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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v12.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: "v12"
  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/v12
  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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7754     put:
7755       tags:
7756         - CloudInfrastructure
7757       summary: see node definition for valid relationships
7758       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
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: vip-ipv4-address
7782           in: path
7783           description: IP address
7784           required: true
7785           type: string
7786           example: __VIP-IPV4-ADDRESS__
7787         - name: body
7788           in: body
7789           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.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: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
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: vip-ipv4-address
7822           in: path
7823           description: IP address
7824           required: true
7825           type: string
7826           example: __VIP-IPV4-ADDRESS__
7827   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7828     get:
7829       tags:
7830         - CloudInfrastructure
7831       summary: returns vip-ipv4-address-list
7832       description: returns vip-ipv4-address-list
7833       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7834       produces:
7835         - application/json
7836         - application/xml
7837       responses:
7838         "200":
7839           description: successful operation
7840           schema:
7841               $ref: "#/getDefinitions/vip-ipv4-address-list"
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: vip-ipv4-address
7858           in: path
7859           description: IP address
7860           required: true
7861           type: string
7862           example: __VIP-IPV4-ADDRESS__
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: vlan-id-inner
7874           in: query
7875           description: Inner VLAN tag
7876           required: false
7877           type: integer
7878           format: int64
7879         - name: neutron-network-id
7880           in: query
7881           description: Neutron network id of the interface that address belongs to
7882           required: false
7883           type: string
7884         - name: neutron-subnet-id
7885           in: query
7886           description: Neutron id of subnet that address belongs to
7887           required: false
7888           type: string
7889     put:
7890       tags:
7891         - CloudInfrastructure
7892       summary: create or update an existing vip-ipv4-address-list
7893       description: |
7894         Create or update an existing vip-ipv4-address-list.
7895         #
7896         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7897       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7898       consumes:
7899         - application/json
7900         - application/xml
7901       produces:
7902         - application/json
7903         - application/xml
7904       responses:
7905         "default":
7906           description: Response codes found in [response codes](https://wiki.onap.org/).
7907       parameters:
7908         - name: cloud-owner
7909           in: path
7910           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7911           required: true
7912           type: string
7913           example: __CLOUD-OWNER__
7914         - name: cloud-region-id
7915           in: path
7916           description: Identifier used by the vendor for the region. Second part of composite key
7917           required: true
7918           type: string
7919           example: __CLOUD-REGION-ID__
7920         - name: vip-ipv4-address
7921           in: path
7922           description: IP address
7923           required: true
7924           type: string
7925           example: __VIP-IPV4-ADDRESS__
7926         - name: body
7927           in: body
7928           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7929           required: true
7930           schema:
7931             $ref: "#/definitions/vip-ipv4-address-list"
7932     patch:
7933       tags:
7934         - CloudInfrastructure
7935       summary: update an existing vip-ipv4-address-list
7936       description: |
7937         Update an existing vip-ipv4-address-list
7938         #
7939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7940         The PUT operation will entirely replace an existing object.
7941         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7942         #
7943         Other differences between PUT and PATCH are:
7944         #
7945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7948       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7949       consumes:
7950         - application/json
7951         - application/xml
7952       produces:
7953         - application/json
7954         - application/xml
7955       responses:
7956         "default":
7957           description: Response codes found in [response codes](https://wiki.onap.org/).
7958       parameters:
7959         - name: cloud-owner
7960           in: path
7961           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7962           required: true
7963           type: string
7964           example: __CLOUD-OWNER__
7965         - name: cloud-region-id
7966           in: path
7967           description: Identifier used by the vendor for the region. Second part of composite key
7968           required: true
7969           type: string
7970           example: __CLOUD-REGION-ID__
7971         - name: vip-ipv4-address
7972           in: path
7973           description: IP address
7974           required: true
7975           type: string
7976           example: __VIP-IPV4-ADDRESS__
7977         - name: body
7978           in: body
7979           description: vip-ipv4-address-list object that needs to be created or updated.
7980           required: true
7981           schema:
7982             $ref: "#/patchDefinitions/vip-ipv4-address-list"
7983     delete:
7984       tags:
7985         - CloudInfrastructure
7986       summary: delete an existing vip-ipv4-address-list
7987       description: delete an existing vip-ipv4-address-list
7988       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7989       consumes:
7990         - application/json
7991         - application/xml
7992       produces:
7993         - application/json
7994         - application/xml
7995       responses:
7996         "default":
7997           description: Response codes found in [response codes](https://wiki.onap.org/).
7998       parameters:
7999         - name: cloud-owner
8000           in: path
8001           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8002           required: true
8003           type: string
8004           example: __CLOUD-OWNER__
8005         - name: cloud-region-id
8006           in: path
8007           description: Identifier used by the vendor for the region. Second part of composite key
8008           required: true
8009           type: string
8010           example: __CLOUD-REGION-ID__
8011         - name: vip-ipv4-address
8012           in: path
8013           description: IP address
8014           required: true
8015           type: string
8016           example: __VIP-IPV4-ADDRESS__
8017         - name: resource-version
8018           in: query
8019           description: resource-version for concurrency
8020           required: true
8021           type: string
8022   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
8023     put:
8024       tags:
8025         - CloudInfrastructure
8026       summary: see node definition for valid relationships
8027       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8028       consumes:
8029         - application/json
8030         - application/xml
8031       produces:
8032         - application/json
8033         - application/xml
8034       responses:
8035         "default":
8036           description: Response codes found in [response codes](https://wiki.onap.org/).
8037       parameters:
8038         - name: cloud-owner
8039           in: path
8040           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8041           required: true
8042           type: string
8043           example: __CLOUD-OWNER__
8044         - name: cloud-region-id
8045           in: path
8046           description: Identifier used by the vendor for the region. Second part of composite key
8047           required: true
8048           type: string
8049           example: __CLOUD-REGION-ID__
8050         - name: vip-ipv6-address
8051           in: path
8052           description: IP address
8053           required: true
8054           type: string
8055           example: __VIP-IPV6-ADDRESS__
8056         - name: body
8057           in: body
8058           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8059           required: true
8060           schema:
8061             $ref: "#/definitions/relationship"
8062     delete:
8063       tags:
8064         - CloudInfrastructure
8065       summary: delete an existing relationship
8066       description: delete an existing relationship
8067       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8068       consumes:
8069         - application/json
8070         - application/xml
8071       produces:
8072         - application/json
8073         - application/xml
8074       responses:
8075         "default":
8076           description: Response codes found in [response codes](https://wiki.onap.org/).
8077       parameters:
8078         - name: cloud-owner
8079           in: path
8080           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8081           required: true
8082           type: string
8083           example: __CLOUD-OWNER__
8084         - name: cloud-region-id
8085           in: path
8086           description: Identifier used by the vendor for the region. Second part of composite key
8087           required: true
8088           type: string
8089           example: __CLOUD-REGION-ID__
8090         - name: vip-ipv6-address
8091           in: path
8092           description: IP address
8093           required: true
8094           type: string
8095           example: __VIP-IPV6-ADDRESS__
8096   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
8097     get:
8098       tags:
8099         - CloudInfrastructure
8100       summary: returns vip-ipv6-address-list
8101       description: returns vip-ipv6-address-list
8102       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8103       produces:
8104         - application/json
8105         - application/xml
8106       responses:
8107         "200":
8108           description: successful operation
8109           schema:
8110               $ref: "#/getDefinitions/vip-ipv6-address-list"
8111         "default":
8112           description: Response codes found in [response codes](https://wiki.onap.org/).
8113       parameters:
8114         - name: cloud-owner
8115           in: path
8116           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8117           required: true
8118           type: string
8119           example: __CLOUD-OWNER__
8120         - name: cloud-region-id
8121           in: path
8122           description: Identifier used by the vendor for the region. Second part of composite key
8123           required: true
8124           type: string
8125           example: __CLOUD-REGION-ID__
8126         - name: vip-ipv6-address
8127           in: path
8128           description: IP address
8129           required: true
8130           type: string
8131           example: __VIP-IPV6-ADDRESS__
8132         - name: cloud-type
8133           in: query
8134           description: Type of the cloud (e.g., openstack)
8135           required: false
8136           type: string
8137         - name: owner-defined-type
8138           in: query
8139           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8140           required: false
8141           type: string
8142         - name: vlan-id-inner
8143           in: query
8144           description: Inner VLAN tag
8145           required: false
8146           type: integer
8147           format: int64
8148         - name: neutron-network-id
8149           in: query
8150           description: Neutron network id of the interface that address belongs to
8151           required: false
8152           type: string
8153         - name: neutron-subnet-id
8154           in: query
8155           description: Neutron id of subnet that address belongs to
8156           required: false
8157           type: string
8158     put:
8159       tags:
8160         - CloudInfrastructure
8161       summary: create or update an existing vip-ipv6-address-list
8162       description: |
8163         Create or update an existing vip-ipv6-address-list.
8164         #
8165         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8166       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8167       consumes:
8168         - application/json
8169         - application/xml
8170       produces:
8171         - application/json
8172         - application/xml
8173       responses:
8174         "default":
8175           description: Response codes found in [response codes](https://wiki.onap.org/).
8176       parameters:
8177         - name: cloud-owner
8178           in: path
8179           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8180           required: true
8181           type: string
8182           example: __CLOUD-OWNER__
8183         - name: cloud-region-id
8184           in: path
8185           description: Identifier used by the vendor for the region. Second part of composite key
8186           required: true
8187           type: string
8188           example: __CLOUD-REGION-ID__
8189         - name: vip-ipv6-address
8190           in: path
8191           description: IP address
8192           required: true
8193           type: string
8194           example: __VIP-IPV6-ADDRESS__
8195         - name: body
8196           in: body
8197           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8198           required: true
8199           schema:
8200             $ref: "#/definitions/vip-ipv6-address-list"
8201     patch:
8202       tags:
8203         - CloudInfrastructure
8204       summary: update an existing vip-ipv6-address-list
8205       description: |
8206         Update an existing vip-ipv6-address-list
8207         #
8208         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8209         The PUT operation will entirely replace an existing object.
8210         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8211         #
8212         Other differences between PUT and PATCH are:
8213         #
8214         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8215         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8216         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8217       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8218       consumes:
8219         - application/json
8220         - application/xml
8221       produces:
8222         - application/json
8223         - application/xml
8224       responses:
8225         "default":
8226           description: Response codes found in [response codes](https://wiki.onap.org/).
8227       parameters:
8228         - name: cloud-owner
8229           in: path
8230           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8231           required: true
8232           type: string
8233           example: __CLOUD-OWNER__
8234         - name: cloud-region-id
8235           in: path
8236           description: Identifier used by the vendor for the region. Second part of composite key
8237           required: true
8238           type: string
8239           example: __CLOUD-REGION-ID__
8240         - name: vip-ipv6-address
8241           in: path
8242           description: IP address
8243           required: true
8244           type: string
8245           example: __VIP-IPV6-ADDRESS__
8246         - name: body
8247           in: body
8248           description: vip-ipv6-address-list object that needs to be created or updated.
8249           required: true
8250           schema:
8251             $ref: "#/patchDefinitions/vip-ipv6-address-list"
8252     delete:
8253       tags:
8254         - CloudInfrastructure
8255       summary: delete an existing vip-ipv6-address-list
8256       description: delete an existing vip-ipv6-address-list
8257       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8258       consumes:
8259         - application/json
8260         - application/xml
8261       produces:
8262         - application/json
8263         - application/xml
8264       responses:
8265         "default":
8266           description: Response codes found in [response codes](https://wiki.onap.org/).
8267       parameters:
8268         - name: cloud-owner
8269           in: path
8270           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8271           required: true
8272           type: string
8273           example: __CLOUD-OWNER__
8274         - name: cloud-region-id
8275           in: path
8276           description: Identifier used by the vendor for the region. Second part of composite key
8277           required: true
8278           type: string
8279           example: __CLOUD-REGION-ID__
8280         - name: vip-ipv6-address
8281           in: path
8282           description: IP address
8283           required: true
8284           type: string
8285           example: __VIP-IPV6-ADDRESS__
8286         - name: resource-version
8287           in: query
8288           description: resource-version for concurrency
8289           required: true
8290           type: string
8291   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8292     get:
8293       tags:
8294         - CloudInfrastructure
8295       summary: returns cloud-region
8296       description: returns cloud-region
8297       operationId: getCloudInfrastructureCloudRegionsCloudRegion
8298       produces:
8299         - application/json
8300         - application/xml
8301       responses:
8302         "200":
8303           description: successful operation
8304           schema:
8305               $ref: "#/getDefinitions/cloud-region"
8306         "default":
8307           description: Response codes found in [response codes](https://wiki.onap.org/).
8308       parameters:
8309         - name: cloud-owner
8310           in: path
8311           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8312           required: true
8313           type: string
8314           example: __CLOUD-OWNER__
8315         - name: cloud-region-id
8316           in: path
8317           description: Identifier used by the vendor for the region. Second part of composite key
8318           required: true
8319           type: string
8320           example: __CLOUD-REGION-ID__
8321         - name: cloud-type
8322           in: query
8323           description: Type of the cloud (e.g., openstack)
8324           required: false
8325           type: string
8326         - name: owner-defined-type
8327           in: query
8328           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8329           required: false
8330           type: string
8331     put:
8332       tags:
8333         - CloudInfrastructure
8334       summary: create or update an existing cloud-region
8335       description: |
8336         Create or update an existing cloud-region.
8337         #
8338         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8339       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8340       consumes:
8341         - application/json
8342         - application/xml
8343       produces:
8344         - application/json
8345         - application/xml
8346       responses:
8347         "default":
8348           description: Response codes found in [response codes](https://wiki.onap.org/).
8349       parameters:
8350         - name: cloud-owner
8351           in: path
8352           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8353           required: true
8354           type: string
8355           example: __CLOUD-OWNER__
8356         - name: cloud-region-id
8357           in: path
8358           description: Identifier used by the vendor for the region. Second part of composite key
8359           required: true
8360           type: string
8361           example: __CLOUD-REGION-ID__
8362         - name: body
8363           in: body
8364           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)
8365           required: true
8366           schema:
8367             $ref: "#/definitions/cloud-region"
8368     patch:
8369       tags:
8370         - CloudInfrastructure
8371       summary: update an existing cloud-region
8372       description: |
8373         Update an existing cloud-region
8374         #
8375         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8376         The PUT operation will entirely replace an existing object.
8377         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8378         #
8379         Other differences between PUT and PATCH are:
8380         #
8381         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8382         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8383         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8384       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8385       consumes:
8386         - application/json
8387         - application/xml
8388       produces:
8389         - application/json
8390         - application/xml
8391       responses:
8392         "default":
8393           description: Response codes found in [response codes](https://wiki.onap.org/).
8394       parameters:
8395         - name: cloud-owner
8396           in: path
8397           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8398           required: true
8399           type: string
8400           example: __CLOUD-OWNER__
8401         - name: cloud-region-id
8402           in: path
8403           description: Identifier used by the vendor for the region. Second part of composite key
8404           required: true
8405           type: string
8406           example: __CLOUD-REGION-ID__
8407         - name: body
8408           in: body
8409           description: cloud-region object that needs to be created or updated.
8410           required: true
8411           schema:
8412             $ref: "#/patchDefinitions/cloud-region"
8413     delete:
8414       tags:
8415         - CloudInfrastructure
8416       summary: delete an existing cloud-region
8417       description: delete an existing cloud-region
8418       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8419       consumes:
8420         - application/json
8421         - application/xml
8422       produces:
8423         - application/json
8424         - application/xml
8425       responses:
8426         "default":
8427           description: Response codes found in [response codes](https://wiki.onap.org/).
8428       parameters:
8429         - name: cloud-owner
8430           in: path
8431           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8432           required: true
8433           type: string
8434           example: __CLOUD-OWNER__
8435         - name: cloud-region-id
8436           in: path
8437           description: Identifier used by the vendor for the region. Second part of composite key
8438           required: true
8439           type: string
8440           example: __CLOUD-REGION-ID__
8441         - name: resource-version
8442           in: query
8443           description: resource-version for concurrency
8444           required: true
8445           type: string
8446   /cloud-infrastructure/cloud-regions:
8447     get:
8448       tags:
8449         - CloudInfrastructure
8450       summary: returns cloud-regions
8451       description: returns cloud-regions
8452       operationId: getCloudInfrastructureCloudRegions
8453       produces:
8454         - application/json
8455         - application/xml
8456       responses:
8457         "200":
8458           description: successful operation
8459           schema:
8460               $ref: "#/getDefinitions/cloud-regions"
8461         "default":
8462           description: Response codes found in [response codes](https://wiki.onap.org/).
8463   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8464     put:
8465       tags:
8466         - CloudInfrastructure
8467       summary: see node definition for valid relationships
8468       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8469       consumes:
8470         - application/json
8471         - application/xml
8472       produces:
8473         - application/json
8474         - application/xml
8475       responses:
8476         "default":
8477           description: Response codes found in [response codes](https://wiki.onap.org/).
8478       parameters:
8479         - name: nm-profile-name
8480           in: path
8481           description: Unique name of network profile.
8482           required: true
8483           type: string
8484           example: __NM-PROFILE-NAME__
8485         - name: body
8486           in: body
8487           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8488           required: true
8489           schema:
8490             $ref: "#/definitions/relationship"
8491     delete:
8492       tags:
8493         - CloudInfrastructure
8494       summary: delete an existing relationship
8495       description: delete an existing relationship
8496       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8497       consumes:
8498         - application/json
8499         - application/xml
8500       produces:
8501         - application/json
8502         - application/xml
8503       responses:
8504         "default":
8505           description: Response codes found in [response codes](https://wiki.onap.org/).
8506       parameters:
8507         - name: nm-profile-name
8508           in: path
8509           description: Unique name of network profile.
8510           required: true
8511           type: string
8512           example: __NM-PROFILE-NAME__
8513   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
8514     get:
8515       tags:
8516         - CloudInfrastructure
8517       summary: returns network-profile
8518       description: returns network-profile
8519       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
8520       produces:
8521         - application/json
8522         - application/xml
8523       responses:
8524         "200":
8525           description: successful operation
8526           schema:
8527               $ref: "#/getDefinitions/network-profile"
8528         "default":
8529           description: Response codes found in [response codes](https://wiki.onap.org/).
8530       parameters:
8531         - name: nm-profile-name
8532           in: path
8533           description: Unique name of network profile.
8534           required: true
8535           type: string
8536           example: __NM-PROFILE-NAME__
8537     put:
8538       tags:
8539         - CloudInfrastructure
8540       summary: create or update an existing network-profile
8541       description: |
8542         Create or update an existing network-profile.
8543         #
8544         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8545       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
8546       consumes:
8547         - application/json
8548         - application/xml
8549       produces:
8550         - application/json
8551         - application/xml
8552       responses:
8553         "default":
8554           description: Response codes found in [response codes](https://wiki.onap.org/).
8555       parameters:
8556         - name: nm-profile-name
8557           in: path
8558           description: Unique name of network profile.
8559           required: true
8560           type: string
8561           example: __NM-PROFILE-NAME__
8562         - name: body
8563           in: body
8564           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8565           required: true
8566           schema:
8567             $ref: "#/definitions/network-profile"
8568     patch:
8569       tags:
8570         - CloudInfrastructure
8571       summary: update an existing network-profile
8572       description: |
8573         Update an existing network-profile
8574         #
8575         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8576         The PUT operation will entirely replace an existing object.
8577         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8578         #
8579         Other differences between PUT and PATCH are:
8580         #
8581         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8582         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8583         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8584       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
8585       consumes:
8586         - application/json
8587         - application/xml
8588       produces:
8589         - application/json
8590         - application/xml
8591       responses:
8592         "default":
8593           description: Response codes found in [response codes](https://wiki.onap.org/).
8594       parameters:
8595         - name: nm-profile-name
8596           in: path
8597           description: Unique name of network profile.
8598           required: true
8599           type: string
8600           example: __NM-PROFILE-NAME__
8601         - name: body
8602           in: body
8603           description: network-profile object that needs to be created or updated.
8604           required: true
8605           schema:
8606             $ref: "#/patchDefinitions/network-profile"
8607     delete:
8608       tags:
8609         - CloudInfrastructure
8610       summary: delete an existing network-profile
8611       description: delete an existing network-profile
8612       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8613       consumes:
8614         - application/json
8615         - application/xml
8616       produces:
8617         - application/json
8618         - application/xml
8619       responses:
8620         "default":
8621           description: Response codes found in [response codes](https://wiki.onap.org/).
8622       parameters:
8623         - name: nm-profile-name
8624           in: path
8625           description: Unique name of network profile.
8626           required: true
8627           type: string
8628           example: __NM-PROFILE-NAME__
8629         - name: resource-version
8630           in: query
8631           description: resource-version for concurrency
8632           required: true
8633           type: string
8634   /cloud-infrastructure/network-profiles:
8635     get:
8636       tags:
8637         - CloudInfrastructure
8638       summary: returns network-profiles
8639       description: returns network-profiles
8640       operationId: getCloudInfrastructureNetworkProfiles
8641       produces:
8642         - application/json
8643         - application/xml
8644       responses:
8645         "200":
8646           description: successful operation
8647           schema:
8648               $ref: "#/getDefinitions/network-profiles"
8649         "default":
8650           description: Response codes found in [response codes](https://wiki.onap.org/).
8651   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8652     put:
8653       tags:
8654         - CloudInfrastructure
8655       summary: see node definition for valid relationships
8656       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8657       consumes:
8658         - application/json
8659         - application/xml
8660       produces:
8661         - application/json
8662         - application/xml
8663       responses:
8664         "default":
8665           description: Response codes found in [response codes](https://wiki.onap.org/).
8666       parameters:
8667         - name: hostname
8668           in: path
8669           description: Value from executing hostname on the compute node.
8670           required: true
8671           type: string
8672           example: __HOSTNAME__
8673         - name: body
8674           in: body
8675           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
8676           required: true
8677           schema:
8678             $ref: "#/definitions/relationship"
8679     delete:
8680       tags:
8681         - CloudInfrastructure
8682       summary: delete an existing relationship
8683       description: delete an existing relationship
8684       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8685       consumes:
8686         - application/json
8687         - application/xml
8688       produces:
8689         - application/json
8690         - application/xml
8691       responses:
8692         "default":
8693           description: Response codes found in [response codes](https://wiki.onap.org/).
8694       parameters:
8695         - name: hostname
8696           in: path
8697           description: Value from executing hostname on the compute node.
8698           required: true
8699           type: string
8700           example: __HOSTNAME__
8701   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8702     put:
8703       tags:
8704         - CloudInfrastructure
8705       summary: see node definition for valid relationships
8706       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8707       consumes:
8708         - application/json
8709         - application/xml
8710       produces:
8711         - application/json
8712         - application/xml
8713       responses:
8714         "default":
8715           description: Response codes found in [response codes](https://wiki.onap.org/).
8716       parameters:
8717         - name: hostname
8718           in: path
8719           description: Value from executing hostname on the compute node.
8720           required: true
8721           type: string
8722           example: __HOSTNAME__
8723         - name: interface-name
8724           in: path
8725           description: Name that identifies the physical interface
8726           required: true
8727           type: string
8728           example: __INTERFACE-NAME__
8729         - name: body
8730           in: body
8731           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8732           required: true
8733           schema:
8734             $ref: "#/definitions/relationship"
8735     delete:
8736       tags:
8737         - CloudInfrastructure
8738       summary: delete an existing relationship
8739       description: delete an existing relationship
8740       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8741       consumes:
8742         - application/json
8743         - application/xml
8744       produces:
8745         - application/json
8746         - application/xml
8747       responses:
8748         "default":
8749           description: Response codes found in [response codes](https://wiki.onap.org/).
8750       parameters:
8751         - name: hostname
8752           in: path
8753           description: Value from executing hostname on the compute node.
8754           required: true
8755           type: string
8756           example: __HOSTNAME__
8757         - name: interface-name
8758           in: path
8759           description: Name that identifies the physical interface
8760           required: true
8761           type: string
8762           example: __INTERFACE-NAME__
8763   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
8764     put:
8765       tags:
8766         - CloudInfrastructure
8767       summary: see node definition for valid relationships
8768       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8769       consumes:
8770         - application/json
8771         - application/xml
8772       produces:
8773         - application/json
8774         - application/xml
8775       responses:
8776         "default":
8777           description: Response codes found in [response codes](https://wiki.onap.org/).
8778       parameters:
8779         - name: hostname
8780           in: path
8781           description: Value from executing hostname on the compute node.
8782           required: true
8783           type: string
8784           example: __HOSTNAME__
8785         - name: interface-name
8786           in: path
8787           description: Name that identifies the physical interface
8788           required: true
8789           type: string
8790           example: __INTERFACE-NAME__
8791         - name: pf-pci-id
8792           in: path
8793           description: Identifier for the sriov-pf
8794           required: true
8795           type: string
8796           example: __PF-PCI-ID__
8797         - name: body
8798           in: body
8799           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8800           required: true
8801           schema:
8802             $ref: "#/definitions/relationship"
8803     delete:
8804       tags:
8805         - CloudInfrastructure
8806       summary: delete an existing relationship
8807       description: delete an existing relationship
8808       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8809       consumes:
8810         - application/json
8811         - application/xml
8812       produces:
8813         - application/json
8814         - application/xml
8815       responses:
8816         "default":
8817           description: Response codes found in [response codes](https://wiki.onap.org/).
8818       parameters:
8819         - name: hostname
8820           in: path
8821           description: Value from executing hostname on the compute node.
8822           required: true
8823           type: string
8824           example: __HOSTNAME__
8825         - name: interface-name
8826           in: path
8827           description: Name that identifies the physical interface
8828           required: true
8829           type: string
8830           example: __INTERFACE-NAME__
8831         - name: pf-pci-id
8832           in: path
8833           description: Identifier for the sriov-pf
8834           required: true
8835           type: string
8836           example: __PF-PCI-ID__
8837   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
8838     get:
8839       tags:
8840         - CloudInfrastructure
8841       summary: returns sriov-pf
8842       description: returns sriov-pf
8843       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8844       produces:
8845         - application/json
8846         - application/xml
8847       responses:
8848         "200":
8849           description: successful operation
8850           schema:
8851               $ref: "#/getDefinitions/sriov-pf"
8852         "default":
8853           description: Response codes found in [response codes](https://wiki.onap.org/).
8854       parameters:
8855         - name: hostname
8856           in: path
8857           description: Value from executing hostname on the compute node.
8858           required: true
8859           type: string
8860           example: __HOSTNAME__
8861         - name: interface-name
8862           in: path
8863           description: Name that identifies the physical interface
8864           required: true
8865           type: string
8866           example: __INTERFACE-NAME__
8867         - name: pf-pci-id
8868           in: path
8869           description: Identifier for the sriov-pf
8870           required: true
8871           type: string
8872           example: __PF-PCI-ID__
8873         - name: inv-status
8874           in: query
8875           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
8876           required: false
8877           type: string
8878         - name: pserver-id
8879           in: query
8880           description: ID of Pserver
8881           required: false
8882           type: string
8883         - name: in-maint
8884           in: query
8885           required: false
8886           type: boolean
8887         - name: pserver-name2
8888           in: query
8889           description: alternative pserver name
8890           required: false
8891           type: string
8892         - name: prov-status
8893           in: query
8894           description: Trigger for operational monitoring of this resource by Service Assurance systems.
8895           required: false
8896           type: string
8897     put:
8898       tags:
8899         - CloudInfrastructure
8900       summary: create or update an existing sriov-pf
8901       description: |
8902         Create or update an existing sriov-pf.
8903         #
8904         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8905       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8906       consumes:
8907         - application/json
8908         - application/xml
8909       produces:
8910         - application/json
8911         - application/xml
8912       responses:
8913         "default":
8914           description: Response codes found in [response codes](https://wiki.onap.org/).
8915       parameters:
8916         - name: hostname
8917           in: path
8918           description: Value from executing hostname on the compute node.
8919           required: true
8920           type: string
8921           example: __HOSTNAME__
8922         - name: interface-name
8923           in: path
8924           description: Name that identifies the physical interface
8925           required: true
8926           type: string
8927           example: __INTERFACE-NAME__
8928         - name: pf-pci-id
8929           in: path
8930           description: Identifier for the sriov-pf
8931           required: true
8932           type: string
8933           example: __PF-PCI-ID__
8934         - name: body
8935           in: body
8936           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8937           required: true
8938           schema:
8939             $ref: "#/definitions/sriov-pf"
8940     patch:
8941       tags:
8942         - CloudInfrastructure
8943       summary: update an existing sriov-pf
8944       description: |
8945         Update an existing sriov-pf
8946         #
8947         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8948         The PUT operation will entirely replace an existing object.
8949         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8950         #
8951         Other differences between PUT and PATCH are:
8952         #
8953         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8954         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8955         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8956       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8957       consumes:
8958         - application/json
8959         - application/xml
8960       produces:
8961         - application/json
8962         - application/xml
8963       responses:
8964         "default":
8965           description: Response codes found in [response codes](https://wiki.onap.org/).
8966       parameters:
8967         - name: hostname
8968           in: path
8969           description: Value from executing hostname on the compute node.
8970           required: true
8971           type: string
8972           example: __HOSTNAME__
8973         - name: interface-name
8974           in: path
8975           description: Name that identifies the physical interface
8976           required: true
8977           type: string
8978           example: __INTERFACE-NAME__
8979         - name: pf-pci-id
8980           in: path
8981           description: Identifier for the sriov-pf
8982           required: true
8983           type: string
8984           example: __PF-PCI-ID__
8985         - name: body
8986           in: body
8987           description: sriov-pf object that needs to be created or updated.
8988           required: true
8989           schema:
8990             $ref: "#/patchDefinitions/sriov-pf"
8991     delete:
8992       tags:
8993         - CloudInfrastructure
8994       summary: delete an existing sriov-pf
8995       description: delete an existing sriov-pf
8996       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8997       consumes:
8998         - application/json
8999         - application/xml
9000       produces:
9001         - application/json
9002         - application/xml
9003       responses:
9004         "default":
9005           description: Response codes found in [response codes](https://wiki.onap.org/).
9006       parameters:
9007         - name: hostname
9008           in: path
9009           description: Value from executing hostname on the compute node.
9010           required: true
9011           type: string
9012           example: __HOSTNAME__
9013         - name: interface-name
9014           in: path
9015           description: Name that identifies the physical interface
9016           required: true
9017           type: string
9018           example: __INTERFACE-NAME__
9019         - name: pf-pci-id
9020           in: path
9021           description: Identifier for the sriov-pf
9022           required: true
9023           type: string
9024           example: __PF-PCI-ID__
9025         - name: resource-version
9026           in: query
9027           description: resource-version for concurrency
9028           required: true
9029           type: string
9030   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9031     get:
9032       tags:
9033         - CloudInfrastructure
9034       summary: returns sriov-pfs
9035       description: returns sriov-pfs
9036       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9037       produces:
9038         - application/json
9039         - application/xml
9040       responses:
9041         "200":
9042           description: successful operation
9043           schema:
9044               $ref: "#/getDefinitions/sriov-pfs"
9045         "default":
9046           description: Response codes found in [response codes](https://wiki.onap.org/).
9047       parameters:
9048         - name: hostname
9049           in: path
9050           description: Value from executing hostname on the compute node.
9051           required: true
9052           type: string
9053           example: __HOSTNAME__
9054         - name: interface-name
9055           in: path
9056           description: Name that identifies the physical interface
9057           required: true
9058           type: string
9059           example: __INTERFACE-NAME__
9060         - name: inv-status
9061           in: query
9062           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9063           required: false
9064           type: string
9065         - name: pserver-id
9066           in: query
9067           description: ID of Pserver
9068           required: false
9069           type: string
9070         - name: in-maint
9071           in: query
9072           required: false
9073           type: boolean
9074         - name: pserver-name2
9075           in: query
9076           description: alternative pserver name
9077           required: false
9078           type: string
9079         - name: prov-status
9080           in: query
9081           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9082           required: false
9083           type: string
9084   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9085     put:
9086       tags:
9087         - CloudInfrastructure
9088       summary: see node definition for valid relationships
9089       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9090       consumes:
9091         - application/json
9092         - application/xml
9093       produces:
9094         - application/json
9095         - application/xml
9096       responses:
9097         "default":
9098           description: Response codes found in [response codes](https://wiki.onap.org/).
9099       parameters:
9100         - name: hostname
9101           in: path
9102           description: Value from executing hostname on the compute node.
9103           required: true
9104           type: string
9105           example: __HOSTNAME__
9106         - name: interface-name
9107           in: path
9108           description: Name that identifies the physical interface
9109           required: true
9110           type: string
9111           example: __INTERFACE-NAME__
9112         - name: interface-name
9113           in: path
9114           description: Name given to the interface
9115           required: true
9116           type: string
9117           example: __INTERFACE-NAME__
9118         - name: vlan-interface
9119           in: path
9120           description: String that identifies the interface
9121           required: true
9122           type: string
9123           example: __VLAN-INTERFACE__
9124         - name: body
9125           in: body
9126           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9127           required: true
9128           schema:
9129             $ref: "#/definitions/relationship"
9130     delete:
9131       tags:
9132         - CloudInfrastructure
9133       summary: delete an existing relationship
9134       description: delete an existing relationship
9135       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9136       consumes:
9137         - application/json
9138         - application/xml
9139       produces:
9140         - application/json
9141         - application/xml
9142       responses:
9143         "default":
9144           description: Response codes found in [response codes](https://wiki.onap.org/).
9145       parameters:
9146         - name: hostname
9147           in: path
9148           description: Value from executing hostname on the compute node.
9149           required: true
9150           type: string
9151           example: __HOSTNAME__
9152         - name: interface-name
9153           in: path
9154           description: Name that identifies the physical interface
9155           required: true
9156           type: string
9157           example: __INTERFACE-NAME__
9158         - name: interface-name
9159           in: path
9160           description: Name given to the interface
9161           required: true
9162           type: string
9163           example: __INTERFACE-NAME__
9164         - name: vlan-interface
9165           in: path
9166           description: String that identifies the interface
9167           required: true
9168           type: string
9169           example: __VLAN-INTERFACE__
9170   /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:
9171     put:
9172       tags:
9173         - CloudInfrastructure
9174       summary: see node definition for valid relationships
9175       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9176       consumes:
9177         - application/json
9178         - application/xml
9179       produces:
9180         - application/json
9181         - application/xml
9182       responses:
9183         "default":
9184           description: Response codes found in [response codes](https://wiki.onap.org/).
9185       parameters:
9186         - name: hostname
9187           in: path
9188           description: Value from executing hostname on the compute node.
9189           required: true
9190           type: string
9191           example: __HOSTNAME__
9192         - name: interface-name
9193           in: path
9194           description: Name that identifies the physical interface
9195           required: true
9196           type: string
9197           example: __INTERFACE-NAME__
9198         - name: interface-name
9199           in: path
9200           description: Name given to the interface
9201           required: true
9202           type: string
9203           example: __INTERFACE-NAME__
9204         - name: vlan-interface
9205           in: path
9206           description: String that identifies the interface
9207           required: true
9208           type: string
9209           example: __VLAN-INTERFACE__
9210         - name: l3-interface-ipv4-address
9211           in: path
9212           description: IP address
9213           required: true
9214           type: string
9215           example: __L3-INTERFACE-IPV4-ADDRESS__
9216         - name: body
9217           in: body
9218           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9219           required: true
9220           schema:
9221             $ref: "#/definitions/relationship"
9222     delete:
9223       tags:
9224         - CloudInfrastructure
9225       summary: delete an existing relationship
9226       description: delete an existing relationship
9227       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9228       consumes:
9229         - application/json
9230         - application/xml
9231       produces:
9232         - application/json
9233         - application/xml
9234       responses:
9235         "default":
9236           description: Response codes found in [response codes](https://wiki.onap.org/).
9237       parameters:
9238         - name: hostname
9239           in: path
9240           description: Value from executing hostname on the compute node.
9241           required: true
9242           type: string
9243           example: __HOSTNAME__
9244         - name: interface-name
9245           in: path
9246           description: Name that identifies the physical interface
9247           required: true
9248           type: string
9249           example: __INTERFACE-NAME__
9250         - name: interface-name
9251           in: path
9252           description: Name given to the interface
9253           required: true
9254           type: string
9255           example: __INTERFACE-NAME__
9256         - name: vlan-interface
9257           in: path
9258           description: String that identifies the interface
9259           required: true
9260           type: string
9261           example: __VLAN-INTERFACE__
9262         - name: l3-interface-ipv4-address
9263           in: path
9264           description: IP address
9265           required: true
9266           type: string
9267           example: __L3-INTERFACE-IPV4-ADDRESS__
9268   /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}:
9269     get:
9270       tags:
9271         - CloudInfrastructure
9272       summary: returns l3-interface-ipv4-address-list
9273       description: returns l3-interface-ipv4-address-list
9274       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9275       produces:
9276         - application/json
9277         - application/xml
9278       responses:
9279         "200":
9280           description: successful operation
9281           schema:
9282               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9283         "default":
9284           description: Response codes found in [response codes](https://wiki.onap.org/).
9285       parameters:
9286         - name: hostname
9287           in: path
9288           description: Value from executing hostname on the compute node.
9289           required: true
9290           type: string
9291           example: __HOSTNAME__
9292         - name: interface-name
9293           in: path
9294           description: Name that identifies the physical interface
9295           required: true
9296           type: string
9297           example: __INTERFACE-NAME__
9298         - name: interface-name
9299           in: path
9300           description: Name given to the interface
9301           required: true
9302           type: string
9303           example: __INTERFACE-NAME__
9304         - name: vlan-interface
9305           in: path
9306           description: String that identifies the interface
9307           required: true
9308           type: string
9309           example: __VLAN-INTERFACE__
9310         - name: l3-interface-ipv4-address
9311           in: path
9312           description: IP address
9313           required: true
9314           type: string
9315           example: __L3-INTERFACE-IPV4-ADDRESS__
9316         - name: inv-status
9317           in: query
9318           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9319           required: false
9320           type: string
9321         - name: pserver-id
9322           in: query
9323           description: ID of Pserver
9324           required: false
9325           type: string
9326         - name: in-maint
9327           in: query
9328           required: false
9329           type: boolean
9330         - name: pserver-name2
9331           in: query
9332           description: alternative pserver name
9333           required: false
9334           type: string
9335         - name: prov-status
9336           in: query
9337           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9338           required: false
9339           type: string
9340         - name: interface-id
9341           in: query
9342           description: ID of interface
9343           required: false
9344           type: string
9345         - name: macaddr
9346           in: query
9347           description: MAC address for the interface
9348           required: false
9349           type: string
9350         - name: network-name
9351           in: query
9352           description: Name of the network
9353           required: false
9354           type: string
9355         - name: vlan-id-inner
9356           in: query
9357           description: Inner VLAN tag
9358           required: false
9359           type: integer
9360           format: int64
9361         - name: vpn-key
9362           in: query
9363           description: This indicates the customers VPN ID associated with this vlan
9364           required: false
9365           type: string
9366         - name: vlan-id-inner
9367           in: query
9368           description: Inner VLAN tag
9369           required: false
9370           type: integer
9371           format: int64
9372         - name: neutron-network-id
9373           in: query
9374           description: Neutron network id of the interface that address belongs to
9375           required: false
9376           type: string
9377         - name: neutron-subnet-id
9378           in: query
9379           description: Neutron id of subnet that address belongs to
9380           required: false
9381           type: string
9382     put:
9383       tags:
9384         - CloudInfrastructure
9385       summary: create or update an existing l3-interface-ipv4-address-list
9386       description: |
9387         Create or update an existing l3-interface-ipv4-address-list.
9388         #
9389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9390       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9391       consumes:
9392         - application/json
9393         - application/xml
9394       produces:
9395         - application/json
9396         - application/xml
9397       responses:
9398         "default":
9399           description: Response codes found in [response codes](https://wiki.onap.org/).
9400       parameters:
9401         - name: hostname
9402           in: path
9403           description: Value from executing hostname on the compute node.
9404           required: true
9405           type: string
9406           example: __HOSTNAME__
9407         - name: interface-name
9408           in: path
9409           description: Name that identifies the physical interface
9410           required: true
9411           type: string
9412           example: __INTERFACE-NAME__
9413         - name: interface-name
9414           in: path
9415           description: Name given to the interface
9416           required: true
9417           type: string
9418           example: __INTERFACE-NAME__
9419         - name: vlan-interface
9420           in: path
9421           description: String that identifies the interface
9422           required: true
9423           type: string
9424           example: __VLAN-INTERFACE__
9425         - name: l3-interface-ipv4-address
9426           in: path
9427           description: IP address
9428           required: true
9429           type: string
9430           example: __L3-INTERFACE-IPV4-ADDRESS__
9431         - name: body
9432           in: body
9433           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9434           required: true
9435           schema:
9436             $ref: "#/definitions/l3-interface-ipv4-address-list"
9437     patch:
9438       tags:
9439         - CloudInfrastructure
9440       summary: update an existing l3-interface-ipv4-address-list
9441       description: |
9442         Update an existing l3-interface-ipv4-address-list
9443         #
9444         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9445         The PUT operation will entirely replace an existing object.
9446         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9447         #
9448         Other differences between PUT and PATCH are:
9449         #
9450         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9451         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9452         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9453       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9454       consumes:
9455         - application/json
9456         - application/xml
9457       produces:
9458         - application/json
9459         - application/xml
9460       responses:
9461         "default":
9462           description: Response codes found in [response codes](https://wiki.onap.org/).
9463       parameters:
9464         - name: hostname
9465           in: path
9466           description: Value from executing hostname on the compute node.
9467           required: true
9468           type: string
9469           example: __HOSTNAME__
9470         - name: interface-name
9471           in: path
9472           description: Name that identifies the physical interface
9473           required: true
9474           type: string
9475           example: __INTERFACE-NAME__
9476         - name: interface-name
9477           in: path
9478           description: Name given to the interface
9479           required: true
9480           type: string
9481           example: __INTERFACE-NAME__
9482         - name: vlan-interface
9483           in: path
9484           description: String that identifies the interface
9485           required: true
9486           type: string
9487           example: __VLAN-INTERFACE__
9488         - name: l3-interface-ipv4-address
9489           in: path
9490           description: IP address
9491           required: true
9492           type: string
9493           example: __L3-INTERFACE-IPV4-ADDRESS__
9494         - name: body
9495           in: body
9496           description: l3-interface-ipv4-address-list object that needs to be created or updated.
9497           required: true
9498           schema:
9499             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9500     delete:
9501       tags:
9502         - CloudInfrastructure
9503       summary: delete an existing l3-interface-ipv4-address-list
9504       description: delete an existing l3-interface-ipv4-address-list
9505       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9506       consumes:
9507         - application/json
9508         - application/xml
9509       produces:
9510         - application/json
9511         - application/xml
9512       responses:
9513         "default":
9514           description: Response codes found in [response codes](https://wiki.onap.org/).
9515       parameters:
9516         - name: hostname
9517           in: path
9518           description: Value from executing hostname on the compute node.
9519           required: true
9520           type: string
9521           example: __HOSTNAME__
9522         - name: interface-name
9523           in: path
9524           description: Name that identifies the physical interface
9525           required: true
9526           type: string
9527           example: __INTERFACE-NAME__
9528         - name: interface-name
9529           in: path
9530           description: Name given to the interface
9531           required: true
9532           type: string
9533           example: __INTERFACE-NAME__
9534         - name: vlan-interface
9535           in: path
9536           description: String that identifies the interface
9537           required: true
9538           type: string
9539           example: __VLAN-INTERFACE__
9540         - name: l3-interface-ipv4-address
9541           in: path
9542           description: IP address
9543           required: true
9544           type: string
9545           example: __L3-INTERFACE-IPV4-ADDRESS__
9546         - name: resource-version
9547           in: query
9548           description: resource-version for concurrency
9549           required: true
9550           type: string
9551   /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:
9552     put:
9553       tags:
9554         - CloudInfrastructure
9555       summary: see node definition for valid relationships
9556       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9557       consumes:
9558         - application/json
9559         - application/xml
9560       produces:
9561         - application/json
9562         - application/xml
9563       responses:
9564         "default":
9565           description: Response codes found in [response codes](https://wiki.onap.org/).
9566       parameters:
9567         - name: hostname
9568           in: path
9569           description: Value from executing hostname on the compute node.
9570           required: true
9571           type: string
9572           example: __HOSTNAME__
9573         - name: interface-name
9574           in: path
9575           description: Name that identifies the physical interface
9576           required: true
9577           type: string
9578           example: __INTERFACE-NAME__
9579         - name: interface-name
9580           in: path
9581           description: Name given to the interface
9582           required: true
9583           type: string
9584           example: __INTERFACE-NAME__
9585         - name: vlan-interface
9586           in: path
9587           description: String that identifies the interface
9588           required: true
9589           type: string
9590           example: __VLAN-INTERFACE__
9591         - name: l3-interface-ipv6-address
9592           in: path
9593           description: IP address
9594           required: true
9595           type: string
9596           example: __L3-INTERFACE-IPV6-ADDRESS__
9597         - name: body
9598           in: body
9599           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9600           required: true
9601           schema:
9602             $ref: "#/definitions/relationship"
9603     delete:
9604       tags:
9605         - CloudInfrastructure
9606       summary: delete an existing relationship
9607       description: delete an existing relationship
9608       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9609       consumes:
9610         - application/json
9611         - application/xml
9612       produces:
9613         - application/json
9614         - application/xml
9615       responses:
9616         "default":
9617           description: Response codes found in [response codes](https://wiki.onap.org/).
9618       parameters:
9619         - name: hostname
9620           in: path
9621           description: Value from executing hostname on the compute node.
9622           required: true
9623           type: string
9624           example: __HOSTNAME__
9625         - name: interface-name
9626           in: path
9627           description: Name that identifies the physical interface
9628           required: true
9629           type: string
9630           example: __INTERFACE-NAME__
9631         - name: interface-name
9632           in: path
9633           description: Name given to the interface
9634           required: true
9635           type: string
9636           example: __INTERFACE-NAME__
9637         - name: vlan-interface
9638           in: path
9639           description: String that identifies the interface
9640           required: true
9641           type: string
9642           example: __VLAN-INTERFACE__
9643         - name: l3-interface-ipv6-address
9644           in: path
9645           description: IP address
9646           required: true
9647           type: string
9648           example: __L3-INTERFACE-IPV6-ADDRESS__
9649   /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}:
9650     get:
9651       tags:
9652         - CloudInfrastructure
9653       summary: returns l3-interface-ipv6-address-list
9654       description: returns l3-interface-ipv6-address-list
9655       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9656       produces:
9657         - application/json
9658         - application/xml
9659       responses:
9660         "200":
9661           description: successful operation
9662           schema:
9663               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9664         "default":
9665           description: Response codes found in [response codes](https://wiki.onap.org/).
9666       parameters:
9667         - name: hostname
9668           in: path
9669           description: Value from executing hostname on the compute node.
9670           required: true
9671           type: string
9672           example: __HOSTNAME__
9673         - name: interface-name
9674           in: path
9675           description: Name that identifies the physical interface
9676           required: true
9677           type: string
9678           example: __INTERFACE-NAME__
9679         - name: interface-name
9680           in: path
9681           description: Name given to the interface
9682           required: true
9683           type: string
9684           example: __INTERFACE-NAME__
9685         - name: vlan-interface
9686           in: path
9687           description: String that identifies the interface
9688           required: true
9689           type: string
9690           example: __VLAN-INTERFACE__
9691         - name: l3-interface-ipv6-address
9692           in: path
9693           description: IP address
9694           required: true
9695           type: string
9696           example: __L3-INTERFACE-IPV6-ADDRESS__
9697         - name: inv-status
9698           in: query
9699           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9700           required: false
9701           type: string
9702         - name: pserver-id
9703           in: query
9704           description: ID of Pserver
9705           required: false
9706           type: string
9707         - name: in-maint
9708           in: query
9709           required: false
9710           type: boolean
9711         - name: pserver-name2
9712           in: query
9713           description: alternative pserver name
9714           required: false
9715           type: string
9716         - name: prov-status
9717           in: query
9718           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9719           required: false
9720           type: string
9721         - name: interface-id
9722           in: query
9723           description: ID of interface
9724           required: false
9725           type: string
9726         - name: macaddr
9727           in: query
9728           description: MAC address for the interface
9729           required: false
9730           type: string
9731         - name: network-name
9732           in: query
9733           description: Name of the network
9734           required: false
9735           type: string
9736         - name: vlan-id-inner
9737           in: query
9738           description: Inner VLAN tag
9739           required: false
9740           type: integer
9741           format: int64
9742         - name: vpn-key
9743           in: query
9744           description: This indicates the customers VPN ID associated with this vlan
9745           required: false
9746           type: string
9747         - name: vlan-id-inner
9748           in: query
9749           description: Inner VLAN tag
9750           required: false
9751           type: integer
9752           format: int64
9753         - name: neutron-network-id
9754           in: query
9755           description: Neutron network id of the interface that address belongs to
9756           required: false
9757           type: string
9758         - name: neutron-subnet-id
9759           in: query
9760           description: Neutron id of subnet that address belongs to
9761           required: false
9762           type: string
9763     put:
9764       tags:
9765         - CloudInfrastructure
9766       summary: create or update an existing l3-interface-ipv6-address-list
9767       description: |
9768         Create or update an existing l3-interface-ipv6-address-list.
9769         #
9770         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9771       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9772       consumes:
9773         - application/json
9774         - application/xml
9775       produces:
9776         - application/json
9777         - application/xml
9778       responses:
9779         "default":
9780           description: Response codes found in [response codes](https://wiki.onap.org/).
9781       parameters:
9782         - name: hostname
9783           in: path
9784           description: Value from executing hostname on the compute node.
9785           required: true
9786           type: string
9787           example: __HOSTNAME__
9788         - name: interface-name
9789           in: path
9790           description: Name that identifies the physical interface
9791           required: true
9792           type: string
9793           example: __INTERFACE-NAME__
9794         - name: interface-name
9795           in: path
9796           description: Name given to the interface
9797           required: true
9798           type: string
9799           example: __INTERFACE-NAME__
9800         - name: vlan-interface
9801           in: path
9802           description: String that identifies the interface
9803           required: true
9804           type: string
9805           example: __VLAN-INTERFACE__
9806         - name: l3-interface-ipv6-address
9807           in: path
9808           description: IP address
9809           required: true
9810           type: string
9811           example: __L3-INTERFACE-IPV6-ADDRESS__
9812         - name: body
9813           in: body
9814           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9815           required: true
9816           schema:
9817             $ref: "#/definitions/l3-interface-ipv6-address-list"
9818     patch:
9819       tags:
9820         - CloudInfrastructure
9821       summary: update an existing l3-interface-ipv6-address-list
9822       description: |
9823         Update an existing l3-interface-ipv6-address-list
9824         #
9825         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9826         The PUT operation will entirely replace an existing object.
9827         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9828         #
9829         Other differences between PUT and PATCH are:
9830         #
9831         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9832         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9833         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9834       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9835       consumes:
9836         - application/json
9837         - application/xml
9838       produces:
9839         - application/json
9840         - application/xml
9841       responses:
9842         "default":
9843           description: Response codes found in [response codes](https://wiki.onap.org/).
9844       parameters:
9845         - name: hostname
9846           in: path
9847           description: Value from executing hostname on the compute node.
9848           required: true
9849           type: string
9850           example: __HOSTNAME__
9851         - name: interface-name
9852           in: path
9853           description: Name that identifies the physical interface
9854           required: true
9855           type: string
9856           example: __INTERFACE-NAME__
9857         - name: interface-name
9858           in: path
9859           description: Name given to the interface
9860           required: true
9861           type: string
9862           example: __INTERFACE-NAME__
9863         - name: vlan-interface
9864           in: path
9865           description: String that identifies the interface
9866           required: true
9867           type: string
9868           example: __VLAN-INTERFACE__
9869         - name: l3-interface-ipv6-address
9870           in: path
9871           description: IP address
9872           required: true
9873           type: string
9874           example: __L3-INTERFACE-IPV6-ADDRESS__
9875         - name: body
9876           in: body
9877           description: l3-interface-ipv6-address-list object that needs to be created or updated.
9878           required: true
9879           schema:
9880             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9881     delete:
9882       tags:
9883         - CloudInfrastructure
9884       summary: delete an existing l3-interface-ipv6-address-list
9885       description: delete an existing l3-interface-ipv6-address-list
9886       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9887       consumes:
9888         - application/json
9889         - application/xml
9890       produces:
9891         - application/json
9892         - application/xml
9893       responses:
9894         "default":
9895           description: Response codes found in [response codes](https://wiki.onap.org/).
9896       parameters:
9897         - name: hostname
9898           in: path
9899           description: Value from executing hostname on the compute node.
9900           required: true
9901           type: string
9902           example: __HOSTNAME__
9903         - name: interface-name
9904           in: path
9905           description: Name that identifies the physical interface
9906           required: true
9907           type: string
9908           example: __INTERFACE-NAME__
9909         - name: interface-name
9910           in: path
9911           description: Name given to the interface
9912           required: true
9913           type: string
9914           example: __INTERFACE-NAME__
9915         - name: vlan-interface
9916           in: path
9917           description: String that identifies the interface
9918           required: true
9919           type: string
9920           example: __VLAN-INTERFACE__
9921         - name: l3-interface-ipv6-address
9922           in: path
9923           description: IP address
9924           required: true
9925           type: string
9926           example: __L3-INTERFACE-IPV6-ADDRESS__
9927         - name: resource-version
9928           in: query
9929           description: resource-version for concurrency
9930           required: true
9931           type: string
9932   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9933     get:
9934       tags:
9935         - CloudInfrastructure
9936       summary: returns vlan
9937       description: returns vlan
9938       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9939       produces:
9940         - application/json
9941         - application/xml
9942       responses:
9943         "200":
9944           description: successful operation
9945           schema:
9946               $ref: "#/getDefinitions/vlan"
9947         "default":
9948           description: Response codes found in [response codes](https://wiki.onap.org/).
9949       parameters:
9950         - name: hostname
9951           in: path
9952           description: Value from executing hostname on the compute node.
9953           required: true
9954           type: string
9955           example: __HOSTNAME__
9956         - name: interface-name
9957           in: path
9958           description: Name that identifies the physical interface
9959           required: true
9960           type: string
9961           example: __INTERFACE-NAME__
9962         - name: interface-name
9963           in: path
9964           description: Name given to the interface
9965           required: true
9966           type: string
9967           example: __INTERFACE-NAME__
9968         - name: vlan-interface
9969           in: path
9970           description: String that identifies the interface
9971           required: true
9972           type: string
9973           example: __VLAN-INTERFACE__
9974         - name: inv-status
9975           in: query
9976           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9977           required: false
9978           type: string
9979         - name: pserver-id
9980           in: query
9981           description: ID of Pserver
9982           required: false
9983           type: string
9984         - name: in-maint
9985           in: query
9986           required: false
9987           type: boolean
9988         - name: pserver-name2
9989           in: query
9990           description: alternative pserver name
9991           required: false
9992           type: string
9993         - name: prov-status
9994           in: query
9995           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9996           required: false
9997           type: string
9998         - name: interface-id
9999           in: query
10000           description: ID of interface
10001           required: false
10002           type: string
10003         - name: macaddr
10004           in: query
10005           description: MAC address for the interface
10006           required: false
10007           type: string
10008         - name: network-name
10009           in: query
10010           description: Name of the network
10011           required: false
10012           type: string
10013         - name: vlan-id-inner
10014           in: query
10015           description: Inner VLAN tag
10016           required: false
10017           type: integer
10018           format: int64
10019         - name: vpn-key
10020           in: query
10021           description: This indicates the customers VPN ID associated with this vlan
10022           required: false
10023           type: string
10024     put:
10025       tags:
10026         - CloudInfrastructure
10027       summary: create or update an existing vlan
10028       description: |
10029         Create or update an existing vlan.
10030         #
10031         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10032       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10033       consumes:
10034         - application/json
10035         - application/xml
10036       produces:
10037         - application/json
10038         - application/xml
10039       responses:
10040         "default":
10041           description: Response codes found in [response codes](https://wiki.onap.org/).
10042       parameters:
10043         - name: hostname
10044           in: path
10045           description: Value from executing hostname on the compute node.
10046           required: true
10047           type: string
10048           example: __HOSTNAME__
10049         - name: interface-name
10050           in: path
10051           description: Name that identifies the physical interface
10052           required: true
10053           type: string
10054           example: __INTERFACE-NAME__
10055         - name: interface-name
10056           in: path
10057           description: Name given to the interface
10058           required: true
10059           type: string
10060           example: __INTERFACE-NAME__
10061         - name: vlan-interface
10062           in: path
10063           description: String that identifies the interface
10064           required: true
10065           type: string
10066           example: __VLAN-INTERFACE__
10067         - name: body
10068           in: body
10069           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10070           required: true
10071           schema:
10072             $ref: "#/definitions/vlan"
10073     patch:
10074       tags:
10075         - CloudInfrastructure
10076       summary: update an existing vlan
10077       description: |
10078         Update an existing vlan
10079         #
10080         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10081         The PUT operation will entirely replace an existing object.
10082         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10083         #
10084         Other differences between PUT and PATCH are:
10085         #
10086         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10087         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10088         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10089       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10090       consumes:
10091         - application/json
10092         - application/xml
10093       produces:
10094         - application/json
10095         - application/xml
10096       responses:
10097         "default":
10098           description: Response codes found in [response codes](https://wiki.onap.org/).
10099       parameters:
10100         - name: hostname
10101           in: path
10102           description: Value from executing hostname on the compute node.
10103           required: true
10104           type: string
10105           example: __HOSTNAME__
10106         - name: interface-name
10107           in: path
10108           description: Name that identifies the physical interface
10109           required: true
10110           type: string
10111           example: __INTERFACE-NAME__
10112         - name: interface-name
10113           in: path
10114           description: Name given to the interface
10115           required: true
10116           type: string
10117           example: __INTERFACE-NAME__
10118         - name: vlan-interface
10119           in: path
10120           description: String that identifies the interface
10121           required: true
10122           type: string
10123           example: __VLAN-INTERFACE__
10124         - name: body
10125           in: body
10126           description: vlan object that needs to be created or updated.
10127           required: true
10128           schema:
10129             $ref: "#/patchDefinitions/vlan"
10130     delete:
10131       tags:
10132         - CloudInfrastructure
10133       summary: delete an existing vlan
10134       description: delete an existing vlan
10135       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10136       consumes:
10137         - application/json
10138         - application/xml
10139       produces:
10140         - application/json
10141         - application/xml
10142       responses:
10143         "default":
10144           description: Response codes found in [response codes](https://wiki.onap.org/).
10145       parameters:
10146         - name: hostname
10147           in: path
10148           description: Value from executing hostname on the compute node.
10149           required: true
10150           type: string
10151           example: __HOSTNAME__
10152         - name: interface-name
10153           in: path
10154           description: Name that identifies the physical interface
10155           required: true
10156           type: string
10157           example: __INTERFACE-NAME__
10158         - name: interface-name
10159           in: path
10160           description: Name given to the interface
10161           required: true
10162           type: string
10163           example: __INTERFACE-NAME__
10164         - name: vlan-interface
10165           in: path
10166           description: String that identifies the interface
10167           required: true
10168           type: string
10169           example: __VLAN-INTERFACE__
10170         - name: resource-version
10171           in: query
10172           description: resource-version for concurrency
10173           required: true
10174           type: string
10175   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10176     get:
10177       tags:
10178         - CloudInfrastructure
10179       summary: returns vlans
10180       description: returns vlans
10181       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10182       produces:
10183         - application/json
10184         - application/xml
10185       responses:
10186         "200":
10187           description: successful operation
10188           schema:
10189               $ref: "#/getDefinitions/vlans"
10190         "default":
10191           description: Response codes found in [response codes](https://wiki.onap.org/).
10192       parameters:
10193         - name: hostname
10194           in: path
10195           description: Value from executing hostname on the compute node.
10196           required: true
10197           type: string
10198           example: __HOSTNAME__
10199         - name: interface-name
10200           in: path
10201           description: Name that identifies the physical interface
10202           required: true
10203           type: string
10204           example: __INTERFACE-NAME__
10205         - name: interface-name
10206           in: path
10207           description: Name given to the interface
10208           required: true
10209           type: string
10210           example: __INTERFACE-NAME__
10211         - name: inv-status
10212           in: query
10213           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10214           required: false
10215           type: string
10216         - name: pserver-id
10217           in: query
10218           description: ID of Pserver
10219           required: false
10220           type: string
10221         - name: in-maint
10222           in: query
10223           required: false
10224           type: boolean
10225         - name: pserver-name2
10226           in: query
10227           description: alternative pserver name
10228           required: false
10229           type: string
10230         - name: prov-status
10231           in: query
10232           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10233           required: false
10234           type: string
10235         - name: interface-id
10236           in: query
10237           description: ID of interface
10238           required: false
10239           type: string
10240         - name: macaddr
10241           in: query
10242           description: MAC address for the interface
10243           required: false
10244           type: string
10245         - name: network-name
10246           in: query
10247           description: Name of the network
10248           required: false
10249           type: string
10250   /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:
10251     put:
10252       tags:
10253         - CloudInfrastructure
10254       summary: see node definition for valid relationships
10255       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10256       consumes:
10257         - application/json
10258         - application/xml
10259       produces:
10260         - application/json
10261         - application/xml
10262       responses:
10263         "default":
10264           description: Response codes found in [response codes](https://wiki.onap.org/).
10265       parameters:
10266         - name: hostname
10267           in: path
10268           description: Value from executing hostname on the compute node.
10269           required: true
10270           type: string
10271           example: __HOSTNAME__
10272         - name: interface-name
10273           in: path
10274           description: Name that identifies the physical interface
10275           required: true
10276           type: string
10277           example: __INTERFACE-NAME__
10278         - name: interface-name
10279           in: path
10280           description: Name given to the interface
10281           required: true
10282           type: string
10283           example: __INTERFACE-NAME__
10284         - name: pci-id
10285           in: path
10286           description: PCI ID used to identify the sriov-vf
10287           required: true
10288           type: string
10289           example: __PCI-ID__
10290         - name: body
10291           in: body
10292           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10293           required: true
10294           schema:
10295             $ref: "#/definitions/relationship"
10296     delete:
10297       tags:
10298         - CloudInfrastructure
10299       summary: delete an existing relationship
10300       description: delete an existing relationship
10301       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10302       consumes:
10303         - application/json
10304         - application/xml
10305       produces:
10306         - application/json
10307         - application/xml
10308       responses:
10309         "default":
10310           description: Response codes found in [response codes](https://wiki.onap.org/).
10311       parameters:
10312         - name: hostname
10313           in: path
10314           description: Value from executing hostname on the compute node.
10315           required: true
10316           type: string
10317           example: __HOSTNAME__
10318         - name: interface-name
10319           in: path
10320           description: Name that identifies the physical interface
10321           required: true
10322           type: string
10323           example: __INTERFACE-NAME__
10324         - name: interface-name
10325           in: path
10326           description: Name given to the interface
10327           required: true
10328           type: string
10329           example: __INTERFACE-NAME__
10330         - name: pci-id
10331           in: path
10332           description: PCI ID used to identify the sriov-vf
10333           required: true
10334           type: string
10335           example: __PCI-ID__
10336   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10337     get:
10338       tags:
10339         - CloudInfrastructure
10340       summary: returns sriov-vf
10341       description: returns sriov-vf
10342       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10343       produces:
10344         - application/json
10345         - application/xml
10346       responses:
10347         "200":
10348           description: successful operation
10349           schema:
10350               $ref: "#/getDefinitions/sriov-vf"
10351         "default":
10352           description: Response codes found in [response codes](https://wiki.onap.org/).
10353       parameters:
10354         - name: hostname
10355           in: path
10356           description: Value from executing hostname on the compute node.
10357           required: true
10358           type: string
10359           example: __HOSTNAME__
10360         - name: interface-name
10361           in: path
10362           description: Name that identifies the physical interface
10363           required: true
10364           type: string
10365           example: __INTERFACE-NAME__
10366         - name: interface-name
10367           in: path
10368           description: Name given to the interface
10369           required: true
10370           type: string
10371           example: __INTERFACE-NAME__
10372         - name: pci-id
10373           in: path
10374           description: PCI ID used to identify the sriov-vf
10375           required: true
10376           type: string
10377           example: __PCI-ID__
10378         - name: inv-status
10379           in: query
10380           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10381           required: false
10382           type: string
10383         - name: pserver-id
10384           in: query
10385           description: ID of Pserver
10386           required: false
10387           type: string
10388         - name: in-maint
10389           in: query
10390           required: false
10391           type: boolean
10392         - name: pserver-name2
10393           in: query
10394           description: alternative pserver name
10395           required: false
10396           type: string
10397         - name: prov-status
10398           in: query
10399           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10400           required: false
10401           type: string
10402         - name: interface-id
10403           in: query
10404           description: ID of interface
10405           required: false
10406           type: string
10407         - name: macaddr
10408           in: query
10409           description: MAC address for the interface
10410           required: false
10411           type: string
10412         - name: network-name
10413           in: query
10414           description: Name of the network
10415           required: false
10416           type: string
10417         - name: vf-vlan-filter
10418           in: query
10419           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
10420           required: false
10421           type: string
10422         - name: vf-mac-filter
10423           in: query
10424           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
10425           required: false
10426           type: string
10427         - name: vf-vlan-strip
10428           in: query
10429           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
10430           required: false
10431           type: boolean
10432         - name: neutron-network-id
10433           in: query
10434           description: Neutron network id of the interface
10435           required: false
10436           type: string
10437     put:
10438       tags:
10439         - CloudInfrastructure
10440       summary: create or update an existing sriov-vf
10441       description: |
10442         Create or update an existing sriov-vf.
10443         #
10444         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10445       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10446       consumes:
10447         - application/json
10448         - application/xml
10449       produces:
10450         - application/json
10451         - application/xml
10452       responses:
10453         "default":
10454           description: Response codes found in [response codes](https://wiki.onap.org/).
10455       parameters:
10456         - name: hostname
10457           in: path
10458           description: Value from executing hostname on the compute node.
10459           required: true
10460           type: string
10461           example: __HOSTNAME__
10462         - name: interface-name
10463           in: path
10464           description: Name that identifies the physical interface
10465           required: true
10466           type: string
10467           example: __INTERFACE-NAME__
10468         - name: interface-name
10469           in: path
10470           description: Name given to the interface
10471           required: true
10472           type: string
10473           example: __INTERFACE-NAME__
10474         - name: pci-id
10475           in: path
10476           description: PCI ID used to identify the sriov-vf
10477           required: true
10478           type: string
10479           example: __PCI-ID__
10480         - name: body
10481           in: body
10482           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10483           required: true
10484           schema:
10485             $ref: "#/definitions/sriov-vf"
10486     patch:
10487       tags:
10488         - CloudInfrastructure
10489       summary: update an existing sriov-vf
10490       description: |
10491         Update an existing sriov-vf
10492         #
10493         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10494         The PUT operation will entirely replace an existing object.
10495         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10496         #
10497         Other differences between PUT and PATCH are:
10498         #
10499         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10500         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10501         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10502       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10503       consumes:
10504         - application/json
10505         - application/xml
10506       produces:
10507         - application/json
10508         - application/xml
10509       responses:
10510         "default":
10511           description: Response codes found in [response codes](https://wiki.onap.org/).
10512       parameters:
10513         - name: hostname
10514           in: path
10515           description: Value from executing hostname on the compute node.
10516           required: true
10517           type: string
10518           example: __HOSTNAME__
10519         - name: interface-name
10520           in: path
10521           description: Name that identifies the physical interface
10522           required: true
10523           type: string
10524           example: __INTERFACE-NAME__
10525         - name: interface-name
10526           in: path
10527           description: Name given to the interface
10528           required: true
10529           type: string
10530           example: __INTERFACE-NAME__
10531         - name: pci-id
10532           in: path
10533           description: PCI ID used to identify the sriov-vf
10534           required: true
10535           type: string
10536           example: __PCI-ID__
10537         - name: body
10538           in: body
10539           description: sriov-vf object that needs to be created or updated.
10540           required: true
10541           schema:
10542             $ref: "#/patchDefinitions/sriov-vf"
10543     delete:
10544       tags:
10545         - CloudInfrastructure
10546       summary: delete an existing sriov-vf
10547       description: delete an existing sriov-vf
10548       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10549       consumes:
10550         - application/json
10551         - application/xml
10552       produces:
10553         - application/json
10554         - application/xml
10555       responses:
10556         "default":
10557           description: Response codes found in [response codes](https://wiki.onap.org/).
10558       parameters:
10559         - name: hostname
10560           in: path
10561           description: Value from executing hostname on the compute node.
10562           required: true
10563           type: string
10564           example: __HOSTNAME__
10565         - name: interface-name
10566           in: path
10567           description: Name that identifies the physical interface
10568           required: true
10569           type: string
10570           example: __INTERFACE-NAME__
10571         - name: interface-name
10572           in: path
10573           description: Name given to the interface
10574           required: true
10575           type: string
10576           example: __INTERFACE-NAME__
10577         - name: pci-id
10578           in: path
10579           description: PCI ID used to identify the sriov-vf
10580           required: true
10581           type: string
10582           example: __PCI-ID__
10583         - name: resource-version
10584           in: query
10585           description: resource-version for concurrency
10586           required: true
10587           type: string
10588   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10589     get:
10590       tags:
10591         - CloudInfrastructure
10592       summary: returns sriov-vfs
10593       description: returns sriov-vfs
10594       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10595       produces:
10596         - application/json
10597         - application/xml
10598       responses:
10599         "200":
10600           description: successful operation
10601           schema:
10602               $ref: "#/getDefinitions/sriov-vfs"
10603         "default":
10604           description: Response codes found in [response codes](https://wiki.onap.org/).
10605       parameters:
10606         - name: hostname
10607           in: path
10608           description: Value from executing hostname on the compute node.
10609           required: true
10610           type: string
10611           example: __HOSTNAME__
10612         - name: interface-name
10613           in: path
10614           description: Name that identifies the physical interface
10615           required: true
10616           type: string
10617           example: __INTERFACE-NAME__
10618         - name: interface-name
10619           in: path
10620           description: Name given to the interface
10621           required: true
10622           type: string
10623           example: __INTERFACE-NAME__
10624         - name: inv-status
10625           in: query
10626           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10627           required: false
10628           type: string
10629         - name: pserver-id
10630           in: query
10631           description: ID of Pserver
10632           required: false
10633           type: string
10634         - name: in-maint
10635           in: query
10636           required: false
10637           type: boolean
10638         - name: pserver-name2
10639           in: query
10640           description: alternative pserver name
10641           required: false
10642           type: string
10643         - name: prov-status
10644           in: query
10645           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10646           required: false
10647           type: string
10648         - name: interface-id
10649           in: query
10650           description: ID of interface
10651           required: false
10652           type: string
10653         - name: macaddr
10654           in: query
10655           description: MAC address for the interface
10656           required: false
10657           type: string
10658         - name: network-name
10659           in: query
10660           description: Name of the network
10661           required: false
10662           type: string
10663   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10664     put:
10665       tags:
10666         - CloudInfrastructure
10667       summary: see node definition for valid relationships
10668       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10669       consumes:
10670         - application/json
10671         - application/xml
10672       produces:
10673         - application/json
10674         - application/xml
10675       responses:
10676         "default":
10677           description: Response codes found in [response codes](https://wiki.onap.org/).
10678       parameters:
10679         - name: hostname
10680           in: path
10681           description: Value from executing hostname on the compute node.
10682           required: true
10683           type: string
10684           example: __HOSTNAME__
10685         - name: interface-name
10686           in: path
10687           description: Name that identifies the physical interface
10688           required: true
10689           type: string
10690           example: __INTERFACE-NAME__
10691         - name: interface-name
10692           in: path
10693           description: Name given to the interface
10694           required: true
10695           type: string
10696           example: __INTERFACE-NAME__
10697         - name: body
10698           in: body
10699           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10700           required: true
10701           schema:
10702             $ref: "#/definitions/relationship"
10703     delete:
10704       tags:
10705         - CloudInfrastructure
10706       summary: delete an existing relationship
10707       description: delete an existing relationship
10708       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10709       consumes:
10710         - application/json
10711         - application/xml
10712       produces:
10713         - application/json
10714         - application/xml
10715       responses:
10716         "default":
10717           description: Response codes found in [response codes](https://wiki.onap.org/).
10718       parameters:
10719         - name: hostname
10720           in: path
10721           description: Value from executing hostname on the compute node.
10722           required: true
10723           type: string
10724           example: __HOSTNAME__
10725         - name: interface-name
10726           in: path
10727           description: Name that identifies the physical interface
10728           required: true
10729           type: string
10730           example: __INTERFACE-NAME__
10731         - name: interface-name
10732           in: path
10733           description: Name given to the interface
10734           required: true
10735           type: string
10736           example: __INTERFACE-NAME__
10737   /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:
10738     put:
10739       tags:
10740         - CloudInfrastructure
10741       summary: see node definition for valid relationships
10742       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10743       consumes:
10744         - application/json
10745         - application/xml
10746       produces:
10747         - application/json
10748         - application/xml
10749       responses:
10750         "default":
10751           description: Response codes found in [response codes](https://wiki.onap.org/).
10752       parameters:
10753         - name: hostname
10754           in: path
10755           description: Value from executing hostname on the compute node.
10756           required: true
10757           type: string
10758           example: __HOSTNAME__
10759         - name: interface-name
10760           in: path
10761           description: Name that identifies the physical interface
10762           required: true
10763           type: string
10764           example: __INTERFACE-NAME__
10765         - name: interface-name
10766           in: path
10767           description: Name given to the interface
10768           required: true
10769           type: string
10770           example: __INTERFACE-NAME__
10771         - name: l3-interface-ipv4-address
10772           in: path
10773           description: IP address
10774           required: true
10775           type: string
10776           example: __L3-INTERFACE-IPV4-ADDRESS__
10777         - name: body
10778           in: body
10779           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10780           required: true
10781           schema:
10782             $ref: "#/definitions/relationship"
10783     delete:
10784       tags:
10785         - CloudInfrastructure
10786       summary: delete an existing relationship
10787       description: delete an existing relationship
10788       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10789       consumes:
10790         - application/json
10791         - application/xml
10792       produces:
10793         - application/json
10794         - application/xml
10795       responses:
10796         "default":
10797           description: Response codes found in [response codes](https://wiki.onap.org/).
10798       parameters:
10799         - name: hostname
10800           in: path
10801           description: Value from executing hostname on the compute node.
10802           required: true
10803           type: string
10804           example: __HOSTNAME__
10805         - name: interface-name
10806           in: path
10807           description: Name that identifies the physical interface
10808           required: true
10809           type: string
10810           example: __INTERFACE-NAME__
10811         - name: interface-name
10812           in: path
10813           description: Name given to the interface
10814           required: true
10815           type: string
10816           example: __INTERFACE-NAME__
10817         - name: l3-interface-ipv4-address
10818           in: path
10819           description: IP address
10820           required: true
10821           type: string
10822           example: __L3-INTERFACE-IPV4-ADDRESS__
10823   /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}:
10824     get:
10825       tags:
10826         - CloudInfrastructure
10827       summary: returns l3-interface-ipv4-address-list
10828       description: returns l3-interface-ipv4-address-list
10829       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10830       produces:
10831         - application/json
10832         - application/xml
10833       responses:
10834         "200":
10835           description: successful operation
10836           schema:
10837               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10838         "default":
10839           description: Response codes found in [response codes](https://wiki.onap.org/).
10840       parameters:
10841         - name: hostname
10842           in: path
10843           description: Value from executing hostname on the compute node.
10844           required: true
10845           type: string
10846           example: __HOSTNAME__
10847         - name: interface-name
10848           in: path
10849           description: Name that identifies the physical interface
10850           required: true
10851           type: string
10852           example: __INTERFACE-NAME__
10853         - name: interface-name
10854           in: path
10855           description: Name given to the interface
10856           required: true
10857           type: string
10858           example: __INTERFACE-NAME__
10859         - name: l3-interface-ipv4-address
10860           in: path
10861           description: IP address
10862           required: true
10863           type: string
10864           example: __L3-INTERFACE-IPV4-ADDRESS__
10865         - name: inv-status
10866           in: query
10867           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10868           required: false
10869           type: string
10870         - name: pserver-id
10871           in: query
10872           description: ID of Pserver
10873           required: false
10874           type: string
10875         - name: in-maint
10876           in: query
10877           required: false
10878           type: boolean
10879         - name: pserver-name2
10880           in: query
10881           description: alternative pserver name
10882           required: false
10883           type: string
10884         - name: prov-status
10885           in: query
10886           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10887           required: false
10888           type: string
10889         - name: interface-id
10890           in: query
10891           description: ID of interface
10892           required: false
10893           type: string
10894         - name: macaddr
10895           in: query
10896           description: MAC address for the interface
10897           required: false
10898           type: string
10899         - name: network-name
10900           in: query
10901           description: Name of the network
10902           required: false
10903           type: string
10904         - name: vlan-id-inner
10905           in: query
10906           description: Inner VLAN tag
10907           required: false
10908           type: integer
10909           format: int64
10910         - name: neutron-network-id
10911           in: query
10912           description: Neutron network id of the interface that address belongs to
10913           required: false
10914           type: string
10915         - name: neutron-subnet-id
10916           in: query
10917           description: Neutron id of subnet that address belongs to
10918           required: false
10919           type: string
10920     put:
10921       tags:
10922         - CloudInfrastructure
10923       summary: create or update an existing l3-interface-ipv4-address-list
10924       description: |
10925         Create or update an existing l3-interface-ipv4-address-list.
10926         #
10927         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10928       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10929       consumes:
10930         - application/json
10931         - application/xml
10932       produces:
10933         - application/json
10934         - application/xml
10935       responses:
10936         "default":
10937           description: Response codes found in [response codes](https://wiki.onap.org/).
10938       parameters:
10939         - name: hostname
10940           in: path
10941           description: Value from executing hostname on the compute node.
10942           required: true
10943           type: string
10944           example: __HOSTNAME__
10945         - name: interface-name
10946           in: path
10947           description: Name that identifies the physical interface
10948           required: true
10949           type: string
10950           example: __INTERFACE-NAME__
10951         - name: interface-name
10952           in: path
10953           description: Name given to the interface
10954           required: true
10955           type: string
10956           example: __INTERFACE-NAME__
10957         - name: l3-interface-ipv4-address
10958           in: path
10959           description: IP address
10960           required: true
10961           type: string
10962           example: __L3-INTERFACE-IPV4-ADDRESS__
10963         - name: body
10964           in: body
10965           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10966           required: true
10967           schema:
10968             $ref: "#/definitions/l3-interface-ipv4-address-list"
10969     patch:
10970       tags:
10971         - CloudInfrastructure
10972       summary: update an existing l3-interface-ipv4-address-list
10973       description: |
10974         Update an existing l3-interface-ipv4-address-list
10975         #
10976         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10977         The PUT operation will entirely replace an existing object.
10978         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10979         #
10980         Other differences between PUT and PATCH are:
10981         #
10982         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10983         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10984         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10985       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10986       consumes:
10987         - application/json
10988         - application/xml
10989       produces:
10990         - application/json
10991         - application/xml
10992       responses:
10993         "default":
10994           description: Response codes found in [response codes](https://wiki.onap.org/).
10995       parameters:
10996         - name: hostname
10997           in: path
10998           description: Value from executing hostname on the compute node.
10999           required: true
11000           type: string
11001           example: __HOSTNAME__
11002         - name: interface-name
11003           in: path
11004           description: Name that identifies the physical interface
11005           required: true
11006           type: string
11007           example: __INTERFACE-NAME__
11008         - name: interface-name
11009           in: path
11010           description: Name given to the interface
11011           required: true
11012           type: string
11013           example: __INTERFACE-NAME__
11014         - name: l3-interface-ipv4-address
11015           in: path
11016           description: IP address
11017           required: true
11018           type: string
11019           example: __L3-INTERFACE-IPV4-ADDRESS__
11020         - name: body
11021           in: body
11022           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11023           required: true
11024           schema:
11025             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11026     delete:
11027       tags:
11028         - CloudInfrastructure
11029       summary: delete an existing l3-interface-ipv4-address-list
11030       description: delete an existing l3-interface-ipv4-address-list
11031       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11032       consumes:
11033         - application/json
11034         - application/xml
11035       produces:
11036         - application/json
11037         - application/xml
11038       responses:
11039         "default":
11040           description: Response codes found in [response codes](https://wiki.onap.org/).
11041       parameters:
11042         - name: hostname
11043           in: path
11044           description: Value from executing hostname on the compute node.
11045           required: true
11046           type: string
11047           example: __HOSTNAME__
11048         - name: interface-name
11049           in: path
11050           description: Name that identifies the physical interface
11051           required: true
11052           type: string
11053           example: __INTERFACE-NAME__
11054         - name: interface-name
11055           in: path
11056           description: Name given to the interface
11057           required: true
11058           type: string
11059           example: __INTERFACE-NAME__
11060         - name: l3-interface-ipv4-address
11061           in: path
11062           description: IP address
11063           required: true
11064           type: string
11065           example: __L3-INTERFACE-IPV4-ADDRESS__
11066         - name: resource-version
11067           in: query
11068           description: resource-version for concurrency
11069           required: true
11070           type: string
11071   /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:
11072     put:
11073       tags:
11074         - CloudInfrastructure
11075       summary: see node definition for valid relationships
11076       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11077       consumes:
11078         - application/json
11079         - application/xml
11080       produces:
11081         - application/json
11082         - application/xml
11083       responses:
11084         "default":
11085           description: Response codes found in [response codes](https://wiki.onap.org/).
11086       parameters:
11087         - name: hostname
11088           in: path
11089           description: Value from executing hostname on the compute node.
11090           required: true
11091           type: string
11092           example: __HOSTNAME__
11093         - name: interface-name
11094           in: path
11095           description: Name that identifies the physical interface
11096           required: true
11097           type: string
11098           example: __INTERFACE-NAME__
11099         - name: interface-name
11100           in: path
11101           description: Name given to the interface
11102           required: true
11103           type: string
11104           example: __INTERFACE-NAME__
11105         - name: l3-interface-ipv6-address
11106           in: path
11107           description: IP address
11108           required: true
11109           type: string
11110           example: __L3-INTERFACE-IPV6-ADDRESS__
11111         - name: body
11112           in: body
11113           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11114           required: true
11115           schema:
11116             $ref: "#/definitions/relationship"
11117     delete:
11118       tags:
11119         - CloudInfrastructure
11120       summary: delete an existing relationship
11121       description: delete an existing relationship
11122       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11123       consumes:
11124         - application/json
11125         - application/xml
11126       produces:
11127         - application/json
11128         - application/xml
11129       responses:
11130         "default":
11131           description: Response codes found in [response codes](https://wiki.onap.org/).
11132       parameters:
11133         - name: hostname
11134           in: path
11135           description: Value from executing hostname on the compute node.
11136           required: true
11137           type: string
11138           example: __HOSTNAME__
11139         - name: interface-name
11140           in: path
11141           description: Name that identifies the physical interface
11142           required: true
11143           type: string
11144           example: __INTERFACE-NAME__
11145         - name: interface-name
11146           in: path
11147           description: Name given to the interface
11148           required: true
11149           type: string
11150           example: __INTERFACE-NAME__
11151         - name: l3-interface-ipv6-address
11152           in: path
11153           description: IP address
11154           required: true
11155           type: string
11156           example: __L3-INTERFACE-IPV6-ADDRESS__
11157   /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}:
11158     get:
11159       tags:
11160         - CloudInfrastructure
11161       summary: returns l3-interface-ipv6-address-list
11162       description: returns l3-interface-ipv6-address-list
11163       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11164       produces:
11165         - application/json
11166         - application/xml
11167       responses:
11168         "200":
11169           description: successful operation
11170           schema:
11171               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11172         "default":
11173           description: Response codes found in [response codes](https://wiki.onap.org/).
11174       parameters:
11175         - name: hostname
11176           in: path
11177           description: Value from executing hostname on the compute node.
11178           required: true
11179           type: string
11180           example: __HOSTNAME__
11181         - name: interface-name
11182           in: path
11183           description: Name that identifies the physical interface
11184           required: true
11185           type: string
11186           example: __INTERFACE-NAME__
11187         - name: interface-name
11188           in: path
11189           description: Name given to the interface
11190           required: true
11191           type: string
11192           example: __INTERFACE-NAME__
11193         - name: l3-interface-ipv6-address
11194           in: path
11195           description: IP address
11196           required: true
11197           type: string
11198           example: __L3-INTERFACE-IPV6-ADDRESS__
11199         - name: inv-status
11200           in: query
11201           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11202           required: false
11203           type: string
11204         - name: pserver-id
11205           in: query
11206           description: ID of Pserver
11207           required: false
11208           type: string
11209         - name: in-maint
11210           in: query
11211           required: false
11212           type: boolean
11213         - name: pserver-name2
11214           in: query
11215           description: alternative pserver name
11216           required: false
11217           type: string
11218         - name: prov-status
11219           in: query
11220           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11221           required: false
11222           type: string
11223         - name: interface-id
11224           in: query
11225           description: ID of interface
11226           required: false
11227           type: string
11228         - name: macaddr
11229           in: query
11230           description: MAC address for the interface
11231           required: false
11232           type: string
11233         - name: network-name
11234           in: query
11235           description: Name of the network
11236           required: false
11237           type: string
11238         - name: vlan-id-inner
11239           in: query
11240           description: Inner VLAN tag
11241           required: false
11242           type: integer
11243           format: int64
11244         - name: neutron-network-id
11245           in: query
11246           description: Neutron network id of the interface that address belongs to
11247           required: false
11248           type: string
11249         - name: neutron-subnet-id
11250           in: query
11251           description: Neutron id of subnet that address belongs to
11252           required: false
11253           type: string
11254     put:
11255       tags:
11256         - CloudInfrastructure
11257       summary: create or update an existing l3-interface-ipv6-address-list
11258       description: |
11259         Create or update an existing l3-interface-ipv6-address-list.
11260         #
11261         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11262       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11263       consumes:
11264         - application/json
11265         - application/xml
11266       produces:
11267         - application/json
11268         - application/xml
11269       responses:
11270         "default":
11271           description: Response codes found in [response codes](https://wiki.onap.org/).
11272       parameters:
11273         - name: hostname
11274           in: path
11275           description: Value from executing hostname on the compute node.
11276           required: true
11277           type: string
11278           example: __HOSTNAME__
11279         - name: interface-name
11280           in: path
11281           description: Name that identifies the physical interface
11282           required: true
11283           type: string
11284           example: __INTERFACE-NAME__
11285         - name: interface-name
11286           in: path
11287           description: Name given to the interface
11288           required: true
11289           type: string
11290           example: __INTERFACE-NAME__
11291         - name: l3-interface-ipv6-address
11292           in: path
11293           description: IP address
11294           required: true
11295           type: string
11296           example: __L3-INTERFACE-IPV6-ADDRESS__
11297         - name: body
11298           in: body
11299           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11300           required: true
11301           schema:
11302             $ref: "#/definitions/l3-interface-ipv6-address-list"
11303     patch:
11304       tags:
11305         - CloudInfrastructure
11306       summary: update an existing l3-interface-ipv6-address-list
11307       description: |
11308         Update an existing l3-interface-ipv6-address-list
11309         #
11310         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11311         The PUT operation will entirely replace an existing object.
11312         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11313         #
11314         Other differences between PUT and PATCH are:
11315         #
11316         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11317         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11318         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11319       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11320       consumes:
11321         - application/json
11322         - application/xml
11323       produces:
11324         - application/json
11325         - application/xml
11326       responses:
11327         "default":
11328           description: Response codes found in [response codes](https://wiki.onap.org/).
11329       parameters:
11330         - name: hostname
11331           in: path
11332           description: Value from executing hostname on the compute node.
11333           required: true
11334           type: string
11335           example: __HOSTNAME__
11336         - name: interface-name
11337           in: path
11338           description: Name that identifies the physical interface
11339           required: true
11340           type: string
11341           example: __INTERFACE-NAME__
11342         - name: interface-name
11343           in: path
11344           description: Name given to the interface
11345           required: true
11346           type: string
11347           example: __INTERFACE-NAME__
11348         - name: l3-interface-ipv6-address
11349           in: path
11350           description: IP address
11351           required: true
11352           type: string
11353           example: __L3-INTERFACE-IPV6-ADDRESS__
11354         - name: body
11355           in: body
11356           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11357           required: true
11358           schema:
11359             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11360     delete:
11361       tags:
11362         - CloudInfrastructure
11363       summary: delete an existing l3-interface-ipv6-address-list
11364       description: delete an existing l3-interface-ipv6-address-list
11365       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11366       consumes:
11367         - application/json
11368         - application/xml
11369       produces:
11370         - application/json
11371         - application/xml
11372       responses:
11373         "default":
11374           description: Response codes found in [response codes](https://wiki.onap.org/).
11375       parameters:
11376         - name: hostname
11377           in: path
11378           description: Value from executing hostname on the compute node.
11379           required: true
11380           type: string
11381           example: __HOSTNAME__
11382         - name: interface-name
11383           in: path
11384           description: Name that identifies the physical interface
11385           required: true
11386           type: string
11387           example: __INTERFACE-NAME__
11388         - name: interface-name
11389           in: path
11390           description: Name given to the interface
11391           required: true
11392           type: string
11393           example: __INTERFACE-NAME__
11394         - name: l3-interface-ipv6-address
11395           in: path
11396           description: IP address
11397           required: true
11398           type: string
11399           example: __L3-INTERFACE-IPV6-ADDRESS__
11400         - name: resource-version
11401           in: query
11402           description: resource-version for concurrency
11403           required: true
11404           type: string
11405   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11406     get:
11407       tags:
11408         - CloudInfrastructure
11409       summary: returns l-interface
11410       description: returns l-interface
11411       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11412       produces:
11413         - application/json
11414         - application/xml
11415       responses:
11416         "200":
11417           description: successful operation
11418           schema:
11419               $ref: "#/getDefinitions/l-interface"
11420         "default":
11421           description: Response codes found in [response codes](https://wiki.onap.org/).
11422       parameters:
11423         - name: hostname
11424           in: path
11425           description: Value from executing hostname on the compute node.
11426           required: true
11427           type: string
11428           example: __HOSTNAME__
11429         - name: interface-name
11430           in: path
11431           description: Name that identifies the physical interface
11432           required: true
11433           type: string
11434           example: __INTERFACE-NAME__
11435         - name: interface-name
11436           in: path
11437           description: Name given to the interface
11438           required: true
11439           type: string
11440           example: __INTERFACE-NAME__
11441         - name: inv-status
11442           in: query
11443           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11444           required: false
11445           type: string
11446         - name: pserver-id
11447           in: query
11448           description: ID of Pserver
11449           required: false
11450           type: string
11451         - name: in-maint
11452           in: query
11453           required: false
11454           type: boolean
11455         - name: pserver-name2
11456           in: query
11457           description: alternative pserver name
11458           required: false
11459           type: string
11460         - name: prov-status
11461           in: query
11462           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11463           required: false
11464           type: string
11465         - name: interface-id
11466           in: query
11467           description: ID of interface
11468           required: false
11469           type: string
11470         - name: macaddr
11471           in: query
11472           description: MAC address for the interface
11473           required: false
11474           type: string
11475         - name: network-name
11476           in: query
11477           description: Name of the network
11478           required: false
11479           type: string
11480     put:
11481       tags:
11482         - CloudInfrastructure
11483       summary: create or update an existing l-interface
11484       description: |
11485         Create or update an existing l-interface.
11486         #
11487         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11488       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11489       consumes:
11490         - application/json
11491         - application/xml
11492       produces:
11493         - application/json
11494         - application/xml
11495       responses:
11496         "default":
11497           description: Response codes found in [response codes](https://wiki.onap.org/).
11498       parameters:
11499         - name: hostname
11500           in: path
11501           description: Value from executing hostname on the compute node.
11502           required: true
11503           type: string
11504           example: __HOSTNAME__
11505         - name: interface-name
11506           in: path
11507           description: Name that identifies the physical interface
11508           required: true
11509           type: string
11510           example: __INTERFACE-NAME__
11511         - name: interface-name
11512           in: path
11513           description: Name given to the interface
11514           required: true
11515           type: string
11516           example: __INTERFACE-NAME__
11517         - name: body
11518           in: body
11519           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11520           required: true
11521           schema:
11522             $ref: "#/definitions/l-interface"
11523     patch:
11524       tags:
11525         - CloudInfrastructure
11526       summary: update an existing l-interface
11527       description: |
11528         Update an existing l-interface
11529         #
11530         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11531         The PUT operation will entirely replace an existing object.
11532         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11533         #
11534         Other differences between PUT and PATCH are:
11535         #
11536         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11537         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11538         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11539       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11540       consumes:
11541         - application/json
11542         - application/xml
11543       produces:
11544         - application/json
11545         - application/xml
11546       responses:
11547         "default":
11548           description: Response codes found in [response codes](https://wiki.onap.org/).
11549       parameters:
11550         - name: hostname
11551           in: path
11552           description: Value from executing hostname on the compute node.
11553           required: true
11554           type: string
11555           example: __HOSTNAME__
11556         - name: interface-name
11557           in: path
11558           description: Name that identifies the physical interface
11559           required: true
11560           type: string
11561           example: __INTERFACE-NAME__
11562         - name: interface-name
11563           in: path
11564           description: Name given to the interface
11565           required: true
11566           type: string
11567           example: __INTERFACE-NAME__
11568         - name: body
11569           in: body
11570           description: l-interface object that needs to be created or updated.
11571           required: true
11572           schema:
11573             $ref: "#/patchDefinitions/l-interface"
11574     delete:
11575       tags:
11576         - CloudInfrastructure
11577       summary: delete an existing l-interface
11578       description: delete an existing l-interface
11579       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11580       consumes:
11581         - application/json
11582         - application/xml
11583       produces:
11584         - application/json
11585         - application/xml
11586       responses:
11587         "default":
11588           description: Response codes found in [response codes](https://wiki.onap.org/).
11589       parameters:
11590         - name: hostname
11591           in: path
11592           description: Value from executing hostname on the compute node.
11593           required: true
11594           type: string
11595           example: __HOSTNAME__
11596         - name: interface-name
11597           in: path
11598           description: Name that identifies the physical interface
11599           required: true
11600           type: string
11601           example: __INTERFACE-NAME__
11602         - name: interface-name
11603           in: path
11604           description: Name given to the interface
11605           required: true
11606           type: string
11607           example: __INTERFACE-NAME__
11608         - name: resource-version
11609           in: query
11610           description: resource-version for concurrency
11611           required: true
11612           type: string
11613   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11614     get:
11615       tags:
11616         - CloudInfrastructure
11617       summary: returns l-interfaces
11618       description: returns l-interfaces
11619       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11620       produces:
11621         - application/json
11622         - application/xml
11623       responses:
11624         "200":
11625           description: successful operation
11626           schema:
11627               $ref: "#/getDefinitions/l-interfaces"
11628         "default":
11629           description: Response codes found in [response codes](https://wiki.onap.org/).
11630       parameters:
11631         - name: hostname
11632           in: path
11633           description: Value from executing hostname on the compute node.
11634           required: true
11635           type: string
11636           example: __HOSTNAME__
11637         - name: interface-name
11638           in: path
11639           description: Name that identifies the physical interface
11640           required: true
11641           type: string
11642           example: __INTERFACE-NAME__
11643         - name: inv-status
11644           in: query
11645           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11646           required: false
11647           type: string
11648         - name: pserver-id
11649           in: query
11650           description: ID of Pserver
11651           required: false
11652           type: string
11653         - name: in-maint
11654           in: query
11655           required: false
11656           type: boolean
11657         - name: pserver-name2
11658           in: query
11659           description: alternative pserver name
11660           required: false
11661           type: string
11662         - name: prov-status
11663           in: query
11664           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11665           required: false
11666           type: string
11667   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11668     get:
11669       tags:
11670         - CloudInfrastructure
11671       summary: returns p-interface
11672       description: returns p-interface
11673       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11674       produces:
11675         - application/json
11676         - application/xml
11677       responses:
11678         "200":
11679           description: successful operation
11680           schema:
11681               $ref: "#/getDefinitions/p-interface"
11682         "default":
11683           description: Response codes found in [response codes](https://wiki.onap.org/).
11684       parameters:
11685         - name: hostname
11686           in: path
11687           description: Value from executing hostname on the compute node.
11688           required: true
11689           type: string
11690           example: __HOSTNAME__
11691         - name: interface-name
11692           in: path
11693           description: Name that identifies the physical interface
11694           required: true
11695           type: string
11696           example: __INTERFACE-NAME__
11697         - name: inv-status
11698           in: query
11699           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11700           required: false
11701           type: string
11702         - name: pserver-id
11703           in: query
11704           description: ID of Pserver
11705           required: false
11706           type: string
11707         - name: in-maint
11708           in: query
11709           required: false
11710           type: boolean
11711         - name: pserver-name2
11712           in: query
11713           description: alternative pserver name
11714           required: false
11715           type: string
11716         - name: prov-status
11717           in: query
11718           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11719           required: false
11720           type: string
11721     put:
11722       tags:
11723         - CloudInfrastructure
11724       summary: create or update an existing p-interface
11725       description: |
11726         Create or update an existing p-interface.
11727         #
11728         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11729       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11730       consumes:
11731         - application/json
11732         - application/xml
11733       produces:
11734         - application/json
11735         - application/xml
11736       responses:
11737         "default":
11738           description: Response codes found in [response codes](https://wiki.onap.org/).
11739       parameters:
11740         - name: hostname
11741           in: path
11742           description: Value from executing hostname on the compute node.
11743           required: true
11744           type: string
11745           example: __HOSTNAME__
11746         - name: interface-name
11747           in: path
11748           description: Name that identifies the physical interface
11749           required: true
11750           type: string
11751           example: __INTERFACE-NAME__
11752         - name: body
11753           in: body
11754           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
11755           required: true
11756           schema:
11757             $ref: "#/definitions/p-interface"
11758     patch:
11759       tags:
11760         - CloudInfrastructure
11761       summary: update an existing p-interface
11762       description: |
11763         Update an existing p-interface
11764         #
11765         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11766         The PUT operation will entirely replace an existing object.
11767         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11768         #
11769         Other differences between PUT and PATCH are:
11770         #
11771         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11772         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11773         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11774       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11775       consumes:
11776         - application/json
11777         - application/xml
11778       produces:
11779         - application/json
11780         - application/xml
11781       responses:
11782         "default":
11783           description: Response codes found in [response codes](https://wiki.onap.org/).
11784       parameters:
11785         - name: hostname
11786           in: path
11787           description: Value from executing hostname on the compute node.
11788           required: true
11789           type: string
11790           example: __HOSTNAME__
11791         - name: interface-name
11792           in: path
11793           description: Name that identifies the physical interface
11794           required: true
11795           type: string
11796           example: __INTERFACE-NAME__
11797         - name: body
11798           in: body
11799           description: p-interface object that needs to be created or updated.
11800           required: true
11801           schema:
11802             $ref: "#/patchDefinitions/p-interface"
11803     delete:
11804       tags:
11805         - CloudInfrastructure
11806       summary: delete an existing p-interface
11807       description: delete an existing p-interface
11808       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
11809       consumes:
11810         - application/json
11811         - application/xml
11812       produces:
11813         - application/json
11814         - application/xml
11815       responses:
11816         "default":
11817           description: Response codes found in [response codes](https://wiki.onap.org/).
11818       parameters:
11819         - name: hostname
11820           in: path
11821           description: Value from executing hostname on the compute node.
11822           required: true
11823           type: string
11824           example: __HOSTNAME__
11825         - name: interface-name
11826           in: path
11827           description: Name that identifies the physical interface
11828           required: true
11829           type: string
11830           example: __INTERFACE-NAME__
11831         - name: resource-version
11832           in: query
11833           description: resource-version for concurrency
11834           required: true
11835           type: string
11836   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
11837     get:
11838       tags:
11839         - CloudInfrastructure
11840       summary: returns p-interfaces
11841       description: returns p-interfaces
11842       operationId: getCloudInfrastructurePserversPserverPInterfaces
11843       produces:
11844         - application/json
11845         - application/xml
11846       responses:
11847         "200":
11848           description: successful operation
11849           schema:
11850               $ref: "#/getDefinitions/p-interfaces"
11851         "default":
11852           description: Response codes found in [response codes](https://wiki.onap.org/).
11853       parameters:
11854         - name: hostname
11855           in: path
11856           description: Value from executing hostname on the compute node.
11857           required: true
11858           type: string
11859           example: __HOSTNAME__
11860         - name: inv-status
11861           in: query
11862           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11863           required: false
11864           type: string
11865         - name: pserver-id
11866           in: query
11867           description: ID of Pserver
11868           required: false
11869           type: string
11870         - name: in-maint
11871           in: query
11872           required: false
11873           type: boolean
11874         - name: pserver-name2
11875           in: query
11876           description: alternative pserver name
11877           required: false
11878           type: string
11879   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
11880     put:
11881       tags:
11882         - CloudInfrastructure
11883       summary: see node definition for valid relationships
11884       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11885       consumes:
11886         - application/json
11887         - application/xml
11888       produces:
11889         - application/json
11890         - application/xml
11891       responses:
11892         "default":
11893           description: Response codes found in [response codes](https://wiki.onap.org/).
11894       parameters:
11895         - name: hostname
11896           in: path
11897           description: Value from executing hostname on the compute node.
11898           required: true
11899           type: string
11900           example: __HOSTNAME__
11901         - name: interface-name
11902           in: path
11903           description: Name that identifies the link aggregate interface
11904           required: true
11905           type: string
11906           example: __INTERFACE-NAME__
11907         - name: body
11908           in: body
11909           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11910           required: true
11911           schema:
11912             $ref: "#/definitions/relationship"
11913     delete:
11914       tags:
11915         - CloudInfrastructure
11916       summary: delete an existing relationship
11917       description: delete an existing relationship
11918       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11919       consumes:
11920         - application/json
11921         - application/xml
11922       produces:
11923         - application/json
11924         - application/xml
11925       responses:
11926         "default":
11927           description: Response codes found in [response codes](https://wiki.onap.org/).
11928       parameters:
11929         - name: hostname
11930           in: path
11931           description: Value from executing hostname on the compute node.
11932           required: true
11933           type: string
11934           example: __HOSTNAME__
11935         - name: interface-name
11936           in: path
11937           description: Name that identifies the link aggregate interface
11938           required: true
11939           type: string
11940           example: __INTERFACE-NAME__
11941   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11942     put:
11943       tags:
11944         - CloudInfrastructure
11945       summary: see node definition for valid relationships
11946       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11947       consumes:
11948         - application/json
11949         - application/xml
11950       produces:
11951         - application/json
11952         - application/xml
11953       responses:
11954         "default":
11955           description: Response codes found in [response codes](https://wiki.onap.org/).
11956       parameters:
11957         - name: hostname
11958           in: path
11959           description: Value from executing hostname on the compute node.
11960           required: true
11961           type: string
11962           example: __HOSTNAME__
11963         - name: interface-name
11964           in: path
11965           description: Name that identifies the link aggregate interface
11966           required: true
11967           type: string
11968           example: __INTERFACE-NAME__
11969         - name: interface-name
11970           in: path
11971           description: Name given to the interface
11972           required: true
11973           type: string
11974           example: __INTERFACE-NAME__
11975         - name: vlan-interface
11976           in: path
11977           description: String that identifies the interface
11978           required: true
11979           type: string
11980           example: __VLAN-INTERFACE__
11981         - name: body
11982           in: body
11983           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11984           required: true
11985           schema:
11986             $ref: "#/definitions/relationship"
11987     delete:
11988       tags:
11989         - CloudInfrastructure
11990       summary: delete an existing relationship
11991       description: delete an existing relationship
11992       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11993       consumes:
11994         - application/json
11995         - application/xml
11996       produces:
11997         - application/json
11998         - application/xml
11999       responses:
12000         "default":
12001           description: Response codes found in [response codes](https://wiki.onap.org/).
12002       parameters:
12003         - name: hostname
12004           in: path
12005           description: Value from executing hostname on the compute node.
12006           required: true
12007           type: string
12008           example: __HOSTNAME__
12009         - name: interface-name
12010           in: path
12011           description: Name that identifies the link aggregate interface
12012           required: true
12013           type: string
12014           example: __INTERFACE-NAME__
12015         - name: interface-name
12016           in: path
12017           description: Name given to the interface
12018           required: true
12019           type: string
12020           example: __INTERFACE-NAME__
12021         - name: vlan-interface
12022           in: path
12023           description: String that identifies the interface
12024           required: true
12025           type: string
12026           example: __VLAN-INTERFACE__
12027   /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:
12028     put:
12029       tags:
12030         - CloudInfrastructure
12031       summary: see node definition for valid relationships
12032       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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 link aggregate interface
12052           required: true
12053           type: string
12054           example: __INTERFACE-NAME__
12055         - name: interface-name
12056           in: path
12057           description: Name given to the interface
12058           required: true
12059           type: string
12060           example: __INTERFACE-NAME__
12061         - name: vlan-interface
12062           in: path
12063           description: String that identifies the interface
12064           required: true
12065           type: string
12066           example: __VLAN-INTERFACE__
12067         - name: l3-interface-ipv4-address
12068           in: path
12069           description: IP address
12070           required: true
12071           type: string
12072           example: __L3-INTERFACE-IPV4-ADDRESS__
12073         - name: body
12074           in: body
12075           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12076           required: true
12077           schema:
12078             $ref: "#/definitions/relationship"
12079     delete:
12080       tags:
12081         - CloudInfrastructure
12082       summary: delete an existing relationship
12083       description: delete an existing relationship
12084       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12085       consumes:
12086         - application/json
12087         - application/xml
12088       produces:
12089         - application/json
12090         - application/xml
12091       responses:
12092         "default":
12093           description: Response codes found in [response codes](https://wiki.onap.org/).
12094       parameters:
12095         - name: hostname
12096           in: path
12097           description: Value from executing hostname on the compute node.
12098           required: true
12099           type: string
12100           example: __HOSTNAME__
12101         - name: interface-name
12102           in: path
12103           description: Name that identifies the link aggregate interface
12104           required: true
12105           type: string
12106           example: __INTERFACE-NAME__
12107         - name: interface-name
12108           in: path
12109           description: Name given to the interface
12110           required: true
12111           type: string
12112           example: __INTERFACE-NAME__
12113         - name: vlan-interface
12114           in: path
12115           description: String that identifies the interface
12116           required: true
12117           type: string
12118           example: __VLAN-INTERFACE__
12119         - name: l3-interface-ipv4-address
12120           in: path
12121           description: IP address
12122           required: true
12123           type: string
12124           example: __L3-INTERFACE-IPV4-ADDRESS__
12125   /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}:
12126     get:
12127       tags:
12128         - CloudInfrastructure
12129       summary: returns l3-interface-ipv4-address-list
12130       description: returns l3-interface-ipv4-address-list
12131       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12132       produces:
12133         - application/json
12134         - application/xml
12135       responses:
12136         "200":
12137           description: successful operation
12138           schema:
12139               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12140         "default":
12141           description: Response codes found in [response codes](https://wiki.onap.org/).
12142       parameters:
12143         - name: hostname
12144           in: path
12145           description: Value from executing hostname on the compute node.
12146           required: true
12147           type: string
12148           example: __HOSTNAME__
12149         - name: interface-name
12150           in: path
12151           description: Name that identifies the link aggregate interface
12152           required: true
12153           type: string
12154           example: __INTERFACE-NAME__
12155         - name: interface-name
12156           in: path
12157           description: Name given to the interface
12158           required: true
12159           type: string
12160           example: __INTERFACE-NAME__
12161         - name: vlan-interface
12162           in: path
12163           description: String that identifies the interface
12164           required: true
12165           type: string
12166           example: __VLAN-INTERFACE__
12167         - name: l3-interface-ipv4-address
12168           in: path
12169           description: IP address
12170           required: true
12171           type: string
12172           example: __L3-INTERFACE-IPV4-ADDRESS__
12173         - name: inv-status
12174           in: query
12175           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12176           required: false
12177           type: string
12178         - name: pserver-id
12179           in: query
12180           description: ID of Pserver
12181           required: false
12182           type: string
12183         - name: in-maint
12184           in: query
12185           required: false
12186           type: boolean
12187         - name: pserver-name2
12188           in: query
12189           description: alternative pserver name
12190           required: false
12191           type: string
12192         - name: interface-id
12193           in: query
12194           description: ID of interface
12195           required: false
12196           type: string
12197         - name: interface-role
12198           in: query
12199           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12200           required: false
12201           type: string
12202         - name: interface-id
12203           in: query
12204           description: ID of interface
12205           required: false
12206           type: string
12207         - name: macaddr
12208           in: query
12209           description: MAC address for the interface
12210           required: false
12211           type: string
12212         - name: network-name
12213           in: query
12214           description: Name of the network
12215           required: false
12216           type: string
12217         - name: vlan-id-inner
12218           in: query
12219           description: Inner VLAN tag
12220           required: false
12221           type: integer
12222           format: int64
12223         - name: vpn-key
12224           in: query
12225           description: This indicates the customers VPN ID associated with this vlan
12226           required: false
12227           type: string
12228         - name: vlan-id-inner
12229           in: query
12230           description: Inner VLAN tag
12231           required: false
12232           type: integer
12233           format: int64
12234         - name: neutron-network-id
12235           in: query
12236           description: Neutron network id of the interface that address belongs to
12237           required: false
12238           type: string
12239         - name: neutron-subnet-id
12240           in: query
12241           description: Neutron id of subnet that address belongs to
12242           required: false
12243           type: string
12244     put:
12245       tags:
12246         - CloudInfrastructure
12247       summary: create or update an existing l3-interface-ipv4-address-list
12248       description: |
12249         Create or update an existing l3-interface-ipv4-address-list.
12250         #
12251         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12252       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12253       consumes:
12254         - application/json
12255         - application/xml
12256       produces:
12257         - application/json
12258         - application/xml
12259       responses:
12260         "default":
12261           description: Response codes found in [response codes](https://wiki.onap.org/).
12262       parameters:
12263         - name: hostname
12264           in: path
12265           description: Value from executing hostname on the compute node.
12266           required: true
12267           type: string
12268           example: __HOSTNAME__
12269         - name: interface-name
12270           in: path
12271           description: Name that identifies the link aggregate interface
12272           required: true
12273           type: string
12274           example: __INTERFACE-NAME__
12275         - name: interface-name
12276           in: path
12277           description: Name given to the interface
12278           required: true
12279           type: string
12280           example: __INTERFACE-NAME__
12281         - name: vlan-interface
12282           in: path
12283           description: String that identifies the interface
12284           required: true
12285           type: string
12286           example: __VLAN-INTERFACE__
12287         - name: l3-interface-ipv4-address
12288           in: path
12289           description: IP address
12290           required: true
12291           type: string
12292           example: __L3-INTERFACE-IPV4-ADDRESS__
12293         - name: body
12294           in: body
12295           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12296           required: true
12297           schema:
12298             $ref: "#/definitions/l3-interface-ipv4-address-list"
12299     patch:
12300       tags:
12301         - CloudInfrastructure
12302       summary: update an existing l3-interface-ipv4-address-list
12303       description: |
12304         Update an existing l3-interface-ipv4-address-list
12305         #
12306         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12307         The PUT operation will entirely replace an existing object.
12308         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12309         #
12310         Other differences between PUT and PATCH are:
12311         #
12312         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12313         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12314         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12315       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12316       consumes:
12317         - application/json
12318         - application/xml
12319       produces:
12320         - application/json
12321         - application/xml
12322       responses:
12323         "default":
12324           description: Response codes found in [response codes](https://wiki.onap.org/).
12325       parameters:
12326         - name: hostname
12327           in: path
12328           description: Value from executing hostname on the compute node.
12329           required: true
12330           type: string
12331           example: __HOSTNAME__
12332         - name: interface-name
12333           in: path
12334           description: Name that identifies the link aggregate interface
12335           required: true
12336           type: string
12337           example: __INTERFACE-NAME__
12338         - name: interface-name
12339           in: path
12340           description: Name given to the interface
12341           required: true
12342           type: string
12343           example: __INTERFACE-NAME__
12344         - name: vlan-interface
12345           in: path
12346           description: String that identifies the interface
12347           required: true
12348           type: string
12349           example: __VLAN-INTERFACE__
12350         - name: l3-interface-ipv4-address
12351           in: path
12352           description: IP address
12353           required: true
12354           type: string
12355           example: __L3-INTERFACE-IPV4-ADDRESS__
12356         - name: body
12357           in: body
12358           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12359           required: true
12360           schema:
12361             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12362     delete:
12363       tags:
12364         - CloudInfrastructure
12365       summary: delete an existing l3-interface-ipv4-address-list
12366       description: delete an existing l3-interface-ipv4-address-list
12367       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12368       consumes:
12369         - application/json
12370         - application/xml
12371       produces:
12372         - application/json
12373         - application/xml
12374       responses:
12375         "default":
12376           description: Response codes found in [response codes](https://wiki.onap.org/).
12377       parameters:
12378         - name: hostname
12379           in: path
12380           description: Value from executing hostname on the compute node.
12381           required: true
12382           type: string
12383           example: __HOSTNAME__
12384         - name: interface-name
12385           in: path
12386           description: Name that identifies the link aggregate interface
12387           required: true
12388           type: string
12389           example: __INTERFACE-NAME__
12390         - name: interface-name
12391           in: path
12392           description: Name given to the interface
12393           required: true
12394           type: string
12395           example: __INTERFACE-NAME__
12396         - name: vlan-interface
12397           in: path
12398           description: String that identifies the interface
12399           required: true
12400           type: string
12401           example: __VLAN-INTERFACE__
12402         - name: l3-interface-ipv4-address
12403           in: path
12404           description: IP address
12405           required: true
12406           type: string
12407           example: __L3-INTERFACE-IPV4-ADDRESS__
12408         - name: resource-version
12409           in: query
12410           description: resource-version for concurrency
12411           required: true
12412           type: string
12413   /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:
12414     put:
12415       tags:
12416         - CloudInfrastructure
12417       summary: see node definition for valid relationships
12418       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12419       consumes:
12420         - application/json
12421         - application/xml
12422       produces:
12423         - application/json
12424         - application/xml
12425       responses:
12426         "default":
12427           description: Response codes found in [response codes](https://wiki.onap.org/).
12428       parameters:
12429         - name: hostname
12430           in: path
12431           description: Value from executing hostname on the compute node.
12432           required: true
12433           type: string
12434           example: __HOSTNAME__
12435         - name: interface-name
12436           in: path
12437           description: Name that identifies the link aggregate interface
12438           required: true
12439           type: string
12440           example: __INTERFACE-NAME__
12441         - name: interface-name
12442           in: path
12443           description: Name given to the interface
12444           required: true
12445           type: string
12446           example: __INTERFACE-NAME__
12447         - name: vlan-interface
12448           in: path
12449           description: String that identifies the interface
12450           required: true
12451           type: string
12452           example: __VLAN-INTERFACE__
12453         - name: l3-interface-ipv6-address
12454           in: path
12455           description: IP address
12456           required: true
12457           type: string
12458           example: __L3-INTERFACE-IPV6-ADDRESS__
12459         - name: body
12460           in: body
12461           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12462           required: true
12463           schema:
12464             $ref: "#/definitions/relationship"
12465     delete:
12466       tags:
12467         - CloudInfrastructure
12468       summary: delete an existing relationship
12469       description: delete an existing relationship
12470       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12471       consumes:
12472         - application/json
12473         - application/xml
12474       produces:
12475         - application/json
12476         - application/xml
12477       responses:
12478         "default":
12479           description: Response codes found in [response codes](https://wiki.onap.org/).
12480       parameters:
12481         - name: hostname
12482           in: path
12483           description: Value from executing hostname on the compute node.
12484           required: true
12485           type: string
12486           example: __HOSTNAME__
12487         - name: interface-name
12488           in: path
12489           description: Name that identifies the link aggregate interface
12490           required: true
12491           type: string
12492           example: __INTERFACE-NAME__
12493         - name: interface-name
12494           in: path
12495           description: Name given to the interface
12496           required: true
12497           type: string
12498           example: __INTERFACE-NAME__
12499         - name: vlan-interface
12500           in: path
12501           description: String that identifies the interface
12502           required: true
12503           type: string
12504           example: __VLAN-INTERFACE__
12505         - name: l3-interface-ipv6-address
12506           in: path
12507           description: IP address
12508           required: true
12509           type: string
12510           example: __L3-INTERFACE-IPV6-ADDRESS__
12511   /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}:
12512     get:
12513       tags:
12514         - CloudInfrastructure
12515       summary: returns l3-interface-ipv6-address-list
12516       description: returns l3-interface-ipv6-address-list
12517       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12518       produces:
12519         - application/json
12520         - application/xml
12521       responses:
12522         "200":
12523           description: successful operation
12524           schema:
12525               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12526         "default":
12527           description: Response codes found in [response codes](https://wiki.onap.org/).
12528       parameters:
12529         - name: hostname
12530           in: path
12531           description: Value from executing hostname on the compute node.
12532           required: true
12533           type: string
12534           example: __HOSTNAME__
12535         - name: interface-name
12536           in: path
12537           description: Name that identifies the link aggregate interface
12538           required: true
12539           type: string
12540           example: __INTERFACE-NAME__
12541         - name: interface-name
12542           in: path
12543           description: Name given to the interface
12544           required: true
12545           type: string
12546           example: __INTERFACE-NAME__
12547         - name: vlan-interface
12548           in: path
12549           description: String that identifies the interface
12550           required: true
12551           type: string
12552           example: __VLAN-INTERFACE__
12553         - name: l3-interface-ipv6-address
12554           in: path
12555           description: IP address
12556           required: true
12557           type: string
12558           example: __L3-INTERFACE-IPV6-ADDRESS__
12559         - name: inv-status
12560           in: query
12561           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12562           required: false
12563           type: string
12564         - name: pserver-id
12565           in: query
12566           description: ID of Pserver
12567           required: false
12568           type: string
12569         - name: in-maint
12570           in: query
12571           required: false
12572           type: boolean
12573         - name: pserver-name2
12574           in: query
12575           description: alternative pserver name
12576           required: false
12577           type: string
12578         - name: interface-id
12579           in: query
12580           description: ID of interface
12581           required: false
12582           type: string
12583         - name: interface-role
12584           in: query
12585           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12586           required: false
12587           type: string
12588         - name: interface-id
12589           in: query
12590           description: ID of interface
12591           required: false
12592           type: string
12593         - name: macaddr
12594           in: query
12595           description: MAC address for the interface
12596           required: false
12597           type: string
12598         - name: network-name
12599           in: query
12600           description: Name of the network
12601           required: false
12602           type: string
12603         - name: vlan-id-inner
12604           in: query
12605           description: Inner VLAN tag
12606           required: false
12607           type: integer
12608           format: int64
12609         - name: vpn-key
12610           in: query
12611           description: This indicates the customers VPN ID associated with this vlan
12612           required: false
12613           type: string
12614         - name: vlan-id-inner
12615           in: query
12616           description: Inner VLAN tag
12617           required: false
12618           type: integer
12619           format: int64
12620         - name: neutron-network-id
12621           in: query
12622           description: Neutron network id of the interface that address belongs to
12623           required: false
12624           type: string
12625         - name: neutron-subnet-id
12626           in: query
12627           description: Neutron id of subnet that address belongs to
12628           required: false
12629           type: string
12630     put:
12631       tags:
12632         - CloudInfrastructure
12633       summary: create or update an existing l3-interface-ipv6-address-list
12634       description: |
12635         Create or update an existing l3-interface-ipv6-address-list.
12636         #
12637         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12638       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12639       consumes:
12640         - application/json
12641         - application/xml
12642       produces:
12643         - application/json
12644         - application/xml
12645       responses:
12646         "default":
12647           description: Response codes found in [response codes](https://wiki.onap.org/).
12648       parameters:
12649         - name: hostname
12650           in: path
12651           description: Value from executing hostname on the compute node.
12652           required: true
12653           type: string
12654           example: __HOSTNAME__
12655         - name: interface-name
12656           in: path
12657           description: Name that identifies the link aggregate interface
12658           required: true
12659           type: string
12660           example: __INTERFACE-NAME__
12661         - name: interface-name
12662           in: path
12663           description: Name given to the interface
12664           required: true
12665           type: string
12666           example: __INTERFACE-NAME__
12667         - name: vlan-interface
12668           in: path
12669           description: String that identifies the interface
12670           required: true
12671           type: string
12672           example: __VLAN-INTERFACE__
12673         - name: l3-interface-ipv6-address
12674           in: path
12675           description: IP address
12676           required: true
12677           type: string
12678           example: __L3-INTERFACE-IPV6-ADDRESS__
12679         - name: body
12680           in: body
12681           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12682           required: true
12683           schema:
12684             $ref: "#/definitions/l3-interface-ipv6-address-list"
12685     patch:
12686       tags:
12687         - CloudInfrastructure
12688       summary: update an existing l3-interface-ipv6-address-list
12689       description: |
12690         Update an existing l3-interface-ipv6-address-list
12691         #
12692         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12693         The PUT operation will entirely replace an existing object.
12694         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12695         #
12696         Other differences between PUT and PATCH are:
12697         #
12698         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12699         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12700         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12701       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12702       consumes:
12703         - application/json
12704         - application/xml
12705       produces:
12706         - application/json
12707         - application/xml
12708       responses:
12709         "default":
12710           description: Response codes found in [response codes](https://wiki.onap.org/).
12711       parameters:
12712         - name: hostname
12713           in: path
12714           description: Value from executing hostname on the compute node.
12715           required: true
12716           type: string
12717           example: __HOSTNAME__
12718         - name: interface-name
12719           in: path
12720           description: Name that identifies the link aggregate interface
12721           required: true
12722           type: string
12723           example: __INTERFACE-NAME__
12724         - name: interface-name
12725           in: path
12726           description: Name given to the interface
12727           required: true
12728           type: string
12729           example: __INTERFACE-NAME__
12730         - name: vlan-interface
12731           in: path
12732           description: String that identifies the interface
12733           required: true
12734           type: string
12735           example: __VLAN-INTERFACE__
12736         - name: l3-interface-ipv6-address
12737           in: path
12738           description: IP address
12739           required: true
12740           type: string
12741           example: __L3-INTERFACE-IPV6-ADDRESS__
12742         - name: body
12743           in: body
12744           description: l3-interface-ipv6-address-list object that needs to be created or updated.
12745           required: true
12746           schema:
12747             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12748     delete:
12749       tags:
12750         - CloudInfrastructure
12751       summary: delete an existing l3-interface-ipv6-address-list
12752       description: delete an existing l3-interface-ipv6-address-list
12753       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12754       consumes:
12755         - application/json
12756         - application/xml
12757       produces:
12758         - application/json
12759         - application/xml
12760       responses:
12761         "default":
12762           description: Response codes found in [response codes](https://wiki.onap.org/).
12763       parameters:
12764         - name: hostname
12765           in: path
12766           description: Value from executing hostname on the compute node.
12767           required: true
12768           type: string
12769           example: __HOSTNAME__
12770         - name: interface-name
12771           in: path
12772           description: Name that identifies the link aggregate interface
12773           required: true
12774           type: string
12775           example: __INTERFACE-NAME__
12776         - name: interface-name
12777           in: path
12778           description: Name given to the interface
12779           required: true
12780           type: string
12781           example: __INTERFACE-NAME__
12782         - name: vlan-interface
12783           in: path
12784           description: String that identifies the interface
12785           required: true
12786           type: string
12787           example: __VLAN-INTERFACE__
12788         - name: l3-interface-ipv6-address
12789           in: path
12790           description: IP address
12791           required: true
12792           type: string
12793           example: __L3-INTERFACE-IPV6-ADDRESS__
12794         - name: resource-version
12795           in: query
12796           description: resource-version for concurrency
12797           required: true
12798           type: string
12799   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
12800     get:
12801       tags:
12802         - CloudInfrastructure
12803       summary: returns vlan
12804       description: returns vlan
12805       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12806       produces:
12807         - application/json
12808         - application/xml
12809       responses:
12810         "200":
12811           description: successful operation
12812           schema:
12813               $ref: "#/getDefinitions/vlan"
12814         "default":
12815           description: Response codes found in [response codes](https://wiki.onap.org/).
12816       parameters:
12817         - name: hostname
12818           in: path
12819           description: Value from executing hostname on the compute node.
12820           required: true
12821           type: string
12822           example: __HOSTNAME__
12823         - name: interface-name
12824           in: path
12825           description: Name that identifies the link aggregate interface
12826           required: true
12827           type: string
12828           example: __INTERFACE-NAME__
12829         - name: interface-name
12830           in: path
12831           description: Name given to the interface
12832           required: true
12833           type: string
12834           example: __INTERFACE-NAME__
12835         - name: vlan-interface
12836           in: path
12837           description: String that identifies the interface
12838           required: true
12839           type: string
12840           example: __VLAN-INTERFACE__
12841         - name: inv-status
12842           in: query
12843           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12844           required: false
12845           type: string
12846         - name: pserver-id
12847           in: query
12848           description: ID of Pserver
12849           required: false
12850           type: string
12851         - name: in-maint
12852           in: query
12853           required: false
12854           type: boolean
12855         - name: pserver-name2
12856           in: query
12857           description: alternative pserver name
12858           required: false
12859           type: string
12860         - name: interface-id
12861           in: query
12862           description: ID of interface
12863           required: false
12864           type: string
12865         - name: interface-role
12866           in: query
12867           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12868           required: false
12869           type: string
12870         - name: interface-id
12871           in: query
12872           description: ID of interface
12873           required: false
12874           type: string
12875         - name: macaddr
12876           in: query
12877           description: MAC address for the interface
12878           required: false
12879           type: string
12880         - name: network-name
12881           in: query
12882           description: Name of the network
12883           required: false
12884           type: string
12885         - name: vlan-id-inner
12886           in: query
12887           description: Inner VLAN tag
12888           required: false
12889           type: integer
12890           format: int64
12891         - name: vpn-key
12892           in: query
12893           description: This indicates the customers VPN ID associated with this vlan
12894           required: false
12895           type: string
12896     put:
12897       tags:
12898         - CloudInfrastructure
12899       summary: create or update an existing vlan
12900       description: |
12901         Create or update an existing vlan.
12902         #
12903         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12904       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12905       consumes:
12906         - application/json
12907         - application/xml
12908       produces:
12909         - application/json
12910         - application/xml
12911       responses:
12912         "default":
12913           description: Response codes found in [response codes](https://wiki.onap.org/).
12914       parameters:
12915         - name: hostname
12916           in: path
12917           description: Value from executing hostname on the compute node.
12918           required: true
12919           type: string
12920           example: __HOSTNAME__
12921         - name: interface-name
12922           in: path
12923           description: Name that identifies the link aggregate interface
12924           required: true
12925           type: string
12926           example: __INTERFACE-NAME__
12927         - name: interface-name
12928           in: path
12929           description: Name given to the interface
12930           required: true
12931           type: string
12932           example: __INTERFACE-NAME__
12933         - name: vlan-interface
12934           in: path
12935           description: String that identifies the interface
12936           required: true
12937           type: string
12938           example: __VLAN-INTERFACE__
12939         - name: body
12940           in: body
12941           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12942           required: true
12943           schema:
12944             $ref: "#/definitions/vlan"
12945     patch:
12946       tags:
12947         - CloudInfrastructure
12948       summary: update an existing vlan
12949       description: |
12950         Update an existing vlan
12951         #
12952         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12953         The PUT operation will entirely replace an existing object.
12954         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12955         #
12956         Other differences between PUT and PATCH are:
12957         #
12958         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12959         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12960         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12961       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12962       consumes:
12963         - application/json
12964         - application/xml
12965       produces:
12966         - application/json
12967         - application/xml
12968       responses:
12969         "default":
12970           description: Response codes found in [response codes](https://wiki.onap.org/).
12971       parameters:
12972         - name: hostname
12973           in: path
12974           description: Value from executing hostname on the compute node.
12975           required: true
12976           type: string
12977           example: __HOSTNAME__
12978         - name: interface-name
12979           in: path
12980           description: Name that identifies the link aggregate interface
12981           required: true
12982           type: string
12983           example: __INTERFACE-NAME__
12984         - name: interface-name
12985           in: path
12986           description: Name given to the interface
12987           required: true
12988           type: string
12989           example: __INTERFACE-NAME__
12990         - name: vlan-interface
12991           in: path
12992           description: String that identifies the interface
12993           required: true
12994           type: string
12995           example: __VLAN-INTERFACE__
12996         - name: body
12997           in: body
12998           description: vlan object that needs to be created or updated.
12999           required: true
13000           schema:
13001             $ref: "#/patchDefinitions/vlan"
13002     delete:
13003       tags:
13004         - CloudInfrastructure
13005       summary: delete an existing vlan
13006       description: delete an existing vlan
13007       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13008       consumes:
13009         - application/json
13010         - application/xml
13011       produces:
13012         - application/json
13013         - application/xml
13014       responses:
13015         "default":
13016           description: Response codes found in [response codes](https://wiki.onap.org/).
13017       parameters:
13018         - name: hostname
13019           in: path
13020           description: Value from executing hostname on the compute node.
13021           required: true
13022           type: string
13023           example: __HOSTNAME__
13024         - name: interface-name
13025           in: path
13026           description: Name that identifies the link aggregate interface
13027           required: true
13028           type: string
13029           example: __INTERFACE-NAME__
13030         - name: interface-name
13031           in: path
13032           description: Name given to the interface
13033           required: true
13034           type: string
13035           example: __INTERFACE-NAME__
13036         - name: vlan-interface
13037           in: path
13038           description: String that identifies the interface
13039           required: true
13040           type: string
13041           example: __VLAN-INTERFACE__
13042         - name: resource-version
13043           in: query
13044           description: resource-version for concurrency
13045           required: true
13046           type: string
13047   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
13048     get:
13049       tags:
13050         - CloudInfrastructure
13051       summary: returns vlans
13052       description: returns vlans
13053       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
13054       produces:
13055         - application/json
13056         - application/xml
13057       responses:
13058         "200":
13059           description: successful operation
13060           schema:
13061               $ref: "#/getDefinitions/vlans"
13062         "default":
13063           description: Response codes found in [response codes](https://wiki.onap.org/).
13064       parameters:
13065         - name: hostname
13066           in: path
13067           description: Value from executing hostname on the compute node.
13068           required: true
13069           type: string
13070           example: __HOSTNAME__
13071         - name: interface-name
13072           in: path
13073           description: Name that identifies the link aggregate interface
13074           required: true
13075           type: string
13076           example: __INTERFACE-NAME__
13077         - name: interface-name
13078           in: path
13079           description: Name given to the interface
13080           required: true
13081           type: string
13082           example: __INTERFACE-NAME__
13083         - name: inv-status
13084           in: query
13085           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13086           required: false
13087           type: string
13088         - name: pserver-id
13089           in: query
13090           description: ID of Pserver
13091           required: false
13092           type: string
13093         - name: in-maint
13094           in: query
13095           required: false
13096           type: boolean
13097         - name: pserver-name2
13098           in: query
13099           description: alternative pserver name
13100           required: false
13101           type: string
13102         - name: interface-id
13103           in: query
13104           description: ID of interface
13105           required: false
13106           type: string
13107         - name: interface-role
13108           in: query
13109           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13110           required: false
13111           type: string
13112         - name: interface-id
13113           in: query
13114           description: ID of interface
13115           required: false
13116           type: string
13117         - name: macaddr
13118           in: query
13119           description: MAC address for the interface
13120           required: false
13121           type: string
13122         - name: network-name
13123           in: query
13124           description: Name of the network
13125           required: false
13126           type: string
13127   /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:
13128     put:
13129       tags:
13130         - CloudInfrastructure
13131       summary: see node definition for valid relationships
13132       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13133       consumes:
13134         - application/json
13135         - application/xml
13136       produces:
13137         - application/json
13138         - application/xml
13139       responses:
13140         "default":
13141           description: Response codes found in [response codes](https://wiki.onap.org/).
13142       parameters:
13143         - name: hostname
13144           in: path
13145           description: Value from executing hostname on the compute node.
13146           required: true
13147           type: string
13148           example: __HOSTNAME__
13149         - name: interface-name
13150           in: path
13151           description: Name that identifies the link aggregate interface
13152           required: true
13153           type: string
13154           example: __INTERFACE-NAME__
13155         - name: interface-name
13156           in: path
13157           description: Name given to the interface
13158           required: true
13159           type: string
13160           example: __INTERFACE-NAME__
13161         - name: pci-id
13162           in: path
13163           description: PCI ID used to identify the sriov-vf
13164           required: true
13165           type: string
13166           example: __PCI-ID__
13167         - name: body
13168           in: body
13169           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13170           required: true
13171           schema:
13172             $ref: "#/definitions/relationship"
13173     delete:
13174       tags:
13175         - CloudInfrastructure
13176       summary: delete an existing relationship
13177       description: delete an existing relationship
13178       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13179       consumes:
13180         - application/json
13181         - application/xml
13182       produces:
13183         - application/json
13184         - application/xml
13185       responses:
13186         "default":
13187           description: Response codes found in [response codes](https://wiki.onap.org/).
13188       parameters:
13189         - name: hostname
13190           in: path
13191           description: Value from executing hostname on the compute node.
13192           required: true
13193           type: string
13194           example: __HOSTNAME__
13195         - name: interface-name
13196           in: path
13197           description: Name that identifies the link aggregate interface
13198           required: true
13199           type: string
13200           example: __INTERFACE-NAME__
13201         - name: interface-name
13202           in: path
13203           description: Name given to the interface
13204           required: true
13205           type: string
13206           example: __INTERFACE-NAME__
13207         - name: pci-id
13208           in: path
13209           description: PCI ID used to identify the sriov-vf
13210           required: true
13211           type: string
13212           example: __PCI-ID__
13213   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
13214     get:
13215       tags:
13216         - CloudInfrastructure
13217       summary: returns sriov-vf
13218       description: returns sriov-vf
13219       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13220       produces:
13221         - application/json
13222         - application/xml
13223       responses:
13224         "200":
13225           description: successful operation
13226           schema:
13227               $ref: "#/getDefinitions/sriov-vf"
13228         "default":
13229           description: Response codes found in [response codes](https://wiki.onap.org/).
13230       parameters:
13231         - name: hostname
13232           in: path
13233           description: Value from executing hostname on the compute node.
13234           required: true
13235           type: string
13236           example: __HOSTNAME__
13237         - name: interface-name
13238           in: path
13239           description: Name that identifies the link aggregate interface
13240           required: true
13241           type: string
13242           example: __INTERFACE-NAME__
13243         - name: interface-name
13244           in: path
13245           description: Name given to the interface
13246           required: true
13247           type: string
13248           example: __INTERFACE-NAME__
13249         - name: pci-id
13250           in: path
13251           description: PCI ID used to identify the sriov-vf
13252           required: true
13253           type: string
13254           example: __PCI-ID__
13255         - name: inv-status
13256           in: query
13257           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13258           required: false
13259           type: string
13260         - name: pserver-id
13261           in: query
13262           description: ID of Pserver
13263           required: false
13264           type: string
13265         - name: in-maint
13266           in: query
13267           required: false
13268           type: boolean
13269         - name: pserver-name2
13270           in: query
13271           description: alternative pserver name
13272           required: false
13273           type: string
13274         - name: interface-id
13275           in: query
13276           description: ID of interface
13277           required: false
13278           type: string
13279         - name: interface-role
13280           in: query
13281           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13282           required: false
13283           type: string
13284         - name: interface-id
13285           in: query
13286           description: ID of interface
13287           required: false
13288           type: string
13289         - name: macaddr
13290           in: query
13291           description: MAC address for the interface
13292           required: false
13293           type: string
13294         - name: network-name
13295           in: query
13296           description: Name of the network
13297           required: false
13298           type: string
13299         - name: vf-vlan-filter
13300           in: query
13301           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
13302           required: false
13303           type: string
13304         - name: vf-mac-filter
13305           in: query
13306           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
13307           required: false
13308           type: string
13309         - name: vf-vlan-strip
13310           in: query
13311           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
13312           required: false
13313           type: boolean
13314         - name: neutron-network-id
13315           in: query
13316           description: Neutron network id of the interface
13317           required: false
13318           type: string
13319     put:
13320       tags:
13321         - CloudInfrastructure
13322       summary: create or update an existing sriov-vf
13323       description: |
13324         Create or update an existing sriov-vf.
13325         #
13326         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13327       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13328       consumes:
13329         - application/json
13330         - application/xml
13331       produces:
13332         - application/json
13333         - application/xml
13334       responses:
13335         "default":
13336           description: Response codes found in [response codes](https://wiki.onap.org/).
13337       parameters:
13338         - name: hostname
13339           in: path
13340           description: Value from executing hostname on the compute node.
13341           required: true
13342           type: string
13343           example: __HOSTNAME__
13344         - name: interface-name
13345           in: path
13346           description: Name that identifies the link aggregate interface
13347           required: true
13348           type: string
13349           example: __INTERFACE-NAME__
13350         - name: interface-name
13351           in: path
13352           description: Name given to the interface
13353           required: true
13354           type: string
13355           example: __INTERFACE-NAME__
13356         - name: pci-id
13357           in: path
13358           description: PCI ID used to identify the sriov-vf
13359           required: true
13360           type: string
13361           example: __PCI-ID__
13362         - name: body
13363           in: body
13364           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13365           required: true
13366           schema:
13367             $ref: "#/definitions/sriov-vf"
13368     patch:
13369       tags:
13370         - CloudInfrastructure
13371       summary: update an existing sriov-vf
13372       description: |
13373         Update an existing sriov-vf
13374         #
13375         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13376         The PUT operation will entirely replace an existing object.
13377         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13378         #
13379         Other differences between PUT and PATCH are:
13380         #
13381         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13382         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13383         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13384       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13385       consumes:
13386         - application/json
13387         - application/xml
13388       produces:
13389         - application/json
13390         - application/xml
13391       responses:
13392         "default":
13393           description: Response codes found in [response codes](https://wiki.onap.org/).
13394       parameters:
13395         - name: hostname
13396           in: path
13397           description: Value from executing hostname on the compute node.
13398           required: true
13399           type: string
13400           example: __HOSTNAME__
13401         - name: interface-name
13402           in: path
13403           description: Name that identifies the link aggregate interface
13404           required: true
13405           type: string
13406           example: __INTERFACE-NAME__
13407         - name: interface-name
13408           in: path
13409           description: Name given to the interface
13410           required: true
13411           type: string
13412           example: __INTERFACE-NAME__
13413         - name: pci-id
13414           in: path
13415           description: PCI ID used to identify the sriov-vf
13416           required: true
13417           type: string
13418           example: __PCI-ID__
13419         - name: body
13420           in: body
13421           description: sriov-vf object that needs to be created or updated.
13422           required: true
13423           schema:
13424             $ref: "#/patchDefinitions/sriov-vf"
13425     delete:
13426       tags:
13427         - CloudInfrastructure
13428       summary: delete an existing sriov-vf
13429       description: delete an existing sriov-vf
13430       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13431       consumes:
13432         - application/json
13433         - application/xml
13434       produces:
13435         - application/json
13436         - application/xml
13437       responses:
13438         "default":
13439           description: Response codes found in [response codes](https://wiki.onap.org/).
13440       parameters:
13441         - name: hostname
13442           in: path
13443           description: Value from executing hostname on the compute node.
13444           required: true
13445           type: string
13446           example: __HOSTNAME__
13447         - name: interface-name
13448           in: path
13449           description: Name that identifies the link aggregate interface
13450           required: true
13451           type: string
13452           example: __INTERFACE-NAME__
13453         - name: interface-name
13454           in: path
13455           description: Name given to the interface
13456           required: true
13457           type: string
13458           example: __INTERFACE-NAME__
13459         - name: pci-id
13460           in: path
13461           description: PCI ID used to identify the sriov-vf
13462           required: true
13463           type: string
13464           example: __PCI-ID__
13465         - name: resource-version
13466           in: query
13467           description: resource-version for concurrency
13468           required: true
13469           type: string
13470   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
13471     get:
13472       tags:
13473         - CloudInfrastructure
13474       summary: returns sriov-vfs
13475       description: returns sriov-vfs
13476       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
13477       produces:
13478         - application/json
13479         - application/xml
13480       responses:
13481         "200":
13482           description: successful operation
13483           schema:
13484               $ref: "#/getDefinitions/sriov-vfs"
13485         "default":
13486           description: Response codes found in [response codes](https://wiki.onap.org/).
13487       parameters:
13488         - name: hostname
13489           in: path
13490           description: Value from executing hostname on the compute node.
13491           required: true
13492           type: string
13493           example: __HOSTNAME__
13494         - name: interface-name
13495           in: path
13496           description: Name that identifies the link aggregate interface
13497           required: true
13498           type: string
13499           example: __INTERFACE-NAME__
13500         - name: interface-name
13501           in: path
13502           description: Name given to the interface
13503           required: true
13504           type: string
13505           example: __INTERFACE-NAME__
13506         - name: inv-status
13507           in: query
13508           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13509           required: false
13510           type: string
13511         - name: pserver-id
13512           in: query
13513           description: ID of Pserver
13514           required: false
13515           type: string
13516         - name: in-maint
13517           in: query
13518           required: false
13519           type: boolean
13520         - name: pserver-name2
13521           in: query
13522           description: alternative pserver name
13523           required: false
13524           type: string
13525         - name: interface-id
13526           in: query
13527           description: ID of interface
13528           required: false
13529           type: string
13530         - name: interface-role
13531           in: query
13532           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13533           required: false
13534           type: string
13535         - name: interface-id
13536           in: query
13537           description: ID of interface
13538           required: false
13539           type: string
13540         - name: macaddr
13541           in: query
13542           description: MAC address for the interface
13543           required: false
13544           type: string
13545         - name: network-name
13546           in: query
13547           description: Name of the network
13548           required: false
13549           type: string
13550   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
13551     put:
13552       tags:
13553         - CloudInfrastructure
13554       summary: see node definition for valid relationships
13555       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13556       consumes:
13557         - application/json
13558         - application/xml
13559       produces:
13560         - application/json
13561         - application/xml
13562       responses:
13563         "default":
13564           description: Response codes found in [response codes](https://wiki.onap.org/).
13565       parameters:
13566         - name: hostname
13567           in: path
13568           description: Value from executing hostname on the compute node.
13569           required: true
13570           type: string
13571           example: __HOSTNAME__
13572         - name: interface-name
13573           in: path
13574           description: Name that identifies the link aggregate interface
13575           required: true
13576           type: string
13577           example: __INTERFACE-NAME__
13578         - name: interface-name
13579           in: path
13580           description: Name given to the interface
13581           required: true
13582           type: string
13583           example: __INTERFACE-NAME__
13584         - name: body
13585           in: body
13586           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13587           required: true
13588           schema:
13589             $ref: "#/definitions/relationship"
13590     delete:
13591       tags:
13592         - CloudInfrastructure
13593       summary: delete an existing relationship
13594       description: delete an existing relationship
13595       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13596       consumes:
13597         - application/json
13598         - application/xml
13599       produces:
13600         - application/json
13601         - application/xml
13602       responses:
13603         "default":
13604           description: Response codes found in [response codes](https://wiki.onap.org/).
13605       parameters:
13606         - name: hostname
13607           in: path
13608           description: Value from executing hostname on the compute node.
13609           required: true
13610           type: string
13611           example: __HOSTNAME__
13612         - name: interface-name
13613           in: path
13614           description: Name that identifies the link aggregate interface
13615           required: true
13616           type: string
13617           example: __INTERFACE-NAME__
13618         - name: interface-name
13619           in: path
13620           description: Name given to the interface
13621           required: true
13622           type: string
13623           example: __INTERFACE-NAME__
13624   /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:
13625     put:
13626       tags:
13627         - CloudInfrastructure
13628       summary: see node definition for valid relationships
13629       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13630       consumes:
13631         - application/json
13632         - application/xml
13633       produces:
13634         - application/json
13635         - application/xml
13636       responses:
13637         "default":
13638           description: Response codes found in [response codes](https://wiki.onap.org/).
13639       parameters:
13640         - name: hostname
13641           in: path
13642           description: Value from executing hostname on the compute node.
13643           required: true
13644           type: string
13645           example: __HOSTNAME__
13646         - name: interface-name
13647           in: path
13648           description: Name that identifies the link aggregate interface
13649           required: true
13650           type: string
13651           example: __INTERFACE-NAME__
13652         - name: interface-name
13653           in: path
13654           description: Name given to the interface
13655           required: true
13656           type: string
13657           example: __INTERFACE-NAME__
13658         - name: l3-interface-ipv4-address
13659           in: path
13660           description: IP address
13661           required: true
13662           type: string
13663           example: __L3-INTERFACE-IPV4-ADDRESS__
13664         - name: body
13665           in: body
13666           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13667           required: true
13668           schema:
13669             $ref: "#/definitions/relationship"
13670     delete:
13671       tags:
13672         - CloudInfrastructure
13673       summary: delete an existing relationship
13674       description: delete an existing relationship
13675       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13676       consumes:
13677         - application/json
13678         - application/xml
13679       produces:
13680         - application/json
13681         - application/xml
13682       responses:
13683         "default":
13684           description: Response codes found in [response codes](https://wiki.onap.org/).
13685       parameters:
13686         - name: hostname
13687           in: path
13688           description: Value from executing hostname on the compute node.
13689           required: true
13690           type: string
13691           example: __HOSTNAME__
13692         - name: interface-name
13693           in: path
13694           description: Name that identifies the link aggregate interface
13695           required: true
13696           type: string
13697           example: __INTERFACE-NAME__
13698         - name: interface-name
13699           in: path
13700           description: Name given to the interface
13701           required: true
13702           type: string
13703           example: __INTERFACE-NAME__
13704         - name: l3-interface-ipv4-address
13705           in: path
13706           description: IP address
13707           required: true
13708           type: string
13709           example: __L3-INTERFACE-IPV4-ADDRESS__
13710   /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}:
13711     get:
13712       tags:
13713         - CloudInfrastructure
13714       summary: returns l3-interface-ipv4-address-list
13715       description: returns l3-interface-ipv4-address-list
13716       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13717       produces:
13718         - application/json
13719         - application/xml
13720       responses:
13721         "200":
13722           description: successful operation
13723           schema:
13724               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13725         "default":
13726           description: Response codes found in [response codes](https://wiki.onap.org/).
13727       parameters:
13728         - name: hostname
13729           in: path
13730           description: Value from executing hostname on the compute node.
13731           required: true
13732           type: string
13733           example: __HOSTNAME__
13734         - name: interface-name
13735           in: path
13736           description: Name that identifies the link aggregate interface
13737           required: true
13738           type: string
13739           example: __INTERFACE-NAME__
13740         - name: interface-name
13741           in: path
13742           description: Name given to the interface
13743           required: true
13744           type: string
13745           example: __INTERFACE-NAME__
13746         - name: l3-interface-ipv4-address
13747           in: path
13748           description: IP address
13749           required: true
13750           type: string
13751           example: __L3-INTERFACE-IPV4-ADDRESS__
13752         - name: inv-status
13753           in: query
13754           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13755           required: false
13756           type: string
13757         - name: pserver-id
13758           in: query
13759           description: ID of Pserver
13760           required: false
13761           type: string
13762         - name: in-maint
13763           in: query
13764           required: false
13765           type: boolean
13766         - name: pserver-name2
13767           in: query
13768           description: alternative pserver name
13769           required: false
13770           type: string
13771         - name: interface-id
13772           in: query
13773           description: ID of interface
13774           required: false
13775           type: string
13776         - name: interface-role
13777           in: query
13778           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13779           required: false
13780           type: string
13781         - name: interface-id
13782           in: query
13783           description: ID of interface
13784           required: false
13785           type: string
13786         - name: macaddr
13787           in: query
13788           description: MAC address for the interface
13789           required: false
13790           type: string
13791         - name: network-name
13792           in: query
13793           description: Name of the network
13794           required: false
13795           type: string
13796         - name: vlan-id-inner
13797           in: query
13798           description: Inner VLAN tag
13799           required: false
13800           type: integer
13801           format: int64
13802         - name: neutron-network-id
13803           in: query
13804           description: Neutron network id of the interface that address belongs to
13805           required: false
13806           type: string
13807         - name: neutron-subnet-id
13808           in: query
13809           description: Neutron id of subnet that address belongs to
13810           required: false
13811           type: string
13812     put:
13813       tags:
13814         - CloudInfrastructure
13815       summary: create or update an existing l3-interface-ipv4-address-list
13816       description: |
13817         Create or update an existing l3-interface-ipv4-address-list.
13818         #
13819         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13820       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13821       consumes:
13822         - application/json
13823         - application/xml
13824       produces:
13825         - application/json
13826         - application/xml
13827       responses:
13828         "default":
13829           description: Response codes found in [response codes](https://wiki.onap.org/).
13830       parameters:
13831         - name: hostname
13832           in: path
13833           description: Value from executing hostname on the compute node.
13834           required: true
13835           type: string
13836           example: __HOSTNAME__
13837         - name: interface-name
13838           in: path
13839           description: Name that identifies the link aggregate interface
13840           required: true
13841           type: string
13842           example: __INTERFACE-NAME__
13843         - name: interface-name
13844           in: path
13845           description: Name given to the interface
13846           required: true
13847           type: string
13848           example: __INTERFACE-NAME__
13849         - name: l3-interface-ipv4-address
13850           in: path
13851           description: IP address
13852           required: true
13853           type: string
13854           example: __L3-INTERFACE-IPV4-ADDRESS__
13855         - name: body
13856           in: body
13857           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13858           required: true
13859           schema:
13860             $ref: "#/definitions/l3-interface-ipv4-address-list"
13861     patch:
13862       tags:
13863         - CloudInfrastructure
13864       summary: update an existing l3-interface-ipv4-address-list
13865       description: |
13866         Update an existing l3-interface-ipv4-address-list
13867         #
13868         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13869         The PUT operation will entirely replace an existing object.
13870         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13871         #
13872         Other differences between PUT and PATCH are:
13873         #
13874         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13875         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13876         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13877       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13878       consumes:
13879         - application/json
13880         - application/xml
13881       produces:
13882         - application/json
13883         - application/xml
13884       responses:
13885         "default":
13886           description: Response codes found in [response codes](https://wiki.onap.org/).
13887       parameters:
13888         - name: hostname
13889           in: path
13890           description: Value from executing hostname on the compute node.
13891           required: true
13892           type: string
13893           example: __HOSTNAME__
13894         - name: interface-name
13895           in: path
13896           description: Name that identifies the link aggregate interface
13897           required: true
13898           type: string
13899           example: __INTERFACE-NAME__
13900         - name: interface-name
13901           in: path
13902           description: Name given to the interface
13903           required: true
13904           type: string
13905           example: __INTERFACE-NAME__
13906         - name: l3-interface-ipv4-address
13907           in: path
13908           description: IP address
13909           required: true
13910           type: string
13911           example: __L3-INTERFACE-IPV4-ADDRESS__
13912         - name: body
13913           in: body
13914           description: l3-interface-ipv4-address-list object that needs to be created or updated.
13915           required: true
13916           schema:
13917             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13918     delete:
13919       tags:
13920         - CloudInfrastructure
13921       summary: delete an existing l3-interface-ipv4-address-list
13922       description: delete an existing l3-interface-ipv4-address-list
13923       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13924       consumes:
13925         - application/json
13926         - application/xml
13927       produces:
13928         - application/json
13929         - application/xml
13930       responses:
13931         "default":
13932           description: Response codes found in [response codes](https://wiki.onap.org/).
13933       parameters:
13934         - name: hostname
13935           in: path
13936           description: Value from executing hostname on the compute node.
13937           required: true
13938           type: string
13939           example: __HOSTNAME__
13940         - name: interface-name
13941           in: path
13942           description: Name that identifies the link aggregate interface
13943           required: true
13944           type: string
13945           example: __INTERFACE-NAME__
13946         - name: interface-name
13947           in: path
13948           description: Name given to the interface
13949           required: true
13950           type: string
13951           example: __INTERFACE-NAME__
13952         - name: l3-interface-ipv4-address
13953           in: path
13954           description: IP address
13955           required: true
13956           type: string
13957           example: __L3-INTERFACE-IPV4-ADDRESS__
13958         - name: resource-version
13959           in: query
13960           description: resource-version for concurrency
13961           required: true
13962           type: string
13963   /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:
13964     put:
13965       tags:
13966         - CloudInfrastructure
13967       summary: see node definition for valid relationships
13968       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13969       consumes:
13970         - application/json
13971         - application/xml
13972       produces:
13973         - application/json
13974         - application/xml
13975       responses:
13976         "default":
13977           description: Response codes found in [response codes](https://wiki.onap.org/).
13978       parameters:
13979         - name: hostname
13980           in: path
13981           description: Value from executing hostname on the compute node.
13982           required: true
13983           type: string
13984           example: __HOSTNAME__
13985         - name: interface-name
13986           in: path
13987           description: Name that identifies the link aggregate interface
13988           required: true
13989           type: string
13990           example: __INTERFACE-NAME__
13991         - name: interface-name
13992           in: path
13993           description: Name given to the interface
13994           required: true
13995           type: string
13996           example: __INTERFACE-NAME__
13997         - name: l3-interface-ipv6-address
13998           in: path
13999           description: IP address
14000           required: true
14001           type: string
14002           example: __L3-INTERFACE-IPV6-ADDRESS__
14003         - name: body
14004           in: body
14005           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14006           required: true
14007           schema:
14008             $ref: "#/definitions/relationship"
14009     delete:
14010       tags:
14011         - CloudInfrastructure
14012       summary: delete an existing relationship
14013       description: delete an existing relationship
14014       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14015       consumes:
14016         - application/json
14017         - application/xml
14018       produces:
14019         - application/json
14020         - application/xml
14021       responses:
14022         "default":
14023           description: Response codes found in [response codes](https://wiki.onap.org/).
14024       parameters:
14025         - name: hostname
14026           in: path
14027           description: Value from executing hostname on the compute node.
14028           required: true
14029           type: string
14030           example: __HOSTNAME__
14031         - name: interface-name
14032           in: path
14033           description: Name that identifies the link aggregate interface
14034           required: true
14035           type: string
14036           example: __INTERFACE-NAME__
14037         - name: interface-name
14038           in: path
14039           description: Name given to the interface
14040           required: true
14041           type: string
14042           example: __INTERFACE-NAME__
14043         - name: l3-interface-ipv6-address
14044           in: path
14045           description: IP address
14046           required: true
14047           type: string
14048           example: __L3-INTERFACE-IPV6-ADDRESS__
14049   /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}:
14050     get:
14051       tags:
14052         - CloudInfrastructure
14053       summary: returns l3-interface-ipv6-address-list
14054       description: returns l3-interface-ipv6-address-list
14055       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14056       produces:
14057         - application/json
14058         - application/xml
14059       responses:
14060         "200":
14061           description: successful operation
14062           schema:
14063               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
14064         "default":
14065           description: Response codes found in [response codes](https://wiki.onap.org/).
14066       parameters:
14067         - name: hostname
14068           in: path
14069           description: Value from executing hostname on the compute node.
14070           required: true
14071           type: string
14072           example: __HOSTNAME__
14073         - name: interface-name
14074           in: path
14075           description: Name that identifies the link aggregate interface
14076           required: true
14077           type: string
14078           example: __INTERFACE-NAME__
14079         - name: interface-name
14080           in: path
14081           description: Name given to the interface
14082           required: true
14083           type: string
14084           example: __INTERFACE-NAME__
14085         - name: l3-interface-ipv6-address
14086           in: path
14087           description: IP address
14088           required: true
14089           type: string
14090           example: __L3-INTERFACE-IPV6-ADDRESS__
14091         - name: inv-status
14092           in: query
14093           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14094           required: false
14095           type: string
14096         - name: pserver-id
14097           in: query
14098           description: ID of Pserver
14099           required: false
14100           type: string
14101         - name: in-maint
14102           in: query
14103           required: false
14104           type: boolean
14105         - name: pserver-name2
14106           in: query
14107           description: alternative pserver name
14108           required: false
14109           type: string
14110         - name: interface-id
14111           in: query
14112           description: ID of interface
14113           required: false
14114           type: string
14115         - name: interface-role
14116           in: query
14117           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14118           required: false
14119           type: string
14120         - name: interface-id
14121           in: query
14122           description: ID of interface
14123           required: false
14124           type: string
14125         - name: macaddr
14126           in: query
14127           description: MAC address for the interface
14128           required: false
14129           type: string
14130         - name: network-name
14131           in: query
14132           description: Name of the network
14133           required: false
14134           type: string
14135         - name: vlan-id-inner
14136           in: query
14137           description: Inner VLAN tag
14138           required: false
14139           type: integer
14140           format: int64
14141         - name: neutron-network-id
14142           in: query
14143           description: Neutron network id of the interface that address belongs to
14144           required: false
14145           type: string
14146         - name: neutron-subnet-id
14147           in: query
14148           description: Neutron id of subnet that address belongs to
14149           required: false
14150           type: string
14151     put:
14152       tags:
14153         - CloudInfrastructure
14154       summary: create or update an existing l3-interface-ipv6-address-list
14155       description: |
14156         Create or update an existing l3-interface-ipv6-address-list.
14157         #
14158         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14159       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14160       consumes:
14161         - application/json
14162         - application/xml
14163       produces:
14164         - application/json
14165         - application/xml
14166       responses:
14167         "default":
14168           description: Response codes found in [response codes](https://wiki.onap.org/).
14169       parameters:
14170         - name: hostname
14171           in: path
14172           description: Value from executing hostname on the compute node.
14173           required: true
14174           type: string
14175           example: __HOSTNAME__
14176         - name: interface-name
14177           in: path
14178           description: Name that identifies the link aggregate interface
14179           required: true
14180           type: string
14181           example: __INTERFACE-NAME__
14182         - name: interface-name
14183           in: path
14184           description: Name given to the interface
14185           required: true
14186           type: string
14187           example: __INTERFACE-NAME__
14188         - name: l3-interface-ipv6-address
14189           in: path
14190           description: IP address
14191           required: true
14192           type: string
14193           example: __L3-INTERFACE-IPV6-ADDRESS__
14194         - name: body
14195           in: body
14196           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14197           required: true
14198           schema:
14199             $ref: "#/definitions/l3-interface-ipv6-address-list"
14200     patch:
14201       tags:
14202         - CloudInfrastructure
14203       summary: update an existing l3-interface-ipv6-address-list
14204       description: |
14205         Update an existing l3-interface-ipv6-address-list
14206         #
14207         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14208         The PUT operation will entirely replace an existing object.
14209         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14210         #
14211         Other differences between PUT and PATCH are:
14212         #
14213         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14214         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14215         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14216       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14217       consumes:
14218         - application/json
14219         - application/xml
14220       produces:
14221         - application/json
14222         - application/xml
14223       responses:
14224         "default":
14225           description: Response codes found in [response codes](https://wiki.onap.org/).
14226       parameters:
14227         - name: hostname
14228           in: path
14229           description: Value from executing hostname on the compute node.
14230           required: true
14231           type: string
14232           example: __HOSTNAME__
14233         - name: interface-name
14234           in: path
14235           description: Name that identifies the link aggregate interface
14236           required: true
14237           type: string
14238           example: __INTERFACE-NAME__
14239         - name: interface-name
14240           in: path
14241           description: Name given to the interface
14242           required: true
14243           type: string
14244           example: __INTERFACE-NAME__
14245         - name: l3-interface-ipv6-address
14246           in: path
14247           description: IP address
14248           required: true
14249           type: string
14250           example: __L3-INTERFACE-IPV6-ADDRESS__
14251         - name: body
14252           in: body
14253           description: l3-interface-ipv6-address-list object that needs to be created or updated.
14254           required: true
14255           schema:
14256             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
14257     delete:
14258       tags:
14259         - CloudInfrastructure
14260       summary: delete an existing l3-interface-ipv6-address-list
14261       description: delete an existing l3-interface-ipv6-address-list
14262       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14263       consumes:
14264         - application/json
14265         - application/xml
14266       produces:
14267         - application/json
14268         - application/xml
14269       responses:
14270         "default":
14271           description: Response codes found in [response codes](https://wiki.onap.org/).
14272       parameters:
14273         - name: hostname
14274           in: path
14275           description: Value from executing hostname on the compute node.
14276           required: true
14277           type: string
14278           example: __HOSTNAME__
14279         - name: interface-name
14280           in: path
14281           description: Name that identifies the link aggregate interface
14282           required: true
14283           type: string
14284           example: __INTERFACE-NAME__
14285         - name: interface-name
14286           in: path
14287           description: Name given to the interface
14288           required: true
14289           type: string
14290           example: __INTERFACE-NAME__
14291         - name: l3-interface-ipv6-address
14292           in: path
14293           description: IP address
14294           required: true
14295           type: string
14296           example: __L3-INTERFACE-IPV6-ADDRESS__
14297         - name: resource-version
14298           in: query
14299           description: resource-version for concurrency
14300           required: true
14301           type: string
14302   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
14303     get:
14304       tags:
14305         - CloudInfrastructure
14306       summary: returns l-interface
14307       description: returns l-interface
14308       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14309       produces:
14310         - application/json
14311         - application/xml
14312       responses:
14313         "200":
14314           description: successful operation
14315           schema:
14316               $ref: "#/getDefinitions/l-interface"
14317         "default":
14318           description: Response codes found in [response codes](https://wiki.onap.org/).
14319       parameters:
14320         - name: hostname
14321           in: path
14322           description: Value from executing hostname on the compute node.
14323           required: true
14324           type: string
14325           example: __HOSTNAME__
14326         - name: interface-name
14327           in: path
14328           description: Name that identifies the link aggregate interface
14329           required: true
14330           type: string
14331           example: __INTERFACE-NAME__
14332         - name: interface-name
14333           in: path
14334           description: Name given to the interface
14335           required: true
14336           type: string
14337           example: __INTERFACE-NAME__
14338         - name: inv-status
14339           in: query
14340           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14341           required: false
14342           type: string
14343         - name: pserver-id
14344           in: query
14345           description: ID of Pserver
14346           required: false
14347           type: string
14348         - name: in-maint
14349           in: query
14350           required: false
14351           type: boolean
14352         - name: pserver-name2
14353           in: query
14354           description: alternative pserver name
14355           required: false
14356           type: string
14357         - name: interface-id
14358           in: query
14359           description: ID of interface
14360           required: false
14361           type: string
14362         - name: interface-role
14363           in: query
14364           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14365           required: false
14366           type: string
14367         - name: interface-id
14368           in: query
14369           description: ID of interface
14370           required: false
14371           type: string
14372         - name: macaddr
14373           in: query
14374           description: MAC address for the interface
14375           required: false
14376           type: string
14377         - name: network-name
14378           in: query
14379           description: Name of the network
14380           required: false
14381           type: string
14382     put:
14383       tags:
14384         - CloudInfrastructure
14385       summary: create or update an existing l-interface
14386       description: |
14387         Create or update an existing l-interface.
14388         #
14389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14390       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14391       consumes:
14392         - application/json
14393         - application/xml
14394       produces:
14395         - application/json
14396         - application/xml
14397       responses:
14398         "default":
14399           description: Response codes found in [response codes](https://wiki.onap.org/).
14400       parameters:
14401         - name: hostname
14402           in: path
14403           description: Value from executing hostname on the compute node.
14404           required: true
14405           type: string
14406           example: __HOSTNAME__
14407         - name: interface-name
14408           in: path
14409           description: Name that identifies the link aggregate interface
14410           required: true
14411           type: string
14412           example: __INTERFACE-NAME__
14413         - name: interface-name
14414           in: path
14415           description: Name given to the interface
14416           required: true
14417           type: string
14418           example: __INTERFACE-NAME__
14419         - name: body
14420           in: body
14421           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
14422           required: true
14423           schema:
14424             $ref: "#/definitions/l-interface"
14425     patch:
14426       tags:
14427         - CloudInfrastructure
14428       summary: update an existing l-interface
14429       description: |
14430         Update an existing l-interface
14431         #
14432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14433         The PUT operation will entirely replace an existing object.
14434         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14435         #
14436         Other differences between PUT and PATCH are:
14437         #
14438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14441       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14442       consumes:
14443         - application/json
14444         - application/xml
14445       produces:
14446         - application/json
14447         - application/xml
14448       responses:
14449         "default":
14450           description: Response codes found in [response codes](https://wiki.onap.org/).
14451       parameters:
14452         - name: hostname
14453           in: path
14454           description: Value from executing hostname on the compute node.
14455           required: true
14456           type: string
14457           example: __HOSTNAME__
14458         - name: interface-name
14459           in: path
14460           description: Name that identifies the link aggregate interface
14461           required: true
14462           type: string
14463           example: __INTERFACE-NAME__
14464         - name: interface-name
14465           in: path
14466           description: Name given to the interface
14467           required: true
14468           type: string
14469           example: __INTERFACE-NAME__
14470         - name: body
14471           in: body
14472           description: l-interface object that needs to be created or updated.
14473           required: true
14474           schema:
14475             $ref: "#/patchDefinitions/l-interface"
14476     delete:
14477       tags:
14478         - CloudInfrastructure
14479       summary: delete an existing l-interface
14480       description: delete an existing l-interface
14481       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14482       consumes:
14483         - application/json
14484         - application/xml
14485       produces:
14486         - application/json
14487         - application/xml
14488       responses:
14489         "default":
14490           description: Response codes found in [response codes](https://wiki.onap.org/).
14491       parameters:
14492         - name: hostname
14493           in: path
14494           description: Value from executing hostname on the compute node.
14495           required: true
14496           type: string
14497           example: __HOSTNAME__
14498         - name: interface-name
14499           in: path
14500           description: Name that identifies the link aggregate interface
14501           required: true
14502           type: string
14503           example: __INTERFACE-NAME__
14504         - name: interface-name
14505           in: path
14506           description: Name given to the interface
14507           required: true
14508           type: string
14509           example: __INTERFACE-NAME__
14510         - name: resource-version
14511           in: query
14512           description: resource-version for concurrency
14513           required: true
14514           type: string
14515   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
14516     get:
14517       tags:
14518         - CloudInfrastructure
14519       summary: returns l-interfaces
14520       description: returns l-interfaces
14521       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
14522       produces:
14523         - application/json
14524         - application/xml
14525       responses:
14526         "200":
14527           description: successful operation
14528           schema:
14529               $ref: "#/getDefinitions/l-interfaces"
14530         "default":
14531           description: Response codes found in [response codes](https://wiki.onap.org/).
14532       parameters:
14533         - name: hostname
14534           in: path
14535           description: Value from executing hostname on the compute node.
14536           required: true
14537           type: string
14538           example: __HOSTNAME__
14539         - name: interface-name
14540           in: path
14541           description: Name that identifies the link aggregate interface
14542           required: true
14543           type: string
14544           example: __INTERFACE-NAME__
14545         - name: inv-status
14546           in: query
14547           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14548           required: false
14549           type: string
14550         - name: pserver-id
14551           in: query
14552           description: ID of Pserver
14553           required: false
14554           type: string
14555         - name: in-maint
14556           in: query
14557           required: false
14558           type: boolean
14559         - name: pserver-name2
14560           in: query
14561           description: alternative pserver name
14562           required: false
14563           type: string
14564         - name: interface-id
14565           in: query
14566           description: ID of interface
14567           required: false
14568           type: string
14569         - name: interface-role
14570           in: query
14571           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14572           required: false
14573           type: string
14574   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
14575     get:
14576       tags:
14577         - CloudInfrastructure
14578       summary: returns lag-interface
14579       description: returns lag-interface
14580       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
14581       produces:
14582         - application/json
14583         - application/xml
14584       responses:
14585         "200":
14586           description: successful operation
14587           schema:
14588               $ref: "#/getDefinitions/lag-interface"
14589         "default":
14590           description: Response codes found in [response codes](https://wiki.onap.org/).
14591       parameters:
14592         - name: hostname
14593           in: path
14594           description: Value from executing hostname on the compute node.
14595           required: true
14596           type: string
14597           example: __HOSTNAME__
14598         - name: interface-name
14599           in: path
14600           description: Name that identifies the link aggregate interface
14601           required: true
14602           type: string
14603           example: __INTERFACE-NAME__
14604         - name: inv-status
14605           in: query
14606           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14607           required: false
14608           type: string
14609         - name: pserver-id
14610           in: query
14611           description: ID of Pserver
14612           required: false
14613           type: string
14614         - name: in-maint
14615           in: query
14616           required: false
14617           type: boolean
14618         - name: pserver-name2
14619           in: query
14620           description: alternative pserver name
14621           required: false
14622           type: string
14623         - name: interface-id
14624           in: query
14625           description: ID of interface
14626           required: false
14627           type: string
14628         - name: interface-role
14629           in: query
14630           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14631           required: false
14632           type: string
14633     put:
14634       tags:
14635         - CloudInfrastructure
14636       summary: create or update an existing lag-interface
14637       description: |
14638         Create or update an existing lag-interface.
14639         #
14640         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14641       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14642       consumes:
14643         - application/json
14644         - application/xml
14645       produces:
14646         - application/json
14647         - application/xml
14648       responses:
14649         "default":
14650           description: Response codes found in [response codes](https://wiki.onap.org/).
14651       parameters:
14652         - name: hostname
14653           in: path
14654           description: Value from executing hostname on the compute node.
14655           required: true
14656           type: string
14657           example: __HOSTNAME__
14658         - name: interface-name
14659           in: path
14660           description: Name that identifies the link aggregate interface
14661           required: true
14662           type: string
14663           example: __INTERFACE-NAME__
14664         - name: body
14665           in: body
14666           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
14667           required: true
14668           schema:
14669             $ref: "#/definitions/lag-interface"
14670     patch:
14671       tags:
14672         - CloudInfrastructure
14673       summary: update an existing lag-interface
14674       description: |
14675         Update an existing lag-interface
14676         #
14677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14678         The PUT operation will entirely replace an existing object.
14679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14680         #
14681         Other differences between PUT and PATCH are:
14682         #
14683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14686       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14687       consumes:
14688         - application/json
14689         - application/xml
14690       produces:
14691         - application/json
14692         - application/xml
14693       responses:
14694         "default":
14695           description: Response codes found in [response codes](https://wiki.onap.org/).
14696       parameters:
14697         - name: hostname
14698           in: path
14699           description: Value from executing hostname on the compute node.
14700           required: true
14701           type: string
14702           example: __HOSTNAME__
14703         - name: interface-name
14704           in: path
14705           description: Name that identifies the link aggregate interface
14706           required: true
14707           type: string
14708           example: __INTERFACE-NAME__
14709         - name: body
14710           in: body
14711           description: lag-interface object that needs to be created or updated.
14712           required: true
14713           schema:
14714             $ref: "#/patchDefinitions/lag-interface"
14715     delete:
14716       tags:
14717         - CloudInfrastructure
14718       summary: delete an existing lag-interface
14719       description: delete an existing lag-interface
14720       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
14721       consumes:
14722         - application/json
14723         - application/xml
14724       produces:
14725         - application/json
14726         - application/xml
14727       responses:
14728         "default":
14729           description: Response codes found in [response codes](https://wiki.onap.org/).
14730       parameters:
14731         - name: hostname
14732           in: path
14733           description: Value from executing hostname on the compute node.
14734           required: true
14735           type: string
14736           example: __HOSTNAME__
14737         - name: interface-name
14738           in: path
14739           description: Name that identifies the link aggregate interface
14740           required: true
14741           type: string
14742           example: __INTERFACE-NAME__
14743         - name: resource-version
14744           in: query
14745           description: resource-version for concurrency
14746           required: true
14747           type: string
14748   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
14749     get:
14750       tags:
14751         - CloudInfrastructure
14752       summary: returns lag-interfaces
14753       description: returns lag-interfaces
14754       operationId: getCloudInfrastructurePserversPserverLagInterfaces
14755       produces:
14756         - application/json
14757         - application/xml
14758       responses:
14759         "200":
14760           description: successful operation
14761           schema:
14762               $ref: "#/getDefinitions/lag-interfaces"
14763         "default":
14764           description: Response codes found in [response codes](https://wiki.onap.org/).
14765       parameters:
14766         - name: hostname
14767           in: path
14768           description: Value from executing hostname on the compute node.
14769           required: true
14770           type: string
14771           example: __HOSTNAME__
14772         - name: inv-status
14773           in: query
14774           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14775           required: false
14776           type: string
14777         - name: pserver-id
14778           in: query
14779           description: ID of Pserver
14780           required: false
14781           type: string
14782         - name: in-maint
14783           in: query
14784           required: false
14785           type: boolean
14786         - name: pserver-name2
14787           in: query
14788           description: alternative pserver name
14789           required: false
14790           type: string
14791   /cloud-infrastructure/pservers/pserver/{hostname}:
14792     get:
14793       tags:
14794         - CloudInfrastructure
14795       summary: returns pserver
14796       description: returns pserver
14797       operationId: getCloudInfrastructurePserversPserver
14798       produces:
14799         - application/json
14800         - application/xml
14801       responses:
14802         "200":
14803           description: successful operation
14804           schema:
14805               $ref: "#/getDefinitions/pserver"
14806         "default":
14807           description: Response codes found in [response codes](https://wiki.onap.org/).
14808       parameters:
14809         - name: hostname
14810           in: path
14811           description: Value from executing hostname on the compute node.
14812           required: true
14813           type: string
14814           example: __HOSTNAME__
14815         - name: inv-status
14816           in: query
14817           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14818           required: false
14819           type: string
14820         - name: pserver-id
14821           in: query
14822           description: ID of Pserver
14823           required: false
14824           type: string
14825         - name: in-maint
14826           in: query
14827           required: false
14828           type: boolean
14829         - name: pserver-name2
14830           in: query
14831           description: alternative pserver name
14832           required: false
14833           type: string
14834     put:
14835       tags:
14836         - CloudInfrastructure
14837       summary: create or update an existing pserver
14838       description: |
14839         Create or update an existing pserver.
14840         #
14841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14842       operationId: createOrUpdateCloudInfrastructurePserversPserver
14843       consumes:
14844         - application/json
14845         - application/xml
14846       produces:
14847         - application/json
14848         - application/xml
14849       responses:
14850         "default":
14851           description: Response codes found in [response codes](https://wiki.onap.org/).
14852       parameters:
14853         - name: hostname
14854           in: path
14855           description: Value from executing hostname on the compute node.
14856           required: true
14857           type: string
14858           example: __HOSTNAME__
14859         - name: body
14860           in: body
14861           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
14862           required: true
14863           schema:
14864             $ref: "#/definitions/pserver"
14865     patch:
14866       tags:
14867         - CloudInfrastructure
14868       summary: update an existing pserver
14869       description: |
14870         Update an existing pserver
14871         #
14872         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14873         The PUT operation will entirely replace an existing object.
14874         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14875         #
14876         Other differences between PUT and PATCH are:
14877         #
14878         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14879         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14880         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14881       operationId: UpdateCloudInfrastructurePserversPserver
14882       consumes:
14883         - application/json
14884         - application/xml
14885       produces:
14886         - application/json
14887         - application/xml
14888       responses:
14889         "default":
14890           description: Response codes found in [response codes](https://wiki.onap.org/).
14891       parameters:
14892         - name: hostname
14893           in: path
14894           description: Value from executing hostname on the compute node.
14895           required: true
14896           type: string
14897           example: __HOSTNAME__
14898         - name: body
14899           in: body
14900           description: pserver object that needs to be created or updated.
14901           required: true
14902           schema:
14903             $ref: "#/patchDefinitions/pserver"
14904     delete:
14905       tags:
14906         - CloudInfrastructure
14907       summary: delete an existing pserver
14908       description: delete an existing pserver
14909       operationId: deleteCloudInfrastructurePserversPserver
14910       consumes:
14911         - application/json
14912         - application/xml
14913       produces:
14914         - application/json
14915         - application/xml
14916       responses:
14917         "default":
14918           description: Response codes found in [response codes](https://wiki.onap.org/).
14919       parameters:
14920         - name: hostname
14921           in: path
14922           description: Value from executing hostname on the compute node.
14923           required: true
14924           type: string
14925           example: __HOSTNAME__
14926         - name: resource-version
14927           in: query
14928           description: resource-version for concurrency
14929           required: true
14930           type: string
14931   /cloud-infrastructure/pservers:
14932     get:
14933       tags:
14934         - CloudInfrastructure
14935       summary: returns pservers
14936       description: returns pservers
14937       operationId: getCloudInfrastructurePservers
14938       produces:
14939         - application/json
14940         - application/xml
14941       responses:
14942         "200":
14943           description: successful operation
14944           schema:
14945               $ref: "#/getDefinitions/pservers"
14946         "default":
14947           description: Response codes found in [response codes](https://wiki.onap.org/).
14948   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14949     put:
14950       tags:
14951         - CloudInfrastructure
14952       summary: see node definition for valid relationships
14953       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14954       consumes:
14955         - application/json
14956         - application/xml
14957       produces:
14958         - application/json
14959         - application/xml
14960       responses:
14961         "default":
14962           description: Response codes found in [response codes](https://wiki.onap.org/).
14963       parameters:
14964         - name: vdc-id
14965           in: path
14966           description: Unique ID of the vdc
14967           required: true
14968           type: string
14969           example: __VDC-ID__
14970         - name: body
14971           in: body
14972           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14973           required: true
14974           schema:
14975             $ref: "#/definitions/relationship"
14976     delete:
14977       tags:
14978         - CloudInfrastructure
14979       summary: delete an existing relationship
14980       description: delete an existing relationship
14981       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14982       consumes:
14983         - application/json
14984         - application/xml
14985       produces:
14986         - application/json
14987         - application/xml
14988       responses:
14989         "default":
14990           description: Response codes found in [response codes](https://wiki.onap.org/).
14991       parameters:
14992         - name: vdc-id
14993           in: path
14994           description: Unique ID of the vdc
14995           required: true
14996           type: string
14997           example: __VDC-ID__
14998   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14999     get:
15000       tags:
15001         - CloudInfrastructure
15002       summary: returns virtual-data-center
15003       description: returns virtual-data-center
15004       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
15005       produces:
15006         - application/json
15007         - application/xml
15008       responses:
15009         "200":
15010           description: successful operation
15011           schema:
15012               $ref: "#/getDefinitions/virtual-data-center"
15013         "default":
15014           description: Response codes found in [response codes](https://wiki.onap.org/).
15015       parameters:
15016         - name: vdc-id
15017           in: path
15018           description: Unique ID of the vdc
15019           required: true
15020           type: string
15021           example: __VDC-ID__
15022         - name: vdc-name
15023           in: query
15024           description: Name of the virtual data center
15025           required: false
15026           type: string
15027     put:
15028       tags:
15029         - CloudInfrastructure
15030       summary: create or update an existing virtual-data-center
15031       description: |
15032         Create or update an existing virtual-data-center.
15033         #
15034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15035       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15036       consumes:
15037         - application/json
15038         - application/xml
15039       produces:
15040         - application/json
15041         - application/xml
15042       responses:
15043         "default":
15044           description: Response codes found in [response codes](https://wiki.onap.org/).
15045       parameters:
15046         - name: vdc-id
15047           in: path
15048           description: Unique ID of the vdc
15049           required: true
15050           type: string
15051           example: __VDC-ID__
15052         - name: body
15053           in: body
15054           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15055           required: true
15056           schema:
15057             $ref: "#/definitions/virtual-data-center"
15058     patch:
15059       tags:
15060         - CloudInfrastructure
15061       summary: update an existing virtual-data-center
15062       description: |
15063         Update an existing virtual-data-center
15064         #
15065         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15066         The PUT operation will entirely replace an existing object.
15067         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15068         #
15069         Other differences between PUT and PATCH are:
15070         #
15071         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15072         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15073         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15074       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15075       consumes:
15076         - application/json
15077         - application/xml
15078       produces:
15079         - application/json
15080         - application/xml
15081       responses:
15082         "default":
15083           description: Response codes found in [response codes](https://wiki.onap.org/).
15084       parameters:
15085         - name: vdc-id
15086           in: path
15087           description: Unique ID of the vdc
15088           required: true
15089           type: string
15090           example: __VDC-ID__
15091         - name: body
15092           in: body
15093           description: virtual-data-center object that needs to be created or updated.
15094           required: true
15095           schema:
15096             $ref: "#/patchDefinitions/virtual-data-center"
15097     delete:
15098       tags:
15099         - CloudInfrastructure
15100       summary: delete an existing virtual-data-center
15101       description: delete an existing virtual-data-center
15102       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
15103       consumes:
15104         - application/json
15105         - application/xml
15106       produces:
15107         - application/json
15108         - application/xml
15109       responses:
15110         "default":
15111           description: Response codes found in [response codes](https://wiki.onap.org/).
15112       parameters:
15113         - name: vdc-id
15114           in: path
15115           description: Unique ID of the vdc
15116           required: true
15117           type: string
15118           example: __VDC-ID__
15119         - name: resource-version
15120           in: query
15121           description: resource-version for concurrency
15122           required: true
15123           type: string
15124   /cloud-infrastructure/virtual-data-centers:
15125     get:
15126       tags:
15127         - CloudInfrastructure
15128       summary: returns virtual-data-centers
15129       description: returns virtual-data-centers
15130       operationId: getCloudInfrastructureVirtualDataCenters
15131       produces:
15132         - application/json
15133         - application/xml
15134       responses:
15135         "200":
15136           description: successful operation
15137           schema:
15138               $ref: "#/getDefinitions/virtual-data-centers"
15139         "default":
15140           description: Response codes found in [response codes](https://wiki.onap.org/).
15141   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
15142     put:
15143       tags:
15144         - CloudInfrastructure
15145       summary: see node definition for valid relationships
15146       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
15147       consumes:
15148         - application/json
15149         - application/xml
15150       produces:
15151         - application/json
15152         - application/xml
15153       responses:
15154         "default":
15155           description: Response codes found in [response codes](https://wiki.onap.org/).
15156       parameters:
15157         - name: operational-environment-id
15158           in: path
15159           description: UUID of an operational environment
15160           required: true
15161           type: string
15162           example: __OPERATIONAL-ENVIRONMENT-ID__
15163         - name: body
15164           in: body
15165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
15166           required: true
15167           schema:
15168             $ref: "#/definitions/relationship"
15169     delete:
15170       tags:
15171         - CloudInfrastructure
15172       summary: delete an existing relationship
15173       description: delete an existing relationship
15174       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
15175       consumes:
15176         - application/json
15177         - application/xml
15178       produces:
15179         - application/json
15180         - application/xml
15181       responses:
15182         "default":
15183           description: Response codes found in [response codes](https://wiki.onap.org/).
15184       parameters:
15185         - name: operational-environment-id
15186           in: path
15187           description: UUID of an operational environment
15188           required: true
15189           type: string
15190           example: __OPERATIONAL-ENVIRONMENT-ID__
15191   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
15192     get:
15193       tags:
15194         - CloudInfrastructure
15195       summary: returns operational-environment
15196       description: returns operational-environment
15197       operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
15198       produces:
15199         - application/json
15200         - application/xml
15201       responses:
15202         "200":
15203           description: successful operation
15204           schema:
15205               $ref: "#/getDefinitions/operational-environment"
15206         "default":
15207           description: Response codes found in [response codes](https://wiki.onap.org/).
15208       parameters:
15209         - name: operational-environment-id
15210           in: path
15211           description: UUID of an operational environment
15212           required: true
15213           type: string
15214           example: __OPERATIONAL-ENVIRONMENT-ID__
15215     put:
15216       tags:
15217         - CloudInfrastructure
15218       summary: create or update an existing operational-environment
15219       description: |
15220         Create or update an existing operational-environment.
15221         #
15222         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15223       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
15224       consumes:
15225         - application/json
15226         - application/xml
15227       produces:
15228         - application/json
15229         - application/xml
15230       responses:
15231         "default":
15232           description: Response codes found in [response codes](https://wiki.onap.org/).
15233       parameters:
15234         - name: operational-environment-id
15235           in: path
15236           description: UUID of an operational environment
15237           required: true
15238           type: string
15239           example: __OPERATIONAL-ENVIRONMENT-ID__
15240         - name: body
15241           in: body
15242           description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
15243           required: true
15244           schema:
15245             $ref: "#/definitions/operational-environment"
15246     patch:
15247       tags:
15248         - CloudInfrastructure
15249       summary: update an existing operational-environment
15250       description: |
15251         Update an existing operational-environment
15252         #
15253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15254         The PUT operation will entirely replace an existing object.
15255         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15256         #
15257         Other differences between PUT and PATCH are:
15258         #
15259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15262       operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
15263       consumes:
15264         - application/json
15265         - application/xml
15266       produces:
15267         - application/json
15268         - application/xml
15269       responses:
15270         "default":
15271           description: Response codes found in [response codes](https://wiki.onap.org/).
15272       parameters:
15273         - name: operational-environment-id
15274           in: path
15275           description: UUID of an operational environment
15276           required: true
15277           type: string
15278           example: __OPERATIONAL-ENVIRONMENT-ID__
15279         - name: body
15280           in: body
15281           description: operational-environment object that needs to be created or updated.
15282           required: true
15283           schema:
15284             $ref: "#/patchDefinitions/operational-environment"
15285     delete:
15286       tags:
15287         - CloudInfrastructure
15288       summary: delete an existing operational-environment
15289       description: delete an existing operational-environment
15290       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
15291       consumes:
15292         - application/json
15293         - application/xml
15294       produces:
15295         - application/json
15296         - application/xml
15297       responses:
15298         "default":
15299           description: Response codes found in [response codes](https://wiki.onap.org/).
15300       parameters:
15301         - name: operational-environment-id
15302           in: path
15303           description: UUID of an operational environment
15304           required: true
15305           type: string
15306           example: __OPERATIONAL-ENVIRONMENT-ID__
15307         - name: resource-version
15308           in: query
15309           description: resource-version for concurrency
15310           required: true
15311           type: string
15312   /cloud-infrastructure/operational-environments:
15313     get:
15314       tags:
15315         - CloudInfrastructure
15316       summary: returns operational-environments
15317       description: returns operational-environments
15318       operationId: getCloudInfrastructureOperationalEnvironments
15319       produces:
15320         - application/json
15321         - application/xml
15322       responses:
15323         "200":
15324           description: successful operation
15325           schema:
15326               $ref: "#/getDefinitions/operational-environments"
15327         "default":
15328           description: Response codes found in [response codes](https://wiki.onap.org/).
15329   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
15330     put:
15331       tags:
15332         - Business
15333       summary: see node definition for valid relationships
15334       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
15335       consumes:
15336         - application/json
15337         - application/xml
15338       produces:
15339         - application/json
15340         - application/xml
15341       responses:
15342         "default":
15343           description: Response codes found in [response codes](https://wiki.onap.org/).
15344       parameters:
15345         - name: resource-instance-id
15346           in: path
15347           description: Unique id of resource instance.
15348           required: true
15349           type: string
15350           example: __RESOURCE-INSTANCE-ID__
15351         - name: body
15352           in: body
15353           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
15354           required: true
15355           schema:
15356             $ref: "#/definitions/relationship"
15357     delete:
15358       tags:
15359         - Business
15360       summary: delete an existing relationship
15361       description: delete an existing relationship
15362       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
15363       consumes:
15364         - application/json
15365         - application/xml
15366       produces:
15367         - application/json
15368         - application/xml
15369       responses:
15370         "default":
15371           description: Response codes found in [response codes](https://wiki.onap.org/).
15372       parameters:
15373         - name: resource-instance-id
15374           in: path
15375           description: Unique id of resource instance.
15376           required: true
15377           type: string
15378           example: __RESOURCE-INSTANCE-ID__
15379   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
15380     get:
15381       tags:
15382         - Business
15383       summary: returns metadatum
15384       description: returns metadatum
15385       operationId: getBusinessConnectorsConnectorMetadataMetadatum
15386       produces:
15387         - application/json
15388         - application/xml
15389       responses:
15390         "200":
15391           description: successful operation
15392           schema:
15393               $ref: "#/getDefinitions/metadatum"
15394         "default":
15395           description: Response codes found in [response codes](https://wiki.onap.org/).
15396       parameters:
15397         - name: resource-instance-id
15398           in: path
15399           description: Unique id of resource instance.
15400           required: true
15401           type: string
15402           example: __RESOURCE-INSTANCE-ID__
15403         - name: metaname
15404           in: path
15405           required: true
15406           type: string
15407           example: __METANAME__
15408         - name: model-invariant-id
15409           in: query
15410           description: the ASDC model id for this resource or service model.
15411           required: false
15412           type: string
15413         - name: model-version-id
15414           in: query
15415           description: the ASDC model version for this resource or service model.
15416           required: false
15417           type: string
15418         - name: widget-model-id
15419           in: query
15420           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15421           required: false
15422           type: string
15423         - name: widget-model-version
15424           in: query
15425           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15426           required: false
15427           type: string
15428     put:
15429       tags:
15430         - Business
15431       summary: create or update an existing metadatum
15432       description: |
15433         Create or update an existing metadatum.
15434         #
15435         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15436       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
15437       consumes:
15438         - application/json
15439         - application/xml
15440       produces:
15441         - application/json
15442         - application/xml
15443       responses:
15444         "default":
15445           description: Response codes found in [response codes](https://wiki.onap.org/).
15446       parameters:
15447         - name: resource-instance-id
15448           in: path
15449           description: Unique id of resource instance.
15450           required: true
15451           type: string
15452           example: __RESOURCE-INSTANCE-ID__
15453         - name: metaname
15454           in: path
15455           required: true
15456           type: string
15457           example: __METANAME__
15458         - name: body
15459           in: body
15460           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnectorMetadataMetadatum.json)
15461           required: true
15462           schema:
15463             $ref: "#/definitions/metadatum"
15464     patch:
15465       tags:
15466         - Business
15467       summary: update an existing metadatum
15468       description: |
15469         Update an existing metadatum
15470         #
15471         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15472         The PUT operation will entirely replace an existing object.
15473         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15474         #
15475         Other differences between PUT and PATCH are:
15476         #
15477         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15478         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15479         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15480       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
15481       consumes:
15482         - application/json
15483         - application/xml
15484       produces:
15485         - application/json
15486         - application/xml
15487       responses:
15488         "default":
15489           description: Response codes found in [response codes](https://wiki.onap.org/).
15490       parameters:
15491         - name: resource-instance-id
15492           in: path
15493           description: Unique id of resource instance.
15494           required: true
15495           type: string
15496           example: __RESOURCE-INSTANCE-ID__
15497         - name: metaname
15498           in: path
15499           required: true
15500           type: string
15501           example: __METANAME__
15502         - name: body
15503           in: body
15504           description: metadatum object that needs to be created or updated.
15505           required: true
15506           schema:
15507             $ref: "#/patchDefinitions/metadatum"
15508     delete:
15509       tags:
15510         - Business
15511       summary: delete an existing metadatum
15512       description: delete an existing metadatum
15513       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
15514       consumes:
15515         - application/json
15516         - application/xml
15517       produces:
15518         - application/json
15519         - application/xml
15520       responses:
15521         "default":
15522           description: Response codes found in [response codes](https://wiki.onap.org/).
15523       parameters:
15524         - name: resource-instance-id
15525           in: path
15526           description: Unique id of resource instance.
15527           required: true
15528           type: string
15529           example: __RESOURCE-INSTANCE-ID__
15530         - name: metaname
15531           in: path
15532           required: true
15533           type: string
15534           example: __METANAME__
15535         - name: resource-version
15536           in: query
15537           description: resource-version for concurrency
15538           required: true
15539           type: string
15540   /business/connectors/connector/{resource-instance-id}/metadata:
15541     get:
15542       tags:
15543         - Business
15544       summary: returns metadata
15545       description: returns metadata
15546       operationId: getBusinessConnectorsConnectorMetadata
15547       produces:
15548         - application/json
15549         - application/xml
15550       responses:
15551         "200":
15552           description: successful operation
15553           schema:
15554               $ref: "#/getDefinitions/metadata"
15555         "default":
15556           description: Response codes found in [response codes](https://wiki.onap.org/).
15557       parameters:
15558         - name: resource-instance-id
15559           in: path
15560           description: Unique id of resource instance.
15561           required: true
15562           type: string
15563           example: __RESOURCE-INSTANCE-ID__
15564         - name: model-invariant-id
15565           in: query
15566           description: the ASDC model id for this resource or service model.
15567           required: false
15568           type: string
15569         - name: model-version-id
15570           in: query
15571           description: the ASDC model version for this resource or service model.
15572           required: false
15573           type: string
15574         - name: widget-model-id
15575           in: query
15576           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15577           required: false
15578           type: string
15579         - name: widget-model-version
15580           in: query
15581           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15582           required: false
15583           type: string
15584   /business/connectors/connector/{resource-instance-id}:
15585     get:
15586       tags:
15587         - Business
15588       summary: returns connector
15589       description: returns connector
15590       operationId: getBusinessConnectorsConnector
15591       produces:
15592         - application/json
15593         - application/xml
15594       responses:
15595         "200":
15596           description: successful operation
15597           schema:
15598               $ref: "#/getDefinitions/connector"
15599         "default":
15600           description: Response codes found in [response codes](https://wiki.onap.org/).
15601       parameters:
15602         - name: resource-instance-id
15603           in: path
15604           description: Unique id of resource instance.
15605           required: true
15606           type: string
15607           example: __RESOURCE-INSTANCE-ID__
15608         - name: model-invariant-id
15609           in: query
15610           description: the ASDC model id for this resource or service model.
15611           required: false
15612           type: string
15613         - name: model-version-id
15614           in: query
15615           description: the ASDC model version for this resource or service model.
15616           required: false
15617           type: string
15618         - name: widget-model-id
15619           in: query
15620           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15621           required: false
15622           type: string
15623         - name: widget-model-version
15624           in: query
15625           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15626           required: false
15627           type: string
15628     put:
15629       tags:
15630         - Business
15631       summary: create or update an existing connector
15632       description: |
15633         Create or update an existing connector.
15634         #
15635         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15636       operationId: createOrUpdateBusinessConnectorsConnector
15637       consumes:
15638         - application/json
15639         - application/xml
15640       produces:
15641         - application/json
15642         - application/xml
15643       responses:
15644         "default":
15645           description: Response codes found in [response codes](https://wiki.onap.org/).
15646       parameters:
15647         - name: resource-instance-id
15648           in: path
15649           description: Unique id of resource instance.
15650           required: true
15651           type: string
15652           example: __RESOURCE-INSTANCE-ID__
15653         - name: body
15654           in: body
15655           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
15656           required: true
15657           schema:
15658             $ref: "#/definitions/connector"
15659     patch:
15660       tags:
15661         - Business
15662       summary: update an existing connector
15663       description: |
15664         Update an existing connector
15665         #
15666         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15667         The PUT operation will entirely replace an existing object.
15668         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15669         #
15670         Other differences between PUT and PATCH are:
15671         #
15672         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15673         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15674         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15675       operationId: UpdateBusinessConnectorsConnector
15676       consumes:
15677         - application/json
15678         - application/xml
15679       produces:
15680         - application/json
15681         - application/xml
15682       responses:
15683         "default":
15684           description: Response codes found in [response codes](https://wiki.onap.org/).
15685       parameters:
15686         - name: resource-instance-id
15687           in: path
15688           description: Unique id of resource instance.
15689           required: true
15690           type: string
15691           example: __RESOURCE-INSTANCE-ID__
15692         - name: body
15693           in: body
15694           description: connector object that needs to be created or updated.
15695           required: true
15696           schema:
15697             $ref: "#/patchDefinitions/connector"
15698     delete:
15699       tags:
15700         - Business
15701       summary: delete an existing connector
15702       description: delete an existing connector
15703       operationId: deleteBusinessConnectorsConnector
15704       consumes:
15705         - application/json
15706         - application/xml
15707       produces:
15708         - application/json
15709         - application/xml
15710       responses:
15711         "default":
15712           description: Response codes found in [response codes](https://wiki.onap.org/).
15713       parameters:
15714         - name: resource-instance-id
15715           in: path
15716           description: Unique id of resource instance.
15717           required: true
15718           type: string
15719           example: __RESOURCE-INSTANCE-ID__
15720         - name: resource-version
15721           in: query
15722           description: resource-version for concurrency
15723           required: true
15724           type: string
15725   /business/connectors:
15726     get:
15727       tags:
15728         - Business
15729       summary: returns connectors
15730       description: returns connectors
15731       operationId: getBusinessConnectors
15732       produces:
15733         - application/json
15734         - application/xml
15735       responses:
15736         "200":
15737           description: successful operation
15738           schema:
15739               $ref: "#/getDefinitions/connectors"
15740         "default":
15741           description: Response codes found in [response codes](https://wiki.onap.org/).
15742   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
15743     put:
15744       tags:
15745         - Business
15746       summary: see node definition for valid relationships
15747       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15748       consumes:
15749         - application/json
15750         - application/xml
15751       produces:
15752         - application/json
15753         - application/xml
15754       responses:
15755         "default":
15756           description: Response codes found in [response codes](https://wiki.onap.org/).
15757       parameters:
15758         - name: global-customer-id
15759           in: path
15760           description: Global customer id used across ECOMP to uniquely identify customer.
15761           required: true
15762           type: string
15763           example: __GLOBAL-CUSTOMER-ID__
15764         - name: service-type
15765           in: path
15766           description: Value defined by orchestration to identify this service across ECOMP.
15767           required: true
15768           type: string
15769           example: __SERVICE-TYPE__
15770         - name: service-instance-id
15771           in: path
15772           description: Uniquely identifies this instance of a service
15773           required: true
15774           type: string
15775           example: __SERVICE-INSTANCE-ID__
15776         - name: body
15777           in: body
15778           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
15779           required: true
15780           schema:
15781             $ref: "#/definitions/relationship"
15782     delete:
15783       tags:
15784         - Business
15785       summary: delete an existing relationship
15786       description: delete an existing relationship
15787       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15788       consumes:
15789         - application/json
15790         - application/xml
15791       produces:
15792         - application/json
15793         - application/xml
15794       responses:
15795         "default":
15796           description: Response codes found in [response codes](https://wiki.onap.org/).
15797       parameters:
15798         - name: global-customer-id
15799           in: path
15800           description: Global customer id used across ECOMP to uniquely identify customer.
15801           required: true
15802           type: string
15803           example: __GLOBAL-CUSTOMER-ID__
15804         - name: service-type
15805           in: path
15806           description: Value defined by orchestration to identify this service across ECOMP.
15807           required: true
15808           type: string
15809           example: __SERVICE-TYPE__
15810         - name: service-instance-id
15811           in: path
15812           description: Uniquely identifies this instance of a service
15813           required: true
15814           type: string
15815           example: __SERVICE-INSTANCE-ID__
15816   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15817     get:
15818       tags:
15819         - Business
15820       summary: returns metadatum
15821       description: returns metadatum
15822       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15823       produces:
15824         - application/json
15825         - application/xml
15826       responses:
15827         "200":
15828           description: successful operation
15829           schema:
15830               $ref: "#/getDefinitions/metadatum"
15831         "default":
15832           description: Response codes found in [response codes](https://wiki.onap.org/).
15833       parameters:
15834         - name: global-customer-id
15835           in: path
15836           description: Global customer id used across ECOMP to uniquely identify customer.
15837           required: true
15838           type: string
15839           example: __GLOBAL-CUSTOMER-ID__
15840         - name: service-type
15841           in: path
15842           description: Value defined by orchestration to identify this service across ECOMP.
15843           required: true
15844           type: string
15845           example: __SERVICE-TYPE__
15846         - name: service-instance-id
15847           in: path
15848           description: Uniquely identifies this instance of a service
15849           required: true
15850           type: string
15851           example: __SERVICE-INSTANCE-ID__
15852         - name: metaname
15853           in: path
15854           required: true
15855           type: string
15856           example: __METANAME__
15857         - name: subscriber-name
15858           in: query
15859           description: Subscriber name, an alternate way to retrieve a customer.
15860           required: false
15861           type: string
15862         - name: subscriber-type
15863           in: query
15864           description: Subscriber type, a way to provide VID with only the INFRA customers.
15865           required: false
15866           type: string
15867         - name: service-instance-name
15868           in: query
15869           description: This field will store a name assigned to the service-instance.
15870           required: false
15871           type: string
15872         - name: environment-context
15873           in: query
15874           description: This field will store the environment context assigned to the service-instance.
15875           required: false
15876           type: string
15877         - name: workload-context
15878           in: query
15879           description: This field will store the workload context assigned to the service-instance.
15880           required: false
15881           type: string
15882         - name: model-invariant-id
15883           in: query
15884           description: the ASDC model id for this resource or service model.
15885           required: false
15886           type: string
15887         - name: model-version-id
15888           in: query
15889           description: the ASDC model version for this resource or service model.
15890           required: false
15891           type: string
15892         - name: widget-model-id
15893           in: query
15894           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15895           required: false
15896           type: string
15897         - name: widget-model-version
15898           in: query
15899           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15900           required: false
15901           type: string
15902         - name: service-instance-location-id
15903           in: query
15904           description: An identifier that customers assign to the location where this service is being used.
15905           required: false
15906           type: string
15907         - name: orchestration-status
15908           in: query
15909           description: Orchestration status of this service.
15910           required: false
15911           type: string
15912     put:
15913       tags:
15914         - Business
15915       summary: create or update an existing metadatum
15916       description: |
15917         Create or update an existing metadatum.
15918         #
15919         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15920       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15921       consumes:
15922         - application/json
15923         - application/xml
15924       produces:
15925         - application/json
15926         - application/xml
15927       responses:
15928         "default":
15929           description: Response codes found in [response codes](https://wiki.onap.org/).
15930       parameters:
15931         - name: global-customer-id
15932           in: path
15933           description: Global customer id used across ECOMP to uniquely identify customer.
15934           required: true
15935           type: string
15936           example: __GLOBAL-CUSTOMER-ID__
15937         - name: service-type
15938           in: path
15939           description: Value defined by orchestration to identify this service across ECOMP.
15940           required: true
15941           type: string
15942           example: __SERVICE-TYPE__
15943         - name: service-instance-id
15944           in: path
15945           description: Uniquely identifies this instance of a service
15946           required: true
15947           type: string
15948           example: __SERVICE-INSTANCE-ID__
15949         - name: metaname
15950           in: path
15951           required: true
15952           type: string
15953           example: __METANAME__
15954         - name: body
15955           in: body
15956           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
15957           required: true
15958           schema:
15959             $ref: "#/definitions/metadatum"
15960     patch:
15961       tags:
15962         - Business
15963       summary: update an existing metadatum
15964       description: |
15965         Update an existing metadatum
15966         #
15967         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15968         The PUT operation will entirely replace an existing object.
15969         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15970         #
15971         Other differences between PUT and PATCH are:
15972         #
15973         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15974         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15975         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15976       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15977       consumes:
15978         - application/json
15979         - application/xml
15980       produces:
15981         - application/json
15982         - application/xml
15983       responses:
15984         "default":
15985           description: Response codes found in [response codes](https://wiki.onap.org/).
15986       parameters:
15987         - name: global-customer-id
15988           in: path
15989           description: Global customer id used across ECOMP to uniquely identify customer.
15990           required: true
15991           type: string
15992           example: __GLOBAL-CUSTOMER-ID__
15993         - name: service-type
15994           in: path
15995           description: Value defined by orchestration to identify this service across ECOMP.
15996           required: true
15997           type: string
15998           example: __SERVICE-TYPE__
15999         - name: service-instance-id
16000           in: path
16001           description: Uniquely identifies this instance of a service
16002           required: true
16003           type: string
16004           example: __SERVICE-INSTANCE-ID__
16005         - name: metaname
16006           in: path
16007           required: true
16008           type: string
16009           example: __METANAME__
16010         - name: body
16011           in: body
16012           description: metadatum object that needs to be created or updated.
16013           required: true
16014           schema:
16015             $ref: "#/patchDefinitions/metadatum"
16016     delete:
16017       tags:
16018         - Business
16019       summary: delete an existing metadatum
16020       description: delete an existing metadatum
16021       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16022       consumes:
16023         - application/json
16024         - application/xml
16025       produces:
16026         - application/json
16027         - application/xml
16028       responses:
16029         "default":
16030           description: Response codes found in [response codes](https://wiki.onap.org/).
16031       parameters:
16032         - name: global-customer-id
16033           in: path
16034           description: Global customer id used across ECOMP to uniquely identify customer.
16035           required: true
16036           type: string
16037           example: __GLOBAL-CUSTOMER-ID__
16038         - name: service-type
16039           in: path
16040           description: Value defined by orchestration to identify this service across ECOMP.
16041           required: true
16042           type: string
16043           example: __SERVICE-TYPE__
16044         - name: service-instance-id
16045           in: path
16046           description: Uniquely identifies this instance of a service
16047           required: true
16048           type: string
16049           example: __SERVICE-INSTANCE-ID__
16050         - name: metaname
16051           in: path
16052           required: true
16053           type: string
16054           example: __METANAME__
16055         - name: resource-version
16056           in: query
16057           description: resource-version for concurrency
16058           required: true
16059           type: string
16060   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
16061     get:
16062       tags:
16063         - Business
16064       summary: returns metadata
16065       description: returns metadata
16066       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
16067       produces:
16068         - application/json
16069         - application/xml
16070       responses:
16071         "200":
16072           description: successful operation
16073           schema:
16074               $ref: "#/getDefinitions/metadata"
16075         "default":
16076           description: Response codes found in [response codes](https://wiki.onap.org/).
16077       parameters:
16078         - name: global-customer-id
16079           in: path
16080           description: Global customer id used across ECOMP to uniquely identify customer.
16081           required: true
16082           type: string
16083           example: __GLOBAL-CUSTOMER-ID__
16084         - name: service-type
16085           in: path
16086           description: Value defined by orchestration to identify this service across ECOMP.
16087           required: true
16088           type: string
16089           example: __SERVICE-TYPE__
16090         - name: service-instance-id
16091           in: path
16092           description: Uniquely identifies this instance of a service
16093           required: true
16094           type: string
16095           example: __SERVICE-INSTANCE-ID__
16096         - name: subscriber-name
16097           in: query
16098           description: Subscriber name, an alternate way to retrieve a customer.
16099           required: false
16100           type: string
16101         - name: subscriber-type
16102           in: query
16103           description: Subscriber type, a way to provide VID with only the INFRA customers.
16104           required: false
16105           type: string
16106         - name: service-instance-name
16107           in: query
16108           description: This field will store a name assigned to the service-instance.
16109           required: false
16110           type: string
16111         - name: environment-context
16112           in: query
16113           description: This field will store the environment context assigned to the service-instance.
16114           required: false
16115           type: string
16116         - name: workload-context
16117           in: query
16118           description: This field will store the workload context assigned to the service-instance.
16119           required: false
16120           type: string
16121         - name: model-invariant-id
16122           in: query
16123           description: the ASDC model id for this resource or service model.
16124           required: false
16125           type: string
16126         - name: model-version-id
16127           in: query
16128           description: the ASDC model version for this resource or service model.
16129           required: false
16130           type: string
16131         - name: widget-model-id
16132           in: query
16133           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16134           required: false
16135           type: string
16136         - name: widget-model-version
16137           in: query
16138           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16139           required: false
16140           type: string
16141         - name: service-instance-location-id
16142           in: query
16143           description: An identifier that customers assign to the location where this service is being used.
16144           required: false
16145           type: string
16146         - name: orchestration-status
16147           in: query
16148           description: Orchestration status of this service.
16149           required: false
16150           type: string
16151   /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:
16152     put:
16153       tags:
16154         - Business
16155       summary: see node definition for valid relationships
16156       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16157       consumes:
16158         - application/json
16159         - application/xml
16160       produces:
16161         - application/json
16162         - application/xml
16163       responses:
16164         "default":
16165           description: Response codes found in [response codes](https://wiki.onap.org/).
16166       parameters:
16167         - name: global-customer-id
16168           in: path
16169           description: Global customer id used across ECOMP to uniquely identify customer.
16170           required: true
16171           type: string
16172           example: __GLOBAL-CUSTOMER-ID__
16173         - name: service-type
16174           in: path
16175           description: Value defined by orchestration to identify this service across ECOMP.
16176           required: true
16177           type: string
16178           example: __SERVICE-TYPE__
16179         - name: service-instance-id
16180           in: path
16181           description: Uniquely identifies this instance of a service
16182           required: true
16183           type: string
16184           example: __SERVICE-INSTANCE-ID__
16185         - name: id
16186           in: path
16187           description: Allotted Resource id UUID assigned to this instance.
16188           required: true
16189           type: string
16190           example: __ID__
16191         - name: id
16192           in: path
16193           description: Allotted Resource id UUID assigned to this instance.
16194           required: true
16195           type: string
16196           example: __ID__
16197         - name: body
16198           in: body
16199           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16200           required: true
16201           schema:
16202             $ref: "#/definitions/relationship"
16203     delete:
16204       tags:
16205         - Business
16206       summary: delete an existing relationship
16207       description: delete an existing relationship
16208       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16209       consumes:
16210         - application/json
16211         - application/xml
16212       produces:
16213         - application/json
16214         - application/xml
16215       responses:
16216         "default":
16217           description: Response codes found in [response codes](https://wiki.onap.org/).
16218       parameters:
16219         - name: global-customer-id
16220           in: path
16221           description: Global customer id used across ECOMP to uniquely identify customer.
16222           required: true
16223           type: string
16224           example: __GLOBAL-CUSTOMER-ID__
16225         - name: service-type
16226           in: path
16227           description: Value defined by orchestration to identify this service across ECOMP.
16228           required: true
16229           type: string
16230           example: __SERVICE-TYPE__
16231         - name: service-instance-id
16232           in: path
16233           description: Uniquely identifies this instance of a service
16234           required: true
16235           type: string
16236           example: __SERVICE-INSTANCE-ID__
16237         - name: id
16238           in: path
16239           description: Allotted Resource id UUID assigned to this instance.
16240           required: true
16241           type: string
16242           example: __ID__
16243         - name: id
16244           in: path
16245           description: Allotted Resource id UUID assigned to this instance.
16246           required: true
16247           type: string
16248           example: __ID__
16249   /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}:
16250     get:
16251       tags:
16252         - Business
16253       summary: returns tunnel-xconnect
16254       description: returns tunnel-xconnect
16255       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16256       produces:
16257         - application/json
16258         - application/xml
16259       responses:
16260         "200":
16261           description: successful operation
16262           schema:
16263               $ref: "#/getDefinitions/tunnel-xconnect"
16264         "default":
16265           description: Response codes found in [response codes](https://wiki.onap.org/).
16266       parameters:
16267         - name: global-customer-id
16268           in: path
16269           description: Global customer id used across ECOMP to uniquely identify customer.
16270           required: true
16271           type: string
16272           example: __GLOBAL-CUSTOMER-ID__
16273         - name: service-type
16274           in: path
16275           description: Value defined by orchestration to identify this service across ECOMP.
16276           required: true
16277           type: string
16278           example: __SERVICE-TYPE__
16279         - name: service-instance-id
16280           in: path
16281           description: Uniquely identifies this instance of a service
16282           required: true
16283           type: string
16284           example: __SERVICE-INSTANCE-ID__
16285         - name: id
16286           in: path
16287           description: Allotted Resource id UUID assigned to this instance.
16288           required: true
16289           type: string
16290           example: __ID__
16291         - name: id
16292           in: path
16293           description: Allotted Resource id UUID assigned to this instance.
16294           required: true
16295           type: string
16296           example: __ID__
16297         - name: subscriber-name
16298           in: query
16299           description: Subscriber name, an alternate way to retrieve a customer.
16300           required: false
16301           type: string
16302         - name: subscriber-type
16303           in: query
16304           description: Subscriber type, a way to provide VID with only the INFRA customers.
16305           required: false
16306           type: string
16307         - name: service-instance-name
16308           in: query
16309           description: This field will store a name assigned to the service-instance.
16310           required: false
16311           type: string
16312         - name: environment-context
16313           in: query
16314           description: This field will store the environment context assigned to the service-instance.
16315           required: false
16316           type: string
16317         - name: workload-context
16318           in: query
16319           description: This field will store the workload context assigned to the service-instance.
16320           required: false
16321           type: string
16322         - name: model-invariant-id
16323           in: query
16324           description: the ASDC model id for this resource or service model.
16325           required: false
16326           type: string
16327         - name: model-version-id
16328           in: query
16329           description: the ASDC model version for this resource or service model.
16330           required: false
16331           type: string
16332         - name: widget-model-id
16333           in: query
16334           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16335           required: false
16336           type: string
16337         - name: widget-model-version
16338           in: query
16339           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16340           required: false
16341           type: string
16342         - name: service-instance-location-id
16343           in: query
16344           description: An identifier that customers assign to the location where this service is being used.
16345           required: false
16346           type: string
16347         - name: orchestration-status
16348           in: query
16349           description: Orchestration status of this service.
16350           required: false
16351           type: string
16352         - name: model-invariant-id
16353           in: query
16354           description: the ASDC model id for this resource or service model.
16355           required: false
16356           type: string
16357         - name: model-version-id
16358           in: query
16359           description: the ASDC model version for this resource or service model.
16360           required: false
16361           type: string
16362         - name: type
16363           in: query
16364           description: Generic description of the type of allotted resource.
16365           required: false
16366           type: string
16367         - name: role
16368           in: query
16369           description: role in the network that this resource will be providing.
16370           required: false
16371           type: string
16372     put:
16373       tags:
16374         - Business
16375       summary: create or update an existing tunnel-xconnect
16376       description: |
16377         Create or update an existing tunnel-xconnect.
16378         #
16379         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16380       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16381       consumes:
16382         - application/json
16383         - application/xml
16384       produces:
16385         - application/json
16386         - application/xml
16387       responses:
16388         "default":
16389           description: Response codes found in [response codes](https://wiki.onap.org/).
16390       parameters:
16391         - name: global-customer-id
16392           in: path
16393           description: Global customer id used across ECOMP to uniquely identify customer.
16394           required: true
16395           type: string
16396           example: __GLOBAL-CUSTOMER-ID__
16397         - name: service-type
16398           in: path
16399           description: Value defined by orchestration to identify this service across ECOMP.
16400           required: true
16401           type: string
16402           example: __SERVICE-TYPE__
16403         - name: service-instance-id
16404           in: path
16405           description: Uniquely identifies this instance of a service
16406           required: true
16407           type: string
16408           example: __SERVICE-INSTANCE-ID__
16409         - name: id
16410           in: path
16411           description: Allotted Resource id UUID assigned to this instance.
16412           required: true
16413           type: string
16414           example: __ID__
16415         - name: id
16416           in: path
16417           description: Allotted Resource id UUID assigned to this instance.
16418           required: true
16419           type: string
16420           example: __ID__
16421         - name: body
16422           in: body
16423           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16424           required: true
16425           schema:
16426             $ref: "#/definitions/tunnel-xconnect"
16427     patch:
16428       tags:
16429         - Business
16430       summary: update an existing tunnel-xconnect
16431       description: |
16432         Update an existing tunnel-xconnect
16433         #
16434         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16435         The PUT operation will entirely replace an existing object.
16436         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16437         #
16438         Other differences between PUT and PATCH are:
16439         #
16440         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16441         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16442         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16443       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16444       consumes:
16445         - application/json
16446         - application/xml
16447       produces:
16448         - application/json
16449         - application/xml
16450       responses:
16451         "default":
16452           description: Response codes found in [response codes](https://wiki.onap.org/).
16453       parameters:
16454         - name: global-customer-id
16455           in: path
16456           description: Global customer id used across ECOMP to uniquely identify customer.
16457           required: true
16458           type: string
16459           example: __GLOBAL-CUSTOMER-ID__
16460         - name: service-type
16461           in: path
16462           description: Value defined by orchestration to identify this service across ECOMP.
16463           required: true
16464           type: string
16465           example: __SERVICE-TYPE__
16466         - name: service-instance-id
16467           in: path
16468           description: Uniquely identifies this instance of a service
16469           required: true
16470           type: string
16471           example: __SERVICE-INSTANCE-ID__
16472         - name: id
16473           in: path
16474           description: Allotted Resource id UUID assigned to this instance.
16475           required: true
16476           type: string
16477           example: __ID__
16478         - name: id
16479           in: path
16480           description: Allotted Resource id UUID assigned to this instance.
16481           required: true
16482           type: string
16483           example: __ID__
16484         - name: body
16485           in: body
16486           description: tunnel-xconnect object that needs to be created or updated.
16487           required: true
16488           schema:
16489             $ref: "#/patchDefinitions/tunnel-xconnect"
16490     delete:
16491       tags:
16492         - Business
16493       summary: delete an existing tunnel-xconnect
16494       description: delete an existing tunnel-xconnect
16495       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
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: resource-version
16537           in: query
16538           description: resource-version for concurrency
16539           required: true
16540           type: string
16541   /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:
16542     get:
16543       tags:
16544         - Business
16545       summary: returns tunnel-xconnects
16546       description: returns tunnel-xconnects
16547       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
16548       produces:
16549         - application/json
16550         - application/xml
16551       responses:
16552         "200":
16553           description: successful operation
16554           schema:
16555               $ref: "#/getDefinitions/tunnel-xconnects"
16556         "default":
16557           description: Response codes found in [response codes](https://wiki.onap.org/).
16558       parameters:
16559         - name: global-customer-id
16560           in: path
16561           description: Global customer id used across ECOMP to uniquely identify customer.
16562           required: true
16563           type: string
16564           example: __GLOBAL-CUSTOMER-ID__
16565         - name: service-type
16566           in: path
16567           description: Value defined by orchestration to identify this service across ECOMP.
16568           required: true
16569           type: string
16570           example: __SERVICE-TYPE__
16571         - name: service-instance-id
16572           in: path
16573           description: Uniquely identifies this instance of a service
16574           required: true
16575           type: string
16576           example: __SERVICE-INSTANCE-ID__
16577         - name: id
16578           in: path
16579           description: Allotted Resource id UUID assigned to this instance.
16580           required: true
16581           type: string
16582           example: __ID__
16583         - name: subscriber-name
16584           in: query
16585           description: Subscriber name, an alternate way to retrieve a customer.
16586           required: false
16587           type: string
16588         - name: subscriber-type
16589           in: query
16590           description: Subscriber type, a way to provide VID with only the INFRA customers.
16591           required: false
16592           type: string
16593         - name: service-instance-name
16594           in: query
16595           description: This field will store a name assigned to the service-instance.
16596           required: false
16597           type: string
16598         - name: environment-context
16599           in: query
16600           description: This field will store the environment context assigned to the service-instance.
16601           required: false
16602           type: string
16603         - name: workload-context
16604           in: query
16605           description: This field will store the workload context assigned to the service-instance.
16606           required: false
16607           type: string
16608         - name: model-invariant-id
16609           in: query
16610           description: the ASDC model id for this resource or service model.
16611           required: false
16612           type: string
16613         - name: model-version-id
16614           in: query
16615           description: the ASDC model version for this resource or service model.
16616           required: false
16617           type: string
16618         - name: widget-model-id
16619           in: query
16620           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16621           required: false
16622           type: string
16623         - name: widget-model-version
16624           in: query
16625           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16626           required: false
16627           type: string
16628         - name: service-instance-location-id
16629           in: query
16630           description: An identifier that customers assign to the location where this service is being used.
16631           required: false
16632           type: string
16633         - name: orchestration-status
16634           in: query
16635           description: Orchestration status of this service.
16636           required: false
16637           type: string
16638         - name: model-invariant-id
16639           in: query
16640           description: the ASDC model id for this resource or service model.
16641           required: false
16642           type: string
16643         - name: model-version-id
16644           in: query
16645           description: the ASDC model version for this resource or service model.
16646           required: false
16647           type: string
16648         - name: type
16649           in: query
16650           description: Generic description of the type of allotted resource.
16651           required: false
16652           type: string
16653         - name: role
16654           in: query
16655           description: role in the network that this resource will be providing.
16656           required: false
16657           type: string
16658   /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:
16659     put:
16660       tags:
16661         - Business
16662       summary: see node definition for valid relationships
16663       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16664       consumes:
16665         - application/json
16666         - application/xml
16667       produces:
16668         - application/json
16669         - application/xml
16670       responses:
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: body
16699           in: body
16700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16701           required: true
16702           schema:
16703             $ref: "#/definitions/relationship"
16704     delete:
16705       tags:
16706         - Business
16707       summary: delete an existing relationship
16708       description: delete an existing relationship
16709       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16710       consumes:
16711         - application/json
16712         - application/xml
16713       produces:
16714         - application/json
16715         - application/xml
16716       responses:
16717         "default":
16718           description: Response codes found in [response codes](https://wiki.onap.org/).
16719       parameters:
16720         - name: global-customer-id
16721           in: path
16722           description: Global customer id used across ECOMP to uniquely identify customer.
16723           required: true
16724           type: string
16725           example: __GLOBAL-CUSTOMER-ID__
16726         - name: service-type
16727           in: path
16728           description: Value defined by orchestration to identify this service across ECOMP.
16729           required: true
16730           type: string
16731           example: __SERVICE-TYPE__
16732         - name: service-instance-id
16733           in: path
16734           description: Uniquely identifies this instance of a service
16735           required: true
16736           type: string
16737           example: __SERVICE-INSTANCE-ID__
16738         - name: id
16739           in: path
16740           description: Allotted Resource id UUID assigned to this instance.
16741           required: true
16742           type: string
16743           example: __ID__
16744   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
16745     get:
16746       tags:
16747         - Business
16748       summary: returns allotted-resource
16749       description: returns allotted-resource
16750       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16751       produces:
16752         - application/json
16753         - application/xml
16754       responses:
16755         "200":
16756           description: successful operation
16757           schema:
16758               $ref: "#/getDefinitions/allotted-resource"
16759         "default":
16760           description: Response codes found in [response codes](https://wiki.onap.org/).
16761       parameters:
16762         - name: global-customer-id
16763           in: path
16764           description: Global customer id used across ECOMP to uniquely identify customer.
16765           required: true
16766           type: string
16767           example: __GLOBAL-CUSTOMER-ID__
16768         - name: service-type
16769           in: path
16770           description: Value defined by orchestration to identify this service across ECOMP.
16771           required: true
16772           type: string
16773           example: __SERVICE-TYPE__
16774         - name: service-instance-id
16775           in: path
16776           description: Uniquely identifies this instance of a service
16777           required: true
16778           type: string
16779           example: __SERVICE-INSTANCE-ID__
16780         - name: id
16781           in: path
16782           description: Allotted Resource id UUID assigned to this instance.
16783           required: true
16784           type: string
16785           example: __ID__
16786         - name: subscriber-name
16787           in: query
16788           description: Subscriber name, an alternate way to retrieve a customer.
16789           required: false
16790           type: string
16791         - name: subscriber-type
16792           in: query
16793           description: Subscriber type, a way to provide VID with only the INFRA customers.
16794           required: false
16795           type: string
16796         - name: service-instance-name
16797           in: query
16798           description: This field will store a name assigned to the service-instance.
16799           required: false
16800           type: string
16801         - name: environment-context
16802           in: query
16803           description: This field will store the environment context assigned to the service-instance.
16804           required: false
16805           type: string
16806         - name: workload-context
16807           in: query
16808           description: This field will store the workload context assigned to the service-instance.
16809           required: false
16810           type: string
16811         - name: model-invariant-id
16812           in: query
16813           description: the ASDC model id for this resource or service model.
16814           required: false
16815           type: string
16816         - name: model-version-id
16817           in: query
16818           description: the ASDC model version for this resource or service model.
16819           required: false
16820           type: string
16821         - name: widget-model-id
16822           in: query
16823           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16824           required: false
16825           type: string
16826         - name: widget-model-version
16827           in: query
16828           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16829           required: false
16830           type: string
16831         - name: service-instance-location-id
16832           in: query
16833           description: An identifier that customers assign to the location where this service is being used.
16834           required: false
16835           type: string
16836         - name: orchestration-status
16837           in: query
16838           description: Orchestration status of this service.
16839           required: false
16840           type: string
16841         - name: model-invariant-id
16842           in: query
16843           description: the ASDC model id for this resource or service model.
16844           required: false
16845           type: string
16846         - name: model-version-id
16847           in: query
16848           description: the ASDC model version for this resource or service model.
16849           required: false
16850           type: string
16851         - name: type
16852           in: query
16853           description: Generic description of the type of allotted resource.
16854           required: false
16855           type: string
16856         - name: role
16857           in: query
16858           description: role in the network that this resource will be providing.
16859           required: false
16860           type: string
16861     put:
16862       tags:
16863         - Business
16864       summary: create or update an existing allotted-resource
16865       description: |
16866         Create or update an existing allotted-resource.
16867         #
16868         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16869       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16870       consumes:
16871         - application/json
16872         - application/xml
16873       produces:
16874         - application/json
16875         - application/xml
16876       responses:
16877         "default":
16878           description: Response codes found in [response codes](https://wiki.onap.org/).
16879       parameters:
16880         - name: global-customer-id
16881           in: path
16882           description: Global customer id used across ECOMP to uniquely identify customer.
16883           required: true
16884           type: string
16885           example: __GLOBAL-CUSTOMER-ID__
16886         - name: service-type
16887           in: path
16888           description: Value defined by orchestration to identify this service across ECOMP.
16889           required: true
16890           type: string
16891           example: __SERVICE-TYPE__
16892         - name: service-instance-id
16893           in: path
16894           description: Uniquely identifies this instance of a service
16895           required: true
16896           type: string
16897           example: __SERVICE-INSTANCE-ID__
16898         - name: id
16899           in: path
16900           description: Allotted Resource id UUID assigned to this instance.
16901           required: true
16902           type: string
16903           example: __ID__
16904         - name: body
16905           in: body
16906           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16907           required: true
16908           schema:
16909             $ref: "#/definitions/allotted-resource"
16910     patch:
16911       tags:
16912         - Business
16913       summary: update an existing allotted-resource
16914       description: |
16915         Update an existing allotted-resource
16916         #
16917         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16918         The PUT operation will entirely replace an existing object.
16919         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16920         #
16921         Other differences between PUT and PATCH are:
16922         #
16923         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16924         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16925         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16926       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16927       consumes:
16928         - application/json
16929         - application/xml
16930       produces:
16931         - application/json
16932         - application/xml
16933       responses:
16934         "default":
16935           description: Response codes found in [response codes](https://wiki.onap.org/).
16936       parameters:
16937         - name: global-customer-id
16938           in: path
16939           description: Global customer id used across ECOMP to uniquely identify customer.
16940           required: true
16941           type: string
16942           example: __GLOBAL-CUSTOMER-ID__
16943         - name: service-type
16944           in: path
16945           description: Value defined by orchestration to identify this service across ECOMP.
16946           required: true
16947           type: string
16948           example: __SERVICE-TYPE__
16949         - name: service-instance-id
16950           in: path
16951           description: Uniquely identifies this instance of a service
16952           required: true
16953           type: string
16954           example: __SERVICE-INSTANCE-ID__
16955         - name: id
16956           in: path
16957           description: Allotted Resource id UUID assigned to this instance.
16958           required: true
16959           type: string
16960           example: __ID__
16961         - name: body
16962           in: body
16963           description: allotted-resource object that needs to be created or updated.
16964           required: true
16965           schema:
16966             $ref: "#/patchDefinitions/allotted-resource"
16967     delete:
16968       tags:
16969         - Business
16970       summary: delete an existing allotted-resource
16971       description: delete an existing allotted-resource
16972       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16973       consumes:
16974         - application/json
16975         - application/xml
16976       produces:
16977         - application/json
16978         - application/xml
16979       responses:
16980         "default":
16981           description: Response codes found in [response codes](https://wiki.onap.org/).
16982       parameters:
16983         - name: global-customer-id
16984           in: path
16985           description: Global customer id used across ECOMP to uniquely identify customer.
16986           required: true
16987           type: string
16988           example: __GLOBAL-CUSTOMER-ID__
16989         - name: service-type
16990           in: path
16991           description: Value defined by orchestration to identify this service across ECOMP.
16992           required: true
16993           type: string
16994           example: __SERVICE-TYPE__
16995         - name: service-instance-id
16996           in: path
16997           description: Uniquely identifies this instance of a service
16998           required: true
16999           type: string
17000           example: __SERVICE-INSTANCE-ID__
17001         - name: id
17002           in: path
17003           description: Allotted Resource id UUID assigned to this instance.
17004           required: true
17005           type: string
17006           example: __ID__
17007         - name: resource-version
17008           in: query
17009           description: resource-version for concurrency
17010           required: true
17011           type: string
17012   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
17013     get:
17014       tags:
17015         - Business
17016       summary: returns allotted-resources
17017       description: returns allotted-resources
17018       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
17019       produces:
17020         - application/json
17021         - application/xml
17022       responses:
17023         "200":
17024           description: successful operation
17025           schema:
17026               $ref: "#/getDefinitions/allotted-resources"
17027         "default":
17028           description: Response codes found in [response codes](https://wiki.onap.org/).
17029       parameters:
17030         - name: global-customer-id
17031           in: path
17032           description: Global customer id used across ECOMP to uniquely identify customer.
17033           required: true
17034           type: string
17035           example: __GLOBAL-CUSTOMER-ID__
17036         - name: service-type
17037           in: path
17038           description: Value defined by orchestration to identify this service across ECOMP.
17039           required: true
17040           type: string
17041           example: __SERVICE-TYPE__
17042         - name: service-instance-id
17043           in: path
17044           description: Uniquely identifies this instance of a service
17045           required: true
17046           type: string
17047           example: __SERVICE-INSTANCE-ID__
17048         - name: subscriber-name
17049           in: query
17050           description: Subscriber name, an alternate way to retrieve a customer.
17051           required: false
17052           type: string
17053         - name: subscriber-type
17054           in: query
17055           description: Subscriber type, a way to provide VID with only the INFRA customers.
17056           required: false
17057           type: string
17058         - name: service-instance-name
17059           in: query
17060           description: This field will store a name assigned to the service-instance.
17061           required: false
17062           type: string
17063         - name: environment-context
17064           in: query
17065           description: This field will store the environment context assigned to the service-instance.
17066           required: false
17067           type: string
17068         - name: workload-context
17069           in: query
17070           description: This field will store the workload context assigned to the service-instance.
17071           required: false
17072           type: string
17073         - name: model-invariant-id
17074           in: query
17075           description: the ASDC model id for this resource or service model.
17076           required: false
17077           type: string
17078         - name: model-version-id
17079           in: query
17080           description: the ASDC model version for this resource or service model.
17081           required: false
17082           type: string
17083         - name: widget-model-id
17084           in: query
17085           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17086           required: false
17087           type: string
17088         - name: widget-model-version
17089           in: query
17090           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17091           required: false
17092           type: string
17093         - name: service-instance-location-id
17094           in: query
17095           description: An identifier that customers assign to the location where this service is being used.
17096           required: false
17097           type: string
17098         - name: orchestration-status
17099           in: query
17100           description: Orchestration status of this service.
17101           required: false
17102           type: string
17103   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
17104     get:
17105       tags:
17106         - Business
17107       summary: returns service-instance
17108       description: returns service-instance
17109       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17110       produces:
17111         - application/json
17112         - application/xml
17113       responses:
17114         "200":
17115           description: successful operation
17116           schema:
17117               $ref: "#/getDefinitions/service-instance"
17118         "default":
17119           description: Response codes found in [response codes](https://wiki.onap.org/).
17120       parameters:
17121         - name: global-customer-id
17122           in: path
17123           description: Global customer id used across ECOMP to uniquely identify customer.
17124           required: true
17125           type: string
17126           example: __GLOBAL-CUSTOMER-ID__
17127         - name: service-type
17128           in: path
17129           description: Value defined by orchestration to identify this service across ECOMP.
17130           required: true
17131           type: string
17132           example: __SERVICE-TYPE__
17133         - name: service-instance-id
17134           in: path
17135           description: Uniquely identifies this instance of a service
17136           required: true
17137           type: string
17138           example: __SERVICE-INSTANCE-ID__
17139         - name: subscriber-name
17140           in: query
17141           description: Subscriber name, an alternate way to retrieve a customer.
17142           required: false
17143           type: string
17144         - name: subscriber-type
17145           in: query
17146           description: Subscriber type, a way to provide VID with only the INFRA customers.
17147           required: false
17148           type: string
17149         - name: service-instance-name
17150           in: query
17151           description: This field will store a name assigned to the service-instance.
17152           required: false
17153           type: string
17154         - name: environment-context
17155           in: query
17156           description: This field will store the environment context assigned to the service-instance.
17157           required: false
17158           type: string
17159         - name: workload-context
17160           in: query
17161           description: This field will store the workload context assigned to the service-instance.
17162           required: false
17163           type: string
17164         - name: model-invariant-id
17165           in: query
17166           description: the ASDC model id for this resource or service model.
17167           required: false
17168           type: string
17169         - name: model-version-id
17170           in: query
17171           description: the ASDC model version for this resource or service model.
17172           required: false
17173           type: string
17174         - name: widget-model-id
17175           in: query
17176           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17177           required: false
17178           type: string
17179         - name: widget-model-version
17180           in: query
17181           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17182           required: false
17183           type: string
17184         - name: service-instance-location-id
17185           in: query
17186           description: An identifier that customers assign to the location where this service is being used.
17187           required: false
17188           type: string
17189         - name: orchestration-status
17190           in: query
17191           description: Orchestration status of this service.
17192           required: false
17193           type: string
17194     put:
17195       tags:
17196         - Business
17197       summary: create or update an existing service-instance
17198       description: |
17199         Create or update an existing service-instance.
17200         #
17201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17202       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17203       consumes:
17204         - application/json
17205         - application/xml
17206       produces:
17207         - application/json
17208         - application/xml
17209       responses:
17210         "default":
17211           description: Response codes found in [response codes](https://wiki.onap.org/).
17212       parameters:
17213         - name: global-customer-id
17214           in: path
17215           description: Global customer id used across ECOMP to uniquely identify customer.
17216           required: true
17217           type: string
17218           example: __GLOBAL-CUSTOMER-ID__
17219         - name: service-type
17220           in: path
17221           description: Value defined by orchestration to identify this service across ECOMP.
17222           required: true
17223           type: string
17224           example: __SERVICE-TYPE__
17225         - name: service-instance-id
17226           in: path
17227           description: Uniquely identifies this instance of a service
17228           required: true
17229           type: string
17230           example: __SERVICE-INSTANCE-ID__
17231         - name: body
17232           in: body
17233           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
17234           required: true
17235           schema:
17236             $ref: "#/definitions/service-instance"
17237     patch:
17238       tags:
17239         - Business
17240       summary: update an existing service-instance
17241       description: |
17242         Update an existing service-instance
17243         #
17244         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17245         The PUT operation will entirely replace an existing object.
17246         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17247         #
17248         Other differences between PUT and PATCH are:
17249         #
17250         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17251         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17252         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17253       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17254       consumes:
17255         - application/json
17256         - application/xml
17257       produces:
17258         - application/json
17259         - application/xml
17260       responses:
17261         "default":
17262           description: Response codes found in [response codes](https://wiki.onap.org/).
17263       parameters:
17264         - name: global-customer-id
17265           in: path
17266           description: Global customer id used across ECOMP to uniquely identify customer.
17267           required: true
17268           type: string
17269           example: __GLOBAL-CUSTOMER-ID__
17270         - name: service-type
17271           in: path
17272           description: Value defined by orchestration to identify this service across ECOMP.
17273           required: true
17274           type: string
17275           example: __SERVICE-TYPE__
17276         - name: service-instance-id
17277           in: path
17278           description: Uniquely identifies this instance of a service
17279           required: true
17280           type: string
17281           example: __SERVICE-INSTANCE-ID__
17282         - name: body
17283           in: body
17284           description: service-instance object that needs to be created or updated.
17285           required: true
17286           schema:
17287             $ref: "#/patchDefinitions/service-instance"
17288     delete:
17289       tags:
17290         - Business
17291       summary: delete an existing service-instance
17292       description: delete an existing service-instance
17293       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17294       consumes:
17295         - application/json
17296         - application/xml
17297       produces:
17298         - application/json
17299         - application/xml
17300       responses:
17301         "default":
17302           description: Response codes found in [response codes](https://wiki.onap.org/).
17303       parameters:
17304         - name: global-customer-id
17305           in: path
17306           description: Global customer id used across ECOMP to uniquely identify customer.
17307           required: true
17308           type: string
17309           example: __GLOBAL-CUSTOMER-ID__
17310         - name: service-type
17311           in: path
17312           description: Value defined by orchestration to identify this service across ECOMP.
17313           required: true
17314           type: string
17315           example: __SERVICE-TYPE__
17316         - name: service-instance-id
17317           in: path
17318           description: Uniquely identifies this instance of a service
17319           required: true
17320           type: string
17321           example: __SERVICE-INSTANCE-ID__
17322         - name: resource-version
17323           in: query
17324           description: resource-version for concurrency
17325           required: true
17326           type: string
17327   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
17328     get:
17329       tags:
17330         - Business
17331       summary: returns service-instances
17332       description: returns service-instances
17333       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
17334       produces:
17335         - application/json
17336         - application/xml
17337       responses:
17338         "200":
17339           description: successful operation
17340           schema:
17341               $ref: "#/getDefinitions/service-instances"
17342         "default":
17343           description: Response codes found in [response codes](https://wiki.onap.org/).
17344       parameters:
17345         - name: global-customer-id
17346           in: path
17347           description: Global customer id used across ECOMP to uniquely identify customer.
17348           required: true
17349           type: string
17350           example: __GLOBAL-CUSTOMER-ID__
17351         - name: service-type
17352           in: path
17353           description: Value defined by orchestration to identify this service across ECOMP.
17354           required: true
17355           type: string
17356           example: __SERVICE-TYPE__
17357         - name: subscriber-name
17358           in: query
17359           description: Subscriber name, an alternate way to retrieve a customer.
17360           required: false
17361           type: string
17362         - name: subscriber-type
17363           in: query
17364           description: Subscriber type, a way to provide VID with only the INFRA customers.
17365           required: false
17366           type: string
17367   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
17368     put:
17369       tags:
17370         - Business
17371       summary: see node definition for valid relationships
17372       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17373       consumes:
17374         - application/json
17375         - application/xml
17376       produces:
17377         - application/json
17378         - application/xml
17379       responses:
17380         "default":
17381           description: Response codes found in [response codes](https://wiki.onap.org/).
17382       parameters:
17383         - name: global-customer-id
17384           in: path
17385           description: Global customer id used across ECOMP to uniquely identify customer.
17386           required: true
17387           type: string
17388           example: __GLOBAL-CUSTOMER-ID__
17389         - name: service-type
17390           in: path
17391           description: Value defined by orchestration to identify this service across ECOMP.
17392           required: true
17393           type: string
17394           example: __SERVICE-TYPE__
17395         - name: body
17396           in: body
17397           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17398           required: true
17399           schema:
17400             $ref: "#/definitions/relationship"
17401     delete:
17402       tags:
17403         - Business
17404       summary: delete an existing relationship
17405       description: delete an existing relationship
17406       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17407       consumes:
17408         - application/json
17409         - application/xml
17410       produces:
17411         - application/json
17412         - application/xml
17413       responses:
17414         "default":
17415           description: Response codes found in [response codes](https://wiki.onap.org/).
17416       parameters:
17417         - name: global-customer-id
17418           in: path
17419           description: Global customer id used across ECOMP to uniquely identify customer.
17420           required: true
17421           type: string
17422           example: __GLOBAL-CUSTOMER-ID__
17423         - name: service-type
17424           in: path
17425           description: Value defined by orchestration to identify this service across ECOMP.
17426           required: true
17427           type: string
17428           example: __SERVICE-TYPE__
17429   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
17430     get:
17431       tags:
17432         - Business
17433       summary: returns service-subscription
17434       description: returns service-subscription
17435       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17436       produces:
17437         - application/json
17438         - application/xml
17439       responses:
17440         "200":
17441           description: successful operation
17442           schema:
17443               $ref: "#/getDefinitions/service-subscription"
17444         "default":
17445           description: Response codes found in [response codes](https://wiki.onap.org/).
17446       parameters:
17447         - name: global-customer-id
17448           in: path
17449           description: Global customer id used across ECOMP to uniquely identify customer.
17450           required: true
17451           type: string
17452           example: __GLOBAL-CUSTOMER-ID__
17453         - name: service-type
17454           in: path
17455           description: Value defined by orchestration to identify this service across ECOMP.
17456           required: true
17457           type: string
17458           example: __SERVICE-TYPE__
17459         - name: subscriber-name
17460           in: query
17461           description: Subscriber name, an alternate way to retrieve a customer.
17462           required: false
17463           type: string
17464         - name: subscriber-type
17465           in: query
17466           description: Subscriber type, a way to provide VID with only the INFRA customers.
17467           required: false
17468           type: string
17469     put:
17470       tags:
17471         - Business
17472       summary: create or update an existing service-subscription
17473       description: |
17474         Create or update an existing service-subscription.
17475         #
17476         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17477       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17478       consumes:
17479         - application/json
17480         - application/xml
17481       produces:
17482         - application/json
17483         - application/xml
17484       responses:
17485         "default":
17486           description: Response codes found in [response codes](https://wiki.onap.org/).
17487       parameters:
17488         - name: global-customer-id
17489           in: path
17490           description: Global customer id used across ECOMP to uniquely identify customer.
17491           required: true
17492           type: string
17493           example: __GLOBAL-CUSTOMER-ID__
17494         - name: service-type
17495           in: path
17496           description: Value defined by orchestration to identify this service across ECOMP.
17497           required: true
17498           type: string
17499           example: __SERVICE-TYPE__
17500         - name: body
17501           in: body
17502           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17503           required: true
17504           schema:
17505             $ref: "#/definitions/service-subscription"
17506     patch:
17507       tags:
17508         - Business
17509       summary: update an existing service-subscription
17510       description: |
17511         Update an existing service-subscription
17512         #
17513         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17514         The PUT operation will entirely replace an existing object.
17515         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17516         #
17517         Other differences between PUT and PATCH are:
17518         #
17519         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17520         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17521         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17522       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17523       consumes:
17524         - application/json
17525         - application/xml
17526       produces:
17527         - application/json
17528         - application/xml
17529       responses:
17530         "default":
17531           description: Response codes found in [response codes](https://wiki.onap.org/).
17532       parameters:
17533         - name: global-customer-id
17534           in: path
17535           description: Global customer id used across ECOMP to uniquely identify customer.
17536           required: true
17537           type: string
17538           example: __GLOBAL-CUSTOMER-ID__
17539         - name: service-type
17540           in: path
17541           description: Value defined by orchestration to identify this service across ECOMP.
17542           required: true
17543           type: string
17544           example: __SERVICE-TYPE__
17545         - name: body
17546           in: body
17547           description: service-subscription object that needs to be created or updated.
17548           required: true
17549           schema:
17550             $ref: "#/patchDefinitions/service-subscription"
17551     delete:
17552       tags:
17553         - Business
17554       summary: delete an existing service-subscription
17555       description: delete an existing service-subscription
17556       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17557       consumes:
17558         - application/json
17559         - application/xml
17560       produces:
17561         - application/json
17562         - application/xml
17563       responses:
17564         "default":
17565           description: Response codes found in [response codes](https://wiki.onap.org/).
17566       parameters:
17567         - name: global-customer-id
17568           in: path
17569           description: Global customer id used across ECOMP to uniquely identify customer.
17570           required: true
17571           type: string
17572           example: __GLOBAL-CUSTOMER-ID__
17573         - name: service-type
17574           in: path
17575           description: Value defined by orchestration to identify this service across ECOMP.
17576           required: true
17577           type: string
17578           example: __SERVICE-TYPE__
17579         - name: resource-version
17580           in: query
17581           description: resource-version for concurrency
17582           required: true
17583           type: string
17584   /business/customers/customer/{global-customer-id}/service-subscriptions:
17585     get:
17586       tags:
17587         - Business
17588       summary: returns service-subscriptions
17589       description: returns service-subscriptions
17590       operationId: getBusinessCustomersCustomerServiceSubscriptions
17591       produces:
17592         - application/json
17593         - application/xml
17594       responses:
17595         "200":
17596           description: successful operation
17597           schema:
17598               $ref: "#/getDefinitions/service-subscriptions"
17599         "default":
17600           description: Response codes found in [response codes](https://wiki.onap.org/).
17601       parameters:
17602         - name: global-customer-id
17603           in: path
17604           description: Global customer id used across ECOMP to uniquely identify customer.
17605           required: true
17606           type: string
17607           example: __GLOBAL-CUSTOMER-ID__
17608         - name: subscriber-name
17609           in: query
17610           description: Subscriber name, an alternate way to retrieve a customer.
17611           required: false
17612           type: string
17613         - name: subscriber-type
17614           in: query
17615           description: Subscriber type, a way to provide VID with only the INFRA customers.
17616           required: false
17617           type: string
17618   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
17619     put:
17620       tags:
17621         - Business
17622       summary: see node definition for valid relationships
17623       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
17624       consumes:
17625         - application/json
17626         - application/xml
17627       produces:
17628         - application/json
17629         - application/xml
17630       responses:
17631         "default":
17632           description: Response codes found in [response codes](https://wiki.onap.org/).
17633       parameters:
17634         - name: global-customer-id
17635           in: path
17636           description: Global customer id used across ECOMP to uniquely identify customer.
17637           required: true
17638           type: string
17639           example: __GLOBAL-CUSTOMER-ID__
17640         - name: body
17641           in: body
17642           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
17643           required: true
17644           schema:
17645             $ref: "#/definitions/relationship"
17646     delete:
17647       tags:
17648         - Business
17649       summary: delete an existing relationship
17650       description: delete an existing relationship
17651       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
17652       consumes:
17653         - application/json
17654         - application/xml
17655       produces:
17656         - application/json
17657         - application/xml
17658       responses:
17659         "default":
17660           description: Response codes found in [response codes](https://wiki.onap.org/).
17661       parameters:
17662         - name: global-customer-id
17663           in: path
17664           description: Global customer id used across ECOMP to uniquely identify customer.
17665           required: true
17666           type: string
17667           example: __GLOBAL-CUSTOMER-ID__
17668   /business/customers/customer/{global-customer-id}:
17669     get:
17670       tags:
17671         - Business
17672       summary: returns customer
17673       description: returns customer
17674       operationId: getBusinessCustomersCustomer
17675       produces:
17676         - application/json
17677         - application/xml
17678       responses:
17679         "200":
17680           description: successful operation
17681           schema:
17682               $ref: "#/getDefinitions/customer"
17683         "default":
17684           description: Response codes found in [response codes](https://wiki.onap.org/).
17685       parameters:
17686         - name: global-customer-id
17687           in: path
17688           description: Global customer id used across ECOMP to uniquely identify customer.
17689           required: true
17690           type: string
17691           example: __GLOBAL-CUSTOMER-ID__
17692         - name: subscriber-name
17693           in: query
17694           description: Subscriber name, an alternate way to retrieve a customer.
17695           required: false
17696           type: string
17697         - name: subscriber-type
17698           in: query
17699           description: Subscriber type, a way to provide VID with only the INFRA customers.
17700           required: false
17701           type: string
17702     put:
17703       tags:
17704         - Business
17705       summary: create or update an existing customer
17706       description: |
17707         Create or update an existing customer.
17708         #
17709         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17710       operationId: createOrUpdateBusinessCustomersCustomer
17711       consumes:
17712         - application/json
17713         - application/xml
17714       produces:
17715         - application/json
17716         - application/xml
17717       responses:
17718         "default":
17719           description: Response codes found in [response codes](https://wiki.onap.org/).
17720       parameters:
17721         - name: global-customer-id
17722           in: path
17723           description: Global customer id used across ECOMP to uniquely identify customer.
17724           required: true
17725           type: string
17726           example: __GLOBAL-CUSTOMER-ID__
17727         - name: body
17728           in: body
17729           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
17730           required: true
17731           schema:
17732             $ref: "#/definitions/customer"
17733     patch:
17734       tags:
17735         - Business
17736       summary: update an existing customer
17737       description: |
17738         Update an existing customer
17739         #
17740         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17741         The PUT operation will entirely replace an existing object.
17742         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17743         #
17744         Other differences between PUT and PATCH are:
17745         #
17746         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17747         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17748         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17749       operationId: UpdateBusinessCustomersCustomer
17750       consumes:
17751         - application/json
17752         - application/xml
17753       produces:
17754         - application/json
17755         - application/xml
17756       responses:
17757         "default":
17758           description: Response codes found in [response codes](https://wiki.onap.org/).
17759       parameters:
17760         - name: global-customer-id
17761           in: path
17762           description: Global customer id used across ECOMP to uniquely identify customer.
17763           required: true
17764           type: string
17765           example: __GLOBAL-CUSTOMER-ID__
17766         - name: body
17767           in: body
17768           description: customer object that needs to be created or updated.
17769           required: true
17770           schema:
17771             $ref: "#/patchDefinitions/customer"
17772     delete:
17773       tags:
17774         - Business
17775       summary: delete an existing customer
17776       description: delete an existing customer
17777       operationId: deleteBusinessCustomersCustomer
17778       consumes:
17779         - application/json
17780         - application/xml
17781       produces:
17782         - application/json
17783         - application/xml
17784       responses:
17785         "default":
17786           description: Response codes found in [response codes](https://wiki.onap.org/).
17787       parameters:
17788         - name: global-customer-id
17789           in: path
17790           description: Global customer id used across ECOMP to uniquely identify customer.
17791           required: true
17792           type: string
17793           example: __GLOBAL-CUSTOMER-ID__
17794         - name: resource-version
17795           in: query
17796           description: resource-version for concurrency
17797           required: true
17798           type: string
17799   /business/customers:
17800     get:
17801       tags:
17802         - Business
17803       summary: returns customers
17804       description: returns customers
17805       operationId: getBusinessCustomers
17806       produces:
17807         - application/json
17808         - application/xml
17809       responses:
17810         "200":
17811           description: successful operation
17812           schema:
17813               $ref: "#/getDefinitions/customers"
17814         "default":
17815           description: Response codes found in [response codes](https://wiki.onap.org/).
17816   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
17817     put:
17818       tags:
17819         - Business
17820       summary: see node definition for valid relationships
17821       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17822       consumes:
17823         - application/json
17824         - application/xml
17825       produces:
17826         - application/json
17827         - application/xml
17828       responses:
17829         "default":
17830           description: Response codes found in [response codes](https://wiki.onap.org/).
17831       parameters:
17832         - name: line-of-business-name
17833           in: path
17834           description: Name of the line-of-business (product)
17835           required: true
17836           type: string
17837           example: __LINE-OF-BUSINESS-NAME__
17838         - name: body
17839           in: body
17840           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
17841           required: true
17842           schema:
17843             $ref: "#/definitions/relationship"
17844     delete:
17845       tags:
17846         - Business
17847       summary: delete an existing relationship
17848       description: delete an existing relationship
17849       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17850       consumes:
17851         - application/json
17852         - application/xml
17853       produces:
17854         - application/json
17855         - application/xml
17856       responses:
17857         "default":
17858           description: Response codes found in [response codes](https://wiki.onap.org/).
17859       parameters:
17860         - name: line-of-business-name
17861           in: path
17862           description: Name of the line-of-business (product)
17863           required: true
17864           type: string
17865           example: __LINE-OF-BUSINESS-NAME__
17866   /business/lines-of-business/line-of-business/{line-of-business-name}:
17867     get:
17868       tags:
17869         - Business
17870       summary: returns line-of-business
17871       description: returns line-of-business
17872       operationId: getBusinessLinesOfBusinessLineOfBusiness
17873       produces:
17874         - application/json
17875         - application/xml
17876       responses:
17877         "200":
17878           description: successful operation
17879           schema:
17880               $ref: "#/getDefinitions/line-of-business"
17881         "default":
17882           description: Response codes found in [response codes](https://wiki.onap.org/).
17883       parameters:
17884         - name: line-of-business-name
17885           in: path
17886           description: Name of the line-of-business (product)
17887           required: true
17888           type: string
17889           example: __LINE-OF-BUSINESS-NAME__
17890     put:
17891       tags:
17892         - Business
17893       summary: create or update an existing line-of-business
17894       description: |
17895         Create or update an existing line-of-business.
17896         #
17897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17898       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
17899       consumes:
17900         - application/json
17901         - application/xml
17902       produces:
17903         - application/json
17904         - application/xml
17905       responses:
17906         "default":
17907           description: Response codes found in [response codes](https://wiki.onap.org/).
17908       parameters:
17909         - name: line-of-business-name
17910           in: path
17911           description: Name of the line-of-business (product)
17912           required: true
17913           type: string
17914           example: __LINE-OF-BUSINESS-NAME__
17915         - name: body
17916           in: body
17917           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
17918           required: true
17919           schema:
17920             $ref: "#/definitions/line-of-business"
17921     patch:
17922       tags:
17923         - Business
17924       summary: update an existing line-of-business
17925       description: |
17926         Update an existing line-of-business
17927         #
17928         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17929         The PUT operation will entirely replace an existing object.
17930         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17931         #
17932         Other differences between PUT and PATCH are:
17933         #
17934         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17935         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17936         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17937       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
17938       consumes:
17939         - application/json
17940         - application/xml
17941       produces:
17942         - application/json
17943         - application/xml
17944       responses:
17945         "default":
17946           description: Response codes found in [response codes](https://wiki.onap.org/).
17947       parameters:
17948         - name: line-of-business-name
17949           in: path
17950           description: Name of the line-of-business (product)
17951           required: true
17952           type: string
17953           example: __LINE-OF-BUSINESS-NAME__
17954         - name: body
17955           in: body
17956           description: line-of-business object that needs to be created or updated.
17957           required: true
17958           schema:
17959             $ref: "#/patchDefinitions/line-of-business"
17960     delete:
17961       tags:
17962         - Business
17963       summary: delete an existing line-of-business
17964       description: delete an existing line-of-business
17965       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
17966       consumes:
17967         - application/json
17968         - application/xml
17969       produces:
17970         - application/json
17971         - application/xml
17972       responses:
17973         "default":
17974           description: Response codes found in [response codes](https://wiki.onap.org/).
17975       parameters:
17976         - name: line-of-business-name
17977           in: path
17978           description: Name of the line-of-business (product)
17979           required: true
17980           type: string
17981           example: __LINE-OF-BUSINESS-NAME__
17982         - name: resource-version
17983           in: query
17984           description: resource-version for concurrency
17985           required: true
17986           type: string
17987   /business/lines-of-business:
17988     get:
17989       tags:
17990         - Business
17991       summary: returns lines-of-business
17992       description: returns lines-of-business
17993       operationId: getBusinessLinesOfBusiness
17994       produces:
17995         - application/json
17996         - application/xml
17997       responses:
17998         "200":
17999           description: successful operation
18000           schema:
18001               $ref: "#/getDefinitions/lines-of-business"
18002         "default":
18003           description: Response codes found in [response codes](https://wiki.onap.org/).
18004   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
18005     put:
18006       tags:
18007         - Business
18008       summary: see node definition for valid relationships
18009       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18010       consumes:
18011         - application/json
18012         - application/xml
18013       produces:
18014         - application/json
18015         - application/xml
18016       responses:
18017         "default":
18018           description: Response codes found in [response codes](https://wiki.onap.org/).
18019       parameters:
18020         - name: owning-entity-id
18021           in: path
18022           description: UUID of an owning entity
18023           required: true
18024           type: string
18025           example: __OWNING-ENTITY-ID__
18026         - name: body
18027           in: body
18028           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
18029           required: true
18030           schema:
18031             $ref: "#/definitions/relationship"
18032     delete:
18033       tags:
18034         - Business
18035       summary: delete an existing relationship
18036       description: delete an existing relationship
18037       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18038       consumes:
18039         - application/json
18040         - application/xml
18041       produces:
18042         - application/json
18043         - application/xml
18044       responses:
18045         "default":
18046           description: Response codes found in [response codes](https://wiki.onap.org/).
18047       parameters:
18048         - name: owning-entity-id
18049           in: path
18050           description: UUID of an owning entity
18051           required: true
18052           type: string
18053           example: __OWNING-ENTITY-ID__
18054   /business/owning-entities/owning-entity/{owning-entity-id}:
18055     get:
18056       tags:
18057         - Business
18058       summary: returns owning-entity
18059       description: returns owning-entity
18060       operationId: getBusinessOwningEntitiesOwningEntity
18061       produces:
18062         - application/json
18063         - application/xml
18064       responses:
18065         "200":
18066           description: successful operation
18067           schema:
18068               $ref: "#/getDefinitions/owning-entity"
18069         "default":
18070           description: Response codes found in [response codes](https://wiki.onap.org/).
18071       parameters:
18072         - name: owning-entity-id
18073           in: path
18074           description: UUID of an owning entity
18075           required: true
18076           type: string
18077           example: __OWNING-ENTITY-ID__
18078     put:
18079       tags:
18080         - Business
18081       summary: create or update an existing owning-entity
18082       description: |
18083         Create or update an existing owning-entity.
18084         #
18085         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18086       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
18087       consumes:
18088         - application/json
18089         - application/xml
18090       produces:
18091         - application/json
18092         - application/xml
18093       responses:
18094         "default":
18095           description: Response codes found in [response codes](https://wiki.onap.org/).
18096       parameters:
18097         - name: owning-entity-id
18098           in: path
18099           description: UUID of an owning entity
18100           required: true
18101           type: string
18102           example: __OWNING-ENTITY-ID__
18103         - name: body
18104           in: body
18105           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
18106           required: true
18107           schema:
18108             $ref: "#/definitions/owning-entity"
18109     patch:
18110       tags:
18111         - Business
18112       summary: update an existing owning-entity
18113       description: |
18114         Update an existing owning-entity
18115         #
18116         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18117         The PUT operation will entirely replace an existing object.
18118         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18119         #
18120         Other differences between PUT and PATCH are:
18121         #
18122         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18123         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18124         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18125       operationId: UpdateBusinessOwningEntitiesOwningEntity
18126       consumes:
18127         - application/json
18128         - application/xml
18129       produces:
18130         - application/json
18131         - application/xml
18132       responses:
18133         "default":
18134           description: Response codes found in [response codes](https://wiki.onap.org/).
18135       parameters:
18136         - name: owning-entity-id
18137           in: path
18138           description: UUID of an owning entity
18139           required: true
18140           type: string
18141           example: __OWNING-ENTITY-ID__
18142         - name: body
18143           in: body
18144           description: owning-entity object that needs to be created or updated.
18145           required: true
18146           schema:
18147             $ref: "#/patchDefinitions/owning-entity"
18148     delete:
18149       tags:
18150         - Business
18151       summary: delete an existing owning-entity
18152       description: delete an existing owning-entity
18153       operationId: deleteBusinessOwningEntitiesOwningEntity
18154       consumes:
18155         - application/json
18156         - application/xml
18157       produces:
18158         - application/json
18159         - application/xml
18160       responses:
18161         "default":
18162           description: Response codes found in [response codes](https://wiki.onap.org/).
18163       parameters:
18164         - name: owning-entity-id
18165           in: path
18166           description: UUID of an owning entity
18167           required: true
18168           type: string
18169           example: __OWNING-ENTITY-ID__
18170         - name: resource-version
18171           in: query
18172           description: resource-version for concurrency
18173           required: true
18174           type: string
18175   /business/owning-entities:
18176     get:
18177       tags:
18178         - Business
18179       summary: returns owning-entities
18180       description: returns owning-entities
18181       operationId: getBusinessOwningEntities
18182       produces:
18183         - application/json
18184         - application/xml
18185       responses:
18186         "200":
18187           description: successful operation
18188           schema:
18189               $ref: "#/getDefinitions/owning-entities"
18190         "default":
18191           description: Response codes found in [response codes](https://wiki.onap.org/).
18192   /business/platforms/platform/{platform-name}/relationship-list/relationship:
18193     put:
18194       tags:
18195         - Business
18196       summary: see node definition for valid relationships
18197       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
18198       consumes:
18199         - application/json
18200         - application/xml
18201       produces:
18202         - application/json
18203         - application/xml
18204       responses:
18205         "default":
18206           description: Response codes found in [response codes](https://wiki.onap.org/).
18207       parameters:
18208         - name: platform-name
18209           in: path
18210           description: Name of the platform
18211           required: true
18212           type: string
18213           example: __PLATFORM-NAME__
18214         - name: body
18215           in: body
18216           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
18217           required: true
18218           schema:
18219             $ref: "#/definitions/relationship"
18220     delete:
18221       tags:
18222         - Business
18223       summary: delete an existing relationship
18224       description: delete an existing relationship
18225       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
18226       consumes:
18227         - application/json
18228         - application/xml
18229       produces:
18230         - application/json
18231         - application/xml
18232       responses:
18233         "default":
18234           description: Response codes found in [response codes](https://wiki.onap.org/).
18235       parameters:
18236         - name: platform-name
18237           in: path
18238           description: Name of the platform
18239           required: true
18240           type: string
18241           example: __PLATFORM-NAME__
18242   /business/platforms/platform/{platform-name}:
18243     get:
18244       tags:
18245         - Business
18246       summary: returns platform
18247       description: returns platform
18248       operationId: getBusinessPlatformsPlatform
18249       produces:
18250         - application/json
18251         - application/xml
18252       responses:
18253         "200":
18254           description: successful operation
18255           schema:
18256               $ref: "#/getDefinitions/platform"
18257         "default":
18258           description: Response codes found in [response codes](https://wiki.onap.org/).
18259       parameters:
18260         - name: platform-name
18261           in: path
18262           description: Name of the platform
18263           required: true
18264           type: string
18265           example: __PLATFORM-NAME__
18266     put:
18267       tags:
18268         - Business
18269       summary: create or update an existing platform
18270       description: |
18271         Create or update an existing platform.
18272         #
18273         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18274       operationId: createOrUpdateBusinessPlatformsPlatform
18275       consumes:
18276         - application/json
18277         - application/xml
18278       produces:
18279         - application/json
18280         - application/xml
18281       responses:
18282         "default":
18283           description: Response codes found in [response codes](https://wiki.onap.org/).
18284       parameters:
18285         - name: platform-name
18286           in: path
18287           description: Name of the platform
18288           required: true
18289           type: string
18290           example: __PLATFORM-NAME__
18291         - name: body
18292           in: body
18293           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
18294           required: true
18295           schema:
18296             $ref: "#/definitions/platform"
18297     patch:
18298       tags:
18299         - Business
18300       summary: update an existing platform
18301       description: |
18302         Update an existing platform
18303         #
18304         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18305         The PUT operation will entirely replace an existing object.
18306         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18307         #
18308         Other differences between PUT and PATCH are:
18309         #
18310         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18311         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18312         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18313       operationId: UpdateBusinessPlatformsPlatform
18314       consumes:
18315         - application/json
18316         - application/xml
18317       produces:
18318         - application/json
18319         - application/xml
18320       responses:
18321         "default":
18322           description: Response codes found in [response codes](https://wiki.onap.org/).
18323       parameters:
18324         - name: platform-name
18325           in: path
18326           description: Name of the platform
18327           required: true
18328           type: string
18329           example: __PLATFORM-NAME__
18330         - name: body
18331           in: body
18332           description: platform object that needs to be created or updated.
18333           required: true
18334           schema:
18335             $ref: "#/patchDefinitions/platform"
18336     delete:
18337       tags:
18338         - Business
18339       summary: delete an existing platform
18340       description: delete an existing platform
18341       operationId: deleteBusinessPlatformsPlatform
18342       consumes:
18343         - application/json
18344         - application/xml
18345       produces:
18346         - application/json
18347         - application/xml
18348       responses:
18349         "default":
18350           description: Response codes found in [response codes](https://wiki.onap.org/).
18351       parameters:
18352         - name: platform-name
18353           in: path
18354           description: Name of the platform
18355           required: true
18356           type: string
18357           example: __PLATFORM-NAME__
18358         - name: resource-version
18359           in: query
18360           description: resource-version for concurrency
18361           required: true
18362           type: string
18363   /business/platforms:
18364     get:
18365       tags:
18366         - Business
18367       summary: returns platforms
18368       description: returns platforms
18369       operationId: getBusinessPlatforms
18370       produces:
18371         - application/json
18372         - application/xml
18373       responses:
18374         "200":
18375           description: successful operation
18376           schema:
18377               $ref: "#/getDefinitions/platforms"
18378         "default":
18379           description: Response codes found in [response codes](https://wiki.onap.org/).
18380   /business/projects/project/{project-name}/relationship-list/relationship:
18381     put:
18382       tags:
18383         - Business
18384       summary: see node definition for valid relationships
18385       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
18386       consumes:
18387         - application/json
18388         - application/xml
18389       produces:
18390         - application/json
18391         - application/xml
18392       responses:
18393         "default":
18394           description: Response codes found in [response codes](https://wiki.onap.org/).
18395       parameters:
18396         - name: project-name
18397           in: path
18398           description: Name of the project deploying a service
18399           required: true
18400           type: string
18401           example: __PROJECT-NAME__
18402         - name: body
18403           in: body
18404           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
18405           required: true
18406           schema:
18407             $ref: "#/definitions/relationship"
18408     delete:
18409       tags:
18410         - Business
18411       summary: delete an existing relationship
18412       description: delete an existing relationship
18413       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
18414       consumes:
18415         - application/json
18416         - application/xml
18417       produces:
18418         - application/json
18419         - application/xml
18420       responses:
18421         "default":
18422           description: Response codes found in [response codes](https://wiki.onap.org/).
18423       parameters:
18424         - name: project-name
18425           in: path
18426           description: Name of the project deploying a service
18427           required: true
18428           type: string
18429           example: __PROJECT-NAME__
18430   /business/projects/project/{project-name}:
18431     get:
18432       tags:
18433         - Business
18434       summary: returns project
18435       description: returns project
18436       operationId: getBusinessProjectsProject
18437       produces:
18438         - application/json
18439         - application/xml
18440       responses:
18441         "200":
18442           description: successful operation
18443           schema:
18444               $ref: "#/getDefinitions/project"
18445         "default":
18446           description: Response codes found in [response codes](https://wiki.onap.org/).
18447       parameters:
18448         - name: project-name
18449           in: path
18450           description: Name of the project deploying a service
18451           required: true
18452           type: string
18453           example: __PROJECT-NAME__
18454     put:
18455       tags:
18456         - Business
18457       summary: create or update an existing project
18458       description: |
18459         Create or update an existing project.
18460         #
18461         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18462       operationId: createOrUpdateBusinessProjectsProject
18463       consumes:
18464         - application/json
18465         - application/xml
18466       produces:
18467         - application/json
18468         - application/xml
18469       responses:
18470         "default":
18471           description: Response codes found in [response codes](https://wiki.onap.org/).
18472       parameters:
18473         - name: project-name
18474           in: path
18475           description: Name of the project deploying a service
18476           required: true
18477           type: string
18478           example: __PROJECT-NAME__
18479         - name: body
18480           in: body
18481           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
18482           required: true
18483           schema:
18484             $ref: "#/definitions/project"
18485     patch:
18486       tags:
18487         - Business
18488       summary: update an existing project
18489       description: |
18490         Update an existing project
18491         #
18492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18493         The PUT operation will entirely replace an existing object.
18494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18495         #
18496         Other differences between PUT and PATCH are:
18497         #
18498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18501       operationId: UpdateBusinessProjectsProject
18502       consumes:
18503         - application/json
18504         - application/xml
18505       produces:
18506         - application/json
18507         - application/xml
18508       responses:
18509         "default":
18510           description: Response codes found in [response codes](https://wiki.onap.org/).
18511       parameters:
18512         - name: project-name
18513           in: path
18514           description: Name of the project deploying a service
18515           required: true
18516           type: string
18517           example: __PROJECT-NAME__
18518         - name: body
18519           in: body
18520           description: project object that needs to be created or updated.
18521           required: true
18522           schema:
18523             $ref: "#/patchDefinitions/project"
18524     delete:
18525       tags:
18526         - Business
18527       summary: delete an existing project
18528       description: delete an existing project
18529       operationId: deleteBusinessProjectsProject
18530       consumes:
18531         - application/json
18532         - application/xml
18533       produces:
18534         - application/json
18535         - application/xml
18536       responses:
18537         "default":
18538           description: Response codes found in [response codes](https://wiki.onap.org/).
18539       parameters:
18540         - name: project-name
18541           in: path
18542           description: Name of the project deploying a service
18543           required: true
18544           type: string
18545           example: __PROJECT-NAME__
18546         - name: resource-version
18547           in: query
18548           description: resource-version for concurrency
18549           required: true
18550           type: string
18551   /business/projects:
18552     get:
18553       tags:
18554         - Business
18555       summary: returns projects
18556       description: returns projects
18557       operationId: getBusinessProjects
18558       produces:
18559         - application/json
18560         - application/xml
18561       responses:
18562         "200":
18563           description: successful operation
18564           schema:
18565               $ref: "#/getDefinitions/projects"
18566         "default":
18567           description: Response codes found in [response codes](https://wiki.onap.org/).
18568   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
18569     put:
18570       tags:
18571         - ServiceDesignAndCreation
18572       summary: see node definition for valid relationships
18573       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18574       consumes:
18575         - application/json
18576         - application/xml
18577       produces:
18578         - application/json
18579         - application/xml
18580       responses:
18581         "default":
18582           description: Response codes found in [response codes](https://wiki.onap.org/).
18583       parameters:
18584         - name: vnf-image-uuid
18585           in: path
18586           description: Unique ID of this asset
18587           required: true
18588           type: string
18589           example: __VNF-IMAGE-UUID__
18590         - name: body
18591           in: body
18592           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
18593           required: true
18594           schema:
18595             $ref: "#/definitions/relationship"
18596     delete:
18597       tags:
18598         - ServiceDesignAndCreation
18599       summary: delete an existing relationship
18600       description: delete an existing relationship
18601       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18602       consumes:
18603         - application/json
18604         - application/xml
18605       produces:
18606         - application/json
18607         - application/xml
18608       responses:
18609         "default":
18610           description: Response codes found in [response codes](https://wiki.onap.org/).
18611       parameters:
18612         - name: vnf-image-uuid
18613           in: path
18614           description: Unique ID of this asset
18615           required: true
18616           type: string
18617           example: __VNF-IMAGE-UUID__
18618   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
18619     get:
18620       tags:
18621         - ServiceDesignAndCreation
18622       summary: returns vnf-image
18623       description: returns vnf-image
18624       operationId: getServiceDesignAndCreationVnfImagesVnfImage
18625       produces:
18626         - application/json
18627         - application/xml
18628       responses:
18629         "200":
18630           description: successful operation
18631           schema:
18632               $ref: "#/getDefinitions/vnf-image"
18633         "default":
18634           description: Response codes found in [response codes](https://wiki.onap.org/).
18635       parameters:
18636         - name: vnf-image-uuid
18637           in: path
18638           description: Unique ID of this asset
18639           required: true
18640           type: string
18641           example: __VNF-IMAGE-UUID__
18642         - name: application
18643           in: query
18644           description: The application that the image instantiates.
18645           required: false
18646           type: string
18647         - name: application-vendor
18648           in: query
18649           description: The vendor of the application.
18650           required: false
18651           type: string
18652         - name: application-version
18653           in: query
18654           description: The version of the application.
18655           required: false
18656           type: string
18657     put:
18658       tags:
18659         - ServiceDesignAndCreation
18660       summary: create or update an existing vnf-image
18661       description: |
18662         Create or update an existing vnf-image.
18663         #
18664         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18665       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
18666       consumes:
18667         - application/json
18668         - application/xml
18669       produces:
18670         - application/json
18671         - application/xml
18672       responses:
18673         "default":
18674           description: Response codes found in [response codes](https://wiki.onap.org/).
18675       parameters:
18676         - name: vnf-image-uuid
18677           in: path
18678           description: Unique ID of this asset
18679           required: true
18680           type: string
18681           example: __VNF-IMAGE-UUID__
18682         - name: body
18683           in: body
18684           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
18685           required: true
18686           schema:
18687             $ref: "#/definitions/vnf-image"
18688     patch:
18689       tags:
18690         - ServiceDesignAndCreation
18691       summary: update an existing vnf-image
18692       description: |
18693         Update an existing vnf-image
18694         #
18695         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18696         The PUT operation will entirely replace an existing object.
18697         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18698         #
18699         Other differences between PUT and PATCH are:
18700         #
18701         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18702         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18703         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18704       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
18705       consumes:
18706         - application/json
18707         - application/xml
18708       produces:
18709         - application/json
18710         - application/xml
18711       responses:
18712         "default":
18713           description: Response codes found in [response codes](https://wiki.onap.org/).
18714       parameters:
18715         - name: vnf-image-uuid
18716           in: path
18717           description: Unique ID of this asset
18718           required: true
18719           type: string
18720           example: __VNF-IMAGE-UUID__
18721         - name: body
18722           in: body
18723           description: vnf-image object that needs to be created or updated.
18724           required: true
18725           schema:
18726             $ref: "#/patchDefinitions/vnf-image"
18727     delete:
18728       tags:
18729         - ServiceDesignAndCreation
18730       summary: delete an existing vnf-image
18731       description: delete an existing vnf-image
18732       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
18733       consumes:
18734         - application/json
18735         - application/xml
18736       produces:
18737         - application/json
18738         - application/xml
18739       responses:
18740         "default":
18741           description: Response codes found in [response codes](https://wiki.onap.org/).
18742       parameters:
18743         - name: vnf-image-uuid
18744           in: path
18745           description: Unique ID of this asset
18746           required: true
18747           type: string
18748           example: __VNF-IMAGE-UUID__
18749         - name: resource-version
18750           in: query
18751           description: resource-version for concurrency
18752           required: true
18753           type: string
18754   /service-design-and-creation/vnf-images:
18755     get:
18756       tags:
18757         - ServiceDesignAndCreation
18758       summary: returns vnf-images
18759       description: returns vnf-images
18760       operationId: getServiceDesignAndCreationVnfImages
18761       produces:
18762         - application/json
18763         - application/xml
18764       responses:
18765         "200":
18766           description: successful operation
18767           schema:
18768               $ref: "#/getDefinitions/vnf-images"
18769         "default":
18770           description: Response codes found in [response codes](https://wiki.onap.org/).
18771   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
18772     put:
18773       tags:
18774         - ServiceDesignAndCreation
18775       summary: see node definition for valid relationships
18776       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
18777       consumes:
18778         - application/json
18779         - application/xml
18780       produces:
18781         - application/json
18782         - application/xml
18783       responses:
18784         "default":
18785           description: Response codes found in [response codes](https://wiki.onap.org/).
18786       parameters:
18787         - name: service-id
18788           in: path
18789           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18790           required: true
18791           type: string
18792           example: __SERVICE-ID__
18793         - name: body
18794           in: body
18795           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
18796           required: true
18797           schema:
18798             $ref: "#/definitions/relationship"
18799     delete:
18800       tags:
18801         - ServiceDesignAndCreation
18802       summary: delete an existing relationship
18803       description: delete an existing relationship
18804       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
18805       consumes:
18806         - application/json
18807         - application/xml
18808       produces:
18809         - application/json
18810         - application/xml
18811       responses:
18812         "default":
18813           description: Response codes found in [response codes](https://wiki.onap.org/).
18814       parameters:
18815         - name: service-id
18816           in: path
18817           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18818           required: true
18819           type: string
18820           example: __SERVICE-ID__
18821   /service-design-and-creation/services/service/{service-id}:
18822     get:
18823       tags:
18824         - ServiceDesignAndCreation
18825       summary: returns service
18826       description: returns service
18827       operationId: getServiceDesignAndCreationServicesService
18828       produces:
18829         - application/json
18830         - application/xml
18831       responses:
18832         "200":
18833           description: successful operation
18834           schema:
18835               $ref: "#/getDefinitions/service"
18836         "default":
18837           description: Response codes found in [response codes](https://wiki.onap.org/).
18838       parameters:
18839         - name: service-id
18840           in: path
18841           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18842           required: true
18843           type: string
18844           example: __SERVICE-ID__
18845         - name: service-description
18846           in: query
18847           description: Description of the service
18848           required: false
18849           type: string
18850     put:
18851       tags:
18852         - ServiceDesignAndCreation
18853       summary: create or update an existing service
18854       description: |
18855         Create or update an existing service.
18856         #
18857         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18858       operationId: createOrUpdateServiceDesignAndCreationServicesService
18859       consumes:
18860         - application/json
18861         - application/xml
18862       produces:
18863         - application/json
18864         - application/xml
18865       responses:
18866         "default":
18867           description: Response codes found in [response codes](https://wiki.onap.org/).
18868       parameters:
18869         - name: service-id
18870           in: path
18871           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18872           required: true
18873           type: string
18874           example: __SERVICE-ID__
18875         - name: body
18876           in: body
18877           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
18878           required: true
18879           schema:
18880             $ref: "#/definitions/service"
18881     patch:
18882       tags:
18883         - ServiceDesignAndCreation
18884       summary: update an existing service
18885       description: |
18886         Update an existing service
18887         #
18888         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18889         The PUT operation will entirely replace an existing object.
18890         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18891         #
18892         Other differences between PUT and PATCH are:
18893         #
18894         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18895         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18896         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18897       operationId: UpdateServiceDesignAndCreationServicesService
18898       consumes:
18899         - application/json
18900         - application/xml
18901       produces:
18902         - application/json
18903         - application/xml
18904       responses:
18905         "default":
18906           description: Response codes found in [response codes](https://wiki.onap.org/).
18907       parameters:
18908         - name: service-id
18909           in: path
18910           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18911           required: true
18912           type: string
18913           example: __SERVICE-ID__
18914         - name: body
18915           in: body
18916           description: service object that needs to be created or updated.
18917           required: true
18918           schema:
18919             $ref: "#/patchDefinitions/service"
18920     delete:
18921       tags:
18922         - ServiceDesignAndCreation
18923       summary: delete an existing service
18924       description: delete an existing service
18925       operationId: deleteServiceDesignAndCreationServicesService
18926       consumes:
18927         - application/json
18928         - application/xml
18929       produces:
18930         - application/json
18931         - application/xml
18932       responses:
18933         "default":
18934           description: Response codes found in [response codes](https://wiki.onap.org/).
18935       parameters:
18936         - name: service-id
18937           in: path
18938           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18939           required: true
18940           type: string
18941           example: __SERVICE-ID__
18942         - name: resource-version
18943           in: query
18944           description: resource-version for concurrency
18945           required: true
18946           type: string
18947   /service-design-and-creation/services:
18948     get:
18949       tags:
18950         - ServiceDesignAndCreation
18951       summary: returns services
18952       description: returns services
18953       operationId: getServiceDesignAndCreationServices
18954       produces:
18955         - application/json
18956         - application/xml
18957       responses:
18958         "200":
18959           description: successful operation
18960           schema:
18961               $ref: "#/getDefinitions/services"
18962         "default":
18963           description: Response codes found in [response codes](https://wiki.onap.org/).
18964   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
18965     put:
18966       tags:
18967         - ServiceDesignAndCreation
18968       summary: see node definition for valid relationships
18969       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
18970       consumes:
18971         - application/json
18972         - application/xml
18973       produces:
18974         - application/json
18975         - application/xml
18976       responses:
18977         "default":
18978           description: Response codes found in [response codes](https://wiki.onap.org/).
18979       parameters:
18980         - name: service-type
18981           in: path
18982           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18983           required: true
18984           type: string
18985           example: __SERVICE-TYPE__
18986         - name: vnf-type
18987           in: path
18988           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.
18989           required: true
18990           type: string
18991           example: __VNF-TYPE__
18992         - name: body
18993           in: body
18994           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
18995           required: true
18996           schema:
18997             $ref: "#/definitions/relationship"
18998     delete:
18999       tags:
19000         - ServiceDesignAndCreation
19001       summary: delete an existing relationship
19002       description: delete an existing relationship
19003       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19004       consumes:
19005         - application/json
19006         - application/xml
19007       produces:
19008         - application/json
19009         - application/xml
19010       responses:
19011         "default":
19012           description: Response codes found in [response codes](https://wiki.onap.org/).
19013       parameters:
19014         - name: service-type
19015           in: path
19016           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19017           required: true
19018           type: string
19019           example: __SERVICE-TYPE__
19020         - name: vnf-type
19021           in: path
19022           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.
19023           required: true
19024           type: string
19025           example: __VNF-TYPE__
19026   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
19027     get:
19028       tags:
19029         - ServiceDesignAndCreation
19030       summary: returns service-capability
19031       description: returns service-capability
19032       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
19033       produces:
19034         - application/json
19035         - application/xml
19036       responses:
19037         "200":
19038           description: successful operation
19039           schema:
19040               $ref: "#/getDefinitions/service-capability"
19041         "default":
19042           description: Response codes found in [response codes](https://wiki.onap.org/).
19043       parameters:
19044         - name: service-type
19045           in: path
19046           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19047           required: true
19048           type: string
19049           example: __SERVICE-TYPE__
19050         - name: vnf-type
19051           in: path
19052           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.
19053           required: true
19054           type: string
19055           example: __VNF-TYPE__
19056     put:
19057       tags:
19058         - ServiceDesignAndCreation
19059       summary: create or update an existing service-capability
19060       description: |
19061         Create or update an existing service-capability.
19062         #
19063         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19064       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19065       consumes:
19066         - application/json
19067         - application/xml
19068       produces:
19069         - application/json
19070         - application/xml
19071       responses:
19072         "default":
19073           description: Response codes found in [response codes](https://wiki.onap.org/).
19074       parameters:
19075         - name: service-type
19076           in: path
19077           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19078           required: true
19079           type: string
19080           example: __SERVICE-TYPE__
19081         - name: vnf-type
19082           in: path
19083           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.
19084           required: true
19085           type: string
19086           example: __VNF-TYPE__
19087         - name: body
19088           in: body
19089           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19090           required: true
19091           schema:
19092             $ref: "#/definitions/service-capability"
19093     patch:
19094       tags:
19095         - ServiceDesignAndCreation
19096       summary: update an existing service-capability
19097       description: |
19098         Update an existing service-capability
19099         #
19100         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19101         The PUT operation will entirely replace an existing object.
19102         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19103         #
19104         Other differences between PUT and PATCH are:
19105         #
19106         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19107         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19108         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19109       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19110       consumes:
19111         - application/json
19112         - application/xml
19113       produces:
19114         - application/json
19115         - application/xml
19116       responses:
19117         "default":
19118           description: Response codes found in [response codes](https://wiki.onap.org/).
19119       parameters:
19120         - name: service-type
19121           in: path
19122           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19123           required: true
19124           type: string
19125           example: __SERVICE-TYPE__
19126         - name: vnf-type
19127           in: path
19128           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.
19129           required: true
19130           type: string
19131           example: __VNF-TYPE__
19132         - name: body
19133           in: body
19134           description: service-capability object that needs to be created or updated.
19135           required: true
19136           schema:
19137             $ref: "#/patchDefinitions/service-capability"
19138     delete:
19139       tags:
19140         - ServiceDesignAndCreation
19141       summary: delete an existing service-capability
19142       description: delete an existing service-capability
19143       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
19144       consumes:
19145         - application/json
19146         - application/xml
19147       produces:
19148         - application/json
19149         - application/xml
19150       responses:
19151         "default":
19152           description: Response codes found in [response codes](https://wiki.onap.org/).
19153       parameters:
19154         - name: service-type
19155           in: path
19156           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19157           required: true
19158           type: string
19159           example: __SERVICE-TYPE__
19160         - name: vnf-type
19161           in: path
19162           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.
19163           required: true
19164           type: string
19165           example: __VNF-TYPE__
19166         - name: resource-version
19167           in: query
19168           description: resource-version for concurrency
19169           required: true
19170           type: string
19171   /service-design-and-creation/service-capabilities:
19172     get:
19173       tags:
19174         - ServiceDesignAndCreation
19175       summary: returns service-capabilities
19176       description: returns service-capabilities
19177       operationId: getServiceDesignAndCreationServiceCapabilities
19178       produces:
19179         - application/json
19180         - application/xml
19181       responses:
19182         "200":
19183           description: successful operation
19184           schema:
19185               $ref: "#/getDefinitions/service-capabilities"
19186         "default":
19187           description: Response codes found in [response codes](https://wiki.onap.org/).
19188   /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:
19189     put:
19190       tags:
19191         - ServiceDesignAndCreation
19192       summary: see node definition for valid relationships
19193       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19194       consumes:
19195         - application/json
19196         - application/xml
19197       produces:
19198         - application/json
19199         - application/xml
19200       responses:
19201         "default":
19202           description: Response codes found in [response codes](https://wiki.onap.org/).
19203       parameters:
19204         - name: model-invariant-id
19205           in: path
19206           description: Unique identifier corresponding to the main definition of a model in ASDC
19207           required: true
19208           type: string
19209           example: __MODEL-INVARIANT-ID__
19210         - name: model-version-id
19211           in: path
19212           description: Unique identifier corresponding to one version of a model in ASDC
19213           required: true
19214           type: string
19215           example: __MODEL-VERSION-ID__
19216         - name: model-element-uuid
19217           in: path
19218           required: true
19219           type: string
19220           example: __MODEL-ELEMENT-UUID__
19221         - name: model-constraint-uuid
19222           in: path
19223           required: true
19224           type: string
19225           example: __MODEL-CONSTRAINT-UUID__
19226         - name: constrained-element-set-uuid
19227           in: path
19228           required: true
19229           type: string
19230           example: __CONSTRAINED-ELEMENT-SET-UUID__
19231         - name: element-choice-set-uuid
19232           in: path
19233           required: true
19234           type: string
19235           example: __ELEMENT-CHOICE-SET-UUID__
19236         - name: body
19237           in: body
19238           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19239           required: true
19240           schema:
19241             $ref: "#/definitions/relationship"
19242     delete:
19243       tags:
19244         - ServiceDesignAndCreation
19245       summary: delete an existing relationship
19246       description: delete an existing relationship
19247       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19248       consumes:
19249         - application/json
19250         - application/xml
19251       produces:
19252         - application/json
19253         - application/xml
19254       responses:
19255         "default":
19256           description: Response codes found in [response codes](https://wiki.onap.org/).
19257       parameters:
19258         - name: model-invariant-id
19259           in: path
19260           description: Unique identifier corresponding to the main definition of a model in ASDC
19261           required: true
19262           type: string
19263           example: __MODEL-INVARIANT-ID__
19264         - name: model-version-id
19265           in: path
19266           description: Unique identifier corresponding to one version of a model in ASDC
19267           required: true
19268           type: string
19269           example: __MODEL-VERSION-ID__
19270         - name: model-element-uuid
19271           in: path
19272           required: true
19273           type: string
19274           example: __MODEL-ELEMENT-UUID__
19275         - name: model-constraint-uuid
19276           in: path
19277           required: true
19278           type: string
19279           example: __MODEL-CONSTRAINT-UUID__
19280         - name: constrained-element-set-uuid
19281           in: path
19282           required: true
19283           type: string
19284           example: __CONSTRAINED-ELEMENT-SET-UUID__
19285         - name: element-choice-set-uuid
19286           in: path
19287           required: true
19288           type: string
19289           example: __ELEMENT-CHOICE-SET-UUID__
19290   /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}:
19291     get:
19292       tags:
19293         - ServiceDesignAndCreation
19294       summary: returns element-choice-set
19295       description: returns element-choice-set
19296       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19297       produces:
19298         - application/json
19299         - application/xml
19300       responses:
19301         "200":
19302           description: successful operation
19303           schema:
19304               $ref: "#/getDefinitions/element-choice-set"
19305         "default":
19306           description: Response codes found in [response codes](https://wiki.onap.org/).
19307       parameters:
19308         - name: model-invariant-id
19309           in: path
19310           description: Unique identifier corresponding to the main definition of a model in ASDC
19311           required: true
19312           type: string
19313           example: __MODEL-INVARIANT-ID__
19314         - name: model-version-id
19315           in: path
19316           description: Unique identifier corresponding to one version of a model in ASDC
19317           required: true
19318           type: string
19319           example: __MODEL-VERSION-ID__
19320         - name: model-element-uuid
19321           in: path
19322           required: true
19323           type: string
19324           example: __MODEL-ELEMENT-UUID__
19325         - name: model-constraint-uuid
19326           in: path
19327           required: true
19328           type: string
19329           example: __MODEL-CONSTRAINT-UUID__
19330         - name: constrained-element-set-uuid
19331           in: path
19332           required: true
19333           type: string
19334           example: __CONSTRAINED-ELEMENT-SET-UUID__
19335         - name: element-choice-set-uuid
19336           in: path
19337           required: true
19338           type: string
19339           example: __ELEMENT-CHOICE-SET-UUID__
19340         - name: model-type
19341           in: query
19342           description: Type of the model, e.g., service, resource, widget, etc.
19343           required: false
19344           type: string
19345         - name: model-name
19346           in: query
19347           description: Name of the model, which can change from version to version.
19348           required: false
19349           type: string
19350         - name: model-version
19351           in: query
19352           description: Version
19353           required: false
19354           type: string
19355         - name: distribution-status
19356           in: query
19357           description: Distribution Status
19358           required: false
19359           type: string
19360     put:
19361       tags:
19362         - ServiceDesignAndCreation
19363       summary: create or update an existing element-choice-set
19364       description: |
19365         Create or update an existing element-choice-set.
19366         #
19367         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19368       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19369       consumes:
19370         - application/json
19371         - application/xml
19372       produces:
19373         - application/json
19374         - application/xml
19375       responses:
19376         "default":
19377           description: Response codes found in [response codes](https://wiki.onap.org/).
19378       parameters:
19379         - name: model-invariant-id
19380           in: path
19381           description: Unique identifier corresponding to the main definition of a model in ASDC
19382           required: true
19383           type: string
19384           example: __MODEL-INVARIANT-ID__
19385         - name: model-version-id
19386           in: path
19387           description: Unique identifier corresponding to one version of a model in ASDC
19388           required: true
19389           type: string
19390           example: __MODEL-VERSION-ID__
19391         - name: model-element-uuid
19392           in: path
19393           required: true
19394           type: string
19395           example: __MODEL-ELEMENT-UUID__
19396         - name: model-constraint-uuid
19397           in: path
19398           required: true
19399           type: string
19400           example: __MODEL-CONSTRAINT-UUID__
19401         - name: constrained-element-set-uuid
19402           in: path
19403           required: true
19404           type: string
19405           example: __CONSTRAINED-ELEMENT-SET-UUID__
19406         - name: element-choice-set-uuid
19407           in: path
19408           required: true
19409           type: string
19410           example: __ELEMENT-CHOICE-SET-UUID__
19411         - name: body
19412           in: body
19413           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19414           required: true
19415           schema:
19416             $ref: "#/definitions/element-choice-set"
19417     patch:
19418       tags:
19419         - ServiceDesignAndCreation
19420       summary: update an existing element-choice-set
19421       description: |
19422         Update an existing element-choice-set
19423         #
19424         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19425         The PUT operation will entirely replace an existing object.
19426         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19427         #
19428         Other differences between PUT and PATCH are:
19429         #
19430         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19431         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19432         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19433       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19434       consumes:
19435         - application/json
19436         - application/xml
19437       produces:
19438         - application/json
19439         - application/xml
19440       responses:
19441         "default":
19442           description: Response codes found in [response codes](https://wiki.onap.org/).
19443       parameters:
19444         - name: model-invariant-id
19445           in: path
19446           description: Unique identifier corresponding to the main definition of a model in ASDC
19447           required: true
19448           type: string
19449           example: __MODEL-INVARIANT-ID__
19450         - name: model-version-id
19451           in: path
19452           description: Unique identifier corresponding to one version of a model in ASDC
19453           required: true
19454           type: string
19455           example: __MODEL-VERSION-ID__
19456         - name: model-element-uuid
19457           in: path
19458           required: true
19459           type: string
19460           example: __MODEL-ELEMENT-UUID__
19461         - name: model-constraint-uuid
19462           in: path
19463           required: true
19464           type: string
19465           example: __MODEL-CONSTRAINT-UUID__
19466         - name: constrained-element-set-uuid
19467           in: path
19468           required: true
19469           type: string
19470           example: __CONSTRAINED-ELEMENT-SET-UUID__
19471         - name: element-choice-set-uuid
19472           in: path
19473           required: true
19474           type: string
19475           example: __ELEMENT-CHOICE-SET-UUID__
19476         - name: body
19477           in: body
19478           description: element-choice-set object that needs to be created or updated.
19479           required: true
19480           schema:
19481             $ref: "#/patchDefinitions/element-choice-set"
19482     delete:
19483       tags:
19484         - ServiceDesignAndCreation
19485       summary: delete an existing element-choice-set
19486       description: delete an existing element-choice-set
19487       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19488       consumes:
19489         - application/json
19490         - application/xml
19491       produces:
19492         - application/json
19493         - application/xml
19494       responses:
19495         "default":
19496           description: Response codes found in [response codes](https://wiki.onap.org/).
19497       parameters:
19498         - name: model-invariant-id
19499           in: path
19500           description: Unique identifier corresponding to the main definition of a model in ASDC
19501           required: true
19502           type: string
19503           example: __MODEL-INVARIANT-ID__
19504         - name: model-version-id
19505           in: path
19506           description: Unique identifier corresponding to one version of a model in ASDC
19507           required: true
19508           type: string
19509           example: __MODEL-VERSION-ID__
19510         - name: model-element-uuid
19511           in: path
19512           required: true
19513           type: string
19514           example: __MODEL-ELEMENT-UUID__
19515         - name: model-constraint-uuid
19516           in: path
19517           required: true
19518           type: string
19519           example: __MODEL-CONSTRAINT-UUID__
19520         - name: constrained-element-set-uuid
19521           in: path
19522           required: true
19523           type: string
19524           example: __CONSTRAINED-ELEMENT-SET-UUID__
19525         - name: element-choice-set-uuid
19526           in: path
19527           required: true
19528           type: string
19529           example: __ELEMENT-CHOICE-SET-UUID__
19530         - name: resource-version
19531           in: query
19532           description: resource-version for concurrency
19533           required: true
19534           type: string
19535   /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:
19536     get:
19537       tags:
19538         - ServiceDesignAndCreation
19539       summary: returns element-choice-sets
19540       description: returns element-choice-sets
19541       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
19542       produces:
19543         - application/json
19544         - application/xml
19545       responses:
19546         "200":
19547           description: successful operation
19548           schema:
19549               $ref: "#/getDefinitions/element-choice-sets"
19550         "default":
19551           description: Response codes found in [response codes](https://wiki.onap.org/).
19552       parameters:
19553         - name: model-invariant-id
19554           in: path
19555           description: Unique identifier corresponding to the main definition of a model in ASDC
19556           required: true
19557           type: string
19558           example: __MODEL-INVARIANT-ID__
19559         - name: model-version-id
19560           in: path
19561           description: Unique identifier corresponding to one version of a model in ASDC
19562           required: true
19563           type: string
19564           example: __MODEL-VERSION-ID__
19565         - name: model-element-uuid
19566           in: path
19567           required: true
19568           type: string
19569           example: __MODEL-ELEMENT-UUID__
19570         - name: model-constraint-uuid
19571           in: path
19572           required: true
19573           type: string
19574           example: __MODEL-CONSTRAINT-UUID__
19575         - name: constrained-element-set-uuid
19576           in: path
19577           required: true
19578           type: string
19579           example: __CONSTRAINED-ELEMENT-SET-UUID__
19580         - name: model-type
19581           in: query
19582           description: Type of the model, e.g., service, resource, widget, etc.
19583           required: false
19584           type: string
19585         - name: model-name
19586           in: query
19587           description: Name of the model, which can change from version to version.
19588           required: false
19589           type: string
19590         - name: model-version
19591           in: query
19592           description: Version
19593           required: false
19594           type: string
19595         - name: distribution-status
19596           in: query
19597           description: Distribution Status
19598           required: false
19599           type: string
19600   /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:
19601     put:
19602       tags:
19603         - ServiceDesignAndCreation
19604       summary: see node definition for valid relationships
19605       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19606       consumes:
19607         - application/json
19608         - application/xml
19609       produces:
19610         - application/json
19611         - application/xml
19612       responses:
19613         "default":
19614           description: Response codes found in [response codes](https://wiki.onap.org/).
19615       parameters:
19616         - name: model-invariant-id
19617           in: path
19618           description: Unique identifier corresponding to the main definition of a model in ASDC
19619           required: true
19620           type: string
19621           example: __MODEL-INVARIANT-ID__
19622         - name: model-version-id
19623           in: path
19624           description: Unique identifier corresponding to one version of a model in ASDC
19625           required: true
19626           type: string
19627           example: __MODEL-VERSION-ID__
19628         - name: model-element-uuid
19629           in: path
19630           required: true
19631           type: string
19632           example: __MODEL-ELEMENT-UUID__
19633         - name: model-constraint-uuid
19634           in: path
19635           required: true
19636           type: string
19637           example: __MODEL-CONSTRAINT-UUID__
19638         - name: constrained-element-set-uuid
19639           in: path
19640           required: true
19641           type: string
19642           example: __CONSTRAINED-ELEMENT-SET-UUID__
19643         - name: body
19644           in: body
19645           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19646           required: true
19647           schema:
19648             $ref: "#/definitions/relationship"
19649     delete:
19650       tags:
19651         - ServiceDesignAndCreation
19652       summary: delete an existing relationship
19653       description: delete an existing relationship
19654       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19655       consumes:
19656         - application/json
19657         - application/xml
19658       produces:
19659         - application/json
19660         - application/xml
19661       responses:
19662         "default":
19663           description: Response codes found in [response codes](https://wiki.onap.org/).
19664       parameters:
19665         - name: model-invariant-id
19666           in: path
19667           description: Unique identifier corresponding to the main definition of a model in ASDC
19668           required: true
19669           type: string
19670           example: __MODEL-INVARIANT-ID__
19671         - name: model-version-id
19672           in: path
19673           description: Unique identifier corresponding to one version of a model in ASDC
19674           required: true
19675           type: string
19676           example: __MODEL-VERSION-ID__
19677         - name: model-element-uuid
19678           in: path
19679           required: true
19680           type: string
19681           example: __MODEL-ELEMENT-UUID__
19682         - name: model-constraint-uuid
19683           in: path
19684           required: true
19685           type: string
19686           example: __MODEL-CONSTRAINT-UUID__
19687         - name: constrained-element-set-uuid
19688           in: path
19689           required: true
19690           type: string
19691           example: __CONSTRAINED-ELEMENT-SET-UUID__
19692   /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}:
19693     get:
19694       tags:
19695         - ServiceDesignAndCreation
19696       summary: returns constrained-element-set
19697       description: returns constrained-element-set
19698       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19699       produces:
19700         - application/json
19701         - application/xml
19702       responses:
19703         "200":
19704           description: successful operation
19705           schema:
19706               $ref: "#/getDefinitions/constrained-element-set"
19707         "default":
19708           description: Response codes found in [response codes](https://wiki.onap.org/).
19709       parameters:
19710         - name: model-invariant-id
19711           in: path
19712           description: Unique identifier corresponding to the main definition of a model in ASDC
19713           required: true
19714           type: string
19715           example: __MODEL-INVARIANT-ID__
19716         - name: model-version-id
19717           in: path
19718           description: Unique identifier corresponding to one version of a model in ASDC
19719           required: true
19720           type: string
19721           example: __MODEL-VERSION-ID__
19722         - name: model-element-uuid
19723           in: path
19724           required: true
19725           type: string
19726           example: __MODEL-ELEMENT-UUID__
19727         - name: model-constraint-uuid
19728           in: path
19729           required: true
19730           type: string
19731           example: __MODEL-CONSTRAINT-UUID__
19732         - name: constrained-element-set-uuid
19733           in: path
19734           required: true
19735           type: string
19736           example: __CONSTRAINED-ELEMENT-SET-UUID__
19737         - name: model-type
19738           in: query
19739           description: Type of the model, e.g., service, resource, widget, etc.
19740           required: false
19741           type: string
19742         - name: model-name
19743           in: query
19744           description: Name of the model, which can change from version to version.
19745           required: false
19746           type: string
19747         - name: model-version
19748           in: query
19749           description: Version
19750           required: false
19751           type: string
19752         - name: distribution-status
19753           in: query
19754           description: Distribution Status
19755           required: false
19756           type: string
19757     put:
19758       tags:
19759         - ServiceDesignAndCreation
19760       summary: create or update an existing constrained-element-set
19761       description: |
19762         Create or update an existing constrained-element-set.
19763         #
19764         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19765       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19766       consumes:
19767         - application/json
19768         - application/xml
19769       produces:
19770         - application/json
19771         - application/xml
19772       responses:
19773         "default":
19774           description: Response codes found in [response codes](https://wiki.onap.org/).
19775       parameters:
19776         - name: model-invariant-id
19777           in: path
19778           description: Unique identifier corresponding to the main definition of a model in ASDC
19779           required: true
19780           type: string
19781           example: __MODEL-INVARIANT-ID__
19782         - name: model-version-id
19783           in: path
19784           description: Unique identifier corresponding to one version of a model in ASDC
19785           required: true
19786           type: string
19787           example: __MODEL-VERSION-ID__
19788         - name: model-element-uuid
19789           in: path
19790           required: true
19791           type: string
19792           example: __MODEL-ELEMENT-UUID__
19793         - name: model-constraint-uuid
19794           in: path
19795           required: true
19796           type: string
19797           example: __MODEL-CONSTRAINT-UUID__
19798         - name: constrained-element-set-uuid
19799           in: path
19800           required: true
19801           type: string
19802           example: __CONSTRAINED-ELEMENT-SET-UUID__
19803         - name: body
19804           in: body
19805           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19806           required: true
19807           schema:
19808             $ref: "#/definitions/constrained-element-set"
19809     patch:
19810       tags:
19811         - ServiceDesignAndCreation
19812       summary: update an existing constrained-element-set
19813       description: |
19814         Update an existing constrained-element-set
19815         #
19816         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19817         The PUT operation will entirely replace an existing object.
19818         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19819         #
19820         Other differences between PUT and PATCH are:
19821         #
19822         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19823         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19824         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19825       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19826       consumes:
19827         - application/json
19828         - application/xml
19829       produces:
19830         - application/json
19831         - application/xml
19832       responses:
19833         "default":
19834           description: Response codes found in [response codes](https://wiki.onap.org/).
19835       parameters:
19836         - name: model-invariant-id
19837           in: path
19838           description: Unique identifier corresponding to the main definition of a model in ASDC
19839           required: true
19840           type: string
19841           example: __MODEL-INVARIANT-ID__
19842         - name: model-version-id
19843           in: path
19844           description: Unique identifier corresponding to one version of a model in ASDC
19845           required: true
19846           type: string
19847           example: __MODEL-VERSION-ID__
19848         - name: model-element-uuid
19849           in: path
19850           required: true
19851           type: string
19852           example: __MODEL-ELEMENT-UUID__
19853         - name: model-constraint-uuid
19854           in: path
19855           required: true
19856           type: string
19857           example: __MODEL-CONSTRAINT-UUID__
19858         - name: constrained-element-set-uuid
19859           in: path
19860           required: true
19861           type: string
19862           example: __CONSTRAINED-ELEMENT-SET-UUID__
19863         - name: body
19864           in: body
19865           description: constrained-element-set object that needs to be created or updated.
19866           required: true
19867           schema:
19868             $ref: "#/patchDefinitions/constrained-element-set"
19869     delete:
19870       tags:
19871         - ServiceDesignAndCreation
19872       summary: delete an existing constrained-element-set
19873       description: delete an existing constrained-element-set
19874       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19875       consumes:
19876         - application/json
19877         - application/xml
19878       produces:
19879         - application/json
19880         - application/xml
19881       responses:
19882         "default":
19883           description: Response codes found in [response codes](https://wiki.onap.org/).
19884       parameters:
19885         - name: model-invariant-id
19886           in: path
19887           description: Unique identifier corresponding to the main definition of a model in ASDC
19888           required: true
19889           type: string
19890           example: __MODEL-INVARIANT-ID__
19891         - name: model-version-id
19892           in: path
19893           description: Unique identifier corresponding to one version of a model in ASDC
19894           required: true
19895           type: string
19896           example: __MODEL-VERSION-ID__
19897         - name: model-element-uuid
19898           in: path
19899           required: true
19900           type: string
19901           example: __MODEL-ELEMENT-UUID__
19902         - name: model-constraint-uuid
19903           in: path
19904           required: true
19905           type: string
19906           example: __MODEL-CONSTRAINT-UUID__
19907         - name: constrained-element-set-uuid
19908           in: path
19909           required: true
19910           type: string
19911           example: __CONSTRAINED-ELEMENT-SET-UUID__
19912         - name: resource-version
19913           in: query
19914           description: resource-version for concurrency
19915           required: true
19916           type: string
19917   /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:
19918     get:
19919       tags:
19920         - ServiceDesignAndCreation
19921       summary: returns constrained-element-sets
19922       description: returns constrained-element-sets
19923       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
19924       produces:
19925         - application/json
19926         - application/xml
19927       responses:
19928         "200":
19929           description: successful operation
19930           schema:
19931               $ref: "#/getDefinitions/constrained-element-sets"
19932         "default":
19933           description: Response codes found in [response codes](https://wiki.onap.org/).
19934       parameters:
19935         - name: model-invariant-id
19936           in: path
19937           description: Unique identifier corresponding to the main definition of a model in ASDC
19938           required: true
19939           type: string
19940           example: __MODEL-INVARIANT-ID__
19941         - name: model-version-id
19942           in: path
19943           description: Unique identifier corresponding to one version of a model in ASDC
19944           required: true
19945           type: string
19946           example: __MODEL-VERSION-ID__
19947         - name: model-element-uuid
19948           in: path
19949           required: true
19950           type: string
19951           example: __MODEL-ELEMENT-UUID__
19952         - name: model-constraint-uuid
19953           in: path
19954           required: true
19955           type: string
19956           example: __MODEL-CONSTRAINT-UUID__
19957         - name: model-type
19958           in: query
19959           description: Type of the model, e.g., service, resource, widget, etc.
19960           required: false
19961           type: string
19962         - name: model-name
19963           in: query
19964           description: Name of the model, which can change from version to version.
19965           required: false
19966           type: string
19967         - name: model-version
19968           in: query
19969           description: Version
19970           required: false
19971           type: string
19972         - name: distribution-status
19973           in: query
19974           description: Distribution Status
19975           required: false
19976           type: string
19977   /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}:
19978     get:
19979       tags:
19980         - ServiceDesignAndCreation
19981       summary: returns model-constraint
19982       description: returns model-constraint
19983       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19984       produces:
19985         - application/json
19986         - application/xml
19987       responses:
19988         "200":
19989           description: successful operation
19990           schema:
19991               $ref: "#/getDefinitions/model-constraint"
19992         "default":
19993           description: Response codes found in [response codes](https://wiki.onap.org/).
19994       parameters:
19995         - name: model-invariant-id
19996           in: path
19997           description: Unique identifier corresponding to the main definition of a model in ASDC
19998           required: true
19999           type: string
20000           example: __MODEL-INVARIANT-ID__
20001         - name: model-version-id
20002           in: path
20003           description: Unique identifier corresponding to one version of a model in ASDC
20004           required: true
20005           type: string
20006           example: __MODEL-VERSION-ID__
20007         - name: model-element-uuid
20008           in: path
20009           required: true
20010           type: string
20011           example: __MODEL-ELEMENT-UUID__
20012         - name: model-constraint-uuid
20013           in: path
20014           required: true
20015           type: string
20016           example: __MODEL-CONSTRAINT-UUID__
20017         - name: model-type
20018           in: query
20019           description: Type of the model, e.g., service, resource, widget, etc.
20020           required: false
20021           type: string
20022         - name: model-name
20023           in: query
20024           description: Name of the model, which can change from version to version.
20025           required: false
20026           type: string
20027         - name: model-version
20028           in: query
20029           description: Version
20030           required: false
20031           type: string
20032         - name: distribution-status
20033           in: query
20034           description: Distribution Status
20035           required: false
20036           type: string
20037     put:
20038       tags:
20039         - ServiceDesignAndCreation
20040       summary: create or update an existing model-constraint
20041       description: |
20042         Create or update an existing model-constraint.
20043         #
20044         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20045       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20046       consumes:
20047         - application/json
20048         - application/xml
20049       produces:
20050         - application/json
20051         - application/xml
20052       responses:
20053         "default":
20054           description: Response codes found in [response codes](https://wiki.onap.org/).
20055       parameters:
20056         - name: model-invariant-id
20057           in: path
20058           description: Unique identifier corresponding to the main definition of a model in ASDC
20059           required: true
20060           type: string
20061           example: __MODEL-INVARIANT-ID__
20062         - name: model-version-id
20063           in: path
20064           description: Unique identifier corresponding to one version of a model in ASDC
20065           required: true
20066           type: string
20067           example: __MODEL-VERSION-ID__
20068         - name: model-element-uuid
20069           in: path
20070           required: true
20071           type: string
20072           example: __MODEL-ELEMENT-UUID__
20073         - name: model-constraint-uuid
20074           in: path
20075           required: true
20076           type: string
20077           example: __MODEL-CONSTRAINT-UUID__
20078         - name: body
20079           in: body
20080           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
20081           required: true
20082           schema:
20083             $ref: "#/definitions/model-constraint"
20084     patch:
20085       tags:
20086         - ServiceDesignAndCreation
20087       summary: update an existing model-constraint
20088       description: |
20089         Update an existing model-constraint
20090         #
20091         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20092         The PUT operation will entirely replace an existing object.
20093         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20094         #
20095         Other differences between PUT and PATCH are:
20096         #
20097         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20098         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20099         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20100       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20101       consumes:
20102         - application/json
20103         - application/xml
20104       produces:
20105         - application/json
20106         - application/xml
20107       responses:
20108         "default":
20109           description: Response codes found in [response codes](https://wiki.onap.org/).
20110       parameters:
20111         - name: model-invariant-id
20112           in: path
20113           description: Unique identifier corresponding to the main definition of a model in ASDC
20114           required: true
20115           type: string
20116           example: __MODEL-INVARIANT-ID__
20117         - name: model-version-id
20118           in: path
20119           description: Unique identifier corresponding to one version of a model in ASDC
20120           required: true
20121           type: string
20122           example: __MODEL-VERSION-ID__
20123         - name: model-element-uuid
20124           in: path
20125           required: true
20126           type: string
20127           example: __MODEL-ELEMENT-UUID__
20128         - name: model-constraint-uuid
20129           in: path
20130           required: true
20131           type: string
20132           example: __MODEL-CONSTRAINT-UUID__
20133         - name: body
20134           in: body
20135           description: model-constraint object that needs to be created or updated.
20136           required: true
20137           schema:
20138             $ref: "#/patchDefinitions/model-constraint"
20139     delete:
20140       tags:
20141         - ServiceDesignAndCreation
20142       summary: delete an existing model-constraint
20143       description: delete an existing model-constraint
20144       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20145       consumes:
20146         - application/json
20147         - application/xml
20148       produces:
20149         - application/json
20150         - application/xml
20151       responses:
20152         "default":
20153           description: Response codes found in [response codes](https://wiki.onap.org/).
20154       parameters:
20155         - name: model-invariant-id
20156           in: path
20157           description: Unique identifier corresponding to the main definition of a model in ASDC
20158           required: true
20159           type: string
20160           example: __MODEL-INVARIANT-ID__
20161         - name: model-version-id
20162           in: path
20163           description: Unique identifier corresponding to one version of a model in ASDC
20164           required: true
20165           type: string
20166           example: __MODEL-VERSION-ID__
20167         - name: model-element-uuid
20168           in: path
20169           required: true
20170           type: string
20171           example: __MODEL-ELEMENT-UUID__
20172         - name: model-constraint-uuid
20173           in: path
20174           required: true
20175           type: string
20176           example: __MODEL-CONSTRAINT-UUID__
20177         - name: resource-version
20178           in: query
20179           description: resource-version for concurrency
20180           required: true
20181           type: string
20182   /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:
20183     get:
20184       tags:
20185         - ServiceDesignAndCreation
20186       summary: returns model-constraints
20187       description: returns model-constraints
20188       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
20189       produces:
20190         - application/json
20191         - application/xml
20192       responses:
20193         "200":
20194           description: successful operation
20195           schema:
20196               $ref: "#/getDefinitions/model-constraints"
20197         "default":
20198           description: Response codes found in [response codes](https://wiki.onap.org/).
20199       parameters:
20200         - name: model-invariant-id
20201           in: path
20202           description: Unique identifier corresponding to the main definition of a model in ASDC
20203           required: true
20204           type: string
20205           example: __MODEL-INVARIANT-ID__
20206         - name: model-version-id
20207           in: path
20208           description: Unique identifier corresponding to one version of a model in ASDC
20209           required: true
20210           type: string
20211           example: __MODEL-VERSION-ID__
20212         - name: model-element-uuid
20213           in: path
20214           required: true
20215           type: string
20216           example: __MODEL-ELEMENT-UUID__
20217         - name: model-type
20218           in: query
20219           description: Type of the model, e.g., service, resource, widget, etc.
20220           required: false
20221           type: string
20222         - name: model-name
20223           in: query
20224           description: Name of the model, which can change from version to version.
20225           required: false
20226           type: string
20227         - name: model-version
20228           in: query
20229           description: Version
20230           required: false
20231           type: string
20232         - name: distribution-status
20233           in: query
20234           description: Distribution Status
20235           required: false
20236           type: string
20237   /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:
20238     put:
20239       tags:
20240         - ServiceDesignAndCreation
20241       summary: see node definition for valid relationships
20242       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20243       consumes:
20244         - application/json
20245         - application/xml
20246       produces:
20247         - application/json
20248         - application/xml
20249       responses:
20250         "default":
20251           description: Response codes found in [response codes](https://wiki.onap.org/).
20252       parameters:
20253         - name: model-invariant-id
20254           in: path
20255           description: Unique identifier corresponding to the main definition of a model in ASDC
20256           required: true
20257           type: string
20258           example: __MODEL-INVARIANT-ID__
20259         - name: model-version-id
20260           in: path
20261           description: Unique identifier corresponding to one version of a model in ASDC
20262           required: true
20263           type: string
20264           example: __MODEL-VERSION-ID__
20265         - name: model-element-uuid
20266           in: path
20267           required: true
20268           type: string
20269           example: __MODEL-ELEMENT-UUID__
20270         - name: body
20271           in: body
20272           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20273           required: true
20274           schema:
20275             $ref: "#/definitions/relationship"
20276     delete:
20277       tags:
20278         - ServiceDesignAndCreation
20279       summary: delete an existing relationship
20280       description: delete an existing relationship
20281       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20282       consumes:
20283         - application/json
20284         - application/xml
20285       produces:
20286         - application/json
20287         - application/xml
20288       responses:
20289         "default":
20290           description: Response codes found in [response codes](https://wiki.onap.org/).
20291       parameters:
20292         - name: model-invariant-id
20293           in: path
20294           description: Unique identifier corresponding to the main definition of a model in ASDC
20295           required: true
20296           type: string
20297           example: __MODEL-INVARIANT-ID__
20298         - name: model-version-id
20299           in: path
20300           description: Unique identifier corresponding to one version of a model in ASDC
20301           required: true
20302           type: string
20303           example: __MODEL-VERSION-ID__
20304         - name: model-element-uuid
20305           in: path
20306           required: true
20307           type: string
20308           example: __MODEL-ELEMENT-UUID__
20309   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
20310     get:
20311       tags:
20312         - ServiceDesignAndCreation
20313       summary: returns model-element
20314       description: returns model-element
20315       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20316       produces:
20317         - application/json
20318         - application/xml
20319       responses:
20320         "200":
20321           description: successful operation
20322           schema:
20323               $ref: "#/getDefinitions/model-element"
20324         "default":
20325           description: Response codes found in [response codes](https://wiki.onap.org/).
20326       parameters:
20327         - name: model-invariant-id
20328           in: path
20329           description: Unique identifier corresponding to the main definition of a model in ASDC
20330           required: true
20331           type: string
20332           example: __MODEL-INVARIANT-ID__
20333         - name: model-version-id
20334           in: path
20335           description: Unique identifier corresponding to one version of a model in ASDC
20336           required: true
20337           type: string
20338           example: __MODEL-VERSION-ID__
20339         - name: model-element-uuid
20340           in: path
20341           required: true
20342           type: string
20343           example: __MODEL-ELEMENT-UUID__
20344         - name: model-type
20345           in: query
20346           description: Type of the model, e.g., service, resource, widget, etc.
20347           required: false
20348           type: string
20349         - name: model-name
20350           in: query
20351           description: Name of the model, which can change from version to version.
20352           required: false
20353           type: string
20354         - name: model-version
20355           in: query
20356           description: Version
20357           required: false
20358           type: string
20359         - name: distribution-status
20360           in: query
20361           description: Distribution Status
20362           required: false
20363           type: string
20364     put:
20365       tags:
20366         - ServiceDesignAndCreation
20367       summary: create or update an existing model-element
20368       description: |
20369         Create or update an existing model-element.
20370         #
20371         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20372       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20373       consumes:
20374         - application/json
20375         - application/xml
20376       produces:
20377         - application/json
20378         - application/xml
20379       responses:
20380         "default":
20381           description: Response codes found in [response codes](https://wiki.onap.org/).
20382       parameters:
20383         - name: model-invariant-id
20384           in: path
20385           description: Unique identifier corresponding to the main definition of a model in ASDC
20386           required: true
20387           type: string
20388           example: __MODEL-INVARIANT-ID__
20389         - name: model-version-id
20390           in: path
20391           description: Unique identifier corresponding to one version of a model in ASDC
20392           required: true
20393           type: string
20394           example: __MODEL-VERSION-ID__
20395         - name: model-element-uuid
20396           in: path
20397           required: true
20398           type: string
20399           example: __MODEL-ELEMENT-UUID__
20400         - name: body
20401           in: body
20402           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20403           required: true
20404           schema:
20405             $ref: "#/definitions/model-element"
20406     patch:
20407       tags:
20408         - ServiceDesignAndCreation
20409       summary: update an existing model-element
20410       description: |
20411         Update an existing model-element
20412         #
20413         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20414         The PUT operation will entirely replace an existing object.
20415         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20416         #
20417         Other differences between PUT and PATCH are:
20418         #
20419         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20420         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20421         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20422       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20423       consumes:
20424         - application/json
20425         - application/xml
20426       produces:
20427         - application/json
20428         - application/xml
20429       responses:
20430         "default":
20431           description: Response codes found in [response codes](https://wiki.onap.org/).
20432       parameters:
20433         - name: model-invariant-id
20434           in: path
20435           description: Unique identifier corresponding to the main definition of a model in ASDC
20436           required: true
20437           type: string
20438           example: __MODEL-INVARIANT-ID__
20439         - name: model-version-id
20440           in: path
20441           description: Unique identifier corresponding to one version of a model in ASDC
20442           required: true
20443           type: string
20444           example: __MODEL-VERSION-ID__
20445         - name: model-element-uuid
20446           in: path
20447           required: true
20448           type: string
20449           example: __MODEL-ELEMENT-UUID__
20450         - name: body
20451           in: body
20452           description: model-element object that needs to be created or updated.
20453           required: true
20454           schema:
20455             $ref: "#/patchDefinitions/model-element"
20456     delete:
20457       tags:
20458         - ServiceDesignAndCreation
20459       summary: delete an existing model-element
20460       description: delete an existing model-element
20461       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20462       consumes:
20463         - application/json
20464         - application/xml
20465       produces:
20466         - application/json
20467         - application/xml
20468       responses:
20469         "default":
20470           description: Response codes found in [response codes](https://wiki.onap.org/).
20471       parameters:
20472         - name: model-invariant-id
20473           in: path
20474           description: Unique identifier corresponding to the main definition of a model in ASDC
20475           required: true
20476           type: string
20477           example: __MODEL-INVARIANT-ID__
20478         - name: model-version-id
20479           in: path
20480           description: Unique identifier corresponding to one version of a model in ASDC
20481           required: true
20482           type: string
20483           example: __MODEL-VERSION-ID__
20484         - name: model-element-uuid
20485           in: path
20486           required: true
20487           type: string
20488           example: __MODEL-ELEMENT-UUID__
20489         - name: resource-version
20490           in: query
20491           description: resource-version for concurrency
20492           required: true
20493           type: string
20494   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
20495     get:
20496       tags:
20497         - ServiceDesignAndCreation
20498       summary: returns model-elements
20499       description: returns model-elements
20500       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
20501       produces:
20502         - application/json
20503         - application/xml
20504       responses:
20505         "200":
20506           description: successful operation
20507           schema:
20508               $ref: "#/getDefinitions/model-elements"
20509         "default":
20510           description: Response codes found in [response codes](https://wiki.onap.org/).
20511       parameters:
20512         - name: model-invariant-id
20513           in: path
20514           description: Unique identifier corresponding to the main definition of a model in ASDC
20515           required: true
20516           type: string
20517           example: __MODEL-INVARIANT-ID__
20518         - name: model-version-id
20519           in: path
20520           description: Unique identifier corresponding to one version of a model in ASDC
20521           required: true
20522           type: string
20523           example: __MODEL-VERSION-ID__
20524         - name: model-type
20525           in: query
20526           description: Type of the model, e.g., service, resource, widget, etc.
20527           required: false
20528           type: string
20529         - name: model-name
20530           in: query
20531           description: Name of the model, which can change from version to version.
20532           required: false
20533           type: string
20534         - name: model-version
20535           in: query
20536           description: Version
20537           required: false
20538           type: string
20539         - name: distribution-status
20540           in: query
20541           description: Distribution Status
20542           required: false
20543           type: string
20544   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
20545     get:
20546       tags:
20547         - ServiceDesignAndCreation
20548       summary: returns metadatum
20549       description: returns metadatum
20550       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20551       produces:
20552         - application/json
20553         - application/xml
20554       responses:
20555         "200":
20556           description: successful operation
20557           schema:
20558               $ref: "#/getDefinitions/metadatum"
20559         "default":
20560           description: Response codes found in [response codes](https://wiki.onap.org/).
20561       parameters:
20562         - name: model-invariant-id
20563           in: path
20564           description: Unique identifier corresponding to the main definition of a model in ASDC
20565           required: true
20566           type: string
20567           example: __MODEL-INVARIANT-ID__
20568         - name: model-version-id
20569           in: path
20570           description: Unique identifier corresponding to one version of a model in ASDC
20571           required: true
20572           type: string
20573           example: __MODEL-VERSION-ID__
20574         - name: metaname
20575           in: path
20576           required: true
20577           type: string
20578           example: __METANAME__
20579         - name: model-type
20580           in: query
20581           description: Type of the model, e.g., service, resource, widget, etc.
20582           required: false
20583           type: string
20584         - name: model-name
20585           in: query
20586           description: Name of the model, which can change from version to version.
20587           required: false
20588           type: string
20589         - name: model-version
20590           in: query
20591           description: Version
20592           required: false
20593           type: string
20594         - name: distribution-status
20595           in: query
20596           description: Distribution Status
20597           required: false
20598           type: string
20599     put:
20600       tags:
20601         - ServiceDesignAndCreation
20602       summary: create or update an existing metadatum
20603       description: |
20604         Create or update an existing metadatum.
20605         #
20606         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20607       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20608       consumes:
20609         - application/json
20610         - application/xml
20611       produces:
20612         - application/json
20613         - application/xml
20614       responses:
20615         "default":
20616           description: Response codes found in [response codes](https://wiki.onap.org/).
20617       parameters:
20618         - name: model-invariant-id
20619           in: path
20620           description: Unique identifier corresponding to the main definition of a model in ASDC
20621           required: true
20622           type: string
20623           example: __MODEL-INVARIANT-ID__
20624         - name: model-version-id
20625           in: path
20626           description: Unique identifier corresponding to one version of a model in ASDC
20627           required: true
20628           type: string
20629           example: __MODEL-VERSION-ID__
20630         - name: metaname
20631           in: path
20632           required: true
20633           type: string
20634           example: __METANAME__
20635         - name: body
20636           in: body
20637           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
20638           required: true
20639           schema:
20640             $ref: "#/definitions/metadatum"
20641     patch:
20642       tags:
20643         - ServiceDesignAndCreation
20644       summary: update an existing metadatum
20645       description: |
20646         Update an existing metadatum
20647         #
20648         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20649         The PUT operation will entirely replace an existing object.
20650         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20651         #
20652         Other differences between PUT and PATCH are:
20653         #
20654         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20655         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20656         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20657       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20658       consumes:
20659         - application/json
20660         - application/xml
20661       produces:
20662         - application/json
20663         - application/xml
20664       responses:
20665         "default":
20666           description: Response codes found in [response codes](https://wiki.onap.org/).
20667       parameters:
20668         - name: model-invariant-id
20669           in: path
20670           description: Unique identifier corresponding to the main definition of a model in ASDC
20671           required: true
20672           type: string
20673           example: __MODEL-INVARIANT-ID__
20674         - name: model-version-id
20675           in: path
20676           description: Unique identifier corresponding to one version of a model in ASDC
20677           required: true
20678           type: string
20679           example: __MODEL-VERSION-ID__
20680         - name: metaname
20681           in: path
20682           required: true
20683           type: string
20684           example: __METANAME__
20685         - name: body
20686           in: body
20687           description: metadatum object that needs to be created or updated.
20688           required: true
20689           schema:
20690             $ref: "#/patchDefinitions/metadatum"
20691     delete:
20692       tags:
20693         - ServiceDesignAndCreation
20694       summary: delete an existing metadatum
20695       description: delete an existing metadatum
20696       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20697       consumes:
20698         - application/json
20699         - application/xml
20700       produces:
20701         - application/json
20702         - application/xml
20703       responses:
20704         "default":
20705           description: Response codes found in [response codes](https://wiki.onap.org/).
20706       parameters:
20707         - name: model-invariant-id
20708           in: path
20709           description: Unique identifier corresponding to the main definition of a model in ASDC
20710           required: true
20711           type: string
20712           example: __MODEL-INVARIANT-ID__
20713         - name: model-version-id
20714           in: path
20715           description: Unique identifier corresponding to one version of a model in ASDC
20716           required: true
20717           type: string
20718           example: __MODEL-VERSION-ID__
20719         - name: metaname
20720           in: path
20721           required: true
20722           type: string
20723           example: __METANAME__
20724         - name: resource-version
20725           in: query
20726           description: resource-version for concurrency
20727           required: true
20728           type: string
20729   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
20730     get:
20731       tags:
20732         - ServiceDesignAndCreation
20733       summary: returns metadata
20734       description: returns metadata
20735       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
20736       produces:
20737         - application/json
20738         - application/xml
20739       responses:
20740         "200":
20741           description: successful operation
20742           schema:
20743               $ref: "#/getDefinitions/metadata"
20744         "default":
20745           description: Response codes found in [response codes](https://wiki.onap.org/).
20746       parameters:
20747         - name: model-invariant-id
20748           in: path
20749           description: Unique identifier corresponding to the main definition of a model in ASDC
20750           required: true
20751           type: string
20752           example: __MODEL-INVARIANT-ID__
20753         - name: model-version-id
20754           in: path
20755           description: Unique identifier corresponding to one version of a model in ASDC
20756           required: true
20757           type: string
20758           example: __MODEL-VERSION-ID__
20759         - name: model-type
20760           in: query
20761           description: Type of the model, e.g., service, resource, widget, etc.
20762           required: false
20763           type: string
20764         - name: model-name
20765           in: query
20766           description: Name of the model, which can change from version to version.
20767           required: false
20768           type: string
20769         - name: model-version
20770           in: query
20771           description: Version
20772           required: false
20773           type: string
20774         - name: distribution-status
20775           in: query
20776           description: Distribution Status
20777           required: false
20778           type: string
20779   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
20780     put:
20781       tags:
20782         - ServiceDesignAndCreation
20783       summary: see node definition for valid relationships
20784       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20785       consumes:
20786         - application/json
20787         - application/xml
20788       produces:
20789         - application/json
20790         - application/xml
20791       responses:
20792         "default":
20793           description: Response codes found in [response codes](https://wiki.onap.org/).
20794       parameters:
20795         - name: model-invariant-id
20796           in: path
20797           description: Unique identifier corresponding to the main definition of a model in ASDC
20798           required: true
20799           type: string
20800           example: __MODEL-INVARIANT-ID__
20801         - name: model-version-id
20802           in: path
20803           description: Unique identifier corresponding to one version of a model in ASDC
20804           required: true
20805           type: string
20806           example: __MODEL-VERSION-ID__
20807         - name: body
20808           in: body
20809           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20810           required: true
20811           schema:
20812             $ref: "#/definitions/relationship"
20813     delete:
20814       tags:
20815         - ServiceDesignAndCreation
20816       summary: delete an existing relationship
20817       description: delete an existing relationship
20818       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20819       consumes:
20820         - application/json
20821         - application/xml
20822       produces:
20823         - application/json
20824         - application/xml
20825       responses:
20826         "default":
20827           description: Response codes found in [response codes](https://wiki.onap.org/).
20828       parameters:
20829         - name: model-invariant-id
20830           in: path
20831           description: Unique identifier corresponding to the main definition of a model in ASDC
20832           required: true
20833           type: string
20834           example: __MODEL-INVARIANT-ID__
20835         - name: model-version-id
20836           in: path
20837           description: Unique identifier corresponding to one version of a model in ASDC
20838           required: true
20839           type: string
20840           example: __MODEL-VERSION-ID__
20841   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
20842     get:
20843       tags:
20844         - ServiceDesignAndCreation
20845       summary: returns model-ver
20846       description: returns model-ver
20847       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
20848       produces:
20849         - application/json
20850         - application/xml
20851       responses:
20852         "200":
20853           description: successful operation
20854           schema:
20855               $ref: "#/getDefinitions/model-ver"
20856         "default":
20857           description: Response codes found in [response codes](https://wiki.onap.org/).
20858       parameters:
20859         - name: model-invariant-id
20860           in: path
20861           description: Unique identifier corresponding to the main definition of a model in ASDC
20862           required: true
20863           type: string
20864           example: __MODEL-INVARIANT-ID__
20865         - name: model-version-id
20866           in: path
20867           description: Unique identifier corresponding to one version of a model in ASDC
20868           required: true
20869           type: string
20870           example: __MODEL-VERSION-ID__
20871         - name: model-type
20872           in: query
20873           description: Type of the model, e.g., service, resource, widget, etc.
20874           required: false
20875           type: string
20876         - name: model-name
20877           in: query
20878           description: Name of the model, which can change from version to version.
20879           required: false
20880           type: string
20881         - name: model-version
20882           in: query
20883           description: Version
20884           required: false
20885           type: string
20886         - name: distribution-status
20887           in: query
20888           description: Distribution Status
20889           required: false
20890           type: string
20891     put:
20892       tags:
20893         - ServiceDesignAndCreation
20894       summary: create or update an existing model-ver
20895       description: |
20896         Create or update an existing model-ver.
20897         #
20898         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20899       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
20900       consumes:
20901         - application/json
20902         - application/xml
20903       produces:
20904         - application/json
20905         - application/xml
20906       responses:
20907         "default":
20908           description: Response codes found in [response codes](https://wiki.onap.org/).
20909       parameters:
20910         - name: model-invariant-id
20911           in: path
20912           description: Unique identifier corresponding to the main definition of a model in ASDC
20913           required: true
20914           type: string
20915           example: __MODEL-INVARIANT-ID__
20916         - name: model-version-id
20917           in: path
20918           description: Unique identifier corresponding to one version of a model in ASDC
20919           required: true
20920           type: string
20921           example: __MODEL-VERSION-ID__
20922         - name: body
20923           in: body
20924           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20925           required: true
20926           schema:
20927             $ref: "#/definitions/model-ver"
20928     patch:
20929       tags:
20930         - ServiceDesignAndCreation
20931       summary: update an existing model-ver
20932       description: |
20933         Update an existing model-ver
20934         #
20935         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20936         The PUT operation will entirely replace an existing object.
20937         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20938         #
20939         Other differences between PUT and PATCH are:
20940         #
20941         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20942         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20943         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20944       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
20945       consumes:
20946         - application/json
20947         - application/xml
20948       produces:
20949         - application/json
20950         - application/xml
20951       responses:
20952         "default":
20953           description: Response codes found in [response codes](https://wiki.onap.org/).
20954       parameters:
20955         - name: model-invariant-id
20956           in: path
20957           description: Unique identifier corresponding to the main definition of a model in ASDC
20958           required: true
20959           type: string
20960           example: __MODEL-INVARIANT-ID__
20961         - name: model-version-id
20962           in: path
20963           description: Unique identifier corresponding to one version of a model in ASDC
20964           required: true
20965           type: string
20966           example: __MODEL-VERSION-ID__
20967         - name: body
20968           in: body
20969           description: model-ver object that needs to be created or updated.
20970           required: true
20971           schema:
20972             $ref: "#/patchDefinitions/model-ver"
20973     delete:
20974       tags:
20975         - ServiceDesignAndCreation
20976       summary: delete an existing model-ver
20977       description: delete an existing model-ver
20978       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
20979       consumes:
20980         - application/json
20981         - application/xml
20982       produces:
20983         - application/json
20984         - application/xml
20985       responses:
20986         "default":
20987           description: Response codes found in [response codes](https://wiki.onap.org/).
20988       parameters:
20989         - name: model-invariant-id
20990           in: path
20991           description: Unique identifier corresponding to the main definition of a model in ASDC
20992           required: true
20993           type: string
20994           example: __MODEL-INVARIANT-ID__
20995         - name: model-version-id
20996           in: path
20997           description: Unique identifier corresponding to one version of a model in ASDC
20998           required: true
20999           type: string
21000           example: __MODEL-VERSION-ID__
21001         - name: resource-version
21002           in: query
21003           description: resource-version for concurrency
21004           required: true
21005           type: string
21006   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
21007     get:
21008       tags:
21009         - ServiceDesignAndCreation
21010       summary: returns model-vers
21011       description: returns model-vers
21012       operationId: getServiceDesignAndCreationModelsModelModelVers
21013       produces:
21014         - application/json
21015         - application/xml
21016       responses:
21017         "200":
21018           description: successful operation
21019           schema:
21020               $ref: "#/getDefinitions/model-vers"
21021         "default":
21022           description: Response codes found in [response codes](https://wiki.onap.org/).
21023       parameters:
21024         - name: model-invariant-id
21025           in: path
21026           description: Unique identifier corresponding to the main definition of a model in ASDC
21027           required: true
21028           type: string
21029           example: __MODEL-INVARIANT-ID__
21030         - name: model-type
21031           in: query
21032           description: Type of the model, e.g., service, resource, widget, etc.
21033           required: false
21034           type: string
21035   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
21036     put:
21037       tags:
21038         - ServiceDesignAndCreation
21039       summary: see node definition for valid relationships
21040       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
21041       consumes:
21042         - application/json
21043         - application/xml
21044       produces:
21045         - application/json
21046         - application/xml
21047       responses:
21048         "default":
21049           description: Response codes found in [response codes](https://wiki.onap.org/).
21050       parameters:
21051         - name: model-invariant-id
21052           in: path
21053           description: Unique identifier corresponding to the main definition of a model in ASDC
21054           required: true
21055           type: string
21056           example: __MODEL-INVARIANT-ID__
21057         - name: body
21058           in: body
21059           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
21060           required: true
21061           schema:
21062             $ref: "#/definitions/relationship"
21063     delete:
21064       tags:
21065         - ServiceDesignAndCreation
21066       summary: delete an existing relationship
21067       description: delete an existing relationship
21068       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
21069       consumes:
21070         - application/json
21071         - application/xml
21072       produces:
21073         - application/json
21074         - application/xml
21075       responses:
21076         "default":
21077           description: Response codes found in [response codes](https://wiki.onap.org/).
21078       parameters:
21079         - name: model-invariant-id
21080           in: path
21081           description: Unique identifier corresponding to the main definition of a model in ASDC
21082           required: true
21083           type: string
21084           example: __MODEL-INVARIANT-ID__
21085   /service-design-and-creation/models/model/{model-invariant-id}:
21086     get:
21087       tags:
21088         - ServiceDesignAndCreation
21089       summary: returns model
21090       description: returns model
21091       operationId: getServiceDesignAndCreationModelsModel
21092       produces:
21093         - application/json
21094         - application/xml
21095       responses:
21096         "200":
21097           description: successful operation
21098           schema:
21099               $ref: "#/getDefinitions/model"
21100         "default":
21101           description: Response codes found in [response codes](https://wiki.onap.org/).
21102       parameters:
21103         - name: model-invariant-id
21104           in: path
21105           description: Unique identifier corresponding to the main definition of a model in ASDC
21106           required: true
21107           type: string
21108           example: __MODEL-INVARIANT-ID__
21109         - name: model-type
21110           in: query
21111           description: Type of the model, e.g., service, resource, widget, etc.
21112           required: false
21113           type: string
21114     put:
21115       tags:
21116         - ServiceDesignAndCreation
21117       summary: create or update an existing model
21118       description: |
21119         Create or update an existing model.
21120         #
21121         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21122       operationId: createOrUpdateServiceDesignAndCreationModelsModel
21123       consumes:
21124         - application/json
21125         - application/xml
21126       produces:
21127         - application/json
21128         - application/xml
21129       responses:
21130         "default":
21131           description: Response codes found in [response codes](https://wiki.onap.org/).
21132       parameters:
21133         - name: model-invariant-id
21134           in: path
21135           description: Unique identifier corresponding to the main definition of a model in ASDC
21136           required: true
21137           type: string
21138           example: __MODEL-INVARIANT-ID__
21139         - name: body
21140           in: body
21141           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
21142           required: true
21143           schema:
21144             $ref: "#/definitions/model"
21145     patch:
21146       tags:
21147         - ServiceDesignAndCreation
21148       summary: update an existing model
21149       description: |
21150         Update an existing model
21151         #
21152         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21153         The PUT operation will entirely replace an existing object.
21154         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21155         #
21156         Other differences between PUT and PATCH are:
21157         #
21158         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21159         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21160         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21161       operationId: UpdateServiceDesignAndCreationModelsModel
21162       consumes:
21163         - application/json
21164         - application/xml
21165       produces:
21166         - application/json
21167         - application/xml
21168       responses:
21169         "default":
21170           description: Response codes found in [response codes](https://wiki.onap.org/).
21171       parameters:
21172         - name: model-invariant-id
21173           in: path
21174           description: Unique identifier corresponding to the main definition of a model in ASDC
21175           required: true
21176           type: string
21177           example: __MODEL-INVARIANT-ID__
21178         - name: body
21179           in: body
21180           description: model object that needs to be created or updated.
21181           required: true
21182           schema:
21183             $ref: "#/patchDefinitions/model"
21184     delete:
21185       tags:
21186         - ServiceDesignAndCreation
21187       summary: delete an existing model
21188       description: delete an existing model
21189       operationId: deleteServiceDesignAndCreationModelsModel
21190       consumes:
21191         - application/json
21192         - application/xml
21193       produces:
21194         - application/json
21195         - application/xml
21196       responses:
21197         "default":
21198           description: Response codes found in [response codes](https://wiki.onap.org/).
21199       parameters:
21200         - name: model-invariant-id
21201           in: path
21202           description: Unique identifier corresponding to the main definition of a model in ASDC
21203           required: true
21204           type: string
21205           example: __MODEL-INVARIANT-ID__
21206         - name: resource-version
21207           in: query
21208           description: resource-version for concurrency
21209           required: true
21210           type: string
21211   /service-design-and-creation/models:
21212     get:
21213       tags:
21214         - ServiceDesignAndCreation
21215       summary: returns models
21216       description: returns models
21217       operationId: getServiceDesignAndCreationModels
21218       produces:
21219         - application/json
21220         - application/xml
21221       responses:
21222         "200":
21223           description: successful operation
21224           schema:
21225               $ref: "#/getDefinitions/models"
21226         "default":
21227           description: Response codes found in [response codes](https://wiki.onap.org/).
21228   /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:
21229     put:
21230       tags:
21231         - ServiceDesignAndCreation
21232       summary: see node definition for valid relationships
21233       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21234       consumes:
21235         - application/json
21236         - application/xml
21237       produces:
21238         - application/json
21239         - application/xml
21240       responses:
21241         "default":
21242           description: Response codes found in [response codes](https://wiki.onap.org/).
21243       parameters:
21244         - name: named-query-uuid
21245           in: path
21246           required: true
21247           type: string
21248           example: __NAMED-QUERY-UUID__
21249         - name: named-query-element-uuid
21250           in: path
21251           required: true
21252           type: string
21253           example: __NAMED-QUERY-ELEMENT-UUID__
21254         - name: related-lookup-uuid
21255           in: path
21256           required: true
21257           type: string
21258           example: __RELATED-LOOKUP-UUID__
21259         - name: body
21260           in: body
21261           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21262           required: true
21263           schema:
21264             $ref: "#/definitions/relationship"
21265     delete:
21266       tags:
21267         - ServiceDesignAndCreation
21268       summary: delete an existing relationship
21269       description: delete an existing relationship
21270       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21271       consumes:
21272         - application/json
21273         - application/xml
21274       produces:
21275         - application/json
21276         - application/xml
21277       responses:
21278         "default":
21279           description: Response codes found in [response codes](https://wiki.onap.org/).
21280       parameters:
21281         - name: named-query-uuid
21282           in: path
21283           required: true
21284           type: string
21285           example: __NAMED-QUERY-UUID__
21286         - name: named-query-element-uuid
21287           in: path
21288           required: true
21289           type: string
21290           example: __NAMED-QUERY-ELEMENT-UUID__
21291         - name: related-lookup-uuid
21292           in: path
21293           required: true
21294           type: string
21295           example: __RELATED-LOOKUP-UUID__
21296   /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}:
21297     get:
21298       tags:
21299         - ServiceDesignAndCreation
21300       summary: returns related-lookup
21301       description: returns related-lookup
21302       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21303       produces:
21304         - application/json
21305         - application/xml
21306       responses:
21307         "200":
21308           description: successful operation
21309           schema:
21310               $ref: "#/getDefinitions/related-lookup"
21311         "default":
21312           description: Response codes found in [response codes](https://wiki.onap.org/).
21313       parameters:
21314         - name: named-query-uuid
21315           in: path
21316           required: true
21317           type: string
21318           example: __NAMED-QUERY-UUID__
21319         - name: named-query-element-uuid
21320           in: path
21321           required: true
21322           type: string
21323           example: __NAMED-QUERY-ELEMENT-UUID__
21324         - name: related-lookup-uuid
21325           in: path
21326           required: true
21327           type: string
21328           example: __RELATED-LOOKUP-UUID__
21329         - name: named-query-name
21330           in: query
21331           required: false
21332           type: string
21333     put:
21334       tags:
21335         - ServiceDesignAndCreation
21336       summary: create or update an existing related-lookup
21337       description: |
21338         Create or update an existing related-lookup.
21339         #
21340         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21341       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21342       consumes:
21343         - application/json
21344         - application/xml
21345       produces:
21346         - application/json
21347         - application/xml
21348       responses:
21349         "default":
21350           description: Response codes found in [response codes](https://wiki.onap.org/).
21351       parameters:
21352         - name: named-query-uuid
21353           in: path
21354           required: true
21355           type: string
21356           example: __NAMED-QUERY-UUID__
21357         - name: named-query-element-uuid
21358           in: path
21359           required: true
21360           type: string
21361           example: __NAMED-QUERY-ELEMENT-UUID__
21362         - name: related-lookup-uuid
21363           in: path
21364           required: true
21365           type: string
21366           example: __RELATED-LOOKUP-UUID__
21367         - name: body
21368           in: body
21369           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21370           required: true
21371           schema:
21372             $ref: "#/definitions/related-lookup"
21373     patch:
21374       tags:
21375         - ServiceDesignAndCreation
21376       summary: update an existing related-lookup
21377       description: |
21378         Update an existing related-lookup
21379         #
21380         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21381         The PUT operation will entirely replace an existing object.
21382         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21383         #
21384         Other differences between PUT and PATCH are:
21385         #
21386         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21387         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21388         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21389       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21390       consumes:
21391         - application/json
21392         - application/xml
21393       produces:
21394         - application/json
21395         - application/xml
21396       responses:
21397         "default":
21398           description: Response codes found in [response codes](https://wiki.onap.org/).
21399       parameters:
21400         - name: named-query-uuid
21401           in: path
21402           required: true
21403           type: string
21404           example: __NAMED-QUERY-UUID__
21405         - name: named-query-element-uuid
21406           in: path
21407           required: true
21408           type: string
21409           example: __NAMED-QUERY-ELEMENT-UUID__
21410         - name: related-lookup-uuid
21411           in: path
21412           required: true
21413           type: string
21414           example: __RELATED-LOOKUP-UUID__
21415         - name: body
21416           in: body
21417           description: related-lookup object that needs to be created or updated.
21418           required: true
21419           schema:
21420             $ref: "#/patchDefinitions/related-lookup"
21421     delete:
21422       tags:
21423         - ServiceDesignAndCreation
21424       summary: delete an existing related-lookup
21425       description: delete an existing related-lookup
21426       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21427       consumes:
21428         - application/json
21429         - application/xml
21430       produces:
21431         - application/json
21432         - application/xml
21433       responses:
21434         "default":
21435           description: Response codes found in [response codes](https://wiki.onap.org/).
21436       parameters:
21437         - name: named-query-uuid
21438           in: path
21439           required: true
21440           type: string
21441           example: __NAMED-QUERY-UUID__
21442         - name: named-query-element-uuid
21443           in: path
21444           required: true
21445           type: string
21446           example: __NAMED-QUERY-ELEMENT-UUID__
21447         - name: related-lookup-uuid
21448           in: path
21449           required: true
21450           type: string
21451           example: __RELATED-LOOKUP-UUID__
21452         - name: resource-version
21453           in: query
21454           description: resource-version for concurrency
21455           required: true
21456           type: string
21457   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
21458     get:
21459       tags:
21460         - ServiceDesignAndCreation
21461       summary: returns related-lookups
21462       description: returns related-lookups
21463       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
21464       produces:
21465         - application/json
21466         - application/xml
21467       responses:
21468         "200":
21469           description: successful operation
21470           schema:
21471               $ref: "#/getDefinitions/related-lookups"
21472         "default":
21473           description: Response codes found in [response codes](https://wiki.onap.org/).
21474       parameters:
21475         - name: named-query-uuid
21476           in: path
21477           required: true
21478           type: string
21479           example: __NAMED-QUERY-UUID__
21480         - name: named-query-element-uuid
21481           in: path
21482           required: true
21483           type: string
21484           example: __NAMED-QUERY-ELEMENT-UUID__
21485         - name: named-query-name
21486           in: query
21487           required: false
21488           type: string
21489   /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}:
21490     get:
21491       tags:
21492         - ServiceDesignAndCreation
21493       summary: returns property-constraint
21494       description: returns property-constraint
21495       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21496       produces:
21497         - application/json
21498         - application/xml
21499       responses:
21500         "200":
21501           description: successful operation
21502           schema:
21503               $ref: "#/getDefinitions/property-constraint"
21504         "default":
21505           description: Response codes found in [response codes](https://wiki.onap.org/).
21506       parameters:
21507         - name: named-query-uuid
21508           in: path
21509           required: true
21510           type: string
21511           example: __NAMED-QUERY-UUID__
21512         - name: named-query-element-uuid
21513           in: path
21514           required: true
21515           type: string
21516           example: __NAMED-QUERY-ELEMENT-UUID__
21517         - name: property-constraint-uuid
21518           in: path
21519           required: true
21520           type: string
21521           example: __PROPERTY-CONSTRAINT-UUID__
21522         - name: named-query-name
21523           in: query
21524           required: false
21525           type: string
21526     put:
21527       tags:
21528         - ServiceDesignAndCreation
21529       summary: create or update an existing property-constraint
21530       description: |
21531         Create or update an existing property-constraint.
21532         #
21533         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21534       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21535       consumes:
21536         - application/json
21537         - application/xml
21538       produces:
21539         - application/json
21540         - application/xml
21541       responses:
21542         "default":
21543           description: Response codes found in [response codes](https://wiki.onap.org/).
21544       parameters:
21545         - name: named-query-uuid
21546           in: path
21547           required: true
21548           type: string
21549           example: __NAMED-QUERY-UUID__
21550         - name: named-query-element-uuid
21551           in: path
21552           required: true
21553           type: string
21554           example: __NAMED-QUERY-ELEMENT-UUID__
21555         - name: property-constraint-uuid
21556           in: path
21557           required: true
21558           type: string
21559           example: __PROPERTY-CONSTRAINT-UUID__
21560         - name: body
21561           in: body
21562           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
21563           required: true
21564           schema:
21565             $ref: "#/definitions/property-constraint"
21566     patch:
21567       tags:
21568         - ServiceDesignAndCreation
21569       summary: update an existing property-constraint
21570       description: |
21571         Update an existing property-constraint
21572         #
21573         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21574         The PUT operation will entirely replace an existing object.
21575         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21576         #
21577         Other differences between PUT and PATCH are:
21578         #
21579         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21580         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21581         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21582       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21583       consumes:
21584         - application/json
21585         - application/xml
21586       produces:
21587         - application/json
21588         - application/xml
21589       responses:
21590         "default":
21591           description: Response codes found in [response codes](https://wiki.onap.org/).
21592       parameters:
21593         - name: named-query-uuid
21594           in: path
21595           required: true
21596           type: string
21597           example: __NAMED-QUERY-UUID__
21598         - name: named-query-element-uuid
21599           in: path
21600           required: true
21601           type: string
21602           example: __NAMED-QUERY-ELEMENT-UUID__
21603         - name: property-constraint-uuid
21604           in: path
21605           required: true
21606           type: string
21607           example: __PROPERTY-CONSTRAINT-UUID__
21608         - name: body
21609           in: body
21610           description: property-constraint object that needs to be created or updated.
21611           required: true
21612           schema:
21613             $ref: "#/patchDefinitions/property-constraint"
21614     delete:
21615       tags:
21616         - ServiceDesignAndCreation
21617       summary: delete an existing property-constraint
21618       description: delete an existing property-constraint
21619       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21620       consumes:
21621         - application/json
21622         - application/xml
21623       produces:
21624         - application/json
21625         - application/xml
21626       responses:
21627         "default":
21628           description: Response codes found in [response codes](https://wiki.onap.org/).
21629       parameters:
21630         - name: named-query-uuid
21631           in: path
21632           required: true
21633           type: string
21634           example: __NAMED-QUERY-UUID__
21635         - name: named-query-element-uuid
21636           in: path
21637           required: true
21638           type: string
21639           example: __NAMED-QUERY-ELEMENT-UUID__
21640         - name: property-constraint-uuid
21641           in: path
21642           required: true
21643           type: string
21644           example: __PROPERTY-CONSTRAINT-UUID__
21645         - name: resource-version
21646           in: query
21647           description: resource-version for concurrency
21648           required: true
21649           type: string
21650   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
21651     get:
21652       tags:
21653         - ServiceDesignAndCreation
21654       summary: returns property-constraints
21655       description: returns property-constraints
21656       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
21657       produces:
21658         - application/json
21659         - application/xml
21660       responses:
21661         "200":
21662           description: successful operation
21663           schema:
21664               $ref: "#/getDefinitions/property-constraints"
21665         "default":
21666           description: Response codes found in [response codes](https://wiki.onap.org/).
21667       parameters:
21668         - name: named-query-uuid
21669           in: path
21670           required: true
21671           type: string
21672           example: __NAMED-QUERY-UUID__
21673         - name: named-query-element-uuid
21674           in: path
21675           required: true
21676           type: string
21677           example: __NAMED-QUERY-ELEMENT-UUID__
21678         - name: named-query-name
21679           in: query
21680           required: false
21681           type: string
21682   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
21683     put:
21684       tags:
21685         - ServiceDesignAndCreation
21686       summary: see node definition for valid relationships
21687       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21688       consumes:
21689         - application/json
21690         - application/xml
21691       produces:
21692         - application/json
21693         - application/xml
21694       responses:
21695         "default":
21696           description: Response codes found in [response codes](https://wiki.onap.org/).
21697       parameters:
21698         - name: named-query-uuid
21699           in: path
21700           required: true
21701           type: string
21702           example: __NAMED-QUERY-UUID__
21703         - name: named-query-element-uuid
21704           in: path
21705           required: true
21706           type: string
21707           example: __NAMED-QUERY-ELEMENT-UUID__
21708         - name: body
21709           in: body
21710           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21711           required: true
21712           schema:
21713             $ref: "#/definitions/relationship"
21714     delete:
21715       tags:
21716         - ServiceDesignAndCreation
21717       summary: delete an existing relationship
21718       description: delete an existing relationship
21719       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21720       consumes:
21721         - application/json
21722         - application/xml
21723       produces:
21724         - application/json
21725         - application/xml
21726       responses:
21727         "default":
21728           description: Response codes found in [response codes](https://wiki.onap.org/).
21729       parameters:
21730         - name: named-query-uuid
21731           in: path
21732           required: true
21733           type: string
21734           example: __NAMED-QUERY-UUID__
21735         - name: named-query-element-uuid
21736           in: path
21737           required: true
21738           type: string
21739           example: __NAMED-QUERY-ELEMENT-UUID__
21740   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
21741     get:
21742       tags:
21743         - ServiceDesignAndCreation
21744       summary: returns named-query-element
21745       description: returns named-query-element
21746       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21747       produces:
21748         - application/json
21749         - application/xml
21750       responses:
21751         "200":
21752           description: successful operation
21753           schema:
21754               $ref: "#/getDefinitions/named-query-element"
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: named-query-name
21769           in: query
21770           required: false
21771           type: string
21772     put:
21773       tags:
21774         - ServiceDesignAndCreation
21775       summary: create or update an existing named-query-element
21776       description: |
21777         Create or update an existing named-query-element.
21778         #
21779         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21780       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21781       consumes:
21782         - application/json
21783         - application/xml
21784       produces:
21785         - application/json
21786         - application/xml
21787       responses:
21788         "default":
21789           description: Response codes found in [response codes](https://wiki.onap.org/).
21790       parameters:
21791         - name: named-query-uuid
21792           in: path
21793           required: true
21794           type: string
21795           example: __NAMED-QUERY-UUID__
21796         - name: named-query-element-uuid
21797           in: path
21798           required: true
21799           type: string
21800           example: __NAMED-QUERY-ELEMENT-UUID__
21801         - name: body
21802           in: body
21803           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21804           required: true
21805           schema:
21806             $ref: "#/definitions/named-query-element"
21807     patch:
21808       tags:
21809         - ServiceDesignAndCreation
21810       summary: update an existing named-query-element
21811       description: |
21812         Update an existing named-query-element
21813         #
21814         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21815         The PUT operation will entirely replace an existing object.
21816         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21817         #
21818         Other differences between PUT and PATCH are:
21819         #
21820         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21821         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21822         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21823       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21824       consumes:
21825         - application/json
21826         - application/xml
21827       produces:
21828         - application/json
21829         - application/xml
21830       responses:
21831         "default":
21832           description: Response codes found in [response codes](https://wiki.onap.org/).
21833       parameters:
21834         - name: named-query-uuid
21835           in: path
21836           required: true
21837           type: string
21838           example: __NAMED-QUERY-UUID__
21839         - name: named-query-element-uuid
21840           in: path
21841           required: true
21842           type: string
21843           example: __NAMED-QUERY-ELEMENT-UUID__
21844         - name: body
21845           in: body
21846           description: named-query-element object that needs to be created or updated.
21847           required: true
21848           schema:
21849             $ref: "#/patchDefinitions/named-query-element"
21850     delete:
21851       tags:
21852         - ServiceDesignAndCreation
21853       summary: delete an existing named-query-element
21854       description: delete an existing named-query-element
21855       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21856       consumes:
21857         - application/json
21858         - application/xml
21859       produces:
21860         - application/json
21861         - application/xml
21862       responses:
21863         "default":
21864           description: Response codes found in [response codes](https://wiki.onap.org/).
21865       parameters:
21866         - name: named-query-uuid
21867           in: path
21868           required: true
21869           type: string
21870           example: __NAMED-QUERY-UUID__
21871         - name: named-query-element-uuid
21872           in: path
21873           required: true
21874           type: string
21875           example: __NAMED-QUERY-ELEMENT-UUID__
21876         - name: resource-version
21877           in: query
21878           description: resource-version for concurrency
21879           required: true
21880           type: string
21881   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
21882     get:
21883       tags:
21884         - ServiceDesignAndCreation
21885       summary: returns named-query-elements
21886       description: returns named-query-elements
21887       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
21888       produces:
21889         - application/json
21890         - application/xml
21891       responses:
21892         "200":
21893           description: successful operation
21894           schema:
21895               $ref: "#/getDefinitions/named-query-elements"
21896         "default":
21897           description: Response codes found in [response codes](https://wiki.onap.org/).
21898       parameters:
21899         - name: named-query-uuid
21900           in: path
21901           required: true
21902           type: string
21903           example: __NAMED-QUERY-UUID__
21904         - name: named-query-name
21905           in: query
21906           required: false
21907           type: string
21908   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
21909     put:
21910       tags:
21911         - ServiceDesignAndCreation
21912       summary: see node definition for valid relationships
21913       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
21914       consumes:
21915         - application/json
21916         - application/xml
21917       produces:
21918         - application/json
21919         - application/xml
21920       responses:
21921         "default":
21922           description: Response codes found in [response codes](https://wiki.onap.org/).
21923       parameters:
21924         - name: named-query-uuid
21925           in: path
21926           required: true
21927           type: string
21928           example: __NAMED-QUERY-UUID__
21929         - name: body
21930           in: body
21931           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
21932           required: true
21933           schema:
21934             $ref: "#/definitions/relationship"
21935     delete:
21936       tags:
21937         - ServiceDesignAndCreation
21938       summary: delete an existing relationship
21939       description: delete an existing relationship
21940       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
21941       consumes:
21942         - application/json
21943         - application/xml
21944       produces:
21945         - application/json
21946         - application/xml
21947       responses:
21948         "default":
21949           description: Response codes found in [response codes](https://wiki.onap.org/).
21950       parameters:
21951         - name: named-query-uuid
21952           in: path
21953           required: true
21954           type: string
21955           example: __NAMED-QUERY-UUID__
21956   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
21957     get:
21958       tags:
21959         - ServiceDesignAndCreation
21960       summary: returns named-query
21961       description: returns named-query
21962       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
21963       produces:
21964         - application/json
21965         - application/xml
21966       responses:
21967         "200":
21968           description: successful operation
21969           schema:
21970               $ref: "#/getDefinitions/named-query"
21971         "default":
21972           description: Response codes found in [response codes](https://wiki.onap.org/).
21973       parameters:
21974         - name: named-query-uuid
21975           in: path
21976           required: true
21977           type: string
21978           example: __NAMED-QUERY-UUID__
21979         - name: named-query-name
21980           in: query
21981           required: false
21982           type: string
21983     put:
21984       tags:
21985         - ServiceDesignAndCreation
21986       summary: create or update an existing named-query
21987       description: |
21988         Create or update an existing named-query.
21989         #
21990         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21991       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
21992       consumes:
21993         - application/json
21994         - application/xml
21995       produces:
21996         - application/json
21997         - application/xml
21998       responses:
21999         "default":
22000           description: Response codes found in [response codes](https://wiki.onap.org/).
22001       parameters:
22002         - name: named-query-uuid
22003           in: path
22004           required: true
22005           type: string
22006           example: __NAMED-QUERY-UUID__
22007         - name: body
22008           in: body
22009           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
22010           required: true
22011           schema:
22012             $ref: "#/definitions/named-query"
22013     patch:
22014       tags:
22015         - ServiceDesignAndCreation
22016       summary: update an existing named-query
22017       description: |
22018         Update an existing named-query
22019         #
22020         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22021         The PUT operation will entirely replace an existing object.
22022         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22023         #
22024         Other differences between PUT and PATCH are:
22025         #
22026         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22027         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22028         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22029       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
22030       consumes:
22031         - application/json
22032         - application/xml
22033       produces:
22034         - application/json
22035         - application/xml
22036       responses:
22037         "default":
22038           description: Response codes found in [response codes](https://wiki.onap.org/).
22039       parameters:
22040         - name: named-query-uuid
22041           in: path
22042           required: true
22043           type: string
22044           example: __NAMED-QUERY-UUID__
22045         - name: body
22046           in: body
22047           description: named-query object that needs to be created or updated.
22048           required: true
22049           schema:
22050             $ref: "#/patchDefinitions/named-query"
22051     delete:
22052       tags:
22053         - ServiceDesignAndCreation
22054       summary: delete an existing named-query
22055       description: delete an existing named-query
22056       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
22057       consumes:
22058         - application/json
22059         - application/xml
22060       produces:
22061         - application/json
22062         - application/xml
22063       responses:
22064         "default":
22065           description: Response codes found in [response codes](https://wiki.onap.org/).
22066       parameters:
22067         - name: named-query-uuid
22068           in: path
22069           required: true
22070           type: string
22071           example: __NAMED-QUERY-UUID__
22072         - name: resource-version
22073           in: query
22074           description: resource-version for concurrency
22075           required: true
22076           type: string
22077   /service-design-and-creation/named-queries:
22078     get:
22079       tags:
22080         - ServiceDesignAndCreation
22081       summary: returns named-queries
22082       description: returns named-queries
22083       operationId: getServiceDesignAndCreationNamedQueries
22084       produces:
22085         - application/json
22086         - application/xml
22087       responses:
22088         "200":
22089           description: successful operation
22090           schema:
22091               $ref: "#/getDefinitions/named-queries"
22092         "default":
22093           description: Response codes found in [response codes](https://wiki.onap.org/).
22094   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
22095     put:
22096       tags:
22097         - Network
22098       summary: see node definition for valid relationships
22099       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22100       consumes:
22101         - application/json
22102         - application/xml
22103       produces:
22104         - application/json
22105         - application/xml
22106       responses:
22107         "default":
22108           description: Response codes found in [response codes](https://wiki.onap.org/).
22109       parameters:
22110         - name: link-name
22111           in: path
22112           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22113           required: true
22114           type: string
22115           example: __LINK-NAME__
22116         - name: body
22117           in: body
22118           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
22119           required: true
22120           schema:
22121             $ref: "#/definitions/relationship"
22122     delete:
22123       tags:
22124         - Network
22125       summary: delete an existing relationship
22126       description: delete an existing relationship
22127       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22128       consumes:
22129         - application/json
22130         - application/xml
22131       produces:
22132         - application/json
22133         - application/xml
22134       responses:
22135         "default":
22136           description: Response codes found in [response codes](https://wiki.onap.org/).
22137       parameters:
22138         - name: link-name
22139           in: path
22140           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22141           required: true
22142           type: string
22143           example: __LINK-NAME__
22144   /network/logical-links/logical-link/{link-name}:
22145     get:
22146       tags:
22147         - Network
22148       summary: returns logical-link
22149       description: returns logical-link
22150       operationId: getNetworkLogicalLinksLogicalLink
22151       produces:
22152         - application/json
22153         - application/xml
22154       responses:
22155         "200":
22156           description: successful operation
22157           schema:
22158               $ref: "#/getDefinitions/logical-link"
22159         "default":
22160           description: Response codes found in [response codes](https://wiki.onap.org/).
22161       parameters:
22162         - name: link-name
22163           in: path
22164           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22165           required: true
22166           type: string
22167           example: __LINK-NAME__
22168         - name: model-invariant-id
22169           in: query
22170           description: the ASDC model id for this resource or service model.
22171           required: false
22172           type: string
22173         - name: model-version-id
22174           in: query
22175           description: the ASDC model version for this resource or service model.
22176           required: false
22177           type: string
22178         - name: widget-model-id
22179           in: query
22180           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
22181           required: false
22182           type: string
22183         - name: widget-model-version
22184           in: query
22185           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
22186           required: false
22187           type: string
22188         - name: prov-status
22189           in: query
22190           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22191           required: false
22192           type: string
22193         - name: link-id
22194           in: query
22195           description: UUID of the logical-link, SDNC generates this.
22196           required: false
22197           type: string
22198         - name: circuit-id
22199           in: query
22200           description: Circuit id
22201           required: false
22202           type: string
22203         - name: purpose
22204           in: query
22205           description: Reason for this entity, role it is playing
22206           required: false
22207           type: string
22208     put:
22209       tags:
22210         - Network
22211       summary: create or update an existing logical-link
22212       description: |
22213         Create or update an existing logical-link.
22214         #
22215         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22216       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
22217       consumes:
22218         - application/json
22219         - application/xml
22220       produces:
22221         - application/json
22222         - application/xml
22223       responses:
22224         "default":
22225           description: Response codes found in [response codes](https://wiki.onap.org/).
22226       parameters:
22227         - name: link-name
22228           in: path
22229           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22230           required: true
22231           type: string
22232           example: __LINK-NAME__
22233         - name: body
22234           in: body
22235           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
22236           required: true
22237           schema:
22238             $ref: "#/definitions/logical-link"
22239     patch:
22240       tags:
22241         - Network
22242       summary: update an existing logical-link
22243       description: |
22244         Update an existing logical-link
22245         #
22246         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22247         The PUT operation will entirely replace an existing object.
22248         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22249         #
22250         Other differences between PUT and PATCH are:
22251         #
22252         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22253         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22254         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22255       operationId: UpdateNetworkLogicalLinksLogicalLink
22256       consumes:
22257         - application/json
22258         - application/xml
22259       produces:
22260         - application/json
22261         - application/xml
22262       responses:
22263         "default":
22264           description: Response codes found in [response codes](https://wiki.onap.org/).
22265       parameters:
22266         - name: link-name
22267           in: path
22268           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22269           required: true
22270           type: string
22271           example: __LINK-NAME__
22272         - name: body
22273           in: body
22274           description: logical-link object that needs to be created or updated.
22275           required: true
22276           schema:
22277             $ref: "#/patchDefinitions/logical-link"
22278     delete:
22279       tags:
22280         - Network
22281       summary: delete an existing logical-link
22282       description: delete an existing logical-link
22283       operationId: deleteNetworkLogicalLinksLogicalLink
22284       consumes:
22285         - application/json
22286         - application/xml
22287       produces:
22288         - application/json
22289         - application/xml
22290       responses:
22291         "default":
22292           description: Response codes found in [response codes](https://wiki.onap.org/).
22293       parameters:
22294         - name: link-name
22295           in: path
22296           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22297           required: true
22298           type: string
22299           example: __LINK-NAME__
22300         - name: resource-version
22301           in: query
22302           description: resource-version for concurrency
22303           required: true
22304           type: string
22305   /network/logical-links:
22306     get:
22307       tags:
22308         - Network
22309       summary: returns logical-links
22310       description: returns logical-links
22311       operationId: getNetworkLogicalLinks
22312       produces:
22313         - application/json
22314         - application/xml
22315       responses:
22316         "200":
22317           description: successful operation
22318           schema:
22319               $ref: "#/getDefinitions/logical-links"
22320         "default":
22321           description: Response codes found in [response codes](https://wiki.onap.org/).
22322   /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:
22323     put:
22324       tags:
22325         - Network
22326       summary: see node definition for valid relationships
22327       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22328       consumes:
22329         - application/json
22330         - application/xml
22331       produces:
22332         - application/json
22333         - application/xml
22334       responses:
22335         "default":
22336           description: Response codes found in [response codes](https://wiki.onap.org/).
22337       parameters:
22338         - name: site-pair-set-id
22339           in: path
22340           description: Unique id of site pair set.
22341           required: true
22342           type: string
22343           example: __SITE-PAIR-SET-ID__
22344         - name: routing-instance-id
22345           in: path
22346           description: Unique id of routing instance
22347           required: true
22348           type: string
22349           example: __ROUTING-INSTANCE-ID__
22350         - name: site-pair-id
22351           in: path
22352           description: unique identifier of probe
22353           required: true
22354           type: string
22355           example: __SITE-PAIR-ID__
22356         - name: cos
22357           in: path
22358           description: unique identifier of probe
22359           required: true
22360           type: string
22361           example: __COS__
22362         - name: body
22363           in: body
22364           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22365           required: true
22366           schema:
22367             $ref: "#/definitions/relationship"
22368     delete:
22369       tags:
22370         - Network
22371       summary: delete an existing relationship
22372       description: delete an existing relationship
22373       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22374       consumes:
22375         - application/json
22376         - application/xml
22377       produces:
22378         - application/json
22379         - application/xml
22380       responses:
22381         "default":
22382           description: Response codes found in [response codes](https://wiki.onap.org/).
22383       parameters:
22384         - name: site-pair-set-id
22385           in: path
22386           description: Unique id of site pair set.
22387           required: true
22388           type: string
22389           example: __SITE-PAIR-SET-ID__
22390         - name: routing-instance-id
22391           in: path
22392           description: Unique id of routing instance
22393           required: true
22394           type: string
22395           example: __ROUTING-INSTANCE-ID__
22396         - name: site-pair-id
22397           in: path
22398           description: unique identifier of probe
22399           required: true
22400           type: string
22401           example: __SITE-PAIR-ID__
22402         - name: cos
22403           in: path
22404           description: unique identifier of probe
22405           required: true
22406           type: string
22407           example: __COS__
22408   /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}:
22409     get:
22410       tags:
22411         - Network
22412       summary: returns class-of-service
22413       description: returns class-of-service
22414       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22415       produces:
22416         - application/json
22417         - application/xml
22418       responses:
22419         "200":
22420           description: successful operation
22421           schema:
22422               $ref: "#/getDefinitions/class-of-service"
22423         "default":
22424           description: Response codes found in [response codes](https://wiki.onap.org/).
22425       parameters:
22426         - name: site-pair-set-id
22427           in: path
22428           description: Unique id of site pair set.
22429           required: true
22430           type: string
22431           example: __SITE-PAIR-SET-ID__
22432         - name: routing-instance-id
22433           in: path
22434           description: Unique id of routing instance
22435           required: true
22436           type: string
22437           example: __ROUTING-INSTANCE-ID__
22438         - name: site-pair-id
22439           in: path
22440           description: unique identifier of probe
22441           required: true
22442           type: string
22443           example: __SITE-PAIR-ID__
22444         - name: cos
22445           in: path
22446           description: unique identifier of probe
22447           required: true
22448           type: string
22449           example: __COS__
22450     put:
22451       tags:
22452         - Network
22453       summary: create or update an existing class-of-service
22454       description: |
22455         Create or update an existing class-of-service.
22456         #
22457         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22458       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22459       consumes:
22460         - application/json
22461         - application/xml
22462       produces:
22463         - application/json
22464         - application/xml
22465       responses:
22466         "default":
22467           description: Response codes found in [response codes](https://wiki.onap.org/).
22468       parameters:
22469         - name: site-pair-set-id
22470           in: path
22471           description: Unique id of site pair set.
22472           required: true
22473           type: string
22474           example: __SITE-PAIR-SET-ID__
22475         - name: routing-instance-id
22476           in: path
22477           description: Unique id of routing instance
22478           required: true
22479           type: string
22480           example: __ROUTING-INSTANCE-ID__
22481         - name: site-pair-id
22482           in: path
22483           description: unique identifier of probe
22484           required: true
22485           type: string
22486           example: __SITE-PAIR-ID__
22487         - name: cos
22488           in: path
22489           description: unique identifier of probe
22490           required: true
22491           type: string
22492           example: __COS__
22493         - name: body
22494           in: body
22495           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22496           required: true
22497           schema:
22498             $ref: "#/definitions/class-of-service"
22499     patch:
22500       tags:
22501         - Network
22502       summary: update an existing class-of-service
22503       description: |
22504         Update an existing class-of-service
22505         #
22506         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22507         The PUT operation will entirely replace an existing object.
22508         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22509         #
22510         Other differences between PUT and PATCH are:
22511         #
22512         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22513         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22514         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22515       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22516       consumes:
22517         - application/json
22518         - application/xml
22519       produces:
22520         - application/json
22521         - application/xml
22522       responses:
22523         "default":
22524           description: Response codes found in [response codes](https://wiki.onap.org/).
22525       parameters:
22526         - name: site-pair-set-id
22527           in: path
22528           description: Unique id of site pair set.
22529           required: true
22530           type: string
22531           example: __SITE-PAIR-SET-ID__
22532         - name: routing-instance-id
22533           in: path
22534           description: Unique id of routing instance
22535           required: true
22536           type: string
22537           example: __ROUTING-INSTANCE-ID__
22538         - name: site-pair-id
22539           in: path
22540           description: unique identifier of probe
22541           required: true
22542           type: string
22543           example: __SITE-PAIR-ID__
22544         - name: cos
22545           in: path
22546           description: unique identifier of probe
22547           required: true
22548           type: string
22549           example: __COS__
22550         - name: body
22551           in: body
22552           description: class-of-service object that needs to be created or updated.
22553           required: true
22554           schema:
22555             $ref: "#/patchDefinitions/class-of-service"
22556     delete:
22557       tags:
22558         - Network
22559       summary: delete an existing class-of-service
22560       description: delete an existing class-of-service
22561       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22562       consumes:
22563         - application/json
22564         - application/xml
22565       produces:
22566         - application/json
22567         - application/xml
22568       responses:
22569         "default":
22570           description: Response codes found in [response codes](https://wiki.onap.org/).
22571       parameters:
22572         - name: site-pair-set-id
22573           in: path
22574           description: Unique id of site pair set.
22575           required: true
22576           type: string
22577           example: __SITE-PAIR-SET-ID__
22578         - name: routing-instance-id
22579           in: path
22580           description: Unique id of routing instance
22581           required: true
22582           type: string
22583           example: __ROUTING-INSTANCE-ID__
22584         - name: site-pair-id
22585           in: path
22586           description: unique identifier of probe
22587           required: true
22588           type: string
22589           example: __SITE-PAIR-ID__
22590         - name: cos
22591           in: path
22592           description: unique identifier of probe
22593           required: true
22594           type: string
22595           example: __COS__
22596         - name: resource-version
22597           in: query
22598           description: resource-version for concurrency
22599           required: true
22600           type: string
22601   /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:
22602     get:
22603       tags:
22604         - Network
22605       summary: returns classes-of-service
22606       description: returns classes-of-service
22607       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
22608       produces:
22609         - application/json
22610         - application/xml
22611       responses:
22612         "200":
22613           description: successful operation
22614           schema:
22615               $ref: "#/getDefinitions/classes-of-service"
22616         "default":
22617           description: Response codes found in [response codes](https://wiki.onap.org/).
22618       parameters:
22619         - name: site-pair-set-id
22620           in: path
22621           description: Unique id of site pair set.
22622           required: true
22623           type: string
22624           example: __SITE-PAIR-SET-ID__
22625         - name: routing-instance-id
22626           in: path
22627           description: Unique id of routing instance
22628           required: true
22629           type: string
22630           example: __ROUTING-INSTANCE-ID__
22631         - name: site-pair-id
22632           in: path
22633           description: unique identifier of probe
22634           required: true
22635           type: string
22636           example: __SITE-PAIR-ID__
22637   /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:
22638     put:
22639       tags:
22640         - Network
22641       summary: see node definition for valid relationships
22642       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22643       consumes:
22644         - application/json
22645         - application/xml
22646       produces:
22647         - application/json
22648         - application/xml
22649       responses:
22650         "default":
22651           description: Response codes found in [response codes](https://wiki.onap.org/).
22652       parameters:
22653         - name: site-pair-set-id
22654           in: path
22655           description: Unique id of site pair set.
22656           required: true
22657           type: string
22658           example: __SITE-PAIR-SET-ID__
22659         - name: routing-instance-id
22660           in: path
22661           description: Unique id of routing instance
22662           required: true
22663           type: string
22664           example: __ROUTING-INSTANCE-ID__
22665         - name: site-pair-id
22666           in: path
22667           description: unique identifier of probe
22668           required: true
22669           type: string
22670           example: __SITE-PAIR-ID__
22671         - name: body
22672           in: body
22673           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22674           required: true
22675           schema:
22676             $ref: "#/definitions/relationship"
22677     delete:
22678       tags:
22679         - Network
22680       summary: delete an existing relationship
22681       description: delete an existing relationship
22682       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22683       consumes:
22684         - application/json
22685         - application/xml
22686       produces:
22687         - application/json
22688         - application/xml
22689       responses:
22690         "default":
22691           description: Response codes found in [response codes](https://wiki.onap.org/).
22692       parameters:
22693         - name: site-pair-set-id
22694           in: path
22695           description: Unique id of site pair set.
22696           required: true
22697           type: string
22698           example: __SITE-PAIR-SET-ID__
22699         - name: routing-instance-id
22700           in: path
22701           description: Unique id of routing instance
22702           required: true
22703           type: string
22704           example: __ROUTING-INSTANCE-ID__
22705         - name: site-pair-id
22706           in: path
22707           description: unique identifier of probe
22708           required: true
22709           type: string
22710           example: __SITE-PAIR-ID__
22711   /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}:
22712     get:
22713       tags:
22714         - Network
22715       summary: returns site-pair
22716       description: returns site-pair
22717       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22718       produces:
22719         - application/json
22720         - application/xml
22721       responses:
22722         "200":
22723           description: successful operation
22724           schema:
22725               $ref: "#/getDefinitions/site-pair"
22726         "default":
22727           description: Response codes found in [response codes](https://wiki.onap.org/).
22728       parameters:
22729         - name: site-pair-set-id
22730           in: path
22731           description: Unique id of site pair set.
22732           required: true
22733           type: string
22734           example: __SITE-PAIR-SET-ID__
22735         - name: routing-instance-id
22736           in: path
22737           description: Unique id of routing instance
22738           required: true
22739           type: string
22740           example: __ROUTING-INSTANCE-ID__
22741         - name: site-pair-id
22742           in: path
22743           description: unique identifier of probe
22744           required: true
22745           type: string
22746           example: __SITE-PAIR-ID__
22747     put:
22748       tags:
22749         - Network
22750       summary: create or update an existing site-pair
22751       description: |
22752         Create or update an existing site-pair.
22753         #
22754         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22755       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22756       consumes:
22757         - application/json
22758         - application/xml
22759       produces:
22760         - application/json
22761         - application/xml
22762       responses:
22763         "default":
22764           description: Response codes found in [response codes](https://wiki.onap.org/).
22765       parameters:
22766         - name: site-pair-set-id
22767           in: path
22768           description: Unique id of site pair set.
22769           required: true
22770           type: string
22771           example: __SITE-PAIR-SET-ID__
22772         - name: routing-instance-id
22773           in: path
22774           description: Unique id of routing instance
22775           required: true
22776           type: string
22777           example: __ROUTING-INSTANCE-ID__
22778         - name: site-pair-id
22779           in: path
22780           description: unique identifier of probe
22781           required: true
22782           type: string
22783           example: __SITE-PAIR-ID__
22784         - name: body
22785           in: body
22786           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22787           required: true
22788           schema:
22789             $ref: "#/definitions/site-pair"
22790     patch:
22791       tags:
22792         - Network
22793       summary: update an existing site-pair
22794       description: |
22795         Update an existing site-pair
22796         #
22797         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22798         The PUT operation will entirely replace an existing object.
22799         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22800         #
22801         Other differences between PUT and PATCH are:
22802         #
22803         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22804         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22805         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22806       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22807       consumes:
22808         - application/json
22809         - application/xml
22810       produces:
22811         - application/json
22812         - application/xml
22813       responses:
22814         "default":
22815           description: Response codes found in [response codes](https://wiki.onap.org/).
22816       parameters:
22817         - name: site-pair-set-id
22818           in: path
22819           description: Unique id of site pair set.
22820           required: true
22821           type: string
22822           example: __SITE-PAIR-SET-ID__
22823         - name: routing-instance-id
22824           in: path
22825           description: Unique id of routing instance
22826           required: true
22827           type: string
22828           example: __ROUTING-INSTANCE-ID__
22829         - name: site-pair-id
22830           in: path
22831           description: unique identifier of probe
22832           required: true
22833           type: string
22834           example: __SITE-PAIR-ID__
22835         - name: body
22836           in: body
22837           description: site-pair object that needs to be created or updated.
22838           required: true
22839           schema:
22840             $ref: "#/patchDefinitions/site-pair"
22841     delete:
22842       tags:
22843         - Network
22844       summary: delete an existing site-pair
22845       description: delete an existing site-pair
22846       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22847       consumes:
22848         - application/json
22849         - application/xml
22850       produces:
22851         - application/json
22852         - application/xml
22853       responses:
22854         "default":
22855           description: Response codes found in [response codes](https://wiki.onap.org/).
22856       parameters:
22857         - name: site-pair-set-id
22858           in: path
22859           description: Unique id of site pair set.
22860           required: true
22861           type: string
22862           example: __SITE-PAIR-SET-ID__
22863         - name: routing-instance-id
22864           in: path
22865           description: Unique id of routing instance
22866           required: true
22867           type: string
22868           example: __ROUTING-INSTANCE-ID__
22869         - name: site-pair-id
22870           in: path
22871           description: unique identifier of probe
22872           required: true
22873           type: string
22874           example: __SITE-PAIR-ID__
22875         - name: resource-version
22876           in: query
22877           description: resource-version for concurrency
22878           required: true
22879           type: string
22880   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
22881     get:
22882       tags:
22883         - Network
22884       summary: returns site-pairs
22885       description: returns site-pairs
22886       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
22887       produces:
22888         - application/json
22889         - application/xml
22890       responses:
22891         "200":
22892           description: successful operation
22893           schema:
22894               $ref: "#/getDefinitions/site-pairs"
22895         "default":
22896           description: Response codes found in [response codes](https://wiki.onap.org/).
22897       parameters:
22898         - name: site-pair-set-id
22899           in: path
22900           description: Unique id of site pair set.
22901           required: true
22902           type: string
22903           example: __SITE-PAIR-SET-ID__
22904         - name: routing-instance-id
22905           in: path
22906           description: Unique id of routing instance
22907           required: true
22908           type: string
22909           example: __ROUTING-INSTANCE-ID__
22910   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
22911     put:
22912       tags:
22913         - Network
22914       summary: see node definition for valid relationships
22915       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
22916       consumes:
22917         - application/json
22918         - application/xml
22919       produces:
22920         - application/json
22921         - application/xml
22922       responses:
22923         "default":
22924           description: Response codes found in [response codes](https://wiki.onap.org/).
22925       parameters:
22926         - name: site-pair-set-id
22927           in: path
22928           description: Unique id of site pair set.
22929           required: true
22930           type: string
22931           example: __SITE-PAIR-SET-ID__
22932         - name: routing-instance-id
22933           in: path
22934           description: Unique id of routing instance
22935           required: true
22936           type: string
22937           example: __ROUTING-INSTANCE-ID__
22938         - name: body
22939           in: body
22940           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
22941           required: true
22942           schema:
22943             $ref: "#/definitions/relationship"
22944     delete:
22945       tags:
22946         - Network
22947       summary: delete an existing relationship
22948       description: delete an existing relationship
22949       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
22950       consumes:
22951         - application/json
22952         - application/xml
22953       produces:
22954         - application/json
22955         - application/xml
22956       responses:
22957         "default":
22958           description: Response codes found in [response codes](https://wiki.onap.org/).
22959       parameters:
22960         - name: site-pair-set-id
22961           in: path
22962           description: Unique id of site pair set.
22963           required: true
22964           type: string
22965           example: __SITE-PAIR-SET-ID__
22966         - name: routing-instance-id
22967           in: path
22968           description: Unique id of routing instance
22969           required: true
22970           type: string
22971           example: __ROUTING-INSTANCE-ID__
22972   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
22973     get:
22974       tags:
22975         - Network
22976       summary: returns routing-instance
22977       description: returns routing-instance
22978       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22979       produces:
22980         - application/json
22981         - application/xml
22982       responses:
22983         "200":
22984           description: successful operation
22985           schema:
22986               $ref: "#/getDefinitions/routing-instance"
22987         "default":
22988           description: Response codes found in [response codes](https://wiki.onap.org/).
22989       parameters:
22990         - name: site-pair-set-id
22991           in: path
22992           description: Unique id of site pair set.
22993           required: true
22994           type: string
22995           example: __SITE-PAIR-SET-ID__
22996         - name: routing-instance-id
22997           in: path
22998           description: Unique id of routing instance
22999           required: true
23000           type: string
23001           example: __ROUTING-INSTANCE-ID__
23002     put:
23003       tags:
23004         - Network
23005       summary: create or update an existing routing-instance
23006       description: |
23007         Create or update an existing routing-instance.
23008         #
23009         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23010       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23011       consumes:
23012         - application/json
23013         - application/xml
23014       produces:
23015         - application/json
23016         - application/xml
23017       responses:
23018         "default":
23019           description: Response codes found in [response codes](https://wiki.onap.org/).
23020       parameters:
23021         - name: site-pair-set-id
23022           in: path
23023           description: Unique id of site pair set.
23024           required: true
23025           type: string
23026           example: __SITE-PAIR-SET-ID__
23027         - name: routing-instance-id
23028           in: path
23029           description: Unique id of routing instance
23030           required: true
23031           type: string
23032           example: __ROUTING-INSTANCE-ID__
23033         - name: body
23034           in: body
23035           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23036           required: true
23037           schema:
23038             $ref: "#/definitions/routing-instance"
23039     patch:
23040       tags:
23041         - Network
23042       summary: update an existing routing-instance
23043       description: |
23044         Update an existing routing-instance
23045         #
23046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23047         The PUT operation will entirely replace an existing object.
23048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23049         #
23050         Other differences between PUT and PATCH are:
23051         #
23052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23055       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23056       consumes:
23057         - application/json
23058         - application/xml
23059       produces:
23060         - application/json
23061         - application/xml
23062       responses:
23063         "default":
23064           description: Response codes found in [response codes](https://wiki.onap.org/).
23065       parameters:
23066         - name: site-pair-set-id
23067           in: path
23068           description: Unique id of site pair set.
23069           required: true
23070           type: string
23071           example: __SITE-PAIR-SET-ID__
23072         - name: routing-instance-id
23073           in: path
23074           description: Unique id of routing instance
23075           required: true
23076           type: string
23077           example: __ROUTING-INSTANCE-ID__
23078         - name: body
23079           in: body
23080           description: routing-instance object that needs to be created or updated.
23081           required: true
23082           schema:
23083             $ref: "#/patchDefinitions/routing-instance"
23084     delete:
23085       tags:
23086         - Network
23087       summary: delete an existing routing-instance
23088       description: delete an existing routing-instance
23089       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23090       consumes:
23091         - application/json
23092         - application/xml
23093       produces:
23094         - application/json
23095         - application/xml
23096       responses:
23097         "default":
23098           description: Response codes found in [response codes](https://wiki.onap.org/).
23099       parameters:
23100         - name: site-pair-set-id
23101           in: path
23102           description: Unique id of site pair set.
23103           required: true
23104           type: string
23105           example: __SITE-PAIR-SET-ID__
23106         - name: routing-instance-id
23107           in: path
23108           description: Unique id of routing instance
23109           required: true
23110           type: string
23111           example: __ROUTING-INSTANCE-ID__
23112         - name: resource-version
23113           in: query
23114           description: resource-version for concurrency
23115           required: true
23116           type: string
23117   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
23118     get:
23119       tags:
23120         - Network
23121       summary: returns routing-instances
23122       description: returns routing-instances
23123       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
23124       produces:
23125         - application/json
23126         - application/xml
23127       responses:
23128         "200":
23129           description: successful operation
23130           schema:
23131               $ref: "#/getDefinitions/routing-instances"
23132         "default":
23133           description: Response codes found in [response codes](https://wiki.onap.org/).
23134       parameters:
23135         - name: site-pair-set-id
23136           in: path
23137           description: Unique id of site pair set.
23138           required: true
23139           type: string
23140           example: __SITE-PAIR-SET-ID__
23141   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
23142     put:
23143       tags:
23144         - Network
23145       summary: see node definition for valid relationships
23146       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
23147       consumes:
23148         - application/json
23149         - application/xml
23150       produces:
23151         - application/json
23152         - application/xml
23153       responses:
23154         "default":
23155           description: Response codes found in [response codes](https://wiki.onap.org/).
23156       parameters:
23157         - name: site-pair-set-id
23158           in: path
23159           description: Unique id of site pair set.
23160           required: true
23161           type: string
23162           example: __SITE-PAIR-SET-ID__
23163         - name: body
23164           in: body
23165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
23166           required: true
23167           schema:
23168             $ref: "#/definitions/relationship"
23169     delete:
23170       tags:
23171         - Network
23172       summary: delete an existing relationship
23173       description: delete an existing relationship
23174       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
23175       consumes:
23176         - application/json
23177         - application/xml
23178       produces:
23179         - application/json
23180         - application/xml
23181       responses:
23182         "default":
23183           description: Response codes found in [response codes](https://wiki.onap.org/).
23184       parameters:
23185         - name: site-pair-set-id
23186           in: path
23187           description: Unique id of site pair set.
23188           required: true
23189           type: string
23190           example: __SITE-PAIR-SET-ID__
23191   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
23192     get:
23193       tags:
23194         - Network
23195       summary: returns site-pair-set
23196       description: returns site-pair-set
23197       operationId: getNetworkSitePairSetsSitePairSet
23198       produces:
23199         - application/json
23200         - application/xml
23201       responses:
23202         "200":
23203           description: successful operation
23204           schema:
23205               $ref: "#/getDefinitions/site-pair-set"
23206         "default":
23207           description: Response codes found in [response codes](https://wiki.onap.org/).
23208       parameters:
23209         - name: site-pair-set-id
23210           in: path
23211           description: Unique id of site pair set.
23212           required: true
23213           type: string
23214           example: __SITE-PAIR-SET-ID__
23215     put:
23216       tags:
23217         - Network
23218       summary: create or update an existing site-pair-set
23219       description: |
23220         Create or update an existing site-pair-set.
23221         #
23222         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23223       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
23224       consumes:
23225         - application/json
23226         - application/xml
23227       produces:
23228         - application/json
23229         - application/xml
23230       responses:
23231         "default":
23232           description: Response codes found in [response codes](https://wiki.onap.org/).
23233       parameters:
23234         - name: site-pair-set-id
23235           in: path
23236           description: Unique id of site pair set.
23237           required: true
23238           type: string
23239           example: __SITE-PAIR-SET-ID__
23240         - name: body
23241           in: body
23242           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
23243           required: true
23244           schema:
23245             $ref: "#/definitions/site-pair-set"
23246     patch:
23247       tags:
23248         - Network
23249       summary: update an existing site-pair-set
23250       description: |
23251         Update an existing site-pair-set
23252         #
23253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23254         The PUT operation will entirely replace an existing object.
23255         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23256         #
23257         Other differences between PUT and PATCH are:
23258         #
23259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23262       operationId: UpdateNetworkSitePairSetsSitePairSet
23263       consumes:
23264         - application/json
23265         - application/xml
23266       produces:
23267         - application/json
23268         - application/xml
23269       responses:
23270         "default":
23271           description: Response codes found in [response codes](https://wiki.onap.org/).
23272       parameters:
23273         - name: site-pair-set-id
23274           in: path
23275           description: Unique id of site pair set.
23276           required: true
23277           type: string
23278           example: __SITE-PAIR-SET-ID__
23279         - name: body
23280           in: body
23281           description: site-pair-set object that needs to be created or updated.
23282           required: true
23283           schema:
23284             $ref: "#/patchDefinitions/site-pair-set"
23285     delete:
23286       tags:
23287         - Network
23288       summary: delete an existing site-pair-set
23289       description: delete an existing site-pair-set
23290       operationId: deleteNetworkSitePairSetsSitePairSet
23291       consumes:
23292         - application/json
23293         - application/xml
23294       produces:
23295         - application/json
23296         - application/xml
23297       responses:
23298         "default":
23299           description: Response codes found in [response codes](https://wiki.onap.org/).
23300       parameters:
23301         - name: site-pair-set-id
23302           in: path
23303           description: Unique id of site pair set.
23304           required: true
23305           type: string
23306           example: __SITE-PAIR-SET-ID__
23307         - name: resource-version
23308           in: query
23309           description: resource-version for concurrency
23310           required: true
23311           type: string
23312   /network/site-pair-sets:
23313     get:
23314       tags:
23315         - Network
23316       summary: returns site-pair-sets
23317       description: returns site-pair-sets
23318       operationId: getNetworkSitePairSets
23319       produces:
23320         - application/json
23321         - application/xml
23322       responses:
23323         "200":
23324           description: successful operation
23325           schema:
23326               $ref: "#/getDefinitions/site-pair-sets"
23327         "default":
23328           description: Response codes found in [response codes](https://wiki.onap.org/).
23329   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
23330     put:
23331       tags:
23332         - Network
23333       summary: see node definition for valid relationships
23334       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23335       consumes:
23336         - application/json
23337         - application/xml
23338       produces:
23339         - application/json
23340         - application/xml
23341       responses:
23342         "default":
23343           description: Response codes found in [response codes](https://wiki.onap.org/).
23344       parameters:
23345         - name: vpn-id
23346           in: path
23347           description: VPN ID, globally unique within A&AI
23348           required: true
23349           type: string
23350           example: __VPN-ID__
23351         - name: global-route-target
23352           in: path
23353           description: Number used to identify an RT, globally unique in the network
23354           required: true
23355           type: string
23356           example: __GLOBAL-ROUTE-TARGET__
23357         - name: route-target-role
23358           in: path
23359           description: Role assigned to this route target
23360           required: true
23361           type: string
23362           example: __ROUTE-TARGET-ROLE__
23363         - name: body
23364           in: body
23365           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23366           required: true
23367           schema:
23368             $ref: "#/definitions/relationship"
23369     delete:
23370       tags:
23371         - Network
23372       summary: delete an existing relationship
23373       description: delete an existing relationship
23374       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23375       consumes:
23376         - application/json
23377         - application/xml
23378       produces:
23379         - application/json
23380         - application/xml
23381       responses:
23382         "default":
23383           description: Response codes found in [response codes](https://wiki.onap.org/).
23384       parameters:
23385         - name: vpn-id
23386           in: path
23387           description: VPN ID, globally unique within A&AI
23388           required: true
23389           type: string
23390           example: __VPN-ID__
23391         - name: global-route-target
23392           in: path
23393           description: Number used to identify an RT, globally unique in the network
23394           required: true
23395           type: string
23396           example: __GLOBAL-ROUTE-TARGET__
23397         - name: route-target-role
23398           in: path
23399           description: Role assigned to this route target
23400           required: true
23401           type: string
23402           example: __ROUTE-TARGET-ROLE__
23403   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
23404     get:
23405       tags:
23406         - Network
23407       summary: returns route-target
23408       description: returns route-target
23409       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23410       produces:
23411         - application/json
23412         - application/xml
23413       responses:
23414         "200":
23415           description: successful operation
23416           schema:
23417               $ref: "#/getDefinitions/route-target"
23418         "default":
23419           description: Response codes found in [response codes](https://wiki.onap.org/).
23420       parameters:
23421         - name: vpn-id
23422           in: path
23423           description: VPN ID, globally unique within A&AI
23424           required: true
23425           type: string
23426           example: __VPN-ID__
23427         - name: global-route-target
23428           in: path
23429           description: Number used to identify an RT, globally unique in the network
23430           required: true
23431           type: string
23432           example: __GLOBAL-ROUTE-TARGET__
23433         - name: route-target-role
23434           in: path
23435           description: Role assigned to this route target
23436           required: true
23437           type: string
23438           example: __ROUTE-TARGET-ROLE__
23439         - name: vpn-name
23440           in: query
23441           description: VPN Name
23442           required: false
23443           type: string
23444         - name: vpn-type
23445           in: query
23446           description: Type of the vpn, should be taken from enumerated/valid values
23447           required: false
23448           type: string
23449     put:
23450       tags:
23451         - Network
23452       summary: create or update an existing route-target
23453       description: |
23454         Create or update an existing route-target.
23455         #
23456         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23457       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23458       consumes:
23459         - application/json
23460         - application/xml
23461       produces:
23462         - application/json
23463         - application/xml
23464       responses:
23465         "default":
23466           description: Response codes found in [response codes](https://wiki.onap.org/).
23467       parameters:
23468         - name: vpn-id
23469           in: path
23470           description: VPN ID, globally unique within A&AI
23471           required: true
23472           type: string
23473           example: __VPN-ID__
23474         - name: global-route-target
23475           in: path
23476           description: Number used to identify an RT, globally unique in the network
23477           required: true
23478           type: string
23479           example: __GLOBAL-ROUTE-TARGET__
23480         - name: route-target-role
23481           in: path
23482           description: Role assigned to this route target
23483           required: true
23484           type: string
23485           example: __ROUTE-TARGET-ROLE__
23486         - name: body
23487           in: body
23488           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23489           required: true
23490           schema:
23491             $ref: "#/definitions/route-target"
23492     patch:
23493       tags:
23494         - Network
23495       summary: update an existing route-target
23496       description: |
23497         Update an existing route-target
23498         #
23499         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23500         The PUT operation will entirely replace an existing object.
23501         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23502         #
23503         Other differences between PUT and PATCH are:
23504         #
23505         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23506         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23507         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23508       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23509       consumes:
23510         - application/json
23511         - application/xml
23512       produces:
23513         - application/json
23514         - application/xml
23515       responses:
23516         "default":
23517           description: Response codes found in [response codes](https://wiki.onap.org/).
23518       parameters:
23519         - name: vpn-id
23520           in: path
23521           description: VPN ID, globally unique within A&AI
23522           required: true
23523           type: string
23524           example: __VPN-ID__
23525         - name: global-route-target
23526           in: path
23527           description: Number used to identify an RT, globally unique in the network
23528           required: true
23529           type: string
23530           example: __GLOBAL-ROUTE-TARGET__
23531         - name: route-target-role
23532           in: path
23533           description: Role assigned to this route target
23534           required: true
23535           type: string
23536           example: __ROUTE-TARGET-ROLE__
23537         - name: body
23538           in: body
23539           description: route-target object that needs to be created or updated.
23540           required: true
23541           schema:
23542             $ref: "#/patchDefinitions/route-target"
23543     delete:
23544       tags:
23545         - Network
23546       summary: delete an existing route-target
23547       description: delete an existing route-target
23548       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23549       consumes:
23550         - application/json
23551         - application/xml
23552       produces:
23553         - application/json
23554         - application/xml
23555       responses:
23556         "default":
23557           description: Response codes found in [response codes](https://wiki.onap.org/).
23558       parameters:
23559         - name: vpn-id
23560           in: path
23561           description: VPN ID, globally unique within A&AI
23562           required: true
23563           type: string
23564           example: __VPN-ID__
23565         - name: global-route-target
23566           in: path
23567           description: Number used to identify an RT, globally unique in the network
23568           required: true
23569           type: string
23570           example: __GLOBAL-ROUTE-TARGET__
23571         - name: route-target-role
23572           in: path
23573           description: Role assigned to this route target
23574           required: true
23575           type: string
23576           example: __ROUTE-TARGET-ROLE__
23577         - name: resource-version
23578           in: query
23579           description: resource-version for concurrency
23580           required: true
23581           type: string
23582   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
23583     get:
23584       tags:
23585         - Network
23586       summary: returns route-targets
23587       description: returns route-targets
23588       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
23589       produces:
23590         - application/json
23591         - application/xml
23592       responses:
23593         "200":
23594           description: successful operation
23595           schema:
23596               $ref: "#/getDefinitions/route-targets"
23597         "default":
23598           description: Response codes found in [response codes](https://wiki.onap.org/).
23599       parameters:
23600         - name: vpn-id
23601           in: path
23602           description: VPN ID, globally unique within A&AI
23603           required: true
23604           type: string
23605           example: __VPN-ID__
23606         - name: vpn-name
23607           in: query
23608           description: VPN Name
23609           required: false
23610           type: string
23611         - name: vpn-type
23612           in: query
23613           description: Type of the vpn, should be taken from enumerated/valid values
23614           required: false
23615           type: string
23616   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
23617     put:
23618       tags:
23619         - Network
23620       summary: see node definition for valid relationships
23621       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
23622       consumes:
23623         - application/json
23624         - application/xml
23625       produces:
23626         - application/json
23627         - application/xml
23628       responses:
23629         "default":
23630           description: Response codes found in [response codes](https://wiki.onap.org/).
23631       parameters:
23632         - name: vpn-id
23633           in: path
23634           description: VPN ID, globally unique within A&AI
23635           required: true
23636           type: string
23637           example: __VPN-ID__
23638         - name: body
23639           in: body
23640           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
23641           required: true
23642           schema:
23643             $ref: "#/definitions/relationship"
23644     delete:
23645       tags:
23646         - Network
23647       summary: delete an existing relationship
23648       description: delete an existing relationship
23649       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
23650       consumes:
23651         - application/json
23652         - application/xml
23653       produces:
23654         - application/json
23655         - application/xml
23656       responses:
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   /network/vpn-bindings/vpn-binding/{vpn-id}:
23667     get:
23668       tags:
23669         - Network
23670       summary: returns vpn-binding
23671       description: returns vpn-binding
23672       operationId: getNetworkVpnBindingsVpnBinding
23673       produces:
23674         - application/json
23675         - application/xml
23676       responses:
23677         "200":
23678           description: successful operation
23679           schema:
23680               $ref: "#/getDefinitions/vpn-binding"
23681         "default":
23682           description: Response codes found in [response codes](https://wiki.onap.org/).
23683       parameters:
23684         - name: vpn-id
23685           in: path
23686           description: VPN ID, globally unique within A&AI
23687           required: true
23688           type: string
23689           example: __VPN-ID__
23690         - name: vpn-name
23691           in: query
23692           description: VPN Name
23693           required: false
23694           type: string
23695         - name: vpn-type
23696           in: query
23697           description: Type of the vpn, should be taken from enumerated/valid values
23698           required: false
23699           type: string
23700     put:
23701       tags:
23702         - Network
23703       summary: create or update an existing vpn-binding
23704       description: |
23705         Create or update an existing vpn-binding.
23706         #
23707         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23708       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
23709       consumes:
23710         - application/json
23711         - application/xml
23712       produces:
23713         - application/json
23714         - application/xml
23715       responses:
23716         "default":
23717           description: Response codes found in [response codes](https://wiki.onap.org/).
23718       parameters:
23719         - name: vpn-id
23720           in: path
23721           description: VPN ID, globally unique within A&AI
23722           required: true
23723           type: string
23724           example: __VPN-ID__
23725         - name: body
23726           in: body
23727           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
23728           required: true
23729           schema:
23730             $ref: "#/definitions/vpn-binding"
23731     patch:
23732       tags:
23733         - Network
23734       summary: update an existing vpn-binding
23735       description: |
23736         Update an existing vpn-binding
23737         #
23738         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23739         The PUT operation will entirely replace an existing object.
23740         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23741         #
23742         Other differences between PUT and PATCH are:
23743         #
23744         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23745         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23746         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23747       operationId: UpdateNetworkVpnBindingsVpnBinding
23748       consumes:
23749         - application/json
23750         - application/xml
23751       produces:
23752         - application/json
23753         - application/xml
23754       responses:
23755         "default":
23756           description: Response codes found in [response codes](https://wiki.onap.org/).
23757       parameters:
23758         - name: vpn-id
23759           in: path
23760           description: VPN ID, globally unique within A&AI
23761           required: true
23762           type: string
23763           example: __VPN-ID__
23764         - name: body
23765           in: body
23766           description: vpn-binding object that needs to be created or updated.
23767           required: true
23768           schema:
23769             $ref: "#/patchDefinitions/vpn-binding"
23770     delete:
23771       tags:
23772         - Network
23773       summary: delete an existing vpn-binding
23774       description: delete an existing vpn-binding
23775       operationId: deleteNetworkVpnBindingsVpnBinding
23776       consumes:
23777         - application/json
23778         - application/xml
23779       produces:
23780         - application/json
23781         - application/xml
23782       responses:
23783         "default":
23784           description: Response codes found in [response codes](https://wiki.onap.org/).
23785       parameters:
23786         - name: vpn-id
23787           in: path
23788           description: VPN ID, globally unique within A&AI
23789           required: true
23790           type: string
23791           example: __VPN-ID__
23792         - name: resource-version
23793           in: query
23794           description: resource-version for concurrency
23795           required: true
23796           type: string
23797   /network/vpn-bindings:
23798     get:
23799       tags:
23800         - Network
23801       summary: returns vpn-bindings
23802       description: returns vpn-bindings
23803       operationId: getNetworkVpnBindings
23804       produces:
23805         - application/json
23806         - application/xml
23807       responses:
23808         "200":
23809           description: successful operation
23810           schema:
23811               $ref: "#/getDefinitions/vpn-bindings"
23812         "default":
23813           description: Response codes found in [response codes](https://wiki.onap.org/).
23814   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
23815     put:
23816       tags:
23817         - Network
23818       summary: see node definition for valid relationships
23819       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
23820       consumes:
23821         - application/json
23822         - application/xml
23823       produces:
23824         - application/json
23825         - application/xml
23826       responses:
23827         "default":
23828           description: Response codes found in [response codes](https://wiki.onap.org/).
23829       parameters:
23830         - name: equipment-name
23831           in: path
23832           required: true
23833           type: string
23834           example: __EQUIPMENT-NAME__
23835         - name: body
23836           in: body
23837           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
23838           required: true
23839           schema:
23840             $ref: "#/definitions/relationship"
23841     delete:
23842       tags:
23843         - Network
23844       summary: delete an existing relationship
23845       description: delete an existing relationship
23846       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
23847       consumes:
23848         - application/json
23849         - application/xml
23850       produces:
23851         - application/json
23852         - application/xml
23853       responses:
23854         "default":
23855           description: Response codes found in [response codes](https://wiki.onap.org/).
23856       parameters:
23857         - name: equipment-name
23858           in: path
23859           required: true
23860           type: string
23861           example: __EQUIPMENT-NAME__
23862   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
23863     put:
23864       tags:
23865         - Network
23866       summary: see node definition for valid relationships
23867       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23868       consumes:
23869         - application/json
23870         - application/xml
23871       produces:
23872         - application/json
23873         - application/xml
23874       responses:
23875         "default":
23876           description: Response codes found in [response codes](https://wiki.onap.org/).
23877       parameters:
23878         - name: equipment-name
23879           in: path
23880           required: true
23881           type: string
23882           example: __EQUIPMENT-NAME__
23883         - name: interface-name
23884           in: path
23885           description: Name that identifies the physical interface
23886           required: true
23887           type: string
23888           example: __INTERFACE-NAME__
23889         - name: body
23890           in: body
23891           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
23892           required: true
23893           schema:
23894             $ref: "#/definitions/relationship"
23895     delete:
23896       tags:
23897         - Network
23898       summary: delete an existing relationship
23899       description: delete an existing relationship
23900       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23901       consumes:
23902         - application/json
23903         - application/xml
23904       produces:
23905         - application/json
23906         - application/xml
23907       responses:
23908         "default":
23909           description: Response codes found in [response codes](https://wiki.onap.org/).
23910       parameters:
23911         - name: equipment-name
23912           in: path
23913           required: true
23914           type: string
23915           example: __EQUIPMENT-NAME__
23916         - name: interface-name
23917           in: path
23918           description: Name that identifies the physical interface
23919           required: true
23920           type: string
23921           example: __INTERFACE-NAME__
23922   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
23923     put:
23924       tags:
23925         - Network
23926       summary: see node definition for valid relationships
23927       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
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: pf-pci-id
23950           in: path
23951           description: Identifier for the sriov-pf
23952           required: true
23953           type: string
23954           example: __PF-PCI-ID__
23955         - name: body
23956           in: body
23957           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
23958           required: true
23959           schema:
23960             $ref: "#/definitions/relationship"
23961     delete:
23962       tags:
23963         - Network
23964       summary: delete an existing relationship
23965       description: delete an existing relationship
23966       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
23967       consumes:
23968         - application/json
23969         - application/xml
23970       produces:
23971         - application/json
23972         - application/xml
23973       responses:
23974         "default":
23975           description: Response codes found in [response codes](https://wiki.onap.org/).
23976       parameters:
23977         - name: equipment-name
23978           in: path
23979           required: true
23980           type: string
23981           example: __EQUIPMENT-NAME__
23982         - name: interface-name
23983           in: path
23984           description: Name that identifies the physical interface
23985           required: true
23986           type: string
23987           example: __INTERFACE-NAME__
23988         - name: pf-pci-id
23989           in: path
23990           description: Identifier for the sriov-pf
23991           required: true
23992           type: string
23993           example: __PF-PCI-ID__
23994   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
23995     get:
23996       tags:
23997         - Network
23998       summary: returns sriov-pf
23999       description: returns sriov-pf
24000       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24001       produces:
24002         - application/json
24003         - application/xml
24004       responses:
24005         "200":
24006           description: successful operation
24007           schema:
24008               $ref: "#/getDefinitions/sriov-pf"
24009         "default":
24010           description: Response codes found in [response codes](https://wiki.onap.org/).
24011       parameters:
24012         - name: equipment-name
24013           in: path
24014           required: true
24015           type: string
24016           example: __EQUIPMENT-NAME__
24017         - name: interface-name
24018           in: path
24019           description: Name that identifies the physical interface
24020           required: true
24021           type: string
24022           example: __INTERFACE-NAME__
24023         - name: pf-pci-id
24024           in: path
24025           description: Identifier for the sriov-pf
24026           required: true
24027           type: string
24028           example: __PF-PCI-ID__
24029         - name: prov-status
24030           in: query
24031           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24032           required: false
24033           type: string
24034         - name: prov-status
24035           in: query
24036           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24037           required: false
24038           type: string
24039     put:
24040       tags:
24041         - Network
24042       summary: create or update an existing sriov-pf
24043       description: |
24044         Create or update an existing sriov-pf.
24045         #
24046         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24047       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24048       consumes:
24049         - application/json
24050         - application/xml
24051       produces:
24052         - application/json
24053         - application/xml
24054       responses:
24055         "default":
24056           description: Response codes found in [response codes](https://wiki.onap.org/).
24057       parameters:
24058         - name: equipment-name
24059           in: path
24060           required: true
24061           type: string
24062           example: __EQUIPMENT-NAME__
24063         - name: interface-name
24064           in: path
24065           description: Name that identifies the physical interface
24066           required: true
24067           type: string
24068           example: __INTERFACE-NAME__
24069         - name: pf-pci-id
24070           in: path
24071           description: Identifier for the sriov-pf
24072           required: true
24073           type: string
24074           example: __PF-PCI-ID__
24075         - name: body
24076           in: body
24077           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24078           required: true
24079           schema:
24080             $ref: "#/definitions/sriov-pf"
24081     patch:
24082       tags:
24083         - Network
24084       summary: update an existing sriov-pf
24085       description: |
24086         Update an existing sriov-pf
24087         #
24088         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24089         The PUT operation will entirely replace an existing object.
24090         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24091         #
24092         Other differences between PUT and PATCH are:
24093         #
24094         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24095         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24096         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24097       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24098       consumes:
24099         - application/json
24100         - application/xml
24101       produces:
24102         - application/json
24103         - application/xml
24104       responses:
24105         "default":
24106           description: Response codes found in [response codes](https://wiki.onap.org/).
24107       parameters:
24108         - name: equipment-name
24109           in: path
24110           required: true
24111           type: string
24112           example: __EQUIPMENT-NAME__
24113         - name: interface-name
24114           in: path
24115           description: Name that identifies the physical interface
24116           required: true
24117           type: string
24118           example: __INTERFACE-NAME__
24119         - name: pf-pci-id
24120           in: path
24121           description: Identifier for the sriov-pf
24122           required: true
24123           type: string
24124           example: __PF-PCI-ID__
24125         - name: body
24126           in: body
24127           description: sriov-pf object that needs to be created or updated.
24128           required: true
24129           schema:
24130             $ref: "#/patchDefinitions/sriov-pf"
24131     delete:
24132       tags:
24133         - Network
24134       summary: delete an existing sriov-pf
24135       description: delete an existing sriov-pf
24136       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24137       consumes:
24138         - application/json
24139         - application/xml
24140       produces:
24141         - application/json
24142         - application/xml
24143       responses:
24144         "default":
24145           description: Response codes found in [response codes](https://wiki.onap.org/).
24146       parameters:
24147         - name: equipment-name
24148           in: path
24149           required: true
24150           type: string
24151           example: __EQUIPMENT-NAME__
24152         - name: interface-name
24153           in: path
24154           description: Name that identifies the physical interface
24155           required: true
24156           type: string
24157           example: __INTERFACE-NAME__
24158         - name: pf-pci-id
24159           in: path
24160           description: Identifier for the sriov-pf
24161           required: true
24162           type: string
24163           example: __PF-PCI-ID__
24164         - name: resource-version
24165           in: query
24166           description: resource-version for concurrency
24167           required: true
24168           type: string
24169   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
24170     get:
24171       tags:
24172         - Network
24173       summary: returns sriov-pfs
24174       description: returns sriov-pfs
24175       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
24176       produces:
24177         - application/json
24178         - application/xml
24179       responses:
24180         "200":
24181           description: successful operation
24182           schema:
24183               $ref: "#/getDefinitions/sriov-pfs"
24184         "default":
24185           description: Response codes found in [response codes](https://wiki.onap.org/).
24186       parameters:
24187         - name: equipment-name
24188           in: path
24189           required: true
24190           type: string
24191           example: __EQUIPMENT-NAME__
24192         - name: interface-name
24193           in: path
24194           description: Name that identifies the physical interface
24195           required: true
24196           type: string
24197           example: __INTERFACE-NAME__
24198         - name: prov-status
24199           in: query
24200           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24201           required: false
24202           type: string
24203         - name: prov-status
24204           in: query
24205           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24206           required: false
24207           type: string
24208   /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:
24209     put:
24210       tags:
24211         - Network
24212       summary: see node definition for valid relationships
24213       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24214       consumes:
24215         - application/json
24216         - application/xml
24217       produces:
24218         - application/json
24219         - application/xml
24220       responses:
24221         "default":
24222           description: Response codes found in [response codes](https://wiki.onap.org/).
24223       parameters:
24224         - name: equipment-name
24225           in: path
24226           required: true
24227           type: string
24228           example: __EQUIPMENT-NAME__
24229         - name: interface-name
24230           in: path
24231           description: Name that identifies the physical interface
24232           required: true
24233           type: string
24234           example: __INTERFACE-NAME__
24235         - name: interface-name
24236           in: path
24237           description: Name given to the interface
24238           required: true
24239           type: string
24240           example: __INTERFACE-NAME__
24241         - name: vlan-interface
24242           in: path
24243           description: String that identifies the interface
24244           required: true
24245           type: string
24246           example: __VLAN-INTERFACE__
24247         - name: body
24248           in: body
24249           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
24250           required: true
24251           schema:
24252             $ref: "#/definitions/relationship"
24253     delete:
24254       tags:
24255         - Network
24256       summary: delete an existing relationship
24257       description: delete an existing relationship
24258       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24259       consumes:
24260         - application/json
24261         - application/xml
24262       produces:
24263         - application/json
24264         - application/xml
24265       responses:
24266         "default":
24267           description: Response codes found in [response codes](https://wiki.onap.org/).
24268       parameters:
24269         - name: equipment-name
24270           in: path
24271           required: true
24272           type: string
24273           example: __EQUIPMENT-NAME__
24274         - name: interface-name
24275           in: path
24276           description: Name that identifies the physical interface
24277           required: true
24278           type: string
24279           example: __INTERFACE-NAME__
24280         - name: interface-name
24281           in: path
24282           description: Name given to the interface
24283           required: true
24284           type: string
24285           example: __INTERFACE-NAME__
24286         - name: vlan-interface
24287           in: path
24288           description: String that identifies the interface
24289           required: true
24290           type: string
24291           example: __VLAN-INTERFACE__
24292   /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:
24293     put:
24294       tags:
24295         - Network
24296       summary: see node definition for valid relationships
24297       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24298       consumes:
24299         - application/json
24300         - application/xml
24301       produces:
24302         - application/json
24303         - application/xml
24304       responses:
24305         "default":
24306           description: Response codes found in [response codes](https://wiki.onap.org/).
24307       parameters:
24308         - name: equipment-name
24309           in: path
24310           required: true
24311           type: string
24312           example: __EQUIPMENT-NAME__
24313         - name: interface-name
24314           in: path
24315           description: Name that identifies the physical interface
24316           required: true
24317           type: string
24318           example: __INTERFACE-NAME__
24319         - name: interface-name
24320           in: path
24321           description: Name given to the interface
24322           required: true
24323           type: string
24324           example: __INTERFACE-NAME__
24325         - name: vlan-interface
24326           in: path
24327           description: String that identifies the interface
24328           required: true
24329           type: string
24330           example: __VLAN-INTERFACE__
24331         - name: l3-interface-ipv4-address
24332           in: path
24333           description: IP address
24334           required: true
24335           type: string
24336           example: __L3-INTERFACE-IPV4-ADDRESS__
24337         - name: body
24338           in: body
24339           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24340           required: true
24341           schema:
24342             $ref: "#/definitions/relationship"
24343     delete:
24344       tags:
24345         - Network
24346       summary: delete an existing relationship
24347       description: delete an existing relationship
24348       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24349       consumes:
24350         - application/json
24351         - application/xml
24352       produces:
24353         - application/json
24354         - application/xml
24355       responses:
24356         "default":
24357           description: Response codes found in [response codes](https://wiki.onap.org/).
24358       parameters:
24359         - name: equipment-name
24360           in: path
24361           required: true
24362           type: string
24363           example: __EQUIPMENT-NAME__
24364         - name: interface-name
24365           in: path
24366           description: Name that identifies the physical interface
24367           required: true
24368           type: string
24369           example: __INTERFACE-NAME__
24370         - name: interface-name
24371           in: path
24372           description: Name given to the interface
24373           required: true
24374           type: string
24375           example: __INTERFACE-NAME__
24376         - name: vlan-interface
24377           in: path
24378           description: String that identifies the interface
24379           required: true
24380           type: string
24381           example: __VLAN-INTERFACE__
24382         - name: l3-interface-ipv4-address
24383           in: path
24384           description: IP address
24385           required: true
24386           type: string
24387           example: __L3-INTERFACE-IPV4-ADDRESS__
24388   /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}:
24389     get:
24390       tags:
24391         - Network
24392       summary: returns l3-interface-ipv4-address-list
24393       description: returns l3-interface-ipv4-address-list
24394       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24395       produces:
24396         - application/json
24397         - application/xml
24398       responses:
24399         "200":
24400           description: successful operation
24401           schema:
24402               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24403         "default":
24404           description: Response codes found in [response codes](https://wiki.onap.org/).
24405       parameters:
24406         - name: equipment-name
24407           in: path
24408           required: true
24409           type: string
24410           example: __EQUIPMENT-NAME__
24411         - name: interface-name
24412           in: path
24413           description: Name that identifies the physical interface
24414           required: true
24415           type: string
24416           example: __INTERFACE-NAME__
24417         - name: interface-name
24418           in: path
24419           description: Name given to the interface
24420           required: true
24421           type: string
24422           example: __INTERFACE-NAME__
24423         - name: vlan-interface
24424           in: path
24425           description: String that identifies the interface
24426           required: true
24427           type: string
24428           example: __VLAN-INTERFACE__
24429         - name: l3-interface-ipv4-address
24430           in: path
24431           description: IP address
24432           required: true
24433           type: string
24434           example: __L3-INTERFACE-IPV4-ADDRESS__
24435         - name: prov-status
24436           in: query
24437           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24438           required: false
24439           type: string
24440         - name: prov-status
24441           in: query
24442           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24443           required: false
24444           type: string
24445         - name: interface-id
24446           in: query
24447           description: ID of interface
24448           required: false
24449           type: string
24450         - name: macaddr
24451           in: query
24452           description: MAC address for the interface
24453           required: false
24454           type: string
24455         - name: network-name
24456           in: query
24457           description: Name of the network
24458           required: false
24459           type: string
24460         - name: vlan-id-inner
24461           in: query
24462           description: Inner VLAN tag
24463           required: false
24464           type: integer
24465           format: int64
24466         - name: vpn-key
24467           in: query
24468           description: This indicates the customers VPN ID associated with this vlan
24469           required: false
24470           type: string
24471         - name: vlan-id-inner
24472           in: query
24473           description: Inner VLAN tag
24474           required: false
24475           type: integer
24476           format: int64
24477         - name: neutron-network-id
24478           in: query
24479           description: Neutron network id of the interface that address belongs to
24480           required: false
24481           type: string
24482         - name: neutron-subnet-id
24483           in: query
24484           description: Neutron id of subnet that address belongs to
24485           required: false
24486           type: string
24487     put:
24488       tags:
24489         - Network
24490       summary: create or update an existing l3-interface-ipv4-address-list
24491       description: |
24492         Create or update an existing l3-interface-ipv4-address-list.
24493         #
24494         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24495       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24496       consumes:
24497         - application/json
24498         - application/xml
24499       produces:
24500         - application/json
24501         - application/xml
24502       responses:
24503         "default":
24504           description: Response codes found in [response codes](https://wiki.onap.org/).
24505       parameters:
24506         - name: equipment-name
24507           in: path
24508           required: true
24509           type: string
24510           example: __EQUIPMENT-NAME__
24511         - name: interface-name
24512           in: path
24513           description: Name that identifies the physical interface
24514           required: true
24515           type: string
24516           example: __INTERFACE-NAME__
24517         - name: interface-name
24518           in: path
24519           description: Name given to the interface
24520           required: true
24521           type: string
24522           example: __INTERFACE-NAME__
24523         - name: vlan-interface
24524           in: path
24525           description: String that identifies the interface
24526           required: true
24527           type: string
24528           example: __VLAN-INTERFACE__
24529         - name: l3-interface-ipv4-address
24530           in: path
24531           description: IP address
24532           required: true
24533           type: string
24534           example: __L3-INTERFACE-IPV4-ADDRESS__
24535         - name: body
24536           in: body
24537           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24538           required: true
24539           schema:
24540             $ref: "#/definitions/l3-interface-ipv4-address-list"
24541     patch:
24542       tags:
24543         - Network
24544       summary: update an existing l3-interface-ipv4-address-list
24545       description: |
24546         Update an existing l3-interface-ipv4-address-list
24547         #
24548         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24549         The PUT operation will entirely replace an existing object.
24550         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24551         #
24552         Other differences between PUT and PATCH are:
24553         #
24554         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24555         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24556         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24557       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24558       consumes:
24559         - application/json
24560         - application/xml
24561       produces:
24562         - application/json
24563         - application/xml
24564       responses:
24565         "default":
24566           description: Response codes found in [response codes](https://wiki.onap.org/).
24567       parameters:
24568         - name: equipment-name
24569           in: path
24570           required: true
24571           type: string
24572           example: __EQUIPMENT-NAME__
24573         - name: interface-name
24574           in: path
24575           description: Name that identifies the physical interface
24576           required: true
24577           type: string
24578           example: __INTERFACE-NAME__
24579         - name: interface-name
24580           in: path
24581           description: Name given to the interface
24582           required: true
24583           type: string
24584           example: __INTERFACE-NAME__
24585         - name: vlan-interface
24586           in: path
24587           description: String that identifies the interface
24588           required: true
24589           type: string
24590           example: __VLAN-INTERFACE__
24591         - name: l3-interface-ipv4-address
24592           in: path
24593           description: IP address
24594           required: true
24595           type: string
24596           example: __L3-INTERFACE-IPV4-ADDRESS__
24597         - name: body
24598           in: body
24599           description: l3-interface-ipv4-address-list object that needs to be created or updated.
24600           required: true
24601           schema:
24602             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24603     delete:
24604       tags:
24605         - Network
24606       summary: delete an existing l3-interface-ipv4-address-list
24607       description: delete an existing l3-interface-ipv4-address-list
24608       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24609       consumes:
24610         - application/json
24611         - application/xml
24612       produces:
24613         - application/json
24614         - application/xml
24615       responses:
24616         "default":
24617           description: Response codes found in [response codes](https://wiki.onap.org/).
24618       parameters:
24619         - name: equipment-name
24620           in: path
24621           required: true
24622           type: string
24623           example: __EQUIPMENT-NAME__
24624         - name: interface-name
24625           in: path
24626           description: Name that identifies the physical interface
24627           required: true
24628           type: string
24629           example: __INTERFACE-NAME__
24630         - name: interface-name
24631           in: path
24632           description: Name given to the interface
24633           required: true
24634           type: string
24635           example: __INTERFACE-NAME__
24636         - name: vlan-interface
24637           in: path
24638           description: String that identifies the interface
24639           required: true
24640           type: string
24641           example: __VLAN-INTERFACE__
24642         - name: l3-interface-ipv4-address
24643           in: path
24644           description: IP address
24645           required: true
24646           type: string
24647           example: __L3-INTERFACE-IPV4-ADDRESS__
24648         - name: resource-version
24649           in: query
24650           description: resource-version for concurrency
24651           required: true
24652           type: string
24653   /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:
24654     put:
24655       tags:
24656         - Network
24657       summary: see node definition for valid relationships
24658       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24659       consumes:
24660         - application/json
24661         - application/xml
24662       produces:
24663         - application/json
24664         - application/xml
24665       responses:
24666         "default":
24667           description: Response codes found in [response codes](https://wiki.onap.org/).
24668       parameters:
24669         - name: equipment-name
24670           in: path
24671           required: true
24672           type: string
24673           example: __EQUIPMENT-NAME__
24674         - name: interface-name
24675           in: path
24676           description: Name that identifies the physical interface
24677           required: true
24678           type: string
24679           example: __INTERFACE-NAME__
24680         - name: interface-name
24681           in: path
24682           description: Name given to the interface
24683           required: true
24684           type: string
24685           example: __INTERFACE-NAME__
24686         - name: vlan-interface
24687           in: path
24688           description: String that identifies the interface
24689           required: true
24690           type: string
24691           example: __VLAN-INTERFACE__
24692         - name: l3-interface-ipv6-address
24693           in: path
24694           description: IP address
24695           required: true
24696           type: string
24697           example: __L3-INTERFACE-IPV6-ADDRESS__
24698         - name: body
24699           in: body
24700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24701           required: true
24702           schema:
24703             $ref: "#/definitions/relationship"
24704     delete:
24705       tags:
24706         - Network
24707       summary: delete an existing relationship
24708       description: delete an existing relationship
24709       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24710       consumes:
24711         - application/json
24712         - application/xml
24713       produces:
24714         - application/json
24715         - application/xml
24716       responses:
24717         "default":
24718           description: Response codes found in [response codes](https://wiki.onap.org/).
24719       parameters:
24720         - name: equipment-name
24721           in: path
24722           required: true
24723           type: string
24724           example: __EQUIPMENT-NAME__
24725         - name: interface-name
24726           in: path
24727           description: Name that identifies the physical interface
24728           required: true
24729           type: string
24730           example: __INTERFACE-NAME__
24731         - name: interface-name
24732           in: path
24733           description: Name given to the interface
24734           required: true
24735           type: string
24736           example: __INTERFACE-NAME__
24737         - name: vlan-interface
24738           in: path
24739           description: String that identifies the interface
24740           required: true
24741           type: string
24742           example: __VLAN-INTERFACE__
24743         - name: l3-interface-ipv6-address
24744           in: path
24745           description: IP address
24746           required: true
24747           type: string
24748           example: __L3-INTERFACE-IPV6-ADDRESS__
24749   /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}:
24750     get:
24751       tags:
24752         - Network
24753       summary: returns l3-interface-ipv6-address-list
24754       description: returns l3-interface-ipv6-address-list
24755       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24756       produces:
24757         - application/json
24758         - application/xml
24759       responses:
24760         "200":
24761           description: successful operation
24762           schema:
24763               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24764         "default":
24765           description: Response codes found in [response codes](https://wiki.onap.org/).
24766       parameters:
24767         - name: equipment-name
24768           in: path
24769           required: true
24770           type: string
24771           example: __EQUIPMENT-NAME__
24772         - name: interface-name
24773           in: path
24774           description: Name that identifies the physical interface
24775           required: true
24776           type: string
24777           example: __INTERFACE-NAME__
24778         - name: interface-name
24779           in: path
24780           description: Name given to the interface
24781           required: true
24782           type: string
24783           example: __INTERFACE-NAME__
24784         - name: vlan-interface
24785           in: path
24786           description: String that identifies the interface
24787           required: true
24788           type: string
24789           example: __VLAN-INTERFACE__
24790         - name: l3-interface-ipv6-address
24791           in: path
24792           description: IP address
24793           required: true
24794           type: string
24795           example: __L3-INTERFACE-IPV6-ADDRESS__
24796         - name: prov-status
24797           in: query
24798           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24799           required: false
24800           type: string
24801         - name: prov-status
24802           in: query
24803           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24804           required: false
24805           type: string
24806         - name: interface-id
24807           in: query
24808           description: ID of interface
24809           required: false
24810           type: string
24811         - name: macaddr
24812           in: query
24813           description: MAC address for the interface
24814           required: false
24815           type: string
24816         - name: network-name
24817           in: query
24818           description: Name of the network
24819           required: false
24820           type: string
24821         - name: vlan-id-inner
24822           in: query
24823           description: Inner VLAN tag
24824           required: false
24825           type: integer
24826           format: int64
24827         - name: vpn-key
24828           in: query
24829           description: This indicates the customers VPN ID associated with this vlan
24830           required: false
24831           type: string
24832         - name: vlan-id-inner
24833           in: query
24834           description: Inner VLAN tag
24835           required: false
24836           type: integer
24837           format: int64
24838         - name: neutron-network-id
24839           in: query
24840           description: Neutron network id of the interface that address belongs to
24841           required: false
24842           type: string
24843         - name: neutron-subnet-id
24844           in: query
24845           description: Neutron id of subnet that address belongs to
24846           required: false
24847           type: string
24848     put:
24849       tags:
24850         - Network
24851       summary: create or update an existing l3-interface-ipv6-address-list
24852       description: |
24853         Create or update an existing l3-interface-ipv6-address-list.
24854         #
24855         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24856       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24857       consumes:
24858         - application/json
24859         - application/xml
24860       produces:
24861         - application/json
24862         - application/xml
24863       responses:
24864         "default":
24865           description: Response codes found in [response codes](https://wiki.onap.org/).
24866       parameters:
24867         - name: equipment-name
24868           in: path
24869           required: true
24870           type: string
24871           example: __EQUIPMENT-NAME__
24872         - name: interface-name
24873           in: path
24874           description: Name that identifies the physical interface
24875           required: true
24876           type: string
24877           example: __INTERFACE-NAME__
24878         - name: interface-name
24879           in: path
24880           description: Name given to the interface
24881           required: true
24882           type: string
24883           example: __INTERFACE-NAME__
24884         - name: vlan-interface
24885           in: path
24886           description: String that identifies the interface
24887           required: true
24888           type: string
24889           example: __VLAN-INTERFACE__
24890         - name: l3-interface-ipv6-address
24891           in: path
24892           description: IP address
24893           required: true
24894           type: string
24895           example: __L3-INTERFACE-IPV6-ADDRESS__
24896         - name: body
24897           in: body
24898           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24899           required: true
24900           schema:
24901             $ref: "#/definitions/l3-interface-ipv6-address-list"
24902     patch:
24903       tags:
24904         - Network
24905       summary: update an existing l3-interface-ipv6-address-list
24906       description: |
24907         Update an existing l3-interface-ipv6-address-list
24908         #
24909         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24910         The PUT operation will entirely replace an existing object.
24911         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24912         #
24913         Other differences between PUT and PATCH are:
24914         #
24915         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24916         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24917         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24918       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24919       consumes:
24920         - application/json
24921         - application/xml
24922       produces:
24923         - application/json
24924         - application/xml
24925       responses:
24926         "default":
24927           description: Response codes found in [response codes](https://wiki.onap.org/).
24928       parameters:
24929         - name: equipment-name
24930           in: path
24931           required: true
24932           type: string
24933           example: __EQUIPMENT-NAME__
24934         - name: interface-name
24935           in: path
24936           description: Name that identifies the physical interface
24937           required: true
24938           type: string
24939           example: __INTERFACE-NAME__
24940         - name: interface-name
24941           in: path
24942           description: Name given to the interface
24943           required: true
24944           type: string
24945           example: __INTERFACE-NAME__
24946         - name: vlan-interface
24947           in: path
24948           description: String that identifies the interface
24949           required: true
24950           type: string
24951           example: __VLAN-INTERFACE__
24952         - name: l3-interface-ipv6-address
24953           in: path
24954           description: IP address
24955           required: true
24956           type: string
24957           example: __L3-INTERFACE-IPV6-ADDRESS__
24958         - name: body
24959           in: body
24960           description: l3-interface-ipv6-address-list object that needs to be created or updated.
24961           required: true
24962           schema:
24963             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24964     delete:
24965       tags:
24966         - Network
24967       summary: delete an existing l3-interface-ipv6-address-list
24968       description: delete an existing l3-interface-ipv6-address-list
24969       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24970       consumes:
24971         - application/json
24972         - application/xml
24973       produces:
24974         - application/json
24975         - application/xml
24976       responses:
24977         "default":
24978           description: Response codes found in [response codes](https://wiki.onap.org/).
24979       parameters:
24980         - name: equipment-name
24981           in: path
24982           required: true
24983           type: string
24984           example: __EQUIPMENT-NAME__
24985         - name: interface-name
24986           in: path
24987           description: Name that identifies the physical interface
24988           required: true
24989           type: string
24990           example: __INTERFACE-NAME__
24991         - name: interface-name
24992           in: path
24993           description: Name given to the interface
24994           required: true
24995           type: string
24996           example: __INTERFACE-NAME__
24997         - name: vlan-interface
24998           in: path
24999           description: String that identifies the interface
25000           required: true
25001           type: string
25002           example: __VLAN-INTERFACE__
25003         - name: l3-interface-ipv6-address
25004           in: path
25005           description: IP address
25006           required: true
25007           type: string
25008           example: __L3-INTERFACE-IPV6-ADDRESS__
25009         - name: resource-version
25010           in: query
25011           description: resource-version for concurrency
25012           required: true
25013           type: string
25014   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25015     get:
25016       tags:
25017         - Network
25018       summary: returns vlan
25019       description: returns vlan
25020       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25021       produces:
25022         - application/json
25023         - application/xml
25024       responses:
25025         "200":
25026           description: successful operation
25027           schema:
25028               $ref: "#/getDefinitions/vlan"
25029         "default":
25030           description: Response codes found in [response codes](https://wiki.onap.org/).
25031       parameters:
25032         - name: equipment-name
25033           in: path
25034           required: true
25035           type: string
25036           example: __EQUIPMENT-NAME__
25037         - name: interface-name
25038           in: path
25039           description: Name that identifies the physical interface
25040           required: true
25041           type: string
25042           example: __INTERFACE-NAME__
25043         - name: interface-name
25044           in: path
25045           description: Name given to the interface
25046           required: true
25047           type: string
25048           example: __INTERFACE-NAME__
25049         - name: vlan-interface
25050           in: path
25051           description: String that identifies the interface
25052           required: true
25053           type: string
25054           example: __VLAN-INTERFACE__
25055         - name: prov-status
25056           in: query
25057           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25058           required: false
25059           type: string
25060         - name: prov-status
25061           in: query
25062           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25063           required: false
25064           type: string
25065         - name: interface-id
25066           in: query
25067           description: ID of interface
25068           required: false
25069           type: string
25070         - name: macaddr
25071           in: query
25072           description: MAC address for the interface
25073           required: false
25074           type: string
25075         - name: network-name
25076           in: query
25077           description: Name of the network
25078           required: false
25079           type: string
25080         - name: vlan-id-inner
25081           in: query
25082           description: Inner VLAN tag
25083           required: false
25084           type: integer
25085           format: int64
25086         - name: vpn-key
25087           in: query
25088           description: This indicates the customers VPN ID associated with this vlan
25089           required: false
25090           type: string
25091     put:
25092       tags:
25093         - Network
25094       summary: create or update an existing vlan
25095       description: |
25096         Create or update an existing vlan.
25097         #
25098         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25099       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25100       consumes:
25101         - application/json
25102         - application/xml
25103       produces:
25104         - application/json
25105         - application/xml
25106       responses:
25107         "default":
25108           description: Response codes found in [response codes](https://wiki.onap.org/).
25109       parameters:
25110         - name: equipment-name
25111           in: path
25112           required: true
25113           type: string
25114           example: __EQUIPMENT-NAME__
25115         - name: interface-name
25116           in: path
25117           description: Name that identifies the physical interface
25118           required: true
25119           type: string
25120           example: __INTERFACE-NAME__
25121         - name: interface-name
25122           in: path
25123           description: Name given to the interface
25124           required: true
25125           type: string
25126           example: __INTERFACE-NAME__
25127         - name: vlan-interface
25128           in: path
25129           description: String that identifies the interface
25130           required: true
25131           type: string
25132           example: __VLAN-INTERFACE__
25133         - name: body
25134           in: body
25135           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
25136           required: true
25137           schema:
25138             $ref: "#/definitions/vlan"
25139     patch:
25140       tags:
25141         - Network
25142       summary: update an existing vlan
25143       description: |
25144         Update an existing vlan
25145         #
25146         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25147         The PUT operation will entirely replace an existing object.
25148         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25149         #
25150         Other differences between PUT and PATCH are:
25151         #
25152         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25153         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25154         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25155       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25156       consumes:
25157         - application/json
25158         - application/xml
25159       produces:
25160         - application/json
25161         - application/xml
25162       responses:
25163         "default":
25164           description: Response codes found in [response codes](https://wiki.onap.org/).
25165       parameters:
25166         - name: equipment-name
25167           in: path
25168           required: true
25169           type: string
25170           example: __EQUIPMENT-NAME__
25171         - name: interface-name
25172           in: path
25173           description: Name that identifies the physical interface
25174           required: true
25175           type: string
25176           example: __INTERFACE-NAME__
25177         - name: interface-name
25178           in: path
25179           description: Name given to the interface
25180           required: true
25181           type: string
25182           example: __INTERFACE-NAME__
25183         - name: vlan-interface
25184           in: path
25185           description: String that identifies the interface
25186           required: true
25187           type: string
25188           example: __VLAN-INTERFACE__
25189         - name: body
25190           in: body
25191           description: vlan object that needs to be created or updated.
25192           required: true
25193           schema:
25194             $ref: "#/patchDefinitions/vlan"
25195     delete:
25196       tags:
25197         - Network
25198       summary: delete an existing vlan
25199       description: delete an existing vlan
25200       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25201       consumes:
25202         - application/json
25203         - application/xml
25204       produces:
25205         - application/json
25206         - application/xml
25207       responses:
25208         "default":
25209           description: Response codes found in [response codes](https://wiki.onap.org/).
25210       parameters:
25211         - name: equipment-name
25212           in: path
25213           required: true
25214           type: string
25215           example: __EQUIPMENT-NAME__
25216         - name: interface-name
25217           in: path
25218           description: Name that identifies the physical interface
25219           required: true
25220           type: string
25221           example: __INTERFACE-NAME__
25222         - name: interface-name
25223           in: path
25224           description: Name given to the interface
25225           required: true
25226           type: string
25227           example: __INTERFACE-NAME__
25228         - name: vlan-interface
25229           in: path
25230           description: String that identifies the interface
25231           required: true
25232           type: string
25233           example: __VLAN-INTERFACE__
25234         - name: resource-version
25235           in: query
25236           description: resource-version for concurrency
25237           required: true
25238           type: string
25239   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25240     get:
25241       tags:
25242         - Network
25243       summary: returns vlans
25244       description: returns vlans
25245       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
25246       produces:
25247         - application/json
25248         - application/xml
25249       responses:
25250         "200":
25251           description: successful operation
25252           schema:
25253               $ref: "#/getDefinitions/vlans"
25254         "default":
25255           description: Response codes found in [response codes](https://wiki.onap.org/).
25256       parameters:
25257         - name: equipment-name
25258           in: path
25259           required: true
25260           type: string
25261           example: __EQUIPMENT-NAME__
25262         - name: interface-name
25263           in: path
25264           description: Name that identifies the physical interface
25265           required: true
25266           type: string
25267           example: __INTERFACE-NAME__
25268         - name: interface-name
25269           in: path
25270           description: Name given to the interface
25271           required: true
25272           type: string
25273           example: __INTERFACE-NAME__
25274         - name: prov-status
25275           in: query
25276           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25277           required: false
25278           type: string
25279         - name: prov-status
25280           in: query
25281           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25282           required: false
25283           type: string
25284         - name: interface-id
25285           in: query
25286           description: ID of interface
25287           required: false
25288           type: string
25289         - name: macaddr
25290           in: query
25291           description: MAC address for the interface
25292           required: false
25293           type: string
25294         - name: network-name
25295           in: query
25296           description: Name of the network
25297           required: false
25298           type: string
25299   /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:
25300     put:
25301       tags:
25302         - Network
25303       summary: see node definition for valid relationships
25304       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25305       consumes:
25306         - application/json
25307         - application/xml
25308       produces:
25309         - application/json
25310         - application/xml
25311       responses:
25312         "default":
25313           description: Response codes found in [response codes](https://wiki.onap.org/).
25314       parameters:
25315         - name: equipment-name
25316           in: path
25317           required: true
25318           type: string
25319           example: __EQUIPMENT-NAME__
25320         - name: interface-name
25321           in: path
25322           description: Name that identifies the physical interface
25323           required: true
25324           type: string
25325           example: __INTERFACE-NAME__
25326         - name: interface-name
25327           in: path
25328           description: Name given to the interface
25329           required: true
25330           type: string
25331           example: __INTERFACE-NAME__
25332         - name: pci-id
25333           in: path
25334           description: PCI ID used to identify the sriov-vf
25335           required: true
25336           type: string
25337           example: __PCI-ID__
25338         - name: body
25339           in: body
25340           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25341           required: true
25342           schema:
25343             $ref: "#/definitions/relationship"
25344     delete:
25345       tags:
25346         - Network
25347       summary: delete an existing relationship
25348       description: delete an existing relationship
25349       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25350       consumes:
25351         - application/json
25352         - application/xml
25353       produces:
25354         - application/json
25355         - application/xml
25356       responses:
25357         "default":
25358           description: Response codes found in [response codes](https://wiki.onap.org/).
25359       parameters:
25360         - name: equipment-name
25361           in: path
25362           required: true
25363           type: string
25364           example: __EQUIPMENT-NAME__
25365         - name: interface-name
25366           in: path
25367           description: Name that identifies the physical interface
25368           required: true
25369           type: string
25370           example: __INTERFACE-NAME__
25371         - name: interface-name
25372           in: path
25373           description: Name given to the interface
25374           required: true
25375           type: string
25376           example: __INTERFACE-NAME__
25377         - name: pci-id
25378           in: path
25379           description: PCI ID used to identify the sriov-vf
25380           required: true
25381           type: string
25382           example: __PCI-ID__
25383   /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}:
25384     get:
25385       tags:
25386         - Network
25387       summary: returns sriov-vf
25388       description: returns sriov-vf
25389       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25390       produces:
25391         - application/json
25392         - application/xml
25393       responses:
25394         "200":
25395           description: successful operation
25396           schema:
25397               $ref: "#/getDefinitions/sriov-vf"
25398         "default":
25399           description: Response codes found in [response codes](https://wiki.onap.org/).
25400       parameters:
25401         - name: equipment-name
25402           in: path
25403           required: true
25404           type: string
25405           example: __EQUIPMENT-NAME__
25406         - name: interface-name
25407           in: path
25408           description: Name that identifies the physical interface
25409           required: true
25410           type: string
25411           example: __INTERFACE-NAME__
25412         - name: interface-name
25413           in: path
25414           description: Name given to the interface
25415           required: true
25416           type: string
25417           example: __INTERFACE-NAME__
25418         - name: pci-id
25419           in: path
25420           description: PCI ID used to identify the sriov-vf
25421           required: true
25422           type: string
25423           example: __PCI-ID__
25424         - name: prov-status
25425           in: query
25426           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25427           required: false
25428           type: string
25429         - name: prov-status
25430           in: query
25431           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25432           required: false
25433           type: string
25434         - name: interface-id
25435           in: query
25436           description: ID of interface
25437           required: false
25438           type: string
25439         - name: macaddr
25440           in: query
25441           description: MAC address for the interface
25442           required: false
25443           type: string
25444         - name: network-name
25445           in: query
25446           description: Name of the network
25447           required: false
25448           type: string
25449         - name: vf-vlan-filter
25450           in: query
25451           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25452           required: false
25453           type: string
25454         - name: vf-mac-filter
25455           in: query
25456           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25457           required: false
25458           type: string
25459         - name: vf-vlan-strip
25460           in: query
25461           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25462           required: false
25463           type: boolean
25464         - name: neutron-network-id
25465           in: query
25466           description: Neutron network id of the interface
25467           required: false
25468           type: string
25469     put:
25470       tags:
25471         - Network
25472       summary: create or update an existing sriov-vf
25473       description: |
25474         Create or update an existing sriov-vf.
25475         #
25476         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25477       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25478       consumes:
25479         - application/json
25480         - application/xml
25481       produces:
25482         - application/json
25483         - application/xml
25484       responses:
25485         "default":
25486           description: Response codes found in [response codes](https://wiki.onap.org/).
25487       parameters:
25488         - name: equipment-name
25489           in: path
25490           required: true
25491           type: string
25492           example: __EQUIPMENT-NAME__
25493         - name: interface-name
25494           in: path
25495           description: Name that identifies the physical interface
25496           required: true
25497           type: string
25498           example: __INTERFACE-NAME__
25499         - name: interface-name
25500           in: path
25501           description: Name given to the interface
25502           required: true
25503           type: string
25504           example: __INTERFACE-NAME__
25505         - name: pci-id
25506           in: path
25507           description: PCI ID used to identify the sriov-vf
25508           required: true
25509           type: string
25510           example: __PCI-ID__
25511         - name: body
25512           in: body
25513           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25514           required: true
25515           schema:
25516             $ref: "#/definitions/sriov-vf"
25517     patch:
25518       tags:
25519         - Network
25520       summary: update an existing sriov-vf
25521       description: |
25522         Update an existing sriov-vf
25523         #
25524         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25525         The PUT operation will entirely replace an existing object.
25526         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25527         #
25528         Other differences between PUT and PATCH are:
25529         #
25530         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25531         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25532         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25533       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25534       consumes:
25535         - application/json
25536         - application/xml
25537       produces:
25538         - application/json
25539         - application/xml
25540       responses:
25541         "default":
25542           description: Response codes found in [response codes](https://wiki.onap.org/).
25543       parameters:
25544         - name: equipment-name
25545           in: path
25546           required: true
25547           type: string
25548           example: __EQUIPMENT-NAME__
25549         - name: interface-name
25550           in: path
25551           description: Name that identifies the physical interface
25552           required: true
25553           type: string
25554           example: __INTERFACE-NAME__
25555         - name: interface-name
25556           in: path
25557           description: Name given to the interface
25558           required: true
25559           type: string
25560           example: __INTERFACE-NAME__
25561         - name: pci-id
25562           in: path
25563           description: PCI ID used to identify the sriov-vf
25564           required: true
25565           type: string
25566           example: __PCI-ID__
25567         - name: body
25568           in: body
25569           description: sriov-vf object that needs to be created or updated.
25570           required: true
25571           schema:
25572             $ref: "#/patchDefinitions/sriov-vf"
25573     delete:
25574       tags:
25575         - Network
25576       summary: delete an existing sriov-vf
25577       description: delete an existing sriov-vf
25578       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25579       consumes:
25580         - application/json
25581         - application/xml
25582       produces:
25583         - application/json
25584         - application/xml
25585       responses:
25586         "default":
25587           description: Response codes found in [response codes](https://wiki.onap.org/).
25588       parameters:
25589         - name: equipment-name
25590           in: path
25591           required: true
25592           type: string
25593           example: __EQUIPMENT-NAME__
25594         - name: interface-name
25595           in: path
25596           description: Name that identifies the physical interface
25597           required: true
25598           type: string
25599           example: __INTERFACE-NAME__
25600         - name: interface-name
25601           in: path
25602           description: Name given to the interface
25603           required: true
25604           type: string
25605           example: __INTERFACE-NAME__
25606         - name: pci-id
25607           in: path
25608           description: PCI ID used to identify the sriov-vf
25609           required: true
25610           type: string
25611           example: __PCI-ID__
25612         - name: resource-version
25613           in: query
25614           description: resource-version for concurrency
25615           required: true
25616           type: string
25617   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25618     get:
25619       tags:
25620         - Network
25621       summary: returns sriov-vfs
25622       description: returns sriov-vfs
25623       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
25624       produces:
25625         - application/json
25626         - application/xml
25627       responses:
25628         "200":
25629           description: successful operation
25630           schema:
25631               $ref: "#/getDefinitions/sriov-vfs"
25632         "default":
25633           description: Response codes found in [response codes](https://wiki.onap.org/).
25634       parameters:
25635         - name: equipment-name
25636           in: path
25637           required: true
25638           type: string
25639           example: __EQUIPMENT-NAME__
25640         - name: interface-name
25641           in: path
25642           description: Name that identifies the physical interface
25643           required: true
25644           type: string
25645           example: __INTERFACE-NAME__
25646         - name: interface-name
25647           in: path
25648           description: Name given to the interface
25649           required: true
25650           type: string
25651           example: __INTERFACE-NAME__
25652         - name: prov-status
25653           in: query
25654           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25655           required: false
25656           type: string
25657         - name: prov-status
25658           in: query
25659           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25660           required: false
25661           type: string
25662         - name: interface-id
25663           in: query
25664           description: ID of interface
25665           required: false
25666           type: string
25667         - name: macaddr
25668           in: query
25669           description: MAC address for the interface
25670           required: false
25671           type: string
25672         - name: network-name
25673           in: query
25674           description: Name of the network
25675           required: false
25676           type: string
25677   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25678     put:
25679       tags:
25680         - Network
25681       summary: see node definition for valid relationships
25682       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25683       consumes:
25684         - application/json
25685         - application/xml
25686       produces:
25687         - application/json
25688         - application/xml
25689       responses:
25690         "default":
25691           description: Response codes found in [response codes](https://wiki.onap.org/).
25692       parameters:
25693         - name: equipment-name
25694           in: path
25695           required: true
25696           type: string
25697           example: __EQUIPMENT-NAME__
25698         - name: interface-name
25699           in: path
25700           description: Name that identifies the physical interface
25701           required: true
25702           type: string
25703           example: __INTERFACE-NAME__
25704         - name: interface-name
25705           in: path
25706           description: Name given to the interface
25707           required: true
25708           type: string
25709           example: __INTERFACE-NAME__
25710         - name: body
25711           in: body
25712           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
25713           required: true
25714           schema:
25715             $ref: "#/definitions/relationship"
25716     delete:
25717       tags:
25718         - Network
25719       summary: delete an existing relationship
25720       description: delete an existing relationship
25721       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25722       consumes:
25723         - application/json
25724         - application/xml
25725       produces:
25726         - application/json
25727         - application/xml
25728       responses:
25729         "default":
25730           description: Response codes found in [response codes](https://wiki.onap.org/).
25731       parameters:
25732         - name: equipment-name
25733           in: path
25734           required: true
25735           type: string
25736           example: __EQUIPMENT-NAME__
25737         - name: interface-name
25738           in: path
25739           description: Name that identifies the physical interface
25740           required: true
25741           type: string
25742           example: __INTERFACE-NAME__
25743         - name: interface-name
25744           in: path
25745           description: Name given to the interface
25746           required: true
25747           type: string
25748           example: __INTERFACE-NAME__
25749   /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:
25750     put:
25751       tags:
25752         - Network
25753       summary: see node definition for valid relationships
25754       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25755       consumes:
25756         - application/json
25757         - application/xml
25758       produces:
25759         - application/json
25760         - application/xml
25761       responses:
25762         "default":
25763           description: Response codes found in [response codes](https://wiki.onap.org/).
25764       parameters:
25765         - name: equipment-name
25766           in: path
25767           required: true
25768           type: string
25769           example: __EQUIPMENT-NAME__
25770         - name: interface-name
25771           in: path
25772           description: Name that identifies the physical interface
25773           required: true
25774           type: string
25775           example: __INTERFACE-NAME__
25776         - name: interface-name
25777           in: path
25778           description: Name given to the interface
25779           required: true
25780           type: string
25781           example: __INTERFACE-NAME__
25782         - name: l3-interface-ipv4-address
25783           in: path
25784           description: IP address
25785           required: true
25786           type: string
25787           example: __L3-INTERFACE-IPV4-ADDRESS__
25788         - name: body
25789           in: body
25790           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25791           required: true
25792           schema:
25793             $ref: "#/definitions/relationship"
25794     delete:
25795       tags:
25796         - Network
25797       summary: delete an existing relationship
25798       description: delete an existing relationship
25799       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25800       consumes:
25801         - application/json
25802         - application/xml
25803       produces:
25804         - application/json
25805         - application/xml
25806       responses:
25807         "default":
25808           description: Response codes found in [response codes](https://wiki.onap.org/).
25809       parameters:
25810         - name: equipment-name
25811           in: path
25812           required: true
25813           type: string
25814           example: __EQUIPMENT-NAME__
25815         - name: interface-name
25816           in: path
25817           description: Name that identifies the physical interface
25818           required: true
25819           type: string
25820           example: __INTERFACE-NAME__
25821         - name: interface-name
25822           in: path
25823           description: Name given to the interface
25824           required: true
25825           type: string
25826           example: __INTERFACE-NAME__
25827         - name: l3-interface-ipv4-address
25828           in: path
25829           description: IP address
25830           required: true
25831           type: string
25832           example: __L3-INTERFACE-IPV4-ADDRESS__
25833   /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}:
25834     get:
25835       tags:
25836         - Network
25837       summary: returns l3-interface-ipv4-address-list
25838       description: returns l3-interface-ipv4-address-list
25839       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25840       produces:
25841         - application/json
25842         - application/xml
25843       responses:
25844         "200":
25845           description: successful operation
25846           schema:
25847               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25848         "default":
25849           description: Response codes found in [response codes](https://wiki.onap.org/).
25850       parameters:
25851         - name: equipment-name
25852           in: path
25853           required: true
25854           type: string
25855           example: __EQUIPMENT-NAME__
25856         - name: interface-name
25857           in: path
25858           description: Name that identifies the physical interface
25859           required: true
25860           type: string
25861           example: __INTERFACE-NAME__
25862         - name: interface-name
25863           in: path
25864           description: Name given to the interface
25865           required: true
25866           type: string
25867           example: __INTERFACE-NAME__
25868         - name: l3-interface-ipv4-address
25869           in: path
25870           description: IP address
25871           required: true
25872           type: string
25873           example: __L3-INTERFACE-IPV4-ADDRESS__
25874         - name: prov-status
25875           in: query
25876           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25877           required: false
25878           type: string
25879         - name: prov-status
25880           in: query
25881           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25882           required: false
25883           type: string
25884         - name: interface-id
25885           in: query
25886           description: ID of interface
25887           required: false
25888           type: string
25889         - name: macaddr
25890           in: query
25891           description: MAC address for the interface
25892           required: false
25893           type: string
25894         - name: network-name
25895           in: query
25896           description: Name of the network
25897           required: false
25898           type: string
25899         - name: vlan-id-inner
25900           in: query
25901           description: Inner VLAN tag
25902           required: false
25903           type: integer
25904           format: int64
25905         - name: neutron-network-id
25906           in: query
25907           description: Neutron network id of the interface that address belongs to
25908           required: false
25909           type: string
25910         - name: neutron-subnet-id
25911           in: query
25912           description: Neutron id of subnet that address belongs to
25913           required: false
25914           type: string
25915     put:
25916       tags:
25917         - Network
25918       summary: create or update an existing l3-interface-ipv4-address-list
25919       description: |
25920         Create or update an existing l3-interface-ipv4-address-list.
25921         #
25922         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25923       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25924       consumes:
25925         - application/json
25926         - application/xml
25927       produces:
25928         - application/json
25929         - application/xml
25930       responses:
25931         "default":
25932           description: Response codes found in [response codes](https://wiki.onap.org/).
25933       parameters:
25934         - name: equipment-name
25935           in: path
25936           required: true
25937           type: string
25938           example: __EQUIPMENT-NAME__
25939         - name: interface-name
25940           in: path
25941           description: Name that identifies the physical interface
25942           required: true
25943           type: string
25944           example: __INTERFACE-NAME__
25945         - name: interface-name
25946           in: path
25947           description: Name given to the interface
25948           required: true
25949           type: string
25950           example: __INTERFACE-NAME__
25951         - name: l3-interface-ipv4-address
25952           in: path
25953           description: IP address
25954           required: true
25955           type: string
25956           example: __L3-INTERFACE-IPV4-ADDRESS__
25957         - name: body
25958           in: body
25959           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25960           required: true
25961           schema:
25962             $ref: "#/definitions/l3-interface-ipv4-address-list"
25963     patch:
25964       tags:
25965         - Network
25966       summary: update an existing l3-interface-ipv4-address-list
25967       description: |
25968         Update an existing l3-interface-ipv4-address-list
25969         #
25970         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25971         The PUT operation will entirely replace an existing object.
25972         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25973         #
25974         Other differences between PUT and PATCH are:
25975         #
25976         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25977         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25978         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25979       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25980       consumes:
25981         - application/json
25982         - application/xml
25983       produces:
25984         - application/json
25985         - application/xml
25986       responses:
25987         "default":
25988           description: Response codes found in [response codes](https://wiki.onap.org/).
25989       parameters:
25990         - name: equipment-name
25991           in: path
25992           required: true
25993           type: string
25994           example: __EQUIPMENT-NAME__
25995         - name: interface-name
25996           in: path
25997           description: Name that identifies the physical interface
25998           required: true
25999           type: string
26000           example: __INTERFACE-NAME__
26001         - name: interface-name
26002           in: path
26003           description: Name given to the interface
26004           required: true
26005           type: string
26006           example: __INTERFACE-NAME__
26007         - name: l3-interface-ipv4-address
26008           in: path
26009           description: IP address
26010           required: true
26011           type: string
26012           example: __L3-INTERFACE-IPV4-ADDRESS__
26013         - name: body
26014           in: body
26015           description: l3-interface-ipv4-address-list object that needs to be created or updated.
26016           required: true
26017           schema:
26018             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26019     delete:
26020       tags:
26021         - Network
26022       summary: delete an existing l3-interface-ipv4-address-list
26023       description: delete an existing l3-interface-ipv4-address-list
26024       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26025       consumes:
26026         - application/json
26027         - application/xml
26028       produces:
26029         - application/json
26030         - application/xml
26031       responses:
26032         "default":
26033           description: Response codes found in [response codes](https://wiki.onap.org/).
26034       parameters:
26035         - name: equipment-name
26036           in: path
26037           required: true
26038           type: string
26039           example: __EQUIPMENT-NAME__
26040         - name: interface-name
26041           in: path
26042           description: Name that identifies the physical interface
26043           required: true
26044           type: string
26045           example: __INTERFACE-NAME__
26046         - name: interface-name
26047           in: path
26048           description: Name given to the interface
26049           required: true
26050           type: string
26051           example: __INTERFACE-NAME__
26052         - name: l3-interface-ipv4-address
26053           in: path
26054           description: IP address
26055           required: true
26056           type: string
26057           example: __L3-INTERFACE-IPV4-ADDRESS__
26058         - name: resource-version
26059           in: query
26060           description: resource-version for concurrency
26061           required: true
26062           type: string
26063   /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:
26064     put:
26065       tags:
26066         - Network
26067       summary: see node definition for valid relationships
26068       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26069       consumes:
26070         - application/json
26071         - application/xml
26072       produces:
26073         - application/json
26074         - application/xml
26075       responses:
26076         "default":
26077           description: Response codes found in [response codes](https://wiki.onap.org/).
26078       parameters:
26079         - name: equipment-name
26080           in: path
26081           required: true
26082           type: string
26083           example: __EQUIPMENT-NAME__
26084         - name: interface-name
26085           in: path
26086           description: Name that identifies the physical interface
26087           required: true
26088           type: string
26089           example: __INTERFACE-NAME__
26090         - name: interface-name
26091           in: path
26092           description: Name given to the interface
26093           required: true
26094           type: string
26095           example: __INTERFACE-NAME__
26096         - name: l3-interface-ipv6-address
26097           in: path
26098           description: IP address
26099           required: true
26100           type: string
26101           example: __L3-INTERFACE-IPV6-ADDRESS__
26102         - name: body
26103           in: body
26104           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26105           required: true
26106           schema:
26107             $ref: "#/definitions/relationship"
26108     delete:
26109       tags:
26110         - Network
26111       summary: delete an existing relationship
26112       description: delete an existing relationship
26113       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26114       consumes:
26115         - application/json
26116         - application/xml
26117       produces:
26118         - application/json
26119         - application/xml
26120       responses:
26121         "default":
26122           description: Response codes found in [response codes](https://wiki.onap.org/).
26123       parameters:
26124         - name: equipment-name
26125           in: path
26126           required: true
26127           type: string
26128           example: __EQUIPMENT-NAME__
26129         - name: interface-name
26130           in: path
26131           description: Name that identifies the physical interface
26132           required: true
26133           type: string
26134           example: __INTERFACE-NAME__
26135         - name: interface-name
26136           in: path
26137           description: Name given to the interface
26138           required: true
26139           type: string
26140           example: __INTERFACE-NAME__
26141         - name: l3-interface-ipv6-address
26142           in: path
26143           description: IP address
26144           required: true
26145           type: string
26146           example: __L3-INTERFACE-IPV6-ADDRESS__
26147   /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}:
26148     get:
26149       tags:
26150         - Network
26151       summary: returns l3-interface-ipv6-address-list
26152       description: returns l3-interface-ipv6-address-list
26153       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26154       produces:
26155         - application/json
26156         - application/xml
26157       responses:
26158         "200":
26159           description: successful operation
26160           schema:
26161               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26162         "default":
26163           description: Response codes found in [response codes](https://wiki.onap.org/).
26164       parameters:
26165         - name: equipment-name
26166           in: path
26167           required: true
26168           type: string
26169           example: __EQUIPMENT-NAME__
26170         - name: interface-name
26171           in: path
26172           description: Name that identifies the physical interface
26173           required: true
26174           type: string
26175           example: __INTERFACE-NAME__
26176         - name: interface-name
26177           in: path
26178           description: Name given to the interface
26179           required: true
26180           type: string
26181           example: __INTERFACE-NAME__
26182         - name: l3-interface-ipv6-address
26183           in: path
26184           description: IP address
26185           required: true
26186           type: string
26187           example: __L3-INTERFACE-IPV6-ADDRESS__
26188         - name: prov-status
26189           in: query
26190           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26191           required: false
26192           type: string
26193         - name: prov-status
26194           in: query
26195           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26196           required: false
26197           type: string
26198         - name: interface-id
26199           in: query
26200           description: ID of interface
26201           required: false
26202           type: string
26203         - name: macaddr
26204           in: query
26205           description: MAC address for the interface
26206           required: false
26207           type: string
26208         - name: network-name
26209           in: query
26210           description: Name of the network
26211           required: false
26212           type: string
26213         - name: vlan-id-inner
26214           in: query
26215           description: Inner VLAN tag
26216           required: false
26217           type: integer
26218           format: int64
26219         - name: neutron-network-id
26220           in: query
26221           description: Neutron network id of the interface that address belongs to
26222           required: false
26223           type: string
26224         - name: neutron-subnet-id
26225           in: query
26226           description: Neutron id of subnet that address belongs to
26227           required: false
26228           type: string
26229     put:
26230       tags:
26231         - Network
26232       summary: create or update an existing l3-interface-ipv6-address-list
26233       description: |
26234         Create or update an existing l3-interface-ipv6-address-list.
26235         #
26236         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26237       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26238       consumes:
26239         - application/json
26240         - application/xml
26241       produces:
26242         - application/json
26243         - application/xml
26244       responses:
26245         "default":
26246           description: Response codes found in [response codes](https://wiki.onap.org/).
26247       parameters:
26248         - name: equipment-name
26249           in: path
26250           required: true
26251           type: string
26252           example: __EQUIPMENT-NAME__
26253         - name: interface-name
26254           in: path
26255           description: Name that identifies the physical interface
26256           required: true
26257           type: string
26258           example: __INTERFACE-NAME__
26259         - name: interface-name
26260           in: path
26261           description: Name given to the interface
26262           required: true
26263           type: string
26264           example: __INTERFACE-NAME__
26265         - name: l3-interface-ipv6-address
26266           in: path
26267           description: IP address
26268           required: true
26269           type: string
26270           example: __L3-INTERFACE-IPV6-ADDRESS__
26271         - name: body
26272           in: body
26273           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26274           required: true
26275           schema:
26276             $ref: "#/definitions/l3-interface-ipv6-address-list"
26277     patch:
26278       tags:
26279         - Network
26280       summary: update an existing l3-interface-ipv6-address-list
26281       description: |
26282         Update an existing l3-interface-ipv6-address-list
26283         #
26284         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26285         The PUT operation will entirely replace an existing object.
26286         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26287         #
26288         Other differences between PUT and PATCH are:
26289         #
26290         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26291         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26292         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26293       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26294       consumes:
26295         - application/json
26296         - application/xml
26297       produces:
26298         - application/json
26299         - application/xml
26300       responses:
26301         "default":
26302           description: Response codes found in [response codes](https://wiki.onap.org/).
26303       parameters:
26304         - name: equipment-name
26305           in: path
26306           required: true
26307           type: string
26308           example: __EQUIPMENT-NAME__
26309         - name: interface-name
26310           in: path
26311           description: Name that identifies the physical interface
26312           required: true
26313           type: string
26314           example: __INTERFACE-NAME__
26315         - name: interface-name
26316           in: path
26317           description: Name given to the interface
26318           required: true
26319           type: string
26320           example: __INTERFACE-NAME__
26321         - name: l3-interface-ipv6-address
26322           in: path
26323           description: IP address
26324           required: true
26325           type: string
26326           example: __L3-INTERFACE-IPV6-ADDRESS__
26327         - name: body
26328           in: body
26329           description: l3-interface-ipv6-address-list object that needs to be created or updated.
26330           required: true
26331           schema:
26332             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26333     delete:
26334       tags:
26335         - Network
26336       summary: delete an existing l3-interface-ipv6-address-list
26337       description: delete an existing l3-interface-ipv6-address-list
26338       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26339       consumes:
26340         - application/json
26341         - application/xml
26342       produces:
26343         - application/json
26344         - application/xml
26345       responses:
26346         "default":
26347           description: Response codes found in [response codes](https://wiki.onap.org/).
26348       parameters:
26349         - name: equipment-name
26350           in: path
26351           required: true
26352           type: string
26353           example: __EQUIPMENT-NAME__
26354         - name: interface-name
26355           in: path
26356           description: Name that identifies the physical interface
26357           required: true
26358           type: string
26359           example: __INTERFACE-NAME__
26360         - name: interface-name
26361           in: path
26362           description: Name given to the interface
26363           required: true
26364           type: string
26365           example: __INTERFACE-NAME__
26366         - name: l3-interface-ipv6-address
26367           in: path
26368           description: IP address
26369           required: true
26370           type: string
26371           example: __L3-INTERFACE-IPV6-ADDRESS__
26372         - name: resource-version
26373           in: query
26374           description: resource-version for concurrency
26375           required: true
26376           type: string
26377   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26378     get:
26379       tags:
26380         - Network
26381       summary: returns l-interface
26382       description: returns l-interface
26383       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26384       produces:
26385         - application/json
26386         - application/xml
26387       responses:
26388         "200":
26389           description: successful operation
26390           schema:
26391               $ref: "#/getDefinitions/l-interface"
26392         "default":
26393           description: Response codes found in [response codes](https://wiki.onap.org/).
26394       parameters:
26395         - name: equipment-name
26396           in: path
26397           required: true
26398           type: string
26399           example: __EQUIPMENT-NAME__
26400         - name: interface-name
26401           in: path
26402           description: Name that identifies the physical interface
26403           required: true
26404           type: string
26405           example: __INTERFACE-NAME__
26406         - name: interface-name
26407           in: path
26408           description: Name given to the interface
26409           required: true
26410           type: string
26411           example: __INTERFACE-NAME__
26412         - name: prov-status
26413           in: query
26414           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26415           required: false
26416           type: string
26417         - name: prov-status
26418           in: query
26419           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26420           required: false
26421           type: string
26422         - name: interface-id
26423           in: query
26424           description: ID of interface
26425           required: false
26426           type: string
26427         - name: macaddr
26428           in: query
26429           description: MAC address for the interface
26430           required: false
26431           type: string
26432         - name: network-name
26433           in: query
26434           description: Name of the network
26435           required: false
26436           type: string
26437     put:
26438       tags:
26439         - Network
26440       summary: create or update an existing l-interface
26441       description: |
26442         Create or update an existing l-interface.
26443         #
26444         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26445       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26446       consumes:
26447         - application/json
26448         - application/xml
26449       produces:
26450         - application/json
26451         - application/xml
26452       responses:
26453         "default":
26454           description: Response codes found in [response codes](https://wiki.onap.org/).
26455       parameters:
26456         - name: equipment-name
26457           in: path
26458           required: true
26459           type: string
26460           example: __EQUIPMENT-NAME__
26461         - name: interface-name
26462           in: path
26463           description: Name that identifies the physical interface
26464           required: true
26465           type: string
26466           example: __INTERFACE-NAME__
26467         - name: interface-name
26468           in: path
26469           description: Name given to the interface
26470           required: true
26471           type: string
26472           example: __INTERFACE-NAME__
26473         - name: body
26474           in: body
26475           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
26476           required: true
26477           schema:
26478             $ref: "#/definitions/l-interface"
26479     patch:
26480       tags:
26481         - Network
26482       summary: update an existing l-interface
26483       description: |
26484         Update an existing l-interface
26485         #
26486         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26487         The PUT operation will entirely replace an existing object.
26488         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26489         #
26490         Other differences between PUT and PATCH are:
26491         #
26492         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26493         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26494         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26495       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26496       consumes:
26497         - application/json
26498         - application/xml
26499       produces:
26500         - application/json
26501         - application/xml
26502       responses:
26503         "default":
26504           description: Response codes found in [response codes](https://wiki.onap.org/).
26505       parameters:
26506         - name: equipment-name
26507           in: path
26508           required: true
26509           type: string
26510           example: __EQUIPMENT-NAME__
26511         - name: interface-name
26512           in: path
26513           description: Name that identifies the physical interface
26514           required: true
26515           type: string
26516           example: __INTERFACE-NAME__
26517         - name: interface-name
26518           in: path
26519           description: Name given to the interface
26520           required: true
26521           type: string
26522           example: __INTERFACE-NAME__
26523         - name: body
26524           in: body
26525           description: l-interface object that needs to be created or updated.
26526           required: true
26527           schema:
26528             $ref: "#/patchDefinitions/l-interface"
26529     delete:
26530       tags:
26531         - Network
26532       summary: delete an existing l-interface
26533       description: delete an existing l-interface
26534       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26535       consumes:
26536         - application/json
26537         - application/xml
26538       produces:
26539         - application/json
26540         - application/xml
26541       responses:
26542         "default":
26543           description: Response codes found in [response codes](https://wiki.onap.org/).
26544       parameters:
26545         - name: equipment-name
26546           in: path
26547           required: true
26548           type: string
26549           example: __EQUIPMENT-NAME__
26550         - name: interface-name
26551           in: path
26552           description: Name that identifies the physical interface
26553           required: true
26554           type: string
26555           example: __INTERFACE-NAME__
26556         - name: interface-name
26557           in: path
26558           description: Name given to the interface
26559           required: true
26560           type: string
26561           example: __INTERFACE-NAME__
26562         - name: resource-version
26563           in: query
26564           description: resource-version for concurrency
26565           required: true
26566           type: string
26567   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
26568     get:
26569       tags:
26570         - Network
26571       summary: returns l-interfaces
26572       description: returns l-interfaces
26573       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
26574       produces:
26575         - application/json
26576         - application/xml
26577       responses:
26578         "200":
26579           description: successful operation
26580           schema:
26581               $ref: "#/getDefinitions/l-interfaces"
26582         "default":
26583           description: Response codes found in [response codes](https://wiki.onap.org/).
26584       parameters:
26585         - name: equipment-name
26586           in: path
26587           required: true
26588           type: string
26589           example: __EQUIPMENT-NAME__
26590         - name: interface-name
26591           in: path
26592           description: Name that identifies the physical interface
26593           required: true
26594           type: string
26595           example: __INTERFACE-NAME__
26596         - name: prov-status
26597           in: query
26598           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26599           required: false
26600           type: string
26601         - name: prov-status
26602           in: query
26603           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26604           required: false
26605           type: string
26606   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
26607     get:
26608       tags:
26609         - Network
26610       summary: returns p-interface
26611       description: returns p-interface
26612       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
26613       produces:
26614         - application/json
26615         - application/xml
26616       responses:
26617         "200":
26618           description: successful operation
26619           schema:
26620               $ref: "#/getDefinitions/p-interface"
26621         "default":
26622           description: Response codes found in [response codes](https://wiki.onap.org/).
26623       parameters:
26624         - name: equipment-name
26625           in: path
26626           required: true
26627           type: string
26628           example: __EQUIPMENT-NAME__
26629         - name: interface-name
26630           in: path
26631           description: Name that identifies the physical interface
26632           required: true
26633           type: string
26634           example: __INTERFACE-NAME__
26635         - name: prov-status
26636           in: query
26637           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26638           required: false
26639           type: string
26640         - name: prov-status
26641           in: query
26642           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26643           required: false
26644           type: string
26645     put:
26646       tags:
26647         - Network
26648       summary: create or update an existing p-interface
26649       description: |
26650         Create or update an existing p-interface.
26651         #
26652         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26653       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
26654       consumes:
26655         - application/json
26656         - application/xml
26657       produces:
26658         - application/json
26659         - application/xml
26660       responses:
26661         "default":
26662           description: Response codes found in [response codes](https://wiki.onap.org/).
26663       parameters:
26664         - name: equipment-name
26665           in: path
26666           required: true
26667           type: string
26668           example: __EQUIPMENT-NAME__
26669         - name: interface-name
26670           in: path
26671           description: Name that identifies the physical interface
26672           required: true
26673           type: string
26674           example: __INTERFACE-NAME__
26675         - name: body
26676           in: body
26677           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
26678           required: true
26679           schema:
26680             $ref: "#/definitions/p-interface"
26681     patch:
26682       tags:
26683         - Network
26684       summary: update an existing p-interface
26685       description: |
26686         Update an existing p-interface
26687         #
26688         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26689         The PUT operation will entirely replace an existing object.
26690         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26691         #
26692         Other differences between PUT and PATCH are:
26693         #
26694         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26695         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26696         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26697       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
26698       consumes:
26699         - application/json
26700         - application/xml
26701       produces:
26702         - application/json
26703         - application/xml
26704       responses:
26705         "default":
26706           description: Response codes found in [response codes](https://wiki.onap.org/).
26707       parameters:
26708         - name: equipment-name
26709           in: path
26710           required: true
26711           type: string
26712           example: __EQUIPMENT-NAME__
26713         - name: interface-name
26714           in: path
26715           description: Name that identifies the physical interface
26716           required: true
26717           type: string
26718           example: __INTERFACE-NAME__
26719         - name: body
26720           in: body
26721           description: p-interface object that needs to be created or updated.
26722           required: true
26723           schema:
26724             $ref: "#/patchDefinitions/p-interface"
26725     delete:
26726       tags:
26727         - Network
26728       summary: delete an existing p-interface
26729       description: delete an existing p-interface
26730       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
26731       consumes:
26732         - application/json
26733         - application/xml
26734       produces:
26735         - application/json
26736         - application/xml
26737       responses:
26738         "default":
26739           description: Response codes found in [response codes](https://wiki.onap.org/).
26740       parameters:
26741         - name: equipment-name
26742           in: path
26743           required: true
26744           type: string
26745           example: __EQUIPMENT-NAME__
26746         - name: interface-name
26747           in: path
26748           description: Name that identifies the physical interface
26749           required: true
26750           type: string
26751           example: __INTERFACE-NAME__
26752         - name: resource-version
26753           in: query
26754           description: resource-version for concurrency
26755           required: true
26756           type: string
26757   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
26758     get:
26759       tags:
26760         - Network
26761       summary: returns p-interfaces
26762       description: returns p-interfaces
26763       operationId: getNetworkVplsPesVplsPePInterfaces
26764       produces:
26765         - application/json
26766         - application/xml
26767       responses:
26768         "200":
26769           description: successful operation
26770           schema:
26771               $ref: "#/getDefinitions/p-interfaces"
26772         "default":
26773           description: Response codes found in [response codes](https://wiki.onap.org/).
26774       parameters:
26775         - name: equipment-name
26776           in: path
26777           required: true
26778           type: string
26779           example: __EQUIPMENT-NAME__
26780         - name: prov-status
26781           in: query
26782           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26783           required: false
26784           type: string
26785   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
26786     put:
26787       tags:
26788         - Network
26789       summary: see node definition for valid relationships
26790       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
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 link aggregate interface
26809           required: true
26810           type: string
26811           example: __INTERFACE-NAME__
26812         - name: body
26813           in: body
26814           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26815           required: true
26816           schema:
26817             $ref: "#/definitions/relationship"
26818     delete:
26819       tags:
26820         - Network
26821       summary: delete an existing relationship
26822       description: delete an existing relationship
26823       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
26824       consumes:
26825         - application/json
26826         - application/xml
26827       produces:
26828         - application/json
26829         - application/xml
26830       responses:
26831         "default":
26832           description: Response codes found in [response codes](https://wiki.onap.org/).
26833       parameters:
26834         - name: equipment-name
26835           in: path
26836           required: true
26837           type: string
26838           example: __EQUIPMENT-NAME__
26839         - name: interface-name
26840           in: path
26841           description: Name that identifies the link aggregate interface
26842           required: true
26843           type: string
26844           example: __INTERFACE-NAME__
26845   /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:
26846     put:
26847       tags:
26848         - Network
26849       summary: see node definition for valid relationships
26850       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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: interface-name
26873           in: path
26874           description: Name given to the interface
26875           required: true
26876           type: string
26877           example: __INTERFACE-NAME__
26878         - name: vlan-interface
26879           in: path
26880           description: String that identifies the interface
26881           required: true
26882           type: string
26883           example: __VLAN-INTERFACE__
26884         - name: body
26885           in: body
26886           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26887           required: true
26888           schema:
26889             $ref: "#/definitions/relationship"
26890     delete:
26891       tags:
26892         - Network
26893       summary: delete an existing relationship
26894       description: delete an existing relationship
26895       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
26896       consumes:
26897         - application/json
26898         - application/xml
26899       produces:
26900         - application/json
26901         - application/xml
26902       responses:
26903         "default":
26904           description: Response codes found in [response codes](https://wiki.onap.org/).
26905       parameters:
26906         - name: equipment-name
26907           in: path
26908           required: true
26909           type: string
26910           example: __EQUIPMENT-NAME__
26911         - name: interface-name
26912           in: path
26913           description: Name that identifies the link aggregate interface
26914           required: true
26915           type: string
26916           example: __INTERFACE-NAME__
26917         - name: interface-name
26918           in: path
26919           description: Name given to the interface
26920           required: true
26921           type: string
26922           example: __INTERFACE-NAME__
26923         - name: vlan-interface
26924           in: path
26925           description: String that identifies the interface
26926           required: true
26927           type: string
26928           example: __VLAN-INTERFACE__
26929   /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:
26930     put:
26931       tags:
26932         - Network
26933       summary: see node definition for valid relationships
26934       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
26935       consumes:
26936         - application/json
26937         - application/xml
26938       produces:
26939         - application/json
26940         - application/xml
26941       responses:
26942         "default":
26943           description: Response codes found in [response codes](https://wiki.onap.org/).
26944       parameters:
26945         - name: equipment-name
26946           in: path
26947           required: true
26948           type: string
26949           example: __EQUIPMENT-NAME__
26950         - name: interface-name
26951           in: path
26952           description: Name that identifies the link aggregate interface
26953           required: true
26954           type: string
26955           example: __INTERFACE-NAME__
26956         - name: interface-name
26957           in: path
26958           description: Name given to the interface
26959           required: true
26960           type: string
26961           example: __INTERFACE-NAME__
26962         - name: vlan-interface
26963           in: path
26964           description: String that identifies the interface
26965           required: true
26966           type: string
26967           example: __VLAN-INTERFACE__
26968         - name: l3-interface-ipv4-address
26969           in: path
26970           description: IP address
26971           required: true
26972           type: string
26973           example: __L3-INTERFACE-IPV4-ADDRESS__
26974         - name: body
26975           in: body
26976           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
26977           required: true
26978           schema:
26979             $ref: "#/definitions/relationship"
26980     delete:
26981       tags:
26982         - Network
26983       summary: delete an existing relationship
26984       description: delete an existing relationship
26985       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
26986       consumes:
26987         - application/json
26988         - application/xml
26989       produces:
26990         - application/json
26991         - application/xml
26992       responses:
26993         "default":
26994           description: Response codes found in [response codes](https://wiki.onap.org/).
26995       parameters:
26996         - name: equipment-name
26997           in: path
26998           required: true
26999           type: string
27000           example: __EQUIPMENT-NAME__
27001         - name: interface-name
27002           in: path
27003           description: Name that identifies the link aggregate interface
27004           required: true
27005           type: string
27006           example: __INTERFACE-NAME__
27007         - name: interface-name
27008           in: path
27009           description: Name given to the interface
27010           required: true
27011           type: string
27012           example: __INTERFACE-NAME__
27013         - name: vlan-interface
27014           in: path
27015           description: String that identifies the interface
27016           required: true
27017           type: string
27018           example: __VLAN-INTERFACE__
27019         - name: l3-interface-ipv4-address
27020           in: path
27021           description: IP address
27022           required: true
27023           type: string
27024           example: __L3-INTERFACE-IPV4-ADDRESS__
27025   /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}:
27026     get:
27027       tags:
27028         - Network
27029       summary: returns l3-interface-ipv4-address-list
27030       description: returns l3-interface-ipv4-address-list
27031       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27032       produces:
27033         - application/json
27034         - application/xml
27035       responses:
27036         "200":
27037           description: successful operation
27038           schema:
27039               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27040         "default":
27041           description: Response codes found in [response codes](https://wiki.onap.org/).
27042       parameters:
27043         - name: equipment-name
27044           in: path
27045           required: true
27046           type: string
27047           example: __EQUIPMENT-NAME__
27048         - name: interface-name
27049           in: path
27050           description: Name that identifies the link aggregate interface
27051           required: true
27052           type: string
27053           example: __INTERFACE-NAME__
27054         - name: interface-name
27055           in: path
27056           description: Name given to the interface
27057           required: true
27058           type: string
27059           example: __INTERFACE-NAME__
27060         - name: vlan-interface
27061           in: path
27062           description: String that identifies the interface
27063           required: true
27064           type: string
27065           example: __VLAN-INTERFACE__
27066         - name: l3-interface-ipv4-address
27067           in: path
27068           description: IP address
27069           required: true
27070           type: string
27071           example: __L3-INTERFACE-IPV4-ADDRESS__
27072         - name: prov-status
27073           in: query
27074           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27075           required: false
27076           type: string
27077         - name: interface-id
27078           in: query
27079           description: ID of interface
27080           required: false
27081           type: string
27082         - name: interface-role
27083           in: query
27084           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27085           required: false
27086           type: string
27087         - name: interface-id
27088           in: query
27089           description: ID of interface
27090           required: false
27091           type: string
27092         - name: macaddr
27093           in: query
27094           description: MAC address for the interface
27095           required: false
27096           type: string
27097         - name: network-name
27098           in: query
27099           description: Name of the network
27100           required: false
27101           type: string
27102         - name: vlan-id-inner
27103           in: query
27104           description: Inner VLAN tag
27105           required: false
27106           type: integer
27107           format: int64
27108         - name: vpn-key
27109           in: query
27110           description: This indicates the customers VPN ID associated with this vlan
27111           required: false
27112           type: string
27113         - name: vlan-id-inner
27114           in: query
27115           description: Inner VLAN tag
27116           required: false
27117           type: integer
27118           format: int64
27119         - name: neutron-network-id
27120           in: query
27121           description: Neutron network id of the interface that address belongs to
27122           required: false
27123           type: string
27124         - name: neutron-subnet-id
27125           in: query
27126           description: Neutron id of subnet that address belongs to
27127           required: false
27128           type: string
27129     put:
27130       tags:
27131         - Network
27132       summary: create or update an existing l3-interface-ipv4-address-list
27133       description: |
27134         Create or update an existing l3-interface-ipv4-address-list.
27135         #
27136         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27137       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27138       consumes:
27139         - application/json
27140         - application/xml
27141       produces:
27142         - application/json
27143         - application/xml
27144       responses:
27145         "default":
27146           description: Response codes found in [response codes](https://wiki.onap.org/).
27147       parameters:
27148         - name: equipment-name
27149           in: path
27150           required: true
27151           type: string
27152           example: __EQUIPMENT-NAME__
27153         - name: interface-name
27154           in: path
27155           description: Name that identifies the link aggregate interface
27156           required: true
27157           type: string
27158           example: __INTERFACE-NAME__
27159         - name: interface-name
27160           in: path
27161           description: Name given to the interface
27162           required: true
27163           type: string
27164           example: __INTERFACE-NAME__
27165         - name: vlan-interface
27166           in: path
27167           description: String that identifies the interface
27168           required: true
27169           type: string
27170           example: __VLAN-INTERFACE__
27171         - name: l3-interface-ipv4-address
27172           in: path
27173           description: IP address
27174           required: true
27175           type: string
27176           example: __L3-INTERFACE-IPV4-ADDRESS__
27177         - name: body
27178           in: body
27179           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27180           required: true
27181           schema:
27182             $ref: "#/definitions/l3-interface-ipv4-address-list"
27183     patch:
27184       tags:
27185         - Network
27186       summary: update an existing l3-interface-ipv4-address-list
27187       description: |
27188         Update an existing l3-interface-ipv4-address-list
27189         #
27190         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27191         The PUT operation will entirely replace an existing object.
27192         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27193         #
27194         Other differences between PUT and PATCH are:
27195         #
27196         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27197         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27198         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27199       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27200       consumes:
27201         - application/json
27202         - application/xml
27203       produces:
27204         - application/json
27205         - application/xml
27206       responses:
27207         "default":
27208           description: Response codes found in [response codes](https://wiki.onap.org/).
27209       parameters:
27210         - name: equipment-name
27211           in: path
27212           required: true
27213           type: string
27214           example: __EQUIPMENT-NAME__
27215         - name: interface-name
27216           in: path
27217           description: Name that identifies the link aggregate interface
27218           required: true
27219           type: string
27220           example: __INTERFACE-NAME__
27221         - name: interface-name
27222           in: path
27223           description: Name given to the interface
27224           required: true
27225           type: string
27226           example: __INTERFACE-NAME__
27227         - name: vlan-interface
27228           in: path
27229           description: String that identifies the interface
27230           required: true
27231           type: string
27232           example: __VLAN-INTERFACE__
27233         - name: l3-interface-ipv4-address
27234           in: path
27235           description: IP address
27236           required: true
27237           type: string
27238           example: __L3-INTERFACE-IPV4-ADDRESS__
27239         - name: body
27240           in: body
27241           description: l3-interface-ipv4-address-list object that needs to be created or updated.
27242           required: true
27243           schema:
27244             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27245     delete:
27246       tags:
27247         - Network
27248       summary: delete an existing l3-interface-ipv4-address-list
27249       description: delete an existing l3-interface-ipv4-address-list
27250       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27251       consumes:
27252         - application/json
27253         - application/xml
27254       produces:
27255         - application/json
27256         - application/xml
27257       responses:
27258         "default":
27259           description: Response codes found in [response codes](https://wiki.onap.org/).
27260       parameters:
27261         - name: equipment-name
27262           in: path
27263           required: true
27264           type: string
27265           example: __EQUIPMENT-NAME__
27266         - name: interface-name
27267           in: path
27268           description: Name that identifies the link aggregate interface
27269           required: true
27270           type: string
27271           example: __INTERFACE-NAME__
27272         - name: interface-name
27273           in: path
27274           description: Name given to the interface
27275           required: true
27276           type: string
27277           example: __INTERFACE-NAME__
27278         - name: vlan-interface
27279           in: path
27280           description: String that identifies the interface
27281           required: true
27282           type: string
27283           example: __VLAN-INTERFACE__
27284         - name: l3-interface-ipv4-address
27285           in: path
27286           description: IP address
27287           required: true
27288           type: string
27289           example: __L3-INTERFACE-IPV4-ADDRESS__
27290         - name: resource-version
27291           in: query
27292           description: resource-version for concurrency
27293           required: true
27294           type: string
27295   /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:
27296     put:
27297       tags:
27298         - Network
27299       summary: see node definition for valid relationships
27300       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27301       consumes:
27302         - application/json
27303         - application/xml
27304       produces:
27305         - application/json
27306         - application/xml
27307       responses:
27308         "default":
27309           description: Response codes found in [response codes](https://wiki.onap.org/).
27310       parameters:
27311         - name: equipment-name
27312           in: path
27313           required: true
27314           type: string
27315           example: __EQUIPMENT-NAME__
27316         - name: interface-name
27317           in: path
27318           description: Name that identifies the link aggregate interface
27319           required: true
27320           type: string
27321           example: __INTERFACE-NAME__
27322         - name: interface-name
27323           in: path
27324           description: Name given to the interface
27325           required: true
27326           type: string
27327           example: __INTERFACE-NAME__
27328         - name: vlan-interface
27329           in: path
27330           description: String that identifies the interface
27331           required: true
27332           type: string
27333           example: __VLAN-INTERFACE__
27334         - name: l3-interface-ipv6-address
27335           in: path
27336           description: IP address
27337           required: true
27338           type: string
27339           example: __L3-INTERFACE-IPV6-ADDRESS__
27340         - name: body
27341           in: body
27342           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27343           required: true
27344           schema:
27345             $ref: "#/definitions/relationship"
27346     delete:
27347       tags:
27348         - Network
27349       summary: delete an existing relationship
27350       description: delete an existing relationship
27351       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27352       consumes:
27353         - application/json
27354         - application/xml
27355       produces:
27356         - application/json
27357         - application/xml
27358       responses:
27359         "default":
27360           description: Response codes found in [response codes](https://wiki.onap.org/).
27361       parameters:
27362         - name: equipment-name
27363           in: path
27364           required: true
27365           type: string
27366           example: __EQUIPMENT-NAME__
27367         - name: interface-name
27368           in: path
27369           description: Name that identifies the link aggregate interface
27370           required: true
27371           type: string
27372           example: __INTERFACE-NAME__
27373         - name: interface-name
27374           in: path
27375           description: Name given to the interface
27376           required: true
27377           type: string
27378           example: __INTERFACE-NAME__
27379         - name: vlan-interface
27380           in: path
27381           description: String that identifies the interface
27382           required: true
27383           type: string
27384           example: __VLAN-INTERFACE__
27385         - name: l3-interface-ipv6-address
27386           in: path
27387           description: IP address
27388           required: true
27389           type: string
27390           example: __L3-INTERFACE-IPV6-ADDRESS__
27391   /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}:
27392     get:
27393       tags:
27394         - Network
27395       summary: returns l3-interface-ipv6-address-list
27396       description: returns l3-interface-ipv6-address-list
27397       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27398       produces:
27399         - application/json
27400         - application/xml
27401       responses:
27402         "200":
27403           description: successful operation
27404           schema:
27405               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27406         "default":
27407           description: Response codes found in [response codes](https://wiki.onap.org/).
27408       parameters:
27409         - name: equipment-name
27410           in: path
27411           required: true
27412           type: string
27413           example: __EQUIPMENT-NAME__
27414         - name: interface-name
27415           in: path
27416           description: Name that identifies the link aggregate interface
27417           required: true
27418           type: string
27419           example: __INTERFACE-NAME__
27420         - name: interface-name
27421           in: path
27422           description: Name given to the interface
27423           required: true
27424           type: string
27425           example: __INTERFACE-NAME__
27426         - name: vlan-interface
27427           in: path
27428           description: String that identifies the interface
27429           required: true
27430           type: string
27431           example: __VLAN-INTERFACE__
27432         - name: l3-interface-ipv6-address
27433           in: path
27434           description: IP address
27435           required: true
27436           type: string
27437           example: __L3-INTERFACE-IPV6-ADDRESS__
27438         - name: prov-status
27439           in: query
27440           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27441           required: false
27442           type: string
27443         - name: interface-id
27444           in: query
27445           description: ID of interface
27446           required: false
27447           type: string
27448         - name: interface-role
27449           in: query
27450           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27451           required: false
27452           type: string
27453         - name: interface-id
27454           in: query
27455           description: ID of interface
27456           required: false
27457           type: string
27458         - name: macaddr
27459           in: query
27460           description: MAC address for the interface
27461           required: false
27462           type: string
27463         - name: network-name
27464           in: query
27465           description: Name of the network
27466           required: false
27467           type: string
27468         - name: vlan-id-inner
27469           in: query
27470           description: Inner VLAN tag
27471           required: false
27472           type: integer
27473           format: int64
27474         - name: vpn-key
27475           in: query
27476           description: This indicates the customers VPN ID associated with this vlan
27477           required: false
27478           type: string
27479         - name: vlan-id-inner
27480           in: query
27481           description: Inner VLAN tag
27482           required: false
27483           type: integer
27484           format: int64
27485         - name: neutron-network-id
27486           in: query
27487           description: Neutron network id of the interface that address belongs to
27488           required: false
27489           type: string
27490         - name: neutron-subnet-id
27491           in: query
27492           description: Neutron id of subnet that address belongs to
27493           required: false
27494           type: string
27495     put:
27496       tags:
27497         - Network
27498       summary: create or update an existing l3-interface-ipv6-address-list
27499       description: |
27500         Create or update an existing l3-interface-ipv6-address-list.
27501         #
27502         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27503       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27504       consumes:
27505         - application/json
27506         - application/xml
27507       produces:
27508         - application/json
27509         - application/xml
27510       responses:
27511         "default":
27512           description: Response codes found in [response codes](https://wiki.onap.org/).
27513       parameters:
27514         - name: equipment-name
27515           in: path
27516           required: true
27517           type: string
27518           example: __EQUIPMENT-NAME__
27519         - name: interface-name
27520           in: path
27521           description: Name that identifies the link aggregate interface
27522           required: true
27523           type: string
27524           example: __INTERFACE-NAME__
27525         - name: interface-name
27526           in: path
27527           description: Name given to the interface
27528           required: true
27529           type: string
27530           example: __INTERFACE-NAME__
27531         - name: vlan-interface
27532           in: path
27533           description: String that identifies the interface
27534           required: true
27535           type: string
27536           example: __VLAN-INTERFACE__
27537         - name: l3-interface-ipv6-address
27538           in: path
27539           description: IP address
27540           required: true
27541           type: string
27542           example: __L3-INTERFACE-IPV6-ADDRESS__
27543         - name: body
27544           in: body
27545           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27546           required: true
27547           schema:
27548             $ref: "#/definitions/l3-interface-ipv6-address-list"
27549     patch:
27550       tags:
27551         - Network
27552       summary: update an existing l3-interface-ipv6-address-list
27553       description: |
27554         Update an existing l3-interface-ipv6-address-list
27555         #
27556         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27557         The PUT operation will entirely replace an existing object.
27558         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27559         #
27560         Other differences between PUT and PATCH are:
27561         #
27562         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27563         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27564         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27565       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27566       consumes:
27567         - application/json
27568         - application/xml
27569       produces:
27570         - application/json
27571         - application/xml
27572       responses:
27573         "default":
27574           description: Response codes found in [response codes](https://wiki.onap.org/).
27575       parameters:
27576         - name: equipment-name
27577           in: path
27578           required: true
27579           type: string
27580           example: __EQUIPMENT-NAME__
27581         - name: interface-name
27582           in: path
27583           description: Name that identifies the link aggregate interface
27584           required: true
27585           type: string
27586           example: __INTERFACE-NAME__
27587         - name: interface-name
27588           in: path
27589           description: Name given to the interface
27590           required: true
27591           type: string
27592           example: __INTERFACE-NAME__
27593         - name: vlan-interface
27594           in: path
27595           description: String that identifies the interface
27596           required: true
27597           type: string
27598           example: __VLAN-INTERFACE__
27599         - name: l3-interface-ipv6-address
27600           in: path
27601           description: IP address
27602           required: true
27603           type: string
27604           example: __L3-INTERFACE-IPV6-ADDRESS__
27605         - name: body
27606           in: body
27607           description: l3-interface-ipv6-address-list object that needs to be created or updated.
27608           required: true
27609           schema:
27610             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27611     delete:
27612       tags:
27613         - Network
27614       summary: delete an existing l3-interface-ipv6-address-list
27615       description: delete an existing l3-interface-ipv6-address-list
27616       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27617       consumes:
27618         - application/json
27619         - application/xml
27620       produces:
27621         - application/json
27622         - application/xml
27623       responses:
27624         "default":
27625           description: Response codes found in [response codes](https://wiki.onap.org/).
27626       parameters:
27627         - name: equipment-name
27628           in: path
27629           required: true
27630           type: string
27631           example: __EQUIPMENT-NAME__
27632         - name: interface-name
27633           in: path
27634           description: Name that identifies the link aggregate interface
27635           required: true
27636           type: string
27637           example: __INTERFACE-NAME__
27638         - name: interface-name
27639           in: path
27640           description: Name given to the interface
27641           required: true
27642           type: string
27643           example: __INTERFACE-NAME__
27644         - name: vlan-interface
27645           in: path
27646           description: String that identifies the interface
27647           required: true
27648           type: string
27649           example: __VLAN-INTERFACE__
27650         - name: l3-interface-ipv6-address
27651           in: path
27652           description: IP address
27653           required: true
27654           type: string
27655           example: __L3-INTERFACE-IPV6-ADDRESS__
27656         - name: resource-version
27657           in: query
27658           description: resource-version for concurrency
27659           required: true
27660           type: string
27661   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
27662     get:
27663       tags:
27664         - Network
27665       summary: returns vlan
27666       description: returns vlan
27667       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27668       produces:
27669         - application/json
27670         - application/xml
27671       responses:
27672         "200":
27673           description: successful operation
27674           schema:
27675               $ref: "#/getDefinitions/vlan"
27676         "default":
27677           description: Response codes found in [response codes](https://wiki.onap.org/).
27678       parameters:
27679         - name: equipment-name
27680           in: path
27681           required: true
27682           type: string
27683           example: __EQUIPMENT-NAME__
27684         - name: interface-name
27685           in: path
27686           description: Name that identifies the link aggregate interface
27687           required: true
27688           type: string
27689           example: __INTERFACE-NAME__
27690         - name: interface-name
27691           in: path
27692           description: Name given to the interface
27693           required: true
27694           type: string
27695           example: __INTERFACE-NAME__
27696         - name: vlan-interface
27697           in: path
27698           description: String that identifies the interface
27699           required: true
27700           type: string
27701           example: __VLAN-INTERFACE__
27702         - name: prov-status
27703           in: query
27704           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27705           required: false
27706           type: string
27707         - name: interface-id
27708           in: query
27709           description: ID of interface
27710           required: false
27711           type: string
27712         - name: interface-role
27713           in: query
27714           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27715           required: false
27716           type: string
27717         - name: interface-id
27718           in: query
27719           description: ID of interface
27720           required: false
27721           type: string
27722         - name: macaddr
27723           in: query
27724           description: MAC address for the interface
27725           required: false
27726           type: string
27727         - name: network-name
27728           in: query
27729           description: Name of the network
27730           required: false
27731           type: string
27732         - name: vlan-id-inner
27733           in: query
27734           description: Inner VLAN tag
27735           required: false
27736           type: integer
27737           format: int64
27738         - name: vpn-key
27739           in: query
27740           description: This indicates the customers VPN ID associated with this vlan
27741           required: false
27742           type: string
27743     put:
27744       tags:
27745         - Network
27746       summary: create or update an existing vlan
27747       description: |
27748         Create or update an existing vlan.
27749         #
27750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27751       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27752       consumes:
27753         - application/json
27754         - application/xml
27755       produces:
27756         - application/json
27757         - application/xml
27758       responses:
27759         "default":
27760           description: Response codes found in [response codes](https://wiki.onap.org/).
27761       parameters:
27762         - name: equipment-name
27763           in: path
27764           required: true
27765           type: string
27766           example: __EQUIPMENT-NAME__
27767         - name: interface-name
27768           in: path
27769           description: Name that identifies the link aggregate interface
27770           required: true
27771           type: string
27772           example: __INTERFACE-NAME__
27773         - name: interface-name
27774           in: path
27775           description: Name given to the interface
27776           required: true
27777           type: string
27778           example: __INTERFACE-NAME__
27779         - name: vlan-interface
27780           in: path
27781           description: String that identifies the interface
27782           required: true
27783           type: string
27784           example: __VLAN-INTERFACE__
27785         - name: body
27786           in: body
27787           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27788           required: true
27789           schema:
27790             $ref: "#/definitions/vlan"
27791     patch:
27792       tags:
27793         - Network
27794       summary: update an existing vlan
27795       description: |
27796         Update an existing vlan
27797         #
27798         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27799         The PUT operation will entirely replace an existing object.
27800         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27801         #
27802         Other differences between PUT and PATCH are:
27803         #
27804         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27805         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27806         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27807       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27808       consumes:
27809         - application/json
27810         - application/xml
27811       produces:
27812         - application/json
27813         - application/xml
27814       responses:
27815         "default":
27816           description: Response codes found in [response codes](https://wiki.onap.org/).
27817       parameters:
27818         - name: equipment-name
27819           in: path
27820           required: true
27821           type: string
27822           example: __EQUIPMENT-NAME__
27823         - name: interface-name
27824           in: path
27825           description: Name that identifies the link aggregate interface
27826           required: true
27827           type: string
27828           example: __INTERFACE-NAME__
27829         - name: interface-name
27830           in: path
27831           description: Name given to the interface
27832           required: true
27833           type: string
27834           example: __INTERFACE-NAME__
27835         - name: vlan-interface
27836           in: path
27837           description: String that identifies the interface
27838           required: true
27839           type: string
27840           example: __VLAN-INTERFACE__
27841         - name: body
27842           in: body
27843           description: vlan object that needs to be created or updated.
27844           required: true
27845           schema:
27846             $ref: "#/patchDefinitions/vlan"
27847     delete:
27848       tags:
27849         - Network
27850       summary: delete an existing vlan
27851       description: delete an existing vlan
27852       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27853       consumes:
27854         - application/json
27855         - application/xml
27856       produces:
27857         - application/json
27858         - application/xml
27859       responses:
27860         "default":
27861           description: Response codes found in [response codes](https://wiki.onap.org/).
27862       parameters:
27863         - name: equipment-name
27864           in: path
27865           required: true
27866           type: string
27867           example: __EQUIPMENT-NAME__
27868         - name: interface-name
27869           in: path
27870           description: Name that identifies the link aggregate interface
27871           required: true
27872           type: string
27873           example: __INTERFACE-NAME__
27874         - name: interface-name
27875           in: path
27876           description: Name given to the interface
27877           required: true
27878           type: string
27879           example: __INTERFACE-NAME__
27880         - name: vlan-interface
27881           in: path
27882           description: String that identifies the interface
27883           required: true
27884           type: string
27885           example: __VLAN-INTERFACE__
27886         - name: resource-version
27887           in: query
27888           description: resource-version for concurrency
27889           required: true
27890           type: string
27891   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
27892     get:
27893       tags:
27894         - Network
27895       summary: returns vlans
27896       description: returns vlans
27897       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
27898       produces:
27899         - application/json
27900         - application/xml
27901       responses:
27902         "200":
27903           description: successful operation
27904           schema:
27905               $ref: "#/getDefinitions/vlans"
27906         "default":
27907           description: Response codes found in [response codes](https://wiki.onap.org/).
27908       parameters:
27909         - name: equipment-name
27910           in: path
27911           required: true
27912           type: string
27913           example: __EQUIPMENT-NAME__
27914         - name: interface-name
27915           in: path
27916           description: Name that identifies the link aggregate interface
27917           required: true
27918           type: string
27919           example: __INTERFACE-NAME__
27920         - name: interface-name
27921           in: path
27922           description: Name given to the interface
27923           required: true
27924           type: string
27925           example: __INTERFACE-NAME__
27926         - name: prov-status
27927           in: query
27928           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27929           required: false
27930           type: string
27931         - name: interface-id
27932           in: query
27933           description: ID of interface
27934           required: false
27935           type: string
27936         - name: interface-role
27937           in: query
27938           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27939           required: false
27940           type: string
27941         - name: interface-id
27942           in: query
27943           description: ID of interface
27944           required: false
27945           type: string
27946         - name: macaddr
27947           in: query
27948           description: MAC address for the interface
27949           required: false
27950           type: string
27951         - name: network-name
27952           in: query
27953           description: Name of the network
27954           required: false
27955           type: string
27956   /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:
27957     put:
27958       tags:
27959         - Network
27960       summary: see node definition for valid relationships
27961       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
27962       consumes:
27963         - application/json
27964         - application/xml
27965       produces:
27966         - application/json
27967         - application/xml
27968       responses:
27969         "default":
27970           description: Response codes found in [response codes](https://wiki.onap.org/).
27971       parameters:
27972         - name: equipment-name
27973           in: path
27974           required: true
27975           type: string
27976           example: __EQUIPMENT-NAME__
27977         - name: interface-name
27978           in: path
27979           description: Name that identifies the link aggregate interface
27980           required: true
27981           type: string
27982           example: __INTERFACE-NAME__
27983         - name: interface-name
27984           in: path
27985           description: Name given to the interface
27986           required: true
27987           type: string
27988           example: __INTERFACE-NAME__
27989         - name: pci-id
27990           in: path
27991           description: PCI ID used to identify the sriov-vf
27992           required: true
27993           type: string
27994           example: __PCI-ID__
27995         - name: body
27996           in: body
27997           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
27998           required: true
27999           schema:
28000             $ref: "#/definitions/relationship"
28001     delete:
28002       tags:
28003         - Network
28004       summary: delete an existing relationship
28005       description: delete an existing relationship
28006       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28007       consumes:
28008         - application/json
28009         - application/xml
28010       produces:
28011         - application/json
28012         - application/xml
28013       responses:
28014         "default":
28015           description: Response codes found in [response codes](https://wiki.onap.org/).
28016       parameters:
28017         - name: equipment-name
28018           in: path
28019           required: true
28020           type: string
28021           example: __EQUIPMENT-NAME__
28022         - name: interface-name
28023           in: path
28024           description: Name that identifies the link aggregate interface
28025           required: true
28026           type: string
28027           example: __INTERFACE-NAME__
28028         - name: interface-name
28029           in: path
28030           description: Name given to the interface
28031           required: true
28032           type: string
28033           example: __INTERFACE-NAME__
28034         - name: pci-id
28035           in: path
28036           description: PCI ID used to identify the sriov-vf
28037           required: true
28038           type: string
28039           example: __PCI-ID__
28040   /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}:
28041     get:
28042       tags:
28043         - Network
28044       summary: returns sriov-vf
28045       description: returns sriov-vf
28046       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28047       produces:
28048         - application/json
28049         - application/xml
28050       responses:
28051         "200":
28052           description: successful operation
28053           schema:
28054               $ref: "#/getDefinitions/sriov-vf"
28055         "default":
28056           description: Response codes found in [response codes](https://wiki.onap.org/).
28057       parameters:
28058         - name: equipment-name
28059           in: path
28060           required: true
28061           type: string
28062           example: __EQUIPMENT-NAME__
28063         - name: interface-name
28064           in: path
28065           description: Name that identifies the link aggregate interface
28066           required: true
28067           type: string
28068           example: __INTERFACE-NAME__
28069         - name: interface-name
28070           in: path
28071           description: Name given to the interface
28072           required: true
28073           type: string
28074           example: __INTERFACE-NAME__
28075         - name: pci-id
28076           in: path
28077           description: PCI ID used to identify the sriov-vf
28078           required: true
28079           type: string
28080           example: __PCI-ID__
28081         - name: prov-status
28082           in: query
28083           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28084           required: false
28085           type: string
28086         - name: interface-id
28087           in: query
28088           description: ID of interface
28089           required: false
28090           type: string
28091         - name: interface-role
28092           in: query
28093           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28094           required: false
28095           type: string
28096         - name: interface-id
28097           in: query
28098           description: ID of interface
28099           required: false
28100           type: string
28101         - name: macaddr
28102           in: query
28103           description: MAC address for the interface
28104           required: false
28105           type: string
28106         - name: network-name
28107           in: query
28108           description: Name of the network
28109           required: false
28110           type: string
28111         - name: vf-vlan-filter
28112           in: query
28113           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
28114           required: false
28115           type: string
28116         - name: vf-mac-filter
28117           in: query
28118           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
28119           required: false
28120           type: string
28121         - name: vf-vlan-strip
28122           in: query
28123           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
28124           required: false
28125           type: boolean
28126         - name: neutron-network-id
28127           in: query
28128           description: Neutron network id of the interface
28129           required: false
28130           type: string
28131     put:
28132       tags:
28133         - Network
28134       summary: create or update an existing sriov-vf
28135       description: |
28136         Create or update an existing sriov-vf.
28137         #
28138         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28139       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28140       consumes:
28141         - application/json
28142         - application/xml
28143       produces:
28144         - application/json
28145         - application/xml
28146       responses:
28147         "default":
28148           description: Response codes found in [response codes](https://wiki.onap.org/).
28149       parameters:
28150         - name: equipment-name
28151           in: path
28152           required: true
28153           type: string
28154           example: __EQUIPMENT-NAME__
28155         - name: interface-name
28156           in: path
28157           description: Name that identifies the link aggregate interface
28158           required: true
28159           type: string
28160           example: __INTERFACE-NAME__
28161         - name: interface-name
28162           in: path
28163           description: Name given to the interface
28164           required: true
28165           type: string
28166           example: __INTERFACE-NAME__
28167         - name: pci-id
28168           in: path
28169           description: PCI ID used to identify the sriov-vf
28170           required: true
28171           type: string
28172           example: __PCI-ID__
28173         - name: body
28174           in: body
28175           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28176           required: true
28177           schema:
28178             $ref: "#/definitions/sriov-vf"
28179     patch:
28180       tags:
28181         - Network
28182       summary: update an existing sriov-vf
28183       description: |
28184         Update an existing sriov-vf
28185         #
28186         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28187         The PUT operation will entirely replace an existing object.
28188         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28189         #
28190         Other differences between PUT and PATCH are:
28191         #
28192         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28193         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28194         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28195       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28196       consumes:
28197         - application/json
28198         - application/xml
28199       produces:
28200         - application/json
28201         - application/xml
28202       responses:
28203         "default":
28204           description: Response codes found in [response codes](https://wiki.onap.org/).
28205       parameters:
28206         - name: equipment-name
28207           in: path
28208           required: true
28209           type: string
28210           example: __EQUIPMENT-NAME__
28211         - name: interface-name
28212           in: path
28213           description: Name that identifies the link aggregate interface
28214           required: true
28215           type: string
28216           example: __INTERFACE-NAME__
28217         - name: interface-name
28218           in: path
28219           description: Name given to the interface
28220           required: true
28221           type: string
28222           example: __INTERFACE-NAME__
28223         - name: pci-id
28224           in: path
28225           description: PCI ID used to identify the sriov-vf
28226           required: true
28227           type: string
28228           example: __PCI-ID__
28229         - name: body
28230           in: body
28231           description: sriov-vf object that needs to be created or updated.
28232           required: true
28233           schema:
28234             $ref: "#/patchDefinitions/sriov-vf"
28235     delete:
28236       tags:
28237         - Network
28238       summary: delete an existing sriov-vf
28239       description: delete an existing sriov-vf
28240       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28241       consumes:
28242         - application/json
28243         - application/xml
28244       produces:
28245         - application/json
28246         - application/xml
28247       responses:
28248         "default":
28249           description: Response codes found in [response codes](https://wiki.onap.org/).
28250       parameters:
28251         - name: equipment-name
28252           in: path
28253           required: true
28254           type: string
28255           example: __EQUIPMENT-NAME__
28256         - name: interface-name
28257           in: path
28258           description: Name that identifies the link aggregate interface
28259           required: true
28260           type: string
28261           example: __INTERFACE-NAME__
28262         - name: interface-name
28263           in: path
28264           description: Name given to the interface
28265           required: true
28266           type: string
28267           example: __INTERFACE-NAME__
28268         - name: pci-id
28269           in: path
28270           description: PCI ID used to identify the sriov-vf
28271           required: true
28272           type: string
28273           example: __PCI-ID__
28274         - name: resource-version
28275           in: query
28276           description: resource-version for concurrency
28277           required: true
28278           type: string
28279   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28280     get:
28281       tags:
28282         - Network
28283       summary: returns sriov-vfs
28284       description: returns sriov-vfs
28285       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
28286       produces:
28287         - application/json
28288         - application/xml
28289       responses:
28290         "200":
28291           description: successful operation
28292           schema:
28293               $ref: "#/getDefinitions/sriov-vfs"
28294         "default":
28295           description: Response codes found in [response codes](https://wiki.onap.org/).
28296       parameters:
28297         - name: equipment-name
28298           in: path
28299           required: true
28300           type: string
28301           example: __EQUIPMENT-NAME__
28302         - name: interface-name
28303           in: path
28304           description: Name that identifies the link aggregate interface
28305           required: true
28306           type: string
28307           example: __INTERFACE-NAME__
28308         - name: interface-name
28309           in: path
28310           description: Name given to the interface
28311           required: true
28312           type: string
28313           example: __INTERFACE-NAME__
28314         - name: prov-status
28315           in: query
28316           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28317           required: false
28318           type: string
28319         - name: interface-id
28320           in: query
28321           description: ID of interface
28322           required: false
28323           type: string
28324         - name: interface-role
28325           in: query
28326           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28327           required: false
28328           type: string
28329         - name: interface-id
28330           in: query
28331           description: ID of interface
28332           required: false
28333           type: string
28334         - name: macaddr
28335           in: query
28336           description: MAC address for the interface
28337           required: false
28338           type: string
28339         - name: network-name
28340           in: query
28341           description: Name of the network
28342           required: false
28343           type: string
28344   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28345     put:
28346       tags:
28347         - Network
28348       summary: see node definition for valid relationships
28349       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28350       consumes:
28351         - application/json
28352         - application/xml
28353       produces:
28354         - application/json
28355         - application/xml
28356       responses:
28357         "default":
28358           description: Response codes found in [response codes](https://wiki.onap.org/).
28359       parameters:
28360         - name: equipment-name
28361           in: path
28362           required: true
28363           type: string
28364           example: __EQUIPMENT-NAME__
28365         - name: interface-name
28366           in: path
28367           description: Name that identifies the link aggregate interface
28368           required: true
28369           type: string
28370           example: __INTERFACE-NAME__
28371         - name: interface-name
28372           in: path
28373           description: Name given to the interface
28374           required: true
28375           type: string
28376           example: __INTERFACE-NAME__
28377         - name: body
28378           in: body
28379           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
28380           required: true
28381           schema:
28382             $ref: "#/definitions/relationship"
28383     delete:
28384       tags:
28385         - Network
28386       summary: delete an existing relationship
28387       description: delete an existing relationship
28388       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28389       consumes:
28390         - application/json
28391         - application/xml
28392       produces:
28393         - application/json
28394         - application/xml
28395       responses:
28396         "default":
28397           description: Response codes found in [response codes](https://wiki.onap.org/).
28398       parameters:
28399         - name: equipment-name
28400           in: path
28401           required: true
28402           type: string
28403           example: __EQUIPMENT-NAME__
28404         - name: interface-name
28405           in: path
28406           description: Name that identifies the link aggregate interface
28407           required: true
28408           type: string
28409           example: __INTERFACE-NAME__
28410         - name: interface-name
28411           in: path
28412           description: Name given to the interface
28413           required: true
28414           type: string
28415           example: __INTERFACE-NAME__
28416   /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:
28417     put:
28418       tags:
28419         - Network
28420       summary: see node definition for valid relationships
28421       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28422       consumes:
28423         - application/json
28424         - application/xml
28425       produces:
28426         - application/json
28427         - application/xml
28428       responses:
28429         "default":
28430           description: Response codes found in [response codes](https://wiki.onap.org/).
28431       parameters:
28432         - name: equipment-name
28433           in: path
28434           required: true
28435           type: string
28436           example: __EQUIPMENT-NAME__
28437         - name: interface-name
28438           in: path
28439           description: Name that identifies the link aggregate interface
28440           required: true
28441           type: string
28442           example: __INTERFACE-NAME__
28443         - name: interface-name
28444           in: path
28445           description: Name given to the interface
28446           required: true
28447           type: string
28448           example: __INTERFACE-NAME__
28449         - name: l3-interface-ipv4-address
28450           in: path
28451           description: IP address
28452           required: true
28453           type: string
28454           example: __L3-INTERFACE-IPV4-ADDRESS__
28455         - name: body
28456           in: body
28457           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28458           required: true
28459           schema:
28460             $ref: "#/definitions/relationship"
28461     delete:
28462       tags:
28463         - Network
28464       summary: delete an existing relationship
28465       description: delete an existing relationship
28466       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28467       consumes:
28468         - application/json
28469         - application/xml
28470       produces:
28471         - application/json
28472         - application/xml
28473       responses:
28474         "default":
28475           description: Response codes found in [response codes](https://wiki.onap.org/).
28476       parameters:
28477         - name: equipment-name
28478           in: path
28479           required: true
28480           type: string
28481           example: __EQUIPMENT-NAME__
28482         - name: interface-name
28483           in: path
28484           description: Name that identifies the link aggregate interface
28485           required: true
28486           type: string
28487           example: __INTERFACE-NAME__
28488         - name: interface-name
28489           in: path
28490           description: Name given to the interface
28491           required: true
28492           type: string
28493           example: __INTERFACE-NAME__
28494         - name: l3-interface-ipv4-address
28495           in: path
28496           description: IP address
28497           required: true
28498           type: string
28499           example: __L3-INTERFACE-IPV4-ADDRESS__
28500   /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}:
28501     get:
28502       tags:
28503         - Network
28504       summary: returns l3-interface-ipv4-address-list
28505       description: returns l3-interface-ipv4-address-list
28506       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28507       produces:
28508         - application/json
28509         - application/xml
28510       responses:
28511         "200":
28512           description: successful operation
28513           schema:
28514               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28515         "default":
28516           description: Response codes found in [response codes](https://wiki.onap.org/).
28517       parameters:
28518         - name: equipment-name
28519           in: path
28520           required: true
28521           type: string
28522           example: __EQUIPMENT-NAME__
28523         - name: interface-name
28524           in: path
28525           description: Name that identifies the link aggregate interface
28526           required: true
28527           type: string
28528           example: __INTERFACE-NAME__
28529         - name: interface-name
28530           in: path
28531           description: Name given to the interface
28532           required: true
28533           type: string
28534           example: __INTERFACE-NAME__
28535         - name: l3-interface-ipv4-address
28536           in: path
28537           description: IP address
28538           required: true
28539           type: string
28540           example: __L3-INTERFACE-IPV4-ADDRESS__
28541         - name: prov-status
28542           in: query
28543           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28544           required: false
28545           type: string
28546         - name: interface-id
28547           in: query
28548           description: ID of interface
28549           required: false
28550           type: string
28551         - name: interface-role
28552           in: query
28553           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28554           required: false
28555           type: string
28556         - name: interface-id
28557           in: query
28558           description: ID of interface
28559           required: false
28560           type: string
28561         - name: macaddr
28562           in: query
28563           description: MAC address for the interface
28564           required: false
28565           type: string
28566         - name: network-name
28567           in: query
28568           description: Name of the network
28569           required: false
28570           type: string
28571         - name: vlan-id-inner
28572           in: query
28573           description: Inner VLAN tag
28574           required: false
28575           type: integer
28576           format: int64
28577         - name: neutron-network-id
28578           in: query
28579           description: Neutron network id of the interface that address belongs to
28580           required: false
28581           type: string
28582         - name: neutron-subnet-id
28583           in: query
28584           description: Neutron id of subnet that address belongs to
28585           required: false
28586           type: string
28587     put:
28588       tags:
28589         - Network
28590       summary: create or update an existing l3-interface-ipv4-address-list
28591       description: |
28592         Create or update an existing l3-interface-ipv4-address-list.
28593         #
28594         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28595       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28596       consumes:
28597         - application/json
28598         - application/xml
28599       produces:
28600         - application/json
28601         - application/xml
28602       responses:
28603         "default":
28604           description: Response codes found in [response codes](https://wiki.onap.org/).
28605       parameters:
28606         - name: equipment-name
28607           in: path
28608           required: true
28609           type: string
28610           example: __EQUIPMENT-NAME__
28611         - name: interface-name
28612           in: path
28613           description: Name that identifies the link aggregate interface
28614           required: true
28615           type: string
28616           example: __INTERFACE-NAME__
28617         - name: interface-name
28618           in: path
28619           description: Name given to the interface
28620           required: true
28621           type: string
28622           example: __INTERFACE-NAME__
28623         - name: l3-interface-ipv4-address
28624           in: path
28625           description: IP address
28626           required: true
28627           type: string
28628           example: __L3-INTERFACE-IPV4-ADDRESS__
28629         - name: body
28630           in: body
28631           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28632           required: true
28633           schema:
28634             $ref: "#/definitions/l3-interface-ipv4-address-list"
28635     patch:
28636       tags:
28637         - Network
28638       summary: update an existing l3-interface-ipv4-address-list
28639       description: |
28640         Update an existing l3-interface-ipv4-address-list
28641         #
28642         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28643         The PUT operation will entirely replace an existing object.
28644         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28645         #
28646         Other differences between PUT and PATCH are:
28647         #
28648         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28649         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28650         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28651       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28652       consumes:
28653         - application/json
28654         - application/xml
28655       produces:
28656         - application/json
28657         - application/xml
28658       responses:
28659         "default":
28660           description: Response codes found in [response codes](https://wiki.onap.org/).
28661       parameters:
28662         - name: equipment-name
28663           in: path
28664           required: true
28665           type: string
28666           example: __EQUIPMENT-NAME__
28667         - name: interface-name
28668           in: path
28669           description: Name that identifies the link aggregate interface
28670           required: true
28671           type: string
28672           example: __INTERFACE-NAME__
28673         - name: interface-name
28674           in: path
28675           description: Name given to the interface
28676           required: true
28677           type: string
28678           example: __INTERFACE-NAME__
28679         - name: l3-interface-ipv4-address
28680           in: path
28681           description: IP address
28682           required: true
28683           type: string
28684           example: __L3-INTERFACE-IPV4-ADDRESS__
28685         - name: body
28686           in: body
28687           description: l3-interface-ipv4-address-list object that needs to be created or updated.
28688           required: true
28689           schema:
28690             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28691     delete:
28692       tags:
28693         - Network
28694       summary: delete an existing l3-interface-ipv4-address-list
28695       description: delete an existing l3-interface-ipv4-address-list
28696       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28697       consumes:
28698         - application/json
28699         - application/xml
28700       produces:
28701         - application/json
28702         - application/xml
28703       responses:
28704         "default":
28705           description: Response codes found in [response codes](https://wiki.onap.org/).
28706       parameters:
28707         - name: equipment-name
28708           in: path
28709           required: true
28710           type: string
28711           example: __EQUIPMENT-NAME__
28712         - name: interface-name
28713           in: path
28714           description: Name that identifies the link aggregate interface
28715           required: true
28716           type: string
28717           example: __INTERFACE-NAME__
28718         - name: interface-name
28719           in: path
28720           description: Name given to the interface
28721           required: true
28722           type: string
28723           example: __INTERFACE-NAME__
28724         - name: l3-interface-ipv4-address
28725           in: path
28726           description: IP address
28727           required: true
28728           type: string
28729           example: __L3-INTERFACE-IPV4-ADDRESS__
28730         - name: resource-version
28731           in: query
28732           description: resource-version for concurrency
28733           required: true
28734           type: string
28735   /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:
28736     put:
28737       tags:
28738         - Network
28739       summary: see node definition for valid relationships
28740       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28741       consumes:
28742         - application/json
28743         - application/xml
28744       produces:
28745         - application/json
28746         - application/xml
28747       responses:
28748         "default":
28749           description: Response codes found in [response codes](https://wiki.onap.org/).
28750       parameters:
28751         - name: equipment-name
28752           in: path
28753           required: true
28754           type: string
28755           example: __EQUIPMENT-NAME__
28756         - name: interface-name
28757           in: path
28758           description: Name that identifies the link aggregate interface
28759           required: true
28760           type: string
28761           example: __INTERFACE-NAME__
28762         - name: interface-name
28763           in: path
28764           description: Name given to the interface
28765           required: true
28766           type: string
28767           example: __INTERFACE-NAME__
28768         - name: l3-interface-ipv6-address
28769           in: path
28770           description: IP address
28771           required: true
28772           type: string
28773           example: __L3-INTERFACE-IPV6-ADDRESS__
28774         - name: body
28775           in: body
28776           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28777           required: true
28778           schema:
28779             $ref: "#/definitions/relationship"
28780     delete:
28781       tags:
28782         - Network
28783       summary: delete an existing relationship
28784       description: delete an existing relationship
28785       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28786       consumes:
28787         - application/json
28788         - application/xml
28789       produces:
28790         - application/json
28791         - application/xml
28792       responses:
28793         "default":
28794           description: Response codes found in [response codes](https://wiki.onap.org/).
28795       parameters:
28796         - name: equipment-name
28797           in: path
28798           required: true
28799           type: string
28800           example: __EQUIPMENT-NAME__
28801         - name: interface-name
28802           in: path
28803           description: Name that identifies the link aggregate interface
28804           required: true
28805           type: string
28806           example: __INTERFACE-NAME__
28807         - name: interface-name
28808           in: path
28809           description: Name given to the interface
28810           required: true
28811           type: string
28812           example: __INTERFACE-NAME__
28813         - name: l3-interface-ipv6-address
28814           in: path
28815           description: IP address
28816           required: true
28817           type: string
28818           example: __L3-INTERFACE-IPV6-ADDRESS__
28819   /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}:
28820     get:
28821       tags:
28822         - Network
28823       summary: returns l3-interface-ipv6-address-list
28824       description: returns l3-interface-ipv6-address-list
28825       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28826       produces:
28827         - application/json
28828         - application/xml
28829       responses:
28830         "200":
28831           description: successful operation
28832           schema:
28833               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28834         "default":
28835           description: Response codes found in [response codes](https://wiki.onap.org/).
28836       parameters:
28837         - name: equipment-name
28838           in: path
28839           required: true
28840           type: string
28841           example: __EQUIPMENT-NAME__
28842         - name: interface-name
28843           in: path
28844           description: Name that identifies the link aggregate interface
28845           required: true
28846           type: string
28847           example: __INTERFACE-NAME__
28848         - name: interface-name
28849           in: path
28850           description: Name given to the interface
28851           required: true
28852           type: string
28853           example: __INTERFACE-NAME__
28854         - name: l3-interface-ipv6-address
28855           in: path
28856           description: IP address
28857           required: true
28858           type: string
28859           example: __L3-INTERFACE-IPV6-ADDRESS__
28860         - name: prov-status
28861           in: query
28862           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28863           required: false
28864           type: string
28865         - name: interface-id
28866           in: query
28867           description: ID of interface
28868           required: false
28869           type: string
28870         - name: interface-role
28871           in: query
28872           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28873           required: false
28874           type: string
28875         - name: interface-id
28876           in: query
28877           description: ID of interface
28878           required: false
28879           type: string
28880         - name: macaddr
28881           in: query
28882           description: MAC address for the interface
28883           required: false
28884           type: string
28885         - name: network-name
28886           in: query
28887           description: Name of the network
28888           required: false
28889           type: string
28890         - name: vlan-id-inner
28891           in: query
28892           description: Inner VLAN tag
28893           required: false
28894           type: integer
28895           format: int64
28896         - name: neutron-network-id
28897           in: query
28898           description: Neutron network id of the interface that address belongs to
28899           required: false
28900           type: string
28901         - name: neutron-subnet-id
28902           in: query
28903           description: Neutron id of subnet that address belongs to
28904           required: false
28905           type: string
28906     put:
28907       tags:
28908         - Network
28909       summary: create or update an existing l3-interface-ipv6-address-list
28910       description: |
28911         Create or update an existing l3-interface-ipv6-address-list.
28912         #
28913         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28914       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28915       consumes:
28916         - application/json
28917         - application/xml
28918       produces:
28919         - application/json
28920         - application/xml
28921       responses:
28922         "default":
28923           description: Response codes found in [response codes](https://wiki.onap.org/).
28924       parameters:
28925         - name: equipment-name
28926           in: path
28927           required: true
28928           type: string
28929           example: __EQUIPMENT-NAME__
28930         - name: interface-name
28931           in: path
28932           description: Name that identifies the link aggregate interface
28933           required: true
28934           type: string
28935           example: __INTERFACE-NAME__
28936         - name: interface-name
28937           in: path
28938           description: Name given to the interface
28939           required: true
28940           type: string
28941           example: __INTERFACE-NAME__
28942         - name: l3-interface-ipv6-address
28943           in: path
28944           description: IP address
28945           required: true
28946           type: string
28947           example: __L3-INTERFACE-IPV6-ADDRESS__
28948         - name: body
28949           in: body
28950           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28951           required: true
28952           schema:
28953             $ref: "#/definitions/l3-interface-ipv6-address-list"
28954     patch:
28955       tags:
28956         - Network
28957       summary: update an existing l3-interface-ipv6-address-list
28958       description: |
28959         Update an existing l3-interface-ipv6-address-list
28960         #
28961         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28962         The PUT operation will entirely replace an existing object.
28963         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28964         #
28965         Other differences between PUT and PATCH are:
28966         #
28967         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28968         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28969         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28970       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28971       consumes:
28972         - application/json
28973         - application/xml
28974       produces:
28975         - application/json
28976         - application/xml
28977       responses:
28978         "default":
28979           description: Response codes found in [response codes](https://wiki.onap.org/).
28980       parameters:
28981         - name: equipment-name
28982           in: path
28983           required: true
28984           type: string
28985           example: __EQUIPMENT-NAME__
28986         - name: interface-name
28987           in: path
28988           description: Name that identifies the link aggregate interface
28989           required: true
28990           type: string
28991           example: __INTERFACE-NAME__
28992         - name: interface-name
28993           in: path
28994           description: Name given to the interface
28995           required: true
28996           type: string
28997           example: __INTERFACE-NAME__
28998         - name: l3-interface-ipv6-address
28999           in: path
29000           description: IP address
29001           required: true
29002           type: string
29003           example: __L3-INTERFACE-IPV6-ADDRESS__
29004         - name: body
29005           in: body
29006           description: l3-interface-ipv6-address-list object that needs to be created or updated.
29007           required: true
29008           schema:
29009             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29010     delete:
29011       tags:
29012         - Network
29013       summary: delete an existing l3-interface-ipv6-address-list
29014       description: delete an existing l3-interface-ipv6-address-list
29015       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29016       consumes:
29017         - application/json
29018         - application/xml
29019       produces:
29020         - application/json
29021         - application/xml
29022       responses:
29023         "default":
29024           description: Response codes found in [response codes](https://wiki.onap.org/).
29025       parameters:
29026         - name: equipment-name
29027           in: path
29028           required: true
29029           type: string
29030           example: __EQUIPMENT-NAME__
29031         - name: interface-name
29032           in: path
29033           description: Name that identifies the link aggregate interface
29034           required: true
29035           type: string
29036           example: __INTERFACE-NAME__
29037         - name: interface-name
29038           in: path
29039           description: Name given to the interface
29040           required: true
29041           type: string
29042           example: __INTERFACE-NAME__
29043         - name: l3-interface-ipv6-address
29044           in: path
29045           description: IP address
29046           required: true
29047           type: string
29048           example: __L3-INTERFACE-IPV6-ADDRESS__
29049         - name: resource-version
29050           in: query
29051           description: resource-version for concurrency
29052           required: true
29053           type: string
29054   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29055     get:
29056       tags:
29057         - Network
29058       summary: returns l-interface
29059       description: returns l-interface
29060       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29061       produces:
29062         - application/json
29063         - application/xml
29064       responses:
29065         "200":
29066           description: successful operation
29067           schema:
29068               $ref: "#/getDefinitions/l-interface"
29069         "default":
29070           description: Response codes found in [response codes](https://wiki.onap.org/).
29071       parameters:
29072         - name: equipment-name
29073           in: path
29074           required: true
29075           type: string
29076           example: __EQUIPMENT-NAME__
29077         - name: interface-name
29078           in: path
29079           description: Name that identifies the link aggregate interface
29080           required: true
29081           type: string
29082           example: __INTERFACE-NAME__
29083         - name: interface-name
29084           in: path
29085           description: Name given to the interface
29086           required: true
29087           type: string
29088           example: __INTERFACE-NAME__
29089         - name: prov-status
29090           in: query
29091           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29092           required: false
29093           type: string
29094         - name: interface-id
29095           in: query
29096           description: ID of interface
29097           required: false
29098           type: string
29099         - name: interface-role
29100           in: query
29101           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29102           required: false
29103           type: string
29104         - name: interface-id
29105           in: query
29106           description: ID of interface
29107           required: false
29108           type: string
29109         - name: macaddr
29110           in: query
29111           description: MAC address for the interface
29112           required: false
29113           type: string
29114         - name: network-name
29115           in: query
29116           description: Name of the network
29117           required: false
29118           type: string
29119     put:
29120       tags:
29121         - Network
29122       summary: create or update an existing l-interface
29123       description: |
29124         Create or update an existing l-interface.
29125         #
29126         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29127       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29128       consumes:
29129         - application/json
29130         - application/xml
29131       produces:
29132         - application/json
29133         - application/xml
29134       responses:
29135         "default":
29136           description: Response codes found in [response codes](https://wiki.onap.org/).
29137       parameters:
29138         - name: equipment-name
29139           in: path
29140           required: true
29141           type: string
29142           example: __EQUIPMENT-NAME__
29143         - name: interface-name
29144           in: path
29145           description: Name that identifies the link aggregate interface
29146           required: true
29147           type: string
29148           example: __INTERFACE-NAME__
29149         - name: interface-name
29150           in: path
29151           description: Name given to the interface
29152           required: true
29153           type: string
29154           example: __INTERFACE-NAME__
29155         - name: body
29156           in: body
29157           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
29158           required: true
29159           schema:
29160             $ref: "#/definitions/l-interface"
29161     patch:
29162       tags:
29163         - Network
29164       summary: update an existing l-interface
29165       description: |
29166         Update an existing l-interface
29167         #
29168         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29169         The PUT operation will entirely replace an existing object.
29170         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29171         #
29172         Other differences between PUT and PATCH are:
29173         #
29174         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29175         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29176         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29177       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29178       consumes:
29179         - application/json
29180         - application/xml
29181       produces:
29182         - application/json
29183         - application/xml
29184       responses:
29185         "default":
29186           description: Response codes found in [response codes](https://wiki.onap.org/).
29187       parameters:
29188         - name: equipment-name
29189           in: path
29190           required: true
29191           type: string
29192           example: __EQUIPMENT-NAME__
29193         - name: interface-name
29194           in: path
29195           description: Name that identifies the link aggregate interface
29196           required: true
29197           type: string
29198           example: __INTERFACE-NAME__
29199         - name: interface-name
29200           in: path
29201           description: Name given to the interface
29202           required: true
29203           type: string
29204           example: __INTERFACE-NAME__
29205         - name: body
29206           in: body
29207           description: l-interface object that needs to be created or updated.
29208           required: true
29209           schema:
29210             $ref: "#/patchDefinitions/l-interface"
29211     delete:
29212       tags:
29213         - Network
29214       summary: delete an existing l-interface
29215       description: delete an existing l-interface
29216       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29217       consumes:
29218         - application/json
29219         - application/xml
29220       produces:
29221         - application/json
29222         - application/xml
29223       responses:
29224         "default":
29225           description: Response codes found in [response codes](https://wiki.onap.org/).
29226       parameters:
29227         - name: equipment-name
29228           in: path
29229           required: true
29230           type: string
29231           example: __EQUIPMENT-NAME__
29232         - name: interface-name
29233           in: path
29234           description: Name that identifies the link aggregate interface
29235           required: true
29236           type: string
29237           example: __INTERFACE-NAME__
29238         - name: interface-name
29239           in: path
29240           description: Name given to the interface
29241           required: true
29242           type: string
29243           example: __INTERFACE-NAME__
29244         - name: resource-version
29245           in: query
29246           description: resource-version for concurrency
29247           required: true
29248           type: string
29249   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
29250     get:
29251       tags:
29252         - Network
29253       summary: returns l-interfaces
29254       description: returns l-interfaces
29255       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
29256       produces:
29257         - application/json
29258         - application/xml
29259       responses:
29260         "200":
29261           description: successful operation
29262           schema:
29263               $ref: "#/getDefinitions/l-interfaces"
29264         "default":
29265           description: Response codes found in [response codes](https://wiki.onap.org/).
29266       parameters:
29267         - name: equipment-name
29268           in: path
29269           required: true
29270           type: string
29271           example: __EQUIPMENT-NAME__
29272         - name: interface-name
29273           in: path
29274           description: Name that identifies the link aggregate interface
29275           required: true
29276           type: string
29277           example: __INTERFACE-NAME__
29278         - name: prov-status
29279           in: query
29280           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29281           required: false
29282           type: string
29283         - name: interface-id
29284           in: query
29285           description: ID of interface
29286           required: false
29287           type: string
29288         - name: interface-role
29289           in: query
29290           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29291           required: false
29292           type: string
29293   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
29294     get:
29295       tags:
29296         - Network
29297       summary: returns lag-interface
29298       description: returns lag-interface
29299       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
29300       produces:
29301         - application/json
29302         - application/xml
29303       responses:
29304         "200":
29305           description: successful operation
29306           schema:
29307               $ref: "#/getDefinitions/lag-interface"
29308         "default":
29309           description: Response codes found in [response codes](https://wiki.onap.org/).
29310       parameters:
29311         - name: equipment-name
29312           in: path
29313           required: true
29314           type: string
29315           example: __EQUIPMENT-NAME__
29316         - name: interface-name
29317           in: path
29318           description: Name that identifies the link aggregate interface
29319           required: true
29320           type: string
29321           example: __INTERFACE-NAME__
29322         - name: prov-status
29323           in: query
29324           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29325           required: false
29326           type: string
29327         - name: interface-id
29328           in: query
29329           description: ID of interface
29330           required: false
29331           type: string
29332         - name: interface-role
29333           in: query
29334           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29335           required: false
29336           type: string
29337     put:
29338       tags:
29339         - Network
29340       summary: create or update an existing lag-interface
29341       description: |
29342         Create or update an existing lag-interface.
29343         #
29344         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29345       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29346       consumes:
29347         - application/json
29348         - application/xml
29349       produces:
29350         - application/json
29351         - application/xml
29352       responses:
29353         "default":
29354           description: Response codes found in [response codes](https://wiki.onap.org/).
29355       parameters:
29356         - name: equipment-name
29357           in: path
29358           required: true
29359           type: string
29360           example: __EQUIPMENT-NAME__
29361         - name: interface-name
29362           in: path
29363           description: Name that identifies the link aggregate interface
29364           required: true
29365           type: string
29366           example: __INTERFACE-NAME__
29367         - name: body
29368           in: body
29369           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
29370           required: true
29371           schema:
29372             $ref: "#/definitions/lag-interface"
29373     patch:
29374       tags:
29375         - Network
29376       summary: update an existing lag-interface
29377       description: |
29378         Update an existing lag-interface
29379         #
29380         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29381         The PUT operation will entirely replace an existing object.
29382         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29383         #
29384         Other differences between PUT and PATCH are:
29385         #
29386         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29387         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29388         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29389       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29390       consumes:
29391         - application/json
29392         - application/xml
29393       produces:
29394         - application/json
29395         - application/xml
29396       responses:
29397         "default":
29398           description: Response codes found in [response codes](https://wiki.onap.org/).
29399       parameters:
29400         - name: equipment-name
29401           in: path
29402           required: true
29403           type: string
29404           example: __EQUIPMENT-NAME__
29405         - name: interface-name
29406           in: path
29407           description: Name that identifies the link aggregate interface
29408           required: true
29409           type: string
29410           example: __INTERFACE-NAME__
29411         - name: body
29412           in: body
29413           description: lag-interface object that needs to be created or updated.
29414           required: true
29415           schema:
29416             $ref: "#/patchDefinitions/lag-interface"
29417     delete:
29418       tags:
29419         - Network
29420       summary: delete an existing lag-interface
29421       description: delete an existing lag-interface
29422       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
29423       consumes:
29424         - application/json
29425         - application/xml
29426       produces:
29427         - application/json
29428         - application/xml
29429       responses:
29430         "default":
29431           description: Response codes found in [response codes](https://wiki.onap.org/).
29432       parameters:
29433         - name: equipment-name
29434           in: path
29435           required: true
29436           type: string
29437           example: __EQUIPMENT-NAME__
29438         - name: interface-name
29439           in: path
29440           description: Name that identifies the link aggregate interface
29441           required: true
29442           type: string
29443           example: __INTERFACE-NAME__
29444         - name: resource-version
29445           in: query
29446           description: resource-version for concurrency
29447           required: true
29448           type: string
29449   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
29450     get:
29451       tags:
29452         - Network
29453       summary: returns lag-interfaces
29454       description: returns lag-interfaces
29455       operationId: getNetworkVplsPesVplsPeLagInterfaces
29456       produces:
29457         - application/json
29458         - application/xml
29459       responses:
29460         "200":
29461           description: successful operation
29462           schema:
29463               $ref: "#/getDefinitions/lag-interfaces"
29464         "default":
29465           description: Response codes found in [response codes](https://wiki.onap.org/).
29466       parameters:
29467         - name: equipment-name
29468           in: path
29469           required: true
29470           type: string
29471           example: __EQUIPMENT-NAME__
29472         - name: prov-status
29473           in: query
29474           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29475           required: false
29476           type: string
29477   /network/vpls-pes/vpls-pe/{equipment-name}:
29478     get:
29479       tags:
29480         - Network
29481       summary: returns vpls-pe
29482       description: returns vpls-pe
29483       operationId: getNetworkVplsPesVplsPe
29484       produces:
29485         - application/json
29486         - application/xml
29487       responses:
29488         "200":
29489           description: successful operation
29490           schema:
29491               $ref: "#/getDefinitions/vpls-pe"
29492         "default":
29493           description: Response codes found in [response codes](https://wiki.onap.org/).
29494       parameters:
29495         - name: equipment-name
29496           in: path
29497           required: true
29498           type: string
29499           example: __EQUIPMENT-NAME__
29500         - name: prov-status
29501           in: query
29502           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29503           required: false
29504           type: string
29505     put:
29506       tags:
29507         - Network
29508       summary: create or update an existing vpls-pe
29509       description: |
29510         Create or update an existing vpls-pe.
29511         #
29512         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29513       operationId: createOrUpdateNetworkVplsPesVplsPe
29514       consumes:
29515         - application/json
29516         - application/xml
29517       produces:
29518         - application/json
29519         - application/xml
29520       responses:
29521         "default":
29522           description: Response codes found in [response codes](https://wiki.onap.org/).
29523       parameters:
29524         - name: equipment-name
29525           in: path
29526           required: true
29527           type: string
29528           example: __EQUIPMENT-NAME__
29529         - name: body
29530           in: body
29531           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
29532           required: true
29533           schema:
29534             $ref: "#/definitions/vpls-pe"
29535     patch:
29536       tags:
29537         - Network
29538       summary: update an existing vpls-pe
29539       description: |
29540         Update an existing vpls-pe
29541         #
29542         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29543         The PUT operation will entirely replace an existing object.
29544         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29545         #
29546         Other differences between PUT and PATCH are:
29547         #
29548         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29549         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29550         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29551       operationId: UpdateNetworkVplsPesVplsPe
29552       consumes:
29553         - application/json
29554         - application/xml
29555       produces:
29556         - application/json
29557         - application/xml
29558       responses:
29559         "default":
29560           description: Response codes found in [response codes](https://wiki.onap.org/).
29561       parameters:
29562         - name: equipment-name
29563           in: path
29564           required: true
29565           type: string
29566           example: __EQUIPMENT-NAME__
29567         - name: body
29568           in: body
29569           description: vpls-pe object that needs to be created or updated.
29570           required: true
29571           schema:
29572             $ref: "#/patchDefinitions/vpls-pe"
29573     delete:
29574       tags:
29575         - Network
29576       summary: delete an existing vpls-pe
29577       description: delete an existing vpls-pe
29578       operationId: deleteNetworkVplsPesVplsPe
29579       consumes:
29580         - application/json
29581         - application/xml
29582       produces:
29583         - application/json
29584         - application/xml
29585       responses:
29586         "default":
29587           description: Response codes found in [response codes](https://wiki.onap.org/).
29588       parameters:
29589         - name: equipment-name
29590           in: path
29591           required: true
29592           type: string
29593           example: __EQUIPMENT-NAME__
29594         - name: resource-version
29595           in: query
29596           description: resource-version for concurrency
29597           required: true
29598           type: string
29599   /network/vpls-pes:
29600     get:
29601       tags:
29602         - Network
29603       summary: returns vpls-pes
29604       description: returns vpls-pes
29605       operationId: getNetworkVplsPes
29606       produces:
29607         - application/json
29608         - application/xml
29609       responses:
29610         "200":
29611           description: successful operation
29612           schema:
29613               $ref: "#/getDefinitions/vpls-pes"
29614         "default":
29615           description: Response codes found in [response codes](https://wiki.onap.org/).
29616   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
29617     put:
29618       tags:
29619         - Network
29620       summary: see node definition for valid relationships
29621       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29622       consumes:
29623         - application/json
29624         - application/xml
29625       produces:
29626         - application/json
29627         - application/xml
29628       responses:
29629         "default":
29630           description: Response codes found in [response codes](https://wiki.onap.org/).
29631       parameters:
29632         - name: multicast-configuration-id
29633           in: path
29634           description: Unique id of multicast configuration.
29635           required: true
29636           type: string
29637           example: __MULTICAST-CONFIGURATION-ID__
29638         - name: body
29639           in: body
29640           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
29641           required: true
29642           schema:
29643             $ref: "#/definitions/relationship"
29644     delete:
29645       tags:
29646         - Network
29647       summary: delete an existing relationship
29648       description: delete an existing relationship
29649       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29650       consumes:
29651         - application/json
29652         - application/xml
29653       produces:
29654         - application/json
29655         - application/xml
29656       responses:
29657         "default":
29658           description: Response codes found in [response codes](https://wiki.onap.org/).
29659       parameters:
29660         - name: multicast-configuration-id
29661           in: path
29662           description: Unique id of multicast configuration.
29663           required: true
29664           type: string
29665           example: __MULTICAST-CONFIGURATION-ID__
29666   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
29667     get:
29668       tags:
29669         - Network
29670       summary: returns multicast-configuration
29671       description: returns multicast-configuration
29672       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
29673       produces:
29674         - application/json
29675         - application/xml
29676       responses:
29677         "200":
29678           description: successful operation
29679           schema:
29680               $ref: "#/getDefinitions/multicast-configuration"
29681         "default":
29682           description: Response codes found in [response codes](https://wiki.onap.org/).
29683       parameters:
29684         - name: multicast-configuration-id
29685           in: path
29686           description: Unique id of multicast configuration.
29687           required: true
29688           type: string
29689           example: __MULTICAST-CONFIGURATION-ID__
29690     put:
29691       tags:
29692         - Network
29693       summary: create or update an existing multicast-configuration
29694       description: |
29695         Create or update an existing multicast-configuration.
29696         #
29697         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29698       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
29699       consumes:
29700         - application/json
29701         - application/xml
29702       produces:
29703         - application/json
29704         - application/xml
29705       responses:
29706         "default":
29707           description: Response codes found in [response codes](https://wiki.onap.org/).
29708       parameters:
29709         - name: multicast-configuration-id
29710           in: path
29711           description: Unique id of multicast configuration.
29712           required: true
29713           type: string
29714           example: __MULTICAST-CONFIGURATION-ID__
29715         - name: body
29716           in: body
29717           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
29718           required: true
29719           schema:
29720             $ref: "#/definitions/multicast-configuration"
29721     patch:
29722       tags:
29723         - Network
29724       summary: update an existing multicast-configuration
29725       description: |
29726         Update an existing multicast-configuration
29727         #
29728         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29729         The PUT operation will entirely replace an existing object.
29730         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29731         #
29732         Other differences between PUT and PATCH are:
29733         #
29734         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29735         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29736         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29737       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
29738       consumes:
29739         - application/json
29740         - application/xml
29741       produces:
29742         - application/json
29743         - application/xml
29744       responses:
29745         "default":
29746           description: Response codes found in [response codes](https://wiki.onap.org/).
29747       parameters:
29748         - name: multicast-configuration-id
29749           in: path
29750           description: Unique id of multicast configuration.
29751           required: true
29752           type: string
29753           example: __MULTICAST-CONFIGURATION-ID__
29754         - name: body
29755           in: body
29756           description: multicast-configuration object that needs to be created or updated.
29757           required: true
29758           schema:
29759             $ref: "#/patchDefinitions/multicast-configuration"
29760     delete:
29761       tags:
29762         - Network
29763       summary: delete an existing multicast-configuration
29764       description: delete an existing multicast-configuration
29765       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
29766       consumes:
29767         - application/json
29768         - application/xml
29769       produces:
29770         - application/json
29771         - application/xml
29772       responses:
29773         "default":
29774           description: Response codes found in [response codes](https://wiki.onap.org/).
29775       parameters:
29776         - name: multicast-configuration-id
29777           in: path
29778           description: Unique id of multicast configuration.
29779           required: true
29780           type: string
29781           example: __MULTICAST-CONFIGURATION-ID__
29782         - name: resource-version
29783           in: query
29784           description: resource-version for concurrency
29785           required: true
29786           type: string
29787   /network/multicast-configurations:
29788     get:
29789       tags:
29790         - Network
29791       summary: returns multicast-configurations
29792       description: returns multicast-configurations
29793       operationId: getNetworkMulticastConfigurations
29794       produces:
29795         - application/json
29796         - application/xml
29797       responses:
29798         "200":
29799           description: successful operation
29800           schema:
29801               $ref: "#/getDefinitions/multicast-configurations"
29802         "default":
29803           description: Response codes found in [response codes](https://wiki.onap.org/).
29804   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
29805     put:
29806       tags:
29807         - Network
29808       summary: see node definition for valid relationships
29809       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29810       consumes:
29811         - application/json
29812         - application/xml
29813       produces:
29814         - application/json
29815         - application/xml
29816       responses:
29817         "default":
29818           description: Response codes found in [response codes](https://wiki.onap.org/).
29819       parameters:
29820         - name: vnf-id
29821           in: path
29822           description: Unique id of VNF.  This is unique across the graph.
29823           required: true
29824           type: string
29825           example: __VNF-ID__
29826         - name: interface-id
29827           in: path
29828           description: Unique ID of the interface
29829           required: true
29830           type: string
29831           example: __INTERFACE-ID__
29832         - name: cvlan-tag
29833           in: path
29834           description: See mis-na-virtualization-platform.yang
29835           required: true
29836           type: integer
29837           format: int64
29838           example: __CVLAN-TAG__
29839         - name: body
29840           in: body
29841           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
29842           required: true
29843           schema:
29844             $ref: "#/definitions/relationship"
29845     delete:
29846       tags:
29847         - Network
29848       summary: delete an existing relationship
29849       description: delete an existing relationship
29850       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29851       consumes:
29852         - application/json
29853         - application/xml
29854       produces:
29855         - application/json
29856         - application/xml
29857       responses:
29858         "default":
29859           description: Response codes found in [response codes](https://wiki.onap.org/).
29860       parameters:
29861         - name: vnf-id
29862           in: path
29863           description: Unique id of VNF.  This is unique across the graph.
29864           required: true
29865           type: string
29866           example: __VNF-ID__
29867         - name: interface-id
29868           in: path
29869           description: Unique ID of the interface
29870           required: true
29871           type: string
29872           example: __INTERFACE-ID__
29873         - name: cvlan-tag
29874           in: path
29875           description: See mis-na-virtualization-platform.yang
29876           required: true
29877           type: integer
29878           format: int64
29879           example: __CVLAN-TAG__
29880   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
29881     get:
29882       tags:
29883         - Network
29884       summary: returns cvlan-tag-entry
29885       description: returns cvlan-tag-entry
29886       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
29887       produces:
29888         - application/json
29889         - application/xml
29890       responses:
29891         "200":
29892           description: successful operation
29893           schema:
29894               $ref: "#/getDefinitions/cvlan-tag-entry"
29895         "default":
29896           description: Response codes found in [response codes](https://wiki.onap.org/).
29897       parameters:
29898         - name: vnf-id
29899           in: path
29900           description: Unique id of VNF.  This is unique across the graph.
29901           required: true
29902           type: string
29903           example: __VNF-ID__
29904         - name: interface-id
29905           in: path
29906           description: Unique ID of the interface
29907           required: true
29908           type: string
29909           example: __INTERFACE-ID__
29910         - name: cvlan-tag
29911           in: path
29912           description: See mis-na-virtualization-platform.yang
29913           required: true
29914           type: integer
29915           format: int64
29916           example: __CVLAN-TAG__
29917         - name: vnf-name
29918           in: query
29919           description: Name of VNF.
29920           required: false
29921           type: string
29922         - name: vnf-name2
29923           in: query
29924           description: Alternate name of VNF.
29925           required: false
29926           type: string
29927         - name: vnf-type
29928           in: query
29929           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.
29930           required: false
29931           type: string
29932         - name: service-id
29933           in: query
29934           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
29935           required: false
29936           type: string
29937         - name: regional-resource-zone
29938           in: query
29939           description: Regional way of organizing pservers, source of truth should define values
29940           required: false
29941           type: string
29942         - name: prov-status
29943           in: query
29944           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29945           required: false
29946           type: string
29947         - name: heat-stack-id
29948           in: query
29949           description: Heat stack id corresponding to this instance, managed by MSO
29950           required: false
29951           type: string
29952         - name: vpe-id
29953           in: query
29954           description: Unique ID of VPE connected to this VCE.
29955           required: false
29956           type: string
29957         - name: port-group-id
29958           in: query
29959           description: Unique ID for port group in vmware
29960           required: false
29961           type: string
29962         - name: switch-name
29963           in: query
29964           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
29965           required: false
29966           type: string
29967         - name: heat-stack-id
29968           in: query
29969           description: Heat stack id corresponding to this instance, managed by MSO
29970           required: false
29971           type: string
29972     put:
29973       tags:
29974         - Network
29975       summary: create or update an existing cvlan-tag-entry
29976       description: |
29977         Create or update an existing cvlan-tag-entry.
29978         #
29979         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29980       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
29981       consumes:
29982         - application/json
29983         - application/xml
29984       produces:
29985         - application/json
29986         - application/xml
29987       responses:
29988         "default":
29989           description: Response codes found in [response codes](https://wiki.onap.org/).
29990       parameters:
29991         - name: vnf-id
29992           in: path
29993           description: Unique id of VNF.  This is unique across the graph.
29994           required: true
29995           type: string
29996           example: __VNF-ID__
29997         - name: interface-id
29998           in: path
29999           description: Unique ID of the interface
30000           required: true
30001           type: string
30002           example: __INTERFACE-ID__
30003         - name: cvlan-tag
30004           in: path
30005           description: See mis-na-virtualization-platform.yang
30006           required: true
30007           type: integer
30008           format: int64
30009           example: __CVLAN-TAG__
30010         - name: body
30011           in: body
30012           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
30013           required: true
30014           schema:
30015             $ref: "#/definitions/cvlan-tag-entry"
30016     patch:
30017       tags:
30018         - Network
30019       summary: update an existing cvlan-tag-entry
30020       description: |
30021         Update an existing cvlan-tag-entry
30022         #
30023         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30024         The PUT operation will entirely replace an existing object.
30025         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30026         #
30027         Other differences between PUT and PATCH are:
30028         #
30029         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30030         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30031         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30032       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30033       consumes:
30034         - application/json
30035         - application/xml
30036       produces:
30037         - application/json
30038         - application/xml
30039       responses:
30040         "default":
30041           description: Response codes found in [response codes](https://wiki.onap.org/).
30042       parameters:
30043         - name: vnf-id
30044           in: path
30045           description: Unique id of VNF.  This is unique across the graph.
30046           required: true
30047           type: string
30048           example: __VNF-ID__
30049         - name: interface-id
30050           in: path
30051           description: Unique ID of the interface
30052           required: true
30053           type: string
30054           example: __INTERFACE-ID__
30055         - name: cvlan-tag
30056           in: path
30057           description: See mis-na-virtualization-platform.yang
30058           required: true
30059           type: integer
30060           format: int64
30061           example: __CVLAN-TAG__
30062         - name: body
30063           in: body
30064           description: cvlan-tag-entry object that needs to be created or updated.
30065           required: true
30066           schema:
30067             $ref: "#/patchDefinitions/cvlan-tag-entry"
30068     delete:
30069       tags:
30070         - Network
30071       summary: delete an existing cvlan-tag-entry
30072       description: delete an existing cvlan-tag-entry
30073       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30074       consumes:
30075         - application/json
30076         - application/xml
30077       produces:
30078         - application/json
30079         - application/xml
30080       responses:
30081         "default":
30082           description: Response codes found in [response codes](https://wiki.onap.org/).
30083       parameters:
30084         - name: vnf-id
30085           in: path
30086           description: Unique id of VNF.  This is unique across the graph.
30087           required: true
30088           type: string
30089           example: __VNF-ID__
30090         - name: interface-id
30091           in: path
30092           description: Unique ID of the interface
30093           required: true
30094           type: string
30095           example: __INTERFACE-ID__
30096         - name: cvlan-tag
30097           in: path
30098           description: See mis-na-virtualization-platform.yang
30099           required: true
30100           type: integer
30101           format: int64
30102           example: __CVLAN-TAG__
30103         - name: resource-version
30104           in: query
30105           description: resource-version for concurrency
30106           required: true
30107           type: string
30108   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
30109     get:
30110       tags:
30111         - Network
30112       summary: returns cvlan-tags
30113       description: returns cvlan-tags
30114       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
30115       produces:
30116         - application/json
30117         - application/xml
30118       responses:
30119         "200":
30120           description: successful operation
30121           schema:
30122               $ref: "#/getDefinitions/cvlan-tags"
30123         "default":
30124           description: Response codes found in [response codes](https://wiki.onap.org/).
30125       parameters:
30126         - name: vnf-id
30127           in: path
30128           description: Unique id of VNF.  This is unique across the graph.
30129           required: true
30130           type: string
30131           example: __VNF-ID__
30132         - name: interface-id
30133           in: path
30134           description: Unique ID of the interface
30135           required: true
30136           type: string
30137           example: __INTERFACE-ID__
30138         - name: vnf-name
30139           in: query
30140           description: Name of VNF.
30141           required: false
30142           type: string
30143         - name: vnf-name2
30144           in: query
30145           description: Alternate name of VNF.
30146           required: false
30147           type: string
30148         - name: vnf-type
30149           in: query
30150           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.
30151           required: false
30152           type: string
30153         - name: service-id
30154           in: query
30155           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30156           required: false
30157           type: string
30158         - name: regional-resource-zone
30159           in: query
30160           description: Regional way of organizing pservers, source of truth should define values
30161           required: false
30162           type: string
30163         - name: prov-status
30164           in: query
30165           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30166           required: false
30167           type: string
30168         - name: heat-stack-id
30169           in: query
30170           description: Heat stack id corresponding to this instance, managed by MSO
30171           required: false
30172           type: string
30173         - name: vpe-id
30174           in: query
30175           description: Unique ID of VPE connected to this VCE.
30176           required: false
30177           type: string
30178         - name: port-group-id
30179           in: query
30180           description: Unique ID for port group in vmware
30181           required: false
30182           type: string
30183         - name: switch-name
30184           in: query
30185           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30186           required: false
30187           type: string
30188         - name: heat-stack-id
30189           in: query
30190           description: Heat stack id corresponding to this instance, managed by MSO
30191           required: false
30192           type: string
30193   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
30194     put:
30195       tags:
30196         - Network
30197       summary: see node definition for valid relationships
30198       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30199       consumes:
30200         - application/json
30201         - application/xml
30202       produces:
30203         - application/json
30204         - application/xml
30205       responses:
30206         "default":
30207           description: Response codes found in [response codes](https://wiki.onap.org/).
30208       parameters:
30209         - name: vnf-id
30210           in: path
30211           description: Unique id of VNF.  This is unique across the graph.
30212           required: true
30213           type: string
30214           example: __VNF-ID__
30215         - name: interface-id
30216           in: path
30217           description: Unique ID of the interface
30218           required: true
30219           type: string
30220           example: __INTERFACE-ID__
30221         - name: body
30222           in: body
30223           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
30224           required: true
30225           schema:
30226             $ref: "#/definitions/relationship"
30227     delete:
30228       tags:
30229         - Network
30230       summary: delete an existing relationship
30231       description: delete an existing relationship
30232       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30233       consumes:
30234         - application/json
30235         - application/xml
30236       produces:
30237         - application/json
30238         - application/xml
30239       responses:
30240         "default":
30241           description: Response codes found in [response codes](https://wiki.onap.org/).
30242       parameters:
30243         - name: vnf-id
30244           in: path
30245           description: Unique id of VNF.  This is unique across the graph.
30246           required: true
30247           type: string
30248           example: __VNF-ID__
30249         - name: interface-id
30250           in: path
30251           description: Unique ID of the interface
30252           required: true
30253           type: string
30254           example: __INTERFACE-ID__
30255   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
30256     get:
30257       tags:
30258         - Network
30259       summary: returns port-group
30260       description: returns port-group
30261       operationId: getNetworkVcesVcePortGroupsPortGroup
30262       produces:
30263         - application/json
30264         - application/xml
30265       responses:
30266         "200":
30267           description: successful operation
30268           schema:
30269               $ref: "#/getDefinitions/port-group"
30270         "default":
30271           description: Response codes found in [response codes](https://wiki.onap.org/).
30272       parameters:
30273         - name: vnf-id
30274           in: path
30275           description: Unique id of VNF.  This is unique across the graph.
30276           required: true
30277           type: string
30278           example: __VNF-ID__
30279         - name: interface-id
30280           in: path
30281           description: Unique ID of the interface
30282           required: true
30283           type: string
30284           example: __INTERFACE-ID__
30285         - name: vnf-name
30286           in: query
30287           description: Name of VNF.
30288           required: false
30289           type: string
30290         - name: vnf-name2
30291           in: query
30292           description: Alternate name of VNF.
30293           required: false
30294           type: string
30295         - name: vnf-type
30296           in: query
30297           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.
30298           required: false
30299           type: string
30300         - name: service-id
30301           in: query
30302           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30303           required: false
30304           type: string
30305         - name: regional-resource-zone
30306           in: query
30307           description: Regional way of organizing pservers, source of truth should define values
30308           required: false
30309           type: string
30310         - name: prov-status
30311           in: query
30312           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30313           required: false
30314           type: string
30315         - name: heat-stack-id
30316           in: query
30317           description: Heat stack id corresponding to this instance, managed by MSO
30318           required: false
30319           type: string
30320         - name: vpe-id
30321           in: query
30322           description: Unique ID of VPE connected to this VCE.
30323           required: false
30324           type: string
30325         - name: port-group-id
30326           in: query
30327           description: Unique ID for port group in vmware
30328           required: false
30329           type: string
30330         - name: switch-name
30331           in: query
30332           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30333           required: false
30334           type: string
30335         - name: heat-stack-id
30336           in: query
30337           description: Heat stack id corresponding to this instance, managed by MSO
30338           required: false
30339           type: string
30340     put:
30341       tags:
30342         - Network
30343       summary: create or update an existing port-group
30344       description: |
30345         Create or update an existing port-group.
30346         #
30347         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30348       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
30349       consumes:
30350         - application/json
30351         - application/xml
30352       produces:
30353         - application/json
30354         - application/xml
30355       responses:
30356         "default":
30357           description: Response codes found in [response codes](https://wiki.onap.org/).
30358       parameters:
30359         - name: vnf-id
30360           in: path
30361           description: Unique id of VNF.  This is unique across the graph.
30362           required: true
30363           type: string
30364           example: __VNF-ID__
30365         - name: interface-id
30366           in: path
30367           description: Unique ID of the interface
30368           required: true
30369           type: string
30370           example: __INTERFACE-ID__
30371         - name: body
30372           in: body
30373           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
30374           required: true
30375           schema:
30376             $ref: "#/definitions/port-group"
30377     patch:
30378       tags:
30379         - Network
30380       summary: update an existing port-group
30381       description: |
30382         Update an existing port-group
30383         #
30384         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30385         The PUT operation will entirely replace an existing object.
30386         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30387         #
30388         Other differences between PUT and PATCH are:
30389         #
30390         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30391         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30392         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30393       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
30394       consumes:
30395         - application/json
30396         - application/xml
30397       produces:
30398         - application/json
30399         - application/xml
30400       responses:
30401         "default":
30402           description: Response codes found in [response codes](https://wiki.onap.org/).
30403       parameters:
30404         - name: vnf-id
30405           in: path
30406           description: Unique id of VNF.  This is unique across the graph.
30407           required: true
30408           type: string
30409           example: __VNF-ID__
30410         - name: interface-id
30411           in: path
30412           description: Unique ID of the interface
30413           required: true
30414           type: string
30415           example: __INTERFACE-ID__
30416         - name: body
30417           in: body
30418           description: port-group object that needs to be created or updated.
30419           required: true
30420           schema:
30421             $ref: "#/patchDefinitions/port-group"
30422     delete:
30423       tags:
30424         - Network
30425       summary: delete an existing port-group
30426       description: delete an existing port-group
30427       operationId: deleteNetworkVcesVcePortGroupsPortGroup
30428       consumes:
30429         - application/json
30430         - application/xml
30431       produces:
30432         - application/json
30433         - application/xml
30434       responses:
30435         "default":
30436           description: Response codes found in [response codes](https://wiki.onap.org/).
30437       parameters:
30438         - name: vnf-id
30439           in: path
30440           description: Unique id of VNF.  This is unique across the graph.
30441           required: true
30442           type: string
30443           example: __VNF-ID__
30444         - name: interface-id
30445           in: path
30446           description: Unique ID of the interface
30447           required: true
30448           type: string
30449           example: __INTERFACE-ID__
30450         - name: resource-version
30451           in: query
30452           description: resource-version for concurrency
30453           required: true
30454           type: string
30455   /network/vces/vce/{vnf-id}/port-groups:
30456     get:
30457       tags:
30458         - Network
30459       summary: returns port-groups
30460       description: returns port-groups
30461       operationId: getNetworkVcesVcePortGroups
30462       produces:
30463         - application/json
30464         - application/xml
30465       responses:
30466         "200":
30467           description: successful operation
30468           schema:
30469               $ref: "#/getDefinitions/port-groups"
30470         "default":
30471           description: Response codes found in [response codes](https://wiki.onap.org/).
30472       parameters:
30473         - name: vnf-id
30474           in: path
30475           description: Unique id of VNF.  This is unique across the graph.
30476           required: true
30477           type: string
30478           example: __VNF-ID__
30479         - name: vnf-name
30480           in: query
30481           description: Name of VNF.
30482           required: false
30483           type: string
30484         - name: vnf-name2
30485           in: query
30486           description: Alternate name of VNF.
30487           required: false
30488           type: string
30489         - name: vnf-type
30490           in: query
30491           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.
30492           required: false
30493           type: string
30494         - name: service-id
30495           in: query
30496           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30497           required: false
30498           type: string
30499         - name: regional-resource-zone
30500           in: query
30501           description: Regional way of organizing pservers, source of truth should define values
30502           required: false
30503           type: string
30504         - name: prov-status
30505           in: query
30506           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30507           required: false
30508           type: string
30509         - name: heat-stack-id
30510           in: query
30511           description: Heat stack id corresponding to this instance, managed by MSO
30512           required: false
30513           type: string
30514         - name: vpe-id
30515           in: query
30516           description: Unique ID of VPE connected to this VCE.
30517           required: false
30518           type: string
30519   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30520     put:
30521       tags:
30522         - Network
30523       summary: see node definition for valid relationships
30524       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
30525       consumes:
30526         - application/json
30527         - application/xml
30528       produces:
30529         - application/json
30530         - application/xml
30531       responses:
30532         "default":
30533           description: Response codes found in [response codes](https://wiki.onap.org/).
30534       parameters:
30535         - name: vnf-id
30536           in: path
30537           description: Unique id of VNF.  This is unique across the graph.
30538           required: true
30539           type: string
30540           example: __VNF-ID__
30541         - name: group-uuid
30542           in: path
30543           description: Unique ID for the license group the resource belongs to, should be uuid.
30544           required: true
30545           type: string
30546           example: __GROUP-UUID__
30547         - name: resource-uuid
30548           in: path
30549           description: Unique ID of a license resource.
30550           required: true
30551           type: string
30552           example: __RESOURCE-UUID__
30553         - name: body
30554           in: body
30555           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
30556           required: true
30557           schema:
30558             $ref: "#/definitions/relationship"
30559     delete:
30560       tags:
30561         - Network
30562       summary: delete an existing relationship
30563       description: delete an existing relationship
30564       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
30565       consumes:
30566         - application/json
30567         - application/xml
30568       produces:
30569         - application/json
30570         - application/xml
30571       responses:
30572         "default":
30573           description: Response codes found in [response codes](https://wiki.onap.org/).
30574       parameters:
30575         - name: vnf-id
30576           in: path
30577           description: Unique id of VNF.  This is unique across the graph.
30578           required: true
30579           type: string
30580           example: __VNF-ID__
30581         - name: group-uuid
30582           in: path
30583           description: Unique ID for the license group the resource belongs to, should be uuid.
30584           required: true
30585           type: string
30586           example: __GROUP-UUID__
30587         - name: resource-uuid
30588           in: path
30589           description: Unique ID of a license resource.
30590           required: true
30591           type: string
30592           example: __RESOURCE-UUID__
30593   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
30594     get:
30595       tags:
30596         - Network
30597       summary: returns license
30598       description: returns license
30599       operationId: getNetworkVcesVceLicensesLicense
30600       produces:
30601         - application/json
30602         - application/xml
30603       responses:
30604         "200":
30605           description: successful operation
30606           schema:
30607               $ref: "#/getDefinitions/license"
30608         "default":
30609           description: Response codes found in [response codes](https://wiki.onap.org/).
30610       parameters:
30611         - name: vnf-id
30612           in: path
30613           description: Unique id of VNF.  This is unique across the graph.
30614           required: true
30615           type: string
30616           example: __VNF-ID__
30617         - name: group-uuid
30618           in: path
30619           description: Unique ID for the license group the resource belongs to, should be uuid.
30620           required: true
30621           type: string
30622           example: __GROUP-UUID__
30623         - name: resource-uuid
30624           in: path
30625           description: Unique ID of a license resource.
30626           required: true
30627           type: string
30628           example: __RESOURCE-UUID__
30629         - name: vnf-name
30630           in: query
30631           description: Name of VNF.
30632           required: false
30633           type: string
30634         - name: vnf-name2
30635           in: query
30636           description: Alternate name of VNF.
30637           required: false
30638           type: string
30639         - name: vnf-type
30640           in: query
30641           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.
30642           required: false
30643           type: string
30644         - name: service-id
30645           in: query
30646           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30647           required: false
30648           type: string
30649         - name: regional-resource-zone
30650           in: query
30651           description: Regional way of organizing pservers, source of truth should define values
30652           required: false
30653           type: string
30654         - name: prov-status
30655           in: query
30656           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30657           required: false
30658           type: string
30659         - name: heat-stack-id
30660           in: query
30661           description: Heat stack id corresponding to this instance, managed by MSO
30662           required: false
30663           type: string
30664         - name: vpe-id
30665           in: query
30666           description: Unique ID of VPE connected to this VCE.
30667           required: false
30668           type: string
30669     put:
30670       tags:
30671         - Network
30672       summary: create or update an existing license
30673       description: |
30674         Create or update an existing license.
30675         #
30676         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30677       operationId: createOrUpdateNetworkVcesVceLicensesLicense
30678       consumes:
30679         - application/json
30680         - application/xml
30681       produces:
30682         - application/json
30683         - application/xml
30684       responses:
30685         "default":
30686           description: Response codes found in [response codes](https://wiki.onap.org/).
30687       parameters:
30688         - name: vnf-id
30689           in: path
30690           description: Unique id of VNF.  This is unique across the graph.
30691           required: true
30692           type: string
30693           example: __VNF-ID__
30694         - name: group-uuid
30695           in: path
30696           description: Unique ID for the license group the resource belongs to, should be uuid.
30697           required: true
30698           type: string
30699           example: __GROUP-UUID__
30700         - name: resource-uuid
30701           in: path
30702           description: Unique ID of a license resource.
30703           required: true
30704           type: string
30705           example: __RESOURCE-UUID__
30706         - name: body
30707           in: body
30708           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
30709           required: true
30710           schema:
30711             $ref: "#/definitions/license"
30712     patch:
30713       tags:
30714         - Network
30715       summary: update an existing license
30716       description: |
30717         Update an existing license
30718         #
30719         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30720         The PUT operation will entirely replace an existing object.
30721         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30722         #
30723         Other differences between PUT and PATCH are:
30724         #
30725         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30726         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30727         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30728       operationId: UpdateNetworkVcesVceLicensesLicense
30729       consumes:
30730         - application/json
30731         - application/xml
30732       produces:
30733         - application/json
30734         - application/xml
30735       responses:
30736         "default":
30737           description: Response codes found in [response codes](https://wiki.onap.org/).
30738       parameters:
30739         - name: vnf-id
30740           in: path
30741           description: Unique id of VNF.  This is unique across the graph.
30742           required: true
30743           type: string
30744           example: __VNF-ID__
30745         - name: group-uuid
30746           in: path
30747           description: Unique ID for the license group the resource belongs to, should be uuid.
30748           required: true
30749           type: string
30750           example: __GROUP-UUID__
30751         - name: resource-uuid
30752           in: path
30753           description: Unique ID of a license resource.
30754           required: true
30755           type: string
30756           example: __RESOURCE-UUID__
30757         - name: body
30758           in: body
30759           description: license object that needs to be created or updated.
30760           required: true
30761           schema:
30762             $ref: "#/patchDefinitions/license"
30763     delete:
30764       tags:
30765         - Network
30766       summary: delete an existing license
30767       description: delete an existing license
30768       operationId: deleteNetworkVcesVceLicensesLicense
30769       consumes:
30770         - application/json
30771         - application/xml
30772       produces:
30773         - application/json
30774         - application/xml
30775       responses:
30776         "default":
30777           description: Response codes found in [response codes](https://wiki.onap.org/).
30778       parameters:
30779         - name: vnf-id
30780           in: path
30781           description: Unique id of VNF.  This is unique across the graph.
30782           required: true
30783           type: string
30784           example: __VNF-ID__
30785         - name: group-uuid
30786           in: path
30787           description: Unique ID for the license group the resource belongs to, should be uuid.
30788           required: true
30789           type: string
30790           example: __GROUP-UUID__
30791         - name: resource-uuid
30792           in: path
30793           description: Unique ID of a license resource.
30794           required: true
30795           type: string
30796           example: __RESOURCE-UUID__
30797         - name: resource-version
30798           in: query
30799           description: resource-version for concurrency
30800           required: true
30801           type: string
30802   /network/vces/vce/{vnf-id}/licenses:
30803     get:
30804       tags:
30805         - Network
30806       summary: returns licenses
30807       description: returns licenses
30808       operationId: getNetworkVcesVceLicenses
30809       produces:
30810         - application/json
30811         - application/xml
30812       responses:
30813         "200":
30814           description: successful operation
30815           schema:
30816               $ref: "#/getDefinitions/licenses"
30817         "default":
30818           description: Response codes found in [response codes](https://wiki.onap.org/).
30819       parameters:
30820         - name: vnf-id
30821           in: path
30822           description: Unique id of VNF.  This is unique across the graph.
30823           required: true
30824           type: string
30825           example: __VNF-ID__
30826         - name: vnf-name
30827           in: query
30828           description: Name of VNF.
30829           required: false
30830           type: string
30831         - name: vnf-name2
30832           in: query
30833           description: Alternate name of VNF.
30834           required: false
30835           type: string
30836         - name: vnf-type
30837           in: query
30838           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.
30839           required: false
30840           type: string
30841         - name: service-id
30842           in: query
30843           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30844           required: false
30845           type: string
30846         - name: regional-resource-zone
30847           in: query
30848           description: Regional way of organizing pservers, source of truth should define values
30849           required: false
30850           type: string
30851         - name: prov-status
30852           in: query
30853           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30854           required: false
30855           type: string
30856         - name: heat-stack-id
30857           in: query
30858           description: Heat stack id corresponding to this instance, managed by MSO
30859           required: false
30860           type: string
30861         - name: vpe-id
30862           in: query
30863           description: Unique ID of VPE connected to this VCE.
30864           required: false
30865           type: string
30866   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30867     put:
30868       tags:
30869         - Network
30870       summary: see node definition for valid relationships
30871       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30872       consumes:
30873         - application/json
30874         - application/xml
30875       produces:
30876         - application/json
30877         - application/xml
30878       responses:
30879         "default":
30880           description: Response codes found in [response codes](https://wiki.onap.org/).
30881       parameters:
30882         - name: vnf-id
30883           in: path
30884           description: Unique id of VNF.  This is unique across the graph.
30885           required: true
30886           type: string
30887           example: __VNF-ID__
30888         - name: group-uuid
30889           in: path
30890           description: Unique ID for the entitlement group the resource comes from, should be uuid.
30891           required: true
30892           type: string
30893           example: __GROUP-UUID__
30894         - name: resource-uuid
30895           in: path
30896           description: Unique ID of an entitlement resource.
30897           required: true
30898           type: string
30899           example: __RESOURCE-UUID__
30900         - name: body
30901           in: body
30902           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
30903           required: true
30904           schema:
30905             $ref: "#/definitions/relationship"
30906     delete:
30907       tags:
30908         - Network
30909       summary: delete an existing relationship
30910       description: delete an existing relationship
30911       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30912       consumes:
30913         - application/json
30914         - application/xml
30915       produces:
30916         - application/json
30917         - application/xml
30918       responses:
30919         "default":
30920           description: Response codes found in [response codes](https://wiki.onap.org/).
30921       parameters:
30922         - name: vnf-id
30923           in: path
30924           description: Unique id of VNF.  This is unique across the graph.
30925           required: true
30926           type: string
30927           example: __VNF-ID__
30928         - name: group-uuid
30929           in: path
30930           description: Unique ID for the entitlement group the resource comes from, should be uuid.
30931           required: true
30932           type: string
30933           example: __GROUP-UUID__
30934         - name: resource-uuid
30935           in: path
30936           description: Unique ID of an entitlement resource.
30937           required: true
30938           type: string
30939           example: __RESOURCE-UUID__
30940   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
30941     get:
30942       tags:
30943         - Network
30944       summary: returns entitlement
30945       description: returns entitlement
30946       operationId: getNetworkVcesVceEntitlementsEntitlement
30947       produces:
30948         - application/json
30949         - application/xml
30950       responses:
30951         "200":
30952           description: successful operation
30953           schema:
30954               $ref: "#/getDefinitions/entitlement"
30955         "default":
30956           description: Response codes found in [response codes](https://wiki.onap.org/).
30957       parameters:
30958         - name: vnf-id
30959           in: path
30960           description: Unique id of VNF.  This is unique across the graph.
30961           required: true
30962           type: string
30963           example: __VNF-ID__
30964         - name: group-uuid
30965           in: path
30966           description: Unique ID for the entitlement group the resource comes from, should be uuid.
30967           required: true
30968           type: string
30969           example: __GROUP-UUID__
30970         - name: resource-uuid
30971           in: path
30972           description: Unique ID of an entitlement resource.
30973           required: true
30974           type: string
30975           example: __RESOURCE-UUID__
30976         - name: vnf-name
30977           in: query
30978           description: Name of VNF.
30979           required: false
30980           type: string
30981         - name: vnf-name2
30982           in: query
30983           description: Alternate name of VNF.
30984           required: false
30985           type: string
30986         - name: vnf-type
30987           in: query
30988           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.
30989           required: false
30990           type: string
30991         - name: service-id
30992           in: query
30993           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30994           required: false
30995           type: string
30996         - name: regional-resource-zone
30997           in: query
30998           description: Regional way of organizing pservers, source of truth should define values
30999           required: false
31000           type: string
31001         - name: prov-status
31002           in: query
31003           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31004           required: false
31005           type: string
31006         - name: heat-stack-id
31007           in: query
31008           description: Heat stack id corresponding to this instance, managed by MSO
31009           required: false
31010           type: string
31011         - name: vpe-id
31012           in: query
31013           description: Unique ID of VPE connected to this VCE.
31014           required: false
31015           type: string
31016     put:
31017       tags:
31018         - Network
31019       summary: create or update an existing entitlement
31020       description: |
31021         Create or update an existing entitlement.
31022         #
31023         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31024       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
31025       consumes:
31026         - application/json
31027         - application/xml
31028       produces:
31029         - application/json
31030         - application/xml
31031       responses:
31032         "default":
31033           description: Response codes found in [response codes](https://wiki.onap.org/).
31034       parameters:
31035         - name: vnf-id
31036           in: path
31037           description: Unique id of VNF.  This is unique across the graph.
31038           required: true
31039           type: string
31040           example: __VNF-ID__
31041         - name: group-uuid
31042           in: path
31043           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31044           required: true
31045           type: string
31046           example: __GROUP-UUID__
31047         - name: resource-uuid
31048           in: path
31049           description: Unique ID of an entitlement resource.
31050           required: true
31051           type: string
31052           example: __RESOURCE-UUID__
31053         - name: body
31054           in: body
31055           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
31056           required: true
31057           schema:
31058             $ref: "#/definitions/entitlement"
31059     patch:
31060       tags:
31061         - Network
31062       summary: update an existing entitlement
31063       description: |
31064         Update an existing entitlement
31065         #
31066         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31067         The PUT operation will entirely replace an existing object.
31068         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31069         #
31070         Other differences between PUT and PATCH are:
31071         #
31072         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31073         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31074         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31075       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
31076       consumes:
31077         - application/json
31078         - application/xml
31079       produces:
31080         - application/json
31081         - application/xml
31082       responses:
31083         "default":
31084           description: Response codes found in [response codes](https://wiki.onap.org/).
31085       parameters:
31086         - name: vnf-id
31087           in: path
31088           description: Unique id of VNF.  This is unique across the graph.
31089           required: true
31090           type: string
31091           example: __VNF-ID__
31092         - name: group-uuid
31093           in: path
31094           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31095           required: true
31096           type: string
31097           example: __GROUP-UUID__
31098         - name: resource-uuid
31099           in: path
31100           description: Unique ID of an entitlement resource.
31101           required: true
31102           type: string
31103           example: __RESOURCE-UUID__
31104         - name: body
31105           in: body
31106           description: entitlement object that needs to be created or updated.
31107           required: true
31108           schema:
31109             $ref: "#/patchDefinitions/entitlement"
31110     delete:
31111       tags:
31112         - Network
31113       summary: delete an existing entitlement
31114       description: delete an existing entitlement
31115       operationId: deleteNetworkVcesVceEntitlementsEntitlement
31116       consumes:
31117         - application/json
31118         - application/xml
31119       produces:
31120         - application/json
31121         - application/xml
31122       responses:
31123         "default":
31124           description: Response codes found in [response codes](https://wiki.onap.org/).
31125       parameters:
31126         - name: vnf-id
31127           in: path
31128           description: Unique id of VNF.  This is unique across the graph.
31129           required: true
31130           type: string
31131           example: __VNF-ID__
31132         - name: group-uuid
31133           in: path
31134           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31135           required: true
31136           type: string
31137           example: __GROUP-UUID__
31138         - name: resource-uuid
31139           in: path
31140           description: Unique ID of an entitlement resource.
31141           required: true
31142           type: string
31143           example: __RESOURCE-UUID__
31144         - name: resource-version
31145           in: query
31146           description: resource-version for concurrency
31147           required: true
31148           type: string
31149   /network/vces/vce/{vnf-id}/entitlements:
31150     get:
31151       tags:
31152         - Network
31153       summary: returns entitlements
31154       description: returns entitlements
31155       operationId: getNetworkVcesVceEntitlements
31156       produces:
31157         - application/json
31158         - application/xml
31159       responses:
31160         "200":
31161           description: successful operation
31162           schema:
31163               $ref: "#/getDefinitions/entitlements"
31164         "default":
31165           description: Response codes found in [response codes](https://wiki.onap.org/).
31166       parameters:
31167         - name: vnf-id
31168           in: path
31169           description: Unique id of VNF.  This is unique across the graph.
31170           required: true
31171           type: string
31172           example: __VNF-ID__
31173         - name: vnf-name
31174           in: query
31175           description: Name of VNF.
31176           required: false
31177           type: string
31178         - name: vnf-name2
31179           in: query
31180           description: Alternate name of VNF.
31181           required: false
31182           type: string
31183         - name: vnf-type
31184           in: query
31185           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.
31186           required: false
31187           type: string
31188         - name: service-id
31189           in: query
31190           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31191           required: false
31192           type: string
31193         - name: regional-resource-zone
31194           in: query
31195           description: Regional way of organizing pservers, source of truth should define values
31196           required: false
31197           type: string
31198         - name: prov-status
31199           in: query
31200           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31201           required: false
31202           type: string
31203         - name: heat-stack-id
31204           in: query
31205           description: Heat stack id corresponding to this instance, managed by MSO
31206           required: false
31207           type: string
31208         - name: vpe-id
31209           in: query
31210           description: Unique ID of VPE connected to this VCE.
31211           required: false
31212           type: string
31213   /network/vces/vce/{vnf-id}/relationship-list/relationship:
31214     put:
31215       tags:
31216         - Network
31217       summary: see node definition for valid relationships
31218       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
31219       consumes:
31220         - application/json
31221         - application/xml
31222       produces:
31223         - application/json
31224         - application/xml
31225       responses:
31226         "default":
31227           description: Response codes found in [response codes](https://wiki.onap.org/).
31228       parameters:
31229         - name: vnf-id
31230           in: path
31231           description: Unique id of VNF.  This is unique across the graph.
31232           required: true
31233           type: string
31234           example: __VNF-ID__
31235         - name: body
31236           in: body
31237           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
31238           required: true
31239           schema:
31240             $ref: "#/definitions/relationship"
31241     delete:
31242       tags:
31243         - Network
31244       summary: delete an existing relationship
31245       description: delete an existing relationship
31246       operationId: deleteNetworkVcesVceRelationshipListRelationship
31247       consumes:
31248         - application/json
31249         - application/xml
31250       produces:
31251         - application/json
31252         - application/xml
31253       responses:
31254         "default":
31255           description: Response codes found in [response codes](https://wiki.onap.org/).
31256       parameters:
31257         - name: vnf-id
31258           in: path
31259           description: Unique id of VNF.  This is unique across the graph.
31260           required: true
31261           type: string
31262           example: __VNF-ID__
31263   /network/vces/vce/{vnf-id}:
31264     get:
31265       tags:
31266         - Network
31267       summary: returns vce
31268       description: returns vce
31269       operationId: getNetworkVcesVce
31270       produces:
31271         - application/json
31272         - application/xml
31273       responses:
31274         "200":
31275           description: successful operation
31276           schema:
31277               $ref: "#/getDefinitions/vce"
31278         "default":
31279           description: Response codes found in [response codes](https://wiki.onap.org/).
31280       parameters:
31281         - name: vnf-id
31282           in: path
31283           description: Unique id of VNF.  This is unique across the graph.
31284           required: true
31285           type: string
31286           example: __VNF-ID__
31287         - name: vnf-name
31288           in: query
31289           description: Name of VNF.
31290           required: false
31291           type: string
31292         - name: vnf-name2
31293           in: query
31294           description: Alternate name of VNF.
31295           required: false
31296           type: string
31297         - name: vnf-type
31298           in: query
31299           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.
31300           required: false
31301           type: string
31302         - name: service-id
31303           in: query
31304           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31305           required: false
31306           type: string
31307         - name: regional-resource-zone
31308           in: query
31309           description: Regional way of organizing pservers, source of truth should define values
31310           required: false
31311           type: string
31312         - name: prov-status
31313           in: query
31314           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31315           required: false
31316           type: string
31317         - name: heat-stack-id
31318           in: query
31319           description: Heat stack id corresponding to this instance, managed by MSO
31320           required: false
31321           type: string
31322         - name: vpe-id
31323           in: query
31324           description: Unique ID of VPE connected to this VCE.
31325           required: false
31326           type: string
31327     put:
31328       tags:
31329         - Network
31330       summary: create or update an existing vce
31331       description: |
31332         Create or update an existing vce.
31333         #
31334         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31335       operationId: createOrUpdateNetworkVcesVce
31336       consumes:
31337         - application/json
31338         - application/xml
31339       produces:
31340         - application/json
31341         - application/xml
31342       responses:
31343         "default":
31344           description: Response codes found in [response codes](https://wiki.onap.org/).
31345       parameters:
31346         - name: vnf-id
31347           in: path
31348           description: Unique id of VNF.  This is unique across the graph.
31349           required: true
31350           type: string
31351           example: __VNF-ID__
31352         - name: body
31353           in: body
31354           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
31355           required: true
31356           schema:
31357             $ref: "#/definitions/vce"
31358     patch:
31359       tags:
31360         - Network
31361       summary: update an existing vce
31362       description: |
31363         Update an existing vce
31364         #
31365         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31366         The PUT operation will entirely replace an existing object.
31367         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31368         #
31369         Other differences between PUT and PATCH are:
31370         #
31371         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31372         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31373         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31374       operationId: UpdateNetworkVcesVce
31375       consumes:
31376         - application/json
31377         - application/xml
31378       produces:
31379         - application/json
31380         - application/xml
31381       responses:
31382         "default":
31383           description: Response codes found in [response codes](https://wiki.onap.org/).
31384       parameters:
31385         - name: vnf-id
31386           in: path
31387           description: Unique id of VNF.  This is unique across the graph.
31388           required: true
31389           type: string
31390           example: __VNF-ID__
31391         - name: body
31392           in: body
31393           description: vce object that needs to be created or updated.
31394           required: true
31395           schema:
31396             $ref: "#/patchDefinitions/vce"
31397     delete:
31398       tags:
31399         - Network
31400       summary: delete an existing vce
31401       description: delete an existing vce
31402       operationId: deleteNetworkVcesVce
31403       consumes:
31404         - application/json
31405         - application/xml
31406       produces:
31407         - application/json
31408         - application/xml
31409       responses:
31410         "default":
31411           description: Response codes found in [response codes](https://wiki.onap.org/).
31412       parameters:
31413         - name: vnf-id
31414           in: path
31415           description: Unique id of VNF.  This is unique across the graph.
31416           required: true
31417           type: string
31418           example: __VNF-ID__
31419         - name: resource-version
31420           in: query
31421           description: resource-version for concurrency
31422           required: true
31423           type: string
31424   /network/vces:
31425     get:
31426       tags:
31427         - Network
31428       summary: returns vces
31429       description: returns vces
31430       operationId: getNetworkVces
31431       produces:
31432         - application/json
31433         - application/xml
31434       responses:
31435         "200":
31436           description: successful operation
31437           schema:
31438               $ref: "#/getDefinitions/vces"
31439         "default":
31440           description: Response codes found in [response codes](https://wiki.onap.org/).
31441   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
31442     put:
31443       tags:
31444         - Network
31445       summary: see node definition for valid relationships
31446       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
31447       consumes:
31448         - application/json
31449         - application/xml
31450       produces:
31451         - application/json
31452         - application/xml
31453       responses:
31454         "default":
31455           description: Response codes found in [response codes](https://wiki.onap.org/).
31456       parameters:
31457         - name: vnfc-name
31458           in: path
31459           description: Unique ID of vnfc.
31460           required: true
31461           type: string
31462           example: __VNFC-NAME__
31463         - name: body
31464           in: body
31465           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
31466           required: true
31467           schema:
31468             $ref: "#/definitions/relationship"
31469     delete:
31470       tags:
31471         - Network
31472       summary: delete an existing relationship
31473       description: delete an existing relationship
31474       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
31475       consumes:
31476         - application/json
31477         - application/xml
31478       produces:
31479         - application/json
31480         - application/xml
31481       responses:
31482         "default":
31483           description: Response codes found in [response codes](https://wiki.onap.org/).
31484       parameters:
31485         - name: vnfc-name
31486           in: path
31487           description: Unique ID of vnfc.
31488           required: true
31489           type: string
31490           example: __VNFC-NAME__
31491   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31492     put:
31493       tags:
31494         - Network
31495       summary: see node definition for valid relationships
31496       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31497       consumes:
31498         - application/json
31499         - application/xml
31500       produces:
31501         - application/json
31502         - application/xml
31503       responses:
31504         "default":
31505           description: Response codes found in [response codes](https://wiki.onap.org/).
31506       parameters:
31507         - name: vnfc-name
31508           in: path
31509           description: Unique ID of vnfc.
31510           required: true
31511           type: string
31512           example: __VNFC-NAME__
31513         - name: l3-interface-ipv4-address
31514           in: path
31515           description: IP address
31516           required: true
31517           type: string
31518           example: __L3-INTERFACE-IPV4-ADDRESS__
31519         - name: body
31520           in: body
31521           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31522           required: true
31523           schema:
31524             $ref: "#/definitions/relationship"
31525     delete:
31526       tags:
31527         - Network
31528       summary: delete an existing relationship
31529       description: delete an existing relationship
31530       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31531       consumes:
31532         - application/json
31533         - application/xml
31534       produces:
31535         - application/json
31536         - application/xml
31537       responses:
31538         "default":
31539           description: Response codes found in [response codes](https://wiki.onap.org/).
31540       parameters:
31541         - name: vnfc-name
31542           in: path
31543           description: Unique ID of vnfc.
31544           required: true
31545           type: string
31546           example: __VNFC-NAME__
31547         - name: l3-interface-ipv4-address
31548           in: path
31549           description: IP address
31550           required: true
31551           type: string
31552           example: __L3-INTERFACE-IPV4-ADDRESS__
31553   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31554     get:
31555       tags:
31556         - Network
31557       summary: returns l3-interface-ipv4-address-list
31558       description: returns l3-interface-ipv4-address-list
31559       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31560       produces:
31561         - application/json
31562         - application/xml
31563       responses:
31564         "200":
31565           description: successful operation
31566           schema:
31567               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31568         "default":
31569           description: Response codes found in [response codes](https://wiki.onap.org/).
31570       parameters:
31571         - name: vnfc-name
31572           in: path
31573           description: Unique ID of vnfc.
31574           required: true
31575           type: string
31576           example: __VNFC-NAME__
31577         - name: l3-interface-ipv4-address
31578           in: path
31579           description: IP address
31580           required: true
31581           type: string
31582           example: __L3-INTERFACE-IPV4-ADDRESS__
31583         - name: nfc-naming-code
31584           in: query
31585           description: Short code that is used in naming instances of the item being modeled
31586           required: false
31587           type: string
31588         - name: nfc-function
31589           in: query
31590           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31591           required: false
31592           type: string
31593         - name: prov-status
31594           in: query
31595           description: prov status of this vnfc
31596           required: false
31597           type: string
31598         - name: ipaddress-v4-oam-vip
31599           in: query
31600           description: Oam V4 vip address of this vnfc
31601           required: false
31602           type: string
31603         - name: in-maint
31604           in: query
31605           required: false
31606           type: boolean
31607         - name: is-closed-loop-disabled
31608           in: query
31609           required: false
31610           type: boolean
31611         - name: group-notation
31612           in: query
31613           description: Group notation of VNFC
31614           required: false
31615           type: string
31616         - name: model-invariant-id
31617           in: query
31618           description: the ASDC model id for this resource or service model.
31619           required: false
31620           type: string
31621         - name: model-version-id
31622           in: query
31623           description: the ASDC model version for this resource or service model.
31624           required: false
31625           type: string
31626         - name: vlan-id-inner
31627           in: query
31628           description: Inner VLAN tag
31629           required: false
31630           type: integer
31631           format: int64
31632         - name: neutron-network-id
31633           in: query
31634           description: Neutron network id of the interface that address belongs to
31635           required: false
31636           type: string
31637         - name: neutron-subnet-id
31638           in: query
31639           description: Neutron id of subnet that address belongs to
31640           required: false
31641           type: string
31642     put:
31643       tags:
31644         - Network
31645       summary: create or update an existing l3-interface-ipv4-address-list
31646       description: |
31647         Create or update an existing l3-interface-ipv4-address-list.
31648         #
31649         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31650       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31651       consumes:
31652         - application/json
31653         - application/xml
31654       produces:
31655         - application/json
31656         - application/xml
31657       responses:
31658         "default":
31659           description: Response codes found in [response codes](https://wiki.onap.org/).
31660       parameters:
31661         - name: vnfc-name
31662           in: path
31663           description: Unique ID of vnfc.
31664           required: true
31665           type: string
31666           example: __VNFC-NAME__
31667         - name: l3-interface-ipv4-address
31668           in: path
31669           description: IP address
31670           required: true
31671           type: string
31672           example: __L3-INTERFACE-IPV4-ADDRESS__
31673         - name: body
31674           in: body
31675           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31676           required: true
31677           schema:
31678             $ref: "#/definitions/l3-interface-ipv4-address-list"
31679     patch:
31680       tags:
31681         - Network
31682       summary: update an existing l3-interface-ipv4-address-list
31683       description: |
31684         Update an existing l3-interface-ipv4-address-list
31685         #
31686         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31687         The PUT operation will entirely replace an existing object.
31688         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31689         #
31690         Other differences between PUT and PATCH are:
31691         #
31692         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31693         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31694         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31695       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31696       consumes:
31697         - application/json
31698         - application/xml
31699       produces:
31700         - application/json
31701         - application/xml
31702       responses:
31703         "default":
31704           description: Response codes found in [response codes](https://wiki.onap.org/).
31705       parameters:
31706         - name: vnfc-name
31707           in: path
31708           description: Unique ID of vnfc.
31709           required: true
31710           type: string
31711           example: __VNFC-NAME__
31712         - name: l3-interface-ipv4-address
31713           in: path
31714           description: IP address
31715           required: true
31716           type: string
31717           example: __L3-INTERFACE-IPV4-ADDRESS__
31718         - name: body
31719           in: body
31720           description: l3-interface-ipv4-address-list object that needs to be created or updated.
31721           required: true
31722           schema:
31723             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31724     delete:
31725       tags:
31726         - Network
31727       summary: delete an existing l3-interface-ipv4-address-list
31728       description: delete an existing l3-interface-ipv4-address-list
31729       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31730       consumes:
31731         - application/json
31732         - application/xml
31733       produces:
31734         - application/json
31735         - application/xml
31736       responses:
31737         "default":
31738           description: Response codes found in [response codes](https://wiki.onap.org/).
31739       parameters:
31740         - name: vnfc-name
31741           in: path
31742           description: Unique ID of vnfc.
31743           required: true
31744           type: string
31745           example: __VNFC-NAME__
31746         - name: l3-interface-ipv4-address
31747           in: path
31748           description: IP address
31749           required: true
31750           type: string
31751           example: __L3-INTERFACE-IPV4-ADDRESS__
31752         - name: resource-version
31753           in: query
31754           description: resource-version for concurrency
31755           required: true
31756           type: string
31757   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31758     put:
31759       tags:
31760         - Network
31761       summary: see node definition for valid relationships
31762       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31763       consumes:
31764         - application/json
31765         - application/xml
31766       produces:
31767         - application/json
31768         - application/xml
31769       responses:
31770         "default":
31771           description: Response codes found in [response codes](https://wiki.onap.org/).
31772       parameters:
31773         - name: vnfc-name
31774           in: path
31775           description: Unique ID of vnfc.
31776           required: true
31777           type: string
31778           example: __VNFC-NAME__
31779         - name: l3-interface-ipv6-address
31780           in: path
31781           description: IP address
31782           required: true
31783           type: string
31784           example: __L3-INTERFACE-IPV6-ADDRESS__
31785         - name: body
31786           in: body
31787           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
31788           required: true
31789           schema:
31790             $ref: "#/definitions/relationship"
31791     delete:
31792       tags:
31793         - Network
31794       summary: delete an existing relationship
31795       description: delete an existing relationship
31796       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31797       consumes:
31798         - application/json
31799         - application/xml
31800       produces:
31801         - application/json
31802         - application/xml
31803       responses:
31804         "default":
31805           description: Response codes found in [response codes](https://wiki.onap.org/).
31806       parameters:
31807         - name: vnfc-name
31808           in: path
31809           description: Unique ID of vnfc.
31810           required: true
31811           type: string
31812           example: __VNFC-NAME__
31813         - name: l3-interface-ipv6-address
31814           in: path
31815           description: IP address
31816           required: true
31817           type: string
31818           example: __L3-INTERFACE-IPV6-ADDRESS__
31819   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31820     get:
31821       tags:
31822         - Network
31823       summary: returns l3-interface-ipv6-address-list
31824       description: returns l3-interface-ipv6-address-list
31825       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31826       produces:
31827         - application/json
31828         - application/xml
31829       responses:
31830         "200":
31831           description: successful operation
31832           schema:
31833               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31834         "default":
31835           description: Response codes found in [response codes](https://wiki.onap.org/).
31836       parameters:
31837         - name: vnfc-name
31838           in: path
31839           description: Unique ID of vnfc.
31840           required: true
31841           type: string
31842           example: __VNFC-NAME__
31843         - name: l3-interface-ipv6-address
31844           in: path
31845           description: IP address
31846           required: true
31847           type: string
31848           example: __L3-INTERFACE-IPV6-ADDRESS__
31849         - name: nfc-naming-code
31850           in: query
31851           description: Short code that is used in naming instances of the item being modeled
31852           required: false
31853           type: string
31854         - name: nfc-function
31855           in: query
31856           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31857           required: false
31858           type: string
31859         - name: prov-status
31860           in: query
31861           description: prov status of this vnfc
31862           required: false
31863           type: string
31864         - name: ipaddress-v4-oam-vip
31865           in: query
31866           description: Oam V4 vip address of this vnfc
31867           required: false
31868           type: string
31869         - name: in-maint
31870           in: query
31871           required: false
31872           type: boolean
31873         - name: is-closed-loop-disabled
31874           in: query
31875           required: false
31876           type: boolean
31877         - name: group-notation
31878           in: query
31879           description: Group notation of VNFC
31880           required: false
31881           type: string
31882         - name: model-invariant-id
31883           in: query
31884           description: the ASDC model id for this resource or service model.
31885           required: false
31886           type: string
31887         - name: model-version-id
31888           in: query
31889           description: the ASDC model version for this resource or service model.
31890           required: false
31891           type: string
31892         - name: vlan-id-inner
31893           in: query
31894           description: Inner VLAN tag
31895           required: false
31896           type: integer
31897           format: int64
31898         - name: neutron-network-id
31899           in: query
31900           description: Neutron network id of the interface that address belongs to
31901           required: false
31902           type: string
31903         - name: neutron-subnet-id
31904           in: query
31905           description: Neutron id of subnet that address belongs to
31906           required: false
31907           type: string
31908     put:
31909       tags:
31910         - Network
31911       summary: create or update an existing l3-interface-ipv6-address-list
31912       description: |
31913         Create or update an existing l3-interface-ipv6-address-list.
31914         #
31915         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31916       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31917       consumes:
31918         - application/json
31919         - application/xml
31920       produces:
31921         - application/json
31922         - application/xml
31923       responses:
31924         "default":
31925           description: Response codes found in [response codes](https://wiki.onap.org/).
31926       parameters:
31927         - name: vnfc-name
31928           in: path
31929           description: Unique ID of vnfc.
31930           required: true
31931           type: string
31932           example: __VNFC-NAME__
31933         - name: l3-interface-ipv6-address
31934           in: path
31935           description: IP address
31936           required: true
31937           type: string
31938           example: __L3-INTERFACE-IPV6-ADDRESS__
31939         - name: body
31940           in: body
31941           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
31942           required: true
31943           schema:
31944             $ref: "#/definitions/l3-interface-ipv6-address-list"
31945     patch:
31946       tags:
31947         - Network
31948       summary: update an existing l3-interface-ipv6-address-list
31949       description: |
31950         Update an existing l3-interface-ipv6-address-list
31951         #
31952         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31953         The PUT operation will entirely replace an existing object.
31954         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31955         #
31956         Other differences between PUT and PATCH are:
31957         #
31958         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31959         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31960         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31961       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31962       consumes:
31963         - application/json
31964         - application/xml
31965       produces:
31966         - application/json
31967         - application/xml
31968       responses:
31969         "default":
31970           description: Response codes found in [response codes](https://wiki.onap.org/).
31971       parameters:
31972         - name: vnfc-name
31973           in: path
31974           description: Unique ID of vnfc.
31975           required: true
31976           type: string
31977           example: __VNFC-NAME__
31978         - name: l3-interface-ipv6-address
31979           in: path
31980           description: IP address
31981           required: true
31982           type: string
31983           example: __L3-INTERFACE-IPV6-ADDRESS__
31984         - name: body
31985           in: body
31986           description: l3-interface-ipv6-address-list object that needs to be created or updated.
31987           required: true
31988           schema:
31989             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31990     delete:
31991       tags:
31992         - Network
31993       summary: delete an existing l3-interface-ipv6-address-list
31994       description: delete an existing l3-interface-ipv6-address-list
31995       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31996       consumes:
31997         - application/json
31998         - application/xml
31999       produces:
32000         - application/json
32001         - application/xml
32002       responses:
32003         "default":
32004           description: Response codes found in [response codes](https://wiki.onap.org/).
32005       parameters:
32006         - name: vnfc-name
32007           in: path
32008           description: Unique ID of vnfc.
32009           required: true
32010           type: string
32011           example: __VNFC-NAME__
32012         - name: l3-interface-ipv6-address
32013           in: path
32014           description: IP address
32015           required: true
32016           type: string
32017           example: __L3-INTERFACE-IPV6-ADDRESS__
32018         - name: resource-version
32019           in: query
32020           description: resource-version for concurrency
32021           required: true
32022           type: string
32023   /network/vnfcs/vnfc/{vnfc-name}:
32024     get:
32025       tags:
32026         - Network
32027       summary: returns vnfc
32028       description: returns vnfc
32029       operationId: getNetworkVnfcsVnfc
32030       produces:
32031         - application/json
32032         - application/xml
32033       responses:
32034         "200":
32035           description: successful operation
32036           schema:
32037               $ref: "#/getDefinitions/vnfc"
32038         "default":
32039           description: Response codes found in [response codes](https://wiki.onap.org/).
32040       parameters:
32041         - name: vnfc-name
32042           in: path
32043           description: Unique ID of vnfc.
32044           required: true
32045           type: string
32046           example: __VNFC-NAME__
32047         - name: nfc-naming-code
32048           in: query
32049           description: Short code that is used in naming instances of the item being modeled
32050           required: false
32051           type: string
32052         - name: nfc-function
32053           in: query
32054           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32055           required: false
32056           type: string
32057         - name: prov-status
32058           in: query
32059           description: prov status of this vnfc
32060           required: false
32061           type: string
32062         - name: ipaddress-v4-oam-vip
32063           in: query
32064           description: Oam V4 vip address of this vnfc
32065           required: false
32066           type: string
32067         - name: in-maint
32068           in: query
32069           required: false
32070           type: boolean
32071         - name: is-closed-loop-disabled
32072           in: query
32073           required: false
32074           type: boolean
32075         - name: group-notation
32076           in: query
32077           description: Group notation of VNFC
32078           required: false
32079           type: string
32080         - name: model-invariant-id
32081           in: query
32082           description: the ASDC model id for this resource or service model.
32083           required: false
32084           type: string
32085         - name: model-version-id
32086           in: query
32087           description: the ASDC model version for this resource or service model.
32088           required: false
32089           type: string
32090     put:
32091       tags:
32092         - Network
32093       summary: create or update an existing vnfc
32094       description: |
32095         Create or update an existing vnfc.
32096         #
32097         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32098       operationId: createOrUpdateNetworkVnfcsVnfc
32099       consumes:
32100         - application/json
32101         - application/xml
32102       produces:
32103         - application/json
32104         - application/xml
32105       responses:
32106         "default":
32107           description: Response codes found in [response codes](https://wiki.onap.org/).
32108       parameters:
32109         - name: vnfc-name
32110           in: path
32111           description: Unique ID of vnfc.
32112           required: true
32113           type: string
32114           example: __VNFC-NAME__
32115         - name: body
32116           in: body
32117           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
32118           required: true
32119           schema:
32120             $ref: "#/definitions/vnfc"
32121     patch:
32122       tags:
32123         - Network
32124       summary: update an existing vnfc
32125       description: |
32126         Update an existing vnfc
32127         #
32128         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32129         The PUT operation will entirely replace an existing object.
32130         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32131         #
32132         Other differences between PUT and PATCH are:
32133         #
32134         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32135         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32136         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32137       operationId: UpdateNetworkVnfcsVnfc
32138       consumes:
32139         - application/json
32140         - application/xml
32141       produces:
32142         - application/json
32143         - application/xml
32144       responses:
32145         "default":
32146           description: Response codes found in [response codes](https://wiki.onap.org/).
32147       parameters:
32148         - name: vnfc-name
32149           in: path
32150           description: Unique ID of vnfc.
32151           required: true
32152           type: string
32153           example: __VNFC-NAME__
32154         - name: body
32155           in: body
32156           description: vnfc object that needs to be created or updated.
32157           required: true
32158           schema:
32159             $ref: "#/patchDefinitions/vnfc"
32160     delete:
32161       tags:
32162         - Network
32163       summary: delete an existing vnfc
32164       description: delete an existing vnfc
32165       operationId: deleteNetworkVnfcsVnfc
32166       consumes:
32167         - application/json
32168         - application/xml
32169       produces:
32170         - application/json
32171         - application/xml
32172       responses:
32173         "default":
32174           description: Response codes found in [response codes](https://wiki.onap.org/).
32175       parameters:
32176         - name: vnfc-name
32177           in: path
32178           description: Unique ID of vnfc.
32179           required: true
32180           type: string
32181           example: __VNFC-NAME__
32182         - name: resource-version
32183           in: query
32184           description: resource-version for concurrency
32185           required: true
32186           type: string
32187   /network/vnfcs:
32188     get:
32189       tags:
32190         - Network
32191       summary: returns vnfcs
32192       description: returns vnfcs
32193       operationId: getNetworkVnfcs
32194       produces:
32195         - application/json
32196         - application/xml
32197       responses:
32198         "200":
32199           description: successful operation
32200           schema:
32201               $ref: "#/getDefinitions/vnfcs"
32202         "default":
32203           description: Response codes found in [response codes](https://wiki.onap.org/).
32204   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
32205     put:
32206       tags:
32207         - Network
32208       summary: see node definition for valid relationships
32209       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32210       consumes:
32211         - application/json
32212         - application/xml
32213       produces:
32214         - application/json
32215         - application/xml
32216       responses:
32217         "default":
32218           description: Response codes found in [response codes](https://wiki.onap.org/).
32219       parameters:
32220         - name: network-id
32221           in: path
32222           description: Network ID, should be uuid. Unique across A&AI.
32223           required: true
32224           type: string
32225           example: __NETWORK-ID__
32226         - name: subnet-id
32227           in: path
32228           description: Subnet ID, should be UUID.
32229           required: true
32230           type: string
32231           example: __SUBNET-ID__
32232         - name: host-route-id
32233           in: path
32234           description: host-route id
32235           required: true
32236           type: string
32237           example: __HOST-ROUTE-ID__
32238         - name: body
32239           in: body
32240           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32241           required: true
32242           schema:
32243             $ref: "#/definitions/relationship"
32244     delete:
32245       tags:
32246         - Network
32247       summary: delete an existing relationship
32248       description: delete an existing relationship
32249       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32250       consumes:
32251         - application/json
32252         - application/xml
32253       produces:
32254         - application/json
32255         - application/xml
32256       responses:
32257         "default":
32258           description: Response codes found in [response codes](https://wiki.onap.org/).
32259       parameters:
32260         - name: network-id
32261           in: path
32262           description: Network ID, should be uuid. Unique across A&AI.
32263           required: true
32264           type: string
32265           example: __NETWORK-ID__
32266         - name: subnet-id
32267           in: path
32268           description: Subnet ID, should be UUID.
32269           required: true
32270           type: string
32271           example: __SUBNET-ID__
32272         - name: host-route-id
32273           in: path
32274           description: host-route id
32275           required: true
32276           type: string
32277           example: __HOST-ROUTE-ID__
32278   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
32279     get:
32280       tags:
32281         - Network
32282       summary: returns host-route
32283       description: returns host-route
32284       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32285       produces:
32286         - application/json
32287         - application/xml
32288       responses:
32289         "200":
32290           description: successful operation
32291           schema:
32292               $ref: "#/getDefinitions/host-route"
32293         "default":
32294           description: Response codes found in [response codes](https://wiki.onap.org/).
32295       parameters:
32296         - name: network-id
32297           in: path
32298           description: Network ID, should be uuid. Unique across A&AI.
32299           required: true
32300           type: string
32301           example: __NETWORK-ID__
32302         - name: subnet-id
32303           in: path
32304           description: Subnet ID, should be UUID.
32305           required: true
32306           type: string
32307           example: __SUBNET-ID__
32308         - name: host-route-id
32309           in: path
32310           description: host-route id
32311           required: true
32312           type: string
32313           example: __HOST-ROUTE-ID__
32314         - name: network-name
32315           in: query
32316           description: Name of the network, governed by some naming convention..
32317           required: false
32318           type: string
32319         - name: network-role
32320           in: query
32321           description: Role the network plans - who defines these values?
32322           required: false
32323           type: string
32324         - name: service-id
32325           in: query
32326           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32327           required: false
32328           type: string
32329         - name: heat-stack-id
32330           in: query
32331           description: Heat stack id corresponding to this instance, managed by MSO
32332           required: false
32333           type: string
32334         - name: contrail-network-fqdn
32335           in: query
32336           description: Contrail FQDN for the network
32337           required: false
32338           type: string
32339         - name: model-invariant-id
32340           in: query
32341           description: the ASDC model id for this resource or service model.
32342           required: false
32343           type: string
32344         - name: model-version-id
32345           in: query
32346           description: the ASDC model version for this resource or service model.
32347           required: false
32348           type: string
32349         - name: widget-model-id
32350           in: query
32351           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32352           required: false
32353           type: string
32354         - name: widget-model-version
32355           in: query
32356           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32357           required: false
32358           type: string
32359         - name: subnet-name
32360           in: query
32361           description: Name associated with the subnet.
32362           required: false
32363           type: string
32364     put:
32365       tags:
32366         - Network
32367       summary: create or update an existing host-route
32368       description: |
32369         Create or update an existing host-route.
32370         #
32371         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32372       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32373       consumes:
32374         - application/json
32375         - application/xml
32376       produces:
32377         - application/json
32378         - application/xml
32379       responses:
32380         "default":
32381           description: Response codes found in [response codes](https://wiki.onap.org/).
32382       parameters:
32383         - name: network-id
32384           in: path
32385           description: Network ID, should be uuid. Unique across A&AI.
32386           required: true
32387           type: string
32388           example: __NETWORK-ID__
32389         - name: subnet-id
32390           in: path
32391           description: Subnet ID, should be UUID.
32392           required: true
32393           type: string
32394           example: __SUBNET-ID__
32395         - name: host-route-id
32396           in: path
32397           description: host-route id
32398           required: true
32399           type: string
32400           example: __HOST-ROUTE-ID__
32401         - name: body
32402           in: body
32403           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32404           required: true
32405           schema:
32406             $ref: "#/definitions/host-route"
32407     patch:
32408       tags:
32409         - Network
32410       summary: update an existing host-route
32411       description: |
32412         Update an existing host-route
32413         #
32414         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32415         The PUT operation will entirely replace an existing object.
32416         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32417         #
32418         Other differences between PUT and PATCH are:
32419         #
32420         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32421         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32422         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32423       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32424       consumes:
32425         - application/json
32426         - application/xml
32427       produces:
32428         - application/json
32429         - application/xml
32430       responses:
32431         "default":
32432           description: Response codes found in [response codes](https://wiki.onap.org/).
32433       parameters:
32434         - name: network-id
32435           in: path
32436           description: Network ID, should be uuid. Unique across A&AI.
32437           required: true
32438           type: string
32439           example: __NETWORK-ID__
32440         - name: subnet-id
32441           in: path
32442           description: Subnet ID, should be UUID.
32443           required: true
32444           type: string
32445           example: __SUBNET-ID__
32446         - name: host-route-id
32447           in: path
32448           description: host-route id
32449           required: true
32450           type: string
32451           example: __HOST-ROUTE-ID__
32452         - name: body
32453           in: body
32454           description: host-route object that needs to be created or updated.
32455           required: true
32456           schema:
32457             $ref: "#/patchDefinitions/host-route"
32458     delete:
32459       tags:
32460         - Network
32461       summary: delete an existing host-route
32462       description: delete an existing host-route
32463       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32464       consumes:
32465         - application/json
32466         - application/xml
32467       produces:
32468         - application/json
32469         - application/xml
32470       responses:
32471         "default":
32472           description: Response codes found in [response codes](https://wiki.onap.org/).
32473       parameters:
32474         - name: network-id
32475           in: path
32476           description: Network ID, should be uuid. Unique across A&AI.
32477           required: true
32478           type: string
32479           example: __NETWORK-ID__
32480         - name: subnet-id
32481           in: path
32482           description: Subnet ID, should be UUID.
32483           required: true
32484           type: string
32485           example: __SUBNET-ID__
32486         - name: host-route-id
32487           in: path
32488           description: host-route id
32489           required: true
32490           type: string
32491           example: __HOST-ROUTE-ID__
32492         - name: resource-version
32493           in: query
32494           description: resource-version for concurrency
32495           required: true
32496           type: string
32497   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
32498     get:
32499       tags:
32500         - Network
32501       summary: returns host-routes
32502       description: returns host-routes
32503       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
32504       produces:
32505         - application/json
32506         - application/xml
32507       responses:
32508         "200":
32509           description: successful operation
32510           schema:
32511               $ref: "#/getDefinitions/host-routes"
32512         "default":
32513           description: Response codes found in [response codes](https://wiki.onap.org/).
32514       parameters:
32515         - name: network-id
32516           in: path
32517           description: Network ID, should be uuid. Unique across A&AI.
32518           required: true
32519           type: string
32520           example: __NETWORK-ID__
32521         - name: subnet-id
32522           in: path
32523           description: Subnet ID, should be UUID.
32524           required: true
32525           type: string
32526           example: __SUBNET-ID__
32527         - name: network-name
32528           in: query
32529           description: Name of the network, governed by some naming convention..
32530           required: false
32531           type: string
32532         - name: network-role
32533           in: query
32534           description: Role the network plans - who defines these values?
32535           required: false
32536           type: string
32537         - name: service-id
32538           in: query
32539           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32540           required: false
32541           type: string
32542         - name: heat-stack-id
32543           in: query
32544           description: Heat stack id corresponding to this instance, managed by MSO
32545           required: false
32546           type: string
32547         - name: contrail-network-fqdn
32548           in: query
32549           description: Contrail FQDN for the network
32550           required: false
32551           type: string
32552         - name: model-invariant-id
32553           in: query
32554           description: the ASDC model id for this resource or service model.
32555           required: false
32556           type: string
32557         - name: model-version-id
32558           in: query
32559           description: the ASDC model version for this resource or service model.
32560           required: false
32561           type: string
32562         - name: widget-model-id
32563           in: query
32564           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32565           required: false
32566           type: string
32567         - name: widget-model-version
32568           in: query
32569           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32570           required: false
32571           type: string
32572         - name: subnet-name
32573           in: query
32574           description: Name associated with the subnet.
32575           required: false
32576           type: string
32577   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
32578     put:
32579       tags:
32580         - Network
32581       summary: see node definition for valid relationships
32582       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32583       consumes:
32584         - application/json
32585         - application/xml
32586       produces:
32587         - application/json
32588         - application/xml
32589       responses:
32590         "default":
32591           description: Response codes found in [response codes](https://wiki.onap.org/).
32592       parameters:
32593         - name: network-id
32594           in: path
32595           description: Network ID, should be uuid. Unique across A&AI.
32596           required: true
32597           type: string
32598           example: __NETWORK-ID__
32599         - name: subnet-id
32600           in: path
32601           description: Subnet ID, should be UUID.
32602           required: true
32603           type: string
32604           example: __SUBNET-ID__
32605         - name: body
32606           in: body
32607           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32608           required: true
32609           schema:
32610             $ref: "#/definitions/relationship"
32611     delete:
32612       tags:
32613         - Network
32614       summary: delete an existing relationship
32615       description: delete an existing relationship
32616       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32617       consumes:
32618         - application/json
32619         - application/xml
32620       produces:
32621         - application/json
32622         - application/xml
32623       responses:
32624         "default":
32625           description: Response codes found in [response codes](https://wiki.onap.org/).
32626       parameters:
32627         - name: network-id
32628           in: path
32629           description: Network ID, should be uuid. Unique across A&AI.
32630           required: true
32631           type: string
32632           example: __NETWORK-ID__
32633         - name: subnet-id
32634           in: path
32635           description: Subnet ID, should be UUID.
32636           required: true
32637           type: string
32638           example: __SUBNET-ID__
32639   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
32640     get:
32641       tags:
32642         - Network
32643       summary: returns subnet
32644       description: returns subnet
32645       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
32646       produces:
32647         - application/json
32648         - application/xml
32649       responses:
32650         "200":
32651           description: successful operation
32652           schema:
32653               $ref: "#/getDefinitions/subnet"
32654         "default":
32655           description: Response codes found in [response codes](https://wiki.onap.org/).
32656       parameters:
32657         - name: network-id
32658           in: path
32659           description: Network ID, should be uuid. Unique across A&AI.
32660           required: true
32661           type: string
32662           example: __NETWORK-ID__
32663         - name: subnet-id
32664           in: path
32665           description: Subnet ID, should be UUID.
32666           required: true
32667           type: string
32668           example: __SUBNET-ID__
32669         - name: network-name
32670           in: query
32671           description: Name of the network, governed by some naming convention..
32672           required: false
32673           type: string
32674         - name: network-role
32675           in: query
32676           description: Role the network plans - who defines these values?
32677           required: false
32678           type: string
32679         - name: service-id
32680           in: query
32681           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32682           required: false
32683           type: string
32684         - name: heat-stack-id
32685           in: query
32686           description: Heat stack id corresponding to this instance, managed by MSO
32687           required: false
32688           type: string
32689         - name: contrail-network-fqdn
32690           in: query
32691           description: Contrail FQDN for the network
32692           required: false
32693           type: string
32694         - name: model-invariant-id
32695           in: query
32696           description: the ASDC model id for this resource or service model.
32697           required: false
32698           type: string
32699         - name: model-version-id
32700           in: query
32701           description: the ASDC model version for this resource or service model.
32702           required: false
32703           type: string
32704         - name: widget-model-id
32705           in: query
32706           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32707           required: false
32708           type: string
32709         - name: widget-model-version
32710           in: query
32711           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32712           required: false
32713           type: string
32714         - name: subnet-name
32715           in: query
32716           description: Name associated with the subnet.
32717           required: false
32718           type: string
32719     put:
32720       tags:
32721         - Network
32722       summary: create or update an existing subnet
32723       description: |
32724         Create or update an existing subnet.
32725         #
32726         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32727       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32728       consumes:
32729         - application/json
32730         - application/xml
32731       produces:
32732         - application/json
32733         - application/xml
32734       responses:
32735         "default":
32736           description: Response codes found in [response codes](https://wiki.onap.org/).
32737       parameters:
32738         - name: network-id
32739           in: path
32740           description: Network ID, should be uuid. Unique across A&AI.
32741           required: true
32742           type: string
32743           example: __NETWORK-ID__
32744         - name: subnet-id
32745           in: path
32746           description: Subnet ID, should be UUID.
32747           required: true
32748           type: string
32749           example: __SUBNET-ID__
32750         - name: body
32751           in: body
32752           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32753           required: true
32754           schema:
32755             $ref: "#/definitions/subnet"
32756     patch:
32757       tags:
32758         - Network
32759       summary: update an existing subnet
32760       description: |
32761         Update an existing subnet
32762         #
32763         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32764         The PUT operation will entirely replace an existing object.
32765         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32766         #
32767         Other differences between PUT and PATCH are:
32768         #
32769         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32770         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32771         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32772       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32773       consumes:
32774         - application/json
32775         - application/xml
32776       produces:
32777         - application/json
32778         - application/xml
32779       responses:
32780         "default":
32781           description: Response codes found in [response codes](https://wiki.onap.org/).
32782       parameters:
32783         - name: network-id
32784           in: path
32785           description: Network ID, should be uuid. Unique across A&AI.
32786           required: true
32787           type: string
32788           example: __NETWORK-ID__
32789         - name: subnet-id
32790           in: path
32791           description: Subnet ID, should be UUID.
32792           required: true
32793           type: string
32794           example: __SUBNET-ID__
32795         - name: body
32796           in: body
32797           description: subnet object that needs to be created or updated.
32798           required: true
32799           schema:
32800             $ref: "#/patchDefinitions/subnet"
32801     delete:
32802       tags:
32803         - Network
32804       summary: delete an existing subnet
32805       description: delete an existing subnet
32806       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
32807       consumes:
32808         - application/json
32809         - application/xml
32810       produces:
32811         - application/json
32812         - application/xml
32813       responses:
32814         "default":
32815           description: Response codes found in [response codes](https://wiki.onap.org/).
32816       parameters:
32817         - name: network-id
32818           in: path
32819           description: Network ID, should be uuid. Unique across A&AI.
32820           required: true
32821           type: string
32822           example: __NETWORK-ID__
32823         - name: subnet-id
32824           in: path
32825           description: Subnet ID, should be UUID.
32826           required: true
32827           type: string
32828           example: __SUBNET-ID__
32829         - name: resource-version
32830           in: query
32831           description: resource-version for concurrency
32832           required: true
32833           type: string
32834   /network/l3-networks/l3-network/{network-id}/subnets:
32835     get:
32836       tags:
32837         - Network
32838       summary: returns subnets
32839       description: returns subnets
32840       operationId: getNetworkL3NetworksL3NetworkSubnets
32841       produces:
32842         - application/json
32843         - application/xml
32844       responses:
32845         "200":
32846           description: successful operation
32847           schema:
32848               $ref: "#/getDefinitions/subnets"
32849         "default":
32850           description: Response codes found in [response codes](https://wiki.onap.org/).
32851       parameters:
32852         - name: network-id
32853           in: path
32854           description: Network ID, should be uuid. Unique across A&AI.
32855           required: true
32856           type: string
32857           example: __NETWORK-ID__
32858         - name: network-name
32859           in: query
32860           description: Name of the network, governed by some naming convention..
32861           required: false
32862           type: string
32863         - name: network-role
32864           in: query
32865           description: Role the network plans - who defines these values?
32866           required: false
32867           type: string
32868         - name: service-id
32869           in: query
32870           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32871           required: false
32872           type: string
32873         - name: heat-stack-id
32874           in: query
32875           description: Heat stack id corresponding to this instance, managed by MSO
32876           required: false
32877           type: string
32878         - name: contrail-network-fqdn
32879           in: query
32880           description: Contrail FQDN for the network
32881           required: false
32882           type: string
32883         - name: model-invariant-id
32884           in: query
32885           description: the ASDC model id for this resource or service model.
32886           required: false
32887           type: string
32888         - name: model-version-id
32889           in: query
32890           description: the ASDC model version for this resource or service model.
32891           required: false
32892           type: string
32893         - name: widget-model-id
32894           in: query
32895           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32896           required: false
32897           type: string
32898         - name: widget-model-version
32899           in: query
32900           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32901           required: false
32902           type: string
32903   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
32904     put:
32905       tags:
32906         - Network
32907       summary: see node definition for valid relationships
32908       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
32909       consumes:
32910         - application/json
32911         - application/xml
32912       produces:
32913         - application/json
32914         - application/xml
32915       responses:
32916         "default":
32917           description: Response codes found in [response codes](https://wiki.onap.org/).
32918       parameters:
32919         - name: network-id
32920           in: path
32921           description: Network ID, should be uuid. Unique across A&AI.
32922           required: true
32923           type: string
32924           example: __NETWORK-ID__
32925         - name: vlan-id-inner
32926           in: path
32927           description: id.
32928           required: true
32929           type: integer
32930           format: int64
32931           example: __VLAN-ID-INNER__
32932         - name: body
32933           in: body
32934           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
32935           required: true
32936           schema:
32937             $ref: "#/definitions/relationship"
32938     delete:
32939       tags:
32940         - Network
32941       summary: delete an existing relationship
32942       description: delete an existing relationship
32943       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
32944       consumes:
32945         - application/json
32946         - application/xml
32947       produces:
32948         - application/json
32949         - application/xml
32950       responses:
32951         "default":
32952           description: Response codes found in [response codes](https://wiki.onap.org/).
32953       parameters:
32954         - name: network-id
32955           in: path
32956           description: Network ID, should be uuid. Unique across A&AI.
32957           required: true
32958           type: string
32959           example: __NETWORK-ID__
32960         - name: vlan-id-inner
32961           in: path
32962           description: id.
32963           required: true
32964           type: integer
32965           format: int64
32966           example: __VLAN-ID-INNER__
32967   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
32968     get:
32969       tags:
32970         - Network
32971       summary: returns ctag-assignment
32972       description: returns ctag-assignment
32973       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
32974       produces:
32975         - application/json
32976         - application/xml
32977       responses:
32978         "200":
32979           description: successful operation
32980           schema:
32981               $ref: "#/getDefinitions/ctag-assignment"
32982         "default":
32983           description: Response codes found in [response codes](https://wiki.onap.org/).
32984       parameters:
32985         - name: network-id
32986           in: path
32987           description: Network ID, should be uuid. Unique across A&AI.
32988           required: true
32989           type: string
32990           example: __NETWORK-ID__
32991         - name: vlan-id-inner
32992           in: path
32993           description: id.
32994           required: true
32995           type: integer
32996           format: int64
32997           example: __VLAN-ID-INNER__
32998         - name: network-name
32999           in: query
33000           description: Name of the network, governed by some naming convention..
33001           required: false
33002           type: string
33003         - name: network-role
33004           in: query
33005           description: Role the network plans - who defines these values?
33006           required: false
33007           type: string
33008         - name: service-id
33009           in: query
33010           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33011           required: false
33012           type: string
33013         - name: heat-stack-id
33014           in: query
33015           description: Heat stack id corresponding to this instance, managed by MSO
33016           required: false
33017           type: string
33018         - name: contrail-network-fqdn
33019           in: query
33020           description: Contrail FQDN for the network
33021           required: false
33022           type: string
33023         - name: model-invariant-id
33024           in: query
33025           description: the ASDC model id for this resource or service model.
33026           required: false
33027           type: string
33028         - name: model-version-id
33029           in: query
33030           description: the ASDC model version for this resource or service model.
33031           required: false
33032           type: string
33033         - name: widget-model-id
33034           in: query
33035           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33036           required: false
33037           type: string
33038         - name: widget-model-version
33039           in: query
33040           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33041           required: false
33042           type: string
33043     put:
33044       tags:
33045         - Network
33046       summary: create or update an existing ctag-assignment
33047       description: |
33048         Create or update an existing ctag-assignment.
33049         #
33050         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33051       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33052       consumes:
33053         - application/json
33054         - application/xml
33055       produces:
33056         - application/json
33057         - application/xml
33058       responses:
33059         "default":
33060           description: Response codes found in [response codes](https://wiki.onap.org/).
33061       parameters:
33062         - name: network-id
33063           in: path
33064           description: Network ID, should be uuid. Unique across A&AI.
33065           required: true
33066           type: string
33067           example: __NETWORK-ID__
33068         - name: vlan-id-inner
33069           in: path
33070           description: id.
33071           required: true
33072           type: integer
33073           format: int64
33074           example: __VLAN-ID-INNER__
33075         - name: body
33076           in: body
33077           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
33078           required: true
33079           schema:
33080             $ref: "#/definitions/ctag-assignment"
33081     patch:
33082       tags:
33083         - Network
33084       summary: update an existing ctag-assignment
33085       description: |
33086         Update an existing ctag-assignment
33087         #
33088         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33089         The PUT operation will entirely replace an existing object.
33090         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33091         #
33092         Other differences between PUT and PATCH are:
33093         #
33094         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33095         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33096         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33097       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33098       consumes:
33099         - application/json
33100         - application/xml
33101       produces:
33102         - application/json
33103         - application/xml
33104       responses:
33105         "default":
33106           description: Response codes found in [response codes](https://wiki.onap.org/).
33107       parameters:
33108         - name: network-id
33109           in: path
33110           description: Network ID, should be uuid. Unique across A&AI.
33111           required: true
33112           type: string
33113           example: __NETWORK-ID__
33114         - name: vlan-id-inner
33115           in: path
33116           description: id.
33117           required: true
33118           type: integer
33119           format: int64
33120           example: __VLAN-ID-INNER__
33121         - name: body
33122           in: body
33123           description: ctag-assignment object that needs to be created or updated.
33124           required: true
33125           schema:
33126             $ref: "#/patchDefinitions/ctag-assignment"
33127     delete:
33128       tags:
33129         - Network
33130       summary: delete an existing ctag-assignment
33131       description: delete an existing ctag-assignment
33132       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33133       consumes:
33134         - application/json
33135         - application/xml
33136       produces:
33137         - application/json
33138         - application/xml
33139       responses:
33140         "default":
33141           description: Response codes found in [response codes](https://wiki.onap.org/).
33142       parameters:
33143         - name: network-id
33144           in: path
33145           description: Network ID, should be uuid. Unique across A&AI.
33146           required: true
33147           type: string
33148           example: __NETWORK-ID__
33149         - name: vlan-id-inner
33150           in: path
33151           description: id.
33152           required: true
33153           type: integer
33154           format: int64
33155           example: __VLAN-ID-INNER__
33156         - name: resource-version
33157           in: query
33158           description: resource-version for concurrency
33159           required: true
33160           type: string
33161   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
33162     get:
33163       tags:
33164         - Network
33165       summary: returns ctag-assignments
33166       description: returns ctag-assignments
33167       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
33168       produces:
33169         - application/json
33170         - application/xml
33171       responses:
33172         "200":
33173           description: successful operation
33174           schema:
33175               $ref: "#/getDefinitions/ctag-assignments"
33176         "default":
33177           description: Response codes found in [response codes](https://wiki.onap.org/).
33178       parameters:
33179         - name: network-id
33180           in: path
33181           description: Network ID, should be uuid. Unique across A&AI.
33182           required: true
33183           type: string
33184           example: __NETWORK-ID__
33185         - name: network-name
33186           in: query
33187           description: Name of the network, governed by some naming convention..
33188           required: false
33189           type: string
33190         - name: network-role
33191           in: query
33192           description: Role the network plans - who defines these values?
33193           required: false
33194           type: string
33195         - name: service-id
33196           in: query
33197           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33198           required: false
33199           type: string
33200         - name: heat-stack-id
33201           in: query
33202           description: Heat stack id corresponding to this instance, managed by MSO
33203           required: false
33204           type: string
33205         - name: contrail-network-fqdn
33206           in: query
33207           description: Contrail FQDN for the network
33208           required: false
33209           type: string
33210         - name: model-invariant-id
33211           in: query
33212           description: the ASDC model id for this resource or service model.
33213           required: false
33214           type: string
33215         - name: model-version-id
33216           in: query
33217           description: the ASDC model version for this resource or service model.
33218           required: false
33219           type: string
33220         - name: widget-model-id
33221           in: query
33222           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33223           required: false
33224           type: string
33225         - name: widget-model-version
33226           in: query
33227           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33228           required: false
33229           type: string
33230   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
33231     put:
33232       tags:
33233         - Network
33234       summary: see node definition for valid relationships
33235       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33236       consumes:
33237         - application/json
33238         - application/xml
33239       produces:
33240         - application/json
33241         - application/xml
33242       responses:
33243         "default":
33244           description: Response codes found in [response codes](https://wiki.onap.org/).
33245       parameters:
33246         - name: network-id
33247           in: path
33248           description: Network ID, should be uuid. Unique across A&AI.
33249           required: true
33250           type: string
33251           example: __NETWORK-ID__
33252         - name: segmentation-id
33253           in: path
33254           description: Route Table Reference id, UUID assigned to this instance.
33255           required: true
33256           type: string
33257           example: __SEGMENTATION-ID__
33258         - name: body
33259           in: body
33260           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33261           required: true
33262           schema:
33263             $ref: "#/definitions/relationship"
33264     delete:
33265       tags:
33266         - Network
33267       summary: delete an existing relationship
33268       description: delete an existing relationship
33269       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33270       consumes:
33271         - application/json
33272         - application/xml
33273       produces:
33274         - application/json
33275         - application/xml
33276       responses:
33277         "default":
33278           description: Response codes found in [response codes](https://wiki.onap.org/).
33279       parameters:
33280         - name: network-id
33281           in: path
33282           description: Network ID, should be uuid. Unique across A&AI.
33283           required: true
33284           type: string
33285           example: __NETWORK-ID__
33286         - name: segmentation-id
33287           in: path
33288           description: Route Table Reference id, UUID assigned to this instance.
33289           required: true
33290           type: string
33291           example: __SEGMENTATION-ID__
33292   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
33293     get:
33294       tags:
33295         - Network
33296       summary: returns segmentation-assignment
33297       description: returns segmentation-assignment
33298       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33299       produces:
33300         - application/json
33301         - application/xml
33302       responses:
33303         "200":
33304           description: successful operation
33305           schema:
33306               $ref: "#/getDefinitions/segmentation-assignment"
33307         "default":
33308           description: Response codes found in [response codes](https://wiki.onap.org/).
33309       parameters:
33310         - name: network-id
33311           in: path
33312           description: Network ID, should be uuid. Unique across A&AI.
33313           required: true
33314           type: string
33315           example: __NETWORK-ID__
33316         - name: segmentation-id
33317           in: path
33318           description: Route Table Reference id, UUID assigned to this instance.
33319           required: true
33320           type: string
33321           example: __SEGMENTATION-ID__
33322         - name: network-name
33323           in: query
33324           description: Name of the network, governed by some naming convention..
33325           required: false
33326           type: string
33327         - name: network-role
33328           in: query
33329           description: Role the network plans - who defines these values?
33330           required: false
33331           type: string
33332         - name: service-id
33333           in: query
33334           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33335           required: false
33336           type: string
33337         - name: heat-stack-id
33338           in: query
33339           description: Heat stack id corresponding to this instance, managed by MSO
33340           required: false
33341           type: string
33342         - name: contrail-network-fqdn
33343           in: query
33344           description: Contrail FQDN for the network
33345           required: false
33346           type: string
33347         - name: model-invariant-id
33348           in: query
33349           description: the ASDC model id for this resource or service model.
33350           required: false
33351           type: string
33352         - name: model-version-id
33353           in: query
33354           description: the ASDC model version for this resource or service model.
33355           required: false
33356           type: string
33357         - name: widget-model-id
33358           in: query
33359           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33360           required: false
33361           type: string
33362         - name: widget-model-version
33363           in: query
33364           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33365           required: false
33366           type: string
33367     put:
33368       tags:
33369         - Network
33370       summary: create or update an existing segmentation-assignment
33371       description: |
33372         Create or update an existing segmentation-assignment.
33373         #
33374         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33375       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33376       consumes:
33377         - application/json
33378         - application/xml
33379       produces:
33380         - application/json
33381         - application/xml
33382       responses:
33383         "default":
33384           description: Response codes found in [response codes](https://wiki.onap.org/).
33385       parameters:
33386         - name: network-id
33387           in: path
33388           description: Network ID, should be uuid. Unique across A&AI.
33389           required: true
33390           type: string
33391           example: __NETWORK-ID__
33392         - name: segmentation-id
33393           in: path
33394           description: Route Table Reference id, UUID assigned to this instance.
33395           required: true
33396           type: string
33397           example: __SEGMENTATION-ID__
33398         - name: body
33399           in: body
33400           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33401           required: true
33402           schema:
33403             $ref: "#/definitions/segmentation-assignment"
33404     patch:
33405       tags:
33406         - Network
33407       summary: update an existing segmentation-assignment
33408       description: |
33409         Update an existing segmentation-assignment
33410         #
33411         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33412         The PUT operation will entirely replace an existing object.
33413         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33414         #
33415         Other differences between PUT and PATCH are:
33416         #
33417         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33418         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33419         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33420       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33421       consumes:
33422         - application/json
33423         - application/xml
33424       produces:
33425         - application/json
33426         - application/xml
33427       responses:
33428         "default":
33429           description: Response codes found in [response codes](https://wiki.onap.org/).
33430       parameters:
33431         - name: network-id
33432           in: path
33433           description: Network ID, should be uuid. Unique across A&AI.
33434           required: true
33435           type: string
33436           example: __NETWORK-ID__
33437         - name: segmentation-id
33438           in: path
33439           description: Route Table Reference id, UUID assigned to this instance.
33440           required: true
33441           type: string
33442           example: __SEGMENTATION-ID__
33443         - name: body
33444           in: body
33445           description: segmentation-assignment object that needs to be created or updated.
33446           required: true
33447           schema:
33448             $ref: "#/patchDefinitions/segmentation-assignment"
33449     delete:
33450       tags:
33451         - Network
33452       summary: delete an existing segmentation-assignment
33453       description: delete an existing segmentation-assignment
33454       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33455       consumes:
33456         - application/json
33457         - application/xml
33458       produces:
33459         - application/json
33460         - application/xml
33461       responses:
33462         "default":
33463           description: Response codes found in [response codes](https://wiki.onap.org/).
33464       parameters:
33465         - name: network-id
33466           in: path
33467           description: Network ID, should be uuid. Unique across A&AI.
33468           required: true
33469           type: string
33470           example: __NETWORK-ID__
33471         - name: segmentation-id
33472           in: path
33473           description: Route Table Reference id, UUID assigned to this instance.
33474           required: true
33475           type: string
33476           example: __SEGMENTATION-ID__
33477         - name: resource-version
33478           in: query
33479           description: resource-version for concurrency
33480           required: true
33481           type: string
33482   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
33483     get:
33484       tags:
33485         - Network
33486       summary: returns segmentation-assignments
33487       description: returns segmentation-assignments
33488       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
33489       produces:
33490         - application/json
33491         - application/xml
33492       responses:
33493         "200":
33494           description: successful operation
33495           schema:
33496               $ref: "#/getDefinitions/segmentation-assignments"
33497         "default":
33498           description: Response codes found in [response codes](https://wiki.onap.org/).
33499       parameters:
33500         - name: network-id
33501           in: path
33502           description: Network ID, should be uuid. Unique across A&AI.
33503           required: true
33504           type: string
33505           example: __NETWORK-ID__
33506         - name: network-name
33507           in: query
33508           description: Name of the network, governed by some naming convention..
33509           required: false
33510           type: string
33511         - name: network-role
33512           in: query
33513           description: Role the network plans - who defines these values?
33514           required: false
33515           type: string
33516         - name: service-id
33517           in: query
33518           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33519           required: false
33520           type: string
33521         - name: heat-stack-id
33522           in: query
33523           description: Heat stack id corresponding to this instance, managed by MSO
33524           required: false
33525           type: string
33526         - name: contrail-network-fqdn
33527           in: query
33528           description: Contrail FQDN for the network
33529           required: false
33530           type: string
33531         - name: model-invariant-id
33532           in: query
33533           description: the ASDC model id for this resource or service model.
33534           required: false
33535           type: string
33536         - name: model-version-id
33537           in: query
33538           description: the ASDC model version for this resource or service model.
33539           required: false
33540           type: string
33541         - name: widget-model-id
33542           in: query
33543           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33544           required: false
33545           type: string
33546         - name: widget-model-version
33547           in: query
33548           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33549           required: false
33550           type: string
33551   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
33552     put:
33553       tags:
33554         - Network
33555       summary: see node definition for valid relationships
33556       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
33557       consumes:
33558         - application/json
33559         - application/xml
33560       produces:
33561         - application/json
33562         - application/xml
33563       responses:
33564         "default":
33565           description: Response codes found in [response codes](https://wiki.onap.org/).
33566       parameters:
33567         - name: network-id
33568           in: path
33569           description: Network ID, should be uuid. Unique across A&AI.
33570           required: true
33571           type: string
33572           example: __NETWORK-ID__
33573         - name: body
33574           in: body
33575           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
33576           required: true
33577           schema:
33578             $ref: "#/definitions/relationship"
33579     delete:
33580       tags:
33581         - Network
33582       summary: delete an existing relationship
33583       description: delete an existing relationship
33584       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
33585       consumes:
33586         - application/json
33587         - application/xml
33588       produces:
33589         - application/json
33590         - application/xml
33591       responses:
33592         "default":
33593           description: Response codes found in [response codes](https://wiki.onap.org/).
33594       parameters:
33595         - name: network-id
33596           in: path
33597           description: Network ID, should be uuid. Unique across A&AI.
33598           required: true
33599           type: string
33600           example: __NETWORK-ID__
33601   /network/l3-networks/l3-network/{network-id}:
33602     get:
33603       tags:
33604         - Network
33605       summary: returns l3-network
33606       description: returns l3-network
33607       operationId: getNetworkL3NetworksL3Network
33608       produces:
33609         - application/json
33610         - application/xml
33611       responses:
33612         "200":
33613           description: successful operation
33614           schema:
33615               $ref: "#/getDefinitions/l3-network"
33616         "default":
33617           description: Response codes found in [response codes](https://wiki.onap.org/).
33618       parameters:
33619         - name: network-id
33620           in: path
33621           description: Network ID, should be uuid. Unique across A&AI.
33622           required: true
33623           type: string
33624           example: __NETWORK-ID__
33625         - name: network-name
33626           in: query
33627           description: Name of the network, governed by some naming convention..
33628           required: false
33629           type: string
33630         - name: network-role
33631           in: query
33632           description: Role the network plans - who defines these values?
33633           required: false
33634           type: string
33635         - name: service-id
33636           in: query
33637           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33638           required: false
33639           type: string
33640         - name: heat-stack-id
33641           in: query
33642           description: Heat stack id corresponding to this instance, managed by MSO
33643           required: false
33644           type: string
33645         - name: contrail-network-fqdn
33646           in: query
33647           description: Contrail FQDN for the network
33648           required: false
33649           type: string
33650         - name: model-invariant-id
33651           in: query
33652           description: the ASDC model id for this resource or service model.
33653           required: false
33654           type: string
33655         - name: model-version-id
33656           in: query
33657           description: the ASDC model version for this resource or service model.
33658           required: false
33659           type: string
33660         - name: widget-model-id
33661           in: query
33662           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33663           required: false
33664           type: string
33665         - name: widget-model-version
33666           in: query
33667           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33668           required: false
33669           type: string
33670     put:
33671       tags:
33672         - Network
33673       summary: create or update an existing l3-network
33674       description: |
33675         Create or update an existing l3-network.
33676         #
33677         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33678       operationId: createOrUpdateNetworkL3NetworksL3Network
33679       consumes:
33680         - application/json
33681         - application/xml
33682       produces:
33683         - application/json
33684         - application/xml
33685       responses:
33686         "default":
33687           description: Response codes found in [response codes](https://wiki.onap.org/).
33688       parameters:
33689         - name: network-id
33690           in: path
33691           description: Network ID, should be uuid. Unique across A&AI.
33692           required: true
33693           type: string
33694           example: __NETWORK-ID__
33695         - name: body
33696           in: body
33697           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
33698           required: true
33699           schema:
33700             $ref: "#/definitions/l3-network"
33701     patch:
33702       tags:
33703         - Network
33704       summary: update an existing l3-network
33705       description: |
33706         Update an existing l3-network
33707         #
33708         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33709         The PUT operation will entirely replace an existing object.
33710         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33711         #
33712         Other differences between PUT and PATCH are:
33713         #
33714         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33715         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33716         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33717       operationId: UpdateNetworkL3NetworksL3Network
33718       consumes:
33719         - application/json
33720         - application/xml
33721       produces:
33722         - application/json
33723         - application/xml
33724       responses:
33725         "default":
33726           description: Response codes found in [response codes](https://wiki.onap.org/).
33727       parameters:
33728         - name: network-id
33729           in: path
33730           description: Network ID, should be uuid. Unique across A&AI.
33731           required: true
33732           type: string
33733           example: __NETWORK-ID__
33734         - name: body
33735           in: body
33736           description: l3-network object that needs to be created or updated.
33737           required: true
33738           schema:
33739             $ref: "#/patchDefinitions/l3-network"
33740     delete:
33741       tags:
33742         - Network
33743       summary: delete an existing l3-network
33744       description: delete an existing l3-network
33745       operationId: deleteNetworkL3NetworksL3Network
33746       consumes:
33747         - application/json
33748         - application/xml
33749       produces:
33750         - application/json
33751         - application/xml
33752       responses:
33753         "default":
33754           description: Response codes found in [response codes](https://wiki.onap.org/).
33755       parameters:
33756         - name: network-id
33757           in: path
33758           description: Network ID, should be uuid. Unique across A&AI.
33759           required: true
33760           type: string
33761           example: __NETWORK-ID__
33762         - name: resource-version
33763           in: query
33764           description: resource-version for concurrency
33765           required: true
33766           type: string
33767   /network/l3-networks:
33768     get:
33769       tags:
33770         - Network
33771       summary: returns l3-networks
33772       description: returns l3-networks
33773       operationId: getNetworkL3Networks
33774       produces:
33775         - application/json
33776         - application/xml
33777       responses:
33778         "200":
33779           description: successful operation
33780           schema:
33781               $ref: "#/getDefinitions/l3-networks"
33782         "default":
33783           description: Response codes found in [response codes](https://wiki.onap.org/).
33784   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
33785     put:
33786       tags:
33787         - Network
33788       summary: see node definition for valid relationships
33789       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33790       consumes:
33791         - application/json
33792         - application/xml
33793       produces:
33794         - application/json
33795         - application/xml
33796       responses:
33797         "default":
33798           description: Response codes found in [response codes](https://wiki.onap.org/).
33799       parameters:
33800         - name: network-policy-id
33801           in: path
33802           description: UUID representing unique key to this instance
33803           required: true
33804           type: string
33805           example: __NETWORK-POLICY-ID__
33806         - name: body
33807           in: body
33808           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
33809           required: true
33810           schema:
33811             $ref: "#/definitions/relationship"
33812     delete:
33813       tags:
33814         - Network
33815       summary: delete an existing relationship
33816       description: delete an existing relationship
33817       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33818       consumes:
33819         - application/json
33820         - application/xml
33821       produces:
33822         - application/json
33823         - application/xml
33824       responses:
33825         "default":
33826           description: Response codes found in [response codes](https://wiki.onap.org/).
33827       parameters:
33828         - name: network-policy-id
33829           in: path
33830           description: UUID representing unique key to this instance
33831           required: true
33832           type: string
33833           example: __NETWORK-POLICY-ID__
33834   /network/network-policies/network-policy/{network-policy-id}:
33835     get:
33836       tags:
33837         - Network
33838       summary: returns network-policy
33839       description: returns network-policy
33840       operationId: getNetworkNetworkPoliciesNetworkPolicy
33841       produces:
33842         - application/json
33843         - application/xml
33844       responses:
33845         "200":
33846           description: successful operation
33847           schema:
33848               $ref: "#/getDefinitions/network-policy"
33849         "default":
33850           description: Response codes found in [response codes](https://wiki.onap.org/).
33851       parameters:
33852         - name: network-policy-id
33853           in: path
33854           description: UUID representing unique key to this instance
33855           required: true
33856           type: string
33857           example: __NETWORK-POLICY-ID__
33858         - name: network-policy-fqdn
33859           in: query
33860           description: Contrail FQDN for the policy
33861           required: false
33862           type: string
33863     put:
33864       tags:
33865         - Network
33866       summary: create or update an existing network-policy
33867       description: |
33868         Create or update an existing network-policy.
33869         #
33870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33871       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
33872       consumes:
33873         - application/json
33874         - application/xml
33875       produces:
33876         - application/json
33877         - application/xml
33878       responses:
33879         "default":
33880           description: Response codes found in [response codes](https://wiki.onap.org/).
33881       parameters:
33882         - name: network-policy-id
33883           in: path
33884           description: UUID representing unique key to this instance
33885           required: true
33886           type: string
33887           example: __NETWORK-POLICY-ID__
33888         - name: body
33889           in: body
33890           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
33891           required: true
33892           schema:
33893             $ref: "#/definitions/network-policy"
33894     patch:
33895       tags:
33896         - Network
33897       summary: update an existing network-policy
33898       description: |
33899         Update an existing network-policy
33900         #
33901         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33902         The PUT operation will entirely replace an existing object.
33903         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33904         #
33905         Other differences between PUT and PATCH are:
33906         #
33907         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33908         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33909         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33910       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
33911       consumes:
33912         - application/json
33913         - application/xml
33914       produces:
33915         - application/json
33916         - application/xml
33917       responses:
33918         "default":
33919           description: Response codes found in [response codes](https://wiki.onap.org/).
33920       parameters:
33921         - name: network-policy-id
33922           in: path
33923           description: UUID representing unique key to this instance
33924           required: true
33925           type: string
33926           example: __NETWORK-POLICY-ID__
33927         - name: body
33928           in: body
33929           description: network-policy object that needs to be created or updated.
33930           required: true
33931           schema:
33932             $ref: "#/patchDefinitions/network-policy"
33933     delete:
33934       tags:
33935         - Network
33936       summary: delete an existing network-policy
33937       description: delete an existing network-policy
33938       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
33939       consumes:
33940         - application/json
33941         - application/xml
33942       produces:
33943         - application/json
33944         - application/xml
33945       responses:
33946         "default":
33947           description: Response codes found in [response codes](https://wiki.onap.org/).
33948       parameters:
33949         - name: network-policy-id
33950           in: path
33951           description: UUID representing unique key to this instance
33952           required: true
33953           type: string
33954           example: __NETWORK-POLICY-ID__
33955         - name: resource-version
33956           in: query
33957           description: resource-version for concurrency
33958           required: true
33959           type: string
33960   /network/network-policies:
33961     get:
33962       tags:
33963         - Network
33964       summary: returns network-policies
33965       description: returns network-policies
33966       operationId: getNetworkNetworkPolicies
33967       produces:
33968         - application/json
33969         - application/xml
33970       responses:
33971         "200":
33972           description: successful operation
33973           schema:
33974               $ref: "#/getDefinitions/network-policies"
33975         "default":
33976           description: Response codes found in [response codes](https://wiki.onap.org/).
33977   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
33978     put:
33979       tags:
33980         - Network
33981       summary: see node definition for valid relationships
33982       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
33983       consumes:
33984         - application/json
33985         - application/xml
33986       produces:
33987         - application/json
33988         - application/xml
33989       responses:
33990         "default":
33991           description: Response codes found in [response codes](https://wiki.onap.org/).
33992       parameters:
33993         - name: vnf-id
33994           in: path
33995           description: Unique id of VNF.  This is unique across the graph.
33996           required: true
33997           type: string
33998           example: __VNF-ID__
33999         - name: body
34000           in: body
34001           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
34002           required: true
34003           schema:
34004             $ref: "#/definitions/relationship"
34005     delete:
34006       tags:
34007         - Network
34008       summary: delete an existing relationship
34009       description: delete an existing relationship
34010       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
34011       consumes:
34012         - application/json
34013         - application/xml
34014       produces:
34015         - application/json
34016         - application/xml
34017       responses:
34018         "default":
34019           description: Response codes found in [response codes](https://wiki.onap.org/).
34020       parameters:
34021         - name: vnf-id
34022           in: path
34023           description: Unique id of VNF.  This is unique across the graph.
34024           required: true
34025           type: string
34026           example: __VNF-ID__
34027   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34028     put:
34029       tags:
34030         - Network
34031       summary: see node definition for valid relationships
34032       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34033       consumes:
34034         - application/json
34035         - application/xml
34036       produces:
34037         - application/json
34038         - application/xml
34039       responses:
34040         "default":
34041           description: Response codes found in [response codes](https://wiki.onap.org/).
34042       parameters:
34043         - name: vnf-id
34044           in: path
34045           description: Unique id of VNF.  This is unique across the graph.
34046           required: true
34047           type: string
34048           example: __VNF-ID__
34049         - name: interface-name
34050           in: path
34051           description: Name given to the interface
34052           required: true
34053           type: string
34054           example: __INTERFACE-NAME__
34055         - name: vlan-interface
34056           in: path
34057           description: String that identifies the interface
34058           required: true
34059           type: string
34060           example: __VLAN-INTERFACE__
34061         - name: body
34062           in: body
34063           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
34064           required: true
34065           schema:
34066             $ref: "#/definitions/relationship"
34067     delete:
34068       tags:
34069         - Network
34070       summary: delete an existing relationship
34071       description: delete an existing relationship
34072       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34073       consumes:
34074         - application/json
34075         - application/xml
34076       produces:
34077         - application/json
34078         - application/xml
34079       responses:
34080         "default":
34081           description: Response codes found in [response codes](https://wiki.onap.org/).
34082       parameters:
34083         - name: vnf-id
34084           in: path
34085           description: Unique id of VNF.  This is unique across the graph.
34086           required: true
34087           type: string
34088           example: __VNF-ID__
34089         - name: interface-name
34090           in: path
34091           description: Name given to the interface
34092           required: true
34093           type: string
34094           example: __INTERFACE-NAME__
34095         - name: vlan-interface
34096           in: path
34097           description: String that identifies the interface
34098           required: true
34099           type: string
34100           example: __VLAN-INTERFACE__
34101   /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:
34102     put:
34103       tags:
34104         - Network
34105       summary: see node definition for valid relationships
34106       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34107       consumes:
34108         - application/json
34109         - application/xml
34110       produces:
34111         - application/json
34112         - application/xml
34113       responses:
34114         "default":
34115           description: Response codes found in [response codes](https://wiki.onap.org/).
34116       parameters:
34117         - name: vnf-id
34118           in: path
34119           description: Unique id of VNF.  This is unique across the graph.
34120           required: true
34121           type: string
34122           example: __VNF-ID__
34123         - name: interface-name
34124           in: path
34125           description: Name given to the interface
34126           required: true
34127           type: string
34128           example: __INTERFACE-NAME__
34129         - name: vlan-interface
34130           in: path
34131           description: String that identifies the interface
34132           required: true
34133           type: string
34134           example: __VLAN-INTERFACE__
34135         - name: l3-interface-ipv4-address
34136           in: path
34137           description: IP address
34138           required: true
34139           type: string
34140           example: __L3-INTERFACE-IPV4-ADDRESS__
34141         - name: body
34142           in: body
34143           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34144           required: true
34145           schema:
34146             $ref: "#/definitions/relationship"
34147     delete:
34148       tags:
34149         - Network
34150       summary: delete an existing relationship
34151       description: delete an existing relationship
34152       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34153       consumes:
34154         - application/json
34155         - application/xml
34156       produces:
34157         - application/json
34158         - application/xml
34159       responses:
34160         "default":
34161           description: Response codes found in [response codes](https://wiki.onap.org/).
34162       parameters:
34163         - name: vnf-id
34164           in: path
34165           description: Unique id of VNF.  This is unique across the graph.
34166           required: true
34167           type: string
34168           example: __VNF-ID__
34169         - name: interface-name
34170           in: path
34171           description: Name given to the interface
34172           required: true
34173           type: string
34174           example: __INTERFACE-NAME__
34175         - name: vlan-interface
34176           in: path
34177           description: String that identifies the interface
34178           required: true
34179           type: string
34180           example: __VLAN-INTERFACE__
34181         - name: l3-interface-ipv4-address
34182           in: path
34183           description: IP address
34184           required: true
34185           type: string
34186           example: __L3-INTERFACE-IPV4-ADDRESS__
34187   /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}:
34188     get:
34189       tags:
34190         - Network
34191       summary: returns l3-interface-ipv4-address-list
34192       description: returns l3-interface-ipv4-address-list
34193       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34194       produces:
34195         - application/json
34196         - application/xml
34197       responses:
34198         "200":
34199           description: successful operation
34200           schema:
34201               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34202         "default":
34203           description: Response codes found in [response codes](https://wiki.onap.org/).
34204       parameters:
34205         - name: vnf-id
34206           in: path
34207           description: Unique id of VNF.  This is unique across the graph.
34208           required: true
34209           type: string
34210           example: __VNF-ID__
34211         - name: interface-name
34212           in: path
34213           description: Name given to the interface
34214           required: true
34215           type: string
34216           example: __INTERFACE-NAME__
34217         - name: vlan-interface
34218           in: path
34219           description: String that identifies the interface
34220           required: true
34221           type: string
34222           example: __VLAN-INTERFACE__
34223         - name: l3-interface-ipv4-address
34224           in: path
34225           description: IP address
34226           required: true
34227           type: string
34228           example: __L3-INTERFACE-IPV4-ADDRESS__
34229         - name: vnf-name
34230           in: query
34231           description: Name of VNF.
34232           required: false
34233           type: string
34234         - name: vnf-name2
34235           in: query
34236           description: Alternate name of VNF.
34237           required: false
34238           type: string
34239         - name: vnf-type
34240           in: query
34241           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.
34242           required: false
34243           type: string
34244         - name: service-id
34245           in: query
34246           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34247           required: false
34248           type: string
34249         - name: regional-resource-zone
34250           in: query
34251           description: Regional way of organizing pservers, source of truth should define values
34252           required: false
34253           type: string
34254         - name: prov-status
34255           in: query
34256           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34257           required: false
34258           type: string
34259         - name: heat-stack-id
34260           in: query
34261           description: Heat stack id corresponding to this instance, managed by MSO
34262           required: false
34263           type: string
34264         - name: in-maint
34265           in: query
34266           required: false
34267           type: boolean
34268         - name: is-closed-loop-disabled
34269           in: query
34270           required: false
34271           type: boolean
34272         - name: model-invariant-id
34273           in: query
34274           description: the ASDC model id for this resource or service model.
34275           required: false
34276           type: string
34277         - name: model-version-id
34278           in: query
34279           description: the ASDC model version for this resource or service model.
34280           required: false
34281           type: string
34282         - name: widget-model-id
34283           in: query
34284           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34285           required: false
34286           type: string
34287         - name: widget-model-version
34288           in: query
34289           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34290           required: false
34291           type: string
34292         - name: nf-type
34293           in: query
34294           description: Generic description of the type of NF
34295           required: false
34296           type: string
34297         - name: nf-function
34298           in: query
34299           description: English description of Network function that the specific VNF deployment is providing
34300           required: false
34301           type: string
34302         - name: nf-role
34303           in: query
34304           description: role in the network that this model will be providing
34305           required: false
34306           type: string
34307         - name: nf-naming-code
34308           in: query
34309           description: string assigned to this model used for naming purposes
34310           required: false
34311           type: string
34312         - name: interface-id
34313           in: query
34314           description: ID of interface
34315           required: false
34316           type: string
34317         - name: macaddr
34318           in: query
34319           description: MAC address for the interface
34320           required: false
34321           type: string
34322         - name: network-name
34323           in: query
34324           description: Name of the network
34325           required: false
34326           type: string
34327         - name: vlan-id-inner
34328           in: query
34329           description: Inner VLAN tag
34330           required: false
34331           type: integer
34332           format: int64
34333         - name: vpn-key
34334           in: query
34335           description: This indicates the customers VPN ID associated with this vlan
34336           required: false
34337           type: string
34338         - name: vlan-id-inner
34339           in: query
34340           description: Inner VLAN tag
34341           required: false
34342           type: integer
34343           format: int64
34344         - name: neutron-network-id
34345           in: query
34346           description: Neutron network id of the interface that address belongs to
34347           required: false
34348           type: string
34349         - name: neutron-subnet-id
34350           in: query
34351           description: Neutron id of subnet that address belongs to
34352           required: false
34353           type: string
34354     put:
34355       tags:
34356         - Network
34357       summary: create or update an existing l3-interface-ipv4-address-list
34358       description: |
34359         Create or update an existing l3-interface-ipv4-address-list.
34360         #
34361         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34362       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34363       consumes:
34364         - application/json
34365         - application/xml
34366       produces:
34367         - application/json
34368         - application/xml
34369       responses:
34370         "default":
34371           description: Response codes found in [response codes](https://wiki.onap.org/).
34372       parameters:
34373         - name: vnf-id
34374           in: path
34375           description: Unique id of VNF.  This is unique across the graph.
34376           required: true
34377           type: string
34378           example: __VNF-ID__
34379         - name: interface-name
34380           in: path
34381           description: Name given to the interface
34382           required: true
34383           type: string
34384           example: __INTERFACE-NAME__
34385         - name: vlan-interface
34386           in: path
34387           description: String that identifies the interface
34388           required: true
34389           type: string
34390           example: __VLAN-INTERFACE__
34391         - name: l3-interface-ipv4-address
34392           in: path
34393           description: IP address
34394           required: true
34395           type: string
34396           example: __L3-INTERFACE-IPV4-ADDRESS__
34397         - name: body
34398           in: body
34399           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34400           required: true
34401           schema:
34402             $ref: "#/definitions/l3-interface-ipv4-address-list"
34403     patch:
34404       tags:
34405         - Network
34406       summary: update an existing l3-interface-ipv4-address-list
34407       description: |
34408         Update an existing l3-interface-ipv4-address-list
34409         #
34410         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34411         The PUT operation will entirely replace an existing object.
34412         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34413         #
34414         Other differences between PUT and PATCH are:
34415         #
34416         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34417         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34418         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34419       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34420       consumes:
34421         - application/json
34422         - application/xml
34423       produces:
34424         - application/json
34425         - application/xml
34426       responses:
34427         "default":
34428           description: Response codes found in [response codes](https://wiki.onap.org/).
34429       parameters:
34430         - name: vnf-id
34431           in: path
34432           description: Unique id of VNF.  This is unique across the graph.
34433           required: true
34434           type: string
34435           example: __VNF-ID__
34436         - name: interface-name
34437           in: path
34438           description: Name given to the interface
34439           required: true
34440           type: string
34441           example: __INTERFACE-NAME__
34442         - name: vlan-interface
34443           in: path
34444           description: String that identifies the interface
34445           required: true
34446           type: string
34447           example: __VLAN-INTERFACE__
34448         - name: l3-interface-ipv4-address
34449           in: path
34450           description: IP address
34451           required: true
34452           type: string
34453           example: __L3-INTERFACE-IPV4-ADDRESS__
34454         - name: body
34455           in: body
34456           description: l3-interface-ipv4-address-list object that needs to be created or updated.
34457           required: true
34458           schema:
34459             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34460     delete:
34461       tags:
34462         - Network
34463       summary: delete an existing l3-interface-ipv4-address-list
34464       description: delete an existing l3-interface-ipv4-address-list
34465       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34466       consumes:
34467         - application/json
34468         - application/xml
34469       produces:
34470         - application/json
34471         - application/xml
34472       responses:
34473         "default":
34474           description: Response codes found in [response codes](https://wiki.onap.org/).
34475       parameters:
34476         - name: vnf-id
34477           in: path
34478           description: Unique id of VNF.  This is unique across the graph.
34479           required: true
34480           type: string
34481           example: __VNF-ID__
34482         - name: interface-name
34483           in: path
34484           description: Name given to the interface
34485           required: true
34486           type: string
34487           example: __INTERFACE-NAME__
34488         - name: vlan-interface
34489           in: path
34490           description: String that identifies the interface
34491           required: true
34492           type: string
34493           example: __VLAN-INTERFACE__
34494         - name: l3-interface-ipv4-address
34495           in: path
34496           description: IP address
34497           required: true
34498           type: string
34499           example: __L3-INTERFACE-IPV4-ADDRESS__
34500         - name: resource-version
34501           in: query
34502           description: resource-version for concurrency
34503           required: true
34504           type: string
34505   /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:
34506     put:
34507       tags:
34508         - Network
34509       summary: see node definition for valid relationships
34510       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34511       consumes:
34512         - application/json
34513         - application/xml
34514       produces:
34515         - application/json
34516         - application/xml
34517       responses:
34518         "default":
34519           description: Response codes found in [response codes](https://wiki.onap.org/).
34520       parameters:
34521         - name: vnf-id
34522           in: path
34523           description: Unique id of VNF.  This is unique across the graph.
34524           required: true
34525           type: string
34526           example: __VNF-ID__
34527         - name: interface-name
34528           in: path
34529           description: Name given to the interface
34530           required: true
34531           type: string
34532           example: __INTERFACE-NAME__
34533         - name: vlan-interface
34534           in: path
34535           description: String that identifies the interface
34536           required: true
34537           type: string
34538           example: __VLAN-INTERFACE__
34539         - name: l3-interface-ipv6-address
34540           in: path
34541           description: IP address
34542           required: true
34543           type: string
34544           example: __L3-INTERFACE-IPV6-ADDRESS__
34545         - name: body
34546           in: body
34547           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34548           required: true
34549           schema:
34550             $ref: "#/definitions/relationship"
34551     delete:
34552       tags:
34553         - Network
34554       summary: delete an existing relationship
34555       description: delete an existing relationship
34556       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34557       consumes:
34558         - application/json
34559         - application/xml
34560       produces:
34561         - application/json
34562         - application/xml
34563       responses:
34564         "default":
34565           description: Response codes found in [response codes](https://wiki.onap.org/).
34566       parameters:
34567         - name: vnf-id
34568           in: path
34569           description: Unique id of VNF.  This is unique across the graph.
34570           required: true
34571           type: string
34572           example: __VNF-ID__
34573         - name: interface-name
34574           in: path
34575           description: Name given to the interface
34576           required: true
34577           type: string
34578           example: __INTERFACE-NAME__
34579         - name: vlan-interface
34580           in: path
34581           description: String that identifies the interface
34582           required: true
34583           type: string
34584           example: __VLAN-INTERFACE__
34585         - name: l3-interface-ipv6-address
34586           in: path
34587           description: IP address
34588           required: true
34589           type: string
34590           example: __L3-INTERFACE-IPV6-ADDRESS__
34591   /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}:
34592     get:
34593       tags:
34594         - Network
34595       summary: returns l3-interface-ipv6-address-list
34596       description: returns l3-interface-ipv6-address-list
34597       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34598       produces:
34599         - application/json
34600         - application/xml
34601       responses:
34602         "200":
34603           description: successful operation
34604           schema:
34605               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34606         "default":
34607           description: Response codes found in [response codes](https://wiki.onap.org/).
34608       parameters:
34609         - name: vnf-id
34610           in: path
34611           description: Unique id of VNF.  This is unique across the graph.
34612           required: true
34613           type: string
34614           example: __VNF-ID__
34615         - name: interface-name
34616           in: path
34617           description: Name given to the interface
34618           required: true
34619           type: string
34620           example: __INTERFACE-NAME__
34621         - name: vlan-interface
34622           in: path
34623           description: String that identifies the interface
34624           required: true
34625           type: string
34626           example: __VLAN-INTERFACE__
34627         - name: l3-interface-ipv6-address
34628           in: path
34629           description: IP address
34630           required: true
34631           type: string
34632           example: __L3-INTERFACE-IPV6-ADDRESS__
34633         - name: vnf-name
34634           in: query
34635           description: Name of VNF.
34636           required: false
34637           type: string
34638         - name: vnf-name2
34639           in: query
34640           description: Alternate name of VNF.
34641           required: false
34642           type: string
34643         - name: vnf-type
34644           in: query
34645           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.
34646           required: false
34647           type: string
34648         - name: service-id
34649           in: query
34650           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34651           required: false
34652           type: string
34653         - name: regional-resource-zone
34654           in: query
34655           description: Regional way of organizing pservers, source of truth should define values
34656           required: false
34657           type: string
34658         - name: prov-status
34659           in: query
34660           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34661           required: false
34662           type: string
34663         - name: heat-stack-id
34664           in: query
34665           description: Heat stack id corresponding to this instance, managed by MSO
34666           required: false
34667           type: string
34668         - name: in-maint
34669           in: query
34670           required: false
34671           type: boolean
34672         - name: is-closed-loop-disabled
34673           in: query
34674           required: false
34675           type: boolean
34676         - name: model-invariant-id
34677           in: query
34678           description: the ASDC model id for this resource or service model.
34679           required: false
34680           type: string
34681         - name: model-version-id
34682           in: query
34683           description: the ASDC model version for this resource or service model.
34684           required: false
34685           type: string
34686         - name: widget-model-id
34687           in: query
34688           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34689           required: false
34690           type: string
34691         - name: widget-model-version
34692           in: query
34693           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34694           required: false
34695           type: string
34696         - name: nf-type
34697           in: query
34698           description: Generic description of the type of NF
34699           required: false
34700           type: string
34701         - name: nf-function
34702           in: query
34703           description: English description of Network function that the specific VNF deployment is providing
34704           required: false
34705           type: string
34706         - name: nf-role
34707           in: query
34708           description: role in the network that this model will be providing
34709           required: false
34710           type: string
34711         - name: nf-naming-code
34712           in: query
34713           description: string assigned to this model used for naming purposes
34714           required: false
34715           type: string
34716         - name: interface-id
34717           in: query
34718           description: ID of interface
34719           required: false
34720           type: string
34721         - name: macaddr
34722           in: query
34723           description: MAC address for the interface
34724           required: false
34725           type: string
34726         - name: network-name
34727           in: query
34728           description: Name of the network
34729           required: false
34730           type: string
34731         - name: vlan-id-inner
34732           in: query
34733           description: Inner VLAN tag
34734           required: false
34735           type: integer
34736           format: int64
34737         - name: vpn-key
34738           in: query
34739           description: This indicates the customers VPN ID associated with this vlan
34740           required: false
34741           type: string
34742         - name: vlan-id-inner
34743           in: query
34744           description: Inner VLAN tag
34745           required: false
34746           type: integer
34747           format: int64
34748         - name: neutron-network-id
34749           in: query
34750           description: Neutron network id of the interface that address belongs to
34751           required: false
34752           type: string
34753         - name: neutron-subnet-id
34754           in: query
34755           description: Neutron id of subnet that address belongs to
34756           required: false
34757           type: string
34758     put:
34759       tags:
34760         - Network
34761       summary: create or update an existing l3-interface-ipv6-address-list
34762       description: |
34763         Create or update an existing l3-interface-ipv6-address-list.
34764         #
34765         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34766       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34767       consumes:
34768         - application/json
34769         - application/xml
34770       produces:
34771         - application/json
34772         - application/xml
34773       responses:
34774         "default":
34775           description: Response codes found in [response codes](https://wiki.onap.org/).
34776       parameters:
34777         - name: vnf-id
34778           in: path
34779           description: Unique id of VNF.  This is unique across the graph.
34780           required: true
34781           type: string
34782           example: __VNF-ID__
34783         - name: interface-name
34784           in: path
34785           description: Name given to the interface
34786           required: true
34787           type: string
34788           example: __INTERFACE-NAME__
34789         - name: vlan-interface
34790           in: path
34791           description: String that identifies the interface
34792           required: true
34793           type: string
34794           example: __VLAN-INTERFACE__
34795         - name: l3-interface-ipv6-address
34796           in: path
34797           description: IP address
34798           required: true
34799           type: string
34800           example: __L3-INTERFACE-IPV6-ADDRESS__
34801         - name: body
34802           in: body
34803           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34804           required: true
34805           schema:
34806             $ref: "#/definitions/l3-interface-ipv6-address-list"
34807     patch:
34808       tags:
34809         - Network
34810       summary: update an existing l3-interface-ipv6-address-list
34811       description: |
34812         Update an existing l3-interface-ipv6-address-list
34813         #
34814         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34815         The PUT operation will entirely replace an existing object.
34816         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34817         #
34818         Other differences between PUT and PATCH are:
34819         #
34820         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34821         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34822         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34823       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34824       consumes:
34825         - application/json
34826         - application/xml
34827       produces:
34828         - application/json
34829         - application/xml
34830       responses:
34831         "default":
34832           description: Response codes found in [response codes](https://wiki.onap.org/).
34833       parameters:
34834         - name: vnf-id
34835           in: path
34836           description: Unique id of VNF.  This is unique across the graph.
34837           required: true
34838           type: string
34839           example: __VNF-ID__
34840         - name: interface-name
34841           in: path
34842           description: Name given to the interface
34843           required: true
34844           type: string
34845           example: __INTERFACE-NAME__
34846         - name: vlan-interface
34847           in: path
34848           description: String that identifies the interface
34849           required: true
34850           type: string
34851           example: __VLAN-INTERFACE__
34852         - name: l3-interface-ipv6-address
34853           in: path
34854           description: IP address
34855           required: true
34856           type: string
34857           example: __L3-INTERFACE-IPV6-ADDRESS__
34858         - name: body
34859           in: body
34860           description: l3-interface-ipv6-address-list object that needs to be created or updated.
34861           required: true
34862           schema:
34863             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34864     delete:
34865       tags:
34866         - Network
34867       summary: delete an existing l3-interface-ipv6-address-list
34868       description: delete an existing l3-interface-ipv6-address-list
34869       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34870       consumes:
34871         - application/json
34872         - application/xml
34873       produces:
34874         - application/json
34875         - application/xml
34876       responses:
34877         "default":
34878           description: Response codes found in [response codes](https://wiki.onap.org/).
34879       parameters:
34880         - name: vnf-id
34881           in: path
34882           description: Unique id of VNF.  This is unique across the graph.
34883           required: true
34884           type: string
34885           example: __VNF-ID__
34886         - name: interface-name
34887           in: path
34888           description: Name given to the interface
34889           required: true
34890           type: string
34891           example: __INTERFACE-NAME__
34892         - name: vlan-interface
34893           in: path
34894           description: String that identifies the interface
34895           required: true
34896           type: string
34897           example: __VLAN-INTERFACE__
34898         - name: l3-interface-ipv6-address
34899           in: path
34900           description: IP address
34901           required: true
34902           type: string
34903           example: __L3-INTERFACE-IPV6-ADDRESS__
34904         - name: resource-version
34905           in: query
34906           description: resource-version for concurrency
34907           required: true
34908           type: string
34909   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34910     get:
34911       tags:
34912         - Network
34913       summary: returns vlan
34914       description: returns vlan
34915       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
34916       produces:
34917         - application/json
34918         - application/xml
34919       responses:
34920         "200":
34921           description: successful operation
34922           schema:
34923               $ref: "#/getDefinitions/vlan"
34924         "default":
34925           description: Response codes found in [response codes](https://wiki.onap.org/).
34926       parameters:
34927         - name: vnf-id
34928           in: path
34929           description: Unique id of VNF.  This is unique across the graph.
34930           required: true
34931           type: string
34932           example: __VNF-ID__
34933         - name: interface-name
34934           in: path
34935           description: Name given to the interface
34936           required: true
34937           type: string
34938           example: __INTERFACE-NAME__
34939         - name: vlan-interface
34940           in: path
34941           description: String that identifies the interface
34942           required: true
34943           type: string
34944           example: __VLAN-INTERFACE__
34945         - name: vnf-name
34946           in: query
34947           description: Name of VNF.
34948           required: false
34949           type: string
34950         - name: vnf-name2
34951           in: query
34952           description: Alternate name of VNF.
34953           required: false
34954           type: string
34955         - name: vnf-type
34956           in: query
34957           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.
34958           required: false
34959           type: string
34960         - name: service-id
34961           in: query
34962           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34963           required: false
34964           type: string
34965         - name: regional-resource-zone
34966           in: query
34967           description: Regional way of organizing pservers, source of truth should define values
34968           required: false
34969           type: string
34970         - name: prov-status
34971           in: query
34972           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34973           required: false
34974           type: string
34975         - name: heat-stack-id
34976           in: query
34977           description: Heat stack id corresponding to this instance, managed by MSO
34978           required: false
34979           type: string
34980         - name: in-maint
34981           in: query
34982           required: false
34983           type: boolean
34984         - name: is-closed-loop-disabled
34985           in: query
34986           required: false
34987           type: boolean
34988         - name: model-invariant-id
34989           in: query
34990           description: the ASDC model id for this resource or service model.
34991           required: false
34992           type: string
34993         - name: model-version-id
34994           in: query
34995           description: the ASDC model version for this resource or service model.
34996           required: false
34997           type: string
34998         - name: widget-model-id
34999           in: query
35000           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35001           required: false
35002           type: string
35003         - name: widget-model-version
35004           in: query
35005           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35006           required: false
35007           type: string
35008         - name: nf-type
35009           in: query
35010           description: Generic description of the type of NF
35011           required: false
35012           type: string
35013         - name: nf-function
35014           in: query
35015           description: English description of Network function that the specific VNF deployment is providing
35016           required: false
35017           type: string
35018         - name: nf-role
35019           in: query
35020           description: role in the network that this model will be providing
35021           required: false
35022           type: string
35023         - name: nf-naming-code
35024           in: query
35025           description: string assigned to this model used for naming purposes
35026           required: false
35027           type: string
35028         - name: interface-id
35029           in: query
35030           description: ID of interface
35031           required: false
35032           type: string
35033         - name: macaddr
35034           in: query
35035           description: MAC address for the interface
35036           required: false
35037           type: string
35038         - name: network-name
35039           in: query
35040           description: Name of the network
35041           required: false
35042           type: string
35043         - name: vlan-id-inner
35044           in: query
35045           description: Inner VLAN tag
35046           required: false
35047           type: integer
35048           format: int64
35049         - name: vpn-key
35050           in: query
35051           description: This indicates the customers VPN ID associated with this vlan
35052           required: false
35053           type: string
35054     put:
35055       tags:
35056         - Network
35057       summary: create or update an existing vlan
35058       description: |
35059         Create or update an existing vlan.
35060         #
35061         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35062       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35063       consumes:
35064         - application/json
35065         - application/xml
35066       produces:
35067         - application/json
35068         - application/xml
35069       responses:
35070         "default":
35071           description: Response codes found in [response codes](https://wiki.onap.org/).
35072       parameters:
35073         - name: vnf-id
35074           in: path
35075           description: Unique id of VNF.  This is unique across the graph.
35076           required: true
35077           type: string
35078           example: __VNF-ID__
35079         - name: interface-name
35080           in: path
35081           description: Name given to the interface
35082           required: true
35083           type: string
35084           example: __INTERFACE-NAME__
35085         - name: vlan-interface
35086           in: path
35087           description: String that identifies the interface
35088           required: true
35089           type: string
35090           example: __VLAN-INTERFACE__
35091         - name: body
35092           in: body
35093           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
35094           required: true
35095           schema:
35096             $ref: "#/definitions/vlan"
35097     patch:
35098       tags:
35099         - Network
35100       summary: update an existing vlan
35101       description: |
35102         Update an existing vlan
35103         #
35104         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35105         The PUT operation will entirely replace an existing object.
35106         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35107         #
35108         Other differences between PUT and PATCH are:
35109         #
35110         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35111         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35112         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35113       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35114       consumes:
35115         - application/json
35116         - application/xml
35117       produces:
35118         - application/json
35119         - application/xml
35120       responses:
35121         "default":
35122           description: Response codes found in [response codes](https://wiki.onap.org/).
35123       parameters:
35124         - name: vnf-id
35125           in: path
35126           description: Unique id of VNF.  This is unique across the graph.
35127           required: true
35128           type: string
35129           example: __VNF-ID__
35130         - name: interface-name
35131           in: path
35132           description: Name given to the interface
35133           required: true
35134           type: string
35135           example: __INTERFACE-NAME__
35136         - name: vlan-interface
35137           in: path
35138           description: String that identifies the interface
35139           required: true
35140           type: string
35141           example: __VLAN-INTERFACE__
35142         - name: body
35143           in: body
35144           description: vlan object that needs to be created or updated.
35145           required: true
35146           schema:
35147             $ref: "#/patchDefinitions/vlan"
35148     delete:
35149       tags:
35150         - Network
35151       summary: delete an existing vlan
35152       description: delete an existing vlan
35153       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35154       consumes:
35155         - application/json
35156         - application/xml
35157       produces:
35158         - application/json
35159         - application/xml
35160       responses:
35161         "default":
35162           description: Response codes found in [response codes](https://wiki.onap.org/).
35163       parameters:
35164         - name: vnf-id
35165           in: path
35166           description: Unique id of VNF.  This is unique across the graph.
35167           required: true
35168           type: string
35169           example: __VNF-ID__
35170         - name: interface-name
35171           in: path
35172           description: Name given to the interface
35173           required: true
35174           type: string
35175           example: __INTERFACE-NAME__
35176         - name: vlan-interface
35177           in: path
35178           description: String that identifies the interface
35179           required: true
35180           type: string
35181           example: __VLAN-INTERFACE__
35182         - name: resource-version
35183           in: query
35184           description: resource-version for concurrency
35185           required: true
35186           type: string
35187   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
35188     get:
35189       tags:
35190         - Network
35191       summary: returns vlans
35192       description: returns vlans
35193       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
35194       produces:
35195         - application/json
35196         - application/xml
35197       responses:
35198         "200":
35199           description: successful operation
35200           schema:
35201               $ref: "#/getDefinitions/vlans"
35202         "default":
35203           description: Response codes found in [response codes](https://wiki.onap.org/).
35204       parameters:
35205         - name: vnf-id
35206           in: path
35207           description: Unique id of VNF.  This is unique across the graph.
35208           required: true
35209           type: string
35210           example: __VNF-ID__
35211         - name: interface-name
35212           in: path
35213           description: Name given to the interface
35214           required: true
35215           type: string
35216           example: __INTERFACE-NAME__
35217         - name: vnf-name
35218           in: query
35219           description: Name of VNF.
35220           required: false
35221           type: string
35222         - name: vnf-name2
35223           in: query
35224           description: Alternate name of VNF.
35225           required: false
35226           type: string
35227         - name: vnf-type
35228           in: query
35229           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.
35230           required: false
35231           type: string
35232         - name: service-id
35233           in: query
35234           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35235           required: false
35236           type: string
35237         - name: regional-resource-zone
35238           in: query
35239           description: Regional way of organizing pservers, source of truth should define values
35240           required: false
35241           type: string
35242         - name: prov-status
35243           in: query
35244           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35245           required: false
35246           type: string
35247         - name: heat-stack-id
35248           in: query
35249           description: Heat stack id corresponding to this instance, managed by MSO
35250           required: false
35251           type: string
35252         - name: in-maint
35253           in: query
35254           required: false
35255           type: boolean
35256         - name: is-closed-loop-disabled
35257           in: query
35258           required: false
35259           type: boolean
35260         - name: model-invariant-id
35261           in: query
35262           description: the ASDC model id for this resource or service model.
35263           required: false
35264           type: string
35265         - name: model-version-id
35266           in: query
35267           description: the ASDC model version for this resource or service model.
35268           required: false
35269           type: string
35270         - name: widget-model-id
35271           in: query
35272           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35273           required: false
35274           type: string
35275         - name: widget-model-version
35276           in: query
35277           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35278           required: false
35279           type: string
35280         - name: nf-type
35281           in: query
35282           description: Generic description of the type of NF
35283           required: false
35284           type: string
35285         - name: nf-function
35286           in: query
35287           description: English description of Network function that the specific VNF deployment is providing
35288           required: false
35289           type: string
35290         - name: nf-role
35291           in: query
35292           description: role in the network that this model will be providing
35293           required: false
35294           type: string
35295         - name: nf-naming-code
35296           in: query
35297           description: string assigned to this model used for naming purposes
35298           required: false
35299           type: string
35300         - name: interface-id
35301           in: query
35302           description: ID of interface
35303           required: false
35304           type: string
35305         - name: macaddr
35306           in: query
35307           description: MAC address for the interface
35308           required: false
35309           type: string
35310         - name: network-name
35311           in: query
35312           description: Name of the network
35313           required: false
35314           type: string
35315   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35316     put:
35317       tags:
35318         - Network
35319       summary: see node definition for valid relationships
35320       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35321       consumes:
35322         - application/json
35323         - application/xml
35324       produces:
35325         - application/json
35326         - application/xml
35327       responses:
35328         "default":
35329           description: Response codes found in [response codes](https://wiki.onap.org/).
35330       parameters:
35331         - name: vnf-id
35332           in: path
35333           description: Unique id of VNF.  This is unique across the graph.
35334           required: true
35335           type: string
35336           example: __VNF-ID__
35337         - name: interface-name
35338           in: path
35339           description: Name given to the interface
35340           required: true
35341           type: string
35342           example: __INTERFACE-NAME__
35343         - name: pci-id
35344           in: path
35345           description: PCI ID used to identify the sriov-vf
35346           required: true
35347           type: string
35348           example: __PCI-ID__
35349         - name: body
35350           in: body
35351           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35352           required: true
35353           schema:
35354             $ref: "#/definitions/relationship"
35355     delete:
35356       tags:
35357         - Network
35358       summary: delete an existing relationship
35359       description: delete an existing relationship
35360       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35361       consumes:
35362         - application/json
35363         - application/xml
35364       produces:
35365         - application/json
35366         - application/xml
35367       responses:
35368         "default":
35369           description: Response codes found in [response codes](https://wiki.onap.org/).
35370       parameters:
35371         - name: vnf-id
35372           in: path
35373           description: Unique id of VNF.  This is unique across the graph.
35374           required: true
35375           type: string
35376           example: __VNF-ID__
35377         - name: interface-name
35378           in: path
35379           description: Name given to the interface
35380           required: true
35381           type: string
35382           example: __INTERFACE-NAME__
35383         - name: pci-id
35384           in: path
35385           description: PCI ID used to identify the sriov-vf
35386           required: true
35387           type: string
35388           example: __PCI-ID__
35389   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35390     get:
35391       tags:
35392         - Network
35393       summary: returns sriov-vf
35394       description: returns sriov-vf
35395       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35396       produces:
35397         - application/json
35398         - application/xml
35399       responses:
35400         "200":
35401           description: successful operation
35402           schema:
35403               $ref: "#/getDefinitions/sriov-vf"
35404         "default":
35405           description: Response codes found in [response codes](https://wiki.onap.org/).
35406       parameters:
35407         - name: vnf-id
35408           in: path
35409           description: Unique id of VNF.  This is unique across the graph.
35410           required: true
35411           type: string
35412           example: __VNF-ID__
35413         - name: interface-name
35414           in: path
35415           description: Name given to the interface
35416           required: true
35417           type: string
35418           example: __INTERFACE-NAME__
35419         - name: pci-id
35420           in: path
35421           description: PCI ID used to identify the sriov-vf
35422           required: true
35423           type: string
35424           example: __PCI-ID__
35425         - name: vnf-name
35426           in: query
35427           description: Name of VNF.
35428           required: false
35429           type: string
35430         - name: vnf-name2
35431           in: query
35432           description: Alternate name of VNF.
35433           required: false
35434           type: string
35435         - name: vnf-type
35436           in: query
35437           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.
35438           required: false
35439           type: string
35440         - name: service-id
35441           in: query
35442           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35443           required: false
35444           type: string
35445         - name: regional-resource-zone
35446           in: query
35447           description: Regional way of organizing pservers, source of truth should define values
35448           required: false
35449           type: string
35450         - name: prov-status
35451           in: query
35452           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35453           required: false
35454           type: string
35455         - name: heat-stack-id
35456           in: query
35457           description: Heat stack id corresponding to this instance, managed by MSO
35458           required: false
35459           type: string
35460         - name: in-maint
35461           in: query
35462           required: false
35463           type: boolean
35464         - name: is-closed-loop-disabled
35465           in: query
35466           required: false
35467           type: boolean
35468         - name: model-invariant-id
35469           in: query
35470           description: the ASDC model id for this resource or service model.
35471           required: false
35472           type: string
35473         - name: model-version-id
35474           in: query
35475           description: the ASDC model version for this resource or service model.
35476           required: false
35477           type: string
35478         - name: widget-model-id
35479           in: query
35480           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35481           required: false
35482           type: string
35483         - name: widget-model-version
35484           in: query
35485           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35486           required: false
35487           type: string
35488         - name: nf-type
35489           in: query
35490           description: Generic description of the type of NF
35491           required: false
35492           type: string
35493         - name: nf-function
35494           in: query
35495           description: English description of Network function that the specific VNF deployment is providing
35496           required: false
35497           type: string
35498         - name: nf-role
35499           in: query
35500           description: role in the network that this model will be providing
35501           required: false
35502           type: string
35503         - name: nf-naming-code
35504           in: query
35505           description: string assigned to this model used for naming purposes
35506           required: false
35507           type: string
35508         - name: interface-id
35509           in: query
35510           description: ID of interface
35511           required: false
35512           type: string
35513         - name: macaddr
35514           in: query
35515           description: MAC address for the interface
35516           required: false
35517           type: string
35518         - name: network-name
35519           in: query
35520           description: Name of the network
35521           required: false
35522           type: string
35523         - name: vf-vlan-filter
35524           in: query
35525           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
35526           required: false
35527           type: string
35528         - name: vf-mac-filter
35529           in: query
35530           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
35531           required: false
35532           type: string
35533         - name: vf-vlan-strip
35534           in: query
35535           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
35536           required: false
35537           type: boolean
35538         - name: neutron-network-id
35539           in: query
35540           description: Neutron network id of the interface
35541           required: false
35542           type: string
35543     put:
35544       tags:
35545         - Network
35546       summary: create or update an existing sriov-vf
35547       description: |
35548         Create or update an existing sriov-vf.
35549         #
35550         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35551       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35552       consumes:
35553         - application/json
35554         - application/xml
35555       produces:
35556         - application/json
35557         - application/xml
35558       responses:
35559         "default":
35560           description: Response codes found in [response codes](https://wiki.onap.org/).
35561       parameters:
35562         - name: vnf-id
35563           in: path
35564           description: Unique id of VNF.  This is unique across the graph.
35565           required: true
35566           type: string
35567           example: __VNF-ID__
35568         - name: interface-name
35569           in: path
35570           description: Name given to the interface
35571           required: true
35572           type: string
35573           example: __INTERFACE-NAME__
35574         - name: pci-id
35575           in: path
35576           description: PCI ID used to identify the sriov-vf
35577           required: true
35578           type: string
35579           example: __PCI-ID__
35580         - name: body
35581           in: body
35582           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35583           required: true
35584           schema:
35585             $ref: "#/definitions/sriov-vf"
35586     patch:
35587       tags:
35588         - Network
35589       summary: update an existing sriov-vf
35590       description: |
35591         Update an existing sriov-vf
35592         #
35593         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35594         The PUT operation will entirely replace an existing object.
35595         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35596         #
35597         Other differences between PUT and PATCH are:
35598         #
35599         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35600         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35601         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35602       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35603       consumes:
35604         - application/json
35605         - application/xml
35606       produces:
35607         - application/json
35608         - application/xml
35609       responses:
35610         "default":
35611           description: Response codes found in [response codes](https://wiki.onap.org/).
35612       parameters:
35613         - name: vnf-id
35614           in: path
35615           description: Unique id of VNF.  This is unique across the graph.
35616           required: true
35617           type: string
35618           example: __VNF-ID__
35619         - name: interface-name
35620           in: path
35621           description: Name given to the interface
35622           required: true
35623           type: string
35624           example: __INTERFACE-NAME__
35625         - name: pci-id
35626           in: path
35627           description: PCI ID used to identify the sriov-vf
35628           required: true
35629           type: string
35630           example: __PCI-ID__
35631         - name: body
35632           in: body
35633           description: sriov-vf object that needs to be created or updated.
35634           required: true
35635           schema:
35636             $ref: "#/patchDefinitions/sriov-vf"
35637     delete:
35638       tags:
35639         - Network
35640       summary: delete an existing sriov-vf
35641       description: delete an existing sriov-vf
35642       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35643       consumes:
35644         - application/json
35645         - application/xml
35646       produces:
35647         - application/json
35648         - application/xml
35649       responses:
35650         "default":
35651           description: Response codes found in [response codes](https://wiki.onap.org/).
35652       parameters:
35653         - name: vnf-id
35654           in: path
35655           description: Unique id of VNF.  This is unique across the graph.
35656           required: true
35657           type: string
35658           example: __VNF-ID__
35659         - name: interface-name
35660           in: path
35661           description: Name given to the interface
35662           required: true
35663           type: string
35664           example: __INTERFACE-NAME__
35665         - name: pci-id
35666           in: path
35667           description: PCI ID used to identify the sriov-vf
35668           required: true
35669           type: string
35670           example: __PCI-ID__
35671         - name: resource-version
35672           in: query
35673           description: resource-version for concurrency
35674           required: true
35675           type: string
35676   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35677     get:
35678       tags:
35679         - Network
35680       summary: returns sriov-vfs
35681       description: returns sriov-vfs
35682       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
35683       produces:
35684         - application/json
35685         - application/xml
35686       responses:
35687         "200":
35688           description: successful operation
35689           schema:
35690               $ref: "#/getDefinitions/sriov-vfs"
35691         "default":
35692           description: Response codes found in [response codes](https://wiki.onap.org/).
35693       parameters:
35694         - name: vnf-id
35695           in: path
35696           description: Unique id of VNF.  This is unique across the graph.
35697           required: true
35698           type: string
35699           example: __VNF-ID__
35700         - name: interface-name
35701           in: path
35702           description: Name given to the interface
35703           required: true
35704           type: string
35705           example: __INTERFACE-NAME__
35706         - name: vnf-name
35707           in: query
35708           description: Name of VNF.
35709           required: false
35710           type: string
35711         - name: vnf-name2
35712           in: query
35713           description: Alternate name of VNF.
35714           required: false
35715           type: string
35716         - name: vnf-type
35717           in: query
35718           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.
35719           required: false
35720           type: string
35721         - name: service-id
35722           in: query
35723           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35724           required: false
35725           type: string
35726         - name: regional-resource-zone
35727           in: query
35728           description: Regional way of organizing pservers, source of truth should define values
35729           required: false
35730           type: string
35731         - name: prov-status
35732           in: query
35733           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35734           required: false
35735           type: string
35736         - name: heat-stack-id
35737           in: query
35738           description: Heat stack id corresponding to this instance, managed by MSO
35739           required: false
35740           type: string
35741         - name: in-maint
35742           in: query
35743           required: false
35744           type: boolean
35745         - name: is-closed-loop-disabled
35746           in: query
35747           required: false
35748           type: boolean
35749         - name: model-invariant-id
35750           in: query
35751           description: the ASDC model id for this resource or service model.
35752           required: false
35753           type: string
35754         - name: model-version-id
35755           in: query
35756           description: the ASDC model version for this resource or service model.
35757           required: false
35758           type: string
35759         - name: widget-model-id
35760           in: query
35761           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35762           required: false
35763           type: string
35764         - name: widget-model-version
35765           in: query
35766           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35767           required: false
35768           type: string
35769         - name: nf-type
35770           in: query
35771           description: Generic description of the type of NF
35772           required: false
35773           type: string
35774         - name: nf-function
35775           in: query
35776           description: English description of Network function that the specific VNF deployment is providing
35777           required: false
35778           type: string
35779         - name: nf-role
35780           in: query
35781           description: role in the network that this model will be providing
35782           required: false
35783           type: string
35784         - name: nf-naming-code
35785           in: query
35786           description: string assigned to this model used for naming purposes
35787           required: false
35788           type: string
35789         - name: interface-id
35790           in: query
35791           description: ID of interface
35792           required: false
35793           type: string
35794         - name: macaddr
35795           in: query
35796           description: MAC address for the interface
35797           required: false
35798           type: string
35799         - name: network-name
35800           in: query
35801           description: Name of the network
35802           required: false
35803           type: string
35804   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35805     put:
35806       tags:
35807         - Network
35808       summary: see node definition for valid relationships
35809       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35810       consumes:
35811         - application/json
35812         - application/xml
35813       produces:
35814         - application/json
35815         - application/xml
35816       responses:
35817         "default":
35818           description: Response codes found in [response codes](https://wiki.onap.org/).
35819       parameters:
35820         - name: vnf-id
35821           in: path
35822           description: Unique id of VNF.  This is unique across the graph.
35823           required: true
35824           type: string
35825           example: __VNF-ID__
35826         - name: interface-name
35827           in: path
35828           description: Name given to the interface
35829           required: true
35830           type: string
35831           example: __INTERFACE-NAME__
35832         - name: body
35833           in: body
35834           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
35835           required: true
35836           schema:
35837             $ref: "#/definitions/relationship"
35838     delete:
35839       tags:
35840         - Network
35841       summary: delete an existing relationship
35842       description: delete an existing relationship
35843       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35844       consumes:
35845         - application/json
35846         - application/xml
35847       produces:
35848         - application/json
35849         - application/xml
35850       responses:
35851         "default":
35852           description: Response codes found in [response codes](https://wiki.onap.org/).
35853       parameters:
35854         - name: vnf-id
35855           in: path
35856           description: Unique id of VNF.  This is unique across the graph.
35857           required: true
35858           type: string
35859           example: __VNF-ID__
35860         - name: interface-name
35861           in: path
35862           description: Name given to the interface
35863           required: true
35864           type: string
35865           example: __INTERFACE-NAME__
35866   /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:
35867     put:
35868       tags:
35869         - Network
35870       summary: see node definition for valid relationships
35871       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35872       consumes:
35873         - application/json
35874         - application/xml
35875       produces:
35876         - application/json
35877         - application/xml
35878       responses:
35879         "default":
35880           description: Response codes found in [response codes](https://wiki.onap.org/).
35881       parameters:
35882         - name: vnf-id
35883           in: path
35884           description: Unique id of VNF.  This is unique across the graph.
35885           required: true
35886           type: string
35887           example: __VNF-ID__
35888         - name: interface-name
35889           in: path
35890           description: Name given to the interface
35891           required: true
35892           type: string
35893           example: __INTERFACE-NAME__
35894         - name: l3-interface-ipv4-address
35895           in: path
35896           description: IP address
35897           required: true
35898           type: string
35899           example: __L3-INTERFACE-IPV4-ADDRESS__
35900         - name: body
35901           in: body
35902           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35903           required: true
35904           schema:
35905             $ref: "#/definitions/relationship"
35906     delete:
35907       tags:
35908         - Network
35909       summary: delete an existing relationship
35910       description: delete an existing relationship
35911       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35912       consumes:
35913         - application/json
35914         - application/xml
35915       produces:
35916         - application/json
35917         - application/xml
35918       responses:
35919         "default":
35920           description: Response codes found in [response codes](https://wiki.onap.org/).
35921       parameters:
35922         - name: vnf-id
35923           in: path
35924           description: Unique id of VNF.  This is unique across the graph.
35925           required: true
35926           type: string
35927           example: __VNF-ID__
35928         - name: interface-name
35929           in: path
35930           description: Name given to the interface
35931           required: true
35932           type: string
35933           example: __INTERFACE-NAME__
35934         - name: l3-interface-ipv4-address
35935           in: path
35936           description: IP address
35937           required: true
35938           type: string
35939           example: __L3-INTERFACE-IPV4-ADDRESS__
35940   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35941     get:
35942       tags:
35943         - Network
35944       summary: returns l3-interface-ipv4-address-list
35945       description: returns l3-interface-ipv4-address-list
35946       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
35947       produces:
35948         - application/json
35949         - application/xml
35950       responses:
35951         "200":
35952           description: successful operation
35953           schema:
35954               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35955         "default":
35956           description: Response codes found in [response codes](https://wiki.onap.org/).
35957       parameters:
35958         - name: vnf-id
35959           in: path
35960           description: Unique id of VNF.  This is unique across the graph.
35961           required: true
35962           type: string
35963           example: __VNF-ID__
35964         - name: interface-name
35965           in: path
35966           description: Name given to the interface
35967           required: true
35968           type: string
35969           example: __INTERFACE-NAME__
35970         - name: l3-interface-ipv4-address
35971           in: path
35972           description: IP address
35973           required: true
35974           type: string
35975           example: __L3-INTERFACE-IPV4-ADDRESS__
35976         - name: vnf-name
35977           in: query
35978           description: Name of VNF.
35979           required: false
35980           type: string
35981         - name: vnf-name2
35982           in: query
35983           description: Alternate name of VNF.
35984           required: false
35985           type: string
35986         - name: vnf-type
35987           in: query
35988           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.
35989           required: false
35990           type: string
35991         - name: service-id
35992           in: query
35993           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35994           required: false
35995           type: string
35996         - name: regional-resource-zone
35997           in: query
35998           description: Regional way of organizing pservers, source of truth should define values
35999           required: false
36000           type: string
36001         - name: prov-status
36002           in: query
36003           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36004           required: false
36005           type: string
36006         - name: heat-stack-id
36007           in: query
36008           description: Heat stack id corresponding to this instance, managed by MSO
36009           required: false
36010           type: string
36011         - name: in-maint
36012           in: query
36013           required: false
36014           type: boolean
36015         - name: is-closed-loop-disabled
36016           in: query
36017           required: false
36018           type: boolean
36019         - name: model-invariant-id
36020           in: query
36021           description: the ASDC model id for this resource or service model.
36022           required: false
36023           type: string
36024         - name: model-version-id
36025           in: query
36026           description: the ASDC model version for this resource or service model.
36027           required: false
36028           type: string
36029         - name: widget-model-id
36030           in: query
36031           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36032           required: false
36033           type: string
36034         - name: widget-model-version
36035           in: query
36036           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36037           required: false
36038           type: string
36039         - name: nf-type
36040           in: query
36041           description: Generic description of the type of NF
36042           required: false
36043           type: string
36044         - name: nf-function
36045           in: query
36046           description: English description of Network function that the specific VNF deployment is providing
36047           required: false
36048           type: string
36049         - name: nf-role
36050           in: query
36051           description: role in the network that this model will be providing
36052           required: false
36053           type: string
36054         - name: nf-naming-code
36055           in: query
36056           description: string assigned to this model used for naming purposes
36057           required: false
36058           type: string
36059         - name: interface-id
36060           in: query
36061           description: ID of interface
36062           required: false
36063           type: string
36064         - name: macaddr
36065           in: query
36066           description: MAC address for the interface
36067           required: false
36068           type: string
36069         - name: network-name
36070           in: query
36071           description: Name of the network
36072           required: false
36073           type: string
36074         - name: vlan-id-inner
36075           in: query
36076           description: Inner VLAN tag
36077           required: false
36078           type: integer
36079           format: int64
36080         - name: neutron-network-id
36081           in: query
36082           description: Neutron network id of the interface that address belongs to
36083           required: false
36084           type: string
36085         - name: neutron-subnet-id
36086           in: query
36087           description: Neutron id of subnet that address belongs to
36088           required: false
36089           type: string
36090     put:
36091       tags:
36092         - Network
36093       summary: create or update an existing l3-interface-ipv4-address-list
36094       description: |
36095         Create or update an existing l3-interface-ipv4-address-list.
36096         #
36097         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36098       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36099       consumes:
36100         - application/json
36101         - application/xml
36102       produces:
36103         - application/json
36104         - application/xml
36105       responses:
36106         "default":
36107           description: Response codes found in [response codes](https://wiki.onap.org/).
36108       parameters:
36109         - name: vnf-id
36110           in: path
36111           description: Unique id of VNF.  This is unique across the graph.
36112           required: true
36113           type: string
36114           example: __VNF-ID__
36115         - name: interface-name
36116           in: path
36117           description: Name given to the interface
36118           required: true
36119           type: string
36120           example: __INTERFACE-NAME__
36121         - name: l3-interface-ipv4-address
36122           in: path
36123           description: IP address
36124           required: true
36125           type: string
36126           example: __L3-INTERFACE-IPV4-ADDRESS__
36127         - name: body
36128           in: body
36129           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36130           required: true
36131           schema:
36132             $ref: "#/definitions/l3-interface-ipv4-address-list"
36133     patch:
36134       tags:
36135         - Network
36136       summary: update an existing l3-interface-ipv4-address-list
36137       description: |
36138         Update an existing l3-interface-ipv4-address-list
36139         #
36140         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36141         The PUT operation will entirely replace an existing object.
36142         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36143         #
36144         Other differences between PUT and PATCH are:
36145         #
36146         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36147         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36148         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36149       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36150       consumes:
36151         - application/json
36152         - application/xml
36153       produces:
36154         - application/json
36155         - application/xml
36156       responses:
36157         "default":
36158           description: Response codes found in [response codes](https://wiki.onap.org/).
36159       parameters:
36160         - name: vnf-id
36161           in: path
36162           description: Unique id of VNF.  This is unique across the graph.
36163           required: true
36164           type: string
36165           example: __VNF-ID__
36166         - name: interface-name
36167           in: path
36168           description: Name given to the interface
36169           required: true
36170           type: string
36171           example: __INTERFACE-NAME__
36172         - name: l3-interface-ipv4-address
36173           in: path
36174           description: IP address
36175           required: true
36176           type: string
36177           example: __L3-INTERFACE-IPV4-ADDRESS__
36178         - name: body
36179           in: body
36180           description: l3-interface-ipv4-address-list object that needs to be created or updated.
36181           required: true
36182           schema:
36183             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36184     delete:
36185       tags:
36186         - Network
36187       summary: delete an existing l3-interface-ipv4-address-list
36188       description: delete an existing l3-interface-ipv4-address-list
36189       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36190       consumes:
36191         - application/json
36192         - application/xml
36193       produces:
36194         - application/json
36195         - application/xml
36196       responses:
36197         "default":
36198           description: Response codes found in [response codes](https://wiki.onap.org/).
36199       parameters:
36200         - name: vnf-id
36201           in: path
36202           description: Unique id of VNF.  This is unique across the graph.
36203           required: true
36204           type: string
36205           example: __VNF-ID__
36206         - name: interface-name
36207           in: path
36208           description: Name given to the interface
36209           required: true
36210           type: string
36211           example: __INTERFACE-NAME__
36212         - name: l3-interface-ipv4-address
36213           in: path
36214           description: IP address
36215           required: true
36216           type: string
36217           example: __L3-INTERFACE-IPV4-ADDRESS__
36218         - name: resource-version
36219           in: query
36220           description: resource-version for concurrency
36221           required: true
36222           type: string
36223   /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:
36224     put:
36225       tags:
36226         - Network
36227       summary: see node definition for valid relationships
36228       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36229       consumes:
36230         - application/json
36231         - application/xml
36232       produces:
36233         - application/json
36234         - application/xml
36235       responses:
36236         "default":
36237           description: Response codes found in [response codes](https://wiki.onap.org/).
36238       parameters:
36239         - name: vnf-id
36240           in: path
36241           description: Unique id of VNF.  This is unique across the graph.
36242           required: true
36243           type: string
36244           example: __VNF-ID__
36245         - name: interface-name
36246           in: path
36247           description: Name given to the interface
36248           required: true
36249           type: string
36250           example: __INTERFACE-NAME__
36251         - name: l3-interface-ipv6-address
36252           in: path
36253           description: IP address
36254           required: true
36255           type: string
36256           example: __L3-INTERFACE-IPV6-ADDRESS__
36257         - name: body
36258           in: body
36259           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36260           required: true
36261           schema:
36262             $ref: "#/definitions/relationship"
36263     delete:
36264       tags:
36265         - Network
36266       summary: delete an existing relationship
36267       description: delete an existing relationship
36268       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36269       consumes:
36270         - application/json
36271         - application/xml
36272       produces:
36273         - application/json
36274         - application/xml
36275       responses:
36276         "default":
36277           description: Response codes found in [response codes](https://wiki.onap.org/).
36278       parameters:
36279         - name: vnf-id
36280           in: path
36281           description: Unique id of VNF.  This is unique across the graph.
36282           required: true
36283           type: string
36284           example: __VNF-ID__
36285         - name: interface-name
36286           in: path
36287           description: Name given to the interface
36288           required: true
36289           type: string
36290           example: __INTERFACE-NAME__
36291         - name: l3-interface-ipv6-address
36292           in: path
36293           description: IP address
36294           required: true
36295           type: string
36296           example: __L3-INTERFACE-IPV6-ADDRESS__
36297   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36298     get:
36299       tags:
36300         - Network
36301       summary: returns l3-interface-ipv6-address-list
36302       description: returns l3-interface-ipv6-address-list
36303       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36304       produces:
36305         - application/json
36306         - application/xml
36307       responses:
36308         "200":
36309           description: successful operation
36310           schema:
36311               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36312         "default":
36313           description: Response codes found in [response codes](https://wiki.onap.org/).
36314       parameters:
36315         - name: vnf-id
36316           in: path
36317           description: Unique id of VNF.  This is unique across the graph.
36318           required: true
36319           type: string
36320           example: __VNF-ID__
36321         - name: interface-name
36322           in: path
36323           description: Name given to the interface
36324           required: true
36325           type: string
36326           example: __INTERFACE-NAME__
36327         - name: l3-interface-ipv6-address
36328           in: path
36329           description: IP address
36330           required: true
36331           type: string
36332           example: __L3-INTERFACE-IPV6-ADDRESS__
36333         - name: vnf-name
36334           in: query
36335           description: Name of VNF.
36336           required: false
36337           type: string
36338         - name: vnf-name2
36339           in: query
36340           description: Alternate name of VNF.
36341           required: false
36342           type: string
36343         - name: vnf-type
36344           in: query
36345           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.
36346           required: false
36347           type: string
36348         - name: service-id
36349           in: query
36350           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36351           required: false
36352           type: string
36353         - name: regional-resource-zone
36354           in: query
36355           description: Regional way of organizing pservers, source of truth should define values
36356           required: false
36357           type: string
36358         - name: prov-status
36359           in: query
36360           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36361           required: false
36362           type: string
36363         - name: heat-stack-id
36364           in: query
36365           description: Heat stack id corresponding to this instance, managed by MSO
36366           required: false
36367           type: string
36368         - name: in-maint
36369           in: query
36370           required: false
36371           type: boolean
36372         - name: is-closed-loop-disabled
36373           in: query
36374           required: false
36375           type: boolean
36376         - name: model-invariant-id
36377           in: query
36378           description: the ASDC model id for this resource or service model.
36379           required: false
36380           type: string
36381         - name: model-version-id
36382           in: query
36383           description: the ASDC model version for this resource or service model.
36384           required: false
36385           type: string
36386         - name: widget-model-id
36387           in: query
36388           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36389           required: false
36390           type: string
36391         - name: widget-model-version
36392           in: query
36393           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36394           required: false
36395           type: string
36396         - name: nf-type
36397           in: query
36398           description: Generic description of the type of NF
36399           required: false
36400           type: string
36401         - name: nf-function
36402           in: query
36403           description: English description of Network function that the specific VNF deployment is providing
36404           required: false
36405           type: string
36406         - name: nf-role
36407           in: query
36408           description: role in the network that this model will be providing
36409           required: false
36410           type: string
36411         - name: nf-naming-code
36412           in: query
36413           description: string assigned to this model used for naming purposes
36414           required: false
36415           type: string
36416         - name: interface-id
36417           in: query
36418           description: ID of interface
36419           required: false
36420           type: string
36421         - name: macaddr
36422           in: query
36423           description: MAC address for the interface
36424           required: false
36425           type: string
36426         - name: network-name
36427           in: query
36428           description: Name of the network
36429           required: false
36430           type: string
36431         - name: vlan-id-inner
36432           in: query
36433           description: Inner VLAN tag
36434           required: false
36435           type: integer
36436           format: int64
36437         - name: neutron-network-id
36438           in: query
36439           description: Neutron network id of the interface that address belongs to
36440           required: false
36441           type: string
36442         - name: neutron-subnet-id
36443           in: query
36444           description: Neutron id of subnet that address belongs to
36445           required: false
36446           type: string
36447     put:
36448       tags:
36449         - Network
36450       summary: create or update an existing l3-interface-ipv6-address-list
36451       description: |
36452         Create or update an existing l3-interface-ipv6-address-list.
36453         #
36454         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36455       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36456       consumes:
36457         - application/json
36458         - application/xml
36459       produces:
36460         - application/json
36461         - application/xml
36462       responses:
36463         "default":
36464           description: Response codes found in [response codes](https://wiki.onap.org/).
36465       parameters:
36466         - name: vnf-id
36467           in: path
36468           description: Unique id of VNF.  This is unique across the graph.
36469           required: true
36470           type: string
36471           example: __VNF-ID__
36472         - name: interface-name
36473           in: path
36474           description: Name given to the interface
36475           required: true
36476           type: string
36477           example: __INTERFACE-NAME__
36478         - name: l3-interface-ipv6-address
36479           in: path
36480           description: IP address
36481           required: true
36482           type: string
36483           example: __L3-INTERFACE-IPV6-ADDRESS__
36484         - name: body
36485           in: body
36486           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36487           required: true
36488           schema:
36489             $ref: "#/definitions/l3-interface-ipv6-address-list"
36490     patch:
36491       tags:
36492         - Network
36493       summary: update an existing l3-interface-ipv6-address-list
36494       description: |
36495         Update an existing l3-interface-ipv6-address-list
36496         #
36497         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36498         The PUT operation will entirely replace an existing object.
36499         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36500         #
36501         Other differences between PUT and PATCH are:
36502         #
36503         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36504         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36505         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36506       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36507       consumes:
36508         - application/json
36509         - application/xml
36510       produces:
36511         - application/json
36512         - application/xml
36513       responses:
36514         "default":
36515           description: Response codes found in [response codes](https://wiki.onap.org/).
36516       parameters:
36517         - name: vnf-id
36518           in: path
36519           description: Unique id of VNF.  This is unique across the graph.
36520           required: true
36521           type: string
36522           example: __VNF-ID__
36523         - name: interface-name
36524           in: path
36525           description: Name given to the interface
36526           required: true
36527           type: string
36528           example: __INTERFACE-NAME__
36529         - name: l3-interface-ipv6-address
36530           in: path
36531           description: IP address
36532           required: true
36533           type: string
36534           example: __L3-INTERFACE-IPV6-ADDRESS__
36535         - name: body
36536           in: body
36537           description: l3-interface-ipv6-address-list object that needs to be created or updated.
36538           required: true
36539           schema:
36540             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36541     delete:
36542       tags:
36543         - Network
36544       summary: delete an existing l3-interface-ipv6-address-list
36545       description: delete an existing l3-interface-ipv6-address-list
36546       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36547       consumes:
36548         - application/json
36549         - application/xml
36550       produces:
36551         - application/json
36552         - application/xml
36553       responses:
36554         "default":
36555           description: Response codes found in [response codes](https://wiki.onap.org/).
36556       parameters:
36557         - name: vnf-id
36558           in: path
36559           description: Unique id of VNF.  This is unique across the graph.
36560           required: true
36561           type: string
36562           example: __VNF-ID__
36563         - name: interface-name
36564           in: path
36565           description: Name given to the interface
36566           required: true
36567           type: string
36568           example: __INTERFACE-NAME__
36569         - name: l3-interface-ipv6-address
36570           in: path
36571           description: IP address
36572           required: true
36573           type: string
36574           example: __L3-INTERFACE-IPV6-ADDRESS__
36575         - name: resource-version
36576           in: query
36577           description: resource-version for concurrency
36578           required: true
36579           type: string
36580   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
36581     get:
36582       tags:
36583         - Network
36584       summary: returns l-interface
36585       description: returns l-interface
36586       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
36587       produces:
36588         - application/json
36589         - application/xml
36590       responses:
36591         "200":
36592           description: successful operation
36593           schema:
36594               $ref: "#/getDefinitions/l-interface"
36595         "default":
36596           description: Response codes found in [response codes](https://wiki.onap.org/).
36597       parameters:
36598         - name: vnf-id
36599           in: path
36600           description: Unique id of VNF.  This is unique across the graph.
36601           required: true
36602           type: string
36603           example: __VNF-ID__
36604         - name: interface-name
36605           in: path
36606           description: Name given to the interface
36607           required: true
36608           type: string
36609           example: __INTERFACE-NAME__
36610         - name: vnf-name
36611           in: query
36612           description: Name of VNF.
36613           required: false
36614           type: string
36615         - name: vnf-name2
36616           in: query
36617           description: Alternate name of VNF.
36618           required: false
36619           type: string
36620         - name: vnf-type
36621           in: query
36622           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.
36623           required: false
36624           type: string
36625         - name: service-id
36626           in: query
36627           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36628           required: false
36629           type: string
36630         - name: regional-resource-zone
36631           in: query
36632           description: Regional way of organizing pservers, source of truth should define values
36633           required: false
36634           type: string
36635         - name: prov-status
36636           in: query
36637           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36638           required: false
36639           type: string
36640         - name: heat-stack-id
36641           in: query
36642           description: Heat stack id corresponding to this instance, managed by MSO
36643           required: false
36644           type: string
36645         - name: in-maint
36646           in: query
36647           required: false
36648           type: boolean
36649         - name: is-closed-loop-disabled
36650           in: query
36651           required: false
36652           type: boolean
36653         - name: model-invariant-id
36654           in: query
36655           description: the ASDC model id for this resource or service model.
36656           required: false
36657           type: string
36658         - name: model-version-id
36659           in: query
36660           description: the ASDC model version for this resource or service model.
36661           required: false
36662           type: string
36663         - name: widget-model-id
36664           in: query
36665           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36666           required: false
36667           type: string
36668         - name: widget-model-version
36669           in: query
36670           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36671           required: false
36672           type: string
36673         - name: nf-type
36674           in: query
36675           description: Generic description of the type of NF
36676           required: false
36677           type: string
36678         - name: nf-function
36679           in: query
36680           description: English description of Network function that the specific VNF deployment is providing
36681           required: false
36682           type: string
36683         - name: nf-role
36684           in: query
36685           description: role in the network that this model will be providing
36686           required: false
36687           type: string
36688         - name: nf-naming-code
36689           in: query
36690           description: string assigned to this model used for naming purposes
36691           required: false
36692           type: string
36693         - name: interface-id
36694           in: query
36695           description: ID of interface
36696           required: false
36697           type: string
36698         - name: macaddr
36699           in: query
36700           description: MAC address for the interface
36701           required: false
36702           type: string
36703         - name: network-name
36704           in: query
36705           description: Name of the network
36706           required: false
36707           type: string
36708     put:
36709       tags:
36710         - Network
36711       summary: create or update an existing l-interface
36712       description: |
36713         Create or update an existing l-interface.
36714         #
36715         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36716       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36717       consumes:
36718         - application/json
36719         - application/xml
36720       produces:
36721         - application/json
36722         - application/xml
36723       responses:
36724         "default":
36725           description: Response codes found in [response codes](https://wiki.onap.org/).
36726       parameters:
36727         - name: vnf-id
36728           in: path
36729           description: Unique id of VNF.  This is unique across the graph.
36730           required: true
36731           type: string
36732           example: __VNF-ID__
36733         - name: interface-name
36734           in: path
36735           description: Name given to the interface
36736           required: true
36737           type: string
36738           example: __INTERFACE-NAME__
36739         - name: body
36740           in: body
36741           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
36742           required: true
36743           schema:
36744             $ref: "#/definitions/l-interface"
36745     patch:
36746       tags:
36747         - Network
36748       summary: update an existing l-interface
36749       description: |
36750         Update an existing l-interface
36751         #
36752         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36753         The PUT operation will entirely replace an existing object.
36754         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36755         #
36756         Other differences between PUT and PATCH are:
36757         #
36758         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36759         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36760         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36761       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36762       consumes:
36763         - application/json
36764         - application/xml
36765       produces:
36766         - application/json
36767         - application/xml
36768       responses:
36769         "default":
36770           description: Response codes found in [response codes](https://wiki.onap.org/).
36771       parameters:
36772         - name: vnf-id
36773           in: path
36774           description: Unique id of VNF.  This is unique across the graph.
36775           required: true
36776           type: string
36777           example: __VNF-ID__
36778         - name: interface-name
36779           in: path
36780           description: Name given to the interface
36781           required: true
36782           type: string
36783           example: __INTERFACE-NAME__
36784         - name: body
36785           in: body
36786           description: l-interface object that needs to be created or updated.
36787           required: true
36788           schema:
36789             $ref: "#/patchDefinitions/l-interface"
36790     delete:
36791       tags:
36792         - Network
36793       summary: delete an existing l-interface
36794       description: delete an existing l-interface
36795       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
36796       consumes:
36797         - application/json
36798         - application/xml
36799       produces:
36800         - application/json
36801         - application/xml
36802       responses:
36803         "default":
36804           description: Response codes found in [response codes](https://wiki.onap.org/).
36805       parameters:
36806         - name: vnf-id
36807           in: path
36808           description: Unique id of VNF.  This is unique across the graph.
36809           required: true
36810           type: string
36811           example: __VNF-ID__
36812         - name: interface-name
36813           in: path
36814           description: Name given to the interface
36815           required: true
36816           type: string
36817           example: __INTERFACE-NAME__
36818         - name: resource-version
36819           in: query
36820           description: resource-version for concurrency
36821           required: true
36822           type: string
36823   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
36824     get:
36825       tags:
36826         - Network
36827       summary: returns l-interfaces
36828       description: returns l-interfaces
36829       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
36830       produces:
36831         - application/json
36832         - application/xml
36833       responses:
36834         "200":
36835           description: successful operation
36836           schema:
36837               $ref: "#/getDefinitions/l-interfaces"
36838         "default":
36839           description: Response codes found in [response codes](https://wiki.onap.org/).
36840       parameters:
36841         - name: vnf-id
36842           in: path
36843           description: Unique id of VNF.  This is unique across the graph.
36844           required: true
36845           type: string
36846           example: __VNF-ID__
36847         - name: vnf-name
36848           in: query
36849           description: Name of VNF.
36850           required: false
36851           type: string
36852         - name: vnf-name2
36853           in: query
36854           description: Alternate name of VNF.
36855           required: false
36856           type: string
36857         - name: vnf-type
36858           in: query
36859           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.
36860           required: false
36861           type: string
36862         - name: service-id
36863           in: query
36864           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36865           required: false
36866           type: string
36867         - name: regional-resource-zone
36868           in: query
36869           description: Regional way of organizing pservers, source of truth should define values
36870           required: false
36871           type: string
36872         - name: prov-status
36873           in: query
36874           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36875           required: false
36876           type: string
36877         - name: heat-stack-id
36878           in: query
36879           description: Heat stack id corresponding to this instance, managed by MSO
36880           required: false
36881           type: string
36882         - name: in-maint
36883           in: query
36884           required: false
36885           type: boolean
36886         - name: is-closed-loop-disabled
36887           in: query
36888           required: false
36889           type: boolean
36890         - name: model-invariant-id
36891           in: query
36892           description: the ASDC model id for this resource or service model.
36893           required: false
36894           type: string
36895         - name: model-version-id
36896           in: query
36897           description: the ASDC model version for this resource or service model.
36898           required: false
36899           type: string
36900         - name: widget-model-id
36901           in: query
36902           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36903           required: false
36904           type: string
36905         - name: widget-model-version
36906           in: query
36907           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36908           required: false
36909           type: string
36910         - name: nf-type
36911           in: query
36912           description: Generic description of the type of NF
36913           required: false
36914           type: string
36915         - name: nf-function
36916           in: query
36917           description: English description of Network function that the specific VNF deployment is providing
36918           required: false
36919           type: string
36920         - name: nf-role
36921           in: query
36922           description: role in the network that this model will be providing
36923           required: false
36924           type: string
36925         - name: nf-naming-code
36926           in: query
36927           description: string assigned to this model used for naming purposes
36928           required: false
36929           type: string
36930   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
36931     put:
36932       tags:
36933         - Network
36934       summary: see node definition for valid relationships
36935       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
36936       consumes:
36937         - application/json
36938         - application/xml
36939       produces:
36940         - application/json
36941         - application/xml
36942       responses:
36943         "default":
36944           description: Response codes found in [response codes](https://wiki.onap.org/).
36945       parameters:
36946         - name: vnf-id
36947           in: path
36948           description: Unique id of VNF.  This is unique across the graph.
36949           required: true
36950           type: string
36951           example: __VNF-ID__
36952         - name: interface-name
36953           in: path
36954           description: Name that identifies the link aggregate interface
36955           required: true
36956           type: string
36957           example: __INTERFACE-NAME__
36958         - name: body
36959           in: body
36960           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
36961           required: true
36962           schema:
36963             $ref: "#/definitions/relationship"
36964     delete:
36965       tags:
36966         - Network
36967       summary: delete an existing relationship
36968       description: delete an existing relationship
36969       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
36970       consumes:
36971         - application/json
36972         - application/xml
36973       produces:
36974         - application/json
36975         - application/xml
36976       responses:
36977         "default":
36978           description: Response codes found in [response codes](https://wiki.onap.org/).
36979       parameters:
36980         - name: vnf-id
36981           in: path
36982           description: Unique id of VNF.  This is unique across the graph.
36983           required: true
36984           type: string
36985           example: __VNF-ID__
36986         - name: interface-name
36987           in: path
36988           description: Name that identifies the link aggregate interface
36989           required: true
36990           type: string
36991           example: __INTERFACE-NAME__
36992   /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:
36993     put:
36994       tags:
36995         - Network
36996       summary: see node definition for valid relationships
36997       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
36998       consumes:
36999         - application/json
37000         - application/xml
37001       produces:
37002         - application/json
37003         - application/xml
37004       responses:
37005         "default":
37006           description: Response codes found in [response codes](https://wiki.onap.org/).
37007       parameters:
37008         - name: vnf-id
37009           in: path
37010           description: Unique id of VNF.  This is unique across the graph.
37011           required: true
37012           type: string
37013           example: __VNF-ID__
37014         - name: interface-name
37015           in: path
37016           description: Name that identifies the link aggregate interface
37017           required: true
37018           type: string
37019           example: __INTERFACE-NAME__
37020         - name: interface-name
37021           in: path
37022           description: Name given to the interface
37023           required: true
37024           type: string
37025           example: __INTERFACE-NAME__
37026         - name: vlan-interface
37027           in: path
37028           description: String that identifies the interface
37029           required: true
37030           type: string
37031           example: __VLAN-INTERFACE__
37032         - name: body
37033           in: body
37034           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37035           required: true
37036           schema:
37037             $ref: "#/definitions/relationship"
37038     delete:
37039       tags:
37040         - Network
37041       summary: delete an existing relationship
37042       description: delete an existing relationship
37043       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37044       consumes:
37045         - application/json
37046         - application/xml
37047       produces:
37048         - application/json
37049         - application/xml
37050       responses:
37051         "default":
37052           description: Response codes found in [response codes](https://wiki.onap.org/).
37053       parameters:
37054         - name: vnf-id
37055           in: path
37056           description: Unique id of VNF.  This is unique across the graph.
37057           required: true
37058           type: string
37059           example: __VNF-ID__
37060         - name: interface-name
37061           in: path
37062           description: Name that identifies the link aggregate interface
37063           required: true
37064           type: string
37065           example: __INTERFACE-NAME__
37066         - name: interface-name
37067           in: path
37068           description: Name given to the interface
37069           required: true
37070           type: string
37071           example: __INTERFACE-NAME__
37072         - name: vlan-interface
37073           in: path
37074           description: String that identifies the interface
37075           required: true
37076           type: string
37077           example: __VLAN-INTERFACE__
37078   /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:
37079     put:
37080       tags:
37081         - Network
37082       summary: see node definition for valid relationships
37083       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37084       consumes:
37085         - application/json
37086         - application/xml
37087       produces:
37088         - application/json
37089         - application/xml
37090       responses:
37091         "default":
37092           description: Response codes found in [response codes](https://wiki.onap.org/).
37093       parameters:
37094         - name: vnf-id
37095           in: path
37096           description: Unique id of VNF.  This is unique across the graph.
37097           required: true
37098           type: string
37099           example: __VNF-ID__
37100         - name: interface-name
37101           in: path
37102           description: Name that identifies the link aggregate interface
37103           required: true
37104           type: string
37105           example: __INTERFACE-NAME__
37106         - name: interface-name
37107           in: path
37108           description: Name given to the interface
37109           required: true
37110           type: string
37111           example: __INTERFACE-NAME__
37112         - name: vlan-interface
37113           in: path
37114           description: String that identifies the interface
37115           required: true
37116           type: string
37117           example: __VLAN-INTERFACE__
37118         - name: l3-interface-ipv4-address
37119           in: path
37120           description: IP address
37121           required: true
37122           type: string
37123           example: __L3-INTERFACE-IPV4-ADDRESS__
37124         - name: body
37125           in: body
37126           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37127           required: true
37128           schema:
37129             $ref: "#/definitions/relationship"
37130     delete:
37131       tags:
37132         - Network
37133       summary: delete an existing relationship
37134       description: delete an existing relationship
37135       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37136       consumes:
37137         - application/json
37138         - application/xml
37139       produces:
37140         - application/json
37141         - application/xml
37142       responses:
37143         "default":
37144           description: Response codes found in [response codes](https://wiki.onap.org/).
37145       parameters:
37146         - name: vnf-id
37147           in: path
37148           description: Unique id of VNF.  This is unique across the graph.
37149           required: true
37150           type: string
37151           example: __VNF-ID__
37152         - name: interface-name
37153           in: path
37154           description: Name that identifies the link aggregate interface
37155           required: true
37156           type: string
37157           example: __INTERFACE-NAME__
37158         - name: interface-name
37159           in: path
37160           description: Name given to the interface
37161           required: true
37162           type: string
37163           example: __INTERFACE-NAME__
37164         - name: vlan-interface
37165           in: path
37166           description: String that identifies the interface
37167           required: true
37168           type: string
37169           example: __VLAN-INTERFACE__
37170         - name: l3-interface-ipv4-address
37171           in: path
37172           description: IP address
37173           required: true
37174           type: string
37175           example: __L3-INTERFACE-IPV4-ADDRESS__
37176   /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}:
37177     get:
37178       tags:
37179         - Network
37180       summary: returns l3-interface-ipv4-address-list
37181       description: returns l3-interface-ipv4-address-list
37182       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37183       produces:
37184         - application/json
37185         - application/xml
37186       responses:
37187         "200":
37188           description: successful operation
37189           schema:
37190               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37191         "default":
37192           description: Response codes found in [response codes](https://wiki.onap.org/).
37193       parameters:
37194         - name: vnf-id
37195           in: path
37196           description: Unique id of VNF.  This is unique across the graph.
37197           required: true
37198           type: string
37199           example: __VNF-ID__
37200         - name: interface-name
37201           in: path
37202           description: Name that identifies the link aggregate interface
37203           required: true
37204           type: string
37205           example: __INTERFACE-NAME__
37206         - name: interface-name
37207           in: path
37208           description: Name given to the interface
37209           required: true
37210           type: string
37211           example: __INTERFACE-NAME__
37212         - name: vlan-interface
37213           in: path
37214           description: String that identifies the interface
37215           required: true
37216           type: string
37217           example: __VLAN-INTERFACE__
37218         - name: l3-interface-ipv4-address
37219           in: path
37220           description: IP address
37221           required: true
37222           type: string
37223           example: __L3-INTERFACE-IPV4-ADDRESS__
37224         - name: vnf-name
37225           in: query
37226           description: Name of VNF.
37227           required: false
37228           type: string
37229         - name: vnf-name2
37230           in: query
37231           description: Alternate name of VNF.
37232           required: false
37233           type: string
37234         - name: vnf-type
37235           in: query
37236           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.
37237           required: false
37238           type: string
37239         - name: service-id
37240           in: query
37241           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37242           required: false
37243           type: string
37244         - name: regional-resource-zone
37245           in: query
37246           description: Regional way of organizing pservers, source of truth should define values
37247           required: false
37248           type: string
37249         - name: prov-status
37250           in: query
37251           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37252           required: false
37253           type: string
37254         - name: heat-stack-id
37255           in: query
37256           description: Heat stack id corresponding to this instance, managed by MSO
37257           required: false
37258           type: string
37259         - name: in-maint
37260           in: query
37261           required: false
37262           type: boolean
37263         - name: is-closed-loop-disabled
37264           in: query
37265           required: false
37266           type: boolean
37267         - name: model-invariant-id
37268           in: query
37269           description: the ASDC model id for this resource or service model.
37270           required: false
37271           type: string
37272         - name: model-version-id
37273           in: query
37274           description: the ASDC model version for this resource or service model.
37275           required: false
37276           type: string
37277         - name: widget-model-id
37278           in: query
37279           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37280           required: false
37281           type: string
37282         - name: widget-model-version
37283           in: query
37284           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37285           required: false
37286           type: string
37287         - name: nf-type
37288           in: query
37289           description: Generic description of the type of NF
37290           required: false
37291           type: string
37292         - name: nf-function
37293           in: query
37294           description: English description of Network function that the specific VNF deployment is providing
37295           required: false
37296           type: string
37297         - name: nf-role
37298           in: query
37299           description: role in the network that this model will be providing
37300           required: false
37301           type: string
37302         - name: nf-naming-code
37303           in: query
37304           description: string assigned to this model used for naming purposes
37305           required: false
37306           type: string
37307         - name: interface-id
37308           in: query
37309           description: ID of interface
37310           required: false
37311           type: string
37312         - name: interface-role
37313           in: query
37314           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37315           required: false
37316           type: string
37317         - name: interface-id
37318           in: query
37319           description: ID of interface
37320           required: false
37321           type: string
37322         - name: macaddr
37323           in: query
37324           description: MAC address for the interface
37325           required: false
37326           type: string
37327         - name: network-name
37328           in: query
37329           description: Name of the network
37330           required: false
37331           type: string
37332         - name: vlan-id-inner
37333           in: query
37334           description: Inner VLAN tag
37335           required: false
37336           type: integer
37337           format: int64
37338         - name: vpn-key
37339           in: query
37340           description: This indicates the customers VPN ID associated with this vlan
37341           required: false
37342           type: string
37343         - name: vlan-id-inner
37344           in: query
37345           description: Inner VLAN tag
37346           required: false
37347           type: integer
37348           format: int64
37349         - name: neutron-network-id
37350           in: query
37351           description: Neutron network id of the interface that address belongs to
37352           required: false
37353           type: string
37354         - name: neutron-subnet-id
37355           in: query
37356           description: Neutron id of subnet that address belongs to
37357           required: false
37358           type: string
37359     put:
37360       tags:
37361         - Network
37362       summary: create or update an existing l3-interface-ipv4-address-list
37363       description: |
37364         Create or update an existing l3-interface-ipv4-address-list.
37365         #
37366         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37367       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37368       consumes:
37369         - application/json
37370         - application/xml
37371       produces:
37372         - application/json
37373         - application/xml
37374       responses:
37375         "default":
37376           description: Response codes found in [response codes](https://wiki.onap.org/).
37377       parameters:
37378         - name: vnf-id
37379           in: path
37380           description: Unique id of VNF.  This is unique across the graph.
37381           required: true
37382           type: string
37383           example: __VNF-ID__
37384         - name: interface-name
37385           in: path
37386           description: Name that identifies the link aggregate interface
37387           required: true
37388           type: string
37389           example: __INTERFACE-NAME__
37390         - name: interface-name
37391           in: path
37392           description: Name given to the interface
37393           required: true
37394           type: string
37395           example: __INTERFACE-NAME__
37396         - name: vlan-interface
37397           in: path
37398           description: String that identifies the interface
37399           required: true
37400           type: string
37401           example: __VLAN-INTERFACE__
37402         - name: l3-interface-ipv4-address
37403           in: path
37404           description: IP address
37405           required: true
37406           type: string
37407           example: __L3-INTERFACE-IPV4-ADDRESS__
37408         - name: body
37409           in: body
37410           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37411           required: true
37412           schema:
37413             $ref: "#/definitions/l3-interface-ipv4-address-list"
37414     patch:
37415       tags:
37416         - Network
37417       summary: update an existing l3-interface-ipv4-address-list
37418       description: |
37419         Update an existing l3-interface-ipv4-address-list
37420         #
37421         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37422         The PUT operation will entirely replace an existing object.
37423         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37424         #
37425         Other differences between PUT and PATCH are:
37426         #
37427         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37428         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37429         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37430       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37431       consumes:
37432         - application/json
37433         - application/xml
37434       produces:
37435         - application/json
37436         - application/xml
37437       responses:
37438         "default":
37439           description: Response codes found in [response codes](https://wiki.onap.org/).
37440       parameters:
37441         - name: vnf-id
37442           in: path
37443           description: Unique id of VNF.  This is unique across the graph.
37444           required: true
37445           type: string
37446           example: __VNF-ID__
37447         - name: interface-name
37448           in: path
37449           description: Name that identifies the link aggregate interface
37450           required: true
37451           type: string
37452           example: __INTERFACE-NAME__
37453         - name: interface-name
37454           in: path
37455           description: Name given to the interface
37456           required: true
37457           type: string
37458           example: __INTERFACE-NAME__
37459         - name: vlan-interface
37460           in: path
37461           description: String that identifies the interface
37462           required: true
37463           type: string
37464           example: __VLAN-INTERFACE__
37465         - name: l3-interface-ipv4-address
37466           in: path
37467           description: IP address
37468           required: true
37469           type: string
37470           example: __L3-INTERFACE-IPV4-ADDRESS__
37471         - name: body
37472           in: body
37473           description: l3-interface-ipv4-address-list object that needs to be created or updated.
37474           required: true
37475           schema:
37476             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37477     delete:
37478       tags:
37479         - Network
37480       summary: delete an existing l3-interface-ipv4-address-list
37481       description: delete an existing l3-interface-ipv4-address-list
37482       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37483       consumes:
37484         - application/json
37485         - application/xml
37486       produces:
37487         - application/json
37488         - application/xml
37489       responses:
37490         "default":
37491           description: Response codes found in [response codes](https://wiki.onap.org/).
37492       parameters:
37493         - name: vnf-id
37494           in: path
37495           description: Unique id of VNF.  This is unique across the graph.
37496           required: true
37497           type: string
37498           example: __VNF-ID__
37499         - name: interface-name
37500           in: path
37501           description: Name that identifies the link aggregate interface
37502           required: true
37503           type: string
37504           example: __INTERFACE-NAME__
37505         - name: interface-name
37506           in: path
37507           description: Name given to the interface
37508           required: true
37509           type: string
37510           example: __INTERFACE-NAME__
37511         - name: vlan-interface
37512           in: path
37513           description: String that identifies the interface
37514           required: true
37515           type: string
37516           example: __VLAN-INTERFACE__
37517         - name: l3-interface-ipv4-address
37518           in: path
37519           description: IP address
37520           required: true
37521           type: string
37522           example: __L3-INTERFACE-IPV4-ADDRESS__
37523         - name: resource-version
37524           in: query
37525           description: resource-version for concurrency
37526           required: true
37527           type: string
37528   /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:
37529     put:
37530       tags:
37531         - Network
37532       summary: see node definition for valid relationships
37533       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37534       consumes:
37535         - application/json
37536         - application/xml
37537       produces:
37538         - application/json
37539         - application/xml
37540       responses:
37541         "default":
37542           description: Response codes found in [response codes](https://wiki.onap.org/).
37543       parameters:
37544         - name: vnf-id
37545           in: path
37546           description: Unique id of VNF.  This is unique across the graph.
37547           required: true
37548           type: string
37549           example: __VNF-ID__
37550         - name: interface-name
37551           in: path
37552           description: Name that identifies the link aggregate interface
37553           required: true
37554           type: string
37555           example: __INTERFACE-NAME__
37556         - name: interface-name
37557           in: path
37558           description: Name given to the interface
37559           required: true
37560           type: string
37561           example: __INTERFACE-NAME__
37562         - name: vlan-interface
37563           in: path
37564           description: String that identifies the interface
37565           required: true
37566           type: string
37567           example: __VLAN-INTERFACE__
37568         - name: l3-interface-ipv6-address
37569           in: path
37570           description: IP address
37571           required: true
37572           type: string
37573           example: __L3-INTERFACE-IPV6-ADDRESS__
37574         - name: body
37575           in: body
37576           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37577           required: true
37578           schema:
37579             $ref: "#/definitions/relationship"
37580     delete:
37581       tags:
37582         - Network
37583       summary: delete an existing relationship
37584       description: delete an existing relationship
37585       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37586       consumes:
37587         - application/json
37588         - application/xml
37589       produces:
37590         - application/json
37591         - application/xml
37592       responses:
37593         "default":
37594           description: Response codes found in [response codes](https://wiki.onap.org/).
37595       parameters:
37596         - name: vnf-id
37597           in: path
37598           description: Unique id of VNF.  This is unique across the graph.
37599           required: true
37600           type: string
37601           example: __VNF-ID__
37602         - name: interface-name
37603           in: path
37604           description: Name that identifies the link aggregate interface
37605           required: true
37606           type: string
37607           example: __INTERFACE-NAME__
37608         - name: interface-name
37609           in: path
37610           description: Name given to the interface
37611           required: true
37612           type: string
37613           example: __INTERFACE-NAME__
37614         - name: vlan-interface
37615           in: path
37616           description: String that identifies the interface
37617           required: true
37618           type: string
37619           example: __VLAN-INTERFACE__
37620         - name: l3-interface-ipv6-address
37621           in: path
37622           description: IP address
37623           required: true
37624           type: string
37625           example: __L3-INTERFACE-IPV6-ADDRESS__
37626   /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}:
37627     get:
37628       tags:
37629         - Network
37630       summary: returns l3-interface-ipv6-address-list
37631       description: returns l3-interface-ipv6-address-list
37632       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37633       produces:
37634         - application/json
37635         - application/xml
37636       responses:
37637         "200":
37638           description: successful operation
37639           schema:
37640               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37641         "default":
37642           description: Response codes found in [response codes](https://wiki.onap.org/).
37643       parameters:
37644         - name: vnf-id
37645           in: path
37646           description: Unique id of VNF.  This is unique across the graph.
37647           required: true
37648           type: string
37649           example: __VNF-ID__
37650         - name: interface-name
37651           in: path
37652           description: Name that identifies the link aggregate interface
37653           required: true
37654           type: string
37655           example: __INTERFACE-NAME__
37656         - name: interface-name
37657           in: path
37658           description: Name given to the interface
37659           required: true
37660           type: string
37661           example: __INTERFACE-NAME__
37662         - name: vlan-interface
37663           in: path
37664           description: String that identifies the interface
37665           required: true
37666           type: string
37667           example: __VLAN-INTERFACE__
37668         - name: l3-interface-ipv6-address
37669           in: path
37670           description: IP address
37671           required: true
37672           type: string
37673           example: __L3-INTERFACE-IPV6-ADDRESS__
37674         - name: vnf-name
37675           in: query
37676           description: Name of VNF.
37677           required: false
37678           type: string
37679         - name: vnf-name2
37680           in: query
37681           description: Alternate name of VNF.
37682           required: false
37683           type: string
37684         - name: vnf-type
37685           in: query
37686           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.
37687           required: false
37688           type: string
37689         - name: service-id
37690           in: query
37691           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37692           required: false
37693           type: string
37694         - name: regional-resource-zone
37695           in: query
37696           description: Regional way of organizing pservers, source of truth should define values
37697           required: false
37698           type: string
37699         - name: prov-status
37700           in: query
37701           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37702           required: false
37703           type: string
37704         - name: heat-stack-id
37705           in: query
37706           description: Heat stack id corresponding to this instance, managed by MSO
37707           required: false
37708           type: string
37709         - name: in-maint
37710           in: query
37711           required: false
37712           type: boolean
37713         - name: is-closed-loop-disabled
37714           in: query
37715           required: false
37716           type: boolean
37717         - name: model-invariant-id
37718           in: query
37719           description: the ASDC model id for this resource or service model.
37720           required: false
37721           type: string
37722         - name: model-version-id
37723           in: query
37724           description: the ASDC model version for this resource or service model.
37725           required: false
37726           type: string
37727         - name: widget-model-id
37728           in: query
37729           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37730           required: false
37731           type: string
37732         - name: widget-model-version
37733           in: query
37734           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37735           required: false
37736           type: string
37737         - name: nf-type
37738           in: query
37739           description: Generic description of the type of NF
37740           required: false
37741           type: string
37742         - name: nf-function
37743           in: query
37744           description: English description of Network function that the specific VNF deployment is providing
37745           required: false
37746           type: string
37747         - name: nf-role
37748           in: query
37749           description: role in the network that this model will be providing
37750           required: false
37751           type: string
37752         - name: nf-naming-code
37753           in: query
37754           description: string assigned to this model used for naming purposes
37755           required: false
37756           type: string
37757         - name: interface-id
37758           in: query
37759           description: ID of interface
37760           required: false
37761           type: string
37762         - name: interface-role
37763           in: query
37764           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37765           required: false
37766           type: string
37767         - name: interface-id
37768           in: query
37769           description: ID of interface
37770           required: false
37771           type: string
37772         - name: macaddr
37773           in: query
37774           description: MAC address for the interface
37775           required: false
37776           type: string
37777         - name: network-name
37778           in: query
37779           description: Name of the network
37780           required: false
37781           type: string
37782         - name: vlan-id-inner
37783           in: query
37784           description: Inner VLAN tag
37785           required: false
37786           type: integer
37787           format: int64
37788         - name: vpn-key
37789           in: query
37790           description: This indicates the customers VPN ID associated with this vlan
37791           required: false
37792           type: string
37793         - name: vlan-id-inner
37794           in: query
37795           description: Inner VLAN tag
37796           required: false
37797           type: integer
37798           format: int64
37799         - name: neutron-network-id
37800           in: query
37801           description: Neutron network id of the interface that address belongs to
37802           required: false
37803           type: string
37804         - name: neutron-subnet-id
37805           in: query
37806           description: Neutron id of subnet that address belongs to
37807           required: false
37808           type: string
37809     put:
37810       tags:
37811         - Network
37812       summary: create or update an existing l3-interface-ipv6-address-list
37813       description: |
37814         Create or update an existing l3-interface-ipv6-address-list.
37815         #
37816         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37817       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37818       consumes:
37819         - application/json
37820         - application/xml
37821       produces:
37822         - application/json
37823         - application/xml
37824       responses:
37825         "default":
37826           description: Response codes found in [response codes](https://wiki.onap.org/).
37827       parameters:
37828         - name: vnf-id
37829           in: path
37830           description: Unique id of VNF.  This is unique across the graph.
37831           required: true
37832           type: string
37833           example: __VNF-ID__
37834         - name: interface-name
37835           in: path
37836           description: Name that identifies the link aggregate interface
37837           required: true
37838           type: string
37839           example: __INTERFACE-NAME__
37840         - name: interface-name
37841           in: path
37842           description: Name given to the interface
37843           required: true
37844           type: string
37845           example: __INTERFACE-NAME__
37846         - name: vlan-interface
37847           in: path
37848           description: String that identifies the interface
37849           required: true
37850           type: string
37851           example: __VLAN-INTERFACE__
37852         - name: l3-interface-ipv6-address
37853           in: path
37854           description: IP address
37855           required: true
37856           type: string
37857           example: __L3-INTERFACE-IPV6-ADDRESS__
37858         - name: body
37859           in: body
37860           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37861           required: true
37862           schema:
37863             $ref: "#/definitions/l3-interface-ipv6-address-list"
37864     patch:
37865       tags:
37866         - Network
37867       summary: update an existing l3-interface-ipv6-address-list
37868       description: |
37869         Update an existing l3-interface-ipv6-address-list
37870         #
37871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37872         The PUT operation will entirely replace an existing object.
37873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37874         #
37875         Other differences between PUT and PATCH are:
37876         #
37877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37880       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37881       consumes:
37882         - application/json
37883         - application/xml
37884       produces:
37885         - application/json
37886         - application/xml
37887       responses:
37888         "default":
37889           description: Response codes found in [response codes](https://wiki.onap.org/).
37890       parameters:
37891         - name: vnf-id
37892           in: path
37893           description: Unique id of VNF.  This is unique across the graph.
37894           required: true
37895           type: string
37896           example: __VNF-ID__
37897         - name: interface-name
37898           in: path
37899           description: Name that identifies the link aggregate interface
37900           required: true
37901           type: string
37902           example: __INTERFACE-NAME__
37903         - name: interface-name
37904           in: path
37905           description: Name given to the interface
37906           required: true
37907           type: string
37908           example: __INTERFACE-NAME__
37909         - name: vlan-interface
37910           in: path
37911           description: String that identifies the interface
37912           required: true
37913           type: string
37914           example: __VLAN-INTERFACE__
37915         - name: l3-interface-ipv6-address
37916           in: path
37917           description: IP address
37918           required: true
37919           type: string
37920           example: __L3-INTERFACE-IPV6-ADDRESS__
37921         - name: body
37922           in: body
37923           description: l3-interface-ipv6-address-list object that needs to be created or updated.
37924           required: true
37925           schema:
37926             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37927     delete:
37928       tags:
37929         - Network
37930       summary: delete an existing l3-interface-ipv6-address-list
37931       description: delete an existing l3-interface-ipv6-address-list
37932       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37933       consumes:
37934         - application/json
37935         - application/xml
37936       produces:
37937         - application/json
37938         - application/xml
37939       responses:
37940         "default":
37941           description: Response codes found in [response codes](https://wiki.onap.org/).
37942       parameters:
37943         - name: vnf-id
37944           in: path
37945           description: Unique id of VNF.  This is unique across the graph.
37946           required: true
37947           type: string
37948           example: __VNF-ID__
37949         - name: interface-name
37950           in: path
37951           description: Name that identifies the link aggregate interface
37952           required: true
37953           type: string
37954           example: __INTERFACE-NAME__
37955         - name: interface-name
37956           in: path
37957           description: Name given to the interface
37958           required: true
37959           type: string
37960           example: __INTERFACE-NAME__
37961         - name: vlan-interface
37962           in: path
37963           description: String that identifies the interface
37964           required: true
37965           type: string
37966           example: __VLAN-INTERFACE__
37967         - name: l3-interface-ipv6-address
37968           in: path
37969           description: IP address
37970           required: true
37971           type: string
37972           example: __L3-INTERFACE-IPV6-ADDRESS__
37973         - name: resource-version
37974           in: query
37975           description: resource-version for concurrency
37976           required: true
37977           type: string
37978   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37979     get:
37980       tags:
37981         - Network
37982       summary: returns vlan
37983       description: returns vlan
37984       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
37985       produces:
37986         - application/json
37987         - application/xml
37988       responses:
37989         "200":
37990           description: successful operation
37991           schema:
37992               $ref: "#/getDefinitions/vlan"
37993         "default":
37994           description: Response codes found in [response codes](https://wiki.onap.org/).
37995       parameters:
37996         - name: vnf-id
37997           in: path
37998           description: Unique id of VNF.  This is unique across the graph.
37999           required: true
38000           type: string
38001           example: __VNF-ID__
38002         - name: interface-name
38003           in: path
38004           description: Name that identifies the link aggregate interface
38005           required: true
38006           type: string
38007           example: __INTERFACE-NAME__
38008         - name: interface-name
38009           in: path
38010           description: Name given to the interface
38011           required: true
38012           type: string
38013           example: __INTERFACE-NAME__
38014         - name: vlan-interface
38015           in: path
38016           description: String that identifies the interface
38017           required: true
38018           type: string
38019           example: __VLAN-INTERFACE__
38020         - name: vnf-name
38021           in: query
38022           description: Name of VNF.
38023           required: false
38024           type: string
38025         - name: vnf-name2
38026           in: query
38027           description: Alternate name of VNF.
38028           required: false
38029           type: string
38030         - name: vnf-type
38031           in: query
38032           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.
38033           required: false
38034           type: string
38035         - name: service-id
38036           in: query
38037           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38038           required: false
38039           type: string
38040         - name: regional-resource-zone
38041           in: query
38042           description: Regional way of organizing pservers, source of truth should define values
38043           required: false
38044           type: string
38045         - name: prov-status
38046           in: query
38047           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38048           required: false
38049           type: string
38050         - name: heat-stack-id
38051           in: query
38052           description: Heat stack id corresponding to this instance, managed by MSO
38053           required: false
38054           type: string
38055         - name: in-maint
38056           in: query
38057           required: false
38058           type: boolean
38059         - name: is-closed-loop-disabled
38060           in: query
38061           required: false
38062           type: boolean
38063         - name: model-invariant-id
38064           in: query
38065           description: the ASDC model id for this resource or service model.
38066           required: false
38067           type: string
38068         - name: model-version-id
38069           in: query
38070           description: the ASDC model version for this resource or service model.
38071           required: false
38072           type: string
38073         - name: widget-model-id
38074           in: query
38075           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38076           required: false
38077           type: string
38078         - name: widget-model-version
38079           in: query
38080           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38081           required: false
38082           type: string
38083         - name: nf-type
38084           in: query
38085           description: Generic description of the type of NF
38086           required: false
38087           type: string
38088         - name: nf-function
38089           in: query
38090           description: English description of Network function that the specific VNF deployment is providing
38091           required: false
38092           type: string
38093         - name: nf-role
38094           in: query
38095           description: role in the network that this model will be providing
38096           required: false
38097           type: string
38098         - name: nf-naming-code
38099           in: query
38100           description: string assigned to this model used for naming purposes
38101           required: false
38102           type: string
38103         - name: interface-id
38104           in: query
38105           description: ID of interface
38106           required: false
38107           type: string
38108         - name: interface-role
38109           in: query
38110           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38111           required: false
38112           type: string
38113         - name: interface-id
38114           in: query
38115           description: ID of interface
38116           required: false
38117           type: string
38118         - name: macaddr
38119           in: query
38120           description: MAC address for the interface
38121           required: false
38122           type: string
38123         - name: network-name
38124           in: query
38125           description: Name of the network
38126           required: false
38127           type: string
38128         - name: vlan-id-inner
38129           in: query
38130           description: Inner VLAN tag
38131           required: false
38132           type: integer
38133           format: int64
38134         - name: vpn-key
38135           in: query
38136           description: This indicates the customers VPN ID associated with this vlan
38137           required: false
38138           type: string
38139     put:
38140       tags:
38141         - Network
38142       summary: create or update an existing vlan
38143       description: |
38144         Create or update an existing vlan.
38145         #
38146         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38147       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38148       consumes:
38149         - application/json
38150         - application/xml
38151       produces:
38152         - application/json
38153         - application/xml
38154       responses:
38155         "default":
38156           description: Response codes found in [response codes](https://wiki.onap.org/).
38157       parameters:
38158         - name: vnf-id
38159           in: path
38160           description: Unique id of VNF.  This is unique across the graph.
38161           required: true
38162           type: string
38163           example: __VNF-ID__
38164         - name: interface-name
38165           in: path
38166           description: Name that identifies the link aggregate interface
38167           required: true
38168           type: string
38169           example: __INTERFACE-NAME__
38170         - name: interface-name
38171           in: path
38172           description: Name given to the interface
38173           required: true
38174           type: string
38175           example: __INTERFACE-NAME__
38176         - name: vlan-interface
38177           in: path
38178           description: String that identifies the interface
38179           required: true
38180           type: string
38181           example: __VLAN-INTERFACE__
38182         - name: body
38183           in: body
38184           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38185           required: true
38186           schema:
38187             $ref: "#/definitions/vlan"
38188     patch:
38189       tags:
38190         - Network
38191       summary: update an existing vlan
38192       description: |
38193         Update an existing vlan
38194         #
38195         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38196         The PUT operation will entirely replace an existing object.
38197         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38198         #
38199         Other differences between PUT and PATCH are:
38200         #
38201         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38202         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38203         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38204       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38205       consumes:
38206         - application/json
38207         - application/xml
38208       produces:
38209         - application/json
38210         - application/xml
38211       responses:
38212         "default":
38213           description: Response codes found in [response codes](https://wiki.onap.org/).
38214       parameters:
38215         - name: vnf-id
38216           in: path
38217           description: Unique id of VNF.  This is unique across the graph.
38218           required: true
38219           type: string
38220           example: __VNF-ID__
38221         - name: interface-name
38222           in: path
38223           description: Name that identifies the link aggregate interface
38224           required: true
38225           type: string
38226           example: __INTERFACE-NAME__
38227         - name: interface-name
38228           in: path
38229           description: Name given to the interface
38230           required: true
38231           type: string
38232           example: __INTERFACE-NAME__
38233         - name: vlan-interface
38234           in: path
38235           description: String that identifies the interface
38236           required: true
38237           type: string
38238           example: __VLAN-INTERFACE__
38239         - name: body
38240           in: body
38241           description: vlan object that needs to be created or updated.
38242           required: true
38243           schema:
38244             $ref: "#/patchDefinitions/vlan"
38245     delete:
38246       tags:
38247         - Network
38248       summary: delete an existing vlan
38249       description: delete an existing vlan
38250       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38251       consumes:
38252         - application/json
38253         - application/xml
38254       produces:
38255         - application/json
38256         - application/xml
38257       responses:
38258         "default":
38259           description: Response codes found in [response codes](https://wiki.onap.org/).
38260       parameters:
38261         - name: vnf-id
38262           in: path
38263           description: Unique id of VNF.  This is unique across the graph.
38264           required: true
38265           type: string
38266           example: __VNF-ID__
38267         - name: interface-name
38268           in: path
38269           description: Name that identifies the link aggregate interface
38270           required: true
38271           type: string
38272           example: __INTERFACE-NAME__
38273         - name: interface-name
38274           in: path
38275           description: Name given to the interface
38276           required: true
38277           type: string
38278           example: __INTERFACE-NAME__
38279         - name: vlan-interface
38280           in: path
38281           description: String that identifies the interface
38282           required: true
38283           type: string
38284           example: __VLAN-INTERFACE__
38285         - name: resource-version
38286           in: query
38287           description: resource-version for concurrency
38288           required: true
38289           type: string
38290   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38291     get:
38292       tags:
38293         - Network
38294       summary: returns vlans
38295       description: returns vlans
38296       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38297       produces:
38298         - application/json
38299         - application/xml
38300       responses:
38301         "200":
38302           description: successful operation
38303           schema:
38304               $ref: "#/getDefinitions/vlans"
38305         "default":
38306           description: Response codes found in [response codes](https://wiki.onap.org/).
38307       parameters:
38308         - name: vnf-id
38309           in: path
38310           description: Unique id of VNF.  This is unique across the graph.
38311           required: true
38312           type: string
38313           example: __VNF-ID__
38314         - name: interface-name
38315           in: path
38316           description: Name that identifies the link aggregate interface
38317           required: true
38318           type: string
38319           example: __INTERFACE-NAME__
38320         - name: interface-name
38321           in: path
38322           description: Name given to the interface
38323           required: true
38324           type: string
38325           example: __INTERFACE-NAME__
38326         - name: vnf-name
38327           in: query
38328           description: Name of VNF.
38329           required: false
38330           type: string
38331         - name: vnf-name2
38332           in: query
38333           description: Alternate name of VNF.
38334           required: false
38335           type: string
38336         - name: vnf-type
38337           in: query
38338           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.
38339           required: false
38340           type: string
38341         - name: service-id
38342           in: query
38343           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38344           required: false
38345           type: string
38346         - name: regional-resource-zone
38347           in: query
38348           description: Regional way of organizing pservers, source of truth should define values
38349           required: false
38350           type: string
38351         - name: prov-status
38352           in: query
38353           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38354           required: false
38355           type: string
38356         - name: heat-stack-id
38357           in: query
38358           description: Heat stack id corresponding to this instance, managed by MSO
38359           required: false
38360           type: string
38361         - name: in-maint
38362           in: query
38363           required: false
38364           type: boolean
38365         - name: is-closed-loop-disabled
38366           in: query
38367           required: false
38368           type: boolean
38369         - name: model-invariant-id
38370           in: query
38371           description: the ASDC model id for this resource or service model.
38372           required: false
38373           type: string
38374         - name: model-version-id
38375           in: query
38376           description: the ASDC model version for this resource or service model.
38377           required: false
38378           type: string
38379         - name: widget-model-id
38380           in: query
38381           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38382           required: false
38383           type: string
38384         - name: widget-model-version
38385           in: query
38386           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38387           required: false
38388           type: string
38389         - name: nf-type
38390           in: query
38391           description: Generic description of the type of NF
38392           required: false
38393           type: string
38394         - name: nf-function
38395           in: query
38396           description: English description of Network function that the specific VNF deployment is providing
38397           required: false
38398           type: string
38399         - name: nf-role
38400           in: query
38401           description: role in the network that this model will be providing
38402           required: false
38403           type: string
38404         - name: nf-naming-code
38405           in: query
38406           description: string assigned to this model used for naming purposes
38407           required: false
38408           type: string
38409         - name: interface-id
38410           in: query
38411           description: ID of interface
38412           required: false
38413           type: string
38414         - name: interface-role
38415           in: query
38416           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38417           required: false
38418           type: string
38419         - name: interface-id
38420           in: query
38421           description: ID of interface
38422           required: false
38423           type: string
38424         - name: macaddr
38425           in: query
38426           description: MAC address for the interface
38427           required: false
38428           type: string
38429         - name: network-name
38430           in: query
38431           description: Name of the network
38432           required: false
38433           type: string
38434   /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:
38435     put:
38436       tags:
38437         - Network
38438       summary: see node definition for valid relationships
38439       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38440       consumes:
38441         - application/json
38442         - application/xml
38443       produces:
38444         - application/json
38445         - application/xml
38446       responses:
38447         "default":
38448           description: Response codes found in [response codes](https://wiki.onap.org/).
38449       parameters:
38450         - name: vnf-id
38451           in: path
38452           description: Unique id of VNF.  This is unique across the graph.
38453           required: true
38454           type: string
38455           example: __VNF-ID__
38456         - name: interface-name
38457           in: path
38458           description: Name that identifies the link aggregate interface
38459           required: true
38460           type: string
38461           example: __INTERFACE-NAME__
38462         - name: interface-name
38463           in: path
38464           description: Name given to the interface
38465           required: true
38466           type: string
38467           example: __INTERFACE-NAME__
38468         - name: pci-id
38469           in: path
38470           description: PCI ID used to identify the sriov-vf
38471           required: true
38472           type: string
38473           example: __PCI-ID__
38474         - name: body
38475           in: body
38476           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38477           required: true
38478           schema:
38479             $ref: "#/definitions/relationship"
38480     delete:
38481       tags:
38482         - Network
38483       summary: delete an existing relationship
38484       description: delete an existing relationship
38485       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38486       consumes:
38487         - application/json
38488         - application/xml
38489       produces:
38490         - application/json
38491         - application/xml
38492       responses:
38493         "default":
38494           description: Response codes found in [response codes](https://wiki.onap.org/).
38495       parameters:
38496         - name: vnf-id
38497           in: path
38498           description: Unique id of VNF.  This is unique across the graph.
38499           required: true
38500           type: string
38501           example: __VNF-ID__
38502         - name: interface-name
38503           in: path
38504           description: Name that identifies the link aggregate interface
38505           required: true
38506           type: string
38507           example: __INTERFACE-NAME__
38508         - name: interface-name
38509           in: path
38510           description: Name given to the interface
38511           required: true
38512           type: string
38513           example: __INTERFACE-NAME__
38514         - name: pci-id
38515           in: path
38516           description: PCI ID used to identify the sriov-vf
38517           required: true
38518           type: string
38519           example: __PCI-ID__
38520   /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}:
38521     get:
38522       tags:
38523         - Network
38524       summary: returns sriov-vf
38525       description: returns sriov-vf
38526       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38527       produces:
38528         - application/json
38529         - application/xml
38530       responses:
38531         "200":
38532           description: successful operation
38533           schema:
38534               $ref: "#/getDefinitions/sriov-vf"
38535         "default":
38536           description: Response codes found in [response codes](https://wiki.onap.org/).
38537       parameters:
38538         - name: vnf-id
38539           in: path
38540           description: Unique id of VNF.  This is unique across the graph.
38541           required: true
38542           type: string
38543           example: __VNF-ID__
38544         - name: interface-name
38545           in: path
38546           description: Name that identifies the link aggregate interface
38547           required: true
38548           type: string
38549           example: __INTERFACE-NAME__
38550         - name: interface-name
38551           in: path
38552           description: Name given to the interface
38553           required: true
38554           type: string
38555           example: __INTERFACE-NAME__
38556         - name: pci-id
38557           in: path
38558           description: PCI ID used to identify the sriov-vf
38559           required: true
38560           type: string
38561           example: __PCI-ID__
38562         - name: vnf-name
38563           in: query
38564           description: Name of VNF.
38565           required: false
38566           type: string
38567         - name: vnf-name2
38568           in: query
38569           description: Alternate name of VNF.
38570           required: false
38571           type: string
38572         - name: vnf-type
38573           in: query
38574           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.
38575           required: false
38576           type: string
38577         - name: service-id
38578           in: query
38579           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38580           required: false
38581           type: string
38582         - name: regional-resource-zone
38583           in: query
38584           description: Regional way of organizing pservers, source of truth should define values
38585           required: false
38586           type: string
38587         - name: prov-status
38588           in: query
38589           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38590           required: false
38591           type: string
38592         - name: heat-stack-id
38593           in: query
38594           description: Heat stack id corresponding to this instance, managed by MSO
38595           required: false
38596           type: string
38597         - name: in-maint
38598           in: query
38599           required: false
38600           type: boolean
38601         - name: is-closed-loop-disabled
38602           in: query
38603           required: false
38604           type: boolean
38605         - name: model-invariant-id
38606           in: query
38607           description: the ASDC model id for this resource or service model.
38608           required: false
38609           type: string
38610         - name: model-version-id
38611           in: query
38612           description: the ASDC model version for this resource or service model.
38613           required: false
38614           type: string
38615         - name: widget-model-id
38616           in: query
38617           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38618           required: false
38619           type: string
38620         - name: widget-model-version
38621           in: query
38622           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38623           required: false
38624           type: string
38625         - name: nf-type
38626           in: query
38627           description: Generic description of the type of NF
38628           required: false
38629           type: string
38630         - name: nf-function
38631           in: query
38632           description: English description of Network function that the specific VNF deployment is providing
38633           required: false
38634           type: string
38635         - name: nf-role
38636           in: query
38637           description: role in the network that this model will be providing
38638           required: false
38639           type: string
38640         - name: nf-naming-code
38641           in: query
38642           description: string assigned to this model used for naming purposes
38643           required: false
38644           type: string
38645         - name: interface-id
38646           in: query
38647           description: ID of interface
38648           required: false
38649           type: string
38650         - name: interface-role
38651           in: query
38652           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38653           required: false
38654           type: string
38655         - name: interface-id
38656           in: query
38657           description: ID of interface
38658           required: false
38659           type: string
38660         - name: macaddr
38661           in: query
38662           description: MAC address for the interface
38663           required: false
38664           type: string
38665         - name: network-name
38666           in: query
38667           description: Name of the network
38668           required: false
38669           type: string
38670         - name: vf-vlan-filter
38671           in: query
38672           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
38673           required: false
38674           type: string
38675         - name: vf-mac-filter
38676           in: query
38677           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
38678           required: false
38679           type: string
38680         - name: vf-vlan-strip
38681           in: query
38682           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
38683           required: false
38684           type: boolean
38685         - name: neutron-network-id
38686           in: query
38687           description: Neutron network id of the interface
38688           required: false
38689           type: string
38690     put:
38691       tags:
38692         - Network
38693       summary: create or update an existing sriov-vf
38694       description: |
38695         Create or update an existing sriov-vf.
38696         #
38697         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38698       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38699       consumes:
38700         - application/json
38701         - application/xml
38702       produces:
38703         - application/json
38704         - application/xml
38705       responses:
38706         "default":
38707           description: Response codes found in [response codes](https://wiki.onap.org/).
38708       parameters:
38709         - name: vnf-id
38710           in: path
38711           description: Unique id of VNF.  This is unique across the graph.
38712           required: true
38713           type: string
38714           example: __VNF-ID__
38715         - name: interface-name
38716           in: path
38717           description: Name that identifies the link aggregate interface
38718           required: true
38719           type: string
38720           example: __INTERFACE-NAME__
38721         - name: interface-name
38722           in: path
38723           description: Name given to the interface
38724           required: true
38725           type: string
38726           example: __INTERFACE-NAME__
38727         - name: pci-id
38728           in: path
38729           description: PCI ID used to identify the sriov-vf
38730           required: true
38731           type: string
38732           example: __PCI-ID__
38733         - name: body
38734           in: body
38735           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38736           required: true
38737           schema:
38738             $ref: "#/definitions/sriov-vf"
38739     patch:
38740       tags:
38741         - Network
38742       summary: update an existing sriov-vf
38743       description: |
38744         Update an existing sriov-vf
38745         #
38746         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38747         The PUT operation will entirely replace an existing object.
38748         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38749         #
38750         Other differences between PUT and PATCH are:
38751         #
38752         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38753         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38754         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38755       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38756       consumes:
38757         - application/json
38758         - application/xml
38759       produces:
38760         - application/json
38761         - application/xml
38762       responses:
38763         "default":
38764           description: Response codes found in [response codes](https://wiki.onap.org/).
38765       parameters:
38766         - name: vnf-id
38767           in: path
38768           description: Unique id of VNF.  This is unique across the graph.
38769           required: true
38770           type: string
38771           example: __VNF-ID__
38772         - name: interface-name
38773           in: path
38774           description: Name that identifies the link aggregate interface
38775           required: true
38776           type: string
38777           example: __INTERFACE-NAME__
38778         - name: interface-name
38779           in: path
38780           description: Name given to the interface
38781           required: true
38782           type: string
38783           example: __INTERFACE-NAME__
38784         - name: pci-id
38785           in: path
38786           description: PCI ID used to identify the sriov-vf
38787           required: true
38788           type: string
38789           example: __PCI-ID__
38790         - name: body
38791           in: body
38792           description: sriov-vf object that needs to be created or updated.
38793           required: true
38794           schema:
38795             $ref: "#/patchDefinitions/sriov-vf"
38796     delete:
38797       tags:
38798         - Network
38799       summary: delete an existing sriov-vf
38800       description: delete an existing sriov-vf
38801       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38802       consumes:
38803         - application/json
38804         - application/xml
38805       produces:
38806         - application/json
38807         - application/xml
38808       responses:
38809         "default":
38810           description: Response codes found in [response codes](https://wiki.onap.org/).
38811       parameters:
38812         - name: vnf-id
38813           in: path
38814           description: Unique id of VNF.  This is unique across the graph.
38815           required: true
38816           type: string
38817           example: __VNF-ID__
38818         - name: interface-name
38819           in: path
38820           description: Name that identifies the link aggregate interface
38821           required: true
38822           type: string
38823           example: __INTERFACE-NAME__
38824         - name: interface-name
38825           in: path
38826           description: Name given to the interface
38827           required: true
38828           type: string
38829           example: __INTERFACE-NAME__
38830         - name: pci-id
38831           in: path
38832           description: PCI ID used to identify the sriov-vf
38833           required: true
38834           type: string
38835           example: __PCI-ID__
38836         - name: resource-version
38837           in: query
38838           description: resource-version for concurrency
38839           required: true
38840           type: string
38841   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38842     get:
38843       tags:
38844         - Network
38845       summary: returns sriov-vfs
38846       description: returns sriov-vfs
38847       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38848       produces:
38849         - application/json
38850         - application/xml
38851       responses:
38852         "200":
38853           description: successful operation
38854           schema:
38855               $ref: "#/getDefinitions/sriov-vfs"
38856         "default":
38857           description: Response codes found in [response codes](https://wiki.onap.org/).
38858       parameters:
38859         - name: vnf-id
38860           in: path
38861           description: Unique id of VNF.  This is unique across the graph.
38862           required: true
38863           type: string
38864           example: __VNF-ID__
38865         - name: interface-name
38866           in: path
38867           description: Name that identifies the link aggregate interface
38868           required: true
38869           type: string
38870           example: __INTERFACE-NAME__
38871         - name: interface-name
38872           in: path
38873           description: Name given to the interface
38874           required: true
38875           type: string
38876           example: __INTERFACE-NAME__
38877         - name: vnf-name
38878           in: query
38879           description: Name of VNF.
38880           required: false
38881           type: string
38882         - name: vnf-name2
38883           in: query
38884           description: Alternate name of VNF.
38885           required: false
38886           type: string
38887         - name: vnf-type
38888           in: query
38889           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.
38890           required: false
38891           type: string
38892         - name: service-id
38893           in: query
38894           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38895           required: false
38896           type: string
38897         - name: regional-resource-zone
38898           in: query
38899           description: Regional way of organizing pservers, source of truth should define values
38900           required: false
38901           type: string
38902         - name: prov-status
38903           in: query
38904           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38905           required: false
38906           type: string
38907         - name: heat-stack-id
38908           in: query
38909           description: Heat stack id corresponding to this instance, managed by MSO
38910           required: false
38911           type: string
38912         - name: in-maint
38913           in: query
38914           required: false
38915           type: boolean
38916         - name: is-closed-loop-disabled
38917           in: query
38918           required: false
38919           type: boolean
38920         - name: model-invariant-id
38921           in: query
38922           description: the ASDC model id for this resource or service model.
38923           required: false
38924           type: string
38925         - name: model-version-id
38926           in: query
38927           description: the ASDC model version for this resource or service model.
38928           required: false
38929           type: string
38930         - name: widget-model-id
38931           in: query
38932           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38933           required: false
38934           type: string
38935         - name: widget-model-version
38936           in: query
38937           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38938           required: false
38939           type: string
38940         - name: nf-type
38941           in: query
38942           description: Generic description of the type of NF
38943           required: false
38944           type: string
38945         - name: nf-function
38946           in: query
38947           description: English description of Network function that the specific VNF deployment is providing
38948           required: false
38949           type: string
38950         - name: nf-role
38951           in: query
38952           description: role in the network that this model will be providing
38953           required: false
38954           type: string
38955         - name: nf-naming-code
38956           in: query
38957           description: string assigned to this model used for naming purposes
38958           required: false
38959           type: string
38960         - name: interface-id
38961           in: query
38962           description: ID of interface
38963           required: false
38964           type: string
38965         - name: interface-role
38966           in: query
38967           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38968           required: false
38969           type: string
38970         - name: interface-id
38971           in: query
38972           description: ID of interface
38973           required: false
38974           type: string
38975         - name: macaddr
38976           in: query
38977           description: MAC address for the interface
38978           required: false
38979           type: string
38980         - name: network-name
38981           in: query
38982           description: Name of the network
38983           required: false
38984           type: string
38985   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38986     put:
38987       tags:
38988         - Network
38989       summary: see node definition for valid relationships
38990       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38991       consumes:
38992         - application/json
38993         - application/xml
38994       produces:
38995         - application/json
38996         - application/xml
38997       responses:
38998         "default":
38999           description: Response codes found in [response codes](https://wiki.onap.org/).
39000       parameters:
39001         - name: vnf-id
39002           in: path
39003           description: Unique id of VNF.  This is unique across the graph.
39004           required: true
39005           type: string
39006           example: __VNF-ID__
39007         - name: interface-name
39008           in: path
39009           description: Name that identifies the link aggregate interface
39010           required: true
39011           type: string
39012           example: __INTERFACE-NAME__
39013         - name: interface-name
39014           in: path
39015           description: Name given to the interface
39016           required: true
39017           type: string
39018           example: __INTERFACE-NAME__
39019         - name: body
39020           in: body
39021           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39022           required: true
39023           schema:
39024             $ref: "#/definitions/relationship"
39025     delete:
39026       tags:
39027         - Network
39028       summary: delete an existing relationship
39029       description: delete an existing relationship
39030       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39031       consumes:
39032         - application/json
39033         - application/xml
39034       produces:
39035         - application/json
39036         - application/xml
39037       responses:
39038         "default":
39039           description: Response codes found in [response codes](https://wiki.onap.org/).
39040       parameters:
39041         - name: vnf-id
39042           in: path
39043           description: Unique id of VNF.  This is unique across the graph.
39044           required: true
39045           type: string
39046           example: __VNF-ID__
39047         - name: interface-name
39048           in: path
39049           description: Name that identifies the link aggregate interface
39050           required: true
39051           type: string
39052           example: __INTERFACE-NAME__
39053         - name: interface-name
39054           in: path
39055           description: Name given to the interface
39056           required: true
39057           type: string
39058           example: __INTERFACE-NAME__
39059   /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:
39060     put:
39061       tags:
39062         - Network
39063       summary: see node definition for valid relationships
39064       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39065       consumes:
39066         - application/json
39067         - application/xml
39068       produces:
39069         - application/json
39070         - application/xml
39071       responses:
39072         "default":
39073           description: Response codes found in [response codes](https://wiki.onap.org/).
39074       parameters:
39075         - name: vnf-id
39076           in: path
39077           description: Unique id of VNF.  This is unique across the graph.
39078           required: true
39079           type: string
39080           example: __VNF-ID__
39081         - name: interface-name
39082           in: path
39083           description: Name that identifies the link aggregate interface
39084           required: true
39085           type: string
39086           example: __INTERFACE-NAME__
39087         - name: interface-name
39088           in: path
39089           description: Name given to the interface
39090           required: true
39091           type: string
39092           example: __INTERFACE-NAME__
39093         - name: l3-interface-ipv4-address
39094           in: path
39095           description: IP address
39096           required: true
39097           type: string
39098           example: __L3-INTERFACE-IPV4-ADDRESS__
39099         - name: body
39100           in: body
39101           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39102           required: true
39103           schema:
39104             $ref: "#/definitions/relationship"
39105     delete:
39106       tags:
39107         - Network
39108       summary: delete an existing relationship
39109       description: delete an existing relationship
39110       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39111       consumes:
39112         - application/json
39113         - application/xml
39114       produces:
39115         - application/json
39116         - application/xml
39117       responses:
39118         "default":
39119           description: Response codes found in [response codes](https://wiki.onap.org/).
39120       parameters:
39121         - name: vnf-id
39122           in: path
39123           description: Unique id of VNF.  This is unique across the graph.
39124           required: true
39125           type: string
39126           example: __VNF-ID__
39127         - name: interface-name
39128           in: path
39129           description: Name that identifies the link aggregate interface
39130           required: true
39131           type: string
39132           example: __INTERFACE-NAME__
39133         - name: interface-name
39134           in: path
39135           description: Name given to the interface
39136           required: true
39137           type: string
39138           example: __INTERFACE-NAME__
39139         - name: l3-interface-ipv4-address
39140           in: path
39141           description: IP address
39142           required: true
39143           type: string
39144           example: __L3-INTERFACE-IPV4-ADDRESS__
39145   /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}:
39146     get:
39147       tags:
39148         - Network
39149       summary: returns l3-interface-ipv4-address-list
39150       description: returns l3-interface-ipv4-address-list
39151       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39152       produces:
39153         - application/json
39154         - application/xml
39155       responses:
39156         "200":
39157           description: successful operation
39158           schema:
39159               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39160         "default":
39161           description: Response codes found in [response codes](https://wiki.onap.org/).
39162       parameters:
39163         - name: vnf-id
39164           in: path
39165           description: Unique id of VNF.  This is unique across the graph.
39166           required: true
39167           type: string
39168           example: __VNF-ID__
39169         - name: interface-name
39170           in: path
39171           description: Name that identifies the link aggregate interface
39172           required: true
39173           type: string
39174           example: __INTERFACE-NAME__
39175         - name: interface-name
39176           in: path
39177           description: Name given to the interface
39178           required: true
39179           type: string
39180           example: __INTERFACE-NAME__
39181         - name: l3-interface-ipv4-address
39182           in: path
39183           description: IP address
39184           required: true
39185           type: string
39186           example: __L3-INTERFACE-IPV4-ADDRESS__
39187         - name: vnf-name
39188           in: query
39189           description: Name of VNF.
39190           required: false
39191           type: string
39192         - name: vnf-name2
39193           in: query
39194           description: Alternate name of VNF.
39195           required: false
39196           type: string
39197         - name: vnf-type
39198           in: query
39199           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.
39200           required: false
39201           type: string
39202         - name: service-id
39203           in: query
39204           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39205           required: false
39206           type: string
39207         - name: regional-resource-zone
39208           in: query
39209           description: Regional way of organizing pservers, source of truth should define values
39210           required: false
39211           type: string
39212         - name: prov-status
39213           in: query
39214           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39215           required: false
39216           type: string
39217         - name: heat-stack-id
39218           in: query
39219           description: Heat stack id corresponding to this instance, managed by MSO
39220           required: false
39221           type: string
39222         - name: in-maint
39223           in: query
39224           required: false
39225           type: boolean
39226         - name: is-closed-loop-disabled
39227           in: query
39228           required: false
39229           type: boolean
39230         - name: model-invariant-id
39231           in: query
39232           description: the ASDC model id for this resource or service model.
39233           required: false
39234           type: string
39235         - name: model-version-id
39236           in: query
39237           description: the ASDC model version for this resource or service model.
39238           required: false
39239           type: string
39240         - name: widget-model-id
39241           in: query
39242           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39243           required: false
39244           type: string
39245         - name: widget-model-version
39246           in: query
39247           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39248           required: false
39249           type: string
39250         - name: nf-type
39251           in: query
39252           description: Generic description of the type of NF
39253           required: false
39254           type: string
39255         - name: nf-function
39256           in: query
39257           description: English description of Network function that the specific VNF deployment is providing
39258           required: false
39259           type: string
39260         - name: nf-role
39261           in: query
39262           description: role in the network that this model will be providing
39263           required: false
39264           type: string
39265         - name: nf-naming-code
39266           in: query
39267           description: string assigned to this model used for naming purposes
39268           required: false
39269           type: string
39270         - name: interface-id
39271           in: query
39272           description: ID of interface
39273           required: false
39274           type: string
39275         - name: interface-role
39276           in: query
39277           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39278           required: false
39279           type: string
39280         - name: interface-id
39281           in: query
39282           description: ID of interface
39283           required: false
39284           type: string
39285         - name: macaddr
39286           in: query
39287           description: MAC address for the interface
39288           required: false
39289           type: string
39290         - name: network-name
39291           in: query
39292           description: Name of the network
39293           required: false
39294           type: string
39295         - name: vlan-id-inner
39296           in: query
39297           description: Inner VLAN tag
39298           required: false
39299           type: integer
39300           format: int64
39301         - name: neutron-network-id
39302           in: query
39303           description: Neutron network id of the interface that address belongs to
39304           required: false
39305           type: string
39306         - name: neutron-subnet-id
39307           in: query
39308           description: Neutron id of subnet that address belongs to
39309           required: false
39310           type: string
39311     put:
39312       tags:
39313         - Network
39314       summary: create or update an existing l3-interface-ipv4-address-list
39315       description: |
39316         Create or update an existing l3-interface-ipv4-address-list.
39317         #
39318         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39319       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39320       consumes:
39321         - application/json
39322         - application/xml
39323       produces:
39324         - application/json
39325         - application/xml
39326       responses:
39327         "default":
39328           description: Response codes found in [response codes](https://wiki.onap.org/).
39329       parameters:
39330         - name: vnf-id
39331           in: path
39332           description: Unique id of VNF.  This is unique across the graph.
39333           required: true
39334           type: string
39335           example: __VNF-ID__
39336         - name: interface-name
39337           in: path
39338           description: Name that identifies the link aggregate interface
39339           required: true
39340           type: string
39341           example: __INTERFACE-NAME__
39342         - name: interface-name
39343           in: path
39344           description: Name given to the interface
39345           required: true
39346           type: string
39347           example: __INTERFACE-NAME__
39348         - name: l3-interface-ipv4-address
39349           in: path
39350           description: IP address
39351           required: true
39352           type: string
39353           example: __L3-INTERFACE-IPV4-ADDRESS__
39354         - name: body
39355           in: body
39356           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39357           required: true
39358           schema:
39359             $ref: "#/definitions/l3-interface-ipv4-address-list"
39360     patch:
39361       tags:
39362         - Network
39363       summary: update an existing l3-interface-ipv4-address-list
39364       description: |
39365         Update an existing l3-interface-ipv4-address-list
39366         #
39367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39368         The PUT operation will entirely replace an existing object.
39369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39370         #
39371         Other differences between PUT and PATCH are:
39372         #
39373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39376       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39377       consumes:
39378         - application/json
39379         - application/xml
39380       produces:
39381         - application/json
39382         - application/xml
39383       responses:
39384         "default":
39385           description: Response codes found in [response codes](https://wiki.onap.org/).
39386       parameters:
39387         - name: vnf-id
39388           in: path
39389           description: Unique id of VNF.  This is unique across the graph.
39390           required: true
39391           type: string
39392           example: __VNF-ID__
39393         - name: interface-name
39394           in: path
39395           description: Name that identifies the link aggregate interface
39396           required: true
39397           type: string
39398           example: __INTERFACE-NAME__
39399         - name: interface-name
39400           in: path
39401           description: Name given to the interface
39402           required: true
39403           type: string
39404           example: __INTERFACE-NAME__
39405         - name: l3-interface-ipv4-address
39406           in: path
39407           description: IP address
39408           required: true
39409           type: string
39410           example: __L3-INTERFACE-IPV4-ADDRESS__
39411         - name: body
39412           in: body
39413           description: l3-interface-ipv4-address-list object that needs to be created or updated.
39414           required: true
39415           schema:
39416             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39417     delete:
39418       tags:
39419         - Network
39420       summary: delete an existing l3-interface-ipv4-address-list
39421       description: delete an existing l3-interface-ipv4-address-list
39422       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39423       consumes:
39424         - application/json
39425         - application/xml
39426       produces:
39427         - application/json
39428         - application/xml
39429       responses:
39430         "default":
39431           description: Response codes found in [response codes](https://wiki.onap.org/).
39432       parameters:
39433         - name: vnf-id
39434           in: path
39435           description: Unique id of VNF.  This is unique across the graph.
39436           required: true
39437           type: string
39438           example: __VNF-ID__
39439         - name: interface-name
39440           in: path
39441           description: Name that identifies the link aggregate interface
39442           required: true
39443           type: string
39444           example: __INTERFACE-NAME__
39445         - name: interface-name
39446           in: path
39447           description: Name given to the interface
39448           required: true
39449           type: string
39450           example: __INTERFACE-NAME__
39451         - name: l3-interface-ipv4-address
39452           in: path
39453           description: IP address
39454           required: true
39455           type: string
39456           example: __L3-INTERFACE-IPV4-ADDRESS__
39457         - name: resource-version
39458           in: query
39459           description: resource-version for concurrency
39460           required: true
39461           type: string
39462   /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:
39463     put:
39464       tags:
39465         - Network
39466       summary: see node definition for valid relationships
39467       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39468       consumes:
39469         - application/json
39470         - application/xml
39471       produces:
39472         - application/json
39473         - application/xml
39474       responses:
39475         "default":
39476           description: Response codes found in [response codes](https://wiki.onap.org/).
39477       parameters:
39478         - name: vnf-id
39479           in: path
39480           description: Unique id of VNF.  This is unique across the graph.
39481           required: true
39482           type: string
39483           example: __VNF-ID__
39484         - name: interface-name
39485           in: path
39486           description: Name that identifies the link aggregate interface
39487           required: true
39488           type: string
39489           example: __INTERFACE-NAME__
39490         - name: interface-name
39491           in: path
39492           description: Name given to the interface
39493           required: true
39494           type: string
39495           example: __INTERFACE-NAME__
39496         - name: l3-interface-ipv6-address
39497           in: path
39498           description: IP address
39499           required: true
39500           type: string
39501           example: __L3-INTERFACE-IPV6-ADDRESS__
39502         - name: body
39503           in: body
39504           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39505           required: true
39506           schema:
39507             $ref: "#/definitions/relationship"
39508     delete:
39509       tags:
39510         - Network
39511       summary: delete an existing relationship
39512       description: delete an existing relationship
39513       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39514       consumes:
39515         - application/json
39516         - application/xml
39517       produces:
39518         - application/json
39519         - application/xml
39520       responses:
39521         "default":
39522           description: Response codes found in [response codes](https://wiki.onap.org/).
39523       parameters:
39524         - name: vnf-id
39525           in: path
39526           description: Unique id of VNF.  This is unique across the graph.
39527           required: true
39528           type: string
39529           example: __VNF-ID__
39530         - name: interface-name
39531           in: path
39532           description: Name that identifies the link aggregate interface
39533           required: true
39534           type: string
39535           example: __INTERFACE-NAME__
39536         - name: interface-name
39537           in: path
39538           description: Name given to the interface
39539           required: true
39540           type: string
39541           example: __INTERFACE-NAME__
39542         - name: l3-interface-ipv6-address
39543           in: path
39544           description: IP address
39545           required: true
39546           type: string
39547           example: __L3-INTERFACE-IPV6-ADDRESS__
39548   /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}:
39549     get:
39550       tags:
39551         - Network
39552       summary: returns l3-interface-ipv6-address-list
39553       description: returns l3-interface-ipv6-address-list
39554       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39555       produces:
39556         - application/json
39557         - application/xml
39558       responses:
39559         "200":
39560           description: successful operation
39561           schema:
39562               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39563         "default":
39564           description: Response codes found in [response codes](https://wiki.onap.org/).
39565       parameters:
39566         - name: vnf-id
39567           in: path
39568           description: Unique id of VNF.  This is unique across the graph.
39569           required: true
39570           type: string
39571           example: __VNF-ID__
39572         - name: interface-name
39573           in: path
39574           description: Name that identifies the link aggregate interface
39575           required: true
39576           type: string
39577           example: __INTERFACE-NAME__
39578         - name: interface-name
39579           in: path
39580           description: Name given to the interface
39581           required: true
39582           type: string
39583           example: __INTERFACE-NAME__
39584         - name: l3-interface-ipv6-address
39585           in: path
39586           description: IP address
39587           required: true
39588           type: string
39589           example: __L3-INTERFACE-IPV6-ADDRESS__
39590         - name: vnf-name
39591           in: query
39592           description: Name of VNF.
39593           required: false
39594           type: string
39595         - name: vnf-name2
39596           in: query
39597           description: Alternate name of VNF.
39598           required: false
39599           type: string
39600         - name: vnf-type
39601           in: query
39602           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.
39603           required: false
39604           type: string
39605         - name: service-id
39606           in: query
39607           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39608           required: false
39609           type: string
39610         - name: regional-resource-zone
39611           in: query
39612           description: Regional way of organizing pservers, source of truth should define values
39613           required: false
39614           type: string
39615         - name: prov-status
39616           in: query
39617           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39618           required: false
39619           type: string
39620         - name: heat-stack-id
39621           in: query
39622           description: Heat stack id corresponding to this instance, managed by MSO
39623           required: false
39624           type: string
39625         - name: in-maint
39626           in: query
39627           required: false
39628           type: boolean
39629         - name: is-closed-loop-disabled
39630           in: query
39631           required: false
39632           type: boolean
39633         - name: model-invariant-id
39634           in: query
39635           description: the ASDC model id for this resource or service model.
39636           required: false
39637           type: string
39638         - name: model-version-id
39639           in: query
39640           description: the ASDC model version for this resource or service model.
39641           required: false
39642           type: string
39643         - name: widget-model-id
39644           in: query
39645           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39646           required: false
39647           type: string
39648         - name: widget-model-version
39649           in: query
39650           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39651           required: false
39652           type: string
39653         - name: nf-type
39654           in: query
39655           description: Generic description of the type of NF
39656           required: false
39657           type: string
39658         - name: nf-function
39659           in: query
39660           description: English description of Network function that the specific VNF deployment is providing
39661           required: false
39662           type: string
39663         - name: nf-role
39664           in: query
39665           description: role in the network that this model will be providing
39666           required: false
39667           type: string
39668         - name: nf-naming-code
39669           in: query
39670           description: string assigned to this model used for naming purposes
39671           required: false
39672           type: string
39673         - name: interface-id
39674           in: query
39675           description: ID of interface
39676           required: false
39677           type: string
39678         - name: interface-role
39679           in: query
39680           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39681           required: false
39682           type: string
39683         - name: interface-id
39684           in: query
39685           description: ID of interface
39686           required: false
39687           type: string
39688         - name: macaddr
39689           in: query
39690           description: MAC address for the interface
39691           required: false
39692           type: string
39693         - name: network-name
39694           in: query
39695           description: Name of the network
39696           required: false
39697           type: string
39698         - name: vlan-id-inner
39699           in: query
39700           description: Inner VLAN tag
39701           required: false
39702           type: integer
39703           format: int64
39704         - name: neutron-network-id
39705           in: query
39706           description: Neutron network id of the interface that address belongs to
39707           required: false
39708           type: string
39709         - name: neutron-subnet-id
39710           in: query
39711           description: Neutron id of subnet that address belongs to
39712           required: false
39713           type: string
39714     put:
39715       tags:
39716         - Network
39717       summary: create or update an existing l3-interface-ipv6-address-list
39718       description: |
39719         Create or update an existing l3-interface-ipv6-address-list.
39720         #
39721         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39722       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39723       consumes:
39724         - application/json
39725         - application/xml
39726       produces:
39727         - application/json
39728         - application/xml
39729       responses:
39730         "default":
39731           description: Response codes found in [response codes](https://wiki.onap.org/).
39732       parameters:
39733         - name: vnf-id
39734           in: path
39735           description: Unique id of VNF.  This is unique across the graph.
39736           required: true
39737           type: string
39738           example: __VNF-ID__
39739         - name: interface-name
39740           in: path
39741           description: Name that identifies the link aggregate interface
39742           required: true
39743           type: string
39744           example: __INTERFACE-NAME__
39745         - name: interface-name
39746           in: path
39747           description: Name given to the interface
39748           required: true
39749           type: string
39750           example: __INTERFACE-NAME__
39751         - name: l3-interface-ipv6-address
39752           in: path
39753           description: IP address
39754           required: true
39755           type: string
39756           example: __L3-INTERFACE-IPV6-ADDRESS__
39757         - name: body
39758           in: body
39759           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39760           required: true
39761           schema:
39762             $ref: "#/definitions/l3-interface-ipv6-address-list"
39763     patch:
39764       tags:
39765         - Network
39766       summary: update an existing l3-interface-ipv6-address-list
39767       description: |
39768         Update an existing l3-interface-ipv6-address-list
39769         #
39770         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39771         The PUT operation will entirely replace an existing object.
39772         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39773         #
39774         Other differences between PUT and PATCH are:
39775         #
39776         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39777         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39778         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39779       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39780       consumes:
39781         - application/json
39782         - application/xml
39783       produces:
39784         - application/json
39785         - application/xml
39786       responses:
39787         "default":
39788           description: Response codes found in [response codes](https://wiki.onap.org/).
39789       parameters:
39790         - name: vnf-id
39791           in: path
39792           description: Unique id of VNF.  This is unique across the graph.
39793           required: true
39794           type: string
39795           example: __VNF-ID__
39796         - name: interface-name
39797           in: path
39798           description: Name that identifies the link aggregate interface
39799           required: true
39800           type: string
39801           example: __INTERFACE-NAME__
39802         - name: interface-name
39803           in: path
39804           description: Name given to the interface
39805           required: true
39806           type: string
39807           example: __INTERFACE-NAME__
39808         - name: l3-interface-ipv6-address
39809           in: path
39810           description: IP address
39811           required: true
39812           type: string
39813           example: __L3-INTERFACE-IPV6-ADDRESS__
39814         - name: body
39815           in: body
39816           description: l3-interface-ipv6-address-list object that needs to be created or updated.
39817           required: true
39818           schema:
39819             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39820     delete:
39821       tags:
39822         - Network
39823       summary: delete an existing l3-interface-ipv6-address-list
39824       description: delete an existing l3-interface-ipv6-address-list
39825       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39826       consumes:
39827         - application/json
39828         - application/xml
39829       produces:
39830         - application/json
39831         - application/xml
39832       responses:
39833         "default":
39834           description: Response codes found in [response codes](https://wiki.onap.org/).
39835       parameters:
39836         - name: vnf-id
39837           in: path
39838           description: Unique id of VNF.  This is unique across the graph.
39839           required: true
39840           type: string
39841           example: __VNF-ID__
39842         - name: interface-name
39843           in: path
39844           description: Name that identifies the link aggregate interface
39845           required: true
39846           type: string
39847           example: __INTERFACE-NAME__
39848         - name: interface-name
39849           in: path
39850           description: Name given to the interface
39851           required: true
39852           type: string
39853           example: __INTERFACE-NAME__
39854         - name: l3-interface-ipv6-address
39855           in: path
39856           description: IP address
39857           required: true
39858           type: string
39859           example: __L3-INTERFACE-IPV6-ADDRESS__
39860         - name: resource-version
39861           in: query
39862           description: resource-version for concurrency
39863           required: true
39864           type: string
39865   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39866     get:
39867       tags:
39868         - Network
39869       summary: returns l-interface
39870       description: returns l-interface
39871       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
39872       produces:
39873         - application/json
39874         - application/xml
39875       responses:
39876         "200":
39877           description: successful operation
39878           schema:
39879               $ref: "#/getDefinitions/l-interface"
39880         "default":
39881           description: Response codes found in [response codes](https://wiki.onap.org/).
39882       parameters:
39883         - name: vnf-id
39884           in: path
39885           description: Unique id of VNF.  This is unique across the graph.
39886           required: true
39887           type: string
39888           example: __VNF-ID__
39889         - name: interface-name
39890           in: path
39891           description: Name that identifies the link aggregate interface
39892           required: true
39893           type: string
39894           example: __INTERFACE-NAME__
39895         - name: interface-name
39896           in: path
39897           description: Name given to the interface
39898           required: true
39899           type: string
39900           example: __INTERFACE-NAME__
39901         - name: vnf-name
39902           in: query
39903           description: Name of VNF.
39904           required: false
39905           type: string
39906         - name: vnf-name2
39907           in: query
39908           description: Alternate name of VNF.
39909           required: false
39910           type: string
39911         - name: vnf-type
39912           in: query
39913           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.
39914           required: false
39915           type: string
39916         - name: service-id
39917           in: query
39918           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39919           required: false
39920           type: string
39921         - name: regional-resource-zone
39922           in: query
39923           description: Regional way of organizing pservers, source of truth should define values
39924           required: false
39925           type: string
39926         - name: prov-status
39927           in: query
39928           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39929           required: false
39930           type: string
39931         - name: heat-stack-id
39932           in: query
39933           description: Heat stack id corresponding to this instance, managed by MSO
39934           required: false
39935           type: string
39936         - name: in-maint
39937           in: query
39938           required: false
39939           type: boolean
39940         - name: is-closed-loop-disabled
39941           in: query
39942           required: false
39943           type: boolean
39944         - name: model-invariant-id
39945           in: query
39946           description: the ASDC model id for this resource or service model.
39947           required: false
39948           type: string
39949         - name: model-version-id
39950           in: query
39951           description: the ASDC model version for this resource or service model.
39952           required: false
39953           type: string
39954         - name: widget-model-id
39955           in: query
39956           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39957           required: false
39958           type: string
39959         - name: widget-model-version
39960           in: query
39961           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39962           required: false
39963           type: string
39964         - name: nf-type
39965           in: query
39966           description: Generic description of the type of NF
39967           required: false
39968           type: string
39969         - name: nf-function
39970           in: query
39971           description: English description of Network function that the specific VNF deployment is providing
39972           required: false
39973           type: string
39974         - name: nf-role
39975           in: query
39976           description: role in the network that this model will be providing
39977           required: false
39978           type: string
39979         - name: nf-naming-code
39980           in: query
39981           description: string assigned to this model used for naming purposes
39982           required: false
39983           type: string
39984         - name: interface-id
39985           in: query
39986           description: ID of interface
39987           required: false
39988           type: string
39989         - name: interface-role
39990           in: query
39991           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39992           required: false
39993           type: string
39994         - name: interface-id
39995           in: query
39996           description: ID of interface
39997           required: false
39998           type: string
39999         - name: macaddr
40000           in: query
40001           description: MAC address for the interface
40002           required: false
40003           type: string
40004         - name: network-name
40005           in: query
40006           description: Name of the network
40007           required: false
40008           type: string
40009     put:
40010       tags:
40011         - Network
40012       summary: create or update an existing l-interface
40013       description: |
40014         Create or update an existing l-interface.
40015         #
40016         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40017       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40018       consumes:
40019         - application/json
40020         - application/xml
40021       produces:
40022         - application/json
40023         - application/xml
40024       responses:
40025         "default":
40026           description: Response codes found in [response codes](https://wiki.onap.org/).
40027       parameters:
40028         - name: vnf-id
40029           in: path
40030           description: Unique id of VNF.  This is unique across the graph.
40031           required: true
40032           type: string
40033           example: __VNF-ID__
40034         - name: interface-name
40035           in: path
40036           description: Name that identifies the link aggregate interface
40037           required: true
40038           type: string
40039           example: __INTERFACE-NAME__
40040         - name: interface-name
40041           in: path
40042           description: Name given to the interface
40043           required: true
40044           type: string
40045           example: __INTERFACE-NAME__
40046         - name: body
40047           in: body
40048           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
40049           required: true
40050           schema:
40051             $ref: "#/definitions/l-interface"
40052     patch:
40053       tags:
40054         - Network
40055       summary: update an existing l-interface
40056       description: |
40057         Update an existing l-interface
40058         #
40059         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40060         The PUT operation will entirely replace an existing object.
40061         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40062         #
40063         Other differences between PUT and PATCH are:
40064         #
40065         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40066         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40067         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40068       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40069       consumes:
40070         - application/json
40071         - application/xml
40072       produces:
40073         - application/json
40074         - application/xml
40075       responses:
40076         "default":
40077           description: Response codes found in [response codes](https://wiki.onap.org/).
40078       parameters:
40079         - name: vnf-id
40080           in: path
40081           description: Unique id of VNF.  This is unique across the graph.
40082           required: true
40083           type: string
40084           example: __VNF-ID__
40085         - name: interface-name
40086           in: path
40087           description: Name that identifies the link aggregate interface
40088           required: true
40089           type: string
40090           example: __INTERFACE-NAME__
40091         - name: interface-name
40092           in: path
40093           description: Name given to the interface
40094           required: true
40095           type: string
40096           example: __INTERFACE-NAME__
40097         - name: body
40098           in: body
40099           description: l-interface object that needs to be created or updated.
40100           required: true
40101           schema:
40102             $ref: "#/patchDefinitions/l-interface"
40103     delete:
40104       tags:
40105         - Network
40106       summary: delete an existing l-interface
40107       description: delete an existing l-interface
40108       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40109       consumes:
40110         - application/json
40111         - application/xml
40112       produces:
40113         - application/json
40114         - application/xml
40115       responses:
40116         "default":
40117           description: Response codes found in [response codes](https://wiki.onap.org/).
40118       parameters:
40119         - name: vnf-id
40120           in: path
40121           description: Unique id of VNF.  This is unique across the graph.
40122           required: true
40123           type: string
40124           example: __VNF-ID__
40125         - name: interface-name
40126           in: path
40127           description: Name that identifies the link aggregate interface
40128           required: true
40129           type: string
40130           example: __INTERFACE-NAME__
40131         - name: interface-name
40132           in: path
40133           description: Name given to the interface
40134           required: true
40135           type: string
40136           example: __INTERFACE-NAME__
40137         - name: resource-version
40138           in: query
40139           description: resource-version for concurrency
40140           required: true
40141           type: string
40142   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
40143     get:
40144       tags:
40145         - Network
40146       summary: returns l-interfaces
40147       description: returns l-interfaces
40148       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
40149       produces:
40150         - application/json
40151         - application/xml
40152       responses:
40153         "200":
40154           description: successful operation
40155           schema:
40156               $ref: "#/getDefinitions/l-interfaces"
40157         "default":
40158           description: Response codes found in [response codes](https://wiki.onap.org/).
40159       parameters:
40160         - name: vnf-id
40161           in: path
40162           description: Unique id of VNF.  This is unique across the graph.
40163           required: true
40164           type: string
40165           example: __VNF-ID__
40166         - name: interface-name
40167           in: path
40168           description: Name that identifies the link aggregate interface
40169           required: true
40170           type: string
40171           example: __INTERFACE-NAME__
40172         - name: vnf-name
40173           in: query
40174           description: Name of VNF.
40175           required: false
40176           type: string
40177         - name: vnf-name2
40178           in: query
40179           description: Alternate name of VNF.
40180           required: false
40181           type: string
40182         - name: vnf-type
40183           in: query
40184           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.
40185           required: false
40186           type: string
40187         - name: service-id
40188           in: query
40189           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40190           required: false
40191           type: string
40192         - name: regional-resource-zone
40193           in: query
40194           description: Regional way of organizing pservers, source of truth should define values
40195           required: false
40196           type: string
40197         - name: prov-status
40198           in: query
40199           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40200           required: false
40201           type: string
40202         - name: heat-stack-id
40203           in: query
40204           description: Heat stack id corresponding to this instance, managed by MSO
40205           required: false
40206           type: string
40207         - name: in-maint
40208           in: query
40209           required: false
40210           type: boolean
40211         - name: is-closed-loop-disabled
40212           in: query
40213           required: false
40214           type: boolean
40215         - name: model-invariant-id
40216           in: query
40217           description: the ASDC model id for this resource or service model.
40218           required: false
40219           type: string
40220         - name: model-version-id
40221           in: query
40222           description: the ASDC model version for this resource or service model.
40223           required: false
40224           type: string
40225         - name: widget-model-id
40226           in: query
40227           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40228           required: false
40229           type: string
40230         - name: widget-model-version
40231           in: query
40232           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40233           required: false
40234           type: string
40235         - name: nf-type
40236           in: query
40237           description: Generic description of the type of NF
40238           required: false
40239           type: string
40240         - name: nf-function
40241           in: query
40242           description: English description of Network function that the specific VNF deployment is providing
40243           required: false
40244           type: string
40245         - name: nf-role
40246           in: query
40247           description: role in the network that this model will be providing
40248           required: false
40249           type: string
40250         - name: nf-naming-code
40251           in: query
40252           description: string assigned to this model used for naming purposes
40253           required: false
40254           type: string
40255         - name: interface-id
40256           in: query
40257           description: ID of interface
40258           required: false
40259           type: string
40260         - name: interface-role
40261           in: query
40262           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40263           required: false
40264           type: string
40265   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
40266     get:
40267       tags:
40268         - Network
40269       summary: returns lag-interface
40270       description: returns lag-interface
40271       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40272       produces:
40273         - application/json
40274         - application/xml
40275       responses:
40276         "200":
40277           description: successful operation
40278           schema:
40279               $ref: "#/getDefinitions/lag-interface"
40280         "default":
40281           description: Response codes found in [response codes](https://wiki.onap.org/).
40282       parameters:
40283         - name: vnf-id
40284           in: path
40285           description: Unique id of VNF.  This is unique across the graph.
40286           required: true
40287           type: string
40288           example: __VNF-ID__
40289         - name: interface-name
40290           in: path
40291           description: Name that identifies the link aggregate interface
40292           required: true
40293           type: string
40294           example: __INTERFACE-NAME__
40295         - name: vnf-name
40296           in: query
40297           description: Name of VNF.
40298           required: false
40299           type: string
40300         - name: vnf-name2
40301           in: query
40302           description: Alternate name of VNF.
40303           required: false
40304           type: string
40305         - name: vnf-type
40306           in: query
40307           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.
40308           required: false
40309           type: string
40310         - name: service-id
40311           in: query
40312           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40313           required: false
40314           type: string
40315         - name: regional-resource-zone
40316           in: query
40317           description: Regional way of organizing pservers, source of truth should define values
40318           required: false
40319           type: string
40320         - name: prov-status
40321           in: query
40322           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40323           required: false
40324           type: string
40325         - name: heat-stack-id
40326           in: query
40327           description: Heat stack id corresponding to this instance, managed by MSO
40328           required: false
40329           type: string
40330         - name: in-maint
40331           in: query
40332           required: false
40333           type: boolean
40334         - name: is-closed-loop-disabled
40335           in: query
40336           required: false
40337           type: boolean
40338         - name: model-invariant-id
40339           in: query
40340           description: the ASDC model id for this resource or service model.
40341           required: false
40342           type: string
40343         - name: model-version-id
40344           in: query
40345           description: the ASDC model version for this resource or service model.
40346           required: false
40347           type: string
40348         - name: widget-model-id
40349           in: query
40350           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40351           required: false
40352           type: string
40353         - name: widget-model-version
40354           in: query
40355           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40356           required: false
40357           type: string
40358         - name: nf-type
40359           in: query
40360           description: Generic description of the type of NF
40361           required: false
40362           type: string
40363         - name: nf-function
40364           in: query
40365           description: English description of Network function that the specific VNF deployment is providing
40366           required: false
40367           type: string
40368         - name: nf-role
40369           in: query
40370           description: role in the network that this model will be providing
40371           required: false
40372           type: string
40373         - name: nf-naming-code
40374           in: query
40375           description: string assigned to this model used for naming purposes
40376           required: false
40377           type: string
40378         - name: interface-id
40379           in: query
40380           description: ID of interface
40381           required: false
40382           type: string
40383         - name: interface-role
40384           in: query
40385           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40386           required: false
40387           type: string
40388     put:
40389       tags:
40390         - Network
40391       summary: create or update an existing lag-interface
40392       description: |
40393         Create or update an existing lag-interface.
40394         #
40395         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40396       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40397       consumes:
40398         - application/json
40399         - application/xml
40400       produces:
40401         - application/json
40402         - application/xml
40403       responses:
40404         "default":
40405           description: Response codes found in [response codes](https://wiki.onap.org/).
40406       parameters:
40407         - name: vnf-id
40408           in: path
40409           description: Unique id of VNF.  This is unique across the graph.
40410           required: true
40411           type: string
40412           example: __VNF-ID__
40413         - name: interface-name
40414           in: path
40415           description: Name that identifies the link aggregate interface
40416           required: true
40417           type: string
40418           example: __INTERFACE-NAME__
40419         - name: body
40420           in: body
40421           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
40422           required: true
40423           schema:
40424             $ref: "#/definitions/lag-interface"
40425     patch:
40426       tags:
40427         - Network
40428       summary: update an existing lag-interface
40429       description: |
40430         Update an existing lag-interface
40431         #
40432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40433         The PUT operation will entirely replace an existing object.
40434         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40435         #
40436         Other differences between PUT and PATCH are:
40437         #
40438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40441       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40442       consumes:
40443         - application/json
40444         - application/xml
40445       produces:
40446         - application/json
40447         - application/xml
40448       responses:
40449         "default":
40450           description: Response codes found in [response codes](https://wiki.onap.org/).
40451       parameters:
40452         - name: vnf-id
40453           in: path
40454           description: Unique id of VNF.  This is unique across the graph.
40455           required: true
40456           type: string
40457           example: __VNF-ID__
40458         - name: interface-name
40459           in: path
40460           description: Name that identifies the link aggregate interface
40461           required: true
40462           type: string
40463           example: __INTERFACE-NAME__
40464         - name: body
40465           in: body
40466           description: lag-interface object that needs to be created or updated.
40467           required: true
40468           schema:
40469             $ref: "#/patchDefinitions/lag-interface"
40470     delete:
40471       tags:
40472         - Network
40473       summary: delete an existing lag-interface
40474       description: delete an existing lag-interface
40475       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40476       consumes:
40477         - application/json
40478         - application/xml
40479       produces:
40480         - application/json
40481         - application/xml
40482       responses:
40483         "default":
40484           description: Response codes found in [response codes](https://wiki.onap.org/).
40485       parameters:
40486         - name: vnf-id
40487           in: path
40488           description: Unique id of VNF.  This is unique across the graph.
40489           required: true
40490           type: string
40491           example: __VNF-ID__
40492         - name: interface-name
40493           in: path
40494           description: Name that identifies the link aggregate interface
40495           required: true
40496           type: string
40497           example: __INTERFACE-NAME__
40498         - name: resource-version
40499           in: query
40500           description: resource-version for concurrency
40501           required: true
40502           type: string
40503   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
40504     get:
40505       tags:
40506         - Network
40507       summary: returns lag-interfaces
40508       description: returns lag-interfaces
40509       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
40510       produces:
40511         - application/json
40512         - application/xml
40513       responses:
40514         "200":
40515           description: successful operation
40516           schema:
40517               $ref: "#/getDefinitions/lag-interfaces"
40518         "default":
40519           description: Response codes found in [response codes](https://wiki.onap.org/).
40520       parameters:
40521         - name: vnf-id
40522           in: path
40523           description: Unique id of VNF.  This is unique across the graph.
40524           required: true
40525           type: string
40526           example: __VNF-ID__
40527         - name: vnf-name
40528           in: query
40529           description: Name of VNF.
40530           required: false
40531           type: string
40532         - name: vnf-name2
40533           in: query
40534           description: Alternate name of VNF.
40535           required: false
40536           type: string
40537         - name: vnf-type
40538           in: query
40539           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.
40540           required: false
40541           type: string
40542         - name: service-id
40543           in: query
40544           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40545           required: false
40546           type: string
40547         - name: regional-resource-zone
40548           in: query
40549           description: Regional way of organizing pservers, source of truth should define values
40550           required: false
40551           type: string
40552         - name: prov-status
40553           in: query
40554           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40555           required: false
40556           type: string
40557         - name: heat-stack-id
40558           in: query
40559           description: Heat stack id corresponding to this instance, managed by MSO
40560           required: false
40561           type: string
40562         - name: in-maint
40563           in: query
40564           required: false
40565           type: boolean
40566         - name: is-closed-loop-disabled
40567           in: query
40568           required: false
40569           type: boolean
40570         - name: model-invariant-id
40571           in: query
40572           description: the ASDC model id for this resource or service model.
40573           required: false
40574           type: string
40575         - name: model-version-id
40576           in: query
40577           description: the ASDC model version for this resource or service model.
40578           required: false
40579           type: string
40580         - name: widget-model-id
40581           in: query
40582           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40583           required: false
40584           type: string
40585         - name: widget-model-version
40586           in: query
40587           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40588           required: false
40589           type: string
40590         - name: nf-type
40591           in: query
40592           description: Generic description of the type of NF
40593           required: false
40594           type: string
40595         - name: nf-function
40596           in: query
40597           description: English description of Network function that the specific VNF deployment is providing
40598           required: false
40599           type: string
40600         - name: nf-role
40601           in: query
40602           description: role in the network that this model will be providing
40603           required: false
40604           type: string
40605         - name: nf-naming-code
40606           in: query
40607           description: string assigned to this model used for naming purposes
40608           required: false
40609           type: string
40610   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
40611     put:
40612       tags:
40613         - Network
40614       summary: see node definition for valid relationships
40615       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40616       consumes:
40617         - application/json
40618         - application/xml
40619       produces:
40620         - application/json
40621         - application/xml
40622       responses:
40623         "default":
40624           description: Response codes found in [response codes](https://wiki.onap.org/).
40625       parameters:
40626         - name: vnf-id
40627           in: path
40628           description: Unique id of VNF.  This is unique across the graph.
40629           required: true
40630           type: string
40631           example: __VNF-ID__
40632         - name: vf-module-id
40633           in: path
40634           description: Unique ID of vf-module.
40635           required: true
40636           type: string
40637           example: __VF-MODULE-ID__
40638         - name: body
40639           in: body
40640           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40641           required: true
40642           schema:
40643             $ref: "#/definitions/relationship"
40644     delete:
40645       tags:
40646         - Network
40647       summary: delete an existing relationship
40648       description: delete an existing relationship
40649       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40650       consumes:
40651         - application/json
40652         - application/xml
40653       produces:
40654         - application/json
40655         - application/xml
40656       responses:
40657         "default":
40658           description: Response codes found in [response codes](https://wiki.onap.org/).
40659       parameters:
40660         - name: vnf-id
40661           in: path
40662           description: Unique id of VNF.  This is unique across the graph.
40663           required: true
40664           type: string
40665           example: __VNF-ID__
40666         - name: vf-module-id
40667           in: path
40668           description: Unique ID of vf-module.
40669           required: true
40670           type: string
40671           example: __VF-MODULE-ID__
40672   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
40673     get:
40674       tags:
40675         - Network
40676       summary: returns vf-module
40677       description: returns vf-module
40678       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
40679       produces:
40680         - application/json
40681         - application/xml
40682       responses:
40683         "200":
40684           description: successful operation
40685           schema:
40686               $ref: "#/getDefinitions/vf-module"
40687         "default":
40688           description: Response codes found in [response codes](https://wiki.onap.org/).
40689       parameters:
40690         - name: vnf-id
40691           in: path
40692           description: Unique id of VNF.  This is unique across the graph.
40693           required: true
40694           type: string
40695           example: __VNF-ID__
40696         - name: vf-module-id
40697           in: path
40698           description: Unique ID of vf-module.
40699           required: true
40700           type: string
40701           example: __VF-MODULE-ID__
40702         - name: vnf-name
40703           in: query
40704           description: Name of VNF.
40705           required: false
40706           type: string
40707         - name: vnf-name2
40708           in: query
40709           description: Alternate name of VNF.
40710           required: false
40711           type: string
40712         - name: vnf-type
40713           in: query
40714           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.
40715           required: false
40716           type: string
40717         - name: service-id
40718           in: query
40719           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40720           required: false
40721           type: string
40722         - name: regional-resource-zone
40723           in: query
40724           description: Regional way of organizing pservers, source of truth should define values
40725           required: false
40726           type: string
40727         - name: prov-status
40728           in: query
40729           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40730           required: false
40731           type: string
40732         - name: heat-stack-id
40733           in: query
40734           description: Heat stack id corresponding to this instance, managed by MSO
40735           required: false
40736           type: string
40737         - name: in-maint
40738           in: query
40739           required: false
40740           type: boolean
40741         - name: is-closed-loop-disabled
40742           in: query
40743           required: false
40744           type: boolean
40745         - name: model-invariant-id
40746           in: query
40747           description: the ASDC model id for this resource or service model.
40748           required: false
40749           type: string
40750         - name: model-version-id
40751           in: query
40752           description: the ASDC model version for this resource or service model.
40753           required: false
40754           type: string
40755         - name: widget-model-id
40756           in: query
40757           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40758           required: false
40759           type: string
40760         - name: widget-model-version
40761           in: query
40762           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40763           required: false
40764           type: string
40765         - name: nf-type
40766           in: query
40767           description: Generic description of the type of NF
40768           required: false
40769           type: string
40770         - name: nf-function
40771           in: query
40772           description: English description of Network function that the specific VNF deployment is providing
40773           required: false
40774           type: string
40775         - name: nf-role
40776           in: query
40777           description: role in the network that this model will be providing
40778           required: false
40779           type: string
40780         - name: nf-naming-code
40781           in: query
40782           description: string assigned to this model used for naming purposes
40783           required: false
40784           type: string
40785         - name: vf-module-name
40786           in: query
40787           description: Name of vf-module
40788           required: false
40789           type: string
40790         - name: heat-stack-id
40791           in: query
40792           description: Heat stack id corresponding to this instance.
40793           required: false
40794           type: string
40795         - name: model-invariant-id
40796           in: query
40797           description: the ASDC model id for this resource or service model.
40798           required: false
40799           type: string
40800         - name: model-version-id
40801           in: query
40802           description: the ASDC model version for this resource or service model.
40803           required: false
40804           type: string
40805         - name: widget-model-id
40806           in: query
40807           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40808           required: false
40809           type: string
40810         - name: widget-model-version
40811           in: query
40812           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40813           required: false
40814           type: string
40815         - name: contrail-service-instance-fqdn
40816           in: query
40817           description: the Contrail unique ID for a service-instance
40818           required: false
40819           type: string
40820     put:
40821       tags:
40822         - Network
40823       summary: create or update an existing vf-module
40824       description: |
40825         Create or update an existing vf-module.
40826         #
40827         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40828       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40829       consumes:
40830         - application/json
40831         - application/xml
40832       produces:
40833         - application/json
40834         - application/xml
40835       responses:
40836         "default":
40837           description: Response codes found in [response codes](https://wiki.onap.org/).
40838       parameters:
40839         - name: vnf-id
40840           in: path
40841           description: Unique id of VNF.  This is unique across the graph.
40842           required: true
40843           type: string
40844           example: __VNF-ID__
40845         - name: vf-module-id
40846           in: path
40847           description: Unique ID of vf-module.
40848           required: true
40849           type: string
40850           example: __VF-MODULE-ID__
40851         - name: body
40852           in: body
40853           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40854           required: true
40855           schema:
40856             $ref: "#/definitions/vf-module"
40857     patch:
40858       tags:
40859         - Network
40860       summary: update an existing vf-module
40861       description: |
40862         Update an existing vf-module
40863         #
40864         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40865         The PUT operation will entirely replace an existing object.
40866         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40867         #
40868         Other differences between PUT and PATCH are:
40869         #
40870         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40871         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40872         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40873       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40874       consumes:
40875         - application/json
40876         - application/xml
40877       produces:
40878         - application/json
40879         - application/xml
40880       responses:
40881         "default":
40882           description: Response codes found in [response codes](https://wiki.onap.org/).
40883       parameters:
40884         - name: vnf-id
40885           in: path
40886           description: Unique id of VNF.  This is unique across the graph.
40887           required: true
40888           type: string
40889           example: __VNF-ID__
40890         - name: vf-module-id
40891           in: path
40892           description: Unique ID of vf-module.
40893           required: true
40894           type: string
40895           example: __VF-MODULE-ID__
40896         - name: body
40897           in: body
40898           description: vf-module object that needs to be created or updated.
40899           required: true
40900           schema:
40901             $ref: "#/patchDefinitions/vf-module"
40902     delete:
40903       tags:
40904         - Network
40905       summary: delete an existing vf-module
40906       description: delete an existing vf-module
40907       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
40908       consumes:
40909         - application/json
40910         - application/xml
40911       produces:
40912         - application/json
40913         - application/xml
40914       responses:
40915         "default":
40916           description: Response codes found in [response codes](https://wiki.onap.org/).
40917       parameters:
40918         - name: vnf-id
40919           in: path
40920           description: Unique id of VNF.  This is unique across the graph.
40921           required: true
40922           type: string
40923           example: __VNF-ID__
40924         - name: vf-module-id
40925           in: path
40926           description: Unique ID of vf-module.
40927           required: true
40928           type: string
40929           example: __VF-MODULE-ID__
40930         - name: resource-version
40931           in: query
40932           description: resource-version for concurrency
40933           required: true
40934           type: string
40935   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
40936     get:
40937       tags:
40938         - Network
40939       summary: returns vf-modules
40940       description: returns vf-modules
40941       operationId: getNetworkGenericVnfsGenericVnfVfModules
40942       produces:
40943         - application/json
40944         - application/xml
40945       responses:
40946         "200":
40947           description: successful operation
40948           schema:
40949               $ref: "#/getDefinitions/vf-modules"
40950         "default":
40951           description: Response codes found in [response codes](https://wiki.onap.org/).
40952       parameters:
40953         - name: vnf-id
40954           in: path
40955           description: Unique id of VNF.  This is unique across the graph.
40956           required: true
40957           type: string
40958           example: __VNF-ID__
40959         - name: vnf-name
40960           in: query
40961           description: Name of VNF.
40962           required: false
40963           type: string
40964         - name: vnf-name2
40965           in: query
40966           description: Alternate name of VNF.
40967           required: false
40968           type: string
40969         - name: vnf-type
40970           in: query
40971           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.
40972           required: false
40973           type: string
40974         - name: service-id
40975           in: query
40976           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40977           required: false
40978           type: string
40979         - name: regional-resource-zone
40980           in: query
40981           description: Regional way of organizing pservers, source of truth should define values
40982           required: false
40983           type: string
40984         - name: prov-status
40985           in: query
40986           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40987           required: false
40988           type: string
40989         - name: heat-stack-id
40990           in: query
40991           description: Heat stack id corresponding to this instance, managed by MSO
40992           required: false
40993           type: string
40994         - name: in-maint
40995           in: query
40996           required: false
40997           type: boolean
40998         - name: is-closed-loop-disabled
40999           in: query
41000           required: false
41001           type: boolean
41002         - name: model-invariant-id
41003           in: query
41004           description: the ASDC model id for this resource or service model.
41005           required: false
41006           type: string
41007         - name: model-version-id
41008           in: query
41009           description: the ASDC model version for this resource or service model.
41010           required: false
41011           type: string
41012         - name: widget-model-id
41013           in: query
41014           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41015           required: false
41016           type: string
41017         - name: widget-model-version
41018           in: query
41019           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41020           required: false
41021           type: string
41022         - name: nf-type
41023           in: query
41024           description: Generic description of the type of NF
41025           required: false
41026           type: string
41027         - name: nf-function
41028           in: query
41029           description: English description of Network function that the specific VNF deployment is providing
41030           required: false
41031           type: string
41032         - name: nf-role
41033           in: query
41034           description: role in the network that this model will be providing
41035           required: false
41036           type: string
41037         - name: nf-naming-code
41038           in: query
41039           description: string assigned to this model used for naming purposes
41040           required: false
41041           type: string
41042   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41043     put:
41044       tags:
41045         - Network
41046       summary: see node definition for valid relationships
41047       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41048       consumes:
41049         - application/json
41050         - application/xml
41051       produces:
41052         - application/json
41053         - application/xml
41054       responses:
41055         "default":
41056           description: Response codes found in [response codes](https://wiki.onap.org/).
41057       parameters:
41058         - name: vnf-id
41059           in: path
41060           description: Unique id of VNF.  This is unique across the graph.
41061           required: true
41062           type: string
41063           example: __VNF-ID__
41064         - name: group-uuid
41065           in: path
41066           description: Unique ID for the license group the resource belongs to, should be uuid.
41067           required: true
41068           type: string
41069           example: __GROUP-UUID__
41070         - name: resource-uuid
41071           in: path
41072           description: Unique ID of a license resource.
41073           required: true
41074           type: string
41075           example: __RESOURCE-UUID__
41076         - name: body
41077           in: body
41078           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41079           required: true
41080           schema:
41081             $ref: "#/definitions/relationship"
41082     delete:
41083       tags:
41084         - Network
41085       summary: delete an existing relationship
41086       description: delete an existing relationship
41087       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41088       consumes:
41089         - application/json
41090         - application/xml
41091       produces:
41092         - application/json
41093         - application/xml
41094       responses:
41095         "default":
41096           description: Response codes found in [response codes](https://wiki.onap.org/).
41097       parameters:
41098         - name: vnf-id
41099           in: path
41100           description: Unique id of VNF.  This is unique across the graph.
41101           required: true
41102           type: string
41103           example: __VNF-ID__
41104         - name: group-uuid
41105           in: path
41106           description: Unique ID for the license group the resource belongs to, should be uuid.
41107           required: true
41108           type: string
41109           example: __GROUP-UUID__
41110         - name: resource-uuid
41111           in: path
41112           description: Unique ID of a license resource.
41113           required: true
41114           type: string
41115           example: __RESOURCE-UUID__
41116   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
41117     get:
41118       tags:
41119         - Network
41120       summary: returns license
41121       description: returns license
41122       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
41123       produces:
41124         - application/json
41125         - application/xml
41126       responses:
41127         "200":
41128           description: successful operation
41129           schema:
41130               $ref: "#/getDefinitions/license"
41131         "default":
41132           description: Response codes found in [response codes](https://wiki.onap.org/).
41133       parameters:
41134         - name: vnf-id
41135           in: path
41136           description: Unique id of VNF.  This is unique across the graph.
41137           required: true
41138           type: string
41139           example: __VNF-ID__
41140         - name: group-uuid
41141           in: path
41142           description: Unique ID for the license group the resource belongs to, should be uuid.
41143           required: true
41144           type: string
41145           example: __GROUP-UUID__
41146         - name: resource-uuid
41147           in: path
41148           description: Unique ID of a license resource.
41149           required: true
41150           type: string
41151           example: __RESOURCE-UUID__
41152         - name: vnf-name
41153           in: query
41154           description: Name of VNF.
41155           required: false
41156           type: string
41157         - name: vnf-name2
41158           in: query
41159           description: Alternate name of VNF.
41160           required: false
41161           type: string
41162         - name: vnf-type
41163           in: query
41164           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.
41165           required: false
41166           type: string
41167         - name: service-id
41168           in: query
41169           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41170           required: false
41171           type: string
41172         - name: regional-resource-zone
41173           in: query
41174           description: Regional way of organizing pservers, source of truth should define values
41175           required: false
41176           type: string
41177         - name: prov-status
41178           in: query
41179           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41180           required: false
41181           type: string
41182         - name: heat-stack-id
41183           in: query
41184           description: Heat stack id corresponding to this instance, managed by MSO
41185           required: false
41186           type: string
41187         - name: in-maint
41188           in: query
41189           required: false
41190           type: boolean
41191         - name: is-closed-loop-disabled
41192           in: query
41193           required: false
41194           type: boolean
41195         - name: model-invariant-id
41196           in: query
41197           description: the ASDC model id for this resource or service model.
41198           required: false
41199           type: string
41200         - name: model-version-id
41201           in: query
41202           description: the ASDC model version for this resource or service model.
41203           required: false
41204           type: string
41205         - name: widget-model-id
41206           in: query
41207           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41208           required: false
41209           type: string
41210         - name: widget-model-version
41211           in: query
41212           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41213           required: false
41214           type: string
41215         - name: nf-type
41216           in: query
41217           description: Generic description of the type of NF
41218           required: false
41219           type: string
41220         - name: nf-function
41221           in: query
41222           description: English description of Network function that the specific VNF deployment is providing
41223           required: false
41224           type: string
41225         - name: nf-role
41226           in: query
41227           description: role in the network that this model will be providing
41228           required: false
41229           type: string
41230         - name: nf-naming-code
41231           in: query
41232           description: string assigned to this model used for naming purposes
41233           required: false
41234           type: string
41235     put:
41236       tags:
41237         - Network
41238       summary: create or update an existing license
41239       description: |
41240         Create or update an existing license.
41241         #
41242         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41243       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
41244       consumes:
41245         - application/json
41246         - application/xml
41247       produces:
41248         - application/json
41249         - application/xml
41250       responses:
41251         "default":
41252           description: Response codes found in [response codes](https://wiki.onap.org/).
41253       parameters:
41254         - name: vnf-id
41255           in: path
41256           description: Unique id of VNF.  This is unique across the graph.
41257           required: true
41258           type: string
41259           example: __VNF-ID__
41260         - name: group-uuid
41261           in: path
41262           description: Unique ID for the license group the resource belongs to, should be uuid.
41263           required: true
41264           type: string
41265           example: __GROUP-UUID__
41266         - name: resource-uuid
41267           in: path
41268           description: Unique ID of a license resource.
41269           required: true
41270           type: string
41271           example: __RESOURCE-UUID__
41272         - name: body
41273           in: body
41274           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41275           required: true
41276           schema:
41277             $ref: "#/definitions/license"
41278     patch:
41279       tags:
41280         - Network
41281       summary: update an existing license
41282       description: |
41283         Update an existing license
41284         #
41285         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41286         The PUT operation will entirely replace an existing object.
41287         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41288         #
41289         Other differences between PUT and PATCH are:
41290         #
41291         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41292         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41293         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41294       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
41295       consumes:
41296         - application/json
41297         - application/xml
41298       produces:
41299         - application/json
41300         - application/xml
41301       responses:
41302         "default":
41303           description: Response codes found in [response codes](https://wiki.onap.org/).
41304       parameters:
41305         - name: vnf-id
41306           in: path
41307           description: Unique id of VNF.  This is unique across the graph.
41308           required: true
41309           type: string
41310           example: __VNF-ID__
41311         - name: group-uuid
41312           in: path
41313           description: Unique ID for the license group the resource belongs to, should be uuid.
41314           required: true
41315           type: string
41316           example: __GROUP-UUID__
41317         - name: resource-uuid
41318           in: path
41319           description: Unique ID of a license resource.
41320           required: true
41321           type: string
41322           example: __RESOURCE-UUID__
41323         - name: body
41324           in: body
41325           description: license object that needs to be created or updated.
41326           required: true
41327           schema:
41328             $ref: "#/patchDefinitions/license"
41329     delete:
41330       tags:
41331         - Network
41332       summary: delete an existing license
41333       description: delete an existing license
41334       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
41335       consumes:
41336         - application/json
41337         - application/xml
41338       produces:
41339         - application/json
41340         - application/xml
41341       responses:
41342         "default":
41343           description: Response codes found in [response codes](https://wiki.onap.org/).
41344       parameters:
41345         - name: vnf-id
41346           in: path
41347           description: Unique id of VNF.  This is unique across the graph.
41348           required: true
41349           type: string
41350           example: __VNF-ID__
41351         - name: group-uuid
41352           in: path
41353           description: Unique ID for the license group the resource belongs to, should be uuid.
41354           required: true
41355           type: string
41356           example: __GROUP-UUID__
41357         - name: resource-uuid
41358           in: path
41359           description: Unique ID of a license resource.
41360           required: true
41361           type: string
41362           example: __RESOURCE-UUID__
41363         - name: resource-version
41364           in: query
41365           description: resource-version for concurrency
41366           required: true
41367           type: string
41368   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
41369     get:
41370       tags:
41371         - Network
41372       summary: returns licenses
41373       description: returns licenses
41374       operationId: getNetworkGenericVnfsGenericVnfLicenses
41375       produces:
41376         - application/json
41377         - application/xml
41378       responses:
41379         "200":
41380           description: successful operation
41381           schema:
41382               $ref: "#/getDefinitions/licenses"
41383         "default":
41384           description: Response codes found in [response codes](https://wiki.onap.org/).
41385       parameters:
41386         - name: vnf-id
41387           in: path
41388           description: Unique id of VNF.  This is unique across the graph.
41389           required: true
41390           type: string
41391           example: __VNF-ID__
41392         - name: vnf-name
41393           in: query
41394           description: Name of VNF.
41395           required: false
41396           type: string
41397         - name: vnf-name2
41398           in: query
41399           description: Alternate name of VNF.
41400           required: false
41401           type: string
41402         - name: vnf-type
41403           in: query
41404           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.
41405           required: false
41406           type: string
41407         - name: service-id
41408           in: query
41409           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41410           required: false
41411           type: string
41412         - name: regional-resource-zone
41413           in: query
41414           description: Regional way of organizing pservers, source of truth should define values
41415           required: false
41416           type: string
41417         - name: prov-status
41418           in: query
41419           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41420           required: false
41421           type: string
41422         - name: heat-stack-id
41423           in: query
41424           description: Heat stack id corresponding to this instance, managed by MSO
41425           required: false
41426           type: string
41427         - name: in-maint
41428           in: query
41429           required: false
41430           type: boolean
41431         - name: is-closed-loop-disabled
41432           in: query
41433           required: false
41434           type: boolean
41435         - name: model-invariant-id
41436           in: query
41437           description: the ASDC model id for this resource or service model.
41438           required: false
41439           type: string
41440         - name: model-version-id
41441           in: query
41442           description: the ASDC model version for this resource or service model.
41443           required: false
41444           type: string
41445         - name: widget-model-id
41446           in: query
41447           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41448           required: false
41449           type: string
41450         - name: widget-model-version
41451           in: query
41452           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41453           required: false
41454           type: string
41455         - name: nf-type
41456           in: query
41457           description: Generic description of the type of NF
41458           required: false
41459           type: string
41460         - name: nf-function
41461           in: query
41462           description: English description of Network function that the specific VNF deployment is providing
41463           required: false
41464           type: string
41465         - name: nf-role
41466           in: query
41467           description: role in the network that this model will be providing
41468           required: false
41469           type: string
41470         - name: nf-naming-code
41471           in: query
41472           description: string assigned to this model used for naming purposes
41473           required: false
41474           type: string
41475   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41476     put:
41477       tags:
41478         - Network
41479       summary: see node definition for valid relationships
41480       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41481       consumes:
41482         - application/json
41483         - application/xml
41484       produces:
41485         - application/json
41486         - application/xml
41487       responses:
41488         "default":
41489           description: Response codes found in [response codes](https://wiki.onap.org/).
41490       parameters:
41491         - name: vnf-id
41492           in: path
41493           description: Unique id of VNF.  This is unique across the graph.
41494           required: true
41495           type: string
41496           example: __VNF-ID__
41497         - name: group-uuid
41498           in: path
41499           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41500           required: true
41501           type: string
41502           example: __GROUP-UUID__
41503         - name: resource-uuid
41504           in: path
41505           description: Unique ID of an entitlement resource.
41506           required: true
41507           type: string
41508           example: __RESOURCE-UUID__
41509         - name: body
41510           in: body
41511           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41512           required: true
41513           schema:
41514             $ref: "#/definitions/relationship"
41515     delete:
41516       tags:
41517         - Network
41518       summary: delete an existing relationship
41519       description: delete an existing relationship
41520       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41521       consumes:
41522         - application/json
41523         - application/xml
41524       produces:
41525         - application/json
41526         - application/xml
41527       responses:
41528         "default":
41529           description: Response codes found in [response codes](https://wiki.onap.org/).
41530       parameters:
41531         - name: vnf-id
41532           in: path
41533           description: Unique id of VNF.  This is unique across the graph.
41534           required: true
41535           type: string
41536           example: __VNF-ID__
41537         - name: group-uuid
41538           in: path
41539           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41540           required: true
41541           type: string
41542           example: __GROUP-UUID__
41543         - name: resource-uuid
41544           in: path
41545           description: Unique ID of an entitlement resource.
41546           required: true
41547           type: string
41548           example: __RESOURCE-UUID__
41549   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
41550     get:
41551       tags:
41552         - Network
41553       summary: returns entitlement
41554       description: returns entitlement
41555       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41556       produces:
41557         - application/json
41558         - application/xml
41559       responses:
41560         "200":
41561           description: successful operation
41562           schema:
41563               $ref: "#/getDefinitions/entitlement"
41564         "default":
41565           description: Response codes found in [response codes](https://wiki.onap.org/).
41566       parameters:
41567         - name: vnf-id
41568           in: path
41569           description: Unique id of VNF.  This is unique across the graph.
41570           required: true
41571           type: string
41572           example: __VNF-ID__
41573         - name: group-uuid
41574           in: path
41575           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41576           required: true
41577           type: string
41578           example: __GROUP-UUID__
41579         - name: resource-uuid
41580           in: path
41581           description: Unique ID of an entitlement resource.
41582           required: true
41583           type: string
41584           example: __RESOURCE-UUID__
41585         - name: vnf-name
41586           in: query
41587           description: Name of VNF.
41588           required: false
41589           type: string
41590         - name: vnf-name2
41591           in: query
41592           description: Alternate name of VNF.
41593           required: false
41594           type: string
41595         - name: vnf-type
41596           in: query
41597           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.
41598           required: false
41599           type: string
41600         - name: service-id
41601           in: query
41602           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41603           required: false
41604           type: string
41605         - name: regional-resource-zone
41606           in: query
41607           description: Regional way of organizing pservers, source of truth should define values
41608           required: false
41609           type: string
41610         - name: prov-status
41611           in: query
41612           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41613           required: false
41614           type: string
41615         - name: heat-stack-id
41616           in: query
41617           description: Heat stack id corresponding to this instance, managed by MSO
41618           required: false
41619           type: string
41620         - name: in-maint
41621           in: query
41622           required: false
41623           type: boolean
41624         - name: is-closed-loop-disabled
41625           in: query
41626           required: false
41627           type: boolean
41628         - name: model-invariant-id
41629           in: query
41630           description: the ASDC model id for this resource or service model.
41631           required: false
41632           type: string
41633         - name: model-version-id
41634           in: query
41635           description: the ASDC model version for this resource or service model.
41636           required: false
41637           type: string
41638         - name: widget-model-id
41639           in: query
41640           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41641           required: false
41642           type: string
41643         - name: widget-model-version
41644           in: query
41645           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41646           required: false
41647           type: string
41648         - name: nf-type
41649           in: query
41650           description: Generic description of the type of NF
41651           required: false
41652           type: string
41653         - name: nf-function
41654           in: query
41655           description: English description of Network function that the specific VNF deployment is providing
41656           required: false
41657           type: string
41658         - name: nf-role
41659           in: query
41660           description: role in the network that this model will be providing
41661           required: false
41662           type: string
41663         - name: nf-naming-code
41664           in: query
41665           description: string assigned to this model used for naming purposes
41666           required: false
41667           type: string
41668     put:
41669       tags:
41670         - Network
41671       summary: create or update an existing entitlement
41672       description: |
41673         Create or update an existing entitlement.
41674         #
41675         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41676       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41677       consumes:
41678         - application/json
41679         - application/xml
41680       produces:
41681         - application/json
41682         - application/xml
41683       responses:
41684         "default":
41685           description: Response codes found in [response codes](https://wiki.onap.org/).
41686       parameters:
41687         - name: vnf-id
41688           in: path
41689           description: Unique id of VNF.  This is unique across the graph.
41690           required: true
41691           type: string
41692           example: __VNF-ID__
41693         - name: group-uuid
41694           in: path
41695           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41696           required: true
41697           type: string
41698           example: __GROUP-UUID__
41699         - name: resource-uuid
41700           in: path
41701           description: Unique ID of an entitlement resource.
41702           required: true
41703           type: string
41704           example: __RESOURCE-UUID__
41705         - name: body
41706           in: body
41707           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41708           required: true
41709           schema:
41710             $ref: "#/definitions/entitlement"
41711     patch:
41712       tags:
41713         - Network
41714       summary: update an existing entitlement
41715       description: |
41716         Update an existing entitlement
41717         #
41718         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41719         The PUT operation will entirely replace an existing object.
41720         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41721         #
41722         Other differences between PUT and PATCH are:
41723         #
41724         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41725         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41726         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41727       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41728       consumes:
41729         - application/json
41730         - application/xml
41731       produces:
41732         - application/json
41733         - application/xml
41734       responses:
41735         "default":
41736           description: Response codes found in [response codes](https://wiki.onap.org/).
41737       parameters:
41738         - name: vnf-id
41739           in: path
41740           description: Unique id of VNF.  This is unique across the graph.
41741           required: true
41742           type: string
41743           example: __VNF-ID__
41744         - name: group-uuid
41745           in: path
41746           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41747           required: true
41748           type: string
41749           example: __GROUP-UUID__
41750         - name: resource-uuid
41751           in: path
41752           description: Unique ID of an entitlement resource.
41753           required: true
41754           type: string
41755           example: __RESOURCE-UUID__
41756         - name: body
41757           in: body
41758           description: entitlement object that needs to be created or updated.
41759           required: true
41760           schema:
41761             $ref: "#/patchDefinitions/entitlement"
41762     delete:
41763       tags:
41764         - Network
41765       summary: delete an existing entitlement
41766       description: delete an existing entitlement
41767       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41768       consumes:
41769         - application/json
41770         - application/xml
41771       produces:
41772         - application/json
41773         - application/xml
41774       responses:
41775         "default":
41776           description: Response codes found in [response codes](https://wiki.onap.org/).
41777       parameters:
41778         - name: vnf-id
41779           in: path
41780           description: Unique id of VNF.  This is unique across the graph.
41781           required: true
41782           type: string
41783           example: __VNF-ID__
41784         - name: group-uuid
41785           in: path
41786           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41787           required: true
41788           type: string
41789           example: __GROUP-UUID__
41790         - name: resource-uuid
41791           in: path
41792           description: Unique ID of an entitlement resource.
41793           required: true
41794           type: string
41795           example: __RESOURCE-UUID__
41796         - name: resource-version
41797           in: query
41798           description: resource-version for concurrency
41799           required: true
41800           type: string
41801   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
41802     get:
41803       tags:
41804         - Network
41805       summary: returns entitlements
41806       description: returns entitlements
41807       operationId: getNetworkGenericVnfsGenericVnfEntitlements
41808       produces:
41809         - application/json
41810         - application/xml
41811       responses:
41812         "200":
41813           description: successful operation
41814           schema:
41815               $ref: "#/getDefinitions/entitlements"
41816         "default":
41817           description: Response codes found in [response codes](https://wiki.onap.org/).
41818       parameters:
41819         - name: vnf-id
41820           in: path
41821           description: Unique id of VNF.  This is unique across the graph.
41822           required: true
41823           type: string
41824           example: __VNF-ID__
41825         - name: vnf-name
41826           in: query
41827           description: Name of VNF.
41828           required: false
41829           type: string
41830         - name: vnf-name2
41831           in: query
41832           description: Alternate name of VNF.
41833           required: false
41834           type: string
41835         - name: vnf-type
41836           in: query
41837           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.
41838           required: false
41839           type: string
41840         - name: service-id
41841           in: query
41842           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41843           required: false
41844           type: string
41845         - name: regional-resource-zone
41846           in: query
41847           description: Regional way of organizing pservers, source of truth should define values
41848           required: false
41849           type: string
41850         - name: prov-status
41851           in: query
41852           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41853           required: false
41854           type: string
41855         - name: heat-stack-id
41856           in: query
41857           description: Heat stack id corresponding to this instance, managed by MSO
41858           required: false
41859           type: string
41860         - name: in-maint
41861           in: query
41862           required: false
41863           type: boolean
41864         - name: is-closed-loop-disabled
41865           in: query
41866           required: false
41867           type: boolean
41868         - name: model-invariant-id
41869           in: query
41870           description: the ASDC model id for this resource or service model.
41871           required: false
41872           type: string
41873         - name: model-version-id
41874           in: query
41875           description: the ASDC model version for this resource or service model.
41876           required: false
41877           type: string
41878         - name: widget-model-id
41879           in: query
41880           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41881           required: false
41882           type: string
41883         - name: widget-model-version
41884           in: query
41885           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41886           required: false
41887           type: string
41888         - name: nf-type
41889           in: query
41890           description: Generic description of the type of NF
41891           required: false
41892           type: string
41893         - name: nf-function
41894           in: query
41895           description: English description of Network function that the specific VNF deployment is providing
41896           required: false
41897           type: string
41898         - name: nf-role
41899           in: query
41900           description: role in the network that this model will be providing
41901           required: false
41902           type: string
41903         - name: nf-naming-code
41904           in: query
41905           description: string assigned to this model used for naming purposes
41906           required: false
41907           type: string
41908   /network/generic-vnfs/generic-vnf/{vnf-id}:
41909     get:
41910       tags:
41911         - Network
41912       summary: returns generic-vnf
41913       description: returns generic-vnf
41914       operationId: getNetworkGenericVnfsGenericVnf
41915       produces:
41916         - application/json
41917         - application/xml
41918       responses:
41919         "200":
41920           description: successful operation
41921           schema:
41922               $ref: "#/getDefinitions/generic-vnf"
41923         "default":
41924           description: Response codes found in [response codes](https://wiki.onap.org/).
41925       parameters:
41926         - name: vnf-id
41927           in: path
41928           description: Unique id of VNF.  This is unique across the graph.
41929           required: true
41930           type: string
41931           example: __VNF-ID__
41932         - name: vnf-name
41933           in: query
41934           description: Name of VNF.
41935           required: false
41936           type: string
41937         - name: vnf-name2
41938           in: query
41939           description: Alternate name of VNF.
41940           required: false
41941           type: string
41942         - name: vnf-type
41943           in: query
41944           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.
41945           required: false
41946           type: string
41947         - name: service-id
41948           in: query
41949           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41950           required: false
41951           type: string
41952         - name: regional-resource-zone
41953           in: query
41954           description: Regional way of organizing pservers, source of truth should define values
41955           required: false
41956           type: string
41957         - name: prov-status
41958           in: query
41959           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41960           required: false
41961           type: string
41962         - name: heat-stack-id
41963           in: query
41964           description: Heat stack id corresponding to this instance, managed by MSO
41965           required: false
41966           type: string
41967         - name: in-maint
41968           in: query
41969           required: false
41970           type: boolean
41971         - name: is-closed-loop-disabled
41972           in: query
41973           required: false
41974           type: boolean
41975         - name: model-invariant-id
41976           in: query
41977           description: the ASDC model id for this resource or service model.
41978           required: false
41979           type: string
41980         - name: model-version-id
41981           in: query
41982           description: the ASDC model version for this resource or service model.
41983           required: false
41984           type: string
41985         - name: widget-model-id
41986           in: query
41987           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41988           required: false
41989           type: string
41990         - name: widget-model-version
41991           in: query
41992           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41993           required: false
41994           type: string
41995         - name: nf-type
41996           in: query
41997           description: Generic description of the type of NF
41998           required: false
41999           type: string
42000         - name: nf-function
42001           in: query
42002           description: English description of Network function that the specific VNF deployment is providing
42003           required: false
42004           type: string
42005         - name: nf-role
42006           in: query
42007           description: role in the network that this model will be providing
42008           required: false
42009           type: string
42010         - name: nf-naming-code
42011           in: query
42012           description: string assigned to this model used for naming purposes
42013           required: false
42014           type: string
42015     put:
42016       tags:
42017         - Network
42018       summary: create or update an existing generic-vnf
42019       description: |
42020         Create or update an existing generic-vnf.
42021         #
42022         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42023       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
42024       consumes:
42025         - application/json
42026         - application/xml
42027       produces:
42028         - application/json
42029         - application/xml
42030       responses:
42031         "default":
42032           description: Response codes found in [response codes](https://wiki.onap.org/).
42033       parameters:
42034         - name: vnf-id
42035           in: path
42036           description: Unique id of VNF.  This is unique across the graph.
42037           required: true
42038           type: string
42039           example: __VNF-ID__
42040         - name: body
42041           in: body
42042           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
42043           required: true
42044           schema:
42045             $ref: "#/definitions/generic-vnf"
42046     patch:
42047       tags:
42048         - Network
42049       summary: update an existing generic-vnf
42050       description: |
42051         Update an existing generic-vnf
42052         #
42053         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42054         The PUT operation will entirely replace an existing object.
42055         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42056         #
42057         Other differences between PUT and PATCH are:
42058         #
42059         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42060         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42061         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42062       operationId: UpdateNetworkGenericVnfsGenericVnf
42063       consumes:
42064         - application/json
42065         - application/xml
42066       produces:
42067         - application/json
42068         - application/xml
42069       responses:
42070         "default":
42071           description: Response codes found in [response codes](https://wiki.onap.org/).
42072       parameters:
42073         - name: vnf-id
42074           in: path
42075           description: Unique id of VNF.  This is unique across the graph.
42076           required: true
42077           type: string
42078           example: __VNF-ID__
42079         - name: body
42080           in: body
42081           description: generic-vnf object that needs to be created or updated.
42082           required: true
42083           schema:
42084             $ref: "#/patchDefinitions/generic-vnf"
42085     delete:
42086       tags:
42087         - Network
42088       summary: delete an existing generic-vnf
42089       description: delete an existing generic-vnf
42090       operationId: deleteNetworkGenericVnfsGenericVnf
42091       consumes:
42092         - application/json
42093         - application/xml
42094       produces:
42095         - application/json
42096         - application/xml
42097       responses:
42098         "default":
42099           description: Response codes found in [response codes](https://wiki.onap.org/).
42100       parameters:
42101         - name: vnf-id
42102           in: path
42103           description: Unique id of VNF.  This is unique across the graph.
42104           required: true
42105           type: string
42106           example: __VNF-ID__
42107         - name: resource-version
42108           in: query
42109           description: resource-version for concurrency
42110           required: true
42111           type: string
42112   /network/generic-vnfs:
42113     get:
42114       tags:
42115         - Network
42116       summary: returns generic-vnfs
42117       description: returns generic-vnfs
42118       operationId: getNetworkGenericVnfs
42119       produces:
42120         - application/json
42121         - application/xml
42122       responses:
42123         "200":
42124           description: successful operation
42125           schema:
42126               $ref: "#/getDefinitions/generic-vnfs"
42127         "default":
42128           description: Response codes found in [response codes](https://wiki.onap.org/).
42129   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
42130     put:
42131       tags:
42132         - Network
42133       summary: see node definition for valid relationships
42134       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
42135       consumes:
42136         - application/json
42137         - application/xml
42138       produces:
42139         - application/json
42140         - application/xml
42141       responses:
42142         "default":
42143           description: Response codes found in [response codes](https://wiki.onap.org/).
42144       parameters:
42145         - name: link-name
42146           in: path
42147           description: Alphabetical concatenation of lag-interface names
42148           required: true
42149           type: string
42150           example: __LINK-NAME__
42151         - name: body
42152           in: body
42153           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
42154           required: true
42155           schema:
42156             $ref: "#/definitions/relationship"
42157     delete:
42158       tags:
42159         - Network
42160       summary: delete an existing relationship
42161       description: delete an existing relationship
42162       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
42163       consumes:
42164         - application/json
42165         - application/xml
42166       produces:
42167         - application/json
42168         - application/xml
42169       responses:
42170         "default":
42171           description: Response codes found in [response codes](https://wiki.onap.org/).
42172       parameters:
42173         - name: link-name
42174           in: path
42175           description: Alphabetical concatenation of lag-interface names
42176           required: true
42177           type: string
42178           example: __LINK-NAME__
42179   /network/lag-links/lag-link/{link-name}:
42180     get:
42181       tags:
42182         - Network
42183       summary: returns lag-link
42184       description: returns lag-link
42185       operationId: getNetworkLagLinksLagLink
42186       produces:
42187         - application/json
42188         - application/xml
42189       responses:
42190         "200":
42191           description: successful operation
42192           schema:
42193               $ref: "#/getDefinitions/lag-link"
42194         "default":
42195           description: Response codes found in [response codes](https://wiki.onap.org/).
42196       parameters:
42197         - name: link-name
42198           in: path
42199           description: Alphabetical concatenation of lag-interface names
42200           required: true
42201           type: string
42202           example: __LINK-NAME__
42203     put:
42204       tags:
42205         - Network
42206       summary: create or update an existing lag-link
42207       description: |
42208         Create or update an existing lag-link.
42209         #
42210         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42211       operationId: createOrUpdateNetworkLagLinksLagLink
42212       consumes:
42213         - application/json
42214         - application/xml
42215       produces:
42216         - application/json
42217         - application/xml
42218       responses:
42219         "default":
42220           description: Response codes found in [response codes](https://wiki.onap.org/).
42221       parameters:
42222         - name: link-name
42223           in: path
42224           description: Alphabetical concatenation of lag-interface names
42225           required: true
42226           type: string
42227           example: __LINK-NAME__
42228         - name: body
42229           in: body
42230           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
42231           required: true
42232           schema:
42233             $ref: "#/definitions/lag-link"
42234     patch:
42235       tags:
42236         - Network
42237       summary: update an existing lag-link
42238       description: |
42239         Update an existing lag-link
42240         #
42241         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42242         The PUT operation will entirely replace an existing object.
42243         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42244         #
42245         Other differences between PUT and PATCH are:
42246         #
42247         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42248         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42249         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42250       operationId: UpdateNetworkLagLinksLagLink
42251       consumes:
42252         - application/json
42253         - application/xml
42254       produces:
42255         - application/json
42256         - application/xml
42257       responses:
42258         "default":
42259           description: Response codes found in [response codes](https://wiki.onap.org/).
42260       parameters:
42261         - name: link-name
42262           in: path
42263           description: Alphabetical concatenation of lag-interface names
42264           required: true
42265           type: string
42266           example: __LINK-NAME__
42267         - name: body
42268           in: body
42269           description: lag-link object that needs to be created or updated.
42270           required: true
42271           schema:
42272             $ref: "#/patchDefinitions/lag-link"
42273     delete:
42274       tags:
42275         - Network
42276       summary: delete an existing lag-link
42277       description: delete an existing lag-link
42278       operationId: deleteNetworkLagLinksLagLink
42279       consumes:
42280         - application/json
42281         - application/xml
42282       produces:
42283         - application/json
42284         - application/xml
42285       responses:
42286         "default":
42287           description: Response codes found in [response codes](https://wiki.onap.org/).
42288       parameters:
42289         - name: link-name
42290           in: path
42291           description: Alphabetical concatenation of lag-interface names
42292           required: true
42293           type: string
42294           example: __LINK-NAME__
42295         - name: resource-version
42296           in: query
42297           description: resource-version for concurrency
42298           required: true
42299           type: string
42300   /network/lag-links:
42301     get:
42302       tags:
42303         - Network
42304       summary: returns lag-links
42305       description: returns lag-links
42306       operationId: getNetworkLagLinks
42307       produces:
42308         - application/json
42309         - application/xml
42310       responses:
42311         "200":
42312           description: successful operation
42313           schema:
42314               $ref: "#/getDefinitions/lag-links"
42315         "default":
42316           description: Response codes found in [response codes](https://wiki.onap.org/).
42317   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
42318     put:
42319       tags:
42320         - Network
42321       summary: see node definition for valid relationships
42322       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
42323       consumes:
42324         - application/json
42325         - application/xml
42326       produces:
42327         - application/json
42328         - application/xml
42329       responses:
42330         "default":
42331           description: Response codes found in [response codes](https://wiki.onap.org/).
42332       parameters:
42333         - name: vnf-id2
42334           in: path
42335           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42336           required: true
42337           type: string
42338           example: __VNF-ID2__
42339         - name: body
42340           in: body
42341           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
42342           required: true
42343           schema:
42344             $ref: "#/definitions/relationship"
42345     delete:
42346       tags:
42347         - Network
42348       summary: delete an existing relationship
42349       description: delete an existing relationship
42350       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
42351       consumes:
42352         - application/json
42353         - application/xml
42354       produces:
42355         - application/json
42356         - application/xml
42357       responses:
42358         "default":
42359           description: Response codes found in [response codes](https://wiki.onap.org/).
42360       parameters:
42361         - name: vnf-id2
42362           in: path
42363           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42364           required: true
42365           type: string
42366           example: __VNF-ID2__
42367   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
42368     put:
42369       tags:
42370         - Network
42371       summary: see node definition for valid relationships
42372       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42373       consumes:
42374         - application/json
42375         - application/xml
42376       produces:
42377         - application/json
42378         - application/xml
42379       responses:
42380         "default":
42381           description: Response codes found in [response codes](https://wiki.onap.org/).
42382       parameters:
42383         - name: vnf-id2
42384           in: path
42385           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42386           required: true
42387           type: string
42388           example: __VNF-ID2__
42389         - name: interface-name
42390           in: path
42391           description: Name given to the interface
42392           required: true
42393           type: string
42394           example: __INTERFACE-NAME__
42395         - name: vlan-interface
42396           in: path
42397           description: String that identifies the interface
42398           required: true
42399           type: string
42400           example: __VLAN-INTERFACE__
42401         - name: body
42402           in: body
42403           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
42404           required: true
42405           schema:
42406             $ref: "#/definitions/relationship"
42407     delete:
42408       tags:
42409         - Network
42410       summary: delete an existing relationship
42411       description: delete an existing relationship
42412       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42413       consumes:
42414         - application/json
42415         - application/xml
42416       produces:
42417         - application/json
42418         - application/xml
42419       responses:
42420         "default":
42421           description: Response codes found in [response codes](https://wiki.onap.org/).
42422       parameters:
42423         - name: vnf-id2
42424           in: path
42425           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42426           required: true
42427           type: string
42428           example: __VNF-ID2__
42429         - name: interface-name
42430           in: path
42431           description: Name given to the interface
42432           required: true
42433           type: string
42434           example: __INTERFACE-NAME__
42435         - name: vlan-interface
42436           in: path
42437           description: String that identifies the interface
42438           required: true
42439           type: string
42440           example: __VLAN-INTERFACE__
42441   /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:
42442     put:
42443       tags:
42444         - Network
42445       summary: see node definition for valid relationships
42446       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42447       consumes:
42448         - application/json
42449         - application/xml
42450       produces:
42451         - application/json
42452         - application/xml
42453       responses:
42454         "default":
42455           description: Response codes found in [response codes](https://wiki.onap.org/).
42456       parameters:
42457         - name: vnf-id2
42458           in: path
42459           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42460           required: true
42461           type: string
42462           example: __VNF-ID2__
42463         - name: interface-name
42464           in: path
42465           description: Name given to the interface
42466           required: true
42467           type: string
42468           example: __INTERFACE-NAME__
42469         - name: vlan-interface
42470           in: path
42471           description: String that identifies the interface
42472           required: true
42473           type: string
42474           example: __VLAN-INTERFACE__
42475         - name: l3-interface-ipv4-address
42476           in: path
42477           description: IP address
42478           required: true
42479           type: string
42480           example: __L3-INTERFACE-IPV4-ADDRESS__
42481         - name: body
42482           in: body
42483           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42484           required: true
42485           schema:
42486             $ref: "#/definitions/relationship"
42487     delete:
42488       tags:
42489         - Network
42490       summary: delete an existing relationship
42491       description: delete an existing relationship
42492       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42493       consumes:
42494         - application/json
42495         - application/xml
42496       produces:
42497         - application/json
42498         - application/xml
42499       responses:
42500         "default":
42501           description: Response codes found in [response codes](https://wiki.onap.org/).
42502       parameters:
42503         - name: vnf-id2
42504           in: path
42505           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42506           required: true
42507           type: string
42508           example: __VNF-ID2__
42509         - name: interface-name
42510           in: path
42511           description: Name given to the interface
42512           required: true
42513           type: string
42514           example: __INTERFACE-NAME__
42515         - name: vlan-interface
42516           in: path
42517           description: String that identifies the interface
42518           required: true
42519           type: string
42520           example: __VLAN-INTERFACE__
42521         - name: l3-interface-ipv4-address
42522           in: path
42523           description: IP address
42524           required: true
42525           type: string
42526           example: __L3-INTERFACE-IPV4-ADDRESS__
42527   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42528     get:
42529       tags:
42530         - Network
42531       summary: returns l3-interface-ipv4-address-list
42532       description: returns l3-interface-ipv4-address-list
42533       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42534       produces:
42535         - application/json
42536         - application/xml
42537       responses:
42538         "200":
42539           description: successful operation
42540           schema:
42541               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42542         "default":
42543           description: Response codes found in [response codes](https://wiki.onap.org/).
42544       parameters:
42545         - name: vnf-id2
42546           in: path
42547           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42548           required: true
42549           type: string
42550           example: __VNF-ID2__
42551         - name: interface-name
42552           in: path
42553           description: Name given to the interface
42554           required: true
42555           type: string
42556           example: __INTERFACE-NAME__
42557         - name: vlan-interface
42558           in: path
42559           description: String that identifies the interface
42560           required: true
42561           type: string
42562           example: __VLAN-INTERFACE__
42563         - name: l3-interface-ipv4-address
42564           in: path
42565           description: IP address
42566           required: true
42567           type: string
42568           example: __L3-INTERFACE-IPV4-ADDRESS__
42569         - name: vnf-name
42570           in: query
42571           description: Name of VNF.
42572           required: false
42573           type: string
42574         - name: vnf-name2
42575           in: query
42576           description: Alternate name of VNF.
42577           required: false
42578           type: string
42579         - name: vnf-type
42580           in: query
42581           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.
42582           required: false
42583           type: string
42584         - name: prov-status
42585           in: query
42586           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42587           required: false
42588           type: string
42589         - name: heat-stack-id
42590           in: query
42591           description: Heat stack id corresponding to this instance, managed by MSO
42592           required: false
42593           type: string
42594         - name: interface-id
42595           in: query
42596           description: ID of interface
42597           required: false
42598           type: string
42599         - name: macaddr
42600           in: query
42601           description: MAC address for the interface
42602           required: false
42603           type: string
42604         - name: network-name
42605           in: query
42606           description: Name of the network
42607           required: false
42608           type: string
42609         - name: vlan-id-inner
42610           in: query
42611           description: Inner VLAN tag
42612           required: false
42613           type: integer
42614           format: int64
42615         - name: vpn-key
42616           in: query
42617           description: This indicates the customers VPN ID associated with this vlan
42618           required: false
42619           type: string
42620         - name: vlan-id-inner
42621           in: query
42622           description: Inner VLAN tag
42623           required: false
42624           type: integer
42625           format: int64
42626         - name: neutron-network-id
42627           in: query
42628           description: Neutron network id of the interface that address belongs to
42629           required: false
42630           type: string
42631         - name: neutron-subnet-id
42632           in: query
42633           description: Neutron id of subnet that address belongs to
42634           required: false
42635           type: string
42636     put:
42637       tags:
42638         - Network
42639       summary: create or update an existing l3-interface-ipv4-address-list
42640       description: |
42641         Create or update an existing l3-interface-ipv4-address-list.
42642         #
42643         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42644       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42645       consumes:
42646         - application/json
42647         - application/xml
42648       produces:
42649         - application/json
42650         - application/xml
42651       responses:
42652         "default":
42653           description: Response codes found in [response codes](https://wiki.onap.org/).
42654       parameters:
42655         - name: vnf-id2
42656           in: path
42657           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42658           required: true
42659           type: string
42660           example: __VNF-ID2__
42661         - name: interface-name
42662           in: path
42663           description: Name given to the interface
42664           required: true
42665           type: string
42666           example: __INTERFACE-NAME__
42667         - name: vlan-interface
42668           in: path
42669           description: String that identifies the interface
42670           required: true
42671           type: string
42672           example: __VLAN-INTERFACE__
42673         - name: l3-interface-ipv4-address
42674           in: path
42675           description: IP address
42676           required: true
42677           type: string
42678           example: __L3-INTERFACE-IPV4-ADDRESS__
42679         - name: body
42680           in: body
42681           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42682           required: true
42683           schema:
42684             $ref: "#/definitions/l3-interface-ipv4-address-list"
42685     patch:
42686       tags:
42687         - Network
42688       summary: update an existing l3-interface-ipv4-address-list
42689       description: |
42690         Update an existing l3-interface-ipv4-address-list
42691         #
42692         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42693         The PUT operation will entirely replace an existing object.
42694         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42695         #
42696         Other differences between PUT and PATCH are:
42697         #
42698         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42699         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42700         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42701       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42702       consumes:
42703         - application/json
42704         - application/xml
42705       produces:
42706         - application/json
42707         - application/xml
42708       responses:
42709         "default":
42710           description: Response codes found in [response codes](https://wiki.onap.org/).
42711       parameters:
42712         - name: vnf-id2
42713           in: path
42714           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42715           required: true
42716           type: string
42717           example: __VNF-ID2__
42718         - name: interface-name
42719           in: path
42720           description: Name given to the interface
42721           required: true
42722           type: string
42723           example: __INTERFACE-NAME__
42724         - name: vlan-interface
42725           in: path
42726           description: String that identifies the interface
42727           required: true
42728           type: string
42729           example: __VLAN-INTERFACE__
42730         - name: l3-interface-ipv4-address
42731           in: path
42732           description: IP address
42733           required: true
42734           type: string
42735           example: __L3-INTERFACE-IPV4-ADDRESS__
42736         - name: body
42737           in: body
42738           description: l3-interface-ipv4-address-list object that needs to be created or updated.
42739           required: true
42740           schema:
42741             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42742     delete:
42743       tags:
42744         - Network
42745       summary: delete an existing l3-interface-ipv4-address-list
42746       description: delete an existing l3-interface-ipv4-address-list
42747       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42748       consumes:
42749         - application/json
42750         - application/xml
42751       produces:
42752         - application/json
42753         - application/xml
42754       responses:
42755         "default":
42756           description: Response codes found in [response codes](https://wiki.onap.org/).
42757       parameters:
42758         - name: vnf-id2
42759           in: path
42760           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42761           required: true
42762           type: string
42763           example: __VNF-ID2__
42764         - name: interface-name
42765           in: path
42766           description: Name given to the interface
42767           required: true
42768           type: string
42769           example: __INTERFACE-NAME__
42770         - name: vlan-interface
42771           in: path
42772           description: String that identifies the interface
42773           required: true
42774           type: string
42775           example: __VLAN-INTERFACE__
42776         - name: l3-interface-ipv4-address
42777           in: path
42778           description: IP address
42779           required: true
42780           type: string
42781           example: __L3-INTERFACE-IPV4-ADDRESS__
42782         - name: resource-version
42783           in: query
42784           description: resource-version for concurrency
42785           required: true
42786           type: string
42787   /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:
42788     put:
42789       tags:
42790         - Network
42791       summary: see node definition for valid relationships
42792       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42793       consumes:
42794         - application/json
42795         - application/xml
42796       produces:
42797         - application/json
42798         - application/xml
42799       responses:
42800         "default":
42801           description: Response codes found in [response codes](https://wiki.onap.org/).
42802       parameters:
42803         - name: vnf-id2
42804           in: path
42805           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42806           required: true
42807           type: string
42808           example: __VNF-ID2__
42809         - name: interface-name
42810           in: path
42811           description: Name given to the interface
42812           required: true
42813           type: string
42814           example: __INTERFACE-NAME__
42815         - name: vlan-interface
42816           in: path
42817           description: String that identifies the interface
42818           required: true
42819           type: string
42820           example: __VLAN-INTERFACE__
42821         - name: l3-interface-ipv6-address
42822           in: path
42823           description: IP address
42824           required: true
42825           type: string
42826           example: __L3-INTERFACE-IPV6-ADDRESS__
42827         - name: body
42828           in: body
42829           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42830           required: true
42831           schema:
42832             $ref: "#/definitions/relationship"
42833     delete:
42834       tags:
42835         - Network
42836       summary: delete an existing relationship
42837       description: delete an existing relationship
42838       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42839       consumes:
42840         - application/json
42841         - application/xml
42842       produces:
42843         - application/json
42844         - application/xml
42845       responses:
42846         "default":
42847           description: Response codes found in [response codes](https://wiki.onap.org/).
42848       parameters:
42849         - name: vnf-id2
42850           in: path
42851           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42852           required: true
42853           type: string
42854           example: __VNF-ID2__
42855         - name: interface-name
42856           in: path
42857           description: Name given to the interface
42858           required: true
42859           type: string
42860           example: __INTERFACE-NAME__
42861         - name: vlan-interface
42862           in: path
42863           description: String that identifies the interface
42864           required: true
42865           type: string
42866           example: __VLAN-INTERFACE__
42867         - name: l3-interface-ipv6-address
42868           in: path
42869           description: IP address
42870           required: true
42871           type: string
42872           example: __L3-INTERFACE-IPV6-ADDRESS__
42873   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42874     get:
42875       tags:
42876         - Network
42877       summary: returns l3-interface-ipv6-address-list
42878       description: returns l3-interface-ipv6-address-list
42879       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42880       produces:
42881         - application/json
42882         - application/xml
42883       responses:
42884         "200":
42885           description: successful operation
42886           schema:
42887               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42888         "default":
42889           description: Response codes found in [response codes](https://wiki.onap.org/).
42890       parameters:
42891         - name: vnf-id2
42892           in: path
42893           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42894           required: true
42895           type: string
42896           example: __VNF-ID2__
42897         - name: interface-name
42898           in: path
42899           description: Name given to the interface
42900           required: true
42901           type: string
42902           example: __INTERFACE-NAME__
42903         - name: vlan-interface
42904           in: path
42905           description: String that identifies the interface
42906           required: true
42907           type: string
42908           example: __VLAN-INTERFACE__
42909         - name: l3-interface-ipv6-address
42910           in: path
42911           description: IP address
42912           required: true
42913           type: string
42914           example: __L3-INTERFACE-IPV6-ADDRESS__
42915         - name: vnf-name
42916           in: query
42917           description: Name of VNF.
42918           required: false
42919           type: string
42920         - name: vnf-name2
42921           in: query
42922           description: Alternate name of VNF.
42923           required: false
42924           type: string
42925         - name: vnf-type
42926           in: query
42927           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.
42928           required: false
42929           type: string
42930         - name: prov-status
42931           in: query
42932           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42933           required: false
42934           type: string
42935         - name: heat-stack-id
42936           in: query
42937           description: Heat stack id corresponding to this instance, managed by MSO
42938           required: false
42939           type: string
42940         - name: interface-id
42941           in: query
42942           description: ID of interface
42943           required: false
42944           type: string
42945         - name: macaddr
42946           in: query
42947           description: MAC address for the interface
42948           required: false
42949           type: string
42950         - name: network-name
42951           in: query
42952           description: Name of the network
42953           required: false
42954           type: string
42955         - name: vlan-id-inner
42956           in: query
42957           description: Inner VLAN tag
42958           required: false
42959           type: integer
42960           format: int64
42961         - name: vpn-key
42962           in: query
42963           description: This indicates the customers VPN ID associated with this vlan
42964           required: false
42965           type: string
42966         - name: vlan-id-inner
42967           in: query
42968           description: Inner VLAN tag
42969           required: false
42970           type: integer
42971           format: int64
42972         - name: neutron-network-id
42973           in: query
42974           description: Neutron network id of the interface that address belongs to
42975           required: false
42976           type: string
42977         - name: neutron-subnet-id
42978           in: query
42979           description: Neutron id of subnet that address belongs to
42980           required: false
42981           type: string
42982     put:
42983       tags:
42984         - Network
42985       summary: create or update an existing l3-interface-ipv6-address-list
42986       description: |
42987         Create or update an existing l3-interface-ipv6-address-list.
42988         #
42989         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42990       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42991       consumes:
42992         - application/json
42993         - application/xml
42994       produces:
42995         - application/json
42996         - application/xml
42997       responses:
42998         "default":
42999           description: Response codes found in [response codes](https://wiki.onap.org/).
43000       parameters:
43001         - name: vnf-id2
43002           in: path
43003           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43004           required: true
43005           type: string
43006           example: __VNF-ID2__
43007         - name: interface-name
43008           in: path
43009           description: Name given to the interface
43010           required: true
43011           type: string
43012           example: __INTERFACE-NAME__
43013         - name: vlan-interface
43014           in: path
43015           description: String that identifies the interface
43016           required: true
43017           type: string
43018           example: __VLAN-INTERFACE__
43019         - name: l3-interface-ipv6-address
43020           in: path
43021           description: IP address
43022           required: true
43023           type: string
43024           example: __L3-INTERFACE-IPV6-ADDRESS__
43025         - name: body
43026           in: body
43027           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
43028           required: true
43029           schema:
43030             $ref: "#/definitions/l3-interface-ipv6-address-list"
43031     patch:
43032       tags:
43033         - Network
43034       summary: update an existing l3-interface-ipv6-address-list
43035       description: |
43036         Update an existing l3-interface-ipv6-address-list
43037         #
43038         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43039         The PUT operation will entirely replace an existing object.
43040         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43041         #
43042         Other differences between PUT and PATCH are:
43043         #
43044         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43045         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43046         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43047       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43048       consumes:
43049         - application/json
43050         - application/xml
43051       produces:
43052         - application/json
43053         - application/xml
43054       responses:
43055         "default":
43056           description: Response codes found in [response codes](https://wiki.onap.org/).
43057       parameters:
43058         - name: vnf-id2
43059           in: path
43060           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43061           required: true
43062           type: string
43063           example: __VNF-ID2__
43064         - name: interface-name
43065           in: path
43066           description: Name given to the interface
43067           required: true
43068           type: string
43069           example: __INTERFACE-NAME__
43070         - name: vlan-interface
43071           in: path
43072           description: String that identifies the interface
43073           required: true
43074           type: string
43075           example: __VLAN-INTERFACE__
43076         - name: l3-interface-ipv6-address
43077           in: path
43078           description: IP address
43079           required: true
43080           type: string
43081           example: __L3-INTERFACE-IPV6-ADDRESS__
43082         - name: body
43083           in: body
43084           description: l3-interface-ipv6-address-list object that needs to be created or updated.
43085           required: true
43086           schema:
43087             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43088     delete:
43089       tags:
43090         - Network
43091       summary: delete an existing l3-interface-ipv6-address-list
43092       description: delete an existing l3-interface-ipv6-address-list
43093       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43094       consumes:
43095         - application/json
43096         - application/xml
43097       produces:
43098         - application/json
43099         - application/xml
43100       responses:
43101         "default":
43102           description: Response codes found in [response codes](https://wiki.onap.org/).
43103       parameters:
43104         - name: vnf-id2
43105           in: path
43106           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43107           required: true
43108           type: string
43109           example: __VNF-ID2__
43110         - name: interface-name
43111           in: path
43112           description: Name given to the interface
43113           required: true
43114           type: string
43115           example: __INTERFACE-NAME__
43116         - name: vlan-interface
43117           in: path
43118           description: String that identifies the interface
43119           required: true
43120           type: string
43121           example: __VLAN-INTERFACE__
43122         - name: l3-interface-ipv6-address
43123           in: path
43124           description: IP address
43125           required: true
43126           type: string
43127           example: __L3-INTERFACE-IPV6-ADDRESS__
43128         - name: resource-version
43129           in: query
43130           description: resource-version for concurrency
43131           required: true
43132           type: string
43133   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
43134     get:
43135       tags:
43136         - Network
43137       summary: returns vlan
43138       description: returns vlan
43139       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43140       produces:
43141         - application/json
43142         - application/xml
43143       responses:
43144         "200":
43145           description: successful operation
43146           schema:
43147               $ref: "#/getDefinitions/vlan"
43148         "default":
43149           description: Response codes found in [response codes](https://wiki.onap.org/).
43150       parameters:
43151         - name: vnf-id2
43152           in: path
43153           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43154           required: true
43155           type: string
43156           example: __VNF-ID2__
43157         - name: interface-name
43158           in: path
43159           description: Name given to the interface
43160           required: true
43161           type: string
43162           example: __INTERFACE-NAME__
43163         - name: vlan-interface
43164           in: path
43165           description: String that identifies the interface
43166           required: true
43167           type: string
43168           example: __VLAN-INTERFACE__
43169         - name: vnf-name
43170           in: query
43171           description: Name of VNF.
43172           required: false
43173           type: string
43174         - name: vnf-name2
43175           in: query
43176           description: Alternate name of VNF.
43177           required: false
43178           type: string
43179         - name: vnf-type
43180           in: query
43181           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.
43182           required: false
43183           type: string
43184         - name: prov-status
43185           in: query
43186           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43187           required: false
43188           type: string
43189         - name: heat-stack-id
43190           in: query
43191           description: Heat stack id corresponding to this instance, managed by MSO
43192           required: false
43193           type: string
43194         - name: interface-id
43195           in: query
43196           description: ID of interface
43197           required: false
43198           type: string
43199         - name: macaddr
43200           in: query
43201           description: MAC address for the interface
43202           required: false
43203           type: string
43204         - name: network-name
43205           in: query
43206           description: Name of the network
43207           required: false
43208           type: string
43209         - name: vlan-id-inner
43210           in: query
43211           description: Inner VLAN tag
43212           required: false
43213           type: integer
43214           format: int64
43215         - name: vpn-key
43216           in: query
43217           description: This indicates the customers VPN ID associated with this vlan
43218           required: false
43219           type: string
43220     put:
43221       tags:
43222         - Network
43223       summary: create or update an existing vlan
43224       description: |
43225         Create or update an existing vlan.
43226         #
43227         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43228       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43229       consumes:
43230         - application/json
43231         - application/xml
43232       produces:
43233         - application/json
43234         - application/xml
43235       responses:
43236         "default":
43237           description: Response codes found in [response codes](https://wiki.onap.org/).
43238       parameters:
43239         - name: vnf-id2
43240           in: path
43241           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43242           required: true
43243           type: string
43244           example: __VNF-ID2__
43245         - name: interface-name
43246           in: path
43247           description: Name given to the interface
43248           required: true
43249           type: string
43250           example: __INTERFACE-NAME__
43251         - name: vlan-interface
43252           in: path
43253           description: String that identifies the interface
43254           required: true
43255           type: string
43256           example: __VLAN-INTERFACE__
43257         - name: body
43258           in: body
43259           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
43260           required: true
43261           schema:
43262             $ref: "#/definitions/vlan"
43263     patch:
43264       tags:
43265         - Network
43266       summary: update an existing vlan
43267       description: |
43268         Update an existing vlan
43269         #
43270         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43271         The PUT operation will entirely replace an existing object.
43272         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43273         #
43274         Other differences between PUT and PATCH are:
43275         #
43276         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43277         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43278         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43279       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43280       consumes:
43281         - application/json
43282         - application/xml
43283       produces:
43284         - application/json
43285         - application/xml
43286       responses:
43287         "default":
43288           description: Response codes found in [response codes](https://wiki.onap.org/).
43289       parameters:
43290         - name: vnf-id2
43291           in: path
43292           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43293           required: true
43294           type: string
43295           example: __VNF-ID2__
43296         - name: interface-name
43297           in: path
43298           description: Name given to the interface
43299           required: true
43300           type: string
43301           example: __INTERFACE-NAME__
43302         - name: vlan-interface
43303           in: path
43304           description: String that identifies the interface
43305           required: true
43306           type: string
43307           example: __VLAN-INTERFACE__
43308         - name: body
43309           in: body
43310           description: vlan object that needs to be created or updated.
43311           required: true
43312           schema:
43313             $ref: "#/patchDefinitions/vlan"
43314     delete:
43315       tags:
43316         - Network
43317       summary: delete an existing vlan
43318       description: delete an existing vlan
43319       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43320       consumes:
43321         - application/json
43322         - application/xml
43323       produces:
43324         - application/json
43325         - application/xml
43326       responses:
43327         "default":
43328           description: Response codes found in [response codes](https://wiki.onap.org/).
43329       parameters:
43330         - name: vnf-id2
43331           in: path
43332           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43333           required: true
43334           type: string
43335           example: __VNF-ID2__
43336         - name: interface-name
43337           in: path
43338           description: Name given to the interface
43339           required: true
43340           type: string
43341           example: __INTERFACE-NAME__
43342         - name: vlan-interface
43343           in: path
43344           description: String that identifies the interface
43345           required: true
43346           type: string
43347           example: __VLAN-INTERFACE__
43348         - name: resource-version
43349           in: query
43350           description: resource-version for concurrency
43351           required: true
43352           type: string
43353   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
43354     get:
43355       tags:
43356         - Network
43357       summary: returns vlans
43358       description: returns vlans
43359       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
43360       produces:
43361         - application/json
43362         - application/xml
43363       responses:
43364         "200":
43365           description: successful operation
43366           schema:
43367               $ref: "#/getDefinitions/vlans"
43368         "default":
43369           description: Response codes found in [response codes](https://wiki.onap.org/).
43370       parameters:
43371         - name: vnf-id2
43372           in: path
43373           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43374           required: true
43375           type: string
43376           example: __VNF-ID2__
43377         - name: interface-name
43378           in: path
43379           description: Name given to the interface
43380           required: true
43381           type: string
43382           example: __INTERFACE-NAME__
43383         - name: vnf-name
43384           in: query
43385           description: Name of VNF.
43386           required: false
43387           type: string
43388         - name: vnf-name2
43389           in: query
43390           description: Alternate name of VNF.
43391           required: false
43392           type: string
43393         - name: vnf-type
43394           in: query
43395           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.
43396           required: false
43397           type: string
43398         - name: prov-status
43399           in: query
43400           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43401           required: false
43402           type: string
43403         - name: heat-stack-id
43404           in: query
43405           description: Heat stack id corresponding to this instance, managed by MSO
43406           required: false
43407           type: string
43408         - name: interface-id
43409           in: query
43410           description: ID of interface
43411           required: false
43412           type: string
43413         - name: macaddr
43414           in: query
43415           description: MAC address for the interface
43416           required: false
43417           type: string
43418         - name: network-name
43419           in: query
43420           description: Name of the network
43421           required: false
43422           type: string
43423   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
43424     put:
43425       tags:
43426         - Network
43427       summary: see node definition for valid relationships
43428       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43429       consumes:
43430         - application/json
43431         - application/xml
43432       produces:
43433         - application/json
43434         - application/xml
43435       responses:
43436         "default":
43437           description: Response codes found in [response codes](https://wiki.onap.org/).
43438       parameters:
43439         - name: vnf-id2
43440           in: path
43441           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43442           required: true
43443           type: string
43444           example: __VNF-ID2__
43445         - name: interface-name
43446           in: path
43447           description: Name given to the interface
43448           required: true
43449           type: string
43450           example: __INTERFACE-NAME__
43451         - name: pci-id
43452           in: path
43453           description: PCI ID used to identify the sriov-vf
43454           required: true
43455           type: string
43456           example: __PCI-ID__
43457         - name: body
43458           in: body
43459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43460           required: true
43461           schema:
43462             $ref: "#/definitions/relationship"
43463     delete:
43464       tags:
43465         - Network
43466       summary: delete an existing relationship
43467       description: delete an existing relationship
43468       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43469       consumes:
43470         - application/json
43471         - application/xml
43472       produces:
43473         - application/json
43474         - application/xml
43475       responses:
43476         "default":
43477           description: Response codes found in [response codes](https://wiki.onap.org/).
43478       parameters:
43479         - name: vnf-id2
43480           in: path
43481           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43482           required: true
43483           type: string
43484           example: __VNF-ID2__
43485         - name: interface-name
43486           in: path
43487           description: Name given to the interface
43488           required: true
43489           type: string
43490           example: __INTERFACE-NAME__
43491         - name: pci-id
43492           in: path
43493           description: PCI ID used to identify the sriov-vf
43494           required: true
43495           type: string
43496           example: __PCI-ID__
43497   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
43498     get:
43499       tags:
43500         - Network
43501       summary: returns sriov-vf
43502       description: returns sriov-vf
43503       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43504       produces:
43505         - application/json
43506         - application/xml
43507       responses:
43508         "200":
43509           description: successful operation
43510           schema:
43511               $ref: "#/getDefinitions/sriov-vf"
43512         "default":
43513           description: Response codes found in [response codes](https://wiki.onap.org/).
43514       parameters:
43515         - name: vnf-id2
43516           in: path
43517           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43518           required: true
43519           type: string
43520           example: __VNF-ID2__
43521         - name: interface-name
43522           in: path
43523           description: Name given to the interface
43524           required: true
43525           type: string
43526           example: __INTERFACE-NAME__
43527         - name: pci-id
43528           in: path
43529           description: PCI ID used to identify the sriov-vf
43530           required: true
43531           type: string
43532           example: __PCI-ID__
43533         - name: vnf-name
43534           in: query
43535           description: Name of VNF.
43536           required: false
43537           type: string
43538         - name: vnf-name2
43539           in: query
43540           description: Alternate name of VNF.
43541           required: false
43542           type: string
43543         - name: vnf-type
43544           in: query
43545           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.
43546           required: false
43547           type: string
43548         - name: prov-status
43549           in: query
43550           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43551           required: false
43552           type: string
43553         - name: heat-stack-id
43554           in: query
43555           description: Heat stack id corresponding to this instance, managed by MSO
43556           required: false
43557           type: string
43558         - name: interface-id
43559           in: query
43560           description: ID of interface
43561           required: false
43562           type: string
43563         - name: macaddr
43564           in: query
43565           description: MAC address for the interface
43566           required: false
43567           type: string
43568         - name: network-name
43569           in: query
43570           description: Name of the network
43571           required: false
43572           type: string
43573         - name: vf-vlan-filter
43574           in: query
43575           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
43576           required: false
43577           type: string
43578         - name: vf-mac-filter
43579           in: query
43580           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
43581           required: false
43582           type: string
43583         - name: vf-vlan-strip
43584           in: query
43585           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
43586           required: false
43587           type: boolean
43588         - name: neutron-network-id
43589           in: query
43590           description: Neutron network id of the interface
43591           required: false
43592           type: string
43593     put:
43594       tags:
43595         - Network
43596       summary: create or update an existing sriov-vf
43597       description: |
43598         Create or update an existing sriov-vf.
43599         #
43600         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43601       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43602       consumes:
43603         - application/json
43604         - application/xml
43605       produces:
43606         - application/json
43607         - application/xml
43608       responses:
43609         "default":
43610           description: Response codes found in [response codes](https://wiki.onap.org/).
43611       parameters:
43612         - name: vnf-id2
43613           in: path
43614           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43615           required: true
43616           type: string
43617           example: __VNF-ID2__
43618         - name: interface-name
43619           in: path
43620           description: Name given to the interface
43621           required: true
43622           type: string
43623           example: __INTERFACE-NAME__
43624         - name: pci-id
43625           in: path
43626           description: PCI ID used to identify the sriov-vf
43627           required: true
43628           type: string
43629           example: __PCI-ID__
43630         - name: body
43631           in: body
43632           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43633           required: true
43634           schema:
43635             $ref: "#/definitions/sriov-vf"
43636     patch:
43637       tags:
43638         - Network
43639       summary: update an existing sriov-vf
43640       description: |
43641         Update an existing sriov-vf
43642         #
43643         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43644         The PUT operation will entirely replace an existing object.
43645         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43646         #
43647         Other differences between PUT and PATCH are:
43648         #
43649         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43650         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43651         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43652       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43653       consumes:
43654         - application/json
43655         - application/xml
43656       produces:
43657         - application/json
43658         - application/xml
43659       responses:
43660         "default":
43661           description: Response codes found in [response codes](https://wiki.onap.org/).
43662       parameters:
43663         - name: vnf-id2
43664           in: path
43665           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43666           required: true
43667           type: string
43668           example: __VNF-ID2__
43669         - name: interface-name
43670           in: path
43671           description: Name given to the interface
43672           required: true
43673           type: string
43674           example: __INTERFACE-NAME__
43675         - name: pci-id
43676           in: path
43677           description: PCI ID used to identify the sriov-vf
43678           required: true
43679           type: string
43680           example: __PCI-ID__
43681         - name: body
43682           in: body
43683           description: sriov-vf object that needs to be created or updated.
43684           required: true
43685           schema:
43686             $ref: "#/patchDefinitions/sriov-vf"
43687     delete:
43688       tags:
43689         - Network
43690       summary: delete an existing sriov-vf
43691       description: delete an existing sriov-vf
43692       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43693       consumes:
43694         - application/json
43695         - application/xml
43696       produces:
43697         - application/json
43698         - application/xml
43699       responses:
43700         "default":
43701           description: Response codes found in [response codes](https://wiki.onap.org/).
43702       parameters:
43703         - name: vnf-id2
43704           in: path
43705           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43706           required: true
43707           type: string
43708           example: __VNF-ID2__
43709         - name: interface-name
43710           in: path
43711           description: Name given to the interface
43712           required: true
43713           type: string
43714           example: __INTERFACE-NAME__
43715         - name: pci-id
43716           in: path
43717           description: PCI ID used to identify the sriov-vf
43718           required: true
43719           type: string
43720           example: __PCI-ID__
43721         - name: resource-version
43722           in: query
43723           description: resource-version for concurrency
43724           required: true
43725           type: string
43726   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43727     get:
43728       tags:
43729         - Network
43730       summary: returns sriov-vfs
43731       description: returns sriov-vfs
43732       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
43733       produces:
43734         - application/json
43735         - application/xml
43736       responses:
43737         "200":
43738           description: successful operation
43739           schema:
43740               $ref: "#/getDefinitions/sriov-vfs"
43741         "default":
43742           description: Response codes found in [response codes](https://wiki.onap.org/).
43743       parameters:
43744         - name: vnf-id2
43745           in: path
43746           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43747           required: true
43748           type: string
43749           example: __VNF-ID2__
43750         - name: interface-name
43751           in: path
43752           description: Name given to the interface
43753           required: true
43754           type: string
43755           example: __INTERFACE-NAME__
43756         - name: vnf-name
43757           in: query
43758           description: Name of VNF.
43759           required: false
43760           type: string
43761         - name: vnf-name2
43762           in: query
43763           description: Alternate name of VNF.
43764           required: false
43765           type: string
43766         - name: vnf-type
43767           in: query
43768           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.
43769           required: false
43770           type: string
43771         - name: prov-status
43772           in: query
43773           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43774           required: false
43775           type: string
43776         - name: heat-stack-id
43777           in: query
43778           description: Heat stack id corresponding to this instance, managed by MSO
43779           required: false
43780           type: string
43781         - name: interface-id
43782           in: query
43783           description: ID of interface
43784           required: false
43785           type: string
43786         - name: macaddr
43787           in: query
43788           description: MAC address for the interface
43789           required: false
43790           type: string
43791         - name: network-name
43792           in: query
43793           description: Name of the network
43794           required: false
43795           type: string
43796   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43797     put:
43798       tags:
43799         - Network
43800       summary: see node definition for valid relationships
43801       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43802       consumes:
43803         - application/json
43804         - application/xml
43805       produces:
43806         - application/json
43807         - application/xml
43808       responses:
43809         "default":
43810           description: Response codes found in [response codes](https://wiki.onap.org/).
43811       parameters:
43812         - name: vnf-id2
43813           in: path
43814           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43815           required: true
43816           type: string
43817           example: __VNF-ID2__
43818         - name: interface-name
43819           in: path
43820           description: Name given to the interface
43821           required: true
43822           type: string
43823           example: __INTERFACE-NAME__
43824         - name: body
43825           in: body
43826           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
43827           required: true
43828           schema:
43829             $ref: "#/definitions/relationship"
43830     delete:
43831       tags:
43832         - Network
43833       summary: delete an existing relationship
43834       description: delete an existing relationship
43835       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43836       consumes:
43837         - application/json
43838         - application/xml
43839       produces:
43840         - application/json
43841         - application/xml
43842       responses:
43843         "default":
43844           description: Response codes found in [response codes](https://wiki.onap.org/).
43845       parameters:
43846         - name: vnf-id2
43847           in: path
43848           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43849           required: true
43850           type: string
43851           example: __VNF-ID2__
43852         - name: interface-name
43853           in: path
43854           description: Name given to the interface
43855           required: true
43856           type: string
43857           example: __INTERFACE-NAME__
43858   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43859     put:
43860       tags:
43861         - Network
43862       summary: see node definition for valid relationships
43863       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43864       consumes:
43865         - application/json
43866         - application/xml
43867       produces:
43868         - application/json
43869         - application/xml
43870       responses:
43871         "default":
43872           description: Response codes found in [response codes](https://wiki.onap.org/).
43873       parameters:
43874         - name: vnf-id2
43875           in: path
43876           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43877           required: true
43878           type: string
43879           example: __VNF-ID2__
43880         - name: interface-name
43881           in: path
43882           description: Name given to the interface
43883           required: true
43884           type: string
43885           example: __INTERFACE-NAME__
43886         - name: l3-interface-ipv4-address
43887           in: path
43888           description: IP address
43889           required: true
43890           type: string
43891           example: __L3-INTERFACE-IPV4-ADDRESS__
43892         - name: body
43893           in: body
43894           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43895           required: true
43896           schema:
43897             $ref: "#/definitions/relationship"
43898     delete:
43899       tags:
43900         - Network
43901       summary: delete an existing relationship
43902       description: delete an existing relationship
43903       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43904       consumes:
43905         - application/json
43906         - application/xml
43907       produces:
43908         - application/json
43909         - application/xml
43910       responses:
43911         "default":
43912           description: Response codes found in [response codes](https://wiki.onap.org/).
43913       parameters:
43914         - name: vnf-id2
43915           in: path
43916           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43917           required: true
43918           type: string
43919           example: __VNF-ID2__
43920         - name: interface-name
43921           in: path
43922           description: Name given to the interface
43923           required: true
43924           type: string
43925           example: __INTERFACE-NAME__
43926         - name: l3-interface-ipv4-address
43927           in: path
43928           description: IP address
43929           required: true
43930           type: string
43931           example: __L3-INTERFACE-IPV4-ADDRESS__
43932   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43933     get:
43934       tags:
43935         - Network
43936       summary: returns l3-interface-ipv4-address-list
43937       description: returns l3-interface-ipv4-address-list
43938       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43939       produces:
43940         - application/json
43941         - application/xml
43942       responses:
43943         "200":
43944           description: successful operation
43945           schema:
43946               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43947         "default":
43948           description: Response codes found in [response codes](https://wiki.onap.org/).
43949       parameters:
43950         - name: vnf-id2
43951           in: path
43952           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43953           required: true
43954           type: string
43955           example: __VNF-ID2__
43956         - name: interface-name
43957           in: path
43958           description: Name given to the interface
43959           required: true
43960           type: string
43961           example: __INTERFACE-NAME__
43962         - name: l3-interface-ipv4-address
43963           in: path
43964           description: IP address
43965           required: true
43966           type: string
43967           example: __L3-INTERFACE-IPV4-ADDRESS__
43968         - name: vnf-name
43969           in: query
43970           description: Name of VNF.
43971           required: false
43972           type: string
43973         - name: vnf-name2
43974           in: query
43975           description: Alternate name of VNF.
43976           required: false
43977           type: string
43978         - name: vnf-type
43979           in: query
43980           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.
43981           required: false
43982           type: string
43983         - name: prov-status
43984           in: query
43985           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43986           required: false
43987           type: string
43988         - name: heat-stack-id
43989           in: query
43990           description: Heat stack id corresponding to this instance, managed by MSO
43991           required: false
43992           type: string
43993         - name: interface-id
43994           in: query
43995           description: ID of interface
43996           required: false
43997           type: string
43998         - name: macaddr
43999           in: query
44000           description: MAC address for the interface
44001           required: false
44002           type: string
44003         - name: network-name
44004           in: query
44005           description: Name of the network
44006           required: false
44007           type: string
44008         - name: vlan-id-inner
44009           in: query
44010           description: Inner VLAN tag
44011           required: false
44012           type: integer
44013           format: int64
44014         - name: neutron-network-id
44015           in: query
44016           description: Neutron network id of the interface that address belongs to
44017           required: false
44018           type: string
44019         - name: neutron-subnet-id
44020           in: query
44021           description: Neutron id of subnet that address belongs to
44022           required: false
44023           type: string
44024     put:
44025       tags:
44026         - Network
44027       summary: create or update an existing l3-interface-ipv4-address-list
44028       description: |
44029         Create or update an existing l3-interface-ipv4-address-list.
44030         #
44031         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44032       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44033       consumes:
44034         - application/json
44035         - application/xml
44036       produces:
44037         - application/json
44038         - application/xml
44039       responses:
44040         "default":
44041           description: Response codes found in [response codes](https://wiki.onap.org/).
44042       parameters:
44043         - name: vnf-id2
44044           in: path
44045           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44046           required: true
44047           type: string
44048           example: __VNF-ID2__
44049         - name: interface-name
44050           in: path
44051           description: Name given to the interface
44052           required: true
44053           type: string
44054           example: __INTERFACE-NAME__
44055         - name: l3-interface-ipv4-address
44056           in: path
44057           description: IP address
44058           required: true
44059           type: string
44060           example: __L3-INTERFACE-IPV4-ADDRESS__
44061         - name: body
44062           in: body
44063           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
44064           required: true
44065           schema:
44066             $ref: "#/definitions/l3-interface-ipv4-address-list"
44067     patch:
44068       tags:
44069         - Network
44070       summary: update an existing l3-interface-ipv4-address-list
44071       description: |
44072         Update an existing l3-interface-ipv4-address-list
44073         #
44074         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44075         The PUT operation will entirely replace an existing object.
44076         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44077         #
44078         Other differences between PUT and PATCH are:
44079         #
44080         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44081         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44082         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44083       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44084       consumes:
44085         - application/json
44086         - application/xml
44087       produces:
44088         - application/json
44089         - application/xml
44090       responses:
44091         "default":
44092           description: Response codes found in [response codes](https://wiki.onap.org/).
44093       parameters:
44094         - name: vnf-id2
44095           in: path
44096           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44097           required: true
44098           type: string
44099           example: __VNF-ID2__
44100         - name: interface-name
44101           in: path
44102           description: Name given to the interface
44103           required: true
44104           type: string
44105           example: __INTERFACE-NAME__
44106         - name: l3-interface-ipv4-address
44107           in: path
44108           description: IP address
44109           required: true
44110           type: string
44111           example: __L3-INTERFACE-IPV4-ADDRESS__
44112         - name: body
44113           in: body
44114           description: l3-interface-ipv4-address-list object that needs to be created or updated.
44115           required: true
44116           schema:
44117             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44118     delete:
44119       tags:
44120         - Network
44121       summary: delete an existing l3-interface-ipv4-address-list
44122       description: delete an existing l3-interface-ipv4-address-list
44123       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44124       consumes:
44125         - application/json
44126         - application/xml
44127       produces:
44128         - application/json
44129         - application/xml
44130       responses:
44131         "default":
44132           description: Response codes found in [response codes](https://wiki.onap.org/).
44133       parameters:
44134         - name: vnf-id2
44135           in: path
44136           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44137           required: true
44138           type: string
44139           example: __VNF-ID2__
44140         - name: interface-name
44141           in: path
44142           description: Name given to the interface
44143           required: true
44144           type: string
44145           example: __INTERFACE-NAME__
44146         - name: l3-interface-ipv4-address
44147           in: path
44148           description: IP address
44149           required: true
44150           type: string
44151           example: __L3-INTERFACE-IPV4-ADDRESS__
44152         - name: resource-version
44153           in: query
44154           description: resource-version for concurrency
44155           required: true
44156           type: string
44157   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
44158     put:
44159       tags:
44160         - Network
44161       summary: see node definition for valid relationships
44162       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44163       consumes:
44164         - application/json
44165         - application/xml
44166       produces:
44167         - application/json
44168         - application/xml
44169       responses:
44170         "default":
44171           description: Response codes found in [response codes](https://wiki.onap.org/).
44172       parameters:
44173         - name: vnf-id2
44174           in: path
44175           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44176           required: true
44177           type: string
44178           example: __VNF-ID2__
44179         - name: interface-name
44180           in: path
44181           description: Name given to the interface
44182           required: true
44183           type: string
44184           example: __INTERFACE-NAME__
44185         - name: l3-interface-ipv6-address
44186           in: path
44187           description: IP address
44188           required: true
44189           type: string
44190           example: __L3-INTERFACE-IPV6-ADDRESS__
44191         - name: body
44192           in: body
44193           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44194           required: true
44195           schema:
44196             $ref: "#/definitions/relationship"
44197     delete:
44198       tags:
44199         - Network
44200       summary: delete an existing relationship
44201       description: delete an existing relationship
44202       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44203       consumes:
44204         - application/json
44205         - application/xml
44206       produces:
44207         - application/json
44208         - application/xml
44209       responses:
44210         "default":
44211           description: Response codes found in [response codes](https://wiki.onap.org/).
44212       parameters:
44213         - name: vnf-id2
44214           in: path
44215           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44216           required: true
44217           type: string
44218           example: __VNF-ID2__
44219         - name: interface-name
44220           in: path
44221           description: Name given to the interface
44222           required: true
44223           type: string
44224           example: __INTERFACE-NAME__
44225         - name: l3-interface-ipv6-address
44226           in: path
44227           description: IP address
44228           required: true
44229           type: string
44230           example: __L3-INTERFACE-IPV6-ADDRESS__
44231   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
44232     get:
44233       tags:
44234         - Network
44235       summary: returns l3-interface-ipv6-address-list
44236       description: returns l3-interface-ipv6-address-list
44237       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44238       produces:
44239         - application/json
44240         - application/xml
44241       responses:
44242         "200":
44243           description: successful operation
44244           schema:
44245               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44246         "default":
44247           description: Response codes found in [response codes](https://wiki.onap.org/).
44248       parameters:
44249         - name: vnf-id2
44250           in: path
44251           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44252           required: true
44253           type: string
44254           example: __VNF-ID2__
44255         - name: interface-name
44256           in: path
44257           description: Name given to the interface
44258           required: true
44259           type: string
44260           example: __INTERFACE-NAME__
44261         - name: l3-interface-ipv6-address
44262           in: path
44263           description: IP address
44264           required: true
44265           type: string
44266           example: __L3-INTERFACE-IPV6-ADDRESS__
44267         - name: vnf-name
44268           in: query
44269           description: Name of VNF.
44270           required: false
44271           type: string
44272         - name: vnf-name2
44273           in: query
44274           description: Alternate name of VNF.
44275           required: false
44276           type: string
44277         - name: vnf-type
44278           in: query
44279           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.
44280           required: false
44281           type: string
44282         - name: prov-status
44283           in: query
44284           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44285           required: false
44286           type: string
44287         - name: heat-stack-id
44288           in: query
44289           description: Heat stack id corresponding to this instance, managed by MSO
44290           required: false
44291           type: string
44292         - name: interface-id
44293           in: query
44294           description: ID of interface
44295           required: false
44296           type: string
44297         - name: macaddr
44298           in: query
44299           description: MAC address for the interface
44300           required: false
44301           type: string
44302         - name: network-name
44303           in: query
44304           description: Name of the network
44305           required: false
44306           type: string
44307         - name: vlan-id-inner
44308           in: query
44309           description: Inner VLAN tag
44310           required: false
44311           type: integer
44312           format: int64
44313         - name: neutron-network-id
44314           in: query
44315           description: Neutron network id of the interface that address belongs to
44316           required: false
44317           type: string
44318         - name: neutron-subnet-id
44319           in: query
44320           description: Neutron id of subnet that address belongs to
44321           required: false
44322           type: string
44323     put:
44324       tags:
44325         - Network
44326       summary: create or update an existing l3-interface-ipv6-address-list
44327       description: |
44328         Create or update an existing l3-interface-ipv6-address-list.
44329         #
44330         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44331       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44332       consumes:
44333         - application/json
44334         - application/xml
44335       produces:
44336         - application/json
44337         - application/xml
44338       responses:
44339         "default":
44340           description: Response codes found in [response codes](https://wiki.onap.org/).
44341       parameters:
44342         - name: vnf-id2
44343           in: path
44344           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44345           required: true
44346           type: string
44347           example: __VNF-ID2__
44348         - name: interface-name
44349           in: path
44350           description: Name given to the interface
44351           required: true
44352           type: string
44353           example: __INTERFACE-NAME__
44354         - name: l3-interface-ipv6-address
44355           in: path
44356           description: IP address
44357           required: true
44358           type: string
44359           example: __L3-INTERFACE-IPV6-ADDRESS__
44360         - name: body
44361           in: body
44362           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44363           required: true
44364           schema:
44365             $ref: "#/definitions/l3-interface-ipv6-address-list"
44366     patch:
44367       tags:
44368         - Network
44369       summary: update an existing l3-interface-ipv6-address-list
44370       description: |
44371         Update an existing l3-interface-ipv6-address-list
44372         #
44373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44374         The PUT operation will entirely replace an existing object.
44375         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44376         #
44377         Other differences between PUT and PATCH are:
44378         #
44379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44382       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44383       consumes:
44384         - application/json
44385         - application/xml
44386       produces:
44387         - application/json
44388         - application/xml
44389       responses:
44390         "default":
44391           description: Response codes found in [response codes](https://wiki.onap.org/).
44392       parameters:
44393         - name: vnf-id2
44394           in: path
44395           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44396           required: true
44397           type: string
44398           example: __VNF-ID2__
44399         - name: interface-name
44400           in: path
44401           description: Name given to the interface
44402           required: true
44403           type: string
44404           example: __INTERFACE-NAME__
44405         - name: l3-interface-ipv6-address
44406           in: path
44407           description: IP address
44408           required: true
44409           type: string
44410           example: __L3-INTERFACE-IPV6-ADDRESS__
44411         - name: body
44412           in: body
44413           description: l3-interface-ipv6-address-list object that needs to be created or updated.
44414           required: true
44415           schema:
44416             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44417     delete:
44418       tags:
44419         - Network
44420       summary: delete an existing l3-interface-ipv6-address-list
44421       description: delete an existing l3-interface-ipv6-address-list
44422       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44423       consumes:
44424         - application/json
44425         - application/xml
44426       produces:
44427         - application/json
44428         - application/xml
44429       responses:
44430         "default":
44431           description: Response codes found in [response codes](https://wiki.onap.org/).
44432       parameters:
44433         - name: vnf-id2
44434           in: path
44435           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44436           required: true
44437           type: string
44438           example: __VNF-ID2__
44439         - name: interface-name
44440           in: path
44441           description: Name given to the interface
44442           required: true
44443           type: string
44444           example: __INTERFACE-NAME__
44445         - name: l3-interface-ipv6-address
44446           in: path
44447           description: IP address
44448           required: true
44449           type: string
44450           example: __L3-INTERFACE-IPV6-ADDRESS__
44451         - name: resource-version
44452           in: query
44453           description: resource-version for concurrency
44454           required: true
44455           type: string
44456   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
44457     get:
44458       tags:
44459         - Network
44460       summary: returns l-interface
44461       description: returns l-interface
44462       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
44463       produces:
44464         - application/json
44465         - application/xml
44466       responses:
44467         "200":
44468           description: successful operation
44469           schema:
44470               $ref: "#/getDefinitions/l-interface"
44471         "default":
44472           description: Response codes found in [response codes](https://wiki.onap.org/).
44473       parameters:
44474         - name: vnf-id2
44475           in: path
44476           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44477           required: true
44478           type: string
44479           example: __VNF-ID2__
44480         - name: interface-name
44481           in: path
44482           description: Name given to the interface
44483           required: true
44484           type: string
44485           example: __INTERFACE-NAME__
44486         - name: vnf-name
44487           in: query
44488           description: Name of VNF.
44489           required: false
44490           type: string
44491         - name: vnf-name2
44492           in: query
44493           description: Alternate name of VNF.
44494           required: false
44495           type: string
44496         - name: vnf-type
44497           in: query
44498           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.
44499           required: false
44500           type: string
44501         - name: prov-status
44502           in: query
44503           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44504           required: false
44505           type: string
44506         - name: heat-stack-id
44507           in: query
44508           description: Heat stack id corresponding to this instance, managed by MSO
44509           required: false
44510           type: string
44511         - name: interface-id
44512           in: query
44513           description: ID of interface
44514           required: false
44515           type: string
44516         - name: macaddr
44517           in: query
44518           description: MAC address for the interface
44519           required: false
44520           type: string
44521         - name: network-name
44522           in: query
44523           description: Name of the network
44524           required: false
44525           type: string
44526     put:
44527       tags:
44528         - Network
44529       summary: create or update an existing l-interface
44530       description: |
44531         Create or update an existing l-interface.
44532         #
44533         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44534       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
44535       consumes:
44536         - application/json
44537         - application/xml
44538       produces:
44539         - application/json
44540         - application/xml
44541       responses:
44542         "default":
44543           description: Response codes found in [response codes](https://wiki.onap.org/).
44544       parameters:
44545         - name: vnf-id2
44546           in: path
44547           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44548           required: true
44549           type: string
44550           example: __VNF-ID2__
44551         - name: interface-name
44552           in: path
44553           description: Name given to the interface
44554           required: true
44555           type: string
44556           example: __INTERFACE-NAME__
44557         - name: body
44558           in: body
44559           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
44560           required: true
44561           schema:
44562             $ref: "#/definitions/l-interface"
44563     patch:
44564       tags:
44565         - Network
44566       summary: update an existing l-interface
44567       description: |
44568         Update an existing l-interface
44569         #
44570         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44571         The PUT operation will entirely replace an existing object.
44572         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44573         #
44574         Other differences between PUT and PATCH are:
44575         #
44576         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44577         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44578         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44579       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
44580       consumes:
44581         - application/json
44582         - application/xml
44583       produces:
44584         - application/json
44585         - application/xml
44586       responses:
44587         "default":
44588           description: Response codes found in [response codes](https://wiki.onap.org/).
44589       parameters:
44590         - name: vnf-id2
44591           in: path
44592           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44593           required: true
44594           type: string
44595           example: __VNF-ID2__
44596         - name: interface-name
44597           in: path
44598           description: Name given to the interface
44599           required: true
44600           type: string
44601           example: __INTERFACE-NAME__
44602         - name: body
44603           in: body
44604           description: l-interface object that needs to be created or updated.
44605           required: true
44606           schema:
44607             $ref: "#/patchDefinitions/l-interface"
44608     delete:
44609       tags:
44610         - Network
44611       summary: delete an existing l-interface
44612       description: delete an existing l-interface
44613       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
44614       consumes:
44615         - application/json
44616         - application/xml
44617       produces:
44618         - application/json
44619         - application/xml
44620       responses:
44621         "default":
44622           description: Response codes found in [response codes](https://wiki.onap.org/).
44623       parameters:
44624         - name: vnf-id2
44625           in: path
44626           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44627           required: true
44628           type: string
44629           example: __VNF-ID2__
44630         - name: interface-name
44631           in: path
44632           description: Name given to the interface
44633           required: true
44634           type: string
44635           example: __INTERFACE-NAME__
44636         - name: resource-version
44637           in: query
44638           description: resource-version for concurrency
44639           required: true
44640           type: string
44641   /network/newvces/newvce/{vnf-id2}/l-interfaces:
44642     get:
44643       tags:
44644         - Network
44645       summary: returns l-interfaces
44646       description: returns l-interfaces
44647       operationId: getNetworkNewvcesNewvceLInterfaces
44648       produces:
44649         - application/json
44650         - application/xml
44651       responses:
44652         "200":
44653           description: successful operation
44654           schema:
44655               $ref: "#/getDefinitions/l-interfaces"
44656         "default":
44657           description: Response codes found in [response codes](https://wiki.onap.org/).
44658       parameters:
44659         - name: vnf-id2
44660           in: path
44661           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44662           required: true
44663           type: string
44664           example: __VNF-ID2__
44665         - name: vnf-name
44666           in: query
44667           description: Name of VNF.
44668           required: false
44669           type: string
44670         - name: vnf-name2
44671           in: query
44672           description: Alternate name of VNF.
44673           required: false
44674           type: string
44675         - name: vnf-type
44676           in: query
44677           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.
44678           required: false
44679           type: string
44680         - name: prov-status
44681           in: query
44682           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44683           required: false
44684           type: string
44685         - name: heat-stack-id
44686           in: query
44687           description: Heat stack id corresponding to this instance, managed by MSO
44688           required: false
44689           type: string
44690   /network/newvces/newvce/{vnf-id2}:
44691     get:
44692       tags:
44693         - Network
44694       summary: returns newvce
44695       description: returns newvce
44696       operationId: getNetworkNewvcesNewvce
44697       produces:
44698         - application/json
44699         - application/xml
44700       responses:
44701         "200":
44702           description: successful operation
44703           schema:
44704               $ref: "#/getDefinitions/newvce"
44705         "default":
44706           description: Response codes found in [response codes](https://wiki.onap.org/).
44707       parameters:
44708         - name: vnf-id2
44709           in: path
44710           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44711           required: true
44712           type: string
44713           example: __VNF-ID2__
44714         - name: vnf-name
44715           in: query
44716           description: Name of VNF.
44717           required: false
44718           type: string
44719         - name: vnf-name2
44720           in: query
44721           description: Alternate name of VNF.
44722           required: false
44723           type: string
44724         - name: vnf-type
44725           in: query
44726           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.
44727           required: false
44728           type: string
44729         - name: prov-status
44730           in: query
44731           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44732           required: false
44733           type: string
44734         - name: heat-stack-id
44735           in: query
44736           description: Heat stack id corresponding to this instance, managed by MSO
44737           required: false
44738           type: string
44739     put:
44740       tags:
44741         - Network
44742       summary: create or update an existing newvce
44743       description: |
44744         Create or update an existing newvce.
44745         #
44746         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44747       operationId: createOrUpdateNetworkNewvcesNewvce
44748       consumes:
44749         - application/json
44750         - application/xml
44751       produces:
44752         - application/json
44753         - application/xml
44754       responses:
44755         "default":
44756           description: Response codes found in [response codes](https://wiki.onap.org/).
44757       parameters:
44758         - name: vnf-id2
44759           in: path
44760           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44761           required: true
44762           type: string
44763           example: __VNF-ID2__
44764         - name: body
44765           in: body
44766           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
44767           required: true
44768           schema:
44769             $ref: "#/definitions/newvce"
44770     patch:
44771       tags:
44772         - Network
44773       summary: update an existing newvce
44774       description: |
44775         Update an existing newvce
44776         #
44777         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44778         The PUT operation will entirely replace an existing object.
44779         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44780         #
44781         Other differences between PUT and PATCH are:
44782         #
44783         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44784         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44785         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44786       operationId: UpdateNetworkNewvcesNewvce
44787       consumes:
44788         - application/json
44789         - application/xml
44790       produces:
44791         - application/json
44792         - application/xml
44793       responses:
44794         "default":
44795           description: Response codes found in [response codes](https://wiki.onap.org/).
44796       parameters:
44797         - name: vnf-id2
44798           in: path
44799           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44800           required: true
44801           type: string
44802           example: __VNF-ID2__
44803         - name: body
44804           in: body
44805           description: newvce object that needs to be created or updated.
44806           required: true
44807           schema:
44808             $ref: "#/patchDefinitions/newvce"
44809     delete:
44810       tags:
44811         - Network
44812       summary: delete an existing newvce
44813       description: delete an existing newvce
44814       operationId: deleteNetworkNewvcesNewvce
44815       consumes:
44816         - application/json
44817         - application/xml
44818       produces:
44819         - application/json
44820         - application/xml
44821       responses:
44822         "default":
44823           description: Response codes found in [response codes](https://wiki.onap.org/).
44824       parameters:
44825         - name: vnf-id2
44826           in: path
44827           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44828           required: true
44829           type: string
44830           example: __VNF-ID2__
44831         - name: resource-version
44832           in: query
44833           description: resource-version for concurrency
44834           required: true
44835           type: string
44836   /network/newvces:
44837     get:
44838       tags:
44839         - Network
44840       summary: returns newvces
44841       description: returns newvces
44842       operationId: getNetworkNewvces
44843       produces:
44844         - application/json
44845         - application/xml
44846       responses:
44847         "200":
44848           description: successful operation
44849           schema:
44850               $ref: "#/getDefinitions/newvces"
44851         "default":
44852           description: Response codes found in [response codes](https://wiki.onap.org/).
44853   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
44854     put:
44855       tags:
44856         - Network
44857       summary: see node definition for valid relationships
44858       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
44859       consumes:
44860         - application/json
44861         - application/xml
44862       produces:
44863         - application/json
44864         - application/xml
44865       responses:
44866         "default":
44867           description: Response codes found in [response codes](https://wiki.onap.org/).
44868       parameters:
44869         - name: pnf-name
44870           in: path
44871           description: unique name of Physical Network Function.
44872           required: true
44873           type: string
44874           example: __PNF-NAME__
44875         - name: body
44876           in: body
44877           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
44878           required: true
44879           schema:
44880             $ref: "#/definitions/relationship"
44881     delete:
44882       tags:
44883         - Network
44884       summary: delete an existing relationship
44885       description: delete an existing relationship
44886       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
44887       consumes:
44888         - application/json
44889         - application/xml
44890       produces:
44891         - application/json
44892         - application/xml
44893       responses:
44894         "default":
44895           description: Response codes found in [response codes](https://wiki.onap.org/).
44896       parameters:
44897         - name: pnf-name
44898           in: path
44899           description: unique name of Physical Network Function.
44900           required: true
44901           type: string
44902           example: __PNF-NAME__
44903   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
44904     put:
44905       tags:
44906         - Network
44907       summary: see node definition for valid relationships
44908       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
44909       consumes:
44910         - application/json
44911         - application/xml
44912       produces:
44913         - application/json
44914         - application/xml
44915       responses:
44916         "default":
44917           description: Response codes found in [response codes](https://wiki.onap.org/).
44918       parameters:
44919         - name: pnf-name
44920           in: path
44921           description: unique name of Physical Network Function.
44922           required: true
44923           type: string
44924           example: __PNF-NAME__
44925         - name: interface-name
44926           in: path
44927           description: Name that identifies the physical interface
44928           required: true
44929           type: string
44930           example: __INTERFACE-NAME__
44931         - name: body
44932           in: body
44933           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
44934           required: true
44935           schema:
44936             $ref: "#/definitions/relationship"
44937     delete:
44938       tags:
44939         - Network
44940       summary: delete an existing relationship
44941       description: delete an existing relationship
44942       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
44943       consumes:
44944         - application/json
44945         - application/xml
44946       produces:
44947         - application/json
44948         - application/xml
44949       responses:
44950         "default":
44951           description: Response codes found in [response codes](https://wiki.onap.org/).
44952       parameters:
44953         - name: pnf-name
44954           in: path
44955           description: unique name of Physical Network Function.
44956           required: true
44957           type: string
44958           example: __PNF-NAME__
44959         - name: interface-name
44960           in: path
44961           description: Name that identifies the physical interface
44962           required: true
44963           type: string
44964           example: __INTERFACE-NAME__
44965   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
44966     put:
44967       tags:
44968         - Network
44969       summary: see node definition for valid relationships
44970       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
44971       consumes:
44972         - application/json
44973         - application/xml
44974       produces:
44975         - application/json
44976         - application/xml
44977       responses:
44978         "default":
44979           description: Response codes found in [response codes](https://wiki.onap.org/).
44980       parameters:
44981         - name: pnf-name
44982           in: path
44983           description: unique name of Physical Network Function.
44984           required: true
44985           type: string
44986           example: __PNF-NAME__
44987         - name: interface-name
44988           in: path
44989           description: Name that identifies the physical interface
44990           required: true
44991           type: string
44992           example: __INTERFACE-NAME__
44993         - name: pf-pci-id
44994           in: path
44995           description: Identifier for the sriov-pf
44996           required: true
44997           type: string
44998           example: __PF-PCI-ID__
44999         - name: body
45000           in: body
45001           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45002           required: true
45003           schema:
45004             $ref: "#/definitions/relationship"
45005     delete:
45006       tags:
45007         - Network
45008       summary: delete an existing relationship
45009       description: delete an existing relationship
45010       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45011       consumes:
45012         - application/json
45013         - application/xml
45014       produces:
45015         - application/json
45016         - application/xml
45017       responses:
45018         "default":
45019           description: Response codes found in [response codes](https://wiki.onap.org/).
45020       parameters:
45021         - name: pnf-name
45022           in: path
45023           description: unique name of Physical Network Function.
45024           required: true
45025           type: string
45026           example: __PNF-NAME__
45027         - name: interface-name
45028           in: path
45029           description: Name that identifies the physical interface
45030           required: true
45031           type: string
45032           example: __INTERFACE-NAME__
45033         - name: pf-pci-id
45034           in: path
45035           description: Identifier for the sriov-pf
45036           required: true
45037           type: string
45038           example: __PF-PCI-ID__
45039   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
45040     get:
45041       tags:
45042         - Network
45043       summary: returns sriov-pf
45044       description: returns sriov-pf
45045       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45046       produces:
45047         - application/json
45048         - application/xml
45049       responses:
45050         "200":
45051           description: successful operation
45052           schema:
45053               $ref: "#/getDefinitions/sriov-pf"
45054         "default":
45055           description: Response codes found in [response codes](https://wiki.onap.org/).
45056       parameters:
45057         - name: pnf-name
45058           in: path
45059           description: unique name of Physical Network Function.
45060           required: true
45061           type: string
45062           example: __PNF-NAME__
45063         - name: interface-name
45064           in: path
45065           description: Name that identifies the physical interface
45066           required: true
45067           type: string
45068           example: __INTERFACE-NAME__
45069         - name: pf-pci-id
45070           in: path
45071           description: Identifier for the sriov-pf
45072           required: true
45073           type: string
45074           example: __PF-PCI-ID__
45075         - name: inv-status
45076           in: query
45077           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45078           required: false
45079           type: string
45080         - name: prov-status
45081           in: query
45082           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45083           required: false
45084           type: string
45085     put:
45086       tags:
45087         - Network
45088       summary: create or update an existing sriov-pf
45089       description: |
45090         Create or update an existing sriov-pf.
45091         #
45092         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45093       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45094       consumes:
45095         - application/json
45096         - application/xml
45097       produces:
45098         - application/json
45099         - application/xml
45100       responses:
45101         "default":
45102           description: Response codes found in [response codes](https://wiki.onap.org/).
45103       parameters:
45104         - name: pnf-name
45105           in: path
45106           description: unique name of Physical Network Function.
45107           required: true
45108           type: string
45109           example: __PNF-NAME__
45110         - name: interface-name
45111           in: path
45112           description: Name that identifies the physical interface
45113           required: true
45114           type: string
45115           example: __INTERFACE-NAME__
45116         - name: pf-pci-id
45117           in: path
45118           description: Identifier for the sriov-pf
45119           required: true
45120           type: string
45121           example: __PF-PCI-ID__
45122         - name: body
45123           in: body
45124           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45125           required: true
45126           schema:
45127             $ref: "#/definitions/sriov-pf"
45128     patch:
45129       tags:
45130         - Network
45131       summary: update an existing sriov-pf
45132       description: |
45133         Update an existing sriov-pf
45134         #
45135         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45136         The PUT operation will entirely replace an existing object.
45137         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45138         #
45139         Other differences between PUT and PATCH are:
45140         #
45141         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45142         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45143         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45144       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45145       consumes:
45146         - application/json
45147         - application/xml
45148       produces:
45149         - application/json
45150         - application/xml
45151       responses:
45152         "default":
45153           description: Response codes found in [response codes](https://wiki.onap.org/).
45154       parameters:
45155         - name: pnf-name
45156           in: path
45157           description: unique name of Physical Network Function.
45158           required: true
45159           type: string
45160           example: __PNF-NAME__
45161         - name: interface-name
45162           in: path
45163           description: Name that identifies the physical interface
45164           required: true
45165           type: string
45166           example: __INTERFACE-NAME__
45167         - name: pf-pci-id
45168           in: path
45169           description: Identifier for the sriov-pf
45170           required: true
45171           type: string
45172           example: __PF-PCI-ID__
45173         - name: body
45174           in: body
45175           description: sriov-pf object that needs to be created or updated.
45176           required: true
45177           schema:
45178             $ref: "#/patchDefinitions/sriov-pf"
45179     delete:
45180       tags:
45181         - Network
45182       summary: delete an existing sriov-pf
45183       description: delete an existing sriov-pf
45184       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45185       consumes:
45186         - application/json
45187         - application/xml
45188       produces:
45189         - application/json
45190         - application/xml
45191       responses:
45192         "default":
45193           description: Response codes found in [response codes](https://wiki.onap.org/).
45194       parameters:
45195         - name: pnf-name
45196           in: path
45197           description: unique name of Physical Network Function.
45198           required: true
45199           type: string
45200           example: __PNF-NAME__
45201         - name: interface-name
45202           in: path
45203           description: Name that identifies the physical interface
45204           required: true
45205           type: string
45206           example: __INTERFACE-NAME__
45207         - name: pf-pci-id
45208           in: path
45209           description: Identifier for the sriov-pf
45210           required: true
45211           type: string
45212           example: __PF-PCI-ID__
45213         - name: resource-version
45214           in: query
45215           description: resource-version for concurrency
45216           required: true
45217           type: string
45218   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
45219     get:
45220       tags:
45221         - Network
45222       summary: returns sriov-pfs
45223       description: returns sriov-pfs
45224       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
45225       produces:
45226         - application/json
45227         - application/xml
45228       responses:
45229         "200":
45230           description: successful operation
45231           schema:
45232               $ref: "#/getDefinitions/sriov-pfs"
45233         "default":
45234           description: Response codes found in [response codes](https://wiki.onap.org/).
45235       parameters:
45236         - name: pnf-name
45237           in: path
45238           description: unique name of Physical Network Function.
45239           required: true
45240           type: string
45241           example: __PNF-NAME__
45242         - name: interface-name
45243           in: path
45244           description: Name that identifies the physical interface
45245           required: true
45246           type: string
45247           example: __INTERFACE-NAME__
45248         - name: inv-status
45249           in: query
45250           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45251           required: false
45252           type: string
45253         - name: prov-status
45254           in: query
45255           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45256           required: false
45257           type: string
45258   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
45259     put:
45260       tags:
45261         - Network
45262       summary: see node definition for valid relationships
45263       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45264       consumes:
45265         - application/json
45266         - application/xml
45267       produces:
45268         - application/json
45269         - application/xml
45270       responses:
45271         "default":
45272           description: Response codes found in [response codes](https://wiki.onap.org/).
45273       parameters:
45274         - name: pnf-name
45275           in: path
45276           description: unique name of Physical Network Function.
45277           required: true
45278           type: string
45279           example: __PNF-NAME__
45280         - name: interface-name
45281           in: path
45282           description: Name that identifies the physical interface
45283           required: true
45284           type: string
45285           example: __INTERFACE-NAME__
45286         - name: interface-name
45287           in: path
45288           description: Name given to the interface
45289           required: true
45290           type: string
45291           example: __INTERFACE-NAME__
45292         - name: vlan-interface
45293           in: path
45294           description: String that identifies the interface
45295           required: true
45296           type: string
45297           example: __VLAN-INTERFACE__
45298         - name: body
45299           in: body
45300           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
45301           required: true
45302           schema:
45303             $ref: "#/definitions/relationship"
45304     delete:
45305       tags:
45306         - Network
45307       summary: delete an existing relationship
45308       description: delete an existing relationship
45309       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45310       consumes:
45311         - application/json
45312         - application/xml
45313       produces:
45314         - application/json
45315         - application/xml
45316       responses:
45317         "default":
45318           description: Response codes found in [response codes](https://wiki.onap.org/).
45319       parameters:
45320         - name: pnf-name
45321           in: path
45322           description: unique name of Physical Network Function.
45323           required: true
45324           type: string
45325           example: __PNF-NAME__
45326         - name: interface-name
45327           in: path
45328           description: Name that identifies the physical interface
45329           required: true
45330           type: string
45331           example: __INTERFACE-NAME__
45332         - name: interface-name
45333           in: path
45334           description: Name given to the interface
45335           required: true
45336           type: string
45337           example: __INTERFACE-NAME__
45338         - name: vlan-interface
45339           in: path
45340           description: String that identifies the interface
45341           required: true
45342           type: string
45343           example: __VLAN-INTERFACE__
45344   /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:
45345     put:
45346       tags:
45347         - Network
45348       summary: see node definition for valid relationships
45349       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45350       consumes:
45351         - application/json
45352         - application/xml
45353       produces:
45354         - application/json
45355         - application/xml
45356       responses:
45357         "default":
45358           description: Response codes found in [response codes](https://wiki.onap.org/).
45359       parameters:
45360         - name: pnf-name
45361           in: path
45362           description: unique name of Physical Network Function.
45363           required: true
45364           type: string
45365           example: __PNF-NAME__
45366         - name: interface-name
45367           in: path
45368           description: Name that identifies the physical interface
45369           required: true
45370           type: string
45371           example: __INTERFACE-NAME__
45372         - name: interface-name
45373           in: path
45374           description: Name given to the interface
45375           required: true
45376           type: string
45377           example: __INTERFACE-NAME__
45378         - name: vlan-interface
45379           in: path
45380           description: String that identifies the interface
45381           required: true
45382           type: string
45383           example: __VLAN-INTERFACE__
45384         - name: l3-interface-ipv4-address
45385           in: path
45386           description: IP address
45387           required: true
45388           type: string
45389           example: __L3-INTERFACE-IPV4-ADDRESS__
45390         - name: body
45391           in: body
45392           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45393           required: true
45394           schema:
45395             $ref: "#/definitions/relationship"
45396     delete:
45397       tags:
45398         - Network
45399       summary: delete an existing relationship
45400       description: delete an existing relationship
45401       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45402       consumes:
45403         - application/json
45404         - application/xml
45405       produces:
45406         - application/json
45407         - application/xml
45408       responses:
45409         "default":
45410           description: Response codes found in [response codes](https://wiki.onap.org/).
45411       parameters:
45412         - name: pnf-name
45413           in: path
45414           description: unique name of Physical Network Function.
45415           required: true
45416           type: string
45417           example: __PNF-NAME__
45418         - name: interface-name
45419           in: path
45420           description: Name that identifies the physical interface
45421           required: true
45422           type: string
45423           example: __INTERFACE-NAME__
45424         - name: interface-name
45425           in: path
45426           description: Name given to the interface
45427           required: true
45428           type: string
45429           example: __INTERFACE-NAME__
45430         - name: vlan-interface
45431           in: path
45432           description: String that identifies the interface
45433           required: true
45434           type: string
45435           example: __VLAN-INTERFACE__
45436         - name: l3-interface-ipv4-address
45437           in: path
45438           description: IP address
45439           required: true
45440           type: string
45441           example: __L3-INTERFACE-IPV4-ADDRESS__
45442   /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}:
45443     get:
45444       tags:
45445         - Network
45446       summary: returns l3-interface-ipv4-address-list
45447       description: returns l3-interface-ipv4-address-list
45448       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45449       produces:
45450         - application/json
45451         - application/xml
45452       responses:
45453         "200":
45454           description: successful operation
45455           schema:
45456               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45457         "default":
45458           description: Response codes found in [response codes](https://wiki.onap.org/).
45459       parameters:
45460         - name: pnf-name
45461           in: path
45462           description: unique name of Physical Network Function.
45463           required: true
45464           type: string
45465           example: __PNF-NAME__
45466         - name: interface-name
45467           in: path
45468           description: Name that identifies the physical interface
45469           required: true
45470           type: string
45471           example: __INTERFACE-NAME__
45472         - name: interface-name
45473           in: path
45474           description: Name given to the interface
45475           required: true
45476           type: string
45477           example: __INTERFACE-NAME__
45478         - name: vlan-interface
45479           in: path
45480           description: String that identifies the interface
45481           required: true
45482           type: string
45483           example: __VLAN-INTERFACE__
45484         - name: l3-interface-ipv4-address
45485           in: path
45486           description: IP address
45487           required: true
45488           type: string
45489           example: __L3-INTERFACE-IPV4-ADDRESS__
45490         - name: inv-status
45491           in: query
45492           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45493           required: false
45494           type: string
45495         - name: prov-status
45496           in: query
45497           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45498           required: false
45499           type: string
45500         - name: interface-id
45501           in: query
45502           description: ID of interface
45503           required: false
45504           type: string
45505         - name: macaddr
45506           in: query
45507           description: MAC address for the interface
45508           required: false
45509           type: string
45510         - name: network-name
45511           in: query
45512           description: Name of the network
45513           required: false
45514           type: string
45515         - name: vlan-id-inner
45516           in: query
45517           description: Inner VLAN tag
45518           required: false
45519           type: integer
45520           format: int64
45521         - name: vpn-key
45522           in: query
45523           description: This indicates the customers VPN ID associated with this vlan
45524           required: false
45525           type: string
45526         - name: vlan-id-inner
45527           in: query
45528           description: Inner VLAN tag
45529           required: false
45530           type: integer
45531           format: int64
45532         - name: neutron-network-id
45533           in: query
45534           description: Neutron network id of the interface that address belongs to
45535           required: false
45536           type: string
45537         - name: neutron-subnet-id
45538           in: query
45539           description: Neutron id of subnet that address belongs to
45540           required: false
45541           type: string
45542     put:
45543       tags:
45544         - Network
45545       summary: create or update an existing l3-interface-ipv4-address-list
45546       description: |
45547         Create or update an existing l3-interface-ipv4-address-list.
45548         #
45549         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45550       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45551       consumes:
45552         - application/json
45553         - application/xml
45554       produces:
45555         - application/json
45556         - application/xml
45557       responses:
45558         "default":
45559           description: Response codes found in [response codes](https://wiki.onap.org/).
45560       parameters:
45561         - name: pnf-name
45562           in: path
45563           description: unique name of Physical Network Function.
45564           required: true
45565           type: string
45566           example: __PNF-NAME__
45567         - name: interface-name
45568           in: path
45569           description: Name that identifies the physical interface
45570           required: true
45571           type: string
45572           example: __INTERFACE-NAME__
45573         - name: interface-name
45574           in: path
45575           description: Name given to the interface
45576           required: true
45577           type: string
45578           example: __INTERFACE-NAME__
45579         - name: vlan-interface
45580           in: path
45581           description: String that identifies the interface
45582           required: true
45583           type: string
45584           example: __VLAN-INTERFACE__
45585         - name: l3-interface-ipv4-address
45586           in: path
45587           description: IP address
45588           required: true
45589           type: string
45590           example: __L3-INTERFACE-IPV4-ADDRESS__
45591         - name: body
45592           in: body
45593           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45594           required: true
45595           schema:
45596             $ref: "#/definitions/l3-interface-ipv4-address-list"
45597     patch:
45598       tags:
45599         - Network
45600       summary: update an existing l3-interface-ipv4-address-list
45601       description: |
45602         Update an existing l3-interface-ipv4-address-list
45603         #
45604         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45605         The PUT operation will entirely replace an existing object.
45606         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45607         #
45608         Other differences between PUT and PATCH are:
45609         #
45610         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45611         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45612         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45613       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45614       consumes:
45615         - application/json
45616         - application/xml
45617       produces:
45618         - application/json
45619         - application/xml
45620       responses:
45621         "default":
45622           description: Response codes found in [response codes](https://wiki.onap.org/).
45623       parameters:
45624         - name: pnf-name
45625           in: path
45626           description: unique name of Physical Network Function.
45627           required: true
45628           type: string
45629           example: __PNF-NAME__
45630         - name: interface-name
45631           in: path
45632           description: Name that identifies the physical interface
45633           required: true
45634           type: string
45635           example: __INTERFACE-NAME__
45636         - name: interface-name
45637           in: path
45638           description: Name given to the interface
45639           required: true
45640           type: string
45641           example: __INTERFACE-NAME__
45642         - name: vlan-interface
45643           in: path
45644           description: String that identifies the interface
45645           required: true
45646           type: string
45647           example: __VLAN-INTERFACE__
45648         - name: l3-interface-ipv4-address
45649           in: path
45650           description: IP address
45651           required: true
45652           type: string
45653           example: __L3-INTERFACE-IPV4-ADDRESS__
45654         - name: body
45655           in: body
45656           description: l3-interface-ipv4-address-list object that needs to be created or updated.
45657           required: true
45658           schema:
45659             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45660     delete:
45661       tags:
45662         - Network
45663       summary: delete an existing l3-interface-ipv4-address-list
45664       description: delete an existing l3-interface-ipv4-address-list
45665       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45666       consumes:
45667         - application/json
45668         - application/xml
45669       produces:
45670         - application/json
45671         - application/xml
45672       responses:
45673         "default":
45674           description: Response codes found in [response codes](https://wiki.onap.org/).
45675       parameters:
45676         - name: pnf-name
45677           in: path
45678           description: unique name of Physical Network Function.
45679           required: true
45680           type: string
45681           example: __PNF-NAME__
45682         - name: interface-name
45683           in: path
45684           description: Name that identifies the physical interface
45685           required: true
45686           type: string
45687           example: __INTERFACE-NAME__
45688         - name: interface-name
45689           in: path
45690           description: Name given to the interface
45691           required: true
45692           type: string
45693           example: __INTERFACE-NAME__
45694         - name: vlan-interface
45695           in: path
45696           description: String that identifies the interface
45697           required: true
45698           type: string
45699           example: __VLAN-INTERFACE__
45700         - name: l3-interface-ipv4-address
45701           in: path
45702           description: IP address
45703           required: true
45704           type: string
45705           example: __L3-INTERFACE-IPV4-ADDRESS__
45706         - name: resource-version
45707           in: query
45708           description: resource-version for concurrency
45709           required: true
45710           type: string
45711   /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:
45712     put:
45713       tags:
45714         - Network
45715       summary: see node definition for valid relationships
45716       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45717       consumes:
45718         - application/json
45719         - application/xml
45720       produces:
45721         - application/json
45722         - application/xml
45723       responses:
45724         "default":
45725           description: Response codes found in [response codes](https://wiki.onap.org/).
45726       parameters:
45727         - name: pnf-name
45728           in: path
45729           description: unique name of Physical Network Function.
45730           required: true
45731           type: string
45732           example: __PNF-NAME__
45733         - name: interface-name
45734           in: path
45735           description: Name that identifies the physical interface
45736           required: true
45737           type: string
45738           example: __INTERFACE-NAME__
45739         - name: interface-name
45740           in: path
45741           description: Name given to the interface
45742           required: true
45743           type: string
45744           example: __INTERFACE-NAME__
45745         - name: vlan-interface
45746           in: path
45747           description: String that identifies the interface
45748           required: true
45749           type: string
45750           example: __VLAN-INTERFACE__
45751         - name: l3-interface-ipv6-address
45752           in: path
45753           description: IP address
45754           required: true
45755           type: string
45756           example: __L3-INTERFACE-IPV6-ADDRESS__
45757         - name: body
45758           in: body
45759           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45760           required: true
45761           schema:
45762             $ref: "#/definitions/relationship"
45763     delete:
45764       tags:
45765         - Network
45766       summary: delete an existing relationship
45767       description: delete an existing relationship
45768       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45769       consumes:
45770         - application/json
45771         - application/xml
45772       produces:
45773         - application/json
45774         - application/xml
45775       responses:
45776         "default":
45777           description: Response codes found in [response codes](https://wiki.onap.org/).
45778       parameters:
45779         - name: pnf-name
45780           in: path
45781           description: unique name of Physical Network Function.
45782           required: true
45783           type: string
45784           example: __PNF-NAME__
45785         - name: interface-name
45786           in: path
45787           description: Name that identifies the physical interface
45788           required: true
45789           type: string
45790           example: __INTERFACE-NAME__
45791         - name: interface-name
45792           in: path
45793           description: Name given to the interface
45794           required: true
45795           type: string
45796           example: __INTERFACE-NAME__
45797         - name: vlan-interface
45798           in: path
45799           description: String that identifies the interface
45800           required: true
45801           type: string
45802           example: __VLAN-INTERFACE__
45803         - name: l3-interface-ipv6-address
45804           in: path
45805           description: IP address
45806           required: true
45807           type: string
45808           example: __L3-INTERFACE-IPV6-ADDRESS__
45809   /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}:
45810     get:
45811       tags:
45812         - Network
45813       summary: returns l3-interface-ipv6-address-list
45814       description: returns l3-interface-ipv6-address-list
45815       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45816       produces:
45817         - application/json
45818         - application/xml
45819       responses:
45820         "200":
45821           description: successful operation
45822           schema:
45823               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45824         "default":
45825           description: Response codes found in [response codes](https://wiki.onap.org/).
45826       parameters:
45827         - name: pnf-name
45828           in: path
45829           description: unique name of Physical Network Function.
45830           required: true
45831           type: string
45832           example: __PNF-NAME__
45833         - name: interface-name
45834           in: path
45835           description: Name that identifies the physical interface
45836           required: true
45837           type: string
45838           example: __INTERFACE-NAME__
45839         - name: interface-name
45840           in: path
45841           description: Name given to the interface
45842           required: true
45843           type: string
45844           example: __INTERFACE-NAME__
45845         - name: vlan-interface
45846           in: path
45847           description: String that identifies the interface
45848           required: true
45849           type: string
45850           example: __VLAN-INTERFACE__
45851         - name: l3-interface-ipv6-address
45852           in: path
45853           description: IP address
45854           required: true
45855           type: string
45856           example: __L3-INTERFACE-IPV6-ADDRESS__
45857         - name: inv-status
45858           in: query
45859           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45860           required: false
45861           type: string
45862         - name: prov-status
45863           in: query
45864           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45865           required: false
45866           type: string
45867         - name: interface-id
45868           in: query
45869           description: ID of interface
45870           required: false
45871           type: string
45872         - name: macaddr
45873           in: query
45874           description: MAC address for the interface
45875           required: false
45876           type: string
45877         - name: network-name
45878           in: query
45879           description: Name of the network
45880           required: false
45881           type: string
45882         - name: vlan-id-inner
45883           in: query
45884           description: Inner VLAN tag
45885           required: false
45886           type: integer
45887           format: int64
45888         - name: vpn-key
45889           in: query
45890           description: This indicates the customers VPN ID associated with this vlan
45891           required: false
45892           type: string
45893         - name: vlan-id-inner
45894           in: query
45895           description: Inner VLAN tag
45896           required: false
45897           type: integer
45898           format: int64
45899         - name: neutron-network-id
45900           in: query
45901           description: Neutron network id of the interface that address belongs to
45902           required: false
45903           type: string
45904         - name: neutron-subnet-id
45905           in: query
45906           description: Neutron id of subnet that address belongs to
45907           required: false
45908           type: string
45909     put:
45910       tags:
45911         - Network
45912       summary: create or update an existing l3-interface-ipv6-address-list
45913       description: |
45914         Create or update an existing l3-interface-ipv6-address-list.
45915         #
45916         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45917       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45918       consumes:
45919         - application/json
45920         - application/xml
45921       produces:
45922         - application/json
45923         - application/xml
45924       responses:
45925         "default":
45926           description: Response codes found in [response codes](https://wiki.onap.org/).
45927       parameters:
45928         - name: pnf-name
45929           in: path
45930           description: unique name of Physical Network Function.
45931           required: true
45932           type: string
45933           example: __PNF-NAME__
45934         - name: interface-name
45935           in: path
45936           description: Name that identifies the physical interface
45937           required: true
45938           type: string
45939           example: __INTERFACE-NAME__
45940         - name: interface-name
45941           in: path
45942           description: Name given to the interface
45943           required: true
45944           type: string
45945           example: __INTERFACE-NAME__
45946         - name: vlan-interface
45947           in: path
45948           description: String that identifies the interface
45949           required: true
45950           type: string
45951           example: __VLAN-INTERFACE__
45952         - name: l3-interface-ipv6-address
45953           in: path
45954           description: IP address
45955           required: true
45956           type: string
45957           example: __L3-INTERFACE-IPV6-ADDRESS__
45958         - name: body
45959           in: body
45960           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45961           required: true
45962           schema:
45963             $ref: "#/definitions/l3-interface-ipv6-address-list"
45964     patch:
45965       tags:
45966         - Network
45967       summary: update an existing l3-interface-ipv6-address-list
45968       description: |
45969         Update an existing l3-interface-ipv6-address-list
45970         #
45971         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45972         The PUT operation will entirely replace an existing object.
45973         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45974         #
45975         Other differences between PUT and PATCH are:
45976         #
45977         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45978         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45979         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45980       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45981       consumes:
45982         - application/json
45983         - application/xml
45984       produces:
45985         - application/json
45986         - application/xml
45987       responses:
45988         "default":
45989           description: Response codes found in [response codes](https://wiki.onap.org/).
45990       parameters:
45991         - name: pnf-name
45992           in: path
45993           description: unique name of Physical Network Function.
45994           required: true
45995           type: string
45996           example: __PNF-NAME__
45997         - name: interface-name
45998           in: path
45999           description: Name that identifies the physical interface
46000           required: true
46001           type: string
46002           example: __INTERFACE-NAME__
46003         - name: interface-name
46004           in: path
46005           description: Name given to the interface
46006           required: true
46007           type: string
46008           example: __INTERFACE-NAME__
46009         - name: vlan-interface
46010           in: path
46011           description: String that identifies the interface
46012           required: true
46013           type: string
46014           example: __VLAN-INTERFACE__
46015         - name: l3-interface-ipv6-address
46016           in: path
46017           description: IP address
46018           required: true
46019           type: string
46020           example: __L3-INTERFACE-IPV6-ADDRESS__
46021         - name: body
46022           in: body
46023           description: l3-interface-ipv6-address-list object that needs to be created or updated.
46024           required: true
46025           schema:
46026             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46027     delete:
46028       tags:
46029         - Network
46030       summary: delete an existing l3-interface-ipv6-address-list
46031       description: delete an existing l3-interface-ipv6-address-list
46032       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46033       consumes:
46034         - application/json
46035         - application/xml
46036       produces:
46037         - application/json
46038         - application/xml
46039       responses:
46040         "default":
46041           description: Response codes found in [response codes](https://wiki.onap.org/).
46042       parameters:
46043         - name: pnf-name
46044           in: path
46045           description: unique name of Physical Network Function.
46046           required: true
46047           type: string
46048           example: __PNF-NAME__
46049         - name: interface-name
46050           in: path
46051           description: Name that identifies the physical interface
46052           required: true
46053           type: string
46054           example: __INTERFACE-NAME__
46055         - name: interface-name
46056           in: path
46057           description: Name given to the interface
46058           required: true
46059           type: string
46060           example: __INTERFACE-NAME__
46061         - name: vlan-interface
46062           in: path
46063           description: String that identifies the interface
46064           required: true
46065           type: string
46066           example: __VLAN-INTERFACE__
46067         - name: l3-interface-ipv6-address
46068           in: path
46069           description: IP address
46070           required: true
46071           type: string
46072           example: __L3-INTERFACE-IPV6-ADDRESS__
46073         - name: resource-version
46074           in: query
46075           description: resource-version for concurrency
46076           required: true
46077           type: string
46078   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
46079     get:
46080       tags:
46081         - Network
46082       summary: returns vlan
46083       description: returns vlan
46084       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46085       produces:
46086         - application/json
46087         - application/xml
46088       responses:
46089         "200":
46090           description: successful operation
46091           schema:
46092               $ref: "#/getDefinitions/vlan"
46093         "default":
46094           description: Response codes found in [response codes](https://wiki.onap.org/).
46095       parameters:
46096         - name: pnf-name
46097           in: path
46098           description: unique name of Physical Network Function.
46099           required: true
46100           type: string
46101           example: __PNF-NAME__
46102         - name: interface-name
46103           in: path
46104           description: Name that identifies the physical interface
46105           required: true
46106           type: string
46107           example: __INTERFACE-NAME__
46108         - name: interface-name
46109           in: path
46110           description: Name given to the interface
46111           required: true
46112           type: string
46113           example: __INTERFACE-NAME__
46114         - name: vlan-interface
46115           in: path
46116           description: String that identifies the interface
46117           required: true
46118           type: string
46119           example: __VLAN-INTERFACE__
46120         - name: inv-status
46121           in: query
46122           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46123           required: false
46124           type: string
46125         - name: prov-status
46126           in: query
46127           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46128           required: false
46129           type: string
46130         - name: interface-id
46131           in: query
46132           description: ID of interface
46133           required: false
46134           type: string
46135         - name: macaddr
46136           in: query
46137           description: MAC address for the interface
46138           required: false
46139           type: string
46140         - name: network-name
46141           in: query
46142           description: Name of the network
46143           required: false
46144           type: string
46145         - name: vlan-id-inner
46146           in: query
46147           description: Inner VLAN tag
46148           required: false
46149           type: integer
46150           format: int64
46151         - name: vpn-key
46152           in: query
46153           description: This indicates the customers VPN ID associated with this vlan
46154           required: false
46155           type: string
46156     put:
46157       tags:
46158         - Network
46159       summary: create or update an existing vlan
46160       description: |
46161         Create or update an existing vlan.
46162         #
46163         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46164       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46165       consumes:
46166         - application/json
46167         - application/xml
46168       produces:
46169         - application/json
46170         - application/xml
46171       responses:
46172         "default":
46173           description: Response codes found in [response codes](https://wiki.onap.org/).
46174       parameters:
46175         - name: pnf-name
46176           in: path
46177           description: unique name of Physical Network Function.
46178           required: true
46179           type: string
46180           example: __PNF-NAME__
46181         - name: interface-name
46182           in: path
46183           description: Name that identifies the physical interface
46184           required: true
46185           type: string
46186           example: __INTERFACE-NAME__
46187         - name: interface-name
46188           in: path
46189           description: Name given to the interface
46190           required: true
46191           type: string
46192           example: __INTERFACE-NAME__
46193         - name: vlan-interface
46194           in: path
46195           description: String that identifies the interface
46196           required: true
46197           type: string
46198           example: __VLAN-INTERFACE__
46199         - name: body
46200           in: body
46201           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
46202           required: true
46203           schema:
46204             $ref: "#/definitions/vlan"
46205     patch:
46206       tags:
46207         - Network
46208       summary: update an existing vlan
46209       description: |
46210         Update an existing vlan
46211         #
46212         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46213         The PUT operation will entirely replace an existing object.
46214         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46215         #
46216         Other differences between PUT and PATCH are:
46217         #
46218         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46219         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46220         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46221       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46222       consumes:
46223         - application/json
46224         - application/xml
46225       produces:
46226         - application/json
46227         - application/xml
46228       responses:
46229         "default":
46230           description: Response codes found in [response codes](https://wiki.onap.org/).
46231       parameters:
46232         - name: pnf-name
46233           in: path
46234           description: unique name of Physical Network Function.
46235           required: true
46236           type: string
46237           example: __PNF-NAME__
46238         - name: interface-name
46239           in: path
46240           description: Name that identifies the physical interface
46241           required: true
46242           type: string
46243           example: __INTERFACE-NAME__
46244         - name: interface-name
46245           in: path
46246           description: Name given to the interface
46247           required: true
46248           type: string
46249           example: __INTERFACE-NAME__
46250         - name: vlan-interface
46251           in: path
46252           description: String that identifies the interface
46253           required: true
46254           type: string
46255           example: __VLAN-INTERFACE__
46256         - name: body
46257           in: body
46258           description: vlan object that needs to be created or updated.
46259           required: true
46260           schema:
46261             $ref: "#/patchDefinitions/vlan"
46262     delete:
46263       tags:
46264         - Network
46265       summary: delete an existing vlan
46266       description: delete an existing vlan
46267       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46268       consumes:
46269         - application/json
46270         - application/xml
46271       produces:
46272         - application/json
46273         - application/xml
46274       responses:
46275         "default":
46276           description: Response codes found in [response codes](https://wiki.onap.org/).
46277       parameters:
46278         - name: pnf-name
46279           in: path
46280           description: unique name of Physical Network Function.
46281           required: true
46282           type: string
46283           example: __PNF-NAME__
46284         - name: interface-name
46285           in: path
46286           description: Name that identifies the physical interface
46287           required: true
46288           type: string
46289           example: __INTERFACE-NAME__
46290         - name: interface-name
46291           in: path
46292           description: Name given to the interface
46293           required: true
46294           type: string
46295           example: __INTERFACE-NAME__
46296         - name: vlan-interface
46297           in: path
46298           description: String that identifies the interface
46299           required: true
46300           type: string
46301           example: __VLAN-INTERFACE__
46302         - name: resource-version
46303           in: query
46304           description: resource-version for concurrency
46305           required: true
46306           type: string
46307   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
46308     get:
46309       tags:
46310         - Network
46311       summary: returns vlans
46312       description: returns vlans
46313       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
46314       produces:
46315         - application/json
46316         - application/xml
46317       responses:
46318         "200":
46319           description: successful operation
46320           schema:
46321               $ref: "#/getDefinitions/vlans"
46322         "default":
46323           description: Response codes found in [response codes](https://wiki.onap.org/).
46324       parameters:
46325         - name: pnf-name
46326           in: path
46327           description: unique name of Physical Network Function.
46328           required: true
46329           type: string
46330           example: __PNF-NAME__
46331         - name: interface-name
46332           in: path
46333           description: Name that identifies the physical interface
46334           required: true
46335           type: string
46336           example: __INTERFACE-NAME__
46337         - name: interface-name
46338           in: path
46339           description: Name given to the interface
46340           required: true
46341           type: string
46342           example: __INTERFACE-NAME__
46343         - name: inv-status
46344           in: query
46345           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46346           required: false
46347           type: string
46348         - name: prov-status
46349           in: query
46350           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46351           required: false
46352           type: string
46353         - name: interface-id
46354           in: query
46355           description: ID of interface
46356           required: false
46357           type: string
46358         - name: macaddr
46359           in: query
46360           description: MAC address for the interface
46361           required: false
46362           type: string
46363         - name: network-name
46364           in: query
46365           description: Name of the network
46366           required: false
46367           type: string
46368   /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:
46369     put:
46370       tags:
46371         - Network
46372       summary: see node definition for valid relationships
46373       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46374       consumes:
46375         - application/json
46376         - application/xml
46377       produces:
46378         - application/json
46379         - application/xml
46380       responses:
46381         "default":
46382           description: Response codes found in [response codes](https://wiki.onap.org/).
46383       parameters:
46384         - name: pnf-name
46385           in: path
46386           description: unique name of Physical Network Function.
46387           required: true
46388           type: string
46389           example: __PNF-NAME__
46390         - name: interface-name
46391           in: path
46392           description: Name that identifies the physical interface
46393           required: true
46394           type: string
46395           example: __INTERFACE-NAME__
46396         - name: interface-name
46397           in: path
46398           description: Name given to the interface
46399           required: true
46400           type: string
46401           example: __INTERFACE-NAME__
46402         - name: pci-id
46403           in: path
46404           description: PCI ID used to identify the sriov-vf
46405           required: true
46406           type: string
46407           example: __PCI-ID__
46408         - name: body
46409           in: body
46410           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46411           required: true
46412           schema:
46413             $ref: "#/definitions/relationship"
46414     delete:
46415       tags:
46416         - Network
46417       summary: delete an existing relationship
46418       description: delete an existing relationship
46419       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46420       consumes:
46421         - application/json
46422         - application/xml
46423       produces:
46424         - application/json
46425         - application/xml
46426       responses:
46427         "default":
46428           description: Response codes found in [response codes](https://wiki.onap.org/).
46429       parameters:
46430         - name: pnf-name
46431           in: path
46432           description: unique name of Physical Network Function.
46433           required: true
46434           type: string
46435           example: __PNF-NAME__
46436         - name: interface-name
46437           in: path
46438           description: Name that identifies the physical interface
46439           required: true
46440           type: string
46441           example: __INTERFACE-NAME__
46442         - name: interface-name
46443           in: path
46444           description: Name given to the interface
46445           required: true
46446           type: string
46447           example: __INTERFACE-NAME__
46448         - name: pci-id
46449           in: path
46450           description: PCI ID used to identify the sriov-vf
46451           required: true
46452           type: string
46453           example: __PCI-ID__
46454   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
46455     get:
46456       tags:
46457         - Network
46458       summary: returns sriov-vf
46459       description: returns sriov-vf
46460       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46461       produces:
46462         - application/json
46463         - application/xml
46464       responses:
46465         "200":
46466           description: successful operation
46467           schema:
46468               $ref: "#/getDefinitions/sriov-vf"
46469         "default":
46470           description: Response codes found in [response codes](https://wiki.onap.org/).
46471       parameters:
46472         - name: pnf-name
46473           in: path
46474           description: unique name of Physical Network Function.
46475           required: true
46476           type: string
46477           example: __PNF-NAME__
46478         - name: interface-name
46479           in: path
46480           description: Name that identifies the physical interface
46481           required: true
46482           type: string
46483           example: __INTERFACE-NAME__
46484         - name: interface-name
46485           in: path
46486           description: Name given to the interface
46487           required: true
46488           type: string
46489           example: __INTERFACE-NAME__
46490         - name: pci-id
46491           in: path
46492           description: PCI ID used to identify the sriov-vf
46493           required: true
46494           type: string
46495           example: __PCI-ID__
46496         - name: inv-status
46497           in: query
46498           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46499           required: false
46500           type: string
46501         - name: prov-status
46502           in: query
46503           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46504           required: false
46505           type: string
46506         - name: interface-id
46507           in: query
46508           description: ID of interface
46509           required: false
46510           type: string
46511         - name: macaddr
46512           in: query
46513           description: MAC address for the interface
46514           required: false
46515           type: string
46516         - name: network-name
46517           in: query
46518           description: Name of the network
46519           required: false
46520           type: string
46521         - name: vf-vlan-filter
46522           in: query
46523           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
46524           required: false
46525           type: string
46526         - name: vf-mac-filter
46527           in: query
46528           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
46529           required: false
46530           type: string
46531         - name: vf-vlan-strip
46532           in: query
46533           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
46534           required: false
46535           type: boolean
46536         - name: neutron-network-id
46537           in: query
46538           description: Neutron network id of the interface
46539           required: false
46540           type: string
46541     put:
46542       tags:
46543         - Network
46544       summary: create or update an existing sriov-vf
46545       description: |
46546         Create or update an existing sriov-vf.
46547         #
46548         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46549       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46550       consumes:
46551         - application/json
46552         - application/xml
46553       produces:
46554         - application/json
46555         - application/xml
46556       responses:
46557         "default":
46558           description: Response codes found in [response codes](https://wiki.onap.org/).
46559       parameters:
46560         - name: pnf-name
46561           in: path
46562           description: unique name of Physical Network Function.
46563           required: true
46564           type: string
46565           example: __PNF-NAME__
46566         - name: interface-name
46567           in: path
46568           description: Name that identifies the physical interface
46569           required: true
46570           type: string
46571           example: __INTERFACE-NAME__
46572         - name: interface-name
46573           in: path
46574           description: Name given to the interface
46575           required: true
46576           type: string
46577           example: __INTERFACE-NAME__
46578         - name: pci-id
46579           in: path
46580           description: PCI ID used to identify the sriov-vf
46581           required: true
46582           type: string
46583           example: __PCI-ID__
46584         - name: body
46585           in: body
46586           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46587           required: true
46588           schema:
46589             $ref: "#/definitions/sriov-vf"
46590     patch:
46591       tags:
46592         - Network
46593       summary: update an existing sriov-vf
46594       description: |
46595         Update an existing sriov-vf
46596         #
46597         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46598         The PUT operation will entirely replace an existing object.
46599         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46600         #
46601         Other differences between PUT and PATCH are:
46602         #
46603         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46604         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46605         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46606       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46607       consumes:
46608         - application/json
46609         - application/xml
46610       produces:
46611         - application/json
46612         - application/xml
46613       responses:
46614         "default":
46615           description: Response codes found in [response codes](https://wiki.onap.org/).
46616       parameters:
46617         - name: pnf-name
46618           in: path
46619           description: unique name of Physical Network Function.
46620           required: true
46621           type: string
46622           example: __PNF-NAME__
46623         - name: interface-name
46624           in: path
46625           description: Name that identifies the physical interface
46626           required: true
46627           type: string
46628           example: __INTERFACE-NAME__
46629         - name: interface-name
46630           in: path
46631           description: Name given to the interface
46632           required: true
46633           type: string
46634           example: __INTERFACE-NAME__
46635         - name: pci-id
46636           in: path
46637           description: PCI ID used to identify the sriov-vf
46638           required: true
46639           type: string
46640           example: __PCI-ID__
46641         - name: body
46642           in: body
46643           description: sriov-vf object that needs to be created or updated.
46644           required: true
46645           schema:
46646             $ref: "#/patchDefinitions/sriov-vf"
46647     delete:
46648       tags:
46649         - Network
46650       summary: delete an existing sriov-vf
46651       description: delete an existing sriov-vf
46652       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46653       consumes:
46654         - application/json
46655         - application/xml
46656       produces:
46657         - application/json
46658         - application/xml
46659       responses:
46660         "default":
46661           description: Response codes found in [response codes](https://wiki.onap.org/).
46662       parameters:
46663         - name: pnf-name
46664           in: path
46665           description: unique name of Physical Network Function.
46666           required: true
46667           type: string
46668           example: __PNF-NAME__
46669         - name: interface-name
46670           in: path
46671           description: Name that identifies the physical interface
46672           required: true
46673           type: string
46674           example: __INTERFACE-NAME__
46675         - name: interface-name
46676           in: path
46677           description: Name given to the interface
46678           required: true
46679           type: string
46680           example: __INTERFACE-NAME__
46681         - name: pci-id
46682           in: path
46683           description: PCI ID used to identify the sriov-vf
46684           required: true
46685           type: string
46686           example: __PCI-ID__
46687         - name: resource-version
46688           in: query
46689           description: resource-version for concurrency
46690           required: true
46691           type: string
46692   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
46693     get:
46694       tags:
46695         - Network
46696       summary: returns sriov-vfs
46697       description: returns sriov-vfs
46698       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
46699       produces:
46700         - application/json
46701         - application/xml
46702       responses:
46703         "200":
46704           description: successful operation
46705           schema:
46706               $ref: "#/getDefinitions/sriov-vfs"
46707         "default":
46708           description: Response codes found in [response codes](https://wiki.onap.org/).
46709       parameters:
46710         - name: pnf-name
46711           in: path
46712           description: unique name of Physical Network Function.
46713           required: true
46714           type: string
46715           example: __PNF-NAME__
46716         - name: interface-name
46717           in: path
46718           description: Name that identifies the physical interface
46719           required: true
46720           type: string
46721           example: __INTERFACE-NAME__
46722         - name: interface-name
46723           in: path
46724           description: Name given to the interface
46725           required: true
46726           type: string
46727           example: __INTERFACE-NAME__
46728         - name: inv-status
46729           in: query
46730           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46731           required: false
46732           type: string
46733         - name: prov-status
46734           in: query
46735           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46736           required: false
46737           type: string
46738         - name: interface-id
46739           in: query
46740           description: ID of interface
46741           required: false
46742           type: string
46743         - name: macaddr
46744           in: query
46745           description: MAC address for the interface
46746           required: false
46747           type: string
46748         - name: network-name
46749           in: query
46750           description: Name of the network
46751           required: false
46752           type: string
46753   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
46754     put:
46755       tags:
46756         - Network
46757       summary: see node definition for valid relationships
46758       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46759       consumes:
46760         - application/json
46761         - application/xml
46762       produces:
46763         - application/json
46764         - application/xml
46765       responses:
46766         "default":
46767           description: Response codes found in [response codes](https://wiki.onap.org/).
46768       parameters:
46769         - name: pnf-name
46770           in: path
46771           description: unique name of Physical Network Function.
46772           required: true
46773           type: string
46774           example: __PNF-NAME__
46775         - name: interface-name
46776           in: path
46777           description: Name that identifies the physical interface
46778           required: true
46779           type: string
46780           example: __INTERFACE-NAME__
46781         - name: interface-name
46782           in: path
46783           description: Name given to the interface
46784           required: true
46785           type: string
46786           example: __INTERFACE-NAME__
46787         - name: body
46788           in: body
46789           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
46790           required: true
46791           schema:
46792             $ref: "#/definitions/relationship"
46793     delete:
46794       tags:
46795         - Network
46796       summary: delete an existing relationship
46797       description: delete an existing relationship
46798       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46799       consumes:
46800         - application/json
46801         - application/xml
46802       produces:
46803         - application/json
46804         - application/xml
46805       responses:
46806         "default":
46807           description: Response codes found in [response codes](https://wiki.onap.org/).
46808       parameters:
46809         - name: pnf-name
46810           in: path
46811           description: unique name of Physical Network Function.
46812           required: true
46813           type: string
46814           example: __PNF-NAME__
46815         - name: interface-name
46816           in: path
46817           description: Name that identifies the physical interface
46818           required: true
46819           type: string
46820           example: __INTERFACE-NAME__
46821         - name: interface-name
46822           in: path
46823           description: Name given to the interface
46824           required: true
46825           type: string
46826           example: __INTERFACE-NAME__
46827   /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:
46828     put:
46829       tags:
46830         - Network
46831       summary: see node definition for valid relationships
46832       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46833       consumes:
46834         - application/json
46835         - application/xml
46836       produces:
46837         - application/json
46838         - application/xml
46839       responses:
46840         "default":
46841           description: Response codes found in [response codes](https://wiki.onap.org/).
46842       parameters:
46843         - name: pnf-name
46844           in: path
46845           description: unique name of Physical Network Function.
46846           required: true
46847           type: string
46848           example: __PNF-NAME__
46849         - name: interface-name
46850           in: path
46851           description: Name that identifies the physical interface
46852           required: true
46853           type: string
46854           example: __INTERFACE-NAME__
46855         - name: interface-name
46856           in: path
46857           description: Name given to the interface
46858           required: true
46859           type: string
46860           example: __INTERFACE-NAME__
46861         - name: l3-interface-ipv4-address
46862           in: path
46863           description: IP address
46864           required: true
46865           type: string
46866           example: __L3-INTERFACE-IPV4-ADDRESS__
46867         - name: body
46868           in: body
46869           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46870           required: true
46871           schema:
46872             $ref: "#/definitions/relationship"
46873     delete:
46874       tags:
46875         - Network
46876       summary: delete an existing relationship
46877       description: delete an existing relationship
46878       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46879       consumes:
46880         - application/json
46881         - application/xml
46882       produces:
46883         - application/json
46884         - application/xml
46885       responses:
46886         "default":
46887           description: Response codes found in [response codes](https://wiki.onap.org/).
46888       parameters:
46889         - name: pnf-name
46890           in: path
46891           description: unique name of Physical Network Function.
46892           required: true
46893           type: string
46894           example: __PNF-NAME__
46895         - name: interface-name
46896           in: path
46897           description: Name that identifies the physical interface
46898           required: true
46899           type: string
46900           example: __INTERFACE-NAME__
46901         - name: interface-name
46902           in: path
46903           description: Name given to the interface
46904           required: true
46905           type: string
46906           example: __INTERFACE-NAME__
46907         - name: l3-interface-ipv4-address
46908           in: path
46909           description: IP address
46910           required: true
46911           type: string
46912           example: __L3-INTERFACE-IPV4-ADDRESS__
46913   /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}:
46914     get:
46915       tags:
46916         - Network
46917       summary: returns l3-interface-ipv4-address-list
46918       description: returns l3-interface-ipv4-address-list
46919       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46920       produces:
46921         - application/json
46922         - application/xml
46923       responses:
46924         "200":
46925           description: successful operation
46926           schema:
46927               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46928         "default":
46929           description: Response codes found in [response codes](https://wiki.onap.org/).
46930       parameters:
46931         - name: pnf-name
46932           in: path
46933           description: unique name of Physical Network Function.
46934           required: true
46935           type: string
46936           example: __PNF-NAME__
46937         - name: interface-name
46938           in: path
46939           description: Name that identifies the physical interface
46940           required: true
46941           type: string
46942           example: __INTERFACE-NAME__
46943         - name: interface-name
46944           in: path
46945           description: Name given to the interface
46946           required: true
46947           type: string
46948           example: __INTERFACE-NAME__
46949         - name: l3-interface-ipv4-address
46950           in: path
46951           description: IP address
46952           required: true
46953           type: string
46954           example: __L3-INTERFACE-IPV4-ADDRESS__
46955         - name: inv-status
46956           in: query
46957           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46958           required: false
46959           type: string
46960         - name: prov-status
46961           in: query
46962           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46963           required: false
46964           type: string
46965         - name: interface-id
46966           in: query
46967           description: ID of interface
46968           required: false
46969           type: string
46970         - name: macaddr
46971           in: query
46972           description: MAC address for the interface
46973           required: false
46974           type: string
46975         - name: network-name
46976           in: query
46977           description: Name of the network
46978           required: false
46979           type: string
46980         - name: vlan-id-inner
46981           in: query
46982           description: Inner VLAN tag
46983           required: false
46984           type: integer
46985           format: int64
46986         - name: neutron-network-id
46987           in: query
46988           description: Neutron network id of the interface that address belongs to
46989           required: false
46990           type: string
46991         - name: neutron-subnet-id
46992           in: query
46993           description: Neutron id of subnet that address belongs to
46994           required: false
46995           type: string
46996     put:
46997       tags:
46998         - Network
46999       summary: create or update an existing l3-interface-ipv4-address-list
47000       description: |
47001         Create or update an existing l3-interface-ipv4-address-list.
47002         #
47003         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47004       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47005       consumes:
47006         - application/json
47007         - application/xml
47008       produces:
47009         - application/json
47010         - application/xml
47011       responses:
47012         "default":
47013           description: Response codes found in [response codes](https://wiki.onap.org/).
47014       parameters:
47015         - name: pnf-name
47016           in: path
47017           description: unique name of Physical Network Function.
47018           required: true
47019           type: string
47020           example: __PNF-NAME__
47021         - name: interface-name
47022           in: path
47023           description: Name that identifies the physical interface
47024           required: true
47025           type: string
47026           example: __INTERFACE-NAME__
47027         - name: interface-name
47028           in: path
47029           description: Name given to the interface
47030           required: true
47031           type: string
47032           example: __INTERFACE-NAME__
47033         - name: l3-interface-ipv4-address
47034           in: path
47035           description: IP address
47036           required: true
47037           type: string
47038           example: __L3-INTERFACE-IPV4-ADDRESS__
47039         - name: body
47040           in: body
47041           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
47042           required: true
47043           schema:
47044             $ref: "#/definitions/l3-interface-ipv4-address-list"
47045     patch:
47046       tags:
47047         - Network
47048       summary: update an existing l3-interface-ipv4-address-list
47049       description: |
47050         Update an existing l3-interface-ipv4-address-list
47051         #
47052         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47053         The PUT operation will entirely replace an existing object.
47054         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47055         #
47056         Other differences between PUT and PATCH are:
47057         #
47058         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47059         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47060         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47061       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47062       consumes:
47063         - application/json
47064         - application/xml
47065       produces:
47066         - application/json
47067         - application/xml
47068       responses:
47069         "default":
47070           description: Response codes found in [response codes](https://wiki.onap.org/).
47071       parameters:
47072         - name: pnf-name
47073           in: path
47074           description: unique name of Physical Network Function.
47075           required: true
47076           type: string
47077           example: __PNF-NAME__
47078         - name: interface-name
47079           in: path
47080           description: Name that identifies the physical interface
47081           required: true
47082           type: string
47083           example: __INTERFACE-NAME__
47084         - name: interface-name
47085           in: path
47086           description: Name given to the interface
47087           required: true
47088           type: string
47089           example: __INTERFACE-NAME__
47090         - name: l3-interface-ipv4-address
47091           in: path
47092           description: IP address
47093           required: true
47094           type: string
47095           example: __L3-INTERFACE-IPV4-ADDRESS__
47096         - name: body
47097           in: body
47098           description: l3-interface-ipv4-address-list object that needs to be created or updated.
47099           required: true
47100           schema:
47101             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
47102     delete:
47103       tags:
47104         - Network
47105       summary: delete an existing l3-interface-ipv4-address-list
47106       description: delete an existing l3-interface-ipv4-address-list
47107       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47108       consumes:
47109         - application/json
47110         - application/xml
47111       produces:
47112         - application/json
47113         - application/xml
47114       responses:
47115         "default":
47116           description: Response codes found in [response codes](https://wiki.onap.org/).
47117       parameters:
47118         - name: pnf-name
47119           in: path
47120           description: unique name of Physical Network Function.
47121           required: true
47122           type: string
47123           example: __PNF-NAME__
47124         - name: interface-name
47125           in: path
47126           description: Name that identifies the physical interface
47127           required: true
47128           type: string
47129           example: __INTERFACE-NAME__
47130         - name: interface-name
47131           in: path
47132           description: Name given to the interface
47133           required: true
47134           type: string
47135           example: __INTERFACE-NAME__
47136         - name: l3-interface-ipv4-address
47137           in: path
47138           description: IP address
47139           required: true
47140           type: string
47141           example: __L3-INTERFACE-IPV4-ADDRESS__
47142         - name: resource-version
47143           in: query
47144           description: resource-version for concurrency
47145           required: true
47146           type: string
47147   /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:
47148     put:
47149       tags:
47150         - Network
47151       summary: see node definition for valid relationships
47152       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
47153       consumes:
47154         - application/json
47155         - application/xml
47156       produces:
47157         - application/json
47158         - application/xml
47159       responses:
47160         "default":
47161           description: Response codes found in [response codes](https://wiki.onap.org/).
47162       parameters:
47163         - name: pnf-name
47164           in: path
47165           description: unique name of Physical Network Function.
47166           required: true
47167           type: string
47168           example: __PNF-NAME__
47169         - name: interface-name
47170           in: path
47171           description: Name that identifies the physical interface
47172           required: true
47173           type: string
47174           example: __INTERFACE-NAME__
47175         - name: interface-name
47176           in: path
47177           description: Name given to the interface
47178           required: true
47179           type: string
47180           example: __INTERFACE-NAME__
47181         - name: l3-interface-ipv6-address
47182           in: path
47183           description: IP address
47184           required: true
47185           type: string
47186           example: __L3-INTERFACE-IPV6-ADDRESS__
47187         - name: body
47188           in: body
47189           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47190           required: true
47191           schema:
47192             $ref: "#/definitions/relationship"
47193     delete:
47194       tags:
47195         - Network
47196       summary: delete an existing relationship
47197       description: delete an existing relationship
47198       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
47199       consumes:
47200         - application/json
47201         - application/xml
47202       produces:
47203         - application/json
47204         - application/xml
47205       responses:
47206         "default":
47207           description: Response codes found in [response codes](https://wiki.onap.org/).
47208       parameters:
47209         - name: pnf-name
47210           in: path
47211           description: unique name of Physical Network Function.
47212           required: true
47213           type: string
47214           example: __PNF-NAME__
47215         - name: interface-name
47216           in: path
47217           description: Name that identifies the physical interface
47218           required: true
47219           type: string
47220           example: __INTERFACE-NAME__
47221         - name: interface-name
47222           in: path
47223           description: Name given to the interface
47224           required: true
47225           type: string
47226           example: __INTERFACE-NAME__
47227         - name: l3-interface-ipv6-address
47228           in: path
47229           description: IP address
47230           required: true
47231           type: string
47232           example: __L3-INTERFACE-IPV6-ADDRESS__
47233   /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}:
47234     get:
47235       tags:
47236         - Network
47237       summary: returns l3-interface-ipv6-address-list
47238       description: returns l3-interface-ipv6-address-list
47239       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47240       produces:
47241         - application/json
47242         - application/xml
47243       responses:
47244         "200":
47245           description: successful operation
47246           schema:
47247               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
47248         "default":
47249           description: Response codes found in [response codes](https://wiki.onap.org/).
47250       parameters:
47251         - name: pnf-name
47252           in: path
47253           description: unique name of Physical Network Function.
47254           required: true
47255           type: string
47256           example: __PNF-NAME__
47257         - name: interface-name
47258           in: path
47259           description: Name that identifies the physical interface
47260           required: true
47261           type: string
47262           example: __INTERFACE-NAME__
47263         - name: interface-name
47264           in: path
47265           description: Name given to the interface
47266           required: true
47267           type: string
47268           example: __INTERFACE-NAME__
47269         - name: l3-interface-ipv6-address
47270           in: path
47271           description: IP address
47272           required: true
47273           type: string
47274           example: __L3-INTERFACE-IPV6-ADDRESS__
47275         - name: inv-status
47276           in: query
47277           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47278           required: false
47279           type: string
47280         - name: prov-status
47281           in: query
47282           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47283           required: false
47284           type: string
47285         - name: interface-id
47286           in: query
47287           description: ID of interface
47288           required: false
47289           type: string
47290         - name: macaddr
47291           in: query
47292           description: MAC address for the interface
47293           required: false
47294           type: string
47295         - name: network-name
47296           in: query
47297           description: Name of the network
47298           required: false
47299           type: string
47300         - name: vlan-id-inner
47301           in: query
47302           description: Inner VLAN tag
47303           required: false
47304           type: integer
47305           format: int64
47306         - name: neutron-network-id
47307           in: query
47308           description: Neutron network id of the interface that address belongs to
47309           required: false
47310           type: string
47311         - name: neutron-subnet-id
47312           in: query
47313           description: Neutron id of subnet that address belongs to
47314           required: false
47315           type: string
47316     put:
47317       tags:
47318         - Network
47319       summary: create or update an existing l3-interface-ipv6-address-list
47320       description: |
47321         Create or update an existing l3-interface-ipv6-address-list.
47322         #
47323         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47324       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47325       consumes:
47326         - application/json
47327         - application/xml
47328       produces:
47329         - application/json
47330         - application/xml
47331       responses:
47332         "default":
47333           description: Response codes found in [response codes](https://wiki.onap.org/).
47334       parameters:
47335         - name: pnf-name
47336           in: path
47337           description: unique name of Physical Network Function.
47338           required: true
47339           type: string
47340           example: __PNF-NAME__
47341         - name: interface-name
47342           in: path
47343           description: Name that identifies the physical interface
47344           required: true
47345           type: string
47346           example: __INTERFACE-NAME__
47347         - name: interface-name
47348           in: path
47349           description: Name given to the interface
47350           required: true
47351           type: string
47352           example: __INTERFACE-NAME__
47353         - name: l3-interface-ipv6-address
47354           in: path
47355           description: IP address
47356           required: true
47357           type: string
47358           example: __L3-INTERFACE-IPV6-ADDRESS__
47359         - name: body
47360           in: body
47361           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47362           required: true
47363           schema:
47364             $ref: "#/definitions/l3-interface-ipv6-address-list"
47365     patch:
47366       tags:
47367         - Network
47368       summary: update an existing l3-interface-ipv6-address-list
47369       description: |
47370         Update an existing l3-interface-ipv6-address-list
47371         #
47372         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47373         The PUT operation will entirely replace an existing object.
47374         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47375         #
47376         Other differences between PUT and PATCH are:
47377         #
47378         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47379         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47380         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47381       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47382       consumes:
47383         - application/json
47384         - application/xml
47385       produces:
47386         - application/json
47387         - application/xml
47388       responses:
47389         "default":
47390           description: Response codes found in [response codes](https://wiki.onap.org/).
47391       parameters:
47392         - name: pnf-name
47393           in: path
47394           description: unique name of Physical Network Function.
47395           required: true
47396           type: string
47397           example: __PNF-NAME__
47398         - name: interface-name
47399           in: path
47400           description: Name that identifies the physical interface
47401           required: true
47402           type: string
47403           example: __INTERFACE-NAME__
47404         - name: interface-name
47405           in: path
47406           description: Name given to the interface
47407           required: true
47408           type: string
47409           example: __INTERFACE-NAME__
47410         - name: l3-interface-ipv6-address
47411           in: path
47412           description: IP address
47413           required: true
47414           type: string
47415           example: __L3-INTERFACE-IPV6-ADDRESS__
47416         - name: body
47417           in: body
47418           description: l3-interface-ipv6-address-list object that needs to be created or updated.
47419           required: true
47420           schema:
47421             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
47422     delete:
47423       tags:
47424         - Network
47425       summary: delete an existing l3-interface-ipv6-address-list
47426       description: delete an existing l3-interface-ipv6-address-list
47427       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47428       consumes:
47429         - application/json
47430         - application/xml
47431       produces:
47432         - application/json
47433         - application/xml
47434       responses:
47435         "default":
47436           description: Response codes found in [response codes](https://wiki.onap.org/).
47437       parameters:
47438         - name: pnf-name
47439           in: path
47440           description: unique name of Physical Network Function.
47441           required: true
47442           type: string
47443           example: __PNF-NAME__
47444         - name: interface-name
47445           in: path
47446           description: Name that identifies the physical interface
47447           required: true
47448           type: string
47449           example: __INTERFACE-NAME__
47450         - name: interface-name
47451           in: path
47452           description: Name given to the interface
47453           required: true
47454           type: string
47455           example: __INTERFACE-NAME__
47456         - name: l3-interface-ipv6-address
47457           in: path
47458           description: IP address
47459           required: true
47460           type: string
47461           example: __L3-INTERFACE-IPV6-ADDRESS__
47462         - name: resource-version
47463           in: query
47464           description: resource-version for concurrency
47465           required: true
47466           type: string
47467   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
47468     get:
47469       tags:
47470         - Network
47471       summary: returns l-interface
47472       description: returns l-interface
47473       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47474       produces:
47475         - application/json
47476         - application/xml
47477       responses:
47478         "200":
47479           description: successful operation
47480           schema:
47481               $ref: "#/getDefinitions/l-interface"
47482         "default":
47483           description: Response codes found in [response codes](https://wiki.onap.org/).
47484       parameters:
47485         - name: pnf-name
47486           in: path
47487           description: unique name of Physical Network Function.
47488           required: true
47489           type: string
47490           example: __PNF-NAME__
47491         - name: interface-name
47492           in: path
47493           description: Name that identifies the physical interface
47494           required: true
47495           type: string
47496           example: __INTERFACE-NAME__
47497         - name: interface-name
47498           in: path
47499           description: Name given to the interface
47500           required: true
47501           type: string
47502           example: __INTERFACE-NAME__
47503         - name: inv-status
47504           in: query
47505           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47506           required: false
47507           type: string
47508         - name: prov-status
47509           in: query
47510           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47511           required: false
47512           type: string
47513         - name: interface-id
47514           in: query
47515           description: ID of interface
47516           required: false
47517           type: string
47518         - name: macaddr
47519           in: query
47520           description: MAC address for the interface
47521           required: false
47522           type: string
47523         - name: network-name
47524           in: query
47525           description: Name of the network
47526           required: false
47527           type: string
47528     put:
47529       tags:
47530         - Network
47531       summary: create or update an existing l-interface
47532       description: |
47533         Create or update an existing l-interface.
47534         #
47535         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47536       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47537       consumes:
47538         - application/json
47539         - application/xml
47540       produces:
47541         - application/json
47542         - application/xml
47543       responses:
47544         "default":
47545           description: Response codes found in [response codes](https://wiki.onap.org/).
47546       parameters:
47547         - name: pnf-name
47548           in: path
47549           description: unique name of Physical Network Function.
47550           required: true
47551           type: string
47552           example: __PNF-NAME__
47553         - name: interface-name
47554           in: path
47555           description: Name that identifies the physical interface
47556           required: true
47557           type: string
47558           example: __INTERFACE-NAME__
47559         - name: interface-name
47560           in: path
47561           description: Name given to the interface
47562           required: true
47563           type: string
47564           example: __INTERFACE-NAME__
47565         - name: body
47566           in: body
47567           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
47568           required: true
47569           schema:
47570             $ref: "#/definitions/l-interface"
47571     patch:
47572       tags:
47573         - Network
47574       summary: update an existing l-interface
47575       description: |
47576         Update an existing l-interface
47577         #
47578         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47579         The PUT operation will entirely replace an existing object.
47580         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47581         #
47582         Other differences between PUT and PATCH are:
47583         #
47584         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47585         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47586         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47587       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47588       consumes:
47589         - application/json
47590         - application/xml
47591       produces:
47592         - application/json
47593         - application/xml
47594       responses:
47595         "default":
47596           description: Response codes found in [response codes](https://wiki.onap.org/).
47597       parameters:
47598         - name: pnf-name
47599           in: path
47600           description: unique name of Physical Network Function.
47601           required: true
47602           type: string
47603           example: __PNF-NAME__
47604         - name: interface-name
47605           in: path
47606           description: Name that identifies the physical interface
47607           required: true
47608           type: string
47609           example: __INTERFACE-NAME__
47610         - name: interface-name
47611           in: path
47612           description: Name given to the interface
47613           required: true
47614           type: string
47615           example: __INTERFACE-NAME__
47616         - name: body
47617           in: body
47618           description: l-interface object that needs to be created or updated.
47619           required: true
47620           schema:
47621             $ref: "#/patchDefinitions/l-interface"
47622     delete:
47623       tags:
47624         - Network
47625       summary: delete an existing l-interface
47626       description: delete an existing l-interface
47627       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47628       consumes:
47629         - application/json
47630         - application/xml
47631       produces:
47632         - application/json
47633         - application/xml
47634       responses:
47635         "default":
47636           description: Response codes found in [response codes](https://wiki.onap.org/).
47637       parameters:
47638         - name: pnf-name
47639           in: path
47640           description: unique name of Physical Network Function.
47641           required: true
47642           type: string
47643           example: __PNF-NAME__
47644         - name: interface-name
47645           in: path
47646           description: Name that identifies the physical interface
47647           required: true
47648           type: string
47649           example: __INTERFACE-NAME__
47650         - name: interface-name
47651           in: path
47652           description: Name given to the interface
47653           required: true
47654           type: string
47655           example: __INTERFACE-NAME__
47656         - name: resource-version
47657           in: query
47658           description: resource-version for concurrency
47659           required: true
47660           type: string
47661   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
47662     get:
47663       tags:
47664         - Network
47665       summary: returns l-interfaces
47666       description: returns l-interfaces
47667       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
47668       produces:
47669         - application/json
47670         - application/xml
47671       responses:
47672         "200":
47673           description: successful operation
47674           schema:
47675               $ref: "#/getDefinitions/l-interfaces"
47676         "default":
47677           description: Response codes found in [response codes](https://wiki.onap.org/).
47678       parameters:
47679         - name: pnf-name
47680           in: path
47681           description: unique name of Physical Network Function.
47682           required: true
47683           type: string
47684           example: __PNF-NAME__
47685         - name: interface-name
47686           in: path
47687           description: Name that identifies the physical interface
47688           required: true
47689           type: string
47690           example: __INTERFACE-NAME__
47691         - name: inv-status
47692           in: query
47693           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47694           required: false
47695           type: string
47696         - name: prov-status
47697           in: query
47698           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47699           required: false
47700           type: string
47701   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
47702     get:
47703       tags:
47704         - Network
47705       summary: returns p-interface
47706       description: returns p-interface
47707       operationId: getNetworkPnfsPnfPInterfacesPInterface
47708       produces:
47709         - application/json
47710         - application/xml
47711       responses:
47712         "200":
47713           description: successful operation
47714           schema:
47715               $ref: "#/getDefinitions/p-interface"
47716         "default":
47717           description: Response codes found in [response codes](https://wiki.onap.org/).
47718       parameters:
47719         - name: pnf-name
47720           in: path
47721           description: unique name of Physical Network Function.
47722           required: true
47723           type: string
47724           example: __PNF-NAME__
47725         - name: interface-name
47726           in: path
47727           description: Name that identifies the physical interface
47728           required: true
47729           type: string
47730           example: __INTERFACE-NAME__
47731         - name: inv-status
47732           in: query
47733           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47734           required: false
47735           type: string
47736         - name: prov-status
47737           in: query
47738           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47739           required: false
47740           type: string
47741     put:
47742       tags:
47743         - Network
47744       summary: create or update an existing p-interface
47745       description: |
47746         Create or update an existing p-interface.
47747         #
47748         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47749       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
47750       consumes:
47751         - application/json
47752         - application/xml
47753       produces:
47754         - application/json
47755         - application/xml
47756       responses:
47757         "default":
47758           description: Response codes found in [response codes](https://wiki.onap.org/).
47759       parameters:
47760         - name: pnf-name
47761           in: path
47762           description: unique name of Physical Network Function.
47763           required: true
47764           type: string
47765           example: __PNF-NAME__
47766         - name: interface-name
47767           in: path
47768           description: Name that identifies the physical interface
47769           required: true
47770           type: string
47771           example: __INTERFACE-NAME__
47772         - name: body
47773           in: body
47774           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
47775           required: true
47776           schema:
47777             $ref: "#/definitions/p-interface"
47778     patch:
47779       tags:
47780         - Network
47781       summary: update an existing p-interface
47782       description: |
47783         Update an existing p-interface
47784         #
47785         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47786         The PUT operation will entirely replace an existing object.
47787         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47788         #
47789         Other differences between PUT and PATCH are:
47790         #
47791         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47792         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47793         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47794       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
47795       consumes:
47796         - application/json
47797         - application/xml
47798       produces:
47799         - application/json
47800         - application/xml
47801       responses:
47802         "default":
47803           description: Response codes found in [response codes](https://wiki.onap.org/).
47804       parameters:
47805         - name: pnf-name
47806           in: path
47807           description: unique name of Physical Network Function.
47808           required: true
47809           type: string
47810           example: __PNF-NAME__
47811         - name: interface-name
47812           in: path
47813           description: Name that identifies the physical interface
47814           required: true
47815           type: string
47816           example: __INTERFACE-NAME__
47817         - name: body
47818           in: body
47819           description: p-interface object that needs to be created or updated.
47820           required: true
47821           schema:
47822             $ref: "#/patchDefinitions/p-interface"
47823     delete:
47824       tags:
47825         - Network
47826       summary: delete an existing p-interface
47827       description: delete an existing p-interface
47828       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
47829       consumes:
47830         - application/json
47831         - application/xml
47832       produces:
47833         - application/json
47834         - application/xml
47835       responses:
47836         "default":
47837           description: Response codes found in [response codes](https://wiki.onap.org/).
47838       parameters:
47839         - name: pnf-name
47840           in: path
47841           description: unique name of Physical Network Function.
47842           required: true
47843           type: string
47844           example: __PNF-NAME__
47845         - name: interface-name
47846           in: path
47847           description: Name that identifies the physical interface
47848           required: true
47849           type: string
47850           example: __INTERFACE-NAME__
47851         - name: resource-version
47852           in: query
47853           description: resource-version for concurrency
47854           required: true
47855           type: string
47856   /network/pnfs/pnf/{pnf-name}/p-interfaces:
47857     get:
47858       tags:
47859         - Network
47860       summary: returns p-interfaces
47861       description: returns p-interfaces
47862       operationId: getNetworkPnfsPnfPInterfaces
47863       produces:
47864         - application/json
47865         - application/xml
47866       responses:
47867         "200":
47868           description: successful operation
47869           schema:
47870               $ref: "#/getDefinitions/p-interfaces"
47871         "default":
47872           description: Response codes found in [response codes](https://wiki.onap.org/).
47873       parameters:
47874         - name: pnf-name
47875           in: path
47876           description: unique name of Physical Network Function.
47877           required: true
47878           type: string
47879           example: __PNF-NAME__
47880         - name: inv-status
47881           in: query
47882           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47883           required: false
47884           type: string
47885   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
47886     put:
47887       tags:
47888         - Network
47889       summary: see node definition for valid relationships
47890       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47891       consumes:
47892         - application/json
47893         - application/xml
47894       produces:
47895         - application/json
47896         - application/xml
47897       responses:
47898         "default":
47899           description: Response codes found in [response codes](https://wiki.onap.org/).
47900       parameters:
47901         - name: pnf-name
47902           in: path
47903           description: unique name of Physical Network Function.
47904           required: true
47905           type: string
47906           example: __PNF-NAME__
47907         - name: interface-name
47908           in: path
47909           description: Name that identifies the link aggregate interface
47910           required: true
47911           type: string
47912           example: __INTERFACE-NAME__
47913         - name: body
47914           in: body
47915           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
47916           required: true
47917           schema:
47918             $ref: "#/definitions/relationship"
47919     delete:
47920       tags:
47921         - Network
47922       summary: delete an existing relationship
47923       description: delete an existing relationship
47924       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47925       consumes:
47926         - application/json
47927         - application/xml
47928       produces:
47929         - application/json
47930         - application/xml
47931       responses:
47932         "default":
47933           description: Response codes found in [response codes](https://wiki.onap.org/).
47934       parameters:
47935         - name: pnf-name
47936           in: path
47937           description: unique name of Physical Network Function.
47938           required: true
47939           type: string
47940           example: __PNF-NAME__
47941         - name: interface-name
47942           in: path
47943           description: Name that identifies the link aggregate interface
47944           required: true
47945           type: string
47946           example: __INTERFACE-NAME__
47947   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
47948     put:
47949       tags:
47950         - Network
47951       summary: see node definition for valid relationships
47952       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
47953       consumes:
47954         - application/json
47955         - application/xml
47956       produces:
47957         - application/json
47958         - application/xml
47959       responses:
47960         "default":
47961           description: Response codes found in [response codes](https://wiki.onap.org/).
47962       parameters:
47963         - name: pnf-name
47964           in: path
47965           description: unique name of Physical Network Function.
47966           required: true
47967           type: string
47968           example: __PNF-NAME__
47969         - name: interface-name
47970           in: path
47971           description: Name that identifies the link aggregate interface
47972           required: true
47973           type: string
47974           example: __INTERFACE-NAME__
47975         - name: interface-name
47976           in: path
47977           description: Name given to the interface
47978           required: true
47979           type: string
47980           example: __INTERFACE-NAME__
47981         - name: vlan-interface
47982           in: path
47983           description: String that identifies the interface
47984           required: true
47985           type: string
47986           example: __VLAN-INTERFACE__
47987         - name: body
47988           in: body
47989           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
47990           required: true
47991           schema:
47992             $ref: "#/definitions/relationship"
47993     delete:
47994       tags:
47995         - Network
47996       summary: delete an existing relationship
47997       description: delete an existing relationship
47998       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
47999       consumes:
48000         - application/json
48001         - application/xml
48002       produces:
48003         - application/json
48004         - application/xml
48005       responses:
48006         "default":
48007           description: Response codes found in [response codes](https://wiki.onap.org/).
48008       parameters:
48009         - name: pnf-name
48010           in: path
48011           description: unique name of Physical Network Function.
48012           required: true
48013           type: string
48014           example: __PNF-NAME__
48015         - name: interface-name
48016           in: path
48017           description: Name that identifies the link aggregate interface
48018           required: true
48019           type: string
48020           example: __INTERFACE-NAME__
48021         - name: interface-name
48022           in: path
48023           description: Name given to the interface
48024           required: true
48025           type: string
48026           example: __INTERFACE-NAME__
48027         - name: vlan-interface
48028           in: path
48029           description: String that identifies the interface
48030           required: true
48031           type: string
48032           example: __VLAN-INTERFACE__
48033   /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:
48034     put:
48035       tags:
48036         - Network
48037       summary: see node definition for valid relationships
48038       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48039       consumes:
48040         - application/json
48041         - application/xml
48042       produces:
48043         - application/json
48044         - application/xml
48045       responses:
48046         "default":
48047           description: Response codes found in [response codes](https://wiki.onap.org/).
48048       parameters:
48049         - name: pnf-name
48050           in: path
48051           description: unique name of Physical Network Function.
48052           required: true
48053           type: string
48054           example: __PNF-NAME__
48055         - name: interface-name
48056           in: path
48057           description: Name that identifies the link aggregate interface
48058           required: true
48059           type: string
48060           example: __INTERFACE-NAME__
48061         - name: interface-name
48062           in: path
48063           description: Name given to the interface
48064           required: true
48065           type: string
48066           example: __INTERFACE-NAME__
48067         - name: vlan-interface
48068           in: path
48069           description: String that identifies the interface
48070           required: true
48071           type: string
48072           example: __VLAN-INTERFACE__
48073         - name: l3-interface-ipv4-address
48074           in: path
48075           description: IP address
48076           required: true
48077           type: string
48078           example: __L3-INTERFACE-IPV4-ADDRESS__
48079         - name: body
48080           in: body
48081           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48082           required: true
48083           schema:
48084             $ref: "#/definitions/relationship"
48085     delete:
48086       tags:
48087         - Network
48088       summary: delete an existing relationship
48089       description: delete an existing relationship
48090       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48091       consumes:
48092         - application/json
48093         - application/xml
48094       produces:
48095         - application/json
48096         - application/xml
48097       responses:
48098         "default":
48099           description: Response codes found in [response codes](https://wiki.onap.org/).
48100       parameters:
48101         - name: pnf-name
48102           in: path
48103           description: unique name of Physical Network Function.
48104           required: true
48105           type: string
48106           example: __PNF-NAME__
48107         - name: interface-name
48108           in: path
48109           description: Name that identifies the link aggregate interface
48110           required: true
48111           type: string
48112           example: __INTERFACE-NAME__
48113         - name: interface-name
48114           in: path
48115           description: Name given to the interface
48116           required: true
48117           type: string
48118           example: __INTERFACE-NAME__
48119         - name: vlan-interface
48120           in: path
48121           description: String that identifies the interface
48122           required: true
48123           type: string
48124           example: __VLAN-INTERFACE__
48125         - name: l3-interface-ipv4-address
48126           in: path
48127           description: IP address
48128           required: true
48129           type: string
48130           example: __L3-INTERFACE-IPV4-ADDRESS__
48131   /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}:
48132     get:
48133       tags:
48134         - Network
48135       summary: returns l3-interface-ipv4-address-list
48136       description: returns l3-interface-ipv4-address-list
48137       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48138       produces:
48139         - application/json
48140         - application/xml
48141       responses:
48142         "200":
48143           description: successful operation
48144           schema:
48145               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
48146         "default":
48147           description: Response codes found in [response codes](https://wiki.onap.org/).
48148       parameters:
48149         - name: pnf-name
48150           in: path
48151           description: unique name of Physical Network Function.
48152           required: true
48153           type: string
48154           example: __PNF-NAME__
48155         - name: interface-name
48156           in: path
48157           description: Name that identifies the link aggregate interface
48158           required: true
48159           type: string
48160           example: __INTERFACE-NAME__
48161         - name: interface-name
48162           in: path
48163           description: Name given to the interface
48164           required: true
48165           type: string
48166           example: __INTERFACE-NAME__
48167         - name: vlan-interface
48168           in: path
48169           description: String that identifies the interface
48170           required: true
48171           type: string
48172           example: __VLAN-INTERFACE__
48173         - name: l3-interface-ipv4-address
48174           in: path
48175           description: IP address
48176           required: true
48177           type: string
48178           example: __L3-INTERFACE-IPV4-ADDRESS__
48179         - name: inv-status
48180           in: query
48181           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48182           required: false
48183           type: string
48184         - name: interface-id
48185           in: query
48186           description: ID of interface
48187           required: false
48188           type: string
48189         - name: interface-role
48190           in: query
48191           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48192           required: false
48193           type: string
48194         - name: interface-id
48195           in: query
48196           description: ID of interface
48197           required: false
48198           type: string
48199         - name: macaddr
48200           in: query
48201           description: MAC address for the interface
48202           required: false
48203           type: string
48204         - name: network-name
48205           in: query
48206           description: Name of the network
48207           required: false
48208           type: string
48209         - name: vlan-id-inner
48210           in: query
48211           description: Inner VLAN tag
48212           required: false
48213           type: integer
48214           format: int64
48215         - name: vpn-key
48216           in: query
48217           description: This indicates the customers VPN ID associated with this vlan
48218           required: false
48219           type: string
48220         - name: vlan-id-inner
48221           in: query
48222           description: Inner VLAN tag
48223           required: false
48224           type: integer
48225           format: int64
48226         - name: neutron-network-id
48227           in: query
48228           description: Neutron network id of the interface that address belongs to
48229           required: false
48230           type: string
48231         - name: neutron-subnet-id
48232           in: query
48233           description: Neutron id of subnet that address belongs to
48234           required: false
48235           type: string
48236     put:
48237       tags:
48238         - Network
48239       summary: create or update an existing l3-interface-ipv4-address-list
48240       description: |
48241         Create or update an existing l3-interface-ipv4-address-list.
48242         #
48243         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48244       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48245       consumes:
48246         - application/json
48247         - application/xml
48248       produces:
48249         - application/json
48250         - application/xml
48251       responses:
48252         "default":
48253           description: Response codes found in [response codes](https://wiki.onap.org/).
48254       parameters:
48255         - name: pnf-name
48256           in: path
48257           description: unique name of Physical Network Function.
48258           required: true
48259           type: string
48260           example: __PNF-NAME__
48261         - name: interface-name
48262           in: path
48263           description: Name that identifies the link aggregate interface
48264           required: true
48265           type: string
48266           example: __INTERFACE-NAME__
48267         - name: interface-name
48268           in: path
48269           description: Name given to the interface
48270           required: true
48271           type: string
48272           example: __INTERFACE-NAME__
48273         - name: vlan-interface
48274           in: path
48275           description: String that identifies the interface
48276           required: true
48277           type: string
48278           example: __VLAN-INTERFACE__
48279         - name: l3-interface-ipv4-address
48280           in: path
48281           description: IP address
48282           required: true
48283           type: string
48284           example: __L3-INTERFACE-IPV4-ADDRESS__
48285         - name: body
48286           in: body
48287           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48288           required: true
48289           schema:
48290             $ref: "#/definitions/l3-interface-ipv4-address-list"
48291     patch:
48292       tags:
48293         - Network
48294       summary: update an existing l3-interface-ipv4-address-list
48295       description: |
48296         Update an existing l3-interface-ipv4-address-list
48297         #
48298         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48299         The PUT operation will entirely replace an existing object.
48300         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48301         #
48302         Other differences between PUT and PATCH are:
48303         #
48304         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48305         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48306         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48307       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48308       consumes:
48309         - application/json
48310         - application/xml
48311       produces:
48312         - application/json
48313         - application/xml
48314       responses:
48315         "default":
48316           description: Response codes found in [response codes](https://wiki.onap.org/).
48317       parameters:
48318         - name: pnf-name
48319           in: path
48320           description: unique name of Physical Network Function.
48321           required: true
48322           type: string
48323           example: __PNF-NAME__
48324         - name: interface-name
48325           in: path
48326           description: Name that identifies the link aggregate interface
48327           required: true
48328           type: string
48329           example: __INTERFACE-NAME__
48330         - name: interface-name
48331           in: path
48332           description: Name given to the interface
48333           required: true
48334           type: string
48335           example: __INTERFACE-NAME__
48336         - name: vlan-interface
48337           in: path
48338           description: String that identifies the interface
48339           required: true
48340           type: string
48341           example: __VLAN-INTERFACE__
48342         - name: l3-interface-ipv4-address
48343           in: path
48344           description: IP address
48345           required: true
48346           type: string
48347           example: __L3-INTERFACE-IPV4-ADDRESS__
48348         - name: body
48349           in: body
48350           description: l3-interface-ipv4-address-list object that needs to be created or updated.
48351           required: true
48352           schema:
48353             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
48354     delete:
48355       tags:
48356         - Network
48357       summary: delete an existing l3-interface-ipv4-address-list
48358       description: delete an existing l3-interface-ipv4-address-list
48359       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48360       consumes:
48361         - application/json
48362         - application/xml
48363       produces:
48364         - application/json
48365         - application/xml
48366       responses:
48367         "default":
48368           description: Response codes found in [response codes](https://wiki.onap.org/).
48369       parameters:
48370         - name: pnf-name
48371           in: path
48372           description: unique name of Physical Network Function.
48373           required: true
48374           type: string
48375           example: __PNF-NAME__
48376         - name: interface-name
48377           in: path
48378           description: Name that identifies the link aggregate interface
48379           required: true
48380           type: string
48381           example: __INTERFACE-NAME__
48382         - name: interface-name
48383           in: path
48384           description: Name given to the interface
48385           required: true
48386           type: string
48387           example: __INTERFACE-NAME__
48388         - name: vlan-interface
48389           in: path
48390           description: String that identifies the interface
48391           required: true
48392           type: string
48393           example: __VLAN-INTERFACE__
48394         - name: l3-interface-ipv4-address
48395           in: path
48396           description: IP address
48397           required: true
48398           type: string
48399           example: __L3-INTERFACE-IPV4-ADDRESS__
48400         - name: resource-version
48401           in: query
48402           description: resource-version for concurrency
48403           required: true
48404           type: string
48405   /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:
48406     put:
48407       tags:
48408         - Network
48409       summary: see node definition for valid relationships
48410       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48411       consumes:
48412         - application/json
48413         - application/xml
48414       produces:
48415         - application/json
48416         - application/xml
48417       responses:
48418         "default":
48419           description: Response codes found in [response codes](https://wiki.onap.org/).
48420       parameters:
48421         - name: pnf-name
48422           in: path
48423           description: unique name of Physical Network Function.
48424           required: true
48425           type: string
48426           example: __PNF-NAME__
48427         - name: interface-name
48428           in: path
48429           description: Name that identifies the link aggregate interface
48430           required: true
48431           type: string
48432           example: __INTERFACE-NAME__
48433         - name: interface-name
48434           in: path
48435           description: Name given to the interface
48436           required: true
48437           type: string
48438           example: __INTERFACE-NAME__
48439         - name: vlan-interface
48440           in: path
48441           description: String that identifies the interface
48442           required: true
48443           type: string
48444           example: __VLAN-INTERFACE__
48445         - name: l3-interface-ipv6-address
48446           in: path
48447           description: IP address
48448           required: true
48449           type: string
48450           example: __L3-INTERFACE-IPV6-ADDRESS__
48451         - name: body
48452           in: body
48453           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48454           required: true
48455           schema:
48456             $ref: "#/definitions/relationship"
48457     delete:
48458       tags:
48459         - Network
48460       summary: delete an existing relationship
48461       description: delete an existing relationship
48462       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48463       consumes:
48464         - application/json
48465         - application/xml
48466       produces:
48467         - application/json
48468         - application/xml
48469       responses:
48470         "default":
48471           description: Response codes found in [response codes](https://wiki.onap.org/).
48472       parameters:
48473         - name: pnf-name
48474           in: path
48475           description: unique name of Physical Network Function.
48476           required: true
48477           type: string
48478           example: __PNF-NAME__
48479         - name: interface-name
48480           in: path
48481           description: Name that identifies the link aggregate interface
48482           required: true
48483           type: string
48484           example: __INTERFACE-NAME__
48485         - name: interface-name
48486           in: path
48487           description: Name given to the interface
48488           required: true
48489           type: string
48490           example: __INTERFACE-NAME__
48491         - name: vlan-interface
48492           in: path
48493           description: String that identifies the interface
48494           required: true
48495           type: string
48496           example: __VLAN-INTERFACE__
48497         - name: l3-interface-ipv6-address
48498           in: path
48499           description: IP address
48500           required: true
48501           type: string
48502           example: __L3-INTERFACE-IPV6-ADDRESS__
48503   /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}:
48504     get:
48505       tags:
48506         - Network
48507       summary: returns l3-interface-ipv6-address-list
48508       description: returns l3-interface-ipv6-address-list
48509       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48510       produces:
48511         - application/json
48512         - application/xml
48513       responses:
48514         "200":
48515           description: successful operation
48516           schema:
48517               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
48518         "default":
48519           description: Response codes found in [response codes](https://wiki.onap.org/).
48520       parameters:
48521         - name: pnf-name
48522           in: path
48523           description: unique name of Physical Network Function.
48524           required: true
48525           type: string
48526           example: __PNF-NAME__
48527         - name: interface-name
48528           in: path
48529           description: Name that identifies the link aggregate interface
48530           required: true
48531           type: string
48532           example: __INTERFACE-NAME__
48533         - name: interface-name
48534           in: path
48535           description: Name given to the interface
48536           required: true
48537           type: string
48538           example: __INTERFACE-NAME__
48539         - name: vlan-interface
48540           in: path
48541           description: String that identifies the interface
48542           required: true
48543           type: string
48544           example: __VLAN-INTERFACE__
48545         - name: l3-interface-ipv6-address
48546           in: path
48547           description: IP address
48548           required: true
48549           type: string
48550           example: __L3-INTERFACE-IPV6-ADDRESS__
48551         - name: inv-status
48552           in: query
48553           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48554           required: false
48555           type: string
48556         - name: interface-id
48557           in: query
48558           description: ID of interface
48559           required: false
48560           type: string
48561         - name: interface-role
48562           in: query
48563           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48564           required: false
48565           type: string
48566         - name: interface-id
48567           in: query
48568           description: ID of interface
48569           required: false
48570           type: string
48571         - name: macaddr
48572           in: query
48573           description: MAC address for the interface
48574           required: false
48575           type: string
48576         - name: network-name
48577           in: query
48578           description: Name of the network
48579           required: false
48580           type: string
48581         - name: vlan-id-inner
48582           in: query
48583           description: Inner VLAN tag
48584           required: false
48585           type: integer
48586           format: int64
48587         - name: vpn-key
48588           in: query
48589           description: This indicates the customers VPN ID associated with this vlan
48590           required: false
48591           type: string
48592         - name: vlan-id-inner
48593           in: query
48594           description: Inner VLAN tag
48595           required: false
48596           type: integer
48597           format: int64
48598         - name: neutron-network-id
48599           in: query
48600           description: Neutron network id of the interface that address belongs to
48601           required: false
48602           type: string
48603         - name: neutron-subnet-id
48604           in: query
48605           description: Neutron id of subnet that address belongs to
48606           required: false
48607           type: string
48608     put:
48609       tags:
48610         - Network
48611       summary: create or update an existing l3-interface-ipv6-address-list
48612       description: |
48613         Create or update an existing l3-interface-ipv6-address-list.
48614         #
48615         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48616       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48617       consumes:
48618         - application/json
48619         - application/xml
48620       produces:
48621         - application/json
48622         - application/xml
48623       responses:
48624         "default":
48625           description: Response codes found in [response codes](https://wiki.onap.org/).
48626       parameters:
48627         - name: pnf-name
48628           in: path
48629           description: unique name of Physical Network Function.
48630           required: true
48631           type: string
48632           example: __PNF-NAME__
48633         - name: interface-name
48634           in: path
48635           description: Name that identifies the link aggregate interface
48636           required: true
48637           type: string
48638           example: __INTERFACE-NAME__
48639         - name: interface-name
48640           in: path
48641           description: Name given to the interface
48642           required: true
48643           type: string
48644           example: __INTERFACE-NAME__
48645         - name: vlan-interface
48646           in: path
48647           description: String that identifies the interface
48648           required: true
48649           type: string
48650           example: __VLAN-INTERFACE__
48651         - name: l3-interface-ipv6-address
48652           in: path
48653           description: IP address
48654           required: true
48655           type: string
48656           example: __L3-INTERFACE-IPV6-ADDRESS__
48657         - name: body
48658           in: body
48659           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48660           required: true
48661           schema:
48662             $ref: "#/definitions/l3-interface-ipv6-address-list"
48663     patch:
48664       tags:
48665         - Network
48666       summary: update an existing l3-interface-ipv6-address-list
48667       description: |
48668         Update an existing l3-interface-ipv6-address-list
48669         #
48670         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48671         The PUT operation will entirely replace an existing object.
48672         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48673         #
48674         Other differences between PUT and PATCH are:
48675         #
48676         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48677         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48678         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48679       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48680       consumes:
48681         - application/json
48682         - application/xml
48683       produces:
48684         - application/json
48685         - application/xml
48686       responses:
48687         "default":
48688           description: Response codes found in [response codes](https://wiki.onap.org/).
48689       parameters:
48690         - name: pnf-name
48691           in: path
48692           description: unique name of Physical Network Function.
48693           required: true
48694           type: string
48695           example: __PNF-NAME__
48696         - name: interface-name
48697           in: path
48698           description: Name that identifies the link aggregate interface
48699           required: true
48700           type: string
48701           example: __INTERFACE-NAME__
48702         - name: interface-name
48703           in: path
48704           description: Name given to the interface
48705           required: true
48706           type: string
48707           example: __INTERFACE-NAME__
48708         - name: vlan-interface
48709           in: path
48710           description: String that identifies the interface
48711           required: true
48712           type: string
48713           example: __VLAN-INTERFACE__
48714         - name: l3-interface-ipv6-address
48715           in: path
48716           description: IP address
48717           required: true
48718           type: string
48719           example: __L3-INTERFACE-IPV6-ADDRESS__
48720         - name: body
48721           in: body
48722           description: l3-interface-ipv6-address-list object that needs to be created or updated.
48723           required: true
48724           schema:
48725             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
48726     delete:
48727       tags:
48728         - Network
48729       summary: delete an existing l3-interface-ipv6-address-list
48730       description: delete an existing l3-interface-ipv6-address-list
48731       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48732       consumes:
48733         - application/json
48734         - application/xml
48735       produces:
48736         - application/json
48737         - application/xml
48738       responses:
48739         "default":
48740           description: Response codes found in [response codes](https://wiki.onap.org/).
48741       parameters:
48742         - name: pnf-name
48743           in: path
48744           description: unique name of Physical Network Function.
48745           required: true
48746           type: string
48747           example: __PNF-NAME__
48748         - name: interface-name
48749           in: path
48750           description: Name that identifies the link aggregate interface
48751           required: true
48752           type: string
48753           example: __INTERFACE-NAME__
48754         - name: interface-name
48755           in: path
48756           description: Name given to the interface
48757           required: true
48758           type: string
48759           example: __INTERFACE-NAME__
48760         - name: vlan-interface
48761           in: path
48762           description: String that identifies the interface
48763           required: true
48764           type: string
48765           example: __VLAN-INTERFACE__
48766         - name: l3-interface-ipv6-address
48767           in: path
48768           description: IP address
48769           required: true
48770           type: string
48771           example: __L3-INTERFACE-IPV6-ADDRESS__
48772         - name: resource-version
48773           in: query
48774           description: resource-version for concurrency
48775           required: true
48776           type: string
48777   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
48778     get:
48779       tags:
48780         - Network
48781       summary: returns vlan
48782       description: returns vlan
48783       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48784       produces:
48785         - application/json
48786         - application/xml
48787       responses:
48788         "200":
48789           description: successful operation
48790           schema:
48791               $ref: "#/getDefinitions/vlan"
48792         "default":
48793           description: Response codes found in [response codes](https://wiki.onap.org/).
48794       parameters:
48795         - name: pnf-name
48796           in: path
48797           description: unique name of Physical Network Function.
48798           required: true
48799           type: string
48800           example: __PNF-NAME__
48801         - name: interface-name
48802           in: path
48803           description: Name that identifies the link aggregate interface
48804           required: true
48805           type: string
48806           example: __INTERFACE-NAME__
48807         - name: interface-name
48808           in: path
48809           description: Name given to the interface
48810           required: true
48811           type: string
48812           example: __INTERFACE-NAME__
48813         - name: vlan-interface
48814           in: path
48815           description: String that identifies the interface
48816           required: true
48817           type: string
48818           example: __VLAN-INTERFACE__
48819         - name: inv-status
48820           in: query
48821           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48822           required: false
48823           type: string
48824         - name: interface-id
48825           in: query
48826           description: ID of interface
48827           required: false
48828           type: string
48829         - name: interface-role
48830           in: query
48831           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48832           required: false
48833           type: string
48834         - name: interface-id
48835           in: query
48836           description: ID of interface
48837           required: false
48838           type: string
48839         - name: macaddr
48840           in: query
48841           description: MAC address for the interface
48842           required: false
48843           type: string
48844         - name: network-name
48845           in: query
48846           description: Name of the network
48847           required: false
48848           type: string
48849         - name: vlan-id-inner
48850           in: query
48851           description: Inner VLAN tag
48852           required: false
48853           type: integer
48854           format: int64
48855         - name: vpn-key
48856           in: query
48857           description: This indicates the customers VPN ID associated with this vlan
48858           required: false
48859           type: string
48860     put:
48861       tags:
48862         - Network
48863       summary: create or update an existing vlan
48864       description: |
48865         Create or update an existing vlan.
48866         #
48867         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48868       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48869       consumes:
48870         - application/json
48871         - application/xml
48872       produces:
48873         - application/json
48874         - application/xml
48875       responses:
48876         "default":
48877           description: Response codes found in [response codes](https://wiki.onap.org/).
48878       parameters:
48879         - name: pnf-name
48880           in: path
48881           description: unique name of Physical Network Function.
48882           required: true
48883           type: string
48884           example: __PNF-NAME__
48885         - name: interface-name
48886           in: path
48887           description: Name that identifies the link aggregate interface
48888           required: true
48889           type: string
48890           example: __INTERFACE-NAME__
48891         - name: interface-name
48892           in: path
48893           description: Name given to the interface
48894           required: true
48895           type: string
48896           example: __INTERFACE-NAME__
48897         - name: vlan-interface
48898           in: path
48899           description: String that identifies the interface
48900           required: true
48901           type: string
48902           example: __VLAN-INTERFACE__
48903         - name: body
48904           in: body
48905           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48906           required: true
48907           schema:
48908             $ref: "#/definitions/vlan"
48909     patch:
48910       tags:
48911         - Network
48912       summary: update an existing vlan
48913       description: |
48914         Update an existing vlan
48915         #
48916         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48917         The PUT operation will entirely replace an existing object.
48918         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48919         #
48920         Other differences between PUT and PATCH are:
48921         #
48922         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48923         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48924         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48925       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48926       consumes:
48927         - application/json
48928         - application/xml
48929       produces:
48930         - application/json
48931         - application/xml
48932       responses:
48933         "default":
48934           description: Response codes found in [response codes](https://wiki.onap.org/).
48935       parameters:
48936         - name: pnf-name
48937           in: path
48938           description: unique name of Physical Network Function.
48939           required: true
48940           type: string
48941           example: __PNF-NAME__
48942         - name: interface-name
48943           in: path
48944           description: Name that identifies the link aggregate interface
48945           required: true
48946           type: string
48947           example: __INTERFACE-NAME__
48948         - name: interface-name
48949           in: path
48950           description: Name given to the interface
48951           required: true
48952           type: string
48953           example: __INTERFACE-NAME__
48954         - name: vlan-interface
48955           in: path
48956           description: String that identifies the interface
48957           required: true
48958           type: string
48959           example: __VLAN-INTERFACE__
48960         - name: body
48961           in: body
48962           description: vlan object that needs to be created or updated.
48963           required: true
48964           schema:
48965             $ref: "#/patchDefinitions/vlan"
48966     delete:
48967       tags:
48968         - Network
48969       summary: delete an existing vlan
48970       description: delete an existing vlan
48971       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48972       consumes:
48973         - application/json
48974         - application/xml
48975       produces:
48976         - application/json
48977         - application/xml
48978       responses:
48979         "default":
48980           description: Response codes found in [response codes](https://wiki.onap.org/).
48981       parameters:
48982         - name: pnf-name
48983           in: path
48984           description: unique name of Physical Network Function.
48985           required: true
48986           type: string
48987           example: __PNF-NAME__
48988         - name: interface-name
48989           in: path
48990           description: Name that identifies the link aggregate interface
48991           required: true
48992           type: string
48993           example: __INTERFACE-NAME__
48994         - name: interface-name
48995           in: path
48996           description: Name given to the interface
48997           required: true
48998           type: string
48999           example: __INTERFACE-NAME__
49000         - name: vlan-interface
49001           in: path
49002           description: String that identifies the interface
49003           required: true
49004           type: string
49005           example: __VLAN-INTERFACE__
49006         - name: resource-version
49007           in: query
49008           description: resource-version for concurrency
49009           required: true
49010           type: string
49011   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
49012     get:
49013       tags:
49014         - Network
49015       summary: returns vlans
49016       description: returns vlans
49017       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
49018       produces:
49019         - application/json
49020         - application/xml
49021       responses:
49022         "200":
49023           description: successful operation
49024           schema:
49025               $ref: "#/getDefinitions/vlans"
49026         "default":
49027           description: Response codes found in [response codes](https://wiki.onap.org/).
49028       parameters:
49029         - name: pnf-name
49030           in: path
49031           description: unique name of Physical Network Function.
49032           required: true
49033           type: string
49034           example: __PNF-NAME__
49035         - name: interface-name
49036           in: path
49037           description: Name that identifies the link aggregate interface
49038           required: true
49039           type: string
49040           example: __INTERFACE-NAME__
49041         - name: interface-name
49042           in: path
49043           description: Name given to the interface
49044           required: true
49045           type: string
49046           example: __INTERFACE-NAME__
49047         - name: inv-status
49048           in: query
49049           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49050           required: false
49051           type: string
49052         - name: interface-id
49053           in: query
49054           description: ID of interface
49055           required: false
49056           type: string
49057         - name: interface-role
49058           in: query
49059           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49060           required: false
49061           type: string
49062         - name: interface-id
49063           in: query
49064           description: ID of interface
49065           required: false
49066           type: string
49067         - name: macaddr
49068           in: query
49069           description: MAC address for the interface
49070           required: false
49071           type: string
49072         - name: network-name
49073           in: query
49074           description: Name of the network
49075           required: false
49076           type: string
49077   /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:
49078     put:
49079       tags:
49080         - Network
49081       summary: see node definition for valid relationships
49082       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49083       consumes:
49084         - application/json
49085         - application/xml
49086       produces:
49087         - application/json
49088         - application/xml
49089       responses:
49090         "default":
49091           description: Response codes found in [response codes](https://wiki.onap.org/).
49092       parameters:
49093         - name: pnf-name
49094           in: path
49095           description: unique name of Physical Network Function.
49096           required: true
49097           type: string
49098           example: __PNF-NAME__
49099         - name: interface-name
49100           in: path
49101           description: Name that identifies the link aggregate interface
49102           required: true
49103           type: string
49104           example: __INTERFACE-NAME__
49105         - name: interface-name
49106           in: path
49107           description: Name given to the interface
49108           required: true
49109           type: string
49110           example: __INTERFACE-NAME__
49111         - name: pci-id
49112           in: path
49113           description: PCI ID used to identify the sriov-vf
49114           required: true
49115           type: string
49116           example: __PCI-ID__
49117         - name: body
49118           in: body
49119           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49120           required: true
49121           schema:
49122             $ref: "#/definitions/relationship"
49123     delete:
49124       tags:
49125         - Network
49126       summary: delete an existing relationship
49127       description: delete an existing relationship
49128       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49129       consumes:
49130         - application/json
49131         - application/xml
49132       produces:
49133         - application/json
49134         - application/xml
49135       responses:
49136         "default":
49137           description: Response codes found in [response codes](https://wiki.onap.org/).
49138       parameters:
49139         - name: pnf-name
49140           in: path
49141           description: unique name of Physical Network Function.
49142           required: true
49143           type: string
49144           example: __PNF-NAME__
49145         - name: interface-name
49146           in: path
49147           description: Name that identifies the link aggregate interface
49148           required: true
49149           type: string
49150           example: __INTERFACE-NAME__
49151         - name: interface-name
49152           in: path
49153           description: Name given to the interface
49154           required: true
49155           type: string
49156           example: __INTERFACE-NAME__
49157         - name: pci-id
49158           in: path
49159           description: PCI ID used to identify the sriov-vf
49160           required: true
49161           type: string
49162           example: __PCI-ID__
49163   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
49164     get:
49165       tags:
49166         - Network
49167       summary: returns sriov-vf
49168       description: returns sriov-vf
49169       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49170       produces:
49171         - application/json
49172         - application/xml
49173       responses:
49174         "200":
49175           description: successful operation
49176           schema:
49177               $ref: "#/getDefinitions/sriov-vf"
49178         "default":
49179           description: Response codes found in [response codes](https://wiki.onap.org/).
49180       parameters:
49181         - name: pnf-name
49182           in: path
49183           description: unique name of Physical Network Function.
49184           required: true
49185           type: string
49186           example: __PNF-NAME__
49187         - name: interface-name
49188           in: path
49189           description: Name that identifies the link aggregate interface
49190           required: true
49191           type: string
49192           example: __INTERFACE-NAME__
49193         - name: interface-name
49194           in: path
49195           description: Name given to the interface
49196           required: true
49197           type: string
49198           example: __INTERFACE-NAME__
49199         - name: pci-id
49200           in: path
49201           description: PCI ID used to identify the sriov-vf
49202           required: true
49203           type: string
49204           example: __PCI-ID__
49205         - name: inv-status
49206           in: query
49207           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49208           required: false
49209           type: string
49210         - name: interface-id
49211           in: query
49212           description: ID of interface
49213           required: false
49214           type: string
49215         - name: interface-role
49216           in: query
49217           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49218           required: false
49219           type: string
49220         - name: interface-id
49221           in: query
49222           description: ID of interface
49223           required: false
49224           type: string
49225         - name: macaddr
49226           in: query
49227           description: MAC address for the interface
49228           required: false
49229           type: string
49230         - name: network-name
49231           in: query
49232           description: Name of the network
49233           required: false
49234           type: string
49235         - name: vf-vlan-filter
49236           in: query
49237           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49238           required: false
49239           type: string
49240         - name: vf-mac-filter
49241           in: query
49242           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49243           required: false
49244           type: string
49245         - name: vf-vlan-strip
49246           in: query
49247           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49248           required: false
49249           type: boolean
49250         - name: neutron-network-id
49251           in: query
49252           description: Neutron network id of the interface
49253           required: false
49254           type: string
49255     put:
49256       tags:
49257         - Network
49258       summary: create or update an existing sriov-vf
49259       description: |
49260         Create or update an existing sriov-vf.
49261         #
49262         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49263       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49264       consumes:
49265         - application/json
49266         - application/xml
49267       produces:
49268         - application/json
49269         - application/xml
49270       responses:
49271         "default":
49272           description: Response codes found in [response codes](https://wiki.onap.org/).
49273       parameters:
49274         - name: pnf-name
49275           in: path
49276           description: unique name of Physical Network Function.
49277           required: true
49278           type: string
49279           example: __PNF-NAME__
49280         - name: interface-name
49281           in: path
49282           description: Name that identifies the link aggregate interface
49283           required: true
49284           type: string
49285           example: __INTERFACE-NAME__
49286         - name: interface-name
49287           in: path
49288           description: Name given to the interface
49289           required: true
49290           type: string
49291           example: __INTERFACE-NAME__
49292         - name: pci-id
49293           in: path
49294           description: PCI ID used to identify the sriov-vf
49295           required: true
49296           type: string
49297           example: __PCI-ID__
49298         - name: body
49299           in: body
49300           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49301           required: true
49302           schema:
49303             $ref: "#/definitions/sriov-vf"
49304     patch:
49305       tags:
49306         - Network
49307       summary: update an existing sriov-vf
49308       description: |
49309         Update an existing sriov-vf
49310         #
49311         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49312         The PUT operation will entirely replace an existing object.
49313         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49314         #
49315         Other differences between PUT and PATCH are:
49316         #
49317         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49318         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49319         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49320       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49321       consumes:
49322         - application/json
49323         - application/xml
49324       produces:
49325         - application/json
49326         - application/xml
49327       responses:
49328         "default":
49329           description: Response codes found in [response codes](https://wiki.onap.org/).
49330       parameters:
49331         - name: pnf-name
49332           in: path
49333           description: unique name of Physical Network Function.
49334           required: true
49335           type: string
49336           example: __PNF-NAME__
49337         - name: interface-name
49338           in: path
49339           description: Name that identifies the link aggregate interface
49340           required: true
49341           type: string
49342           example: __INTERFACE-NAME__
49343         - name: interface-name
49344           in: path
49345           description: Name given to the interface
49346           required: true
49347           type: string
49348           example: __INTERFACE-NAME__
49349         - name: pci-id
49350           in: path
49351           description: PCI ID used to identify the sriov-vf
49352           required: true
49353           type: string
49354           example: __PCI-ID__
49355         - name: body
49356           in: body
49357           description: sriov-vf object that needs to be created or updated.
49358           required: true
49359           schema:
49360             $ref: "#/patchDefinitions/sriov-vf"
49361     delete:
49362       tags:
49363         - Network
49364       summary: delete an existing sriov-vf
49365       description: delete an existing sriov-vf
49366       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49367       consumes:
49368         - application/json
49369         - application/xml
49370       produces:
49371         - application/json
49372         - application/xml
49373       responses:
49374         "default":
49375           description: Response codes found in [response codes](https://wiki.onap.org/).
49376       parameters:
49377         - name: pnf-name
49378           in: path
49379           description: unique name of Physical Network Function.
49380           required: true
49381           type: string
49382           example: __PNF-NAME__
49383         - name: interface-name
49384           in: path
49385           description: Name that identifies the link aggregate interface
49386           required: true
49387           type: string
49388           example: __INTERFACE-NAME__
49389         - name: interface-name
49390           in: path
49391           description: Name given to the interface
49392           required: true
49393           type: string
49394           example: __INTERFACE-NAME__
49395         - name: pci-id
49396           in: path
49397           description: PCI ID used to identify the sriov-vf
49398           required: true
49399           type: string
49400           example: __PCI-ID__
49401         - name: resource-version
49402           in: query
49403           description: resource-version for concurrency
49404           required: true
49405           type: string
49406   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
49407     get:
49408       tags:
49409         - Network
49410       summary: returns sriov-vfs
49411       description: returns sriov-vfs
49412       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
49413       produces:
49414         - application/json
49415         - application/xml
49416       responses:
49417         "200":
49418           description: successful operation
49419           schema:
49420               $ref: "#/getDefinitions/sriov-vfs"
49421         "default":
49422           description: Response codes found in [response codes](https://wiki.onap.org/).
49423       parameters:
49424         - name: pnf-name
49425           in: path
49426           description: unique name of Physical Network Function.
49427           required: true
49428           type: string
49429           example: __PNF-NAME__
49430         - name: interface-name
49431           in: path
49432           description: Name that identifies the link aggregate interface
49433           required: true
49434           type: string
49435           example: __INTERFACE-NAME__
49436         - name: interface-name
49437           in: path
49438           description: Name given to the interface
49439           required: true
49440           type: string
49441           example: __INTERFACE-NAME__
49442         - name: inv-status
49443           in: query
49444           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49445           required: false
49446           type: string
49447         - name: interface-id
49448           in: query
49449           description: ID of interface
49450           required: false
49451           type: string
49452         - name: interface-role
49453           in: query
49454           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49455           required: false
49456           type: string
49457         - name: interface-id
49458           in: query
49459           description: ID of interface
49460           required: false
49461           type: string
49462         - name: macaddr
49463           in: query
49464           description: MAC address for the interface
49465           required: false
49466           type: string
49467         - name: network-name
49468           in: query
49469           description: Name of the network
49470           required: false
49471           type: string
49472   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
49473     put:
49474       tags:
49475         - Network
49476       summary: see node definition for valid relationships
49477       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49478       consumes:
49479         - application/json
49480         - application/xml
49481       produces:
49482         - application/json
49483         - application/xml
49484       responses:
49485         "default":
49486           description: Response codes found in [response codes](https://wiki.onap.org/).
49487       parameters:
49488         - name: pnf-name
49489           in: path
49490           description: unique name of Physical Network Function.
49491           required: true
49492           type: string
49493           example: __PNF-NAME__
49494         - name: interface-name
49495           in: path
49496           description: Name that identifies the link aggregate interface
49497           required: true
49498           type: string
49499           example: __INTERFACE-NAME__
49500         - name: interface-name
49501           in: path
49502           description: Name given to the interface
49503           required: true
49504           type: string
49505           example: __INTERFACE-NAME__
49506         - name: body
49507           in: body
49508           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
49509           required: true
49510           schema:
49511             $ref: "#/definitions/relationship"
49512     delete:
49513       tags:
49514         - Network
49515       summary: delete an existing relationship
49516       description: delete an existing relationship
49517       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49518       consumes:
49519         - application/json
49520         - application/xml
49521       produces:
49522         - application/json
49523         - application/xml
49524       responses:
49525         "default":
49526           description: Response codes found in [response codes](https://wiki.onap.org/).
49527       parameters:
49528         - name: pnf-name
49529           in: path
49530           description: unique name of Physical Network Function.
49531           required: true
49532           type: string
49533           example: __PNF-NAME__
49534         - name: interface-name
49535           in: path
49536           description: Name that identifies the link aggregate interface
49537           required: true
49538           type: string
49539           example: __INTERFACE-NAME__
49540         - name: interface-name
49541           in: path
49542           description: Name given to the interface
49543           required: true
49544           type: string
49545           example: __INTERFACE-NAME__
49546   /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:
49547     put:
49548       tags:
49549         - Network
49550       summary: see node definition for valid relationships
49551       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49552       consumes:
49553         - application/json
49554         - application/xml
49555       produces:
49556         - application/json
49557         - application/xml
49558       responses:
49559         "default":
49560           description: Response codes found in [response codes](https://wiki.onap.org/).
49561       parameters:
49562         - name: pnf-name
49563           in: path
49564           description: unique name of Physical Network Function.
49565           required: true
49566           type: string
49567           example: __PNF-NAME__
49568         - name: interface-name
49569           in: path
49570           description: Name that identifies the link aggregate interface
49571           required: true
49572           type: string
49573           example: __INTERFACE-NAME__
49574         - name: interface-name
49575           in: path
49576           description: Name given to the interface
49577           required: true
49578           type: string
49579           example: __INTERFACE-NAME__
49580         - name: l3-interface-ipv4-address
49581           in: path
49582           description: IP address
49583           required: true
49584           type: string
49585           example: __L3-INTERFACE-IPV4-ADDRESS__
49586         - name: body
49587           in: body
49588           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49589           required: true
49590           schema:
49591             $ref: "#/definitions/relationship"
49592     delete:
49593       tags:
49594         - Network
49595       summary: delete an existing relationship
49596       description: delete an existing relationship
49597       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49598       consumes:
49599         - application/json
49600         - application/xml
49601       produces:
49602         - application/json
49603         - application/xml
49604       responses:
49605         "default":
49606           description: Response codes found in [response codes](https://wiki.onap.org/).
49607       parameters:
49608         - name: pnf-name
49609           in: path
49610           description: unique name of Physical Network Function.
49611           required: true
49612           type: string
49613           example: __PNF-NAME__
49614         - name: interface-name
49615           in: path
49616           description: Name that identifies the link aggregate interface
49617           required: true
49618           type: string
49619           example: __INTERFACE-NAME__
49620         - name: interface-name
49621           in: path
49622           description: Name given to the interface
49623           required: true
49624           type: string
49625           example: __INTERFACE-NAME__
49626         - name: l3-interface-ipv4-address
49627           in: path
49628           description: IP address
49629           required: true
49630           type: string
49631           example: __L3-INTERFACE-IPV4-ADDRESS__
49632   /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}:
49633     get:
49634       tags:
49635         - Network
49636       summary: returns l3-interface-ipv4-address-list
49637       description: returns l3-interface-ipv4-address-list
49638       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49639       produces:
49640         - application/json
49641         - application/xml
49642       responses:
49643         "200":
49644           description: successful operation
49645           schema:
49646               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49647         "default":
49648           description: Response codes found in [response codes](https://wiki.onap.org/).
49649       parameters:
49650         - name: pnf-name
49651           in: path
49652           description: unique name of Physical Network Function.
49653           required: true
49654           type: string
49655           example: __PNF-NAME__
49656         - name: interface-name
49657           in: path
49658           description: Name that identifies the link aggregate interface
49659           required: true
49660           type: string
49661           example: __INTERFACE-NAME__
49662         - name: interface-name
49663           in: path
49664           description: Name given to the interface
49665           required: true
49666           type: string
49667           example: __INTERFACE-NAME__
49668         - name: l3-interface-ipv4-address
49669           in: path
49670           description: IP address
49671           required: true
49672           type: string
49673           example: __L3-INTERFACE-IPV4-ADDRESS__
49674         - name: inv-status
49675           in: query
49676           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49677           required: false
49678           type: string
49679         - name: interface-id
49680           in: query
49681           description: ID of interface
49682           required: false
49683           type: string
49684         - name: interface-role
49685           in: query
49686           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49687           required: false
49688           type: string
49689         - name: interface-id
49690           in: query
49691           description: ID of interface
49692           required: false
49693           type: string
49694         - name: macaddr
49695           in: query
49696           description: MAC address for the interface
49697           required: false
49698           type: string
49699         - name: network-name
49700           in: query
49701           description: Name of the network
49702           required: false
49703           type: string
49704         - name: vlan-id-inner
49705           in: query
49706           description: Inner VLAN tag
49707           required: false
49708           type: integer
49709           format: int64
49710         - name: neutron-network-id
49711           in: query
49712           description: Neutron network id of the interface that address belongs to
49713           required: false
49714           type: string
49715         - name: neutron-subnet-id
49716           in: query
49717           description: Neutron id of subnet that address belongs to
49718           required: false
49719           type: string
49720     put:
49721       tags:
49722         - Network
49723       summary: create or update an existing l3-interface-ipv4-address-list
49724       description: |
49725         Create or update an existing l3-interface-ipv4-address-list.
49726         #
49727         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49728       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49729       consumes:
49730         - application/json
49731         - application/xml
49732       produces:
49733         - application/json
49734         - application/xml
49735       responses:
49736         "default":
49737           description: Response codes found in [response codes](https://wiki.onap.org/).
49738       parameters:
49739         - name: pnf-name
49740           in: path
49741           description: unique name of Physical Network Function.
49742           required: true
49743           type: string
49744           example: __PNF-NAME__
49745         - name: interface-name
49746           in: path
49747           description: Name that identifies the link aggregate interface
49748           required: true
49749           type: string
49750           example: __INTERFACE-NAME__
49751         - name: interface-name
49752           in: path
49753           description: Name given to the interface
49754           required: true
49755           type: string
49756           example: __INTERFACE-NAME__
49757         - name: l3-interface-ipv4-address
49758           in: path
49759           description: IP address
49760           required: true
49761           type: string
49762           example: __L3-INTERFACE-IPV4-ADDRESS__
49763         - name: body
49764           in: body
49765           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49766           required: true
49767           schema:
49768             $ref: "#/definitions/l3-interface-ipv4-address-list"
49769     patch:
49770       tags:
49771         - Network
49772       summary: update an existing l3-interface-ipv4-address-list
49773       description: |
49774         Update an existing l3-interface-ipv4-address-list
49775         #
49776         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49777         The PUT operation will entirely replace an existing object.
49778         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49779         #
49780         Other differences between PUT and PATCH are:
49781         #
49782         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49783         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49784         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49785       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49786       consumes:
49787         - application/json
49788         - application/xml
49789       produces:
49790         - application/json
49791         - application/xml
49792       responses:
49793         "default":
49794           description: Response codes found in [response codes](https://wiki.onap.org/).
49795       parameters:
49796         - name: pnf-name
49797           in: path
49798           description: unique name of Physical Network Function.
49799           required: true
49800           type: string
49801           example: __PNF-NAME__
49802         - name: interface-name
49803           in: path
49804           description: Name that identifies the link aggregate interface
49805           required: true
49806           type: string
49807           example: __INTERFACE-NAME__
49808         - name: interface-name
49809           in: path
49810           description: Name given to the interface
49811           required: true
49812           type: string
49813           example: __INTERFACE-NAME__
49814         - name: l3-interface-ipv4-address
49815           in: path
49816           description: IP address
49817           required: true
49818           type: string
49819           example: __L3-INTERFACE-IPV4-ADDRESS__
49820         - name: body
49821           in: body
49822           description: l3-interface-ipv4-address-list object that needs to be created or updated.
49823           required: true
49824           schema:
49825             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
49826     delete:
49827       tags:
49828         - Network
49829       summary: delete an existing l3-interface-ipv4-address-list
49830       description: delete an existing l3-interface-ipv4-address-list
49831       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49832       consumes:
49833         - application/json
49834         - application/xml
49835       produces:
49836         - application/json
49837         - application/xml
49838       responses:
49839         "default":
49840           description: Response codes found in [response codes](https://wiki.onap.org/).
49841       parameters:
49842         - name: pnf-name
49843           in: path
49844           description: unique name of Physical Network Function.
49845           required: true
49846           type: string
49847           example: __PNF-NAME__
49848         - name: interface-name
49849           in: path
49850           description: Name that identifies the link aggregate interface
49851           required: true
49852           type: string
49853           example: __INTERFACE-NAME__
49854         - name: interface-name
49855           in: path
49856           description: Name given to the interface
49857           required: true
49858           type: string
49859           example: __INTERFACE-NAME__
49860         - name: l3-interface-ipv4-address
49861           in: path
49862           description: IP address
49863           required: true
49864           type: string
49865           example: __L3-INTERFACE-IPV4-ADDRESS__
49866         - name: resource-version
49867           in: query
49868           description: resource-version for concurrency
49869           required: true
49870           type: string
49871   /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:
49872     put:
49873       tags:
49874         - Network
49875       summary: see node definition for valid relationships
49876       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49877       consumes:
49878         - application/json
49879         - application/xml
49880       produces:
49881         - application/json
49882         - application/xml
49883       responses:
49884         "default":
49885           description: Response codes found in [response codes](https://wiki.onap.org/).
49886       parameters:
49887         - name: pnf-name
49888           in: path
49889           description: unique name of Physical Network Function.
49890           required: true
49891           type: string
49892           example: __PNF-NAME__
49893         - name: interface-name
49894           in: path
49895           description: Name that identifies the link aggregate interface
49896           required: true
49897           type: string
49898           example: __INTERFACE-NAME__
49899         - name: interface-name
49900           in: path
49901           description: Name given to the interface
49902           required: true
49903           type: string
49904           example: __INTERFACE-NAME__
49905         - name: l3-interface-ipv6-address
49906           in: path
49907           description: IP address
49908           required: true
49909           type: string
49910           example: __L3-INTERFACE-IPV6-ADDRESS__
49911         - name: body
49912           in: body
49913           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
49914           required: true
49915           schema:
49916             $ref: "#/definitions/relationship"
49917     delete:
49918       tags:
49919         - Network
49920       summary: delete an existing relationship
49921       description: delete an existing relationship
49922       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49923       consumes:
49924         - application/json
49925         - application/xml
49926       produces:
49927         - application/json
49928         - application/xml
49929       responses:
49930         "default":
49931           description: Response codes found in [response codes](https://wiki.onap.org/).
49932       parameters:
49933         - name: pnf-name
49934           in: path
49935           description: unique name of Physical Network Function.
49936           required: true
49937           type: string
49938           example: __PNF-NAME__
49939         - name: interface-name
49940           in: path
49941           description: Name that identifies the link aggregate interface
49942           required: true
49943           type: string
49944           example: __INTERFACE-NAME__
49945         - name: interface-name
49946           in: path
49947           description: Name given to the interface
49948           required: true
49949           type: string
49950           example: __INTERFACE-NAME__
49951         - name: l3-interface-ipv6-address
49952           in: path
49953           description: IP address
49954           required: true
49955           type: string
49956           example: __L3-INTERFACE-IPV6-ADDRESS__
49957   /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}:
49958     get:
49959       tags:
49960         - Network
49961       summary: returns l3-interface-ipv6-address-list
49962       description: returns l3-interface-ipv6-address-list
49963       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
49964       produces:
49965         - application/json
49966         - application/xml
49967       responses:
49968         "200":
49969           description: successful operation
49970           schema:
49971               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
49972         "default":
49973           description: Response codes found in [response codes](https://wiki.onap.org/).
49974       parameters:
49975         - name: pnf-name
49976           in: path
49977           description: unique name of Physical Network Function.
49978           required: true
49979           type: string
49980           example: __PNF-NAME__
49981         - name: interface-name
49982           in: path
49983           description: Name that identifies the link aggregate interface
49984           required: true
49985           type: string
49986           example: __INTERFACE-NAME__
49987         - name: interface-name
49988           in: path
49989           description: Name given to the interface
49990           required: true
49991           type: string
49992           example: __INTERFACE-NAME__
49993         - name: l3-interface-ipv6-address
49994           in: path
49995           description: IP address
49996           required: true
49997           type: string
49998           example: __L3-INTERFACE-IPV6-ADDRESS__
49999         - name: inv-status
50000           in: query
50001           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50002           required: false
50003           type: string
50004         - name: interface-id
50005           in: query
50006           description: ID of interface
50007           required: false
50008           type: string
50009         - name: interface-role
50010           in: query
50011           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50012           required: false
50013           type: string
50014         - name: interface-id
50015           in: query
50016           description: ID of interface
50017           required: false
50018           type: string
50019         - name: macaddr
50020           in: query
50021           description: MAC address for the interface
50022           required: false
50023           type: string
50024         - name: network-name
50025           in: query
50026           description: Name of the network
50027           required: false
50028           type: string
50029         - name: vlan-id-inner
50030           in: query
50031           description: Inner VLAN tag
50032           required: false
50033           type: integer
50034           format: int64
50035         - name: neutron-network-id
50036           in: query
50037           description: Neutron network id of the interface that address belongs to
50038           required: false
50039           type: string
50040         - name: neutron-subnet-id
50041           in: query
50042           description: Neutron id of subnet that address belongs to
50043           required: false
50044           type: string
50045     put:
50046       tags:
50047         - Network
50048       summary: create or update an existing l3-interface-ipv6-address-list
50049       description: |
50050         Create or update an existing l3-interface-ipv6-address-list.
50051         #
50052         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50053       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50054       consumes:
50055         - application/json
50056         - application/xml
50057       produces:
50058         - application/json
50059         - application/xml
50060       responses:
50061         "default":
50062           description: Response codes found in [response codes](https://wiki.onap.org/).
50063       parameters:
50064         - name: pnf-name
50065           in: path
50066           description: unique name of Physical Network Function.
50067           required: true
50068           type: string
50069           example: __PNF-NAME__
50070         - name: interface-name
50071           in: path
50072           description: Name that identifies the link aggregate interface
50073           required: true
50074           type: string
50075           example: __INTERFACE-NAME__
50076         - name: interface-name
50077           in: path
50078           description: Name given to the interface
50079           required: true
50080           type: string
50081           example: __INTERFACE-NAME__
50082         - name: l3-interface-ipv6-address
50083           in: path
50084           description: IP address
50085           required: true
50086           type: string
50087           example: __L3-INTERFACE-IPV6-ADDRESS__
50088         - name: body
50089           in: body
50090           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
50091           required: true
50092           schema:
50093             $ref: "#/definitions/l3-interface-ipv6-address-list"
50094     patch:
50095       tags:
50096         - Network
50097       summary: update an existing l3-interface-ipv6-address-list
50098       description: |
50099         Update an existing l3-interface-ipv6-address-list
50100         #
50101         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50102         The PUT operation will entirely replace an existing object.
50103         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50104         #
50105         Other differences between PUT and PATCH are:
50106         #
50107         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50108         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50109         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50110       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50111       consumes:
50112         - application/json
50113         - application/xml
50114       produces:
50115         - application/json
50116         - application/xml
50117       responses:
50118         "default":
50119           description: Response codes found in [response codes](https://wiki.onap.org/).
50120       parameters:
50121         - name: pnf-name
50122           in: path
50123           description: unique name of Physical Network Function.
50124           required: true
50125           type: string
50126           example: __PNF-NAME__
50127         - name: interface-name
50128           in: path
50129           description: Name that identifies the link aggregate interface
50130           required: true
50131           type: string
50132           example: __INTERFACE-NAME__
50133         - name: interface-name
50134           in: path
50135           description: Name given to the interface
50136           required: true
50137           type: string
50138           example: __INTERFACE-NAME__
50139         - name: l3-interface-ipv6-address
50140           in: path
50141           description: IP address
50142           required: true
50143           type: string
50144           example: __L3-INTERFACE-IPV6-ADDRESS__
50145         - name: body
50146           in: body
50147           description: l3-interface-ipv6-address-list object that needs to be created or updated.
50148           required: true
50149           schema:
50150             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
50151     delete:
50152       tags:
50153         - Network
50154       summary: delete an existing l3-interface-ipv6-address-list
50155       description: delete an existing l3-interface-ipv6-address-list
50156       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50157       consumes:
50158         - application/json
50159         - application/xml
50160       produces:
50161         - application/json
50162         - application/xml
50163       responses:
50164         "default":
50165           description: Response codes found in [response codes](https://wiki.onap.org/).
50166       parameters:
50167         - name: pnf-name
50168           in: path
50169           description: unique name of Physical Network Function.
50170           required: true
50171           type: string
50172           example: __PNF-NAME__
50173         - name: interface-name
50174           in: path
50175           description: Name that identifies the link aggregate interface
50176           required: true
50177           type: string
50178           example: __INTERFACE-NAME__
50179         - name: interface-name
50180           in: path
50181           description: Name given to the interface
50182           required: true
50183           type: string
50184           example: __INTERFACE-NAME__
50185         - name: l3-interface-ipv6-address
50186           in: path
50187           description: IP address
50188           required: true
50189           type: string
50190           example: __L3-INTERFACE-IPV6-ADDRESS__
50191         - name: resource-version
50192           in: query
50193           description: resource-version for concurrency
50194           required: true
50195           type: string
50196   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
50197     get:
50198       tags:
50199         - Network
50200       summary: returns l-interface
50201       description: returns l-interface
50202       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50203       produces:
50204         - application/json
50205         - application/xml
50206       responses:
50207         "200":
50208           description: successful operation
50209           schema:
50210               $ref: "#/getDefinitions/l-interface"
50211         "default":
50212           description: Response codes found in [response codes](https://wiki.onap.org/).
50213       parameters:
50214         - name: pnf-name
50215           in: path
50216           description: unique name of Physical Network Function.
50217           required: true
50218           type: string
50219           example: __PNF-NAME__
50220         - name: interface-name
50221           in: path
50222           description: Name that identifies the link aggregate interface
50223           required: true
50224           type: string
50225           example: __INTERFACE-NAME__
50226         - name: interface-name
50227           in: path
50228           description: Name given to the interface
50229           required: true
50230           type: string
50231           example: __INTERFACE-NAME__
50232         - name: inv-status
50233           in: query
50234           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50235           required: false
50236           type: string
50237         - name: interface-id
50238           in: query
50239           description: ID of interface
50240           required: false
50241           type: string
50242         - name: interface-role
50243           in: query
50244           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50245           required: false
50246           type: string
50247         - name: interface-id
50248           in: query
50249           description: ID of interface
50250           required: false
50251           type: string
50252         - name: macaddr
50253           in: query
50254           description: MAC address for the interface
50255           required: false
50256           type: string
50257         - name: network-name
50258           in: query
50259           description: Name of the network
50260           required: false
50261           type: string
50262     put:
50263       tags:
50264         - Network
50265       summary: create or update an existing l-interface
50266       description: |
50267         Create or update an existing l-interface.
50268         #
50269         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50270       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50271       consumes:
50272         - application/json
50273         - application/xml
50274       produces:
50275         - application/json
50276         - application/xml
50277       responses:
50278         "default":
50279           description: Response codes found in [response codes](https://wiki.onap.org/).
50280       parameters:
50281         - name: pnf-name
50282           in: path
50283           description: unique name of Physical Network Function.
50284           required: true
50285           type: string
50286           example: __PNF-NAME__
50287         - name: interface-name
50288           in: path
50289           description: Name that identifies the link aggregate interface
50290           required: true
50291           type: string
50292           example: __INTERFACE-NAME__
50293         - name: interface-name
50294           in: path
50295           description: Name given to the interface
50296           required: true
50297           type: string
50298           example: __INTERFACE-NAME__
50299         - name: body
50300           in: body
50301           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
50302           required: true
50303           schema:
50304             $ref: "#/definitions/l-interface"
50305     patch:
50306       tags:
50307         - Network
50308       summary: update an existing l-interface
50309       description: |
50310         Update an existing l-interface
50311         #
50312         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50313         The PUT operation will entirely replace an existing object.
50314         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50315         #
50316         Other differences between PUT and PATCH are:
50317         #
50318         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50319         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50320         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50321       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50322       consumes:
50323         - application/json
50324         - application/xml
50325       produces:
50326         - application/json
50327         - application/xml
50328       responses:
50329         "default":
50330           description: Response codes found in [response codes](https://wiki.onap.org/).
50331       parameters:
50332         - name: pnf-name
50333           in: path
50334           description: unique name of Physical Network Function.
50335           required: true
50336           type: string
50337           example: __PNF-NAME__
50338         - name: interface-name
50339           in: path
50340           description: Name that identifies the link aggregate interface
50341           required: true
50342           type: string
50343           example: __INTERFACE-NAME__
50344         - name: interface-name
50345           in: path
50346           description: Name given to the interface
50347           required: true
50348           type: string
50349           example: __INTERFACE-NAME__
50350         - name: body
50351           in: body
50352           description: l-interface object that needs to be created or updated.
50353           required: true
50354           schema:
50355             $ref: "#/patchDefinitions/l-interface"
50356     delete:
50357       tags:
50358         - Network
50359       summary: delete an existing l-interface
50360       description: delete an existing l-interface
50361       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50362       consumes:
50363         - application/json
50364         - application/xml
50365       produces:
50366         - application/json
50367         - application/xml
50368       responses:
50369         "default":
50370           description: Response codes found in [response codes](https://wiki.onap.org/).
50371       parameters:
50372         - name: pnf-name
50373           in: path
50374           description: unique name of Physical Network Function.
50375           required: true
50376           type: string
50377           example: __PNF-NAME__
50378         - name: interface-name
50379           in: path
50380           description: Name that identifies the link aggregate interface
50381           required: true
50382           type: string
50383           example: __INTERFACE-NAME__
50384         - name: interface-name
50385           in: path
50386           description: Name given to the interface
50387           required: true
50388           type: string
50389           example: __INTERFACE-NAME__
50390         - name: resource-version
50391           in: query
50392           description: resource-version for concurrency
50393           required: true
50394           type: string
50395   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
50396     get:
50397       tags:
50398         - Network
50399       summary: returns l-interfaces
50400       description: returns l-interfaces
50401       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
50402       produces:
50403         - application/json
50404         - application/xml
50405       responses:
50406         "200":
50407           description: successful operation
50408           schema:
50409               $ref: "#/getDefinitions/l-interfaces"
50410         "default":
50411           description: Response codes found in [response codes](https://wiki.onap.org/).
50412       parameters:
50413         - name: pnf-name
50414           in: path
50415           description: unique name of Physical Network Function.
50416           required: true
50417           type: string
50418           example: __PNF-NAME__
50419         - name: interface-name
50420           in: path
50421           description: Name that identifies the link aggregate interface
50422           required: true
50423           type: string
50424           example: __INTERFACE-NAME__
50425         - name: inv-status
50426           in: query
50427           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50428           required: false
50429           type: string
50430         - name: interface-id
50431           in: query
50432           description: ID of interface
50433           required: false
50434           type: string
50435         - name: interface-role
50436           in: query
50437           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50438           required: false
50439           type: string
50440   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
50441     get:
50442       tags:
50443         - Network
50444       summary: returns lag-interface
50445       description: returns lag-interface
50446       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
50447       produces:
50448         - application/json
50449         - application/xml
50450       responses:
50451         "200":
50452           description: successful operation
50453           schema:
50454               $ref: "#/getDefinitions/lag-interface"
50455         "default":
50456           description: Response codes found in [response codes](https://wiki.onap.org/).
50457       parameters:
50458         - name: pnf-name
50459           in: path
50460           description: unique name of Physical Network Function.
50461           required: true
50462           type: string
50463           example: __PNF-NAME__
50464         - name: interface-name
50465           in: path
50466           description: Name that identifies the link aggregate interface
50467           required: true
50468           type: string
50469           example: __INTERFACE-NAME__
50470         - name: inv-status
50471           in: query
50472           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50473           required: false
50474           type: string
50475         - name: interface-id
50476           in: query
50477           description: ID of interface
50478           required: false
50479           type: string
50480         - name: interface-role
50481           in: query
50482           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50483           required: false
50484           type: string
50485     put:
50486       tags:
50487         - Network
50488       summary: create or update an existing lag-interface
50489       description: |
50490         Create or update an existing lag-interface.
50491         #
50492         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50493       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
50494       consumes:
50495         - application/json
50496         - application/xml
50497       produces:
50498         - application/json
50499         - application/xml
50500       responses:
50501         "default":
50502           description: Response codes found in [response codes](https://wiki.onap.org/).
50503       parameters:
50504         - name: pnf-name
50505           in: path
50506           description: unique name of Physical Network Function.
50507           required: true
50508           type: string
50509           example: __PNF-NAME__
50510         - name: interface-name
50511           in: path
50512           description: Name that identifies the link aggregate interface
50513           required: true
50514           type: string
50515           example: __INTERFACE-NAME__
50516         - name: body
50517           in: body
50518           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
50519           required: true
50520           schema:
50521             $ref: "#/definitions/lag-interface"
50522     patch:
50523       tags:
50524         - Network
50525       summary: update an existing lag-interface
50526       description: |
50527         Update an existing lag-interface
50528         #
50529         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50530         The PUT operation will entirely replace an existing object.
50531         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50532         #
50533         Other differences between PUT and PATCH are:
50534         #
50535         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50536         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50537         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50538       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
50539       consumes:
50540         - application/json
50541         - application/xml
50542       produces:
50543         - application/json
50544         - application/xml
50545       responses:
50546         "default":
50547           description: Response codes found in [response codes](https://wiki.onap.org/).
50548       parameters:
50549         - name: pnf-name
50550           in: path
50551           description: unique name of Physical Network Function.
50552           required: true
50553           type: string
50554           example: __PNF-NAME__
50555         - name: interface-name
50556           in: path
50557           description: Name that identifies the link aggregate interface
50558           required: true
50559           type: string
50560           example: __INTERFACE-NAME__
50561         - name: body
50562           in: body
50563           description: lag-interface object that needs to be created or updated.
50564           required: true
50565           schema:
50566             $ref: "#/patchDefinitions/lag-interface"
50567     delete:
50568       tags:
50569         - Network
50570       summary: delete an existing lag-interface
50571       description: delete an existing lag-interface
50572       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
50573       consumes:
50574         - application/json
50575         - application/xml
50576       produces:
50577         - application/json
50578         - application/xml
50579       responses:
50580         "default":
50581           description: Response codes found in [response codes](https://wiki.onap.org/).
50582       parameters:
50583         - name: pnf-name
50584           in: path
50585           description: unique name of Physical Network Function.
50586           required: true
50587           type: string
50588           example: __PNF-NAME__
50589         - name: interface-name
50590           in: path
50591           description: Name that identifies the link aggregate interface
50592           required: true
50593           type: string
50594           example: __INTERFACE-NAME__
50595         - name: resource-version
50596           in: query
50597           description: resource-version for concurrency
50598           required: true
50599           type: string
50600   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
50601     get:
50602       tags:
50603         - Network
50604       summary: returns lag-interfaces
50605       description: returns lag-interfaces
50606       operationId: getNetworkPnfsPnfLagInterfaces
50607       produces:
50608         - application/json
50609         - application/xml
50610       responses:
50611         "200":
50612           description: successful operation
50613           schema:
50614               $ref: "#/getDefinitions/lag-interfaces"
50615         "default":
50616           description: Response codes found in [response codes](https://wiki.onap.org/).
50617       parameters:
50618         - name: pnf-name
50619           in: path
50620           description: unique name of Physical Network Function.
50621           required: true
50622           type: string
50623           example: __PNF-NAME__
50624         - name: inv-status
50625           in: query
50626           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50627           required: false
50628           type: string
50629   /network/pnfs/pnf/{pnf-name}:
50630     get:
50631       tags:
50632         - Network
50633       summary: returns pnf
50634       description: returns pnf
50635       operationId: getNetworkPnfsPnf
50636       produces:
50637         - application/json
50638         - application/xml
50639       responses:
50640         "200":
50641           description: successful operation
50642           schema:
50643               $ref: "#/getDefinitions/pnf"
50644         "default":
50645           description: Response codes found in [response codes](https://wiki.onap.org/).
50646       parameters:
50647         - name: pnf-name
50648           in: path
50649           description: unique name of Physical Network Function.
50650           required: true
50651           type: string
50652           example: __PNF-NAME__
50653         - name: inv-status
50654           in: query
50655           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50656           required: false
50657           type: string
50658     put:
50659       tags:
50660         - Network
50661       summary: create or update an existing pnf
50662       description: |
50663         Create or update an existing pnf.
50664         #
50665         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50666       operationId: createOrUpdateNetworkPnfsPnf
50667       consumes:
50668         - application/json
50669         - application/xml
50670       produces:
50671         - application/json
50672         - application/xml
50673       responses:
50674         "default":
50675           description: Response codes found in [response codes](https://wiki.onap.org/).
50676       parameters:
50677         - name: pnf-name
50678           in: path
50679           description: unique name of Physical Network Function.
50680           required: true
50681           type: string
50682           example: __PNF-NAME__
50683         - name: body
50684           in: body
50685           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
50686           required: true
50687           schema:
50688             $ref: "#/definitions/pnf"
50689     patch:
50690       tags:
50691         - Network
50692       summary: update an existing pnf
50693       description: |
50694         Update an existing pnf
50695         #
50696         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50697         The PUT operation will entirely replace an existing object.
50698         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50699         #
50700         Other differences between PUT and PATCH are:
50701         #
50702         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50703         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50704         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50705       operationId: UpdateNetworkPnfsPnf
50706       consumes:
50707         - application/json
50708         - application/xml
50709       produces:
50710         - application/json
50711         - application/xml
50712       responses:
50713         "default":
50714           description: Response codes found in [response codes](https://wiki.onap.org/).
50715       parameters:
50716         - name: pnf-name
50717           in: path
50718           description: unique name of Physical Network Function.
50719           required: true
50720           type: string
50721           example: __PNF-NAME__
50722         - name: body
50723           in: body
50724           description: pnf object that needs to be created or updated.
50725           required: true
50726           schema:
50727             $ref: "#/patchDefinitions/pnf"
50728     delete:
50729       tags:
50730         - Network
50731       summary: delete an existing pnf
50732       description: delete an existing pnf
50733       operationId: deleteNetworkPnfsPnf
50734       consumes:
50735         - application/json
50736         - application/xml
50737       produces:
50738         - application/json
50739         - application/xml
50740       responses:
50741         "default":
50742           description: Response codes found in [response codes](https://wiki.onap.org/).
50743       parameters:
50744         - name: pnf-name
50745           in: path
50746           description: unique name of Physical Network Function.
50747           required: true
50748           type: string
50749           example: __PNF-NAME__
50750         - name: resource-version
50751           in: query
50752           description: resource-version for concurrency
50753           required: true
50754           type: string
50755   /network/pnfs:
50756     get:
50757       tags:
50758         - Network
50759       summary: returns pnfs
50760       description: returns pnfs
50761       operationId: getNetworkPnfs
50762       produces:
50763         - application/json
50764         - application/xml
50765       responses:
50766         "200":
50767           description: successful operation
50768           schema:
50769               $ref: "#/getDefinitions/pnfs"
50770         "default":
50771           description: Response codes found in [response codes](https://wiki.onap.org/).
50772   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
50773     put:
50774       tags:
50775         - Network
50776       summary: see node definition for valid relationships
50777       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50778       consumes:
50779         - application/json
50780         - application/xml
50781       produces:
50782         - application/json
50783         - application/xml
50784       responses:
50785         "default":
50786           description: Response codes found in [response codes](https://wiki.onap.org/).
50787       parameters:
50788         - name: link-name
50789           in: path
50790           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50791           required: true
50792           type: string
50793           example: __LINK-NAME__
50794         - name: body
50795           in: body
50796           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
50797           required: true
50798           schema:
50799             $ref: "#/definitions/relationship"
50800     delete:
50801       tags:
50802         - Network
50803       summary: delete an existing relationship
50804       description: delete an existing relationship
50805       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50806       consumes:
50807         - application/json
50808         - application/xml
50809       produces:
50810         - application/json
50811         - application/xml
50812       responses:
50813         "default":
50814           description: Response codes found in [response codes](https://wiki.onap.org/).
50815       parameters:
50816         - name: link-name
50817           in: path
50818           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50819           required: true
50820           type: string
50821           example: __LINK-NAME__
50822   /network/physical-links/physical-link/{link-name}:
50823     get:
50824       tags:
50825         - Network
50826       summary: returns physical-link
50827       description: returns physical-link
50828       operationId: getNetworkPhysicalLinksPhysicalLink
50829       produces:
50830         - application/json
50831         - application/xml
50832       responses:
50833         "200":
50834           description: successful operation
50835           schema:
50836               $ref: "#/getDefinitions/physical-link"
50837         "default":
50838           description: Response codes found in [response codes](https://wiki.onap.org/).
50839       parameters:
50840         - name: link-name
50841           in: path
50842           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50843           required: true
50844           type: string
50845           example: __LINK-NAME__
50846         - name: circuit-id
50847           in: query
50848           description: Circuit it
50849           required: false
50850           type: string
50851     put:
50852       tags:
50853         - Network
50854       summary: create or update an existing physical-link
50855       description: |
50856         Create or update an existing physical-link.
50857         #
50858         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50859       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
50860       consumes:
50861         - application/json
50862         - application/xml
50863       produces:
50864         - application/json
50865         - application/xml
50866       responses:
50867         "default":
50868           description: Response codes found in [response codes](https://wiki.onap.org/).
50869       parameters:
50870         - name: link-name
50871           in: path
50872           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50873           required: true
50874           type: string
50875           example: __LINK-NAME__
50876         - name: body
50877           in: body
50878           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
50879           required: true
50880           schema:
50881             $ref: "#/definitions/physical-link"
50882     patch:
50883       tags:
50884         - Network
50885       summary: update an existing physical-link
50886       description: |
50887         Update an existing physical-link
50888         #
50889         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50890         The PUT operation will entirely replace an existing object.
50891         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50892         #
50893         Other differences between PUT and PATCH are:
50894         #
50895         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50896         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50897         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50898       operationId: UpdateNetworkPhysicalLinksPhysicalLink
50899       consumes:
50900         - application/json
50901         - application/xml
50902       produces:
50903         - application/json
50904         - application/xml
50905       responses:
50906         "default":
50907           description: Response codes found in [response codes](https://wiki.onap.org/).
50908       parameters:
50909         - name: link-name
50910           in: path
50911           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50912           required: true
50913           type: string
50914           example: __LINK-NAME__
50915         - name: body
50916           in: body
50917           description: physical-link object that needs to be created or updated.
50918           required: true
50919           schema:
50920             $ref: "#/patchDefinitions/physical-link"
50921     delete:
50922       tags:
50923         - Network
50924       summary: delete an existing physical-link
50925       description: delete an existing physical-link
50926       operationId: deleteNetworkPhysicalLinksPhysicalLink
50927       consumes:
50928         - application/json
50929         - application/xml
50930       produces:
50931         - application/json
50932         - application/xml
50933       responses:
50934         "default":
50935           description: Response codes found in [response codes](https://wiki.onap.org/).
50936       parameters:
50937         - name: link-name
50938           in: path
50939           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50940           required: true
50941           type: string
50942           example: __LINK-NAME__
50943         - name: resource-version
50944           in: query
50945           description: resource-version for concurrency
50946           required: true
50947           type: string
50948   /network/physical-links:
50949     get:
50950       tags:
50951         - Network
50952       summary: returns physical-links
50953       description: returns physical-links
50954       operationId: getNetworkPhysicalLinks
50955       produces:
50956         - application/json
50957         - application/xml
50958       responses:
50959         "200":
50960           description: successful operation
50961           schema:
50962               $ref: "#/getDefinitions/physical-links"
50963         "default":
50964           description: Response codes found in [response codes](https://wiki.onap.org/).
50965   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
50966     put:
50967       tags:
50968         - Network
50969       summary: see node definition for valid relationships
50970       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
50971       consumes:
50972         - application/json
50973         - application/xml
50974       produces:
50975         - application/json
50976         - application/xml
50977       responses:
50978         "default":
50979           description: Response codes found in [response codes](https://wiki.onap.org/).
50980       parameters:
50981         - name: ipsec-configuration-id
50982           in: path
50983           description: UUID of this configuration
50984           required: true
50985           type: string
50986           example: __IPSEC-CONFIGURATION-ID__
50987         - name: body
50988           in: body
50989           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
50990           required: true
50991           schema:
50992             $ref: "#/definitions/relationship"
50993     delete:
50994       tags:
50995         - Network
50996       summary: delete an existing relationship
50997       description: delete an existing relationship
50998       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
50999       consumes:
51000         - application/json
51001         - application/xml
51002       produces:
51003         - application/json
51004         - application/xml
51005       responses:
51006         "default":
51007           description: Response codes found in [response codes](https://wiki.onap.org/).
51008       parameters:
51009         - name: ipsec-configuration-id
51010           in: path
51011           description: UUID of this configuration
51012           required: true
51013           type: string
51014           example: __IPSEC-CONFIGURATION-ID__
51015   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
51016     put:
51017       tags:
51018         - Network
51019       summary: see node definition for valid relationships
51020       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51021       consumes:
51022         - application/json
51023         - application/xml
51024       produces:
51025         - application/json
51026         - application/xml
51027       responses:
51028         "default":
51029           description: Response codes found in [response codes](https://wiki.onap.org/).
51030       parameters:
51031         - name: ipsec-configuration-id
51032           in: path
51033           description: UUID of this configuration
51034           required: true
51035           type: string
51036           example: __IPSEC-CONFIGURATION-ID__
51037         - name: vig-address-type
51038           in: path
51039           description: indicates whether the VIG is for AVPN or INTERNET
51040           required: true
51041           type: string
51042           example: __VIG-ADDRESS-TYPE__
51043         - name: body
51044           in: body
51045           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51046           required: true
51047           schema:
51048             $ref: "#/definitions/relationship"
51049     delete:
51050       tags:
51051         - Network
51052       summary: delete an existing relationship
51053       description: delete an existing relationship
51054       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51055       consumes:
51056         - application/json
51057         - application/xml
51058       produces:
51059         - application/json
51060         - application/xml
51061       responses:
51062         "default":
51063           description: Response codes found in [response codes](https://wiki.onap.org/).
51064       parameters:
51065         - name: ipsec-configuration-id
51066           in: path
51067           description: UUID of this configuration
51068           required: true
51069           type: string
51070           example: __IPSEC-CONFIGURATION-ID__
51071         - name: vig-address-type
51072           in: path
51073           description: indicates whether the VIG is for AVPN or INTERNET
51074           required: true
51075           type: string
51076           example: __VIG-ADDRESS-TYPE__
51077   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
51078     get:
51079       tags:
51080         - Network
51081       summary: returns vig-server
51082       description: returns vig-server
51083       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51084       produces:
51085         - application/json
51086         - application/xml
51087       responses:
51088         "200":
51089           description: successful operation
51090           schema:
51091               $ref: "#/getDefinitions/vig-server"
51092         "default":
51093           description: Response codes found in [response codes](https://wiki.onap.org/).
51094       parameters:
51095         - name: ipsec-configuration-id
51096           in: path
51097           description: UUID of this configuration
51098           required: true
51099           type: string
51100           example: __IPSEC-CONFIGURATION-ID__
51101         - name: vig-address-type
51102           in: path
51103           description: indicates whether the VIG is for AVPN or INTERNET
51104           required: true
51105           type: string
51106           example: __VIG-ADDRESS-TYPE__
51107     put:
51108       tags:
51109         - Network
51110       summary: create or update an existing vig-server
51111       description: |
51112         Create or update an existing vig-server.
51113         #
51114         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51115       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51116       consumes:
51117         - application/json
51118         - application/xml
51119       produces:
51120         - application/json
51121         - application/xml
51122       responses:
51123         "default":
51124           description: Response codes found in [response codes](https://wiki.onap.org/).
51125       parameters:
51126         - name: ipsec-configuration-id
51127           in: path
51128           description: UUID of this configuration
51129           required: true
51130           type: string
51131           example: __IPSEC-CONFIGURATION-ID__
51132         - name: vig-address-type
51133           in: path
51134           description: indicates whether the VIG is for AVPN or INTERNET
51135           required: true
51136           type: string
51137           example: __VIG-ADDRESS-TYPE__
51138         - name: body
51139           in: body
51140           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51141           required: true
51142           schema:
51143             $ref: "#/definitions/vig-server"
51144     patch:
51145       tags:
51146         - Network
51147       summary: update an existing vig-server
51148       description: |
51149         Update an existing vig-server
51150         #
51151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51152         The PUT operation will entirely replace an existing object.
51153         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51154         #
51155         Other differences between PUT and PATCH are:
51156         #
51157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51160       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51161       consumes:
51162         - application/json
51163         - application/xml
51164       produces:
51165         - application/json
51166         - application/xml
51167       responses:
51168         "default":
51169           description: Response codes found in [response codes](https://wiki.onap.org/).
51170       parameters:
51171         - name: ipsec-configuration-id
51172           in: path
51173           description: UUID of this configuration
51174           required: true
51175           type: string
51176           example: __IPSEC-CONFIGURATION-ID__
51177         - name: vig-address-type
51178           in: path
51179           description: indicates whether the VIG is for AVPN or INTERNET
51180           required: true
51181           type: string
51182           example: __VIG-ADDRESS-TYPE__
51183         - name: body
51184           in: body
51185           description: vig-server object that needs to be created or updated.
51186           required: true
51187           schema:
51188             $ref: "#/patchDefinitions/vig-server"
51189     delete:
51190       tags:
51191         - Network
51192       summary: delete an existing vig-server
51193       description: delete an existing vig-server
51194       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51195       consumes:
51196         - application/json
51197         - application/xml
51198       produces:
51199         - application/json
51200         - application/xml
51201       responses:
51202         "default":
51203           description: Response codes found in [response codes](https://wiki.onap.org/).
51204       parameters:
51205         - name: ipsec-configuration-id
51206           in: path
51207           description: UUID of this configuration
51208           required: true
51209           type: string
51210           example: __IPSEC-CONFIGURATION-ID__
51211         - name: vig-address-type
51212           in: path
51213           description: indicates whether the VIG is for AVPN or INTERNET
51214           required: true
51215           type: string
51216           example: __VIG-ADDRESS-TYPE__
51217         - name: resource-version
51218           in: query
51219           description: resource-version for concurrency
51220           required: true
51221           type: string
51222   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
51223     get:
51224       tags:
51225         - Network
51226       summary: returns vig-servers
51227       description: returns vig-servers
51228       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
51229       produces:
51230         - application/json
51231         - application/xml
51232       responses:
51233         "200":
51234           description: successful operation
51235           schema:
51236               $ref: "#/getDefinitions/vig-servers"
51237         "default":
51238           description: Response codes found in [response codes](https://wiki.onap.org/).
51239       parameters:
51240         - name: ipsec-configuration-id
51241           in: path
51242           description: UUID of this configuration
51243           required: true
51244           type: string
51245           example: __IPSEC-CONFIGURATION-ID__
51246   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
51247     get:
51248       tags:
51249         - Network
51250       summary: returns ipsec-configuration
51251       description: returns ipsec-configuration
51252       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
51253       produces:
51254         - application/json
51255         - application/xml
51256       responses:
51257         "200":
51258           description: successful operation
51259           schema:
51260               $ref: "#/getDefinitions/ipsec-configuration"
51261         "default":
51262           description: Response codes found in [response codes](https://wiki.onap.org/).
51263       parameters:
51264         - name: ipsec-configuration-id
51265           in: path
51266           description: UUID of this configuration
51267           required: true
51268           type: string
51269           example: __IPSEC-CONFIGURATION-ID__
51270     put:
51271       tags:
51272         - Network
51273       summary: create or update an existing ipsec-configuration
51274       description: |
51275         Create or update an existing ipsec-configuration.
51276         #
51277         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51278       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
51279       consumes:
51280         - application/json
51281         - application/xml
51282       produces:
51283         - application/json
51284         - application/xml
51285       responses:
51286         "default":
51287           description: Response codes found in [response codes](https://wiki.onap.org/).
51288       parameters:
51289         - name: ipsec-configuration-id
51290           in: path
51291           description: UUID of this configuration
51292           required: true
51293           type: string
51294           example: __IPSEC-CONFIGURATION-ID__
51295         - name: body
51296           in: body
51297           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
51298           required: true
51299           schema:
51300             $ref: "#/definitions/ipsec-configuration"
51301     patch:
51302       tags:
51303         - Network
51304       summary: update an existing ipsec-configuration
51305       description: |
51306         Update an existing ipsec-configuration
51307         #
51308         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51309         The PUT operation will entirely replace an existing object.
51310         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51311         #
51312         Other differences between PUT and PATCH are:
51313         #
51314         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51315         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51316         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51317       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
51318       consumes:
51319         - application/json
51320         - application/xml
51321       produces:
51322         - application/json
51323         - application/xml
51324       responses:
51325         "default":
51326           description: Response codes found in [response codes](https://wiki.onap.org/).
51327       parameters:
51328         - name: ipsec-configuration-id
51329           in: path
51330           description: UUID of this configuration
51331           required: true
51332           type: string
51333           example: __IPSEC-CONFIGURATION-ID__
51334         - name: body
51335           in: body
51336           description: ipsec-configuration object that needs to be created or updated.
51337           required: true
51338           schema:
51339             $ref: "#/patchDefinitions/ipsec-configuration"
51340     delete:
51341       tags:
51342         - Network
51343       summary: delete an existing ipsec-configuration
51344       description: delete an existing ipsec-configuration
51345       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
51346       consumes:
51347         - application/json
51348         - application/xml
51349       produces:
51350         - application/json
51351         - application/xml
51352       responses:
51353         "default":
51354           description: Response codes found in [response codes](https://wiki.onap.org/).
51355       parameters:
51356         - name: ipsec-configuration-id
51357           in: path
51358           description: UUID of this configuration
51359           required: true
51360           type: string
51361           example: __IPSEC-CONFIGURATION-ID__
51362         - name: resource-version
51363           in: query
51364           description: resource-version for concurrency
51365           required: true
51366           type: string
51367   /network/ipsec-configurations:
51368     get:
51369       tags:
51370         - Network
51371       summary: returns ipsec-configurations
51372       description: returns ipsec-configurations
51373       operationId: getNetworkIpsecConfigurations
51374       produces:
51375         - application/json
51376         - application/xml
51377       responses:
51378         "200":
51379           description: successful operation
51380           schema:
51381               $ref: "#/getDefinitions/ipsec-configurations"
51382         "default":
51383           description: Response codes found in [response codes](https://wiki.onap.org/).
51384   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
51385     put:
51386       tags:
51387         - Network
51388       summary: see node definition for valid relationships
51389       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51390       consumes:
51391         - application/json
51392         - application/xml
51393       produces:
51394         - application/json
51395         - application/xml
51396       responses:
51397         "default":
51398           description: Response codes found in [response codes](https://wiki.onap.org/).
51399       parameters:
51400         - name: route-table-reference-id
51401           in: path
51402           description: Route Table Reference id, UUID assigned to this instance.
51403           required: true
51404           type: string
51405           example: __ROUTE-TABLE-REFERENCE-ID__
51406         - name: body
51407           in: body
51408           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
51409           required: true
51410           schema:
51411             $ref: "#/definitions/relationship"
51412     delete:
51413       tags:
51414         - Network
51415       summary: delete an existing relationship
51416       description: delete an existing relationship
51417       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51418       consumes:
51419         - application/json
51420         - application/xml
51421       produces:
51422         - application/json
51423         - application/xml
51424       responses:
51425         "default":
51426           description: Response codes found in [response codes](https://wiki.onap.org/).
51427       parameters:
51428         - name: route-table-reference-id
51429           in: path
51430           description: Route Table Reference id, UUID assigned to this instance.
51431           required: true
51432           type: string
51433           example: __ROUTE-TABLE-REFERENCE-ID__
51434   /network/route-table-references/route-table-reference/{route-table-reference-id}:
51435     get:
51436       tags:
51437         - Network
51438       summary: returns route-table-reference
51439       description: returns route-table-reference
51440       operationId: getNetworkRouteTableReferencesRouteTableReference
51441       produces:
51442         - application/json
51443         - application/xml
51444       responses:
51445         "200":
51446           description: successful operation
51447           schema:
51448               $ref: "#/getDefinitions/route-table-reference"
51449         "default":
51450           description: Response codes found in [response codes](https://wiki.onap.org/).
51451       parameters:
51452         - name: route-table-reference-id
51453           in: path
51454           description: Route Table Reference id, UUID assigned to this instance.
51455           required: true
51456           type: string
51457           example: __ROUTE-TABLE-REFERENCE-ID__
51458         - name: route-table-reference-fqdn
51459           in: query
51460           description: FQDN entry in the route table.
51461           required: false
51462           type: string
51463     put:
51464       tags:
51465         - Network
51466       summary: create or update an existing route-table-reference
51467       description: |
51468         Create or update an existing route-table-reference.
51469         #
51470         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51471       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
51472       consumes:
51473         - application/json
51474         - application/xml
51475       produces:
51476         - application/json
51477         - application/xml
51478       responses:
51479         "default":
51480           description: Response codes found in [response codes](https://wiki.onap.org/).
51481       parameters:
51482         - name: route-table-reference-id
51483           in: path
51484           description: Route Table Reference id, UUID assigned to this instance.
51485           required: true
51486           type: string
51487           example: __ROUTE-TABLE-REFERENCE-ID__
51488         - name: body
51489           in: body
51490           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
51491           required: true
51492           schema:
51493             $ref: "#/definitions/route-table-reference"
51494     patch:
51495       tags:
51496         - Network
51497       summary: update an existing route-table-reference
51498       description: |
51499         Update an existing route-table-reference
51500         #
51501         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51502         The PUT operation will entirely replace an existing object.
51503         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51504         #
51505         Other differences between PUT and PATCH are:
51506         #
51507         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51508         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51509         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51510       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
51511       consumes:
51512         - application/json
51513         - application/xml
51514       produces:
51515         - application/json
51516         - application/xml
51517       responses:
51518         "default":
51519           description: Response codes found in [response codes](https://wiki.onap.org/).
51520       parameters:
51521         - name: route-table-reference-id
51522           in: path
51523           description: Route Table Reference id, UUID assigned to this instance.
51524           required: true
51525           type: string
51526           example: __ROUTE-TABLE-REFERENCE-ID__
51527         - name: body
51528           in: body
51529           description: route-table-reference object that needs to be created or updated.
51530           required: true
51531           schema:
51532             $ref: "#/patchDefinitions/route-table-reference"
51533     delete:
51534       tags:
51535         - Network
51536       summary: delete an existing route-table-reference
51537       description: delete an existing route-table-reference
51538       operationId: deleteNetworkRouteTableReferencesRouteTableReference
51539       consumes:
51540         - application/json
51541         - application/xml
51542       produces:
51543         - application/json
51544         - application/xml
51545       responses:
51546         "default":
51547           description: Response codes found in [response codes](https://wiki.onap.org/).
51548       parameters:
51549         - name: route-table-reference-id
51550           in: path
51551           description: Route Table Reference id, UUID assigned to this instance.
51552           required: true
51553           type: string
51554           example: __ROUTE-TABLE-REFERENCE-ID__
51555         - name: resource-version
51556           in: query
51557           description: resource-version for concurrency
51558           required: true
51559           type: string
51560   /network/route-table-references:
51561     get:
51562       tags:
51563         - Network
51564       summary: returns route-table-references
51565       description: returns route-table-references
51566       operationId: getNetworkRouteTableReferences
51567       produces:
51568         - application/json
51569         - application/xml
51570       responses:
51571         "200":
51572           description: successful operation
51573           schema:
51574               $ref: "#/getDefinitions/route-table-references"
51575         "default":
51576           description: Response codes found in [response codes](https://wiki.onap.org/).
51577   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
51578     put:
51579       tags:
51580         - Network
51581       summary: see node definition for valid relationships
51582       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51583       consumes:
51584         - application/json
51585         - application/xml
51586       produces:
51587         - application/json
51588         - application/xml
51589       responses:
51590         "default":
51591           description: Response codes found in [response codes](https://wiki.onap.org/).
51592       parameters:
51593         - name: id
51594           in: path
51595           description: Instance Group ID, UUID assigned to this instance.
51596           required: true
51597           type: string
51598           example: __ID__
51599         - name: body
51600           in: body
51601           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
51602           required: true
51603           schema:
51604             $ref: "#/definitions/relationship"
51605     delete:
51606       tags:
51607         - Network
51608       summary: delete an existing relationship
51609       description: delete an existing relationship
51610       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51611       consumes:
51612         - application/json
51613         - application/xml
51614       produces:
51615         - application/json
51616         - application/xml
51617       responses:
51618         "default":
51619           description: Response codes found in [response codes](https://wiki.onap.org/).
51620       parameters:
51621         - name: id
51622           in: path
51623           description: Instance Group ID, UUID assigned to this instance.
51624           required: true
51625           type: string
51626           example: __ID__
51627   /network/instance-groups/instance-group/{id}:
51628     get:
51629       tags:
51630         - Network
51631       summary: returns instance-group
51632       description: returns instance-group
51633       operationId: getNetworkInstanceGroupsInstanceGroup
51634       produces:
51635         - application/json
51636         - application/xml
51637       responses:
51638         "200":
51639           description: successful operation
51640           schema:
51641               $ref: "#/getDefinitions/instance-group"
51642         "default":
51643           description: Response codes found in [response codes](https://wiki.onap.org/).
51644       parameters:
51645         - name: id
51646           in: path
51647           description: Instance Group ID, UUID assigned to this instance.
51648           required: true
51649           type: string
51650           example: __ID__
51651         - name: description
51652           in: query
51653           description: Descriptive text to help identify the usage of this instance-group
51654           required: false
51655           type: string
51656         - name: type
51657           in: query
51658           description: Only valid value today is lower case ha for high availability
51659           required: false
51660           type: string
51661         - name: sub-type
51662           in: query
51663           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
51664           required: false
51665           type: string
51666     put:
51667       tags:
51668         - Network
51669       summary: create or update an existing instance-group
51670       description: |
51671         Create or update an existing instance-group.
51672         #
51673         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51674       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
51675       consumes:
51676         - application/json
51677         - application/xml
51678       produces:
51679         - application/json
51680         - application/xml
51681       responses:
51682         "default":
51683           description: Response codes found in [response codes](https://wiki.onap.org/).
51684       parameters:
51685         - name: id
51686           in: path
51687           description: Instance Group ID, UUID assigned to this instance.
51688           required: true
51689           type: string
51690           example: __ID__
51691         - name: body
51692           in: body
51693           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
51694           required: true
51695           schema:
51696             $ref: "#/definitions/instance-group"
51697     patch:
51698       tags:
51699         - Network
51700       summary: update an existing instance-group
51701       description: |
51702         Update an existing instance-group
51703         #
51704         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51705         The PUT operation will entirely replace an existing object.
51706         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51707         #
51708         Other differences between PUT and PATCH are:
51709         #
51710         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51711         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51712         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51713       operationId: UpdateNetworkInstanceGroupsInstanceGroup
51714       consumes:
51715         - application/json
51716         - application/xml
51717       produces:
51718         - application/json
51719         - application/xml
51720       responses:
51721         "default":
51722           description: Response codes found in [response codes](https://wiki.onap.org/).
51723       parameters:
51724         - name: id
51725           in: path
51726           description: Instance Group ID, UUID assigned to this instance.
51727           required: true
51728           type: string
51729           example: __ID__
51730         - name: body
51731           in: body
51732           description: instance-group object that needs to be created or updated.
51733           required: true
51734           schema:
51735             $ref: "#/patchDefinitions/instance-group"
51736     delete:
51737       tags:
51738         - Network
51739       summary: delete an existing instance-group
51740       description: delete an existing instance-group
51741       operationId: deleteNetworkInstanceGroupsInstanceGroup
51742       consumes:
51743         - application/json
51744         - application/xml
51745       produces:
51746         - application/json
51747         - application/xml
51748       responses:
51749         "default":
51750           description: Response codes found in [response codes](https://wiki.onap.org/).
51751       parameters:
51752         - name: id
51753           in: path
51754           description: Instance Group ID, UUID assigned to this instance.
51755           required: true
51756           type: string
51757           example: __ID__
51758         - name: resource-version
51759           in: query
51760           description: resource-version for concurrency
51761           required: true
51762           type: string
51763   /network/instance-groups:
51764     get:
51765       tags:
51766         - Network
51767       summary: returns instance-groups
51768       description: returns instance-groups
51769       operationId: getNetworkInstanceGroups
51770       produces:
51771         - application/json
51772         - application/xml
51773       responses:
51774         "200":
51775           description: successful operation
51776           schema:
51777               $ref: "#/getDefinitions/instance-groups"
51778         "default":
51779           description: Response codes found in [response codes](https://wiki.onap.org/).
51780   /network/zones/zone/{zone-id}/relationship-list/relationship:
51781     put:
51782       tags:
51783         - Network
51784       summary: see node definition for valid relationships
51785       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
51786       consumes:
51787         - application/json
51788         - application/xml
51789       produces:
51790         - application/json
51791         - application/xml
51792       responses:
51793         "default":
51794           description: Response codes found in [response codes](https://wiki.onap.org/).
51795       parameters:
51796         - name: zone-id
51797           in: path
51798           description: Code assigned by AIC to the zone
51799           required: true
51800           type: string
51801           example: __ZONE-ID__
51802         - name: body
51803           in: body
51804           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
51805           required: true
51806           schema:
51807             $ref: "#/definitions/relationship"
51808     delete:
51809       tags:
51810         - Network
51811       summary: delete an existing relationship
51812       description: delete an existing relationship
51813       operationId: deleteNetworkZonesZoneRelationshipListRelationship
51814       consumes:
51815         - application/json
51816         - application/xml
51817       produces:
51818         - application/json
51819         - application/xml
51820       responses:
51821         "default":
51822           description: Response codes found in [response codes](https://wiki.onap.org/).
51823       parameters:
51824         - name: zone-id
51825           in: path
51826           description: Code assigned by AIC to the zone
51827           required: true
51828           type: string
51829           example: __ZONE-ID__
51830   /network/zones/zone/{zone-id}:
51831     get:
51832       tags:
51833         - Network
51834       summary: returns zone
51835       description: returns zone
51836       operationId: getNetworkZonesZone
51837       produces:
51838         - application/json
51839         - application/xml
51840       responses:
51841         "200":
51842           description: successful operation
51843           schema:
51844               $ref: "#/getDefinitions/zone"
51845         "default":
51846           description: Response codes found in [response codes](https://wiki.onap.org/).
51847       parameters:
51848         - name: zone-id
51849           in: path
51850           description: Code assigned by AIC to the zone
51851           required: true
51852           type: string
51853           example: __ZONE-ID__
51854         - name: design-type
51855           in: query
51856           description: Design of zone [Medium/Large…]
51857           required: false
51858           type: string
51859         - name: zone-context
51860           in: query
51861           description: Context of zone [production/test]
51862           required: false
51863           type: string
51864     put:
51865       tags:
51866         - Network
51867       summary: create or update an existing zone
51868       description: |
51869         Create or update an existing zone.
51870         #
51871         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51872       operationId: createOrUpdateNetworkZonesZone
51873       consumes:
51874         - application/json
51875         - application/xml
51876       produces:
51877         - application/json
51878         - application/xml
51879       responses:
51880         "default":
51881           description: Response codes found in [response codes](https://wiki.onap.org/).
51882       parameters:
51883         - name: zone-id
51884           in: path
51885           description: Code assigned by AIC to the zone
51886           required: true
51887           type: string
51888           example: __ZONE-ID__
51889         - name: body
51890           in: body
51891           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
51892           required: true
51893           schema:
51894             $ref: "#/definitions/zone"
51895     patch:
51896       tags:
51897         - Network
51898       summary: update an existing zone
51899       description: |
51900         Update an existing zone
51901         #
51902         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51903         The PUT operation will entirely replace an existing object.
51904         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51905         #
51906         Other differences between PUT and PATCH are:
51907         #
51908         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51909         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51910         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51911       operationId: UpdateNetworkZonesZone
51912       consumes:
51913         - application/json
51914         - application/xml
51915       produces:
51916         - application/json
51917         - application/xml
51918       responses:
51919         "default":
51920           description: Response codes found in [response codes](https://wiki.onap.org/).
51921       parameters:
51922         - name: zone-id
51923           in: path
51924           description: Code assigned by AIC to the zone
51925           required: true
51926           type: string
51927           example: __ZONE-ID__
51928         - name: body
51929           in: body
51930           description: zone object that needs to be created or updated.
51931           required: true
51932           schema:
51933             $ref: "#/patchDefinitions/zone"
51934     delete:
51935       tags:
51936         - Network
51937       summary: delete an existing zone
51938       description: delete an existing zone
51939       operationId: deleteNetworkZonesZone
51940       consumes:
51941         - application/json
51942         - application/xml
51943       produces:
51944         - application/json
51945         - application/xml
51946       responses:
51947         "default":
51948           description: Response codes found in [response codes](https://wiki.onap.org/).
51949       parameters:
51950         - name: zone-id
51951           in: path
51952           description: Code assigned by AIC to the zone
51953           required: true
51954           type: string
51955           example: __ZONE-ID__
51956         - name: resource-version
51957           in: query
51958           description: resource-version for concurrency
51959           required: true
51960           type: string
51961   /network/zones:
51962     get:
51963       tags:
51964         - Network
51965       summary: returns zones
51966       description: returns zones
51967       operationId: getNetworkZones
51968       produces:
51969         - application/json
51970         - application/xml
51971       responses:
51972         "200":
51973           description: successful operation
51974           schema:
51975               $ref: "#/getDefinitions/zones"
51976         "default":
51977           description: Response codes found in [response codes](https://wiki.onap.org/).
51978   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
51979     put:
51980       tags:
51981         - Network
51982       summary: see node definition for valid relationships
51983       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
51984       consumes:
51985         - application/json
51986         - application/xml
51987       produces:
51988         - application/json
51989         - application/xml
51990       responses:
51991         "default":
51992           description: Response codes found in [response codes](https://wiki.onap.org/).
51993       parameters:
51994         - name: configuration-id
51995           in: path
51996           description: UUID assigned to configuration.
51997           required: true
51998           type: string
51999           example: __CONFIGURATION-ID__
52000         - name: body
52001           in: body
52002           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
52003           required: true
52004           schema:
52005             $ref: "#/definitions/relationship"
52006     delete:
52007       tags:
52008         - Network
52009       summary: delete an existing relationship
52010       description: delete an existing relationship
52011       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
52012       consumes:
52013         - application/json
52014         - application/xml
52015       produces:
52016         - application/json
52017         - application/xml
52018       responses:
52019         "default":
52020           description: Response codes found in [response codes](https://wiki.onap.org/).
52021       parameters:
52022         - name: configuration-id
52023           in: path
52024           description: UUID assigned to configuration.
52025           required: true
52026           type: string
52027           example: __CONFIGURATION-ID__
52028   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
52029     get:
52030       tags:
52031         - Network
52032       summary: returns metadatum
52033       description: returns metadatum
52034       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
52035       produces:
52036         - application/json
52037         - application/xml
52038       responses:
52039         "200":
52040           description: successful operation
52041           schema:
52042               $ref: "#/getDefinitions/metadatum"
52043         "default":
52044           description: Response codes found in [response codes](https://wiki.onap.org/).
52045       parameters:
52046         - name: configuration-id
52047           in: path
52048           description: UUID assigned to configuration.
52049           required: true
52050           type: string
52051           example: __CONFIGURATION-ID__
52052         - name: metaname
52053           in: path
52054           required: true
52055           type: string
52056           example: __METANAME__
52057         - name: model-invariant-id
52058           in: query
52059           description: the ASDC model id for this resource or service model.
52060           required: false
52061           type: string
52062         - name: model-version-id
52063           in: query
52064           description: the ASDC model version for this resource or service model.
52065           required: false
52066           type: string
52067     put:
52068       tags:
52069         - Network
52070       summary: create or update an existing metadatum
52071       description: |
52072         Create or update an existing metadatum.
52073         #
52074         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52075       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
52076       consumes:
52077         - application/json
52078         - application/xml
52079       produces:
52080         - application/json
52081         - application/xml
52082       responses:
52083         "default":
52084           description: Response codes found in [response codes](https://wiki.onap.org/).
52085       parameters:
52086         - name: configuration-id
52087           in: path
52088           description: UUID assigned to configuration.
52089           required: true
52090           type: string
52091           example: __CONFIGURATION-ID__
52092         - name: metaname
52093           in: path
52094           required: true
52095           type: string
52096           example: __METANAME__
52097         - name: body
52098           in: body
52099           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationMetadataMetadatum.json)
52100           required: true
52101           schema:
52102             $ref: "#/definitions/metadatum"
52103     patch:
52104       tags:
52105         - Network
52106       summary: update an existing metadatum
52107       description: |
52108         Update an existing metadatum
52109         #
52110         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52111         The PUT operation will entirely replace an existing object.
52112         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52113         #
52114         Other differences between PUT and PATCH are:
52115         #
52116         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52117         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52118         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52119       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
52120       consumes:
52121         - application/json
52122         - application/xml
52123       produces:
52124         - application/json
52125         - application/xml
52126       responses:
52127         "default":
52128           description: Response codes found in [response codes](https://wiki.onap.org/).
52129       parameters:
52130         - name: configuration-id
52131           in: path
52132           description: UUID assigned to configuration.
52133           required: true
52134           type: string
52135           example: __CONFIGURATION-ID__
52136         - name: metaname
52137           in: path
52138           required: true
52139           type: string
52140           example: __METANAME__
52141         - name: body
52142           in: body
52143           description: metadatum object that needs to be created or updated.
52144           required: true
52145           schema:
52146             $ref: "#/patchDefinitions/metadatum"
52147     delete:
52148       tags:
52149         - Network
52150       summary: delete an existing metadatum
52151       description: delete an existing metadatum
52152       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
52153       consumes:
52154         - application/json
52155         - application/xml
52156       produces:
52157         - application/json
52158         - application/xml
52159       responses:
52160         "default":
52161           description: Response codes found in [response codes](https://wiki.onap.org/).
52162       parameters:
52163         - name: configuration-id
52164           in: path
52165           description: UUID assigned to configuration.
52166           required: true
52167           type: string
52168           example: __CONFIGURATION-ID__
52169         - name: metaname
52170           in: path
52171           required: true
52172           type: string
52173           example: __METANAME__
52174         - name: resource-version
52175           in: query
52176           description: resource-version for concurrency
52177           required: true
52178           type: string
52179   /network/configurations/configuration/{configuration-id}/metadata:
52180     get:
52181       tags:
52182         - Network
52183       summary: returns metadata
52184       description: returns metadata
52185       operationId: getNetworkConfigurationsConfigurationMetadata
52186       produces:
52187         - application/json
52188         - application/xml
52189       responses:
52190         "200":
52191           description: successful operation
52192           schema:
52193               $ref: "#/getDefinitions/metadata"
52194         "default":
52195           description: Response codes found in [response codes](https://wiki.onap.org/).
52196       parameters:
52197         - name: configuration-id
52198           in: path
52199           description: UUID assigned to configuration.
52200           required: true
52201           type: string
52202           example: __CONFIGURATION-ID__
52203         - name: model-invariant-id
52204           in: query
52205           description: the ASDC model id for this resource or service model.
52206           required: false
52207           type: string
52208         - name: model-version-id
52209           in: query
52210           description: the ASDC model version for this resource or service model.
52211           required: false
52212           type: string
52213   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
52214     put:
52215       tags:
52216         - Network
52217       summary: see node definition for valid relationships
52218       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
52219       consumes:
52220         - application/json
52221         - application/xml
52222       produces:
52223         - application/json
52224         - application/xml
52225       responses:
52226         "default":
52227           description: Response codes found in [response codes](https://wiki.onap.org/).
52228       parameters:
52229         - name: configuration-id
52230           in: path
52231           description: UUID assigned to configuration.
52232           required: true
52233           type: string
52234           example: __CONFIGURATION-ID__
52235         - name: forwarder-evc-id
52236           in: path
52237           description: Key for forwarder-evc object
52238           required: true
52239           type: string
52240           example: __FORWARDER-EVC-ID__
52241         - name: body
52242           in: body
52243           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
52244           required: true
52245           schema:
52246             $ref: "#/definitions/relationship"
52247     delete:
52248       tags:
52249         - Network
52250       summary: delete an existing relationship
52251       description: delete an existing relationship
52252       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
52253       consumes:
52254         - application/json
52255         - application/xml
52256       produces:
52257         - application/json
52258         - application/xml
52259       responses:
52260         "default":
52261           description: Response codes found in [response codes](https://wiki.onap.org/).
52262       parameters:
52263         - name: configuration-id
52264           in: path
52265           description: UUID assigned to configuration.
52266           required: true
52267           type: string
52268           example: __CONFIGURATION-ID__
52269         - name: forwarder-evc-id
52270           in: path
52271           description: Key for forwarder-evc object
52272           required: true
52273           type: string
52274           example: __FORWARDER-EVC-ID__
52275   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
52276     get:
52277       tags:
52278         - Network
52279       summary: returns forwarder-evc
52280       description: returns forwarder-evc
52281       operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
52282       produces:
52283         - application/json
52284         - application/xml
52285       responses:
52286         "200":
52287           description: successful operation
52288           schema:
52289               $ref: "#/getDefinitions/forwarder-evc"
52290         "default":
52291           description: Response codes found in [response codes](https://wiki.onap.org/).
52292       parameters:
52293         - name: configuration-id
52294           in: path
52295           description: UUID assigned to configuration.
52296           required: true
52297           type: string
52298           example: __CONFIGURATION-ID__
52299         - name: forwarder-evc-id
52300           in: path
52301           description: Key for forwarder-evc object
52302           required: true
52303           type: string
52304           example: __FORWARDER-EVC-ID__
52305         - name: model-invariant-id
52306           in: query
52307           description: the ASDC model id for this resource or service model.
52308           required: false
52309           type: string
52310         - name: model-version-id
52311           in: query
52312           description: the ASDC model version for this resource or service model.
52313           required: false
52314           type: string
52315     put:
52316       tags:
52317         - Network
52318       summary: create or update an existing forwarder-evc
52319       description: |
52320         Create or update an existing forwarder-evc.
52321         #
52322         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52323       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
52324       consumes:
52325         - application/json
52326         - application/xml
52327       produces:
52328         - application/json
52329         - application/xml
52330       responses:
52331         "default":
52332           description: Response codes found in [response codes](https://wiki.onap.org/).
52333       parameters:
52334         - name: configuration-id
52335           in: path
52336           description: UUID assigned to configuration.
52337           required: true
52338           type: string
52339           example: __CONFIGURATION-ID__
52340         - name: forwarder-evc-id
52341           in: path
52342           description: Key for forwarder-evc object
52343           required: true
52344           type: string
52345           example: __FORWARDER-EVC-ID__
52346         - name: body
52347           in: body
52348           description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
52349           required: true
52350           schema:
52351             $ref: "#/definitions/forwarder-evc"
52352     patch:
52353       tags:
52354         - Network
52355       summary: update an existing forwarder-evc
52356       description: |
52357         Update an existing forwarder-evc
52358         #
52359         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52360         The PUT operation will entirely replace an existing object.
52361         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52362         #
52363         Other differences between PUT and PATCH are:
52364         #
52365         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52366         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52367         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52368       operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
52369       consumes:
52370         - application/json
52371         - application/xml
52372       produces:
52373         - application/json
52374         - application/xml
52375       responses:
52376         "default":
52377           description: Response codes found in [response codes](https://wiki.onap.org/).
52378       parameters:
52379         - name: configuration-id
52380           in: path
52381           description: UUID assigned to configuration.
52382           required: true
52383           type: string
52384           example: __CONFIGURATION-ID__
52385         - name: forwarder-evc-id
52386           in: path
52387           description: Key for forwarder-evc object
52388           required: true
52389           type: string
52390           example: __FORWARDER-EVC-ID__
52391         - name: body
52392           in: body
52393           description: forwarder-evc object that needs to be created or updated.
52394           required: true
52395           schema:
52396             $ref: "#/patchDefinitions/forwarder-evc"
52397     delete:
52398       tags:
52399         - Network
52400       summary: delete an existing forwarder-evc
52401       description: delete an existing forwarder-evc
52402       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
52403       consumes:
52404         - application/json
52405         - application/xml
52406       produces:
52407         - application/json
52408         - application/xml
52409       responses:
52410         "default":
52411           description: Response codes found in [response codes](https://wiki.onap.org/).
52412       parameters:
52413         - name: configuration-id
52414           in: path
52415           description: UUID assigned to configuration.
52416           required: true
52417           type: string
52418           example: __CONFIGURATION-ID__
52419         - name: forwarder-evc-id
52420           in: path
52421           description: Key for forwarder-evc object
52422           required: true
52423           type: string
52424           example: __FORWARDER-EVC-ID__
52425         - name: resource-version
52426           in: query
52427           description: resource-version for concurrency
52428           required: true
52429           type: string
52430   /network/configurations/configuration/{configuration-id}/forwarder-evcs:
52431     get:
52432       tags:
52433         - Network
52434       summary: returns forwarder-evcs
52435       description: returns forwarder-evcs
52436       operationId: getNetworkConfigurationsConfigurationForwarderEvcs
52437       produces:
52438         - application/json
52439         - application/xml
52440       responses:
52441         "200":
52442           description: successful operation
52443           schema:
52444               $ref: "#/getDefinitions/forwarder-evcs"
52445         "default":
52446           description: Response codes found in [response codes](https://wiki.onap.org/).
52447       parameters:
52448         - name: configuration-id
52449           in: path
52450           description: UUID assigned to configuration.
52451           required: true
52452           type: string
52453           example: __CONFIGURATION-ID__
52454         - name: model-invariant-id
52455           in: query
52456           description: the ASDC model id for this resource or service model.
52457           required: false
52458           type: string
52459         - name: model-version-id
52460           in: query
52461           description: the ASDC model version for this resource or service model.
52462           required: false
52463           type: string
52464   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
52465     put:
52466       tags:
52467         - Network
52468       summary: see node definition for valid relationships
52469       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
52470       consumes:
52471         - application/json
52472         - application/xml
52473       produces:
52474         - application/json
52475         - application/xml
52476       responses:
52477         "default":
52478           description: Response codes found in [response codes](https://wiki.onap.org/).
52479       parameters:
52480         - name: configuration-id
52481           in: path
52482           description: UUID assigned to configuration.
52483           required: true
52484           type: string
52485           example: __CONFIGURATION-ID__
52486         - name: evc-id
52487           in: path
52488           description: Unique/key field for the evc object
52489           required: true
52490           type: string
52491           example: __EVC-ID__
52492         - name: body
52493           in: body
52494           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
52495           required: true
52496           schema:
52497             $ref: "#/definitions/relationship"
52498     delete:
52499       tags:
52500         - Network
52501       summary: delete an existing relationship
52502       description: delete an existing relationship
52503       operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
52504       consumes:
52505         - application/json
52506         - application/xml
52507       produces:
52508         - application/json
52509         - application/xml
52510       responses:
52511         "default":
52512           description: Response codes found in [response codes](https://wiki.onap.org/).
52513       parameters:
52514         - name: configuration-id
52515           in: path
52516           description: UUID assigned to configuration.
52517           required: true
52518           type: string
52519           example: __CONFIGURATION-ID__
52520         - name: evc-id
52521           in: path
52522           description: Unique/key field for the evc object
52523           required: true
52524           type: string
52525           example: __EVC-ID__
52526   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
52527     get:
52528       tags:
52529         - Network
52530       summary: returns evc
52531       description: returns evc
52532       operationId: getNetworkConfigurationsConfigurationEvcsEvc
52533       produces:
52534         - application/json
52535         - application/xml
52536       responses:
52537         "200":
52538           description: successful operation
52539           schema:
52540               $ref: "#/getDefinitions/evc"
52541         "default":
52542           description: Response codes found in [response codes](https://wiki.onap.org/).
52543       parameters:
52544         - name: configuration-id
52545           in: path
52546           description: UUID assigned to configuration.
52547           required: true
52548           type: string
52549           example: __CONFIGURATION-ID__
52550         - name: evc-id
52551           in: path
52552           description: Unique/key field for the evc object
52553           required: true
52554           type: string
52555           example: __EVC-ID__
52556         - name: model-invariant-id
52557           in: query
52558           description: the ASDC model id for this resource or service model.
52559           required: false
52560           type: string
52561         - name: model-version-id
52562           in: query
52563           description: the ASDC model version for this resource or service model.
52564           required: false
52565           type: string
52566     put:
52567       tags:
52568         - Network
52569       summary: create or update an existing evc
52570       description: |
52571         Create or update an existing evc.
52572         #
52573         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52574       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
52575       consumes:
52576         - application/json
52577         - application/xml
52578       produces:
52579         - application/json
52580         - application/xml
52581       responses:
52582         "default":
52583           description: Response codes found in [response codes](https://wiki.onap.org/).
52584       parameters:
52585         - name: configuration-id
52586           in: path
52587           description: UUID assigned to configuration.
52588           required: true
52589           type: string
52590           example: __CONFIGURATION-ID__
52591         - name: evc-id
52592           in: path
52593           description: Unique/key field for the evc object
52594           required: true
52595           type: string
52596           example: __EVC-ID__
52597         - name: body
52598           in: body
52599           description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
52600           required: true
52601           schema:
52602             $ref: "#/definitions/evc"
52603     patch:
52604       tags:
52605         - Network
52606       summary: update an existing evc
52607       description: |
52608         Update an existing evc
52609         #
52610         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52611         The PUT operation will entirely replace an existing object.
52612         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52613         #
52614         Other differences between PUT and PATCH are:
52615         #
52616         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52617         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52618         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52619       operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
52620       consumes:
52621         - application/json
52622         - application/xml
52623       produces:
52624         - application/json
52625         - application/xml
52626       responses:
52627         "default":
52628           description: Response codes found in [response codes](https://wiki.onap.org/).
52629       parameters:
52630         - name: configuration-id
52631           in: path
52632           description: UUID assigned to configuration.
52633           required: true
52634           type: string
52635           example: __CONFIGURATION-ID__
52636         - name: evc-id
52637           in: path
52638           description: Unique/key field for the evc object
52639           required: true
52640           type: string
52641           example: __EVC-ID__
52642         - name: body
52643           in: body
52644           description: evc object that needs to be created or updated.
52645           required: true
52646           schema:
52647             $ref: "#/patchDefinitions/evc"
52648     delete:
52649       tags:
52650         - Network
52651       summary: delete an existing evc
52652       description: delete an existing evc
52653       operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
52654       consumes:
52655         - application/json
52656         - application/xml
52657       produces:
52658         - application/json
52659         - application/xml
52660       responses:
52661         "default":
52662           description: Response codes found in [response codes](https://wiki.onap.org/).
52663       parameters:
52664         - name: configuration-id
52665           in: path
52666           description: UUID assigned to configuration.
52667           required: true
52668           type: string
52669           example: __CONFIGURATION-ID__
52670         - name: evc-id
52671           in: path
52672           description: Unique/key field for the evc object
52673           required: true
52674           type: string
52675           example: __EVC-ID__
52676         - name: resource-version
52677           in: query
52678           description: resource-version for concurrency
52679           required: true
52680           type: string
52681   /network/configurations/configuration/{configuration-id}/evcs:
52682     get:
52683       tags:
52684         - Network
52685       summary: returns evcs
52686       description: returns evcs
52687       operationId: getNetworkConfigurationsConfigurationEvcs
52688       produces:
52689         - application/json
52690         - application/xml
52691       responses:
52692         "200":
52693           description: successful operation
52694           schema:
52695               $ref: "#/getDefinitions/evcs"
52696         "default":
52697           description: Response codes found in [response codes](https://wiki.onap.org/).
52698       parameters:
52699         - name: configuration-id
52700           in: path
52701           description: UUID assigned to configuration.
52702           required: true
52703           type: string
52704           example: __CONFIGURATION-ID__
52705         - name: model-invariant-id
52706           in: query
52707           description: the ASDC model id for this resource or service model.
52708           required: false
52709           type: string
52710         - name: model-version-id
52711           in: query
52712           description: the ASDC model version for this resource or service model.
52713           required: false
52714           type: string
52715   /network/configurations/configuration/{configuration-id}:
52716     get:
52717       tags:
52718         - Network
52719       summary: returns configuration
52720       description: returns configuration
52721       operationId: getNetworkConfigurationsConfiguration
52722       produces:
52723         - application/json
52724         - application/xml
52725       responses:
52726         "200":
52727           description: successful operation
52728           schema:
52729               $ref: "#/getDefinitions/configuration"
52730         "default":
52731           description: Response codes found in [response codes](https://wiki.onap.org/).
52732       parameters:
52733         - name: configuration-id
52734           in: path
52735           description: UUID assigned to configuration.
52736           required: true
52737           type: string
52738           example: __CONFIGURATION-ID__
52739         - name: model-invariant-id
52740           in: query
52741           description: the ASDC model id for this resource or service model.
52742           required: false
52743           type: string
52744         - name: model-version-id
52745           in: query
52746           description: the ASDC model version for this resource or service model.
52747           required: false
52748           type: string
52749     put:
52750       tags:
52751         - Network
52752       summary: create or update an existing configuration
52753       description: |
52754         Create or update an existing configuration.
52755         #
52756         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52757       operationId: createOrUpdateNetworkConfigurationsConfiguration
52758       consumes:
52759         - application/json
52760         - application/xml
52761       produces:
52762         - application/json
52763         - application/xml
52764       responses:
52765         "default":
52766           description: Response codes found in [response codes](https://wiki.onap.org/).
52767       parameters:
52768         - name: configuration-id
52769           in: path
52770           description: UUID assigned to configuration.
52771           required: true
52772           type: string
52773           example: __CONFIGURATION-ID__
52774         - name: body
52775           in: body
52776           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
52777           required: true
52778           schema:
52779             $ref: "#/definitions/configuration"
52780     patch:
52781       tags:
52782         - Network
52783       summary: update an existing configuration
52784       description: |
52785         Update an existing configuration
52786         #
52787         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52788         The PUT operation will entirely replace an existing object.
52789         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52790         #
52791         Other differences between PUT and PATCH are:
52792         #
52793         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52794         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52795         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52796       operationId: UpdateNetworkConfigurationsConfiguration
52797       consumes:
52798         - application/json
52799         - application/xml
52800       produces:
52801         - application/json
52802         - application/xml
52803       responses:
52804         "default":
52805           description: Response codes found in [response codes](https://wiki.onap.org/).
52806       parameters:
52807         - name: configuration-id
52808           in: path
52809           description: UUID assigned to configuration.
52810           required: true
52811           type: string
52812           example: __CONFIGURATION-ID__
52813         - name: body
52814           in: body
52815           description: configuration object that needs to be created or updated.
52816           required: true
52817           schema:
52818             $ref: "#/patchDefinitions/configuration"
52819     delete:
52820       tags:
52821         - Network
52822       summary: delete an existing configuration
52823       description: delete an existing configuration
52824       operationId: deleteNetworkConfigurationsConfiguration
52825       consumes:
52826         - application/json
52827         - application/xml
52828       produces:
52829         - application/json
52830         - application/xml
52831       responses:
52832         "default":
52833           description: Response codes found in [response codes](https://wiki.onap.org/).
52834       parameters:
52835         - name: configuration-id
52836           in: path
52837           description: UUID assigned to configuration.
52838           required: true
52839           type: string
52840           example: __CONFIGURATION-ID__
52841         - name: resource-version
52842           in: query
52843           description: resource-version for concurrency
52844           required: true
52845           type: string
52846   /network/configurations:
52847     get:
52848       tags:
52849         - Network
52850       summary: returns configurations
52851       description: returns configurations
52852       operationId: getNetworkConfigurations
52853       produces:
52854         - application/json
52855         - application/xml
52856       responses:
52857         "200":
52858           description: successful operation
52859           schema:
52860               $ref: "#/getDefinitions/configurations"
52861         "default":
52862           description: Response codes found in [response codes](https://wiki.onap.org/).
52863   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
52864     put:
52865       tags:
52866         - Network
52867       summary: see node definition for valid relationships
52868       operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
52869       consumes:
52870         - application/json
52871         - application/xml
52872       produces:
52873         - application/json
52874         - application/xml
52875       responses:
52876         "default":
52877           description: Response codes found in [response codes](https://wiki.onap.org/).
52878       parameters:
52879         - name: forwarding-path-id
52880           in: path
52881           description: Unique ID of this FP
52882           required: true
52883           type: string
52884           example: __FORWARDING-PATH-ID__
52885         - name: body
52886           in: body
52887           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
52888           required: true
52889           schema:
52890             $ref: "#/definitions/relationship"
52891     delete:
52892       tags:
52893         - Network
52894       summary: delete an existing relationship
52895       description: delete an existing relationship
52896       operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
52897       consumes:
52898         - application/json
52899         - application/xml
52900       produces:
52901         - application/json
52902         - application/xml
52903       responses:
52904         "default":
52905           description: Response codes found in [response codes](https://wiki.onap.org/).
52906       parameters:
52907         - name: forwarding-path-id
52908           in: path
52909           description: Unique ID of this FP
52910           required: true
52911           type: string
52912           example: __FORWARDING-PATH-ID__
52913   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
52914     put:
52915       tags:
52916         - Network
52917       summary: see node definition for valid relationships
52918       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
52919       consumes:
52920         - application/json
52921         - application/xml
52922       produces:
52923         - application/json
52924         - application/xml
52925       responses:
52926         "default":
52927           description: Response codes found in [response codes](https://wiki.onap.org/).
52928       parameters:
52929         - name: forwarding-path-id
52930           in: path
52931           description: Unique ID of this FP
52932           required: true
52933           type: string
52934           example: __FORWARDING-PATH-ID__
52935         - name: sequence
52936           in: path
52937           description: Unique ID of this segmentation
52938           required: true
52939           type: integer
52940           format: int32
52941           example: __SEQUENCE__
52942         - name: body
52943           in: body
52944           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
52945           required: true
52946           schema:
52947             $ref: "#/definitions/relationship"
52948     delete:
52949       tags:
52950         - Network
52951       summary: delete an existing relationship
52952       description: delete an existing relationship
52953       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
52954       consumes:
52955         - application/json
52956         - application/xml
52957       produces:
52958         - application/json
52959         - application/xml
52960       responses:
52961         "default":
52962           description: Response codes found in [response codes](https://wiki.onap.org/).
52963       parameters:
52964         - name: forwarding-path-id
52965           in: path
52966           description: Unique ID of this FP
52967           required: true
52968           type: string
52969           example: __FORWARDING-PATH-ID__
52970         - name: sequence
52971           in: path
52972           description: Unique ID of this segmentation
52973           required: true
52974           type: integer
52975           format: int32
52976           example: __SEQUENCE__
52977   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
52978     get:
52979       tags:
52980         - Network
52981       summary: returns forwarder
52982       description: returns forwarder
52983       operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
52984       produces:
52985         - application/json
52986         - application/xml
52987       responses:
52988         "200":
52989           description: successful operation
52990           schema:
52991               $ref: "#/getDefinitions/forwarder"
52992         "default":
52993           description: Response codes found in [response codes](https://wiki.onap.org/).
52994       parameters:
52995         - name: forwarding-path-id
52996           in: path
52997           description: Unique ID of this FP
52998           required: true
52999           type: string
53000           example: __FORWARDING-PATH-ID__
53001         - name: sequence
53002           in: path
53003           description: Unique ID of this segmentation
53004           required: true
53005           type: integer
53006           format: int32
53007           example: __SEQUENCE__
53008         - name: forwarding-path-name
53009           in: query
53010           description: Name of the FP
53011           required: false
53012           type: string
53013     put:
53014       tags:
53015         - Network
53016       summary: create or update an existing forwarder
53017       description: |
53018         Create or update an existing forwarder.
53019         #
53020         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53021       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
53022       consumes:
53023         - application/json
53024         - application/xml
53025       produces:
53026         - application/json
53027         - application/xml
53028       responses:
53029         "default":
53030           description: Response codes found in [response codes](https://wiki.onap.org/).
53031       parameters:
53032         - name: forwarding-path-id
53033           in: path
53034           description: Unique ID of this FP
53035           required: true
53036           type: string
53037           example: __FORWARDING-PATH-ID__
53038         - name: sequence
53039           in: path
53040           description: Unique ID of this segmentation
53041           required: true
53042           type: integer
53043           format: int32
53044           example: __SEQUENCE__
53045         - name: body
53046           in: body
53047           description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
53048           required: true
53049           schema:
53050             $ref: "#/definitions/forwarder"
53051     patch:
53052       tags:
53053         - Network
53054       summary: update an existing forwarder
53055       description: |
53056         Update an existing forwarder
53057         #
53058         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53059         The PUT operation will entirely replace an existing object.
53060         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53061         #
53062         Other differences between PUT and PATCH are:
53063         #
53064         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53065         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53066         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53067       operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
53068       consumes:
53069         - application/json
53070         - application/xml
53071       produces:
53072         - application/json
53073         - application/xml
53074       responses:
53075         "default":
53076           description: Response codes found in [response codes](https://wiki.onap.org/).
53077       parameters:
53078         - name: forwarding-path-id
53079           in: path
53080           description: Unique ID of this FP
53081           required: true
53082           type: string
53083           example: __FORWARDING-PATH-ID__
53084         - name: sequence
53085           in: path
53086           description: Unique ID of this segmentation
53087           required: true
53088           type: integer
53089           format: int32
53090           example: __SEQUENCE__
53091         - name: body
53092           in: body
53093           description: forwarder object that needs to be created or updated.
53094           required: true
53095           schema:
53096             $ref: "#/patchDefinitions/forwarder"
53097     delete:
53098       tags:
53099         - Network
53100       summary: delete an existing forwarder
53101       description: delete an existing forwarder
53102       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
53103       consumes:
53104         - application/json
53105         - application/xml
53106       produces:
53107         - application/json
53108         - application/xml
53109       responses:
53110         "default":
53111           description: Response codes found in [response codes](https://wiki.onap.org/).
53112       parameters:
53113         - name: forwarding-path-id
53114           in: path
53115           description: Unique ID of this FP
53116           required: true
53117           type: string
53118           example: __FORWARDING-PATH-ID__
53119         - name: sequence
53120           in: path
53121           description: Unique ID of this segmentation
53122           required: true
53123           type: integer
53124           format: int32
53125           example: __SEQUENCE__
53126         - name: resource-version
53127           in: query
53128           description: resource-version for concurrency
53129           required: true
53130           type: string
53131   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
53132     get:
53133       tags:
53134         - Network
53135       summary: returns forwarders
53136       description: returns forwarders
53137       operationId: getNetworkForwardingPathsForwardingPathForwarders
53138       produces:
53139         - application/json
53140         - application/xml
53141       responses:
53142         "200":
53143           description: successful operation
53144           schema:
53145               $ref: "#/getDefinitions/forwarders"
53146         "default":
53147           description: Response codes found in [response codes](https://wiki.onap.org/).
53148       parameters:
53149         - name: forwarding-path-id
53150           in: path
53151           description: Unique ID of this FP
53152           required: true
53153           type: string
53154           example: __FORWARDING-PATH-ID__
53155         - name: forwarding-path-name
53156           in: query
53157           description: Name of the FP
53158           required: false
53159           type: string
53160   /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
53161     get:
53162       tags:
53163         - Network
53164       summary: returns forwarding-path
53165       description: returns forwarding-path
53166       operationId: getNetworkForwardingPathsForwardingPath
53167       produces:
53168         - application/json
53169         - application/xml
53170       responses:
53171         "200":
53172           description: successful operation
53173           schema:
53174               $ref: "#/getDefinitions/forwarding-path"
53175         "default":
53176           description: Response codes found in [response codes](https://wiki.onap.org/).
53177       parameters:
53178         - name: forwarding-path-id
53179           in: path
53180           description: Unique ID of this FP
53181           required: true
53182           type: string
53183           example: __FORWARDING-PATH-ID__
53184         - name: forwarding-path-name
53185           in: query
53186           description: Name of the FP
53187           required: false
53188           type: string
53189     put:
53190       tags:
53191         - Network
53192       summary: create or update an existing forwarding-path
53193       description: |
53194         Create or update an existing forwarding-path.
53195         #
53196         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53197       operationId: createOrUpdateNetworkForwardingPathsForwardingPath
53198       consumes:
53199         - application/json
53200         - application/xml
53201       produces:
53202         - application/json
53203         - application/xml
53204       responses:
53205         "default":
53206           description: Response codes found in [response codes](https://wiki.onap.org/).
53207       parameters:
53208         - name: forwarding-path-id
53209           in: path
53210           description: Unique ID of this FP
53211           required: true
53212           type: string
53213           example: __FORWARDING-PATH-ID__
53214         - name: body
53215           in: body
53216           description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
53217           required: true
53218           schema:
53219             $ref: "#/definitions/forwarding-path"
53220     patch:
53221       tags:
53222         - Network
53223       summary: update an existing forwarding-path
53224       description: |
53225         Update an existing forwarding-path
53226         #
53227         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53228         The PUT operation will entirely replace an existing object.
53229         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53230         #
53231         Other differences between PUT and PATCH are:
53232         #
53233         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53234         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53235         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53236       operationId: UpdateNetworkForwardingPathsForwardingPath
53237       consumes:
53238         - application/json
53239         - application/xml
53240       produces:
53241         - application/json
53242         - application/xml
53243       responses:
53244         "default":
53245           description: Response codes found in [response codes](https://wiki.onap.org/).
53246       parameters:
53247         - name: forwarding-path-id
53248           in: path
53249           description: Unique ID of this FP
53250           required: true
53251           type: string
53252           example: __FORWARDING-PATH-ID__
53253         - name: body
53254           in: body
53255           description: forwarding-path object that needs to be created or updated.
53256           required: true
53257           schema:
53258             $ref: "#/patchDefinitions/forwarding-path"
53259     delete:
53260       tags:
53261         - Network
53262       summary: delete an existing forwarding-path
53263       description: delete an existing forwarding-path
53264       operationId: deleteNetworkForwardingPathsForwardingPath
53265       consumes:
53266         - application/json
53267         - application/xml
53268       produces:
53269         - application/json
53270         - application/xml
53271       responses:
53272         "default":
53273           description: Response codes found in [response codes](https://wiki.onap.org/).
53274       parameters:
53275         - name: forwarding-path-id
53276           in: path
53277           description: Unique ID of this FP
53278           required: true
53279           type: string
53280           example: __FORWARDING-PATH-ID__
53281         - name: resource-version
53282           in: query
53283           description: resource-version for concurrency
53284           required: true
53285           type: string
53286   /network/forwarding-paths:
53287     get:
53288       tags:
53289         - Network
53290       summary: returns forwarding-paths
53291       description: returns forwarding-paths
53292       operationId: getNetworkForwardingPaths
53293       produces:
53294         - application/json
53295         - application/xml
53296       responses:
53297         "200":
53298           description: successful operation
53299           schema:
53300               $ref: "#/getDefinitions/forwarding-paths"
53301         "default":
53302           description: Response codes found in [response codes](https://wiki.onap.org/).
53303 definitions:
53304   aai-internal:
53305     properties:
53306       property-name:
53307         type: string
53308       property-value:
53309         type: string
53310   action:
53311     properties:
53312       action-type:
53313         type: string
53314       action-data:
53315         type: array
53316         items:
53317           $ref: "#/definitions/action-data"
53318   action-data:
53319     properties:
53320       property-name:
53321         type: string
53322       property-value:
53323         type: string
53324   actions:
53325     description: |
53326       APIs that are more action related than REST (e.g., notify, update).
53327     properties:
53328       update:
53329         type: object
53330         $ref: "#/definitions/update"
53331       notify:
53332         type: object
53333         $ref: "#/definitions/notify"
53334   allotted-resource:
53335     description: |
53336       Represents a slice or partial piece of a resource that gets separately allotted
53337       ###### Related Nodes
53338       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
53339       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53340       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53341       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
53342       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
53343       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
53344       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
53345       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
53346       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
53347       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
53348       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
53349       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
53350       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
53351       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
53352       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
53353     required:
53354     - id
53355     properties:
53356       id:
53357         type: string
53358         description: Allotted Resource id UUID assigned to this instance.
53359       description:
53360         type: string
53361         description: The descriptive information assigned to this allotted resource instance
53362       selflink:
53363         type: string
53364         description: Link back to more information in the controller
53365       model-invariant-id:
53366         type: string
53367         description: the ASDC model id for this resource or service model.
53368       model-version-id:
53369         type: string
53370         description: the ASDC model version for this resource or service model.
53371       persona-model-version:
53372         type: string
53373         description: the ASDC model version for this resource or service model.
53374       resource-version:
53375         type: string
53376         description: Concurrency value
53377       orchestration-status:
53378         type: string
53379         description: Orchestration status
53380       operational-status:
53381         type: string
53382         description: Indicator for whether the resource is considered operational
53383       type:
53384         type: string
53385         description: Generic description of the type of allotted resource.
53386       role:
53387         type: string
53388         description: role in the network that this resource will be providing.
53389       tunnel-xconnects:
53390         type: array
53391         items:
53392           $ref: "#/definitions/tunnel-xconnect"
53393       relationship-list:
53394         type: array
53395         items:
53396           $ref: "#/definitions/relationship"
53397   allotted-resources:
53398     description: |
53399       This object is used to store slices of services being offered
53400     properties:
53401       allotted-resource:
53402         type: array
53403         items:
53404           $ref: "#/definitions/allotted-resource"
53405   availability-zone:
53406     description: |
53407       Availability zone, a collection of compute hosts/pservers
53408       ###### Related Nodes
53409       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53410       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
53411       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53412       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53413       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53414       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53415       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
53416       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53417       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
53418     required:
53419     - availability-zone-name
53420     - hypervisor-type
53421     properties:
53422       availability-zone-name:
53423         type: string
53424         description: Name of the availability zone.  Unique across a cloud region
53425       hypervisor-type:
53426         type: string
53427         description: Type of hypervisor.  Source of truth should define valid values.
53428       operational-status:
53429         type: string
53430         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
53431       resource-version:
53432         type: string
53433         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53434       relationship-list:
53435         type: array
53436         items:
53437           $ref: "#/definitions/relationship"
53438   availability-zones:
53439     description: |
53440       Collection of availability zones
53441     properties:
53442       availability-zone:
53443         type: array
53444         items:
53445           $ref: "#/definitions/availability-zone"
53446   az-and-dvs-switches:
53447     properties:
53448       dvs-switches:
53449         type: object
53450         $ref: "#/definitions/dvs-switches"
53451       availability-zone:
53452         type: object
53453         $ref: "#/definitions/availability-zone"
53454   business:
53455     description: |
53456       Namespace for business related constructs
53457     properties:
53458       connectors:
53459         type: array
53460         items:
53461           $ref: "#/definitions/connector"
53462       customers:
53463         type: array
53464         items:
53465           $ref: "#/definitions/customer"
53466       lines-of-business:
53467         type: array
53468         items:
53469           $ref: "#/definitions/line-of-business"
53470       owning-entities:
53471         type: array
53472         items:
53473           $ref: "#/definitions/owning-entity"
53474       platforms:
53475         type: array
53476         items:
53477           $ref: "#/definitions/platform"
53478       projects:
53479         type: array
53480         items:
53481           $ref: "#/definitions/project"
53482   class-of-service:
53483     description: |
53484       ###### Related Nodes
53485       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
53486     required:
53487     - cos
53488     properties:
53489       cos:
53490         type: string
53491         description: unique identifier of probe
53492       probe-id:
53493         type: string
53494         description: identifier of probe
53495       probe-type:
53496         type: string
53497         description: type of probe
53498       resource-version:
53499         type: string
53500         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53501       relationship-list:
53502         type: array
53503         items:
53504           $ref: "#/definitions/relationship"
53505   classes-of-service:
53506     description: |
53507       class-of-service of probe
53508     properties:
53509       class-of-service:
53510         type: array
53511         items:
53512           $ref: "#/definitions/class-of-service"
53513   cloud-infrastructure:
53514     description: |
53515       Namespace for cloud infrastructure.
53516     properties:
53517       complexes:
53518         type: array
53519         items:
53520           $ref: "#/definitions/complex"
53521       cloud-regions:
53522         type: array
53523         items:
53524           $ref: "#/definitions/cloud-region"
53525       network-profiles:
53526         type: array
53527         items:
53528           $ref: "#/definitions/network-profile"
53529       pservers:
53530         type: array
53531         items:
53532           $ref: "#/definitions/pserver"
53533       virtual-data-centers:
53534         type: array
53535         items:
53536           $ref: "#/definitions/virtual-data-center"
53537       operational-environments:
53538         type: array
53539         items:
53540           $ref: "#/definitions/operational-environment"
53541   cloud-region:
53542     description: |
53543       cloud-region designates an installation of a cloud cluster or region or instantiation.
53544       ###### Related Nodes
53545       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
53546       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53547       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53548       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53549       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53550       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53551       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53552       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53553       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53554       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53555       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53556       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53557       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53558       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53559       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53560       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
53561       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
53562       - 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
53563       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
53564       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53565     required:
53566     - cloud-owner
53567     - cloud-region-id
53568     - sriov-automation
53569     properties:
53570       cloud-owner:
53571         type: string
53572         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53573       cloud-region-id:
53574         type: string
53575         description: Identifier used by the vendor for the region. Second part of composite key
53576       cloud-type:
53577         type: string
53578         description: Type of the cloud (e.g., openstack)
53579       owner-defined-type:
53580         type: string
53581         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53582       cloud-region-version:
53583         type: string
53584         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
53585       identity-url:
53586         type: string
53587         description: URL of the keystone identity service
53588       cloud-zone:
53589         type: string
53590         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53591       complex-name:
53592         type: string
53593         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53594       sriov-automation:
53595         type: boolean
53596       cloud-extra-info:
53597         type: string
53598         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
53599       cloud-epa-caps:
53600         type: string
53601         description: MultiVIM will discover and expose EPA capabilities.
53602       resource-version:
53603         type: string
53604         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53605       volume-groups:
53606         type: array
53607         items:
53608           $ref: "#/definitions/volume-group"
53609       tenants:
53610         type: array
53611         items:
53612           $ref: "#/definitions/tenant"
53613       flavors:
53614         type: array
53615         items:
53616           $ref: "#/definitions/flavor"
53617       group-assignments:
53618         type: array
53619         items:
53620           $ref: "#/definitions/group-assignment"
53621       snapshots:
53622         type: array
53623         items:
53624           $ref: "#/definitions/snapshot"
53625       images:
53626         type: array
53627         items:
53628           $ref: "#/definitions/image"
53629       dvs-switches:
53630         type: array
53631         items:
53632           $ref: "#/definitions/dvs-switch"
53633       oam-networks:
53634         type: array
53635         items:
53636           $ref: "#/definitions/oam-network"
53637       availability-zones:
53638         type: array
53639         items:
53640           $ref: "#/definitions/availability-zone"
53641       relationship-list:
53642         type: array
53643         items:
53644           $ref: "#/definitions/relationship"
53645       vip-ipv4-address-list:
53646         type: array
53647         items:
53648           $ref: "#/definitions/vip-ipv4-address-list"
53649       vip-ipv6-address-list:
53650         type: array
53651         items:
53652           $ref: "#/definitions/vip-ipv6-address-list"
53653   cloud-regions:
53654     properties:
53655       cloud-region:
53656         type: array
53657         items:
53658           $ref: "#/definitions/cloud-region"
53659   complex:
53660     description: |
53661       Collection of physical locations that can house cloud-regions.
53662       ###### Related Nodes
53663       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53664       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53665       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53666       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53667       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53668       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
53669       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53670       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53671       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53672       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53673       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53674       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53675       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53676       - COMPLEX is DELETED when these are DELETED CTAG-POOL
53677     required:
53678     - physical-location-id
53679     - physical-location-type
53680     - street1
53681     - city
53682     - postal-code
53683     - country
53684     - region
53685     properties:
53686       physical-location-id:
53687         type: string
53688         description: Unique identifier for physical location, e.g., CLLI
53689       data-center-code:
53690         type: string
53691         description: Data center code which can be an alternate way to identify a complex
53692       complex-name:
53693         type: string
53694         description: Gamma complex name for LCP instance.
53695       identity-url:
53696         type: string
53697         description: URL of the keystone identity service
53698       resource-version:
53699         type: string
53700         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53701       physical-location-type:
53702         type: string
53703         description: Type, e.g., central office, data center.
53704       street1:
53705         type: string
53706       street2:
53707         type: string
53708       city:
53709         type: string
53710       state:
53711         type: string
53712       postal-code:
53713         type: string
53714       country:
53715         type: string
53716       region:
53717         type: string
53718       latitude:
53719         type: string
53720       longitude:
53721         type: string
53722       elevation:
53723         type: string
53724       lata:
53725         type: string
53726       ctag-pools:
53727         type: array
53728         items:
53729           $ref: "#/definitions/ctag-pool"
53730       relationship-list:
53731         type: array
53732         items:
53733           $ref: "#/definitions/relationship"
53734   complexes:
53735     description: |
53736       Collection of physical locations that can house cloud-regions.
53737     properties:
53738       complex:
53739         type: array
53740         items:
53741           $ref: "#/definitions/complex"
53742   configuration:
53743     description: |
53744       Port Mirror Configuration.
53745       ###### Related Nodes
53746       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
53747       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
53748       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
53749       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
53750       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
53751       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53752       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53753       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53754       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53755       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53756       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53757       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
53758       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
53759     required:
53760     - configuration-id
53761     - configuration-type
53762     - configuration-sub-type
53763     - orchestration-status
53764     - operational-status
53765     - configuration-selflink
53766     - model-customization-id
53767     properties:
53768       configuration-id:
53769         type: string
53770         description: UUID assigned to configuration.
53771       management-option:
53772         type: string
53773         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
53774       configuration-name:
53775         type: string
53776         description: Name of the configuration.
53777       configuration-type:
53778         type: string
53779         description: port-mirroring-configuration.
53780       configuration-sub-type:
53781         type: string
53782         description: vprobe, pprobe.
53783       model-invariant-id:
53784         type: string
53785         description: the ASDC model id for this resource or service model.
53786       model-version-id:
53787         type: string
53788         description: the ASDC model version for this resource or service model.
53789       orchestration-status:
53790         type: string
53791         description: Orchestration status of the configuration.
53792       operational-status:
53793         type: string
53794         description: Indicator for whether the resource is considered operational.
53795       configuration-selflink:
53796         type: string
53797         description: URL to endpoint where AAI can get more details from SDN-GC.
53798       model-customization-id:
53799         type: string
53800         description: id of  the configuration used to customize the resource
53801       tunnel-bandwidth:
53802         type: string
53803         description: DHV Site Effective Bandwidth
53804       vendor-allowed-max-bandwidth:
53805         type: string
53806         description: Velocloud Nominal Throughput - VNT
53807       resource-version:
53808         type: string
53809         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53810       relationship-list:
53811         type: array
53812         items:
53813           $ref: "#/definitions/relationship"
53814       metadata:
53815         type: array
53816         items:
53817           $ref: "#/definitions/metadatum"
53818       forwarder-evcs:
53819         type: array
53820         items:
53821           $ref: "#/definitions/forwarder-evc"
53822       evcs:
53823         type: array
53824         items:
53825           $ref: "#/definitions/evc"
53826   configurations:
53827     description: |
53828       Collection of configurations
53829     properties:
53830       configuration:
53831         type: array
53832         items:
53833           $ref: "#/definitions/configuration"
53834   connector:
53835     description: |
53836       Collection of resource instances used to connect a variety of disparate inventory widgets
53837       ###### Related Nodes
53838       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53839       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
53840       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
53841       - CONNECTOR is DELETED when these are DELETED METADATUM
53842     required:
53843     - resource-instance-id
53844     properties:
53845       resource-instance-id:
53846         type: string
53847         description: Unique id of resource instance.
53848       resource-version:
53849         type: string
53850         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53851       model-invariant-id:
53852         type: string
53853         description: the ASDC model id for this resource or service model.
53854       model-version-id:
53855         type: string
53856         description: the ASDC model version for this resource or service model.
53857       persona-model-version:
53858         type: string
53859         description: the ASDC model version for this resource or service model.
53860       widget-model-id:
53861         type: string
53862         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53863       widget-model-version:
53864         type: string
53865         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53866       relationship-list:
53867         type: array
53868         items:
53869           $ref: "#/definitions/relationship"
53870       metadata:
53871         type: array
53872         items:
53873           $ref: "#/definitions/metadatum"
53874   connectors:
53875     description: |
53876       Collection of resource instances used to connect a variety of disparate inventory widgets
53877     properties:
53878       connector:
53879         type: array
53880         items:
53881           $ref: "#/definitions/connector"
53882   constrained-element-set:
53883     description: |
53884       This is how we would capture constraints defining allowed sets of elements.
53885       ###### Related Nodes
53886       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
53887       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
53888       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53889       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
53890     required:
53891     - constrained-element-set-uuid
53892     - constraint-type
53893     - check-type
53894     properties:
53895       constrained-element-set-uuid:
53896         type: string
53897       constraint-type:
53898         type: string
53899       check-type:
53900         type: string
53901       resource-version:
53902         type: string
53903       element-choice-sets:
53904         type: array
53905         items:
53906           $ref: "#/definitions/element-choice-set"
53907       relationship-list:
53908         type: array
53909         items:
53910           $ref: "#/definitions/relationship"
53911   constrained-element-sets:
53912     properties:
53913       constrained-element-set:
53914         type: array
53915         items:
53916           $ref: "#/definitions/constrained-element-set"
53917   ctag-assignment:
53918     description: |
53919       ###### Related Nodes
53920       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53921       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
53922     required:
53923     - vlan-id-inner
53924     properties:
53925       vlan-id-inner:
53926         type: integer
53927         format: int64
53928         description: id.
53929       resource-version:
53930         type: string
53931         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53932       relationship-list:
53933         type: array
53934         items:
53935           $ref: "#/definitions/relationship"
53936   ctag-assignments:
53937     properties:
53938       ctag-assignment:
53939         type: array
53940         items:
53941           $ref: "#/definitions/ctag-assignment"
53942   ctag-pool:
53943     description: |
53944       A collection of C tags (vlan tags) grouped for a specific purpose.
53945       ###### Related Nodes
53946       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53947       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53948       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53949       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53950     required:
53951     - target-pe
53952     - availability-zone-name
53953     - ctag-pool-purpose
53954     properties:
53955       target-pe:
53956         type: string
53957         description: The Target provider edge router
53958       availability-zone-name:
53959         type: string
53960         description: Name of the availability zone
53961       ctag-pool-purpose:
53962         type: string
53963         description: Describes what the intended purpose of this pool is.
53964       ctag-values:
53965         type: string
53966         description: Comma separated list of ctags
53967       resource-version:
53968         type: string
53969         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53970       relationship-list:
53971         type: array
53972         items:
53973           $ref: "#/definitions/relationship"
53974   ctag-pools:
53975     properties:
53976       ctag-pool:
53977         type: array
53978         items:
53979           $ref: "#/definitions/ctag-pool"
53980   customer:
53981     description: |
53982       customer identifiers to provide linkage back to BSS information.
53983       ###### Related Nodes
53984       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53985       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53986     required:
53987     - global-customer-id
53988     - subscriber-name
53989     - subscriber-type
53990     properties:
53991       global-customer-id:
53992         type: string
53993         description: Global customer id used across ECOMP to uniquely identify customer.
53994       subscriber-name:
53995         type: string
53996         description: Subscriber name, an alternate way to retrieve a customer.
53997       subscriber-type:
53998         type: string
53999         description: Subscriber type, a way to provide VID with only the INFRA customers.
54000       resource-version:
54001         type: string
54002         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54003       service-subscriptions:
54004         type: array
54005         items:
54006           $ref: "#/definitions/service-subscription"
54007       relationship-list:
54008         type: array
54009         items:
54010           $ref: "#/definitions/relationship"
54011   customers:
54012     description: |
54013       Collection of customer identifiers to provide linkage back to BSS information.
54014     properties:
54015       customer:
54016         type: array
54017         items:
54018           $ref: "#/definitions/customer"
54019   cvlan-tag-entry:
54020     required:
54021     - cvlan-tag
54022     properties:
54023       cvlan-tag:
54024         type: integer
54025         format: int64
54026         description: See mis-na-virtualization-platform.yang
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   cvlan-tags:
54035     properties:
54036       cvlan-tag-entry:
54037         type: array
54038         items:
54039           $ref: "#/definitions/cvlan-tag-entry"
54040   dvs-switch:
54041     description: |
54042       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.
54043       ###### Related Nodes
54044       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54045       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54046     required:
54047     - switch-name
54048     - vcenter-url
54049     properties:
54050       switch-name:
54051         type: string
54052         description: DVS switch name
54053       vcenter-url:
54054         type: string
54055         description: URL used to reach the vcenter
54056       resource-version:
54057         type: string
54058         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54059       relationship-list:
54060         type: array
54061         items:
54062           $ref: "#/definitions/relationship"
54063   dvs-switches:
54064     description: |
54065       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
54066     properties:
54067       dvs-switch:
54068         type: array
54069         items:
54070           $ref: "#/definitions/dvs-switch"
54071   edge-prop-names:
54072     description: |
54073       Internal map to define the properties of an edge and interpret the map EdgeRules
54074     properties:
54075       edgeLabel:
54076         type: string
54077       direction:
54078         type: string
54079       multiplicityRule:
54080         type: string
54081       contains-other-v:
54082         type: string
54083       delete-other-v:
54084         type: string
54085       SVC-INFRA:
54086         type: string
54087       prevent-delete:
54088         type: string
54089       aai-uuid:
54090         type: string
54091   edge-tag-query-request:
54092     properties:
54093       edge-tag:
54094         type: string
54095       result-detail:
54096         type: string
54097       start-node-type:
54098         type: string
54099       start-node-filter:
54100         type: array
54101         items:
54102           $ref: "#/definitions/start-node-filter"
54103       include-node-filter:
54104         type: array
54105         items:
54106           $ref: "#/definitions/include-node-filter"
54107       secondary-filter:
54108         type: array
54109         items:
54110           $ref: "#/definitions/secondary-filter"
54111   edge-tag-query-result:
54112     properties:
54113       tagged-inventory-item-list:
54114         type: array
54115         items:
54116           $ref: "#/definitions/tagged-inventory-item-list"
54117   element-choice-set:
54118     description: |
54119       This is how we would capture constraints defining allowed sets of elements.
54120       ###### Related Nodes
54121       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54122       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54123       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
54124     required:
54125     - element-choice-set-uuid
54126     - element-choice-set-name
54127     properties:
54128       element-choice-set-uuid:
54129         type: string
54130       element-choice-set-name:
54131         type: string
54132       cardinality:
54133         type: string
54134       resource-version:
54135         type: string
54136       model-elements:
54137         type: array
54138         items:
54139           $ref: "#/definitions/model-element"
54140       relationship-list:
54141         type: array
54142         items:
54143           $ref: "#/definitions/relationship"
54144   element-choice-sets:
54145     properties:
54146       element-choice-set:
54147         type: array
54148         items:
54149           $ref: "#/definitions/element-choice-set"
54150   entitlement:
54151     description: |
54152       Metadata for entitlement group.
54153       ###### Related Nodes
54154       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54155       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54156     required:
54157     - group-uuid
54158     - resource-uuid
54159     properties:
54160       group-uuid:
54161         type: string
54162         description: Unique ID for the entitlement group the resource comes from, should be uuid.
54163       resource-uuid:
54164         type: string
54165         description: Unique ID of an entitlement resource.
54166       resource-version:
54167         type: string
54168         description: Concurrency value
54169       relationship-list:
54170         type: array
54171         items:
54172           $ref: "#/definitions/relationship"
54173   entitlements:
54174     description: |
54175       Entitlements, keyed by group-uuid and resource-uuid, related to license management
54176     properties:
54177       entitlement:
54178         type: array
54179         items:
54180           $ref: "#/definitions/entitlement"
54181   esr-ems:
54182     description: |
54183       Persist EMS address information used by EMS driver.
54184       ###### Related Nodes
54185       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
54186       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54187     required:
54188     - ems-id
54189     properties:
54190       ems-id:
54191         type: string
54192         description: Unique ID of EMS.
54193       resource-version:
54194         type: string
54195         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54196       esr-system-info-list:
54197         type: object
54198         $ref: "#/definitions/esr-system-info-list"
54199       relationship-list:
54200         type: object
54201         $ref: "#/definitions/relationship-list"
54202   esr-ems-list:
54203     properties:
54204       esr-ems:
54205         type: array
54206         items:
54207           $ref: "#/definitions/esr-ems"
54208   esr-system-info:
54209     description: |
54210       Persist common address information of external systems.
54211       ###### Related Nodes
54212       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
54213       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
54214       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
54215       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
54216     required:
54217     - esr-system-info-id
54218     - user-name
54219     - password
54220     - system-type
54221     properties:
54222       esr-system-info-id:
54223         type: string
54224         description: Unique ID of esr system info.
54225       system-name:
54226         type: string
54227         description: name of external system.
54228       type:
54229         type: string
54230         description: type of external systems.
54231       vendor:
54232         type: string
54233         description: vendor of external systems.
54234       version:
54235         type: string
54236         description: version of external systems.
54237       service-url:
54238         type: string
54239         description: url used to access external systems.
54240       user-name:
54241         type: string
54242         description: username used to access external systems.
54243       password:
54244         type: string
54245         description: password used to access external systems.
54246       system-type:
54247         type: string
54248         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
54249       protocol:
54250         type: string
54251         description: protocol of third party SDNC, for example netconf/snmp.
54252       ssl-cacert:
54253         type: string
54254         description: ca file content if enabled ssl on auth-url.
54255       ssl-insecure:
54256         type: boolean
54257         description: Whether to verify VIM's certificate.
54258       ip-address:
54259         type: string
54260         description: service IP of ftp server.
54261       port:
54262         type: string
54263         description: service port of ftp server.
54264       cloud-domain:
54265         type: string
54266         description: domain info for authentication.
54267       default-tenant:
54268         type: string
54269         description: default tenant of VIM.
54270       passive:
54271         type: boolean
54272         description: ftp passive mode or not.
54273       remote-path:
54274         type: string
54275         description: resource or performance data file path.
54276       system-status:
54277         type: string
54278         description: the status of external system.
54279       resource-version:
54280         type: string
54281         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54282       relationship-list:
54283         type: object
54284         $ref: "#/definitions/relationship-list"
54285   esr-system-info-list:
54286     description: |
54287       Collection of persistent block-level external system auth info.
54288     properties:
54289       esr-system-info:
54290         type: array
54291         items:
54292           $ref: "#/definitions/esr-system-info"
54293   esr-thirdparty-sdnc:
54294     description: |
54295       Persist SDNC address information used by ONAP SDNC.
54296       ###### Related Nodes
54297       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
54298       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
54299       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54300     required:
54301     - thirdparty-sdnc-id
54302     properties:
54303       thirdparty-sdnc-id:
54304         type: string
54305         description: Unique ID of SDNC.
54306       location:
54307         type: string
54308         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
54309       product-name:
54310         type: string
54311         description: password used to access SDNC server.
54312       resource-version:
54313         type: string
54314         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54315       esr-system-info-list:
54316         type: object
54317         $ref: "#/definitions/esr-system-info-list"
54318       relationship-list:
54319         type: object
54320         $ref: "#/definitions/relationship-list"
54321   esr-thirdparty-sdnc-list:
54322     properties:
54323       esr-thirdparty-sdnc:
54324         type: array
54325         items:
54326           $ref: "#/definitions/esr-thirdparty-sdnc"
54327   esr-vnfm:
54328     description: |
54329       Persist VNFM address information used by VF-C.
54330       ###### Related Nodes
54331       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
54332       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54333     required:
54334     - vnfm-id
54335     properties:
54336       vnfm-id:
54337         type: string
54338         description: Unique ID of VNFM.
54339       vim-id:
54340         type: string
54341         description: indecate the VIM to deploy VNF.
54342       certificate-url:
54343         type: string
54344         description: certificate url of VNFM.
54345       resource-version:
54346         type: string
54347         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54348       esr-system-info-list:
54349         type: object
54350         $ref: "#/definitions/esr-system-info-list"
54351       relationship-list:
54352         type: object
54353         $ref: "#/definitions/relationship-list"
54354   esr-vnfm-list:
54355     properties:
54356       esr-vnfm:
54357         type: array
54358         items:
54359           $ref: "#/definitions/esr-vnfm"
54360   evc:
54361     description: |
54362       evc object is an optional child object of the Configuration object.
54363       ###### Related Nodes
54364       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54365     required:
54366     - evc-id
54367     properties:
54368       evc-id:
54369         type: string
54370         description: Unique/key field for the evc object
54371       forwarding-path-topology:
54372         type: string
54373         description: Point-to-Point, Multi-Point
54374       cir-value:
54375         type: string
54376         description: Commited Information Rate
54377       cir-units:
54378         type: string
54379         description: CIR units
54380       connection-diversity-group-id:
54381         type: string
54382         description: Diversity Group ID
54383       service-hours:
54384         type: string
54385         description: formerly Performance Group
54386       esp-evc-circuit-id:
54387         type: string
54388         description: EVC Circuit ID of ESP EVC
54389       esp-evc-cir-value:
54390         type: string
54391         description: Committed Information Rate (For ESP)
54392       esp-evc-cir-units:
54393         type: string
54394         description: CIR units (For ESP)
54395       esp-itu-code:
54396         type: string
54397         description: Identifies ESP
54398       collector-pop-clli:
54399         type: string
54400         description: Collector POP CLLI (from the hostname of the access pnf)
54401       inter-connect-type-ingress:
54402         type: string
54403         description: Interconnect type on ingress side of EVC.
54404       tagmode-access-ingress:
54405         type: string
54406         description: tagode for collector side of EVC
54407       tagmode-access-egress:
54408         type: string
54409         description: tagMode for network side of EVC
54410       relationship-list:
54411         type: array
54412         items:
54413           $ref: "#/definitions/relationship"
54414       resource-version:
54415         type: string
54416         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54417   evcs:
54418     properties:
54419       evc:
54420         type: array
54421         items:
54422           $ref: "#/definitions/evc"
54423   external-system:
54424     description: |
54425       Namespace for external system.
54426     properties:
54427       esr-ems-list:
54428         type: object
54429         $ref: "#/definitions/esr-ems-list"
54430       esr-vnfm-list:
54431         type: object
54432         $ref: "#/definitions/esr-vnfm-list"
54433       esr-thirdparty-sdnc-list:
54434         type: object
54435         $ref: "#/definitions/esr-thirdparty-sdnc-list"
54436   extra-properties:
54437     description: |
54438       Extra properties for inventory item for response list
54439     properties:
54440       extra-property:
54441         type: array
54442         items:
54443           $ref: "#/definitions/extra-property"
54444   extra-property:
54445     properties:
54446       property-name:
54447         type: string
54448       property-value:
54449         type: string
54450   flavor:
54451     description: |
54452       Openstack flavor.
54453       ###### Related Nodes
54454       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54455       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
54456       - FLAVOR cannot be deleted if linked to VSERVER
54457     required:
54458     - flavor-id
54459     - flavor-name
54460     - flavor-selflink
54461     properties:
54462       flavor-id:
54463         type: string
54464         description: Flavor id, expected to be unique across cloud-region.
54465       flavor-name:
54466         type: string
54467         description: Flavor name
54468       flavor-vcpus:
54469         type: integer
54470         format: int32
54471         description: Number of CPUs
54472       flavor-ram:
54473         type: integer
54474         format: int32
54475         description: Amount of memory
54476       flavor-disk:
54477         type: integer
54478         format: int32
54479         description: Disk space
54480       flavor-ephemeral:
54481         type: integer
54482         format: int32
54483         description: Amount of ephemeral disk space
54484       flavor-swap:
54485         type: string
54486         description: amount of swap space allocation
54487       flavor-is-public:
54488         type: boolean
54489         description: whether flavor is available to all users or private to the tenant it was created in.
54490       flavor-selflink:
54491         type: string
54492         description: URL to endpoint where AAI can get more details
54493       flavor-disabled:
54494         type: boolean
54495         description: Boolean as to whether this flavor is no longer enabled
54496       resource-version:
54497         type: string
54498         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54499       relationship-list:
54500         type: array
54501         items:
54502           $ref: "#/definitions/relationship"
54503   flavors:
54504     description: |
54505       Collection of openstack flavors.
54506     properties:
54507       flavor:
54508         type: array
54509         items:
54510           $ref: "#/definitions/flavor"
54511   forwarder:
54512     description: |
54513       Entity describing a sequenced segment of forwarding path
54514       ###### Related Nodes
54515       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54516       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
54517       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54518       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
54519       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
54520       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
54521     required:
54522     - sequence
54523     properties:
54524       sequence:
54525         type: integer
54526         format: int32
54527         description: Unique ID of this segmentation
54528       forwarder-role:
54529         type: string
54530         description: ingress, intermediate, egress
54531       relationship-list:
54532         type: array
54533         items:
54534           $ref: "#/definitions/relationship"
54535       resource-version:
54536         type: string
54537         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54538   forwarder-evc:
54539     description: |
54540       forwarder object is an optional child object of the Configuration object.
54541       ###### Related Nodes
54542       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54543     required:
54544     - forwarder-evc-id
54545     properties:
54546       forwarder-evc-id:
54547         type: string
54548         description: Key for forwarder-evc object
54549       circuit-id:
54550         type: string
54551         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
54552       ivlan:
54553         type: string
54554         description: Internal VLAN.
54555       svlan:
54556         type: string
54557         description: SVLAN value for ingress of egress forwarder.
54558       cvlan:
54559         type: string
54560         description: CVLAN value for ingress of egress forwarder.
54561       relationship-list:
54562         type: array
54563         items:
54564           $ref: "#/definitions/relationship"
54565       resource-version:
54566         type: string
54567         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54568   forwarder-evcs:
54569     properties:
54570       forwarder-evc:
54571         type: array
54572         items:
54573           $ref: "#/definitions/forwarder-evc"
54574   forwarders:
54575     properties:
54576       forwarder:
54577         type: array
54578         items:
54579           $ref: "#/definitions/forwarder"
54580   forwarding-path:
54581     description: |
54582       Entity that describes the sequenced forwarding path between interfaces of services or resources
54583       ###### Related Nodes
54584       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
54585       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54586       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54587       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
54588       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
54589     required:
54590     - forwarding-path-id
54591     - forwarding-path-name
54592     properties:
54593       forwarding-path-id:
54594         type: string
54595         description: Unique ID of this FP
54596       forwarding-path-name:
54597         type: string
54598         description: Name of the FP
54599       relationship-list:
54600         type: array
54601         items:
54602           $ref: "#/definitions/relationship"
54603       resource-version:
54604         type: string
54605         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54606       selflink:
54607         type: string
54608         description: the self link for this FP
54609       forwarders:
54610         type: array
54611         items:
54612           $ref: "#/definitions/forwarder"
54613   forwarding-paths:
54614     properties:
54615       forwarding-path:
54616         type: array
54617         items:
54618           $ref: "#/definitions/forwarding-path"
54619   generic-vnf:
54620     description: |
54621       General purpose VNF
54622       ###### Related Nodes
54623       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54624       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54625       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54626       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
54627       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54628       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54629       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54630       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
54631       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
54632       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
54633       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
54634       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
54635       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
54636       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54637       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
54638       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
54639       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54640       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54641       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54642       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54643       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54644       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54645       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
54646       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54647       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54648       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54649       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54650       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54651       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
54652       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
54653     required:
54654     - vnf-id
54655     - vnf-instance-id
54656     - vnf-name
54657     - vnf-type
54658     - vnf-package-name
54659     - vnf-discriptor-name
54660     - job-id
54661     - in-maint
54662     - is-closed-loop-disabled
54663     properties:
54664       vnf-id:
54665         type: string
54666         description: Unique id of VNF.  This is unique across the graph.
54667       vnf-instance-id:
54668         type: string
54669         description: vnf instance id.
54670       vnf-name:
54671         type: string
54672         description: Name of VNF.
54673       vnf-name2:
54674         type: string
54675         description: Alternate name of VNF.
54676       vnf-type:
54677         type: string
54678         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.
54679       service-id:
54680         type: string
54681         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
54682       regional-resource-zone:
54683         type: string
54684         description: Regional way of organizing pservers, source of truth should define values
54685       prov-status:
54686         type: string
54687         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54688       operational-status:
54689         type: string
54690         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
54691       license-key:
54692         type: string
54693         description: OBSOLETE -  do not use
54694       equipment-role:
54695         type: string
54696         description: Client should send valid enumerated value
54697       orchestration-status:
54698         type: string
54699         description: Orchestration status of this VNF, used by MSO.
54700       vnf-package-name:
54701         type: string
54702       vnf-discriptor-name:
54703         type: string
54704         description: vnf discriptor name
54705       job-id:
54706         type: string
54707         description: job id corresponding to vnf
54708       heat-stack-id:
54709         type: string
54710         description: Heat stack id corresponding to this instance, managed by MSO
54711       mso-catalog-key:
54712         type: string
54713         description: Corresponds to the SDN-C catalog id used to configure this VCE
54714       management-option:
54715         type: string
54716         description: identifier of managed by ATT or customer
54717       ipv4-oam-address:
54718         type: string
54719         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
54720       ipv4-loopback0-address:
54721         type: string
54722         description: v4 Loopback0 address
54723       nm-lan-v6-address:
54724         type: string
54725         description: v6 Loopback address
54726       management-v6-address:
54727         type: string
54728         description: v6 management address
54729       vcpu:
54730         type: integer
54731         format: int64
54732         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
54733       vcpu-units:
54734         type: string
54735         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
54736       vmemory:
54737         type: integer
54738         format: int64
54739         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
54740       vmemory-units:
54741         type: string
54742         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
54743       vdisk:
54744         type: integer
54745         format: int64
54746         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
54747       vdisk-units:
54748         type: string
54749         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
54750       nshd:
54751         type: integer
54752         format: int64
54753         description: number of associated SHD in vnf.
54754       nvm:
54755         type: integer
54756         format: int64
54757         description: number of vms in vnf.
54758       nnet:
54759         type: integer
54760         format: int64
54761         description: number of network in vnf.
54762       in-maint:
54763         type: boolean
54764       is-closed-loop-disabled:
54765         type: boolean
54766       resource-version:
54767         type: string
54768         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54769       summary-status:
54770         type: string
54771         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
54772       encrypted-access-flag:
54773         type: boolean
54774         description: indicates whether generic-vnf access uses SSH
54775       entitlement-assignment-group-uuid:
54776         type: string
54777         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
54778       entitlement-resource-uuid:
54779         type: string
54780         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
54781       license-assignment-group-uuid:
54782         type: string
54783         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
54784       license-key-uuid:
54785         type: string
54786         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
54787       model-invariant-id:
54788         type: string
54789         description: the ASDC model id for this resource or service model.
54790       model-version-id:
54791         type: string
54792         description: the ASDC model version for this resource or service model.
54793       persona-model-version:
54794         type: string
54795         description: the ASDC model version for this resource or service model.
54796       model-customization-id:
54797         type: string
54798         description: captures the id of all the configuration used to customize the resource for the service.
54799       widget-model-id:
54800         type: string
54801         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54802       widget-model-version:
54803         type: string
54804         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54805       as-number:
54806         type: string
54807         description: as-number of the VNF
54808       regional-resource-subzone:
54809         type: string
54810         description: represents sub zone of the rr plane
54811       nf-type:
54812         type: string
54813         description: Generic description of the type of NF
54814       nf-function:
54815         type: string
54816         description: English description of Network function that the specific VNF deployment is providing
54817       nf-role:
54818         type: string
54819         description: role in the network that this model will be providing
54820       nf-naming-code:
54821         type: string
54822         description: string assigned to this model used for naming purposes
54823       selflink:
54824         type: string
54825         description: Path to the controller object.
54826       ipv4-oam-gateway-address:
54827         type: string
54828         description: Gateway address
54829       ipv4-oam-gateway-address-prefix-length:
54830         type: integer
54831         format: int32
54832         description: Prefix length for oam-address
54833       vlan-id-outer:
54834         type: integer
54835         format: int64
54836         description: Temporary location for S-TAG to get to VCE
54837       nm-profile-name:
54838         type: string
54839         description: Network Management profile of this VNF
54840       relationship-list:
54841         type: array
54842         items:
54843           $ref: "#/definitions/relationship"
54844       l-interfaces:
54845         type: array
54846         items:
54847           $ref: "#/definitions/l-interface"
54848       lag-interfaces:
54849         type: array
54850         items:
54851           $ref: "#/definitions/lag-interface"
54852       vf-modules:
54853         type: array
54854         items:
54855           $ref: "#/definitions/vf-module"
54856       licenses:
54857         type: array
54858         items:
54859           $ref: "#/definitions/license"
54860       entitlements:
54861         type: array
54862         items:
54863           $ref: "#/definitions/entitlement"
54864   generic-vnfs:
54865     description: |
54866       Collection of VNFs
54867     properties:
54868       generic-vnf:
54869         type: array
54870         items:
54871           $ref: "#/definitions/generic-vnf"
54872   group-assignment:
54873     description: |
54874       Openstack group-assignment used to store exclusivity groups (EG).
54875       ###### Related Nodes
54876       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54877       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
54878       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
54879     required:
54880     - group-id
54881     - group-type
54882     - group-name
54883     properties:
54884       group-id:
54885         type: string
54886         description: Group id, expected to be unique across cloud-region.
54887       group-type:
54888         type: string
54889         description: Group type - the type of group this instance refers to
54890       group-name:
54891         type: string
54892         description: Group name - name assigned to the group
54893       group-description:
54894         type: string
54895         description: Group description - description of the group
54896       resource-version:
54897         type: string
54898         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54899       relationship-list:
54900         type: array
54901         items:
54902           $ref: "#/definitions/relationship"
54903   group-assignments:
54904     description: |
54905       Collection of openstack group assignments
54906     properties:
54907       group-assignment:
54908         type: array
54909         items:
54910           $ref: "#/definitions/group-assignment"
54911   host-route:
54912     description: |
54913       ###### Related Nodes
54914       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
54915     required:
54916     - host-route-id
54917     - route-prefix
54918     - next-hop
54919     properties:
54920       host-route-id:
54921         type: string
54922         description: host-route id
54923       route-prefix:
54924         type: string
54925         description: subnet prefix
54926       next-hop:
54927         type: string
54928         description: Could be ip-address, hostname, or service-instance
54929       next-hop-type:
54930         type: string
54931         description: Should be ip-address, hostname, or service-instance to match next-hop
54932       resource-version:
54933         type: string
54934         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54935       relationship-list:
54936         type: array
54937         items:
54938           $ref: "#/definitions/relationship"
54939   host-routes:
54940     properties:
54941       host-route:
54942         type: array
54943         items:
54944           $ref: "#/definitions/host-route"
54945   image:
54946     description: |
54947       Openstack image.
54948       ###### Related Nodes
54949       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54950       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54951       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
54952       - IMAGE cannot be deleted if linked to VSERVER
54953       - IMAGE is DELETED when these are DELETED METADATUM
54954     required:
54955     - image-id
54956     - image-name
54957     - image-os-distro
54958     - image-os-version
54959     - image-selflink
54960     properties:
54961       image-id:
54962         type: string
54963         description: Image id, expected to be unique across cloud region
54964       image-name:
54965         type: string
54966         description: Image name
54967       image-architecture:
54968         type: string
54969         description: Operating system architecture.
54970       image-os-distro:
54971         type: string
54972         description: The common name of the operating system distribution in lowercase
54973       image-os-version:
54974         type: string
54975         description: The operating system version as specified by the distributor.
54976       application:
54977         type: string
54978         description: The application that the image instantiates.
54979       application-vendor:
54980         type: string
54981         description: The vendor of the application.
54982       application-version:
54983         type: string
54984         description: The version of the application.
54985       image-selflink:
54986         type: string
54987         description: URL to endpoint where AAI can get more details
54988       resource-version:
54989         type: string
54990         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54991       relationship-list:
54992         type: array
54993         items:
54994           $ref: "#/definitions/relationship"
54995       metadata:
54996         type: array
54997         items:
54998           $ref: "#/definitions/metadatum"
54999   images:
55000     description: |
55001       Collectio of Openstack images.
55002     properties:
55003       image:
55004         type: array
55005         items:
55006           $ref: "#/definitions/image"
55007   include-node-filter:
55008     properties:
55009       include-node-type:
55010         type: string
55011   instance-filter:
55012     description: |
55013       InstanceFilter for performing a named-query or model query
55014   instance-filters:
55015     description: |
55016       InstanceFilters for performing a named-query or model query
55017     properties:
55018       instance-filter:
55019         type: array
55020         items:
55021           $ref: "#/definitions/instance-filter"
55022   instance-group:
55023     description: |
55024       General mechanism for grouping instances
55025       ###### Related Nodes
55026       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
55027       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55028       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55029       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55030       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55031       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55032       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55033       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55034       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55035       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55036       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55037       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55038     required:
55039     - instance-group-role
55040     - model-invariant-id
55041     - model-version-id
55042     - id
55043     - description
55044     - type
55045     properties:
55046       instance-group-role:
55047         type: string
55048         description: role of the instance group.
55049       model-invariant-id:
55050         type: string
55051         description: ASDC model id for this resource or service model.
55052       model-version-id:
55053         type: string
55054         description: ASDC model version uid for this resource model.
55055       id:
55056         type: string
55057         description: Instance Group ID, UUID assigned to this instance.
55058       description:
55059         type: string
55060         description: Descriptive text to help identify the usage of this instance-group
55061       type:
55062         type: string
55063         description: Only valid value today is lower case ha for high availability
55064       sub-type:
55065         type: string
55066         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
55067       resource-version:
55068         type: string
55069         description: Concurrency value
55070       relationship-list:
55071         type: array
55072         items:
55073           $ref: "#/definitions/relationship"
55074   instance-groups:
55075     description: |
55076       Collection of openstack route table references
55077     properties:
55078       instance-group:
55079         type: array
55080         items:
55081           $ref: "#/definitions/instance-group"
55082   inventory:
55083     properties:
55084       search:
55085         type: object
55086         $ref: "#/definitions/search"
55087       actions:
55088         type: object
55089         $ref: "#/definitions/actions"
55090       cloud-infrastructure:
55091         type: object
55092         $ref: "#/definitions/cloud-infrastructure"
55093       external-system:
55094         type: object
55095         $ref: "#/definitions/external-system"
55096       business:
55097         type: object
55098         $ref: "#/definitions/business"
55099       service-design-and-creation:
55100         type: object
55101         $ref: "#/definitions/service-design-and-creation"
55102       network:
55103         type: object
55104         $ref: "#/definitions/network"
55105       aai-internal:
55106         type: object
55107         $ref: "#/definitions/aai-internal"
55108       nodes:
55109         type: array
55110         items:
55111           $ref: "#/definitions/aai-internal"
55112   inventory-item:
55113     properties:
55114       inventory-item-type:
55115         type: string
55116       inventory-item-link:
55117         type: string
55118       inventory-item-data:
55119         type: array
55120         items:
55121           $ref: "#/definitions/inventory-item-data"
55122       tagged-inventory-item-list:
55123         type: array
55124         items:
55125           $ref: "#/definitions/tagged-inventory-item-list"
55126   inventory-item-data:
55127     properties:
55128       property-name:
55129         type: string
55130       property-value:
55131         type: string
55132   inventory-response-item:
55133     description: |
55134       Inventory item for response list
55135     properties:
55136       model-name:
55137         type: string
55138       extra-properties:
55139         type: object
55140         $ref: "#/definitions/extra-properties"
55141       inventory-response-items:
55142         type: object
55143         $ref: "#/definitions/inventory-response-items"
55144   inventory-response-items:
55145     description: |
55146       Container for inventory items in response list
55147     properties:
55148       inventory-response-item:
55149         type: array
55150         items:
55151           $ref: "#/definitions/inventory-response-item"
55152   ipsec-configuration:
55153     description: |
55154       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
55155       ###### Related Nodes
55156       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
55157       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
55158       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
55159     required:
55160     - ipsec-configuration-id
55161     properties:
55162       ipsec-configuration-id:
55163         type: string
55164         description: UUID of this configuration
55165       requested-vig-address-type:
55166         type: string
55167         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
55168       requested-encryption-strength:
55169         type: string
55170         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
55171       requested-dmz-type:
55172         type: string
55173         description: ATT can offer a shared DMZ or a DMZ specific to a customer
55174       shared-dmz-network-address:
55175         type: string
55176         description: Network address of shared DMZ
55177       requested-customer-name:
55178         type: string
55179         description: If the DMZ is a custom DMZ, this field will indicate the customer information
55180       ike-version:
55181         type: string
55182         description: can be 1 or 2
55183       ikev1-authentication:
55184         type: string
55185         description: Contains values like md5, sha1, sha256, sha384
55186       ikev1-encryption:
55187         type: string
55188         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
55189       ikev1-dh-group:
55190         type: string
55191         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
55192       ikev1-am-group-id:
55193         type: string
55194         description: Group name defined in VIG for clients using aggressive mode
55195       ikev1-am-password:
55196         type: string
55197         description: pre-shared key for the above group name
55198       ikev1-sa-lifetime:
55199         type: string
55200         description: Lifetime for IKEv1 SA
55201       ipsec-authentication:
55202         type: string
55203         description: md5, sha1, sha256, sha384
55204       ipsec-encryption:
55205         type: string
55206         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
55207       ipsec-sa-lifetime:
55208         type: string
55209         description: Life time for IPSec SA
55210       ipsec-pfs:
55211         type: string
55212         description: enable PFS or not
55213       xauth-userid:
55214         type: string
55215         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
55216       xauth-user-password:
55217         type: string
55218         description: Encrypted using the Juniper $9$ algorithm
55219       dpd-interval:
55220         type: string
55221         description: The time between DPD probe
55222       dpd-frequency:
55223         type: string
55224         description: Maximum number of DPD before claiming the tunnel is down
55225       resource-version:
55226         type: string
55227         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55228       relationship-list:
55229         type: array
55230         items:
55231           $ref: "#/definitions/relationship"
55232       vig-servers:
55233         type: array
55234         items:
55235           $ref: "#/definitions/vig-server"
55236   ipsec-configurations:
55237     properties:
55238       ipsec-configuration:
55239         type: array
55240         items:
55241           $ref: "#/definitions/ipsec-configuration"
55242   key-data:
55243     properties:
55244       key-name:
55245         type: string
55246       key-value:
55247         type: string
55248   l-interface:
55249     description: |
55250       Logical interfaces, e.g., a vnic.
55251       ###### Related Nodes
55252       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55253       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55254       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55255       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55256       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55257       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55258       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55259       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
55260       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
55261       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55262       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55263       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
55264       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
55265       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
55266       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
55267       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
55268       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
55269       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55270       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
55271       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
55272     required:
55273     - interface-name
55274     - is-port-mirrored
55275     - in-maint
55276     - is-ip-unnumbered
55277     properties:
55278       interface-name:
55279         type: string
55280         description: Name given to the interface
55281       interface-role:
55282         type: string
55283         description: E.g., CUSTOMER, UPLINK, etc.
55284       v6-wan-link-ip:
55285         type: string
55286         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
55287       selflink:
55288         type: string
55289         description: URL to endpoint where AAI can get more details
55290       interface-id:
55291         type: string
55292         description: ID of interface
55293       macaddr:
55294         type: string
55295         description: MAC address for the interface
55296       network-name:
55297         type: string
55298         description: Name of the network
55299       management-option:
55300         type: string
55301         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
55302       interface-description:
55303         type: string
55304         description: Human friendly text regarding this interface.
55305       is-port-mirrored:
55306         type: boolean
55307       resource-version:
55308         type: string
55309         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55310       in-maint:
55311         type: boolean
55312       prov-status:
55313         type: string
55314         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
55315       is-ip-unnumbered:
55316         type: boolean
55317       allowed-address-pairs:
55318         type: string
55319         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
55320       vlans:
55321         type: array
55322         items:
55323           $ref: "#/definitions/vlan"
55324       sriov-vfs:
55325         type: array
55326         items:
55327           $ref: "#/definitions/sriov-vf"
55328       l-interfaces:
55329         type: array
55330         items:
55331           $ref: "#/definitions/l-interface"
55332       relationship-list:
55333         type: array
55334         items:
55335           $ref: "#/definitions/relationship"
55336       l3-interface-ipv4-address-list:
55337         type: array
55338         items:
55339           $ref: "#/definitions/l3-interface-ipv4-address-list"
55340       l3-interface-ipv6-address-list:
55341         type: array
55342         items:
55343           $ref: "#/definitions/l3-interface-ipv6-address-list"
55344   l-interfaces:
55345     description: |
55346       Collection of logical interfaces.
55347     properties:
55348       l-interface:
55349         type: array
55350         items:
55351           $ref: "#/definitions/l-interface"
55352   l3-interface-ipv4-address-list:
55353     description: |
55354       IPv4 Address Range
55355       ###### Related Nodes
55356       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55357       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55358       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55359       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55360       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55361       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
55362     required:
55363     - l3-interface-ipv4-address
55364     properties:
55365       l3-interface-ipv4-address:
55366         type: string
55367         description: IP address
55368       l3-interface-ipv4-prefix-length:
55369         type: integer
55370         format: int64
55371         description: Prefix length, 32 for single address
55372       vlan-id-inner:
55373         type: integer
55374         format: int64
55375         description: Inner VLAN tag
55376       vlan-id-outer:
55377         type: integer
55378         format: int64
55379         description: Outer VLAN tag
55380       is-floating:
55381         type: boolean
55382         description: Indicator of fixed or floating address
55383       resource-version:
55384         type: string
55385         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55386       neutron-network-id:
55387         type: string
55388         description: Neutron network id of the interface that address belongs to
55389       neutron-subnet-id:
55390         type: string
55391         description: Neutron id of subnet that address belongs to
55392       relationship-list:
55393         type: array
55394         items:
55395           $ref: "#/definitions/relationship"
55396   l3-interface-ipv6-address-list:
55397     description: |
55398       IPv6 Address Range
55399       ###### Related Nodes
55400       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55401       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55402       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55403       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55404       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55405       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
55406     required:
55407     - l3-interface-ipv6-address
55408     properties:
55409       l3-interface-ipv6-address:
55410         type: string
55411         description: IP address
55412       l3-interface-ipv6-prefix-length:
55413         type: integer
55414         format: int64
55415         description: Prefix length, 128 for single address
55416       vlan-id-inner:
55417         type: integer
55418         format: int64
55419         description: Inner VLAN tag
55420       vlan-id-outer:
55421         type: integer
55422         format: int64
55423         description: Outer VLAN tag
55424       is-floating:
55425         type: boolean
55426         description: Indicator of fixed or floating address
55427       resource-version:
55428         type: string
55429         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55430       neutron-network-id:
55431         type: string
55432         description: Neutron network id of the interface that address belongs to
55433       neutron-subnet-id:
55434         type: string
55435         description: Neutron id of subnet that address belongs to
55436       relationship-list:
55437         type: array
55438         items:
55439           $ref: "#/definitions/relationship"
55440   l3-network:
55441     description: |
55442       Generic network definition
55443       ###### Related Nodes
55444       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55445       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55446       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
55447       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55448       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
55449       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
55450       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55451       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55452       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55453       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55454       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55455       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55456       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55457       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
55458       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55459       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55460       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
55461       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
55462     required:
55463     - network-id
55464     - network-name
55465     - is-bound-to-vpn
55466     - is-provider-network
55467     - is-shared-network
55468     - is-external-network
55469     properties:
55470       network-id:
55471         type: string
55472         description: Network ID, should be uuid. Unique across A&AI.
55473       network-name:
55474         type: string
55475         description: Name of the network, governed by some naming convention..
55476       network-type:
55477         type: string
55478         description: Type of the network - who defines these values?
55479       network-role:
55480         type: string
55481         description: Role the network plans - who defines these values?
55482       network-technology:
55483         type: string
55484         description: Network technology - who defines these values?
55485       neutron-network-id:
55486         type: string
55487         description: Neutron network id of this Interface
55488       is-bound-to-vpn:
55489         type: boolean
55490       service-id:
55491         type: string
55492         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
55493       network-role-instance:
55494         type: integer
55495         format: int64
55496         description: network role instance
55497       resource-version:
55498         type: string
55499         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55500       orchestration-status:
55501         type: string
55502         description: Orchestration status of this VNF, mastered by MSO
55503       heat-stack-id:
55504         type: string
55505         description: Heat stack id corresponding to this instance, managed by MSO
55506       mso-catalog-key:
55507         type: string
55508         description: Corresponds to the SDN-C catalog id used to configure this VCE
55509       contrail-network-fqdn:
55510         type: string
55511         description: Contrail FQDN for the network
55512       model-invariant-id:
55513         type: string
55514         description: the ASDC model id for this resource or service model.
55515       model-version-id:
55516         type: string
55517         description: the ASDC model version for this resource or service model.
55518       persona-model-version:
55519         type: string
55520         description: the ASDC model version for this resource or service model.
55521       model-customization-id:
55522         type: string
55523         description: captures the id of all the configuration used to customize the resource for the service.
55524       widget-model-id:
55525         type: string
55526         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55527       widget-model-version:
55528         type: string
55529         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55530       physical-network-name:
55531         type: string
55532         description: Name associated with the physical network.
55533       is-provider-network:
55534         type: boolean
55535       is-shared-network:
55536         type: boolean
55537       is-external-network:
55538         type: boolean
55539       selflink:
55540         type: string
55541         description: Path to the controller object.
55542       operational-status:
55543         type: string
55544         description: Indicator for whether the resource is considered operational.
55545       subnets:
55546         type: array
55547         items:
55548           $ref: "#/definitions/subnet"
55549       ctag-assignments:
55550         type: array
55551         items:
55552           $ref: "#/definitions/ctag-assignment"
55553       segmentation-assignments:
55554         type: array
55555         items:
55556           $ref: "#/definitions/segmentation-assignment"
55557       relationship-list:
55558         type: array
55559         items:
55560           $ref: "#/definitions/relationship"
55561         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
55562   l3-networks:
55563     properties:
55564       l3-network:
55565         type: array
55566         items:
55567           $ref: "#/definitions/l3-network"
55568   lag-interface:
55569     description: |
55570       Link aggregate interface
55571       ###### Related Nodes
55572       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55573       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55574       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55575       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55576       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55577       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55578       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55579       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55580       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
55581       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
55582       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
55583     required:
55584     - interface-name
55585     - in-maint
55586     properties:
55587       interface-name:
55588         type: string
55589         description: Name that identifies the link aggregate interface
55590       interface-description:
55591         type: string
55592         description: Human friendly text regarding this interface.
55593       resource-version:
55594         type: string
55595         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55596       speed-value:
55597         type: string
55598         description: Captures the numeric part of the speed
55599       speed-units:
55600         type: string
55601         description: Captures the units corresponding to the speed
55602       interface-id:
55603         type: string
55604         description: ID of interface
55605       interface-role:
55606         type: string
55607         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55608       prov-status:
55609         type: string
55610         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55611       in-maint:
55612         type: boolean
55613       relationship-list:
55614         type: array
55615         items:
55616           $ref: "#/definitions/relationship"
55617       l-interfaces:
55618         type: array
55619         items:
55620           $ref: "#/definitions/l-interface"
55621   lag-interfaces:
55622     description: |
55623       Collection of link aggregate interfaces.
55624     properties:
55625       lag-interface:
55626         type: array
55627         items:
55628           $ref: "#/definitions/lag-interface"
55629   lag-link:
55630     description: |
55631       LAG links can connect lag-interfaces
55632       ###### Related Nodes
55633       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55634       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55635     required:
55636     - link-name
55637     properties:
55638       link-name:
55639         type: string
55640         description: Alphabetical concatenation of lag-interface names
55641       resource-version:
55642         type: string
55643         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55644       relationship-list:
55645         type: array
55646         items:
55647           $ref: "#/definitions/relationship"
55648   lag-links:
55649     description: |
55650       Collection of link aggregation connections
55651     properties:
55652       lag-link:
55653         type: array
55654         items:
55655           $ref: "#/definitions/lag-link"
55656   license:
55657     description: |
55658       Metadata for license group.
55659       ###### Related Nodes
55660       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55661       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55662     required:
55663     - group-uuid
55664     - resource-uuid
55665     properties:
55666       group-uuid:
55667         type: string
55668         description: Unique ID for the license group the resource belongs to, should be uuid.
55669       resource-uuid:
55670         type: string
55671         description: Unique ID of a license resource.
55672       resource-version:
55673         type: string
55674         description: Concurrency value
55675       relationship-list:
55676         type: array
55677         items:
55678           $ref: "#/definitions/relationship"
55679   licenses:
55680     description: |
55681       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
55682     properties:
55683       license:
55684         type: array
55685         items:
55686           $ref: "#/definitions/license"
55687   line-of-business:
55688     description: |
55689       describes a line-of-business
55690       ###### Related Nodes
55691       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55692     required:
55693     - line-of-business-name
55694     properties:
55695       line-of-business-name:
55696         type: string
55697         description: Name of the line-of-business (product)
55698       resource-version:
55699         type: string
55700         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55701       relationship-list:
55702         type: array
55703         items:
55704           $ref: "#/definitions/relationship"
55705   lines-of-business:
55706     description: |
55707       Collection of lines-of-business
55708     properties:
55709       line-of-business:
55710         type: array
55711         items:
55712           $ref: "#/definitions/line-of-business"
55713   logical-link:
55714     description: |
55715       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
55716       ###### Related Nodes
55717       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
55718       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
55719       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
55720       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
55721       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55722       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55723       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55724       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55725       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55726       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55727       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
55728       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55729       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55730       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55731       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55732       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55733       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55734       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55735     required:
55736     - link-name
55737     - in-maint
55738     - link-type
55739     properties:
55740       link-name:
55741         type: string
55742         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
55743       in-maint:
55744         type: boolean
55745       link-type:
55746         type: string
55747         description: Type of logical link, e.g., evc
55748       speed-value:
55749         type: string
55750         description: Captures the numeric part of the speed
55751       speed-units:
55752         type: string
55753         description: Captures the units corresponding to the speed
55754       ip-version:
55755         type: string
55756         description: v4, v6, or ds for dual stack
55757       routing-protocol:
55758         type: string
55759         description: For example, static or BGP
55760       resource-version:
55761         type: string
55762         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55763       model-invariant-id:
55764         type: string
55765         description: the ASDC model id for this resource or service model.
55766       model-version-id:
55767         type: string
55768         description: the ASDC model version for this resource or service model.
55769       persona-model-version:
55770         type: string
55771         description: the ASDC model version for this resource or service model.
55772       widget-model-id:
55773         type: string
55774         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55775       widget-model-version:
55776         type: string
55777         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55778       operational-status:
55779         type: string
55780         description: Indication of operational status of the logical link.
55781       prov-status:
55782         type: string
55783         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55784       link-role:
55785         type: string
55786         description: Indication of the network use of the logical link.
55787       link-name2:
55788         type: string
55789         description: Alias or alternate name (CLCI or D1 name).
55790       link-id:
55791         type: string
55792         description: UUID of the logical-link, SDNC generates this.
55793       circuit-id:
55794         type: string
55795         description: Circuit id
55796       purpose:
55797         type: string
55798         description: Reason for this entity, role it is playing
55799       relationship-list:
55800         type: array
55801         items:
55802           $ref: "#/definitions/relationship"
55803   logical-links:
55804     description: |
55805       Collection of logical connections
55806     properties:
55807       logical-link:
55808         type: array
55809         items:
55810           $ref: "#/definitions/logical-link"
55811   metadata:
55812     description: |
55813       Collection of metadatum (key/value pairs)
55814     properties:
55815       metadatum:
55816         type: array
55817         items:
55818           $ref: "#/definitions/metadatum"
55819   metadatum:
55820     description: |
55821       Key/value pairs
55822       ###### Related Nodes
55823       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
55824       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
55825       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
55826       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55827       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55828     required:
55829     - metaname
55830     - metaval
55831     properties:
55832       metaname:
55833         type: string
55834       metaval:
55835         type: string
55836       resource-version:
55837         type: string
55838         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55839   model:
55840     description: |
55841       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
55842       ###### Related Nodes
55843       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55844       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
55845       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55846       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55847       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55848       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
55849       - MODEL is DELETED when these are DELETED MODEL-VER
55850     required:
55851     - model-invariant-id
55852     - model-type
55853     properties:
55854       model-invariant-id:
55855         type: string
55856         description: Unique identifier corresponding to the main definition of a model in ASDC
55857       model-type:
55858         type: string
55859         description: Type of the model, e.g., service, resource, widget, etc.
55860       resource-version:
55861         type: string
55862         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55863       model-vers:
55864         type: array
55865         items:
55866           $ref: "#/definitions/model-ver"
55867       relationship-list:
55868         type: array
55869         items:
55870           $ref: "#/definitions/relationship"
55871   model-and-named-query-search:
55872     description: |
55873       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
55874     properties:
55875       query-parameters:
55876         type: object
55877         $ref: "#/definitions/query-parameters"
55878       instance-filters:
55879         type: object
55880         $ref: "#/definitions/instance-filters"
55881       secondary-filts:
55882         type: object
55883         $ref: "#/definitions/secondary-filts"
55884       top-node-type:
55885         type: string
55886       secondary-filter-cut-point:
55887         type: string
55888   model-constraint:
55889     description: |
55890       This is how we would capture constraints defining allowed sets of elements.
55891       ###### Related Nodes
55892       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55893       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
55894       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
55895     required:
55896     - model-constraint-uuid
55897     - constrained-element-set-uuid-to-replace
55898     properties:
55899       model-constraint-uuid:
55900         type: string
55901       constrained-element-set-uuid-to-replace:
55902         type: string
55903       constrained-element-sets:
55904         type: array
55905         items:
55906           $ref: "#/definitions/constrained-element-set"
55907       resource-version:
55908         type: string
55909         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55910   model-constraints:
55911     properties:
55912       model-constraint:
55913         type: array
55914         items:
55915           $ref: "#/definitions/model-constraint"
55916   model-element:
55917     description: |
55918       Defines how other models combine to make up a higher-level model.
55919       ###### Related Nodes
55920       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55921       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55922       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55923       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55924       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55925       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55926       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55927       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
55928     required:
55929     - model-element-uuid
55930     - new-data-del-flag
55931     - cardinality
55932     properties:
55933       model-element-uuid:
55934         type: string
55935       new-data-del-flag:
55936         type: string
55937         description: Indicates whether this element was created as part of instantiation from this model
55938       cardinality:
55939         type: string
55940         description: How many of this type of element are required/allowed
55941       linkage-points:
55942         type: string
55943       resource-version:
55944         type: string
55945         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55946       model-elements:
55947         type: array
55948         items:
55949           $ref: "#/definitions/model-element"
55950         description: Defines how other models combine to make up a higher-level model
55951       model-constraints:
55952         type: array
55953         items:
55954           $ref: "#/definitions/model-constraint"
55955         description: Describes new constraints on this model element that are not part of that model's definition
55956       relationship-list:
55957         type: array
55958         items:
55959           $ref: "#/definitions/relationship"
55960   model-elements:
55961     properties:
55962       model-element:
55963         type: array
55964         items:
55965           $ref: "#/definitions/model-element"
55966   model-ver:
55967     description: |
55968       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
55969       ###### Related Nodes
55970       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55971       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55972       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55973       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55974       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
55975       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
55976       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
55977       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
55978       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
55979       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
55980       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
55981       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
55982     required:
55983     - model-version-id
55984     - model-name
55985     - model-version
55986     properties:
55987       model-version-id:
55988         type: string
55989         description: Unique identifier corresponding to one version of a model in ASDC
55990       model-name:
55991         type: string
55992         description: Name of the model, which can change from version to version.
55993       model-version:
55994         type: string
55995         description: Version
55996       distribution-status:
55997         type: string
55998         description: Distribution Status
55999       model-description:
56000         type: string
56001         description: Description
56002       resource-version:
56003         type: string
56004         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56005       model-elements:
56006         type: array
56007         items:
56008           $ref: "#/definitions/model-element"
56009       metadata:
56010         type: array
56011         items:
56012           $ref: "#/definitions/metadatum"
56013       relationship-list:
56014         type: array
56015         items:
56016           $ref: "#/definitions/relationship"
56017   model-vers:
56018     properties:
56019       model-ver:
56020         type: array
56021         items:
56022           $ref: "#/definitions/model-ver"
56023   models:
56024     description: |
56025       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
56026     properties:
56027       model:
56028         type: array
56029         items:
56030           $ref: "#/definitions/model"
56031   multicast-configuration:
56032     description: |
56033       ###### Related Nodes
56034       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
56035     required:
56036     - multicast-configuration-id
56037     - multicast-protocol
56038     - rp-type
56039     properties:
56040       multicast-configuration-id:
56041         type: string
56042         description: Unique id of multicast configuration.
56043       multicast-protocol:
56044         type: string
56045         description: protocol of multicast configuration
56046       rp-type:
56047         type: string
56048         description: rp type of multicast configuration
56049       resource-version:
56050         type: string
56051         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56052       relationship-list:
56053         type: array
56054         items:
56055           $ref: "#/definitions/relationship"
56056   multicast-configurations:
56057     description: |
56058       multicast configuration of generic-vnf ip-address
56059     properties:
56060       multicast-configuration:
56061         type: array
56062         items:
56063           $ref: "#/definitions/multicast-configuration"
56064   named-queries:
56065     properties:
56066       named-query:
56067         type: array
56068         items:
56069           $ref: "#/definitions/named-query"
56070   named-query:
56071     description: |
56072       TBD
56073       ###### Related Nodes
56074       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
56075       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
56076       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
56077       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
56078     required:
56079     - named-query-uuid
56080     - named-query-name
56081     - named-query-version
56082     properties:
56083       named-query-uuid:
56084         type: string
56085       named-query-name:
56086         type: string
56087       named-query-version:
56088         type: string
56089       required-input-param:
56090         type: string
56091       description:
56092         type: string
56093       resource-version:
56094         type: string
56095       named-query-elements:
56096         type: array
56097         items:
56098           $ref: "#/definitions/named-query-element"
56099       relationship-list:
56100         type: array
56101         items:
56102           $ref: "#/definitions/relationship"
56103   named-query-element:
56104     description: |
56105       TBD
56106       ###### Related Nodes
56107       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
56108       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
56109       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56110       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56111       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56112       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56113       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
56114     required:
56115     - named-query-element-uuid
56116     properties:
56117       named-query-element-uuid:
56118         type: string
56119       property-collect-list:
56120         type: string
56121       resource-version:
56122         type: string
56123       property-limit-desc:
56124         type: string
56125       do-not-output:
56126         type: string
56127       named-query-elements:
56128         type: array
56129         items:
56130           $ref: "#/definitions/named-query-element"
56131       related-lookups:
56132         type: array
56133         items:
56134           $ref: "#/definitions/related-lookup"
56135       property-constraints:
56136         type: array
56137         items:
56138           $ref: "#/definitions/property-constraint"
56139       relationship-list:
56140         type: array
56141         items:
56142           $ref: "#/definitions/relationship"
56143   named-query-elements:
56144     properties:
56145       named-query-element:
56146         type: array
56147         items:
56148           $ref: "#/definitions/named-query-element"
56149   network:
56150     description: |
56151       Namespace for network inventory resources.
56152     properties:
56153       logical-links:
56154         type: array
56155         items:
56156           $ref: "#/definitions/logical-link"
56157       site-pair-sets:
56158         type: array
56159         items:
56160           $ref: "#/definitions/site-pair-set"
56161       vpn-bindings:
56162         type: array
56163         items:
56164           $ref: "#/definitions/vpn-binding"
56165       vpls-pes:
56166         type: array
56167         items:
56168           $ref: "#/definitions/vpls-pe"
56169       multicast-configurations:
56170         type: array
56171         items:
56172           $ref: "#/definitions/multicast-configuration"
56173       vces:
56174         type: array
56175         items:
56176           $ref: "#/definitions/vce"
56177       vnfcs:
56178         type: array
56179         items:
56180           $ref: "#/definitions/vnfc"
56181       l3-networks:
56182         type: array
56183         items:
56184           $ref: "#/definitions/l3-network"
56185       network-policies:
56186         type: array
56187         items:
56188           $ref: "#/definitions/network-policy"
56189       generic-vnfs:
56190         type: array
56191         items:
56192           $ref: "#/definitions/generic-vnf"
56193       lag-links:
56194         type: array
56195         items:
56196           $ref: "#/definitions/lag-link"
56197       newvces:
56198         type: array
56199         items:
56200           $ref: "#/definitions/newvce"
56201       pnfs:
56202         type: array
56203         items:
56204           $ref: "#/definitions/pnf"
56205       physical-links:
56206         type: array
56207         items:
56208           $ref: "#/definitions/physical-link"
56209       ipsec-configurations:
56210         type: array
56211         items:
56212           $ref: "#/definitions/ipsec-configuration"
56213       route-table-references:
56214         type: array
56215         items:
56216           $ref: "#/definitions/route-table-reference"
56217       instance-groups:
56218         type: array
56219         items:
56220           $ref: "#/definitions/instance-group"
56221       zones:
56222         type: array
56223         items:
56224           $ref: "#/definitions/zone"
56225       configurations:
56226         type: array
56227         items:
56228           $ref: "#/definitions/configuration"
56229       forwarding-paths:
56230         type: array
56231         items:
56232           $ref: "#/definitions/forwarding-path"
56233   network-policies:
56234     properties:
56235       network-policy:
56236         type: array
56237         items:
56238           $ref: "#/definitions/network-policy"
56239   network-policy:
56240     description: |
56241       ###### Related Nodes
56242       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
56243       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
56244     required:
56245     - network-policy-id
56246     properties:
56247       network-policy-id:
56248         type: string
56249         description: UUID representing unique key to this instance
56250       network-policy-fqdn:
56251         type: string
56252         description: Contrail FQDN for the policy
56253       heat-stack-id:
56254         type: string
56255         description: ID for the openStack Heat instance
56256       resource-version:
56257         type: string
56258         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56259       relationship-list:
56260         type: array
56261         items:
56262           $ref: "#/definitions/relationship"
56263   network-profile:
56264     description: |
56265       Network profile populated by SDN-GP for SNMP
56266       ###### Related Nodes
56267       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56268     required:
56269     - nm-profile-name
56270     properties:
56271       nm-profile-name:
56272         type: string
56273         description: Unique name of network profile.
56274       community-string:
56275         type: string
56276         description: Encrypted SNMP community string
56277       resource-version:
56278         type: string
56279         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56280       relationship-list:
56281         type: array
56282         items:
56283           $ref: "#/definitions/relationship"
56284   network-profiles:
56285     description: |
56286       Collection of network profiles
56287     properties:
56288       network-profile:
56289         type: array
56290         items:
56291           $ref: "#/definitions/network-profile"
56292   newvce:
56293     description: |
56294       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
56295       ###### Related Nodes
56296       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
56297       - NEWVCE is DELETED when these are DELETED L-INTERFACE
56298     required:
56299     - vnf-id2
56300     - vnf-name
56301     - vnf-type
56302     properties:
56303       vnf-id2:
56304         type: string
56305         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
56306       vnf-name:
56307         type: string
56308         description: Name of VNF.
56309       vnf-name2:
56310         type: string
56311         description: Alternate name of VNF.
56312       vnf-type:
56313         type: string
56314         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.
56315       prov-status:
56316         type: string
56317         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56318       operational-status:
56319         type: string
56320         description: Indicator for whether the resource is considered operational
56321       license-key:
56322         type: string
56323         description: OBSOLETE -  do not use
56324       ipv4-oam-address:
56325         type: string
56326         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).
56327       equipment-role:
56328         type: string
56329         description: Client should send valid enumerated value.
56330       resource-version:
56331         type: string
56332         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56333       ipv4-loopback0-address:
56334         type: string
56335         description: v4 Loopback0 address
56336       orchestration-status:
56337         type: string
56338         description: Orchestration status of this VNF, mastered by MSO.
56339       heat-stack-id:
56340         type: string
56341         description: Heat stack id corresponding to this instance, managed by MSO
56342       mso-catalog-key:
56343         type: string
56344         description: Corresponds to the SDN-C catalog id used to configure this VCE
56345       relationship-list:
56346         type: array
56347         items:
56348           $ref: "#/definitions/relationship"
56349       l-interfaces:
56350         type: array
56351         items:
56352           $ref: "#/definitions/l-interface"
56353   newvces:
56354     description: |
56355       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
56356     properties:
56357       newvce:
56358         type: array
56359         items:
56360           $ref: "#/definitions/newvce"
56361   notification-event:
56362     properties:
56363       cambria.partition:
56364         type: string
56365       notification-event-header:
56366         type: object
56367         $ref: "#/definitions/notification-event-header"
56368   notification-event-header:
56369     properties:
56370       id:
56371         type: string
56372       timestamp:
56373         type: string
56374       source-name:
56375         type: string
56376       domain:
56377         type: string
56378       sequence-number:
56379         type: string
56380       severity:
56381         type: string
56382       event-type:
56383         type: string
56384       version:
56385         type: string
56386       action:
56387         type: string
56388       entity-type:
56389         type: string
56390       top-entity-type:
56391         type: string
56392       entity-link:
56393         type: string
56394       status:
56395         type: string
56396   notify:
56397     required:
56398     - event-id
56399     properties:
56400       event-id:
56401         type: string
56402       node-type:
56403         type: string
56404       event-trigger:
56405         type: string
56406       key-data:
56407         type: array
56408         items:
56409           $ref: "#/definitions/key-data"
56410       selflink:
56411         type: string
56412   oam-network:
56413     description: |
56414       OAM network, to be deprecated shortly.  Do not use for new purposes.
56415       ###### Related Nodes
56416       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56417       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
56418       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56419     required:
56420     - network-uuid
56421     - network-name
56422     - cvlan-tag
56423     properties:
56424       network-uuid:
56425         type: string
56426         description: UUID of the network. Unique across a cloud-region
56427       network-name:
56428         type: string
56429         description: Name of the network.
56430       cvlan-tag:
56431         type: integer
56432         format: int64
56433         description: cvlan-id
56434       ipv4-oam-gateway-address:
56435         type: string
56436         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
56437       ipv4-oam-gateway-address-prefix-length:
56438         type: integer
56439         format: int32
56440         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
56441       resource-version:
56442         type: string
56443         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56444       relationship-list:
56445         type: array
56446         items:
56447           $ref: "#/definitions/relationship"
56448   oam-networks:
56449     description: |
56450       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
56451     properties:
56452       oam-network:
56453         type: array
56454         items:
56455           $ref: "#/definitions/oam-network"
56456   operational-environment:
56457     description: |
56458       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
56459       ###### Related Nodes
56460       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
56461       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
56462     required:
56463     - operational-environment-id
56464     - operational-environment-name
56465     - operational-environment-type
56466     - operational-environment-status
56467     - tenant-context
56468     - workload-context
56469     properties:
56470       operational-environment-id:
56471         type: string
56472         description: UUID of an operational environment
56473       operational-environment-name:
56474         type: string
56475         description: Operational Environment name
56476       operational-environment-type:
56477         type: string
56478         description: Operational Environment Type.
56479       operational-environment-status:
56480         type: string
56481         description: Status
56482       tenant-context:
56483         type: string
56484         description: Tenant Context.
56485       workload-context:
56486         type: string
56487         description: Workload Context.
56488       resource-version:
56489         type: string
56490         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56491       relationship-list:
56492         type: array
56493         items:
56494           $ref: "#/definitions/relationship"
56495   operational-environments:
56496     description: |
56497       a logical partition of the cloud which allows to have multiple environments in the production AIC.
56498     properties:
56499       operational-environment:
56500         type: array
56501         items:
56502           $ref: "#/definitions/operational-environment"
56503   overloaded-model:
56504     description: |
56505       Allows for legacy POST of old-style and new-style models
56506     required:
56507     - model-invariant-id
56508     - model-name-version-id
56509     - model-type
56510     - model-name
56511     - model-id
56512     - model-version
56513     properties:
56514       model-invariant-id:
56515         type: string
56516         description: Unique identifier corresponding to the main definition of a model in ASDC
56517       model-name-version-id:
56518         type: string
56519         description: Unique identifier corresponding to one version of a model in ASDC
56520       model-type:
56521         type: string
56522         description: Type of the model, e.g., service, resource, widget, etc.
56523       model-name:
56524         type: string
56525         description: Name of the model, which can change from version to version.
56526       model-id:
56527         type: string
56528         description: Invariant unique ID which does not change from version to version
56529       model-version:
56530         type: string
56531         description: Version
56532       model-description:
56533         type: string
56534         description: Description
56535       resource-version:
56536         type: string
56537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56538       model-vers:
56539         type: object
56540         $ref: "#/definitions/model-vers"
56541       relationship-list:
56542         type: object
56543         $ref: "#/definitions/relationship-list"
56544   owning-entities:
56545     description: |
56546       Collection of owning-entities
56547     properties:
56548       owning-entity:
56549         type: array
56550         items:
56551           $ref: "#/definitions/owning-entity"
56552   owning-entity:
56553     description: |
56554       describes an owning-entity
56555       ###### Related Nodes
56556       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
56557     required:
56558     - owning-entity-id
56559     - owning-entity-name
56560     properties:
56561       owning-entity-id:
56562         type: string
56563         description: UUID of an owning entity
56564       owning-entity-name:
56565         type: string
56566         description: Owning entity name
56567       resource-version:
56568         type: string
56569         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56570       relationship-list:
56571         type: array
56572         items:
56573           $ref: "#/definitions/relationship"
56574   p-interface:
56575     description: |
56576       Physical interface (e.g., nic)
56577       ###### Related Nodes
56578       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
56579       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56580       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56581       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56582       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56583       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
56584       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
56585       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56586       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
56587       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
56588       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
56589     required:
56590     - interface-name
56591     - in-maint
56592     properties:
56593       interface-name:
56594         type: string
56595         description: Name that identifies the physical interface
56596       selflink:
56597         type: string
56598         description: URL to endpoint where AAI can get more details.
56599       speed-value:
56600         type: string
56601         description: Captures the numeric part of the speed
56602       speed-units:
56603         type: string
56604         description: Captures the units corresponding to the speed
56605       port-description:
56606         type: string
56607         description: Nature of the services and connectivity on this port.
56608       equipment-identifier:
56609         type: string
56610         description: CLEI or other specification for p-interface hardware.
56611       interface-role:
56612         type: string
56613         description: Role specification for p-interface hardware.
56614       interface-type:
56615         type: string
56616         description: Indicates the physical properties of the interface.
56617       prov-status:
56618         type: string
56619         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56620       mac-addresss:
56621         type: string
56622         description: MAC Address of the p-interface.
56623       resource-version:
56624         type: string
56625         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56626       in-maint:
56627         type: boolean
56628       inv-status:
56629         type: string
56630         description: inventory status
56631       relationship-list:
56632         type: array
56633         items:
56634           $ref: "#/definitions/relationship"
56635       sriov-pfs:
56636         type: array
56637         items:
56638           $ref: "#/definitions/sriov-pf"
56639       l-interfaces:
56640         type: array
56641         items:
56642           $ref: "#/definitions/l-interface"
56643   p-interfaces:
56644     description: |
56645       Collection of physical interfaces.
56646     properties:
56647       p-interface:
56648         type: array
56649         items:
56650           $ref: "#/definitions/p-interface"
56651   physical-link:
56652     description: |
56653       Collection of physical connections, typically between p-interfaces
56654       ###### Related Nodes
56655       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56656     required:
56657     - link-name
56658     properties:
56659       link-name:
56660         type: string
56661         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
56662       speed-value:
56663         type: string
56664         description: Captures the numeric part of the speed
56665       speed-units:
56666         type: string
56667         description: Captures the units corresponding to the speed
56668       circuit-id:
56669         type: string
56670         description: Circuit it
56671       dual-mode:
56672         type: string
56673         description: Dual access mode (e.g., primary, secondary
56674       management-option:
56675         type: string
56676         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
56677       service-provider-name:
56678         type: string
56679         description: Name of the service Provider on this link.
56680       service-provider-bandwidth-up-value:
56681         type: integer
56682         format: int32
56683         description: Upstream Bandwidth value agreed with the service provider
56684       service-provider-bandwidth-up-units:
56685         type: string
56686         description: Units for the upstream BW value
56687       service-provider-bandwidth-down-value:
56688         type: integer
56689         format: int32
56690         description: Downstream Bandwidth value agreed with the service provider
56691       service-provider-bandwidth-down-units:
56692         type: string
56693         description: Units for downstream BW value
56694       resource-version:
56695         type: string
56696         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56697       relationship-list:
56698         type: array
56699         items:
56700           $ref: "#/definitions/relationship"
56701   physical-links:
56702     description: |
56703       Collection of physical connections, typically between p-interfaces
56704     properties:
56705       physical-link:
56706         type: array
56707         items:
56708           $ref: "#/definitions/physical-link"
56709   platform:
56710     description: |
56711       describes a platform
56712       ###### Related Nodes
56713       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
56714     required:
56715     - platform-name
56716     properties:
56717       platform-name:
56718         type: string
56719         description: Name of the platform
56720       resource-version:
56721         type: string
56722         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56723       relationship-list:
56724         type: array
56725         items:
56726           $ref: "#/definitions/relationship"
56727   platforms:
56728     description: |
56729       Collection of platforms
56730     properties:
56731       platform:
56732         type: array
56733         items:
56734           $ref: "#/definitions/platform"
56735   pnf:
56736     description: |
56737       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.
56738       ###### Related Nodes
56739       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56740       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56741       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56742       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
56743       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
56744       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
56745       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56746       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56747       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56748       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
56749       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56750     required:
56751     - pnf-name
56752     - in-maint
56753     properties:
56754       pnf-name:
56755         type: string
56756         description: unique name of Physical Network Function.
56757       pnf-name2:
56758         type: string
56759         description: name of Physical Network Function.
56760       selflink:
56761         type: string
56762         description: URL to endpoint where AAI can get more details.
56763       pnf-name2-source:
56764         type: string
56765         description: source of name2
56766       pnf-id:
56767         type: string
56768         description: id of pnf
56769       equip-type:
56770         type: string
56771         description: Equipment type.  Source of truth should define valid values.
56772       equip-vendor:
56773         type: string
56774         description: Equipment vendor.  Source of truth should define valid values.
56775       equip-model:
56776         type: string
56777         description: Equipment model.  Source of truth should define valid values.
56778       management-option:
56779         type: string
56780         description: identifier of managed by ATT or customer
56781       ipaddress-v4-oam:
56782         type: string
56783         description: ipv4-oam-address with new naming convention for IP addresses
56784       sw-version:
56785         type: string
56786         description: sw-version is the version of SW for the hosted application on the PNF.
56787       in-maint:
56788         type: boolean
56789       frame-id:
56790         type: string
56791         description: ID of the physical frame (relay rack) where pnf is installed.
56792       serial-number:
56793         type: string
56794         description: Serial number of the device
56795       ipaddress-v4-loopback-0:
56796         type: string
56797         description: IPV4 Loopback 0 address
56798       ipaddress-v6-loopback-0:
56799         type: string
56800         description: IPV6 Loopback 0 address
56801       ipaddress-v4-aim:
56802         type: string
56803         description: IPV4 AIM address
56804       ipaddress-v6-aim:
56805         type: string
56806         description: IPV6 AIM address
56807       ipaddress-v6-oam:
56808         type: string
56809         description: IPV6 OAM address
56810       inv-status:
56811         type: string
56812         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
56813       resource-version:
56814         type: string
56815         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56816       prov-status:
56817         type: string
56818         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
56819       nf-role:
56820         type: string
56821         description: Nf Role is the role performed by this instance in the network.
56822       relationship-list:
56823         type: array
56824         items:
56825           $ref: "#/definitions/relationship"
56826       p-interfaces:
56827         type: array
56828         items:
56829           $ref: "#/definitions/p-interface"
56830       lag-interfaces:
56831         type: array
56832         items:
56833           $ref: "#/definitions/lag-interface"
56834   pnfs:
56835     description: |
56836       Collection of Physical Network Functions.
56837     properties:
56838       pnf:
56839         type: array
56840         items:
56841           $ref: "#/definitions/pnf"
56842   port-group:
56843     description: |
56844       Used to capture the network interfaces of this VCE
56845       ###### Related Nodes
56846       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56847       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
56848       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
56849     required:
56850     - interface-id
56851     - orchestration-status
56852     properties:
56853       interface-id:
56854         type: string
56855         description: Unique ID of the interface
56856       neutron-network-id:
56857         type: string
56858         description: Neutron network id of this Interface
56859       neutron-network-name:
56860         type: string
56861         description: Neutron network name of this Interface
56862       interface-role:
56863         type: string
56864         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
56865       resource-version:
56866         type: string
56867         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56868       port-group-id:
56869         type: string
56870         description: Unique ID for port group in vmware
56871       port-group-name:
56872         type: string
56873         description: Likely to duplicate value of neutron network name
56874       switch-name:
56875         type: string
56876         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
56877       orchestration-status:
56878         type: string
56879         description: Orchestration status of this VNF, mastered by MSO
56880       heat-stack-id:
56881         type: string
56882         description: Heat stack id corresponding to this instance, managed by MSO
56883       mso-catalog-key:
56884         type: string
56885         description: Corresponds to the SDN-C catalog id used to configure this VCE
56886       cvlan-tags:
56887         type: array
56888         items:
56889           $ref: "#/definitions/cvlan-tag-entry"
56890       relationship-list:
56891         type: array
56892         items:
56893           $ref: "#/definitions/relationship"
56894   port-groups:
56895     properties:
56896       port-group:
56897         type: array
56898         items:
56899           $ref: "#/definitions/port-group"
56900   project:
56901     description: |
56902       describes the project
56903       ###### Related Nodes
56904       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56905     required:
56906     - project-name
56907     properties:
56908       project-name:
56909         type: string
56910         description: Name of the project deploying a service
56911       resource-version:
56912         type: string
56913         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56914       relationship-list:
56915         type: array
56916         items:
56917           $ref: "#/definitions/relationship"
56918   projects:
56919     description: |
56920       Collection of projects
56921     properties:
56922       project:
56923         type: array
56924         items:
56925           $ref: "#/definitions/project"
56926   properties:
56927     description: |
56928       Property holder for query properties or instance properties
56929     properties:
56930       property-name:
56931         type: string
56932       property-value:
56933         type: string
56934   property-constraint:
56935     description: |
56936       TBD
56937       ###### Related Nodes
56938       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56939     required:
56940     - property-constraint-uuid
56941     - constraint-type
56942     - property-name
56943     - property-value
56944     properties:
56945       property-constraint-uuid:
56946         type: string
56947       constraint-type:
56948         type: string
56949       property-name:
56950         type: string
56951       property-value:
56952         type: string
56953       resource-version:
56954         type: string
56955   property-constraints:
56956     properties:
56957       property-constraint:
56958         type: array
56959         items:
56960           $ref: "#/definitions/property-constraint"
56961   pserver:
56962     description: |
56963       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
56964       ###### Related Nodes
56965       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56966       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56967       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56968       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56969       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56970       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
56971       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56972       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56973       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56974       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56975       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
56976       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56977       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
56978     required:
56979     - hostname
56980     - in-maint
56981     properties:
56982       hostname:
56983         type: string
56984         description: Value from executing hostname on the compute node.
56985       ptnii-equip-name:
56986         type: string
56987         description: PTNII name
56988       number-of-cpus:
56989         type: integer
56990         format: int32
56991         description: Number of cpus
56992       disk-in-gigabytes:
56993         type: integer
56994         format: int32
56995         description: Disk size, in GBs
56996       ram-in-megabytes:
56997         type: integer
56998         format: int32
56999         description: RAM size, in MBs
57000       equip-type:
57001         type: string
57002         description: Equipment type.  Source of truth should define valid values.
57003       equip-vendor:
57004         type: string
57005         description: Equipment vendor.  Source of truth should define valid values.
57006       equip-model:
57007         type: string
57008         description: Equipment model.  Source of truth should define valid values.
57009       fqdn:
57010         type: string
57011         description: Fully-qualified domain name
57012       pserver-selflink:
57013         type: string
57014         description: URL to endpoint where AAI can get more details
57015       ipv4-oam-address:
57016         type: string
57017         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
57018       serial-number:
57019         type: string
57020         description: Serial number, may be queried
57021       ipaddress-v4-loopback-0:
57022         type: string
57023         description: IPV4 Loopback 0 address
57024       ipaddress-v6-loopback-0:
57025         type: string
57026         description: IPV6 Loopback 0 address
57027       ipaddress-v4-aim:
57028         type: string
57029         description: IPV4 AIM address
57030       ipaddress-v6-aim:
57031         type: string
57032         description: IPV6 AIM address
57033       ipaddress-v6-oam:
57034         type: string
57035         description: IPV6 OAM address
57036       inv-status:
57037         type: string
57038         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
57039       pserver-id:
57040         type: string
57041         description: ID of Pserver
57042       internet-topology:
57043         type: string
57044         description: internet topology of Pserver
57045       in-maint:
57046         type: boolean
57047       resource-version:
57048         type: string
57049         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57050       pserver-name2:
57051         type: string
57052         description: alternative pserver name
57053       purpose:
57054         type: string
57055         description: purpose of pserver
57056       prov-status:
57057         type: string
57058         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
57059       management-option:
57060         type: string
57061         description: Indicates who owns and or manages the device.
57062       host-profile:
57063         type: string
57064         description: The host profile that defines the configuration of the pserver.
57065       relationship-list:
57066         type: array
57067         items:
57068           $ref: "#/definitions/relationship"
57069       p-interfaces:
57070         type: array
57071         items:
57072           $ref: "#/definitions/p-interface"
57073       lag-interfaces:
57074         type: array
57075         items:
57076           $ref: "#/definitions/lag-interface"
57077   pservers:
57078     description: |
57079       Collection of compute hosts.
57080     properties:
57081       pserver:
57082         type: array
57083         items:
57084           $ref: "#/definitions/pserver"
57085   query-parameters:
57086     description: |
57087       QueryParameters for performing a named-query or model query
57088     properties:
57089       named-query:
57090         type: object
57091         $ref: "#/definitions/named-query"
57092       overloaded-model:
57093         type: object
57094         $ref: "#/definitions/overloaded-model"
57095   related-lookup:
57096     description: |
57097       TBD
57098       ###### Related Nodes
57099       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57100     required:
57101     - related-lookup-uuid
57102     - source-node-type
57103     - source-node-property
57104     - target-node-type
57105     - target-node-property
57106     properties:
57107       related-lookup-uuid:
57108         type: string
57109       source-node-type:
57110         type: string
57111       source-node-property:
57112         type: string
57113       target-node-type:
57114         type: string
57115       target-node-property:
57116         type: string
57117       property-collect-list:
57118         type: string
57119       resource-version:
57120         type: string
57121       relationship-list:
57122         type: array
57123         items:
57124           $ref: "#/definitions/relationship"
57125   related-lookups:
57126     properties:
57127       related-lookup:
57128         type: array
57129         items:
57130           $ref: "#/definitions/related-lookup"
57131   related-to-property:
57132     properties:
57133       property-key:
57134         type: string
57135         description: Key part of a key/value pair
57136       property-value:
57137         type: string
57138         description: Value part of a key/value pair
57139   relationship:
57140     properties:
57141       related-to:
57142         type: string
57143         description: A keyword provided by A&AI to indicate type of node.
57144       relationship-label:
57145         type: string
57146         description: The edge label for this relationship.
57147       related-link:
57148         type: string
57149         description: URL to the object in A&AI.
57150       relationship-data:
57151         type: array
57152         items:
57153           $ref: "#/definitions/relationship-data"
57154   relationship-data:
57155     required:
57156     - relationship-key
57157     - relationship-value
57158     properties:
57159       relationship-key:
57160         type: string
57161         description: A keyword provided by A&AI to indicate an attribute.
57162       relationship-value:
57163         type: string
57164         description: Value of the attribute.
57165   relationship-list:
57166     properties:
57167       relationship:
57168         type: array
57169         items:
57170           $ref: "#/definitions/relationship"
57171   reserved-prop-names:
57172     description: |
57173       Internal map to define some reserved properties of a vertex
57174     properties:
57175       last-mod-source-of-truth:
57176         type: string
57177       aai-node-type:
57178         type: string
57179       aai-created-ts:
57180         type: integer
57181         format: int64
57182       aai-unique-key:
57183         type: string
57184       aai-last-mod-ts:
57185         type: integer
57186         format: int64
57187       source-of-truth:
57188         type: string
57189       aai-uri:
57190         type: string
57191   response-list:
57192     description: |
57193       Response container for the results of a named-query or model query
57194     properties:
57195       inventory-response-items:
57196         type: object
57197         $ref: "#/definitions/inventory-response-items"
57198   result-data:
57199     properties:
57200       resource-type:
57201         type: string
57202         description: The specific type of node in the A&AI graph
57203       resource-link:
57204         type: string
57205         description: The URL to the specific resource
57206   route-table-reference:
57207     description: |
57208       Openstack route table reference.
57209       ###### Related Nodes
57210       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
57211     required:
57212     - route-table-reference-id
57213     - route-table-reference-fqdn
57214     properties:
57215       route-table-reference-id:
57216         type: string
57217         description: Route Table Reference id, UUID assigned to this instance.
57218       route-table-reference-fqdn:
57219         type: string
57220         description: FQDN entry in the route table.
57221       resource-version:
57222         type: string
57223         description: Concurrency value
57224       relationship-list:
57225         type: array
57226         items:
57227           $ref: "#/definitions/relationship"
57228   route-table-references:
57229     description: |
57230       Collection of openstack route table references
57231     properties:
57232       route-table-reference:
57233         type: array
57234         items:
57235           $ref: "#/definitions/route-table-reference"
57236   route-target:
57237     description: |
57238       Route target information
57239       ###### Related Nodes
57240       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
57241     required:
57242     - global-route-target
57243     - route-target-role
57244     properties:
57245       global-route-target:
57246         type: string
57247         description: Number used to identify an RT, globally unique in the network
57248       route-target-role:
57249         type: string
57250         description: Role assigned to this route target
57251       resource-version:
57252         type: string
57253         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57254       relationship-list:
57255         type: array
57256         items:
57257           $ref: "#/definitions/relationship"
57258   route-targets:
57259     description: |
57260       Collection of route target information
57261     properties:
57262       route-target:
57263         type: array
57264         items:
57265           $ref: "#/definitions/route-target"
57266   routing-instance:
57267     description: |
57268       ###### Related Nodes
57269       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
57270       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
57271       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
57272     required:
57273     - routing-instance-id
57274     properties:
57275       routing-instance-id:
57276         type: string
57277         description: Unique id of routing instance
57278       rpm-owner:
57279         type: string
57280         description: rpm owner
57281       resource-version:
57282         type: string
57283         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57284       site-pairs:
57285         type: array
57286         items:
57287           $ref: "#/definitions/site-pair"
57288       relationship-list:
57289         type: array
57290         items:
57291           $ref: "#/definitions/relationship"
57292   routing-instances:
57293     description: |
57294       set of probes related to generic-vnf routing instance
57295     properties:
57296       routing-instance:
57297         type: array
57298         items:
57299           $ref: "#/definitions/routing-instance"
57300   sdn-zone-response:
57301     properties:
57302       oam-networks:
57303         type: object
57304         $ref: "#/definitions/oam-networks"
57305       az-and-dvs-switches:
57306         type: array
57307         items:
57308           $ref: "#/definitions/az-and-dvs-switches"
57309   search:
57310     properties:
57311       edge-tag-query-result:
57312         type: object
57313         $ref: "#/definitions/edge-tag-query-result"
57314       edge-tag-query-request:
57315         type: object
57316         $ref: "#/definitions/edge-tag-query-request"
57317       search-results:
57318         type: object
57319         $ref: "#/definitions/search-results"
57320       sdn-zone-response:
57321         type: object
57322         $ref: "#/definitions/sdn-zone-response"
57323   search-results:
57324     properties:
57325       result-data:
57326         type: array
57327         items:
57328           $ref: "#/definitions/result-data"
57329   secondary-filt:
57330     description: |
57331       SecondaryFilt for performing a named-query or model query
57332   secondary-filter:
57333     properties:
57334       property-name:
57335         type: string
57336       filter-type:
57337         type: string
57338       property-value:
57339         type: string
57340   secondary-filts:
57341     description: |
57342       SecondaryFilts for performing a named-query or model query
57343     properties:
57344       secondary-filt:
57345         type: array
57346         items:
57347           $ref: "#/definitions/secondary-filt"
57348   segmentation-assignment:
57349     description: |
57350       Openstack segmentation assignment.
57351       ###### Related Nodes
57352       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
57353     required:
57354     - segmentation-id
57355     properties:
57356       segmentation-id:
57357         type: string
57358         description: Route Table Reference id, UUID assigned to this instance.
57359       resource-version:
57360         type: string
57361         description: Concurrency value
57362       relationship-list:
57363         type: array
57364         items:
57365           $ref: "#/definitions/relationship"
57366   segmentation-assignments:
57367     description: |
57368       Collection of openstack segmentation assignments
57369     properties:
57370       segmentation-assignment:
57371         type: array
57372         items:
57373           $ref: "#/definitions/segmentation-assignment"
57374   service:
57375     description: |
57376       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
57377     required:
57378     - service-id
57379     - service-description
57380     properties:
57381       service-id:
57382         type: string
57383         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
57384       service-description:
57385         type: string
57386         description: Description of the service
57387       service-selflink:
57388         type: string
57389         description: URL to endpoint where AAI can get more details
57390       resource-version:
57391         type: string
57392         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57393       service-version:
57394         type: string
57395         description: service version
57396       relationship-list:
57397         type: array
57398         items:
57399           $ref: "#/definitions/relationship"
57400   service-capabilities:
57401     description: |
57402       Collection of service capabilities.
57403     properties:
57404       service-capability:
57405         type: array
57406         items:
57407           $ref: "#/definitions/service-capability"
57408   service-capability:
57409     description: |
57410       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
57411       ###### Related Nodes
57412       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57413       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57414       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
57415     required:
57416     - service-type
57417     - vnf-type
57418     properties:
57419       service-type:
57420         type: string
57421         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
57422       vnf-type:
57423         type: string
57424         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.
57425       resource-version:
57426         type: string
57427         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57428       relationship-list:
57429         type: array
57430         items:
57431           $ref: "#/definitions/relationship"
57432   service-design-and-creation:
57433     description: |
57434       Namespace for objects managed by ASDC
57435     properties:
57436       vnf-images:
57437         type: array
57438         items:
57439           $ref: "#/definitions/vnf-image"
57440       services:
57441         type: array
57442         items:
57443           $ref: "#/definitions/service"
57444       service-capabilities:
57445         type: array
57446         items:
57447           $ref: "#/definitions/service-capability"
57448       models:
57449         type: array
57450         items:
57451           $ref: "#/definitions/model"
57452       named-queries:
57453         type: array
57454         items:
57455           $ref: "#/definitions/named-query"
57456   service-instance:
57457     description: |
57458       Instance of a service
57459       ###### Related Nodes
57460       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
57461       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
57462       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
57463       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
57464       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
57465       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
57466       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
57467       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
57468       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57469       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
57470       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
57471       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
57472       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57473       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57474       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
57475       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
57476       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
57477       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
57478       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57479       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57480       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
57481       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
57482       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
57483       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57484     required:
57485     - service-instance-id
57486     - service-type
57487     - service-role
57488     - created-at
57489     - updated-at
57490     - description
57491     properties:
57492       service-instance-id:
57493         type: string
57494         description: Uniquely identifies this instance of a service
57495       service-instance-name:
57496         type: string
57497         description: This field will store a name assigned to the service-instance.
57498       service-type:
57499         type: string
57500         description: String capturing type of service.
57501       service-role:
57502         type: string
57503         description: String capturing the service role.
57504       environment-context:
57505         type: string
57506         description: This field will store the environment context assigned to the service-instance.
57507       workload-context:
57508         type: string
57509         description: This field will store the workload context assigned to the service-instance.
57510       created-at:
57511         type: string
57512         description: create time of Network Service.
57513       updated-at:
57514         type: string
57515         description: last update of Network Service.
57516       description:
57517         type: string
57518         description: short description for service-instance.
57519       model-invariant-id:
57520         type: string
57521         description: the ASDC model id for this resource or service model.
57522       model-version-id:
57523         type: string
57524         description: the ASDC model version for this resource or service model.
57525       persona-model-version:
57526         type: string
57527         description: the ASDC model version for this resource or service model.
57528       widget-model-id:
57529         type: string
57530         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57531       widget-model-version:
57532         type: string
57533         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57534       bandwidth-total:
57535         type: string
57536         description: Indicates the total bandwidth to be used for this service.
57537       bandwidth-up-wan1:
57538         type: string
57539         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
57540       bandwidth-down-wan1:
57541         type: string
57542         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
57543       bandwidth-up-wan2:
57544         type: string
57545         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
57546       bandwidth-down-wan2:
57547         type: string
57548         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
57549       vhn-portal-url:
57550         type: string
57551         description: URL customers will use to access the vHN Portal.
57552       service-instance-location-id:
57553         type: string
57554         description: An identifier that customers assign to the location where this service is being used.
57555       resource-version:
57556         type: string
57557         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57558       selflink:
57559         type: string
57560         description: Path to the controller object.
57561       orchestration-status:
57562         type: string
57563         description: Orchestration status of this service.
57564       relationship-list:
57565         type: array
57566         items:
57567           $ref: "#/definitions/relationship"
57568       metadata:
57569         type: array
57570         items:
57571           $ref: "#/definitions/metadatum"
57572       allotted-resources:
57573         type: array
57574         items:
57575           $ref: "#/definitions/allotted-resource"
57576   service-instances:
57577     description: |
57578       Collection of service instances
57579     properties:
57580       service-instance:
57581         type: array
57582         items:
57583           $ref: "#/definitions/service-instance"
57584   service-subscription:
57585     description: |
57586       Object that group service instances.
57587       ###### Related Nodes
57588       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
57589       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57590       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
57591       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
57592     required:
57593     - service-type
57594     properties:
57595       service-type:
57596         type: string
57597         description: Value defined by orchestration to identify this service across ECOMP.
57598       temp-ub-sub-account-id:
57599         type: string
57600         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
57601       resource-version:
57602         type: string
57603         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57604       service-instances:
57605         type: array
57606         items:
57607           $ref: "#/definitions/service-instance"
57608       relationship-list:
57609         type: array
57610         items:
57611           $ref: "#/definitions/relationship"
57612   service-subscriptions:
57613     description: |
57614       Collection of objects that group service instances.
57615     properties:
57616       service-subscription:
57617         type: array
57618         items:
57619           $ref: "#/definitions/service-subscription"
57620   services:
57621     description: |
57622       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
57623     properties:
57624       service:
57625         type: array
57626         items:
57627           $ref: "#/definitions/service"
57628   site-pair:
57629     description: |
57630       ###### Related Nodes
57631       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
57632       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
57633       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
57634     required:
57635     - site-pair-id
57636     properties:
57637       site-pair-id:
57638         type: string
57639         description: unique identifier of probe
57640       source-ip:
57641         type: string
57642         description: Prefix address
57643       destination-ip:
57644         type: string
57645         description: Prefix address
57646       ip-version:
57647         type: string
57648         description: ip version, v4, v6
57649       destination-hostname:
57650         type: string
57651         description: Hostname of the destination equipment to which SLAs are measured against.
57652       destination-equip-type:
57653         type: string
57654         description: The type of destinatination equipment. Could be Router, UCPE, etc.
57655       resource-version:
57656         type: string
57657         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57658       classes-of-service:
57659         type: array
57660         items:
57661           $ref: "#/definitions/class-of-service"
57662       relationship-list:
57663         type: array
57664         items:
57665           $ref: "#/definitions/relationship"
57666   site-pair-set:
57667     description: |
57668       Set of instances for probes used to measure service level agreements
57669       ###### Related Nodes
57670       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
57671       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
57672       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
57673     required:
57674     - site-pair-set-id
57675     properties:
57676       site-pair-set-id:
57677         type: string
57678         description: Unique id of site pair set.
57679       resource-version:
57680         type: string
57681         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57682       routing-instances:
57683         type: array
57684         items:
57685           $ref: "#/definitions/routing-instance"
57686       relationship-list:
57687         type: array
57688         items:
57689           $ref: "#/definitions/relationship"
57690   site-pair-sets:
57691     description: |
57692       Collection of sets of instances for probes related to generic-vnf
57693     properties:
57694       site-pair-set:
57695         type: array
57696         items:
57697           $ref: "#/definitions/site-pair-set"
57698   site-pairs:
57699     description: |
57700       probe within a set
57701     properties:
57702       site-pair:
57703         type: array
57704         items:
57705           $ref: "#/definitions/site-pair"
57706   snapshot:
57707     description: |
57708       Openstack snapshot
57709       ###### Related Nodes
57710       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57711       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57712     required:
57713     - snapshot-id
57714     properties:
57715       snapshot-id:
57716         type: string
57717         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
57718       snapshot-name:
57719         type: string
57720         description: Snapshot name
57721       snapshot-architecture:
57722         type: string
57723         description: Operating system architecture
57724       snapshot-os-distro:
57725         type: string
57726         description: The common name of the operating system distribution in lowercase
57727       snapshot-os-version:
57728         type: string
57729         description: The operating system version as specified by the distributor.
57730       application:
57731         type: string
57732         description: The application that the image instantiates.
57733       application-vendor:
57734         type: string
57735         description: The vendor of the application.
57736       application-version:
57737         type: string
57738         description: The version of the application.
57739       snapshot-selflink:
57740         type: string
57741         description: URL to endpoint where AAI can get more details
57742       prev-snapshot-id:
57743         type: string
57744         description: This field contains the UUID of the previous snapshot (if any).
57745       resource-version:
57746         type: string
57747         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57748       relationship-list:
57749         type: array
57750         items:
57751           $ref: "#/definitions/relationship"
57752   snapshots:
57753     description: |
57754       Collection of openstack snapshots
57755     properties:
57756       snapshot:
57757         type: array
57758         items:
57759           $ref: "#/definitions/snapshot"
57760   sriov-pf:
57761     description: |
57762       SR-IOV Physical Function
57763       ###### Related Nodes
57764       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
57765       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
57766     required:
57767     - pf-pci-id
57768     properties:
57769       pf-pci-id:
57770         type: string
57771         description: Identifier for the sriov-pf
57772       resource-version:
57773         type: string
57774         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57775       relationship-list:
57776         type: array
57777         items:
57778           $ref: "#/definitions/relationship"
57779   sriov-pfs:
57780     description: |
57781       Collection of SR-IOV Physical Functions.
57782     properties:
57783       sriov-pf:
57784         type: array
57785         items:
57786           $ref: "#/definitions/sriov-pf"
57787   sriov-vf:
57788     description: |
57789       SR-IOV Virtual Function (not to be confused with virtual network function)
57790       ###### Related Nodes
57791       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
57792       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
57793     required:
57794     - pci-id
57795     properties:
57796       pci-id:
57797         type: string
57798         description: PCI ID used to identify the sriov-vf
57799       vf-vlan-filter:
57800         type: string
57801         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
57802       vf-mac-filter:
57803         type: string
57804         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
57805       vf-vlan-strip:
57806         type: boolean
57807         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
57808       vf-vlan-anti-spoof-check:
57809         type: boolean
57810         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.
57811       vf-mac-anti-spoof-check:
57812         type: boolean
57813         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.
57814       vf-mirrors:
57815         type: string
57816         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
57817       vf-broadcast-allow:
57818         type: boolean
57819         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
57820       vf-unknown-multicast-allow:
57821         type: boolean
57822         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
57823       vf-unknown-unicast-allow:
57824         type: boolean
57825         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
57826       vf-insert-stag:
57827         type: boolean
57828         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
57829       vf-link-status:
57830         type: string
57831         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
57832       resource-version:
57833         type: string
57834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57835       neutron-network-id:
57836         type: string
57837         description: Neutron network id of the interface
57838       relationship-list:
57839         type: array
57840         items:
57841           $ref: "#/definitions/relationship"
57842   sriov-vfs:
57843     description: |
57844       Collection of SR-IOV Virtual Functions.
57845     properties:
57846       sriov-vf:
57847         type: array
57848         items:
57849           $ref: "#/definitions/sriov-vf"
57850   start-node-filter:
57851     properties:
57852       property-name:
57853         type: string
57854       property-value:
57855         type: string
57856   subnet:
57857     description: |
57858       ###### Related Nodes
57859       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
57860       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
57861       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
57862       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
57863       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57864       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57865       - 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
57866       - SUBNET is DELETED when these are DELETED HOST-ROUTE
57867     required:
57868     - subnet-id
57869     - dhcp-enabled
57870     properties:
57871       subnet-id:
57872         type: string
57873         description: Subnet ID, should be UUID.
57874       subnet-name:
57875         type: string
57876         description: Name associated with the subnet.
57877       neutron-subnet-id:
57878         type: string
57879         description: Neutron id of this subnet
57880       gateway-address:
57881         type: string
57882         description: gateway ip address
57883       network-start-address:
57884         type: string
57885         description: network start address
57886       cidr-mask:
57887         type: string
57888         description: cidr mask
57889       ip-version:
57890         type: string
57891         description: ip version
57892       orchestration-status:
57893         type: string
57894         description: Orchestration status of this VNF, mastered by MSO
57895       dhcp-enabled:
57896         type: boolean
57897       dhcp-start:
57898         type: string
57899         description: the start address reserved for use by dhcp
57900       dhcp-end:
57901         type: string
57902         description: the last address reserved for use by dhcp
57903       subnet-role:
57904         type: string
57905         description: role of the subnet, referenced when assigning IPs
57906       ip-assignment-direction:
57907         type: string
57908         description: ip address assignment direction of the subnet
57909       resource-version:
57910         type: string
57911         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57912       subnet-sequence:
57913         type: integer
57914         format: int32
57915         description: sequence of the subnet
57916       host-routes:
57917         type: array
57918         items:
57919           $ref: "#/definitions/host-route"
57920       relationship-list:
57921         type: array
57922         items:
57923           $ref: "#/definitions/relationship"
57924   subnets:
57925     properties:
57926       subnet:
57927         type: array
57928         items:
57929           $ref: "#/definitions/subnet"
57930   tagged-inventory-item-list:
57931     properties:
57932       inventory-item:
57933         type: array
57934         items:
57935           $ref: "#/definitions/inventory-item"
57936   tenant:
57937     description: |
57938       Openstack tenant
57939       ###### Related Nodes
57940       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57941       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
57942       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57943       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57944       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57945       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57946       - TENANT cannot be deleted if linked to VSERVER
57947     required:
57948     - tenant-id
57949     - tenant-name
57950     properties:
57951       tenant-id:
57952         type: string
57953         description: Unique id relative to the cloud-region.
57954       tenant-name:
57955         type: string
57956         description: Readable name of tenant
57957       tenant-context:
57958         type: string
57959         description: This field will store the tenant context.
57960       resource-version:
57961         type: string
57962         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57963       vservers:
57964         type: array
57965         items:
57966           $ref: "#/definitions/vserver"
57967       relationship-list:
57968         type: array
57969         items:
57970           $ref: "#/definitions/relationship"
57971   tenants:
57972     description: |
57973       Collection of openstack tenants.
57974     properties:
57975       tenant:
57976         type: array
57977         items:
57978           $ref: "#/definitions/tenant"
57979   tunnel-xconnect:
57980     description: |
57981       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
57982       ###### Related Nodes
57983       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57984     required:
57985     - id
57986     properties:
57987       id:
57988         type: string
57989         description: Allotted Resource id UUID assigned to this instance.
57990       bandwidth-up-wan1:
57991         type: string
57992         description: The WAN uplink bandwidth for WAN1
57993       bandwidth-down-wan1:
57994         type: string
57995         description: The WAN downlink bandwidth for WAN1
57996       bandwidth-up-wan2:
57997         type: string
57998         description: The WAN uplink bandwidth for WAN2
57999       bandwidth-down-wan2:
58000         type: string
58001         description: The WAN downlink bandwidth for WAN2
58002       resource-version:
58003         type: string
58004         description: Concurrency value
58005       relationship-list:
58006         type: array
58007         items:
58008           $ref: "#/definitions/relationship"
58009   tunnel-xconnects:
58010     description: |
58011       This object is used to store the specific tunnel cross connect aspects of an allotted resource
58012     properties:
58013       tunnel-xconnect:
58014         type: array
58015         items:
58016           $ref: "#/definitions/tunnel-xconnect"
58017   update:
58018     description: |
58019       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
58020     required:
58021     - update-node-type
58022     properties:
58023       update-node-type:
58024         type: string
58025       update-node-key:
58026         type: array
58027         items:
58028           $ref: "#/definitions/update-node-key"
58029       update-node-uri:
58030         type: string
58031       action:
58032         type: array
58033         items:
58034           $ref: "#/definitions/action"
58035   update-node-key:
58036     properties:
58037       key-name:
58038         type: string
58039       key-value:
58040         type: string
58041   vce:
58042     description: |
58043       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
58044       ###### Related Nodes
58045       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58046       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58047       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
58048       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58049       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58050       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58051       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
58052       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
58053     required:
58054     - vnf-id
58055     - vnf-name
58056     - vnf-type
58057     properties:
58058       vnf-id:
58059         type: string
58060         description: Unique id of VNF.  This is unique across the graph.
58061       vnf-name:
58062         type: string
58063         description: Name of VNF.
58064       vnf-name2:
58065         type: string
58066         description: Alternate name of VNF.
58067       vnf-type:
58068         type: string
58069         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.
58070       service-id:
58071         type: string
58072         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
58073       regional-resource-zone:
58074         type: string
58075         description: Regional way of organizing pservers, source of truth should define values
58076       prov-status:
58077         type: string
58078         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58079       operational-status:
58080         type: string
58081         description: Indicator for whether the resource is considered operational
58082       license-key:
58083         type: string
58084         description: OBSOLETE -  do not use
58085       equipment-role:
58086         type: string
58087         description: Network role being played by this VNF
58088       orchestration-status:
58089         type: string
58090         description: Orchestration status of this VNF, mastered by MSO
58091       heat-stack-id:
58092         type: string
58093         description: Heat stack id corresponding to this instance, managed by MSO
58094       mso-catalog-key:
58095         type: string
58096         description: Corresponds to the SDN-C catalog id used to configure this VCE
58097       vpe-id:
58098         type: string
58099         description: Unique ID of VPE connected to this VCE.
58100       v6-vce-wan-address:
58101         type: string
58102         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
58103       ipv4-oam-address:
58104         type: string
58105         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
58106       resource-version:
58107         type: string
58108         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58109       ipv4-loopback0-address:
58110         type: string
58111         description: Loopback0 address
58112       entitlement-resource-uuid:
58113         type: string
58114         description: OBSOLETE -  see child relationships
58115       port-groups:
58116         type: array
58117         items:
58118           $ref: "#/definitions/port-group"
58119       licenses:
58120         type: array
58121         items:
58122           $ref: "#/definitions/license"
58123       entitlements:
58124         type: array
58125         items:
58126           $ref: "#/definitions/entitlement"
58127       relationship-list:
58128         type: array
58129         items:
58130           $ref: "#/definitions/relationship"
58131   vces:
58132     description: |
58133       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
58134     properties:
58135       vce:
58136         type: array
58137         items:
58138           $ref: "#/definitions/vce"
58139   vf-module:
58140     description: |
58141       a deployment unit of VNFCs
58142       ###### Related Nodes
58143       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58144       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
58145       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
58146       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
58147       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
58148       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
58149       - VF-MODULE cannot be deleted if linked to VNFC
58150     required:
58151     - vf-module-id
58152     - is-base-vf-module
58153     properties:
58154       vf-module-id:
58155         type: string
58156         description: Unique ID of vf-module.
58157       vf-module-name:
58158         type: string
58159         description: Name of vf-module
58160       heat-stack-id:
58161         type: string
58162         description: Heat stack id corresponding to this instance.
58163       orchestration-status:
58164         type: string
58165         description: orchestration status of this vf-module, mastered by MSO
58166       is-base-vf-module:
58167         type: boolean
58168       resource-version:
58169         type: string
58170         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58171       model-invariant-id:
58172         type: string
58173         description: the ASDC model id for this resource or service model.
58174       model-version-id:
58175         type: string
58176         description: the ASDC model version for this resource or service model.
58177       persona-model-version:
58178         type: string
58179         description: the ASDC model version for this resource or service model.
58180       model-customization-id:
58181         type: string
58182         description: captures the id of all the configuration used to customize the resource for the service.
58183       widget-model-id:
58184         type: string
58185         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58186       widget-model-version:
58187         type: string
58188         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58189       contrail-service-instance-fqdn:
58190         type: string
58191         description: the Contrail unique ID for a service-instance
58192       module-index:
58193         type: integer
58194         format: int32
58195         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
58196       selflink:
58197         type: string
58198         description: Path to the controller object.
58199       relationship-list:
58200         type: array
58201         items:
58202           $ref: "#/definitions/relationship"
58203   vf-modules:
58204     description: |
58205       Collection of vf-modules, a deployment unit of VNFCs
58206     properties:
58207       vf-module:
58208         type: array
58209         items:
58210           $ref: "#/definitions/vf-module"
58211   vig-server:
58212     description: |
58213       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
58214       ###### Related Nodes
58215       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
58216     required:
58217     - vig-address-type
58218     properties:
58219       vig-address-type:
58220         type: string
58221         description: indicates whether the VIG is for AVPN or INTERNET
58222       ipaddress-v4-vig:
58223         type: string
58224         description: v4 IP of the vig server
58225       ipaddress-v6-vig:
58226         type: string
58227         description: v6 IP of the vig server
58228       resource-version:
58229         type: string
58230         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58231       relationship-list:
58232         type: array
58233         items:
58234           $ref: "#/definitions/relationship"
58235   vig-servers:
58236     properties:
58237       vig-server:
58238         type: array
58239         items:
58240           $ref: "#/definitions/vig-server"
58241   vip-ipv4-address-list:
58242     description: |
58243       IPv4 Address Range
58244       ###### Related Nodes
58245       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58246       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58247       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
58248       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
58249     required:
58250     - vip-ipv4-address
58251     properties:
58252       vip-ipv4-address:
58253         type: string
58254         description: IP address
58255       vip-ipv4-prefix-length:
58256         type: integer
58257         format: int64
58258         description: Prefix length, 32 for single address
58259       vlan-id-inner:
58260         type: integer
58261         format: int64
58262         description: Inner VLAN tag
58263       vlan-id-outer:
58264         type: integer
58265         format: int64
58266         description: Outer VLAN tag
58267       is-floating:
58268         type: boolean
58269         description: Indicator of fixed or floating address
58270       resource-version:
58271         type: string
58272         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58273       neutron-network-id:
58274         type: string
58275         description: Neutron network id of the interface that address belongs to
58276       neutron-subnet-id:
58277         type: string
58278         description: Neutron id of subnet that address belongs to
58279       relationship-list:
58280         type: array
58281         items:
58282           $ref: "#/definitions/relationship"
58283   vip-ipv6-address-list:
58284     description: |
58285       IPv6 Address Range
58286       ###### Related Nodes
58287       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58288       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58289       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
58290       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
58291     required:
58292     - vip-ipv6-address
58293     properties:
58294       vip-ipv6-address:
58295         type: string
58296         description: IP address
58297       vip-ipv6-prefix-length:
58298         type: integer
58299         format: int64
58300         description: Prefix length, 128 for single address
58301       vlan-id-inner:
58302         type: integer
58303         format: int64
58304         description: Inner VLAN tag
58305       vlan-id-outer:
58306         type: integer
58307         format: int64
58308         description: Outer VLAN tag
58309       is-floating:
58310         type: boolean
58311         description: Indicator of fixed or floating address
58312       resource-version:
58313         type: string
58314         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58315       neutron-network-id:
58316         type: string
58317         description: Neutron network id of the interface that address belongs to
58318       neutron-subnet-id:
58319         type: string
58320         description: Neutron id of subnet that address belongs to
58321       relationship-list:
58322         type: array
58323         items:
58324           $ref: "#/definitions/relationship"
58325   virtual-data-center:
58326     description: |
58327       Virtual organization of cloud infrastructure elements in a data center context
58328       ###### Related Nodes
58329       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58330       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58331       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58332     required:
58333     - vdc-id
58334     - vdc-name
58335     properties:
58336       vdc-id:
58337         type: string
58338         description: Unique ID of the vdc
58339       vdc-name:
58340         type: string
58341         description: Name of the virtual data center
58342       resource-version:
58343         type: string
58344         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58345       relationship-list:
58346         type: array
58347         items:
58348           $ref: "#/definitions/relationship"
58349   virtual-data-centers:
58350     description: |
58351       Virtual organization of cloud infrastructure elements in a data center context
58352     properties:
58353       virtual-data-center:
58354         type: array
58355         items:
58356           $ref: "#/definitions/virtual-data-center"
58357   vlan:
58358     description: |
58359       Definition of vlan
58360       ###### Related Nodes
58361       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
58362       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
58363       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
58364       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
58365       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
58366       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58367       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58368       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
58369       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
58370     required:
58371     - vlan-interface
58372     - in-maint
58373     - is-ip-unnumbered
58374     properties:
58375       vlan-interface:
58376         type: string
58377         description: String that identifies the interface
58378       vlan-id-inner:
58379         type: integer
58380         format: int64
58381         description: Inner VLAN tag
58382       vlan-id-outer:
58383         type: integer
58384         format: int64
58385         description: Outer VLAN tag
58386       resource-version:
58387         type: string
58388         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58389       speed-value:
58390         type: string
58391         description: Captures the numeric part of the speed
58392       speed-units:
58393         type: string
58394         description: Captures the units corresponding to the speed
58395       vlan-description:
58396         type: string
58397         description: Used to describe (the service associated with) the vlan
58398       backdoor-connection:
58399         type: string
58400         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
58401       vpn-key:
58402         type: string
58403         description: This indicates the customers VPN ID associated with this vlan
58404       orchestration-status:
58405         type: string
58406         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
58407       in-maint:
58408         type: boolean
58409       prov-status:
58410         type: string
58411         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
58412       is-ip-unnumbered:
58413         type: boolean
58414       relationship-list:
58415         type: array
58416         items:
58417           $ref: "#/definitions/relationship"
58418       l3-interface-ipv4-address-list:
58419         type: array
58420         items:
58421           $ref: "#/definitions/l3-interface-ipv4-address-list"
58422       l3-interface-ipv6-address-list:
58423         type: array
58424         items:
58425           $ref: "#/definitions/l3-interface-ipv6-address-list"
58426   vlans:
58427     properties:
58428       vlan:
58429         type: array
58430         items:
58431           $ref: "#/definitions/vlan"
58432   vnf:
58433     description: |
58434       Abstract vnf class
58435     required:
58436     - vnf-id
58437     properties:
58438       vnf-id:
58439         type: string
58440         description: Unique id of VNF.  This is unique across the graph.
58441   vnf-image:
58442     description: |
58443       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
58444       ###### Related Nodes
58445       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
58446       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
58447     required:
58448     - vnf-image-uuid
58449     - application
58450     - application-vendor
58451     properties:
58452       vnf-image-uuid:
58453         type: string
58454         description: Unique ID of this asset
58455       application:
58456         type: string
58457         description: The application that the image instantiates.
58458       application-vendor:
58459         type: string
58460         description: The vendor of the application.
58461       application-version:
58462         type: string
58463         description: The version of the application.
58464       selflink:
58465         type: string
58466         description: URL to endpoint where AAI can get more details
58467       resource-version:
58468         type: string
58469         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58470       relationship-list:
58471         type: array
58472         items:
58473           $ref: "#/definitions/relationship"
58474   vnf-images:
58475     description: |
58476       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
58477     properties:
58478       vnf-image:
58479         type: array
58480         items:
58481           $ref: "#/definitions/vnf-image"
58482   vnfc:
58483     description: |
58484       ###### Related Nodes
58485       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58486       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58487       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
58488       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
58489       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
58490       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
58491       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
58492       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
58493       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
58494     required:
58495     - vnfc-name
58496     - nfc-naming-code
58497     - nfc-function
58498     - in-maint
58499     - is-closed-loop-disabled
58500     properties:
58501       vnfc-name:
58502         type: string
58503         description: Unique ID of vnfc.
58504       nfc-naming-code:
58505         type: string
58506         description: Short code that is used in naming instances of the item being modeled
58507       nfc-function:
58508         type: string
58509         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
58510       prov-status:
58511         type: string
58512         description: prov status of this vnfc
58513       orchestration-status:
58514         type: string
58515         description: Orchestration status of this VNF, mastered by APP-C
58516       ipaddress-v4-oam-vip:
58517         type: string
58518         description: Oam V4 vip address of this vnfc
58519       in-maint:
58520         type: boolean
58521       is-closed-loop-disabled:
58522         type: boolean
58523       group-notation:
58524         type: string
58525         description: Group notation of VNFC
58526       model-invariant-id:
58527         type: string
58528         description: the ASDC model id for this resource or service model.
58529       model-version-id:
58530         type: string
58531         description: the ASDC model version for this resource or service model.
58532       resource-version:
58533         type: string
58534         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58535       relationship-list:
58536         type: array
58537         items:
58538           $ref: "#/definitions/relationship"
58539       l3-interface-ipv4-address-list:
58540         type: array
58541         items:
58542           $ref: "#/definitions/l3-interface-ipv4-address-list"
58543       l3-interface-ipv6-address-list:
58544         type: array
58545         items:
58546           $ref: "#/definitions/l3-interface-ipv6-address-list"
58547   vnfcs:
58548     description: |
58549       virtual network components associated with a vserver from application controller.
58550     properties:
58551       vnfc:
58552         type: array
58553         items:
58554           $ref: "#/definitions/vnfc"
58555   volume:
58556     description: |
58557       Ephemeral Block storage volume.
58558       ###### Related Nodes
58559       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
58560     required:
58561     - volume-id
58562     - volume-selflink
58563     properties:
58564       volume-id:
58565         type: string
58566         description: Unique ID of block storage volume relative to the vserver.
58567       volume-selflink:
58568         type: string
58569         description: URL to endpoint where AAI can get more details
58570       resource-version:
58571         type: string
58572         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58573       relationship-list:
58574         type: array
58575         items:
58576           $ref: "#/definitions/relationship"
58577   volume-group:
58578     description: |
58579       Persistent block-level storage.
58580       ###### Related Nodes
58581       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58582       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58583       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58584       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
58585       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58586     required:
58587     - volume-group-id
58588     - volume-group-name
58589     - vnf-type
58590     properties:
58591       volume-group-id:
58592         type: string
58593         description: Unique ID of volume-group.
58594       volume-group-name:
58595         type: string
58596         description: Name of the volume group.
58597       heat-stack-id:
58598         type: string
58599         description: Heat stack id corresponding to this volume-group
58600       vnf-type:
58601         type: string
58602         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.
58603       orchestration-status:
58604         type: string
58605         description: Orchestration status of this volume-group
58606       model-customization-id:
58607         type: string
58608         description: captures the id of all the configuration used to customize the resource for the service.
58609       vf-module-model-customization-id:
58610         type: string
58611         description: helps relate the volume group to the vf-module whose components will require the volume group
58612       resource-version:
58613         type: string
58614         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58615       relationship-list:
58616         type: array
58617         items:
58618           $ref: "#/definitions/relationship"
58619   volume-groups:
58620     description: |
58621       Collection of persistent block-level storage.
58622     properties:
58623       volume-group:
58624         type: array
58625         items:
58626           $ref: "#/definitions/volume-group"
58627   volumes:
58628     description: |
58629       Collection of ephemeral Block storage volumes.
58630     properties:
58631       volume:
58632         type: array
58633         items:
58634           $ref: "#/definitions/volume"
58635   vpls-pe:
58636     description: |
58637       VPLS Provider Edge routers.
58638       ###### Related Nodes
58639       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58640       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58641       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
58642       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
58643       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
58644     required:
58645     - equipment-name
58646     properties:
58647       equipment-name:
58648         type: string
58649       prov-status:
58650         type: string
58651         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
58652       ipv4-oam-address:
58653         type: string
58654         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).
58655       equipment-role:
58656         type: string
58657         description: Client should send valid enumerated value, e.g., VPLS-PE.
58658       vlan-id-outer:
58659         type: integer
58660         format: int64
58661         description: Temporary location for stag to get to VCE
58662       resource-version:
58663         type: string
58664         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58665       relationship-list:
58666         type: array
58667         items:
58668           $ref: "#/definitions/relationship"
58669       p-interfaces:
58670         type: array
58671         items:
58672           $ref: "#/definitions/p-interface"
58673       lag-interfaces:
58674         type: array
58675         items:
58676           $ref: "#/definitions/lag-interface"
58677   vpls-pes:
58678     description: |
58679       Collection of VPLS Provider Edge routers
58680     properties:
58681       vpls-pe:
58682         type: array
58683         items:
58684           $ref: "#/definitions/vpls-pe"
58685   vpn-binding:
58686     description: |
58687       VPN binding
58688       ###### Related Nodes
58689       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
58690       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
58691       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
58692       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
58693       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
58694       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
58695     required:
58696     - vpn-id
58697     - vpn-name
58698     properties:
58699       vpn-id:
58700         type: string
58701         description: VPN ID, globally unique within A&AI
58702       vpn-name:
58703         type: string
58704         description: VPN Name
58705       vpn-platform:
58706         type: string
58707         description: the platform associated with the VPN example AVPN, Mobility
58708       vpn-type:
58709         type: string
58710         description: Type of the vpn, should be taken from enumerated/valid values
58711       vpn-region:
58712         type: string
58713         description: region of customer vpn
58714       customer-vpn-id:
58715         type: string
58716         description: id for this customer vpn
58717       route-distinguisher:
58718         type: string
58719         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
58720       resource-version:
58721         type: string
58722         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58723       route-targets:
58724         type: array
58725         items:
58726           $ref: "#/definitions/route-target"
58727       relationship-list:
58728         type: array
58729         items:
58730           $ref: "#/definitions/relationship"
58731         description: l3-networks relate to vpn-bindings
58732   vpn-bindings:
58733     properties:
58734       vpn-binding:
58735         type: array
58736         items:
58737           $ref: "#/definitions/vpn-binding"
58738   vserver:
58739     description: |
58740       Virtual Servers, aka virtual machine or VM.
58741       ###### Related Nodes
58742       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
58743       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
58744       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
58745       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
58746       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
58747       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
58748       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
58749       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
58750       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
58751       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
58752       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
58753       - VSERVER is DELETED when these are DELETED L-INTERFACE
58754       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
58755     required:
58756     - vserver-id
58757     - vserver-name
58758     - vserver-selflink
58759     - in-maint
58760     - is-closed-loop-disabled
58761     properties:
58762       vserver-id:
58763         type: string
58764         description: Unique identifier for this vserver relative to its tenant
58765       vserver-name:
58766         type: string
58767         description: Name of vserver
58768       vserver-name2:
58769         type: string
58770         description: Alternative name of vserver
58771       prov-status:
58772         type: string
58773         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58774       vserver-selflink:
58775         type: string
58776         description: URL to endpoint where AAI can get more details
58777       in-maint:
58778         type: boolean
58779       is-closed-loop-disabled:
58780         type: boolean
58781       resource-version:
58782         type: string
58783         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58784       volumes:
58785         type: array
58786         items:
58787           $ref: "#/definitions/volume"
58788       relationship-list:
58789         type: array
58790         items:
58791           $ref: "#/definitions/relationship"
58792       l-interfaces:
58793         type: array
58794         items:
58795           $ref: "#/definitions/l-interface"
58796   vservers:
58797     description: |
58798       Collection of virtual Servers, aka virtual machines or VMs.
58799     properties:
58800       vserver:
58801         type: array
58802         items:
58803           $ref: "#/definitions/vserver"
58804   zone:
58805     description: |
58806       A zone is a grouping of assets in a location homing to the same connections into the CBB
58807       ###### Related Nodes
58808       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58809       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58810       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58811       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58812       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58813     required:
58814     - zone-id
58815     - zone-name
58816     - design-type
58817     - zone-context
58818     properties:
58819       zone-id:
58820         type: string
58821         description: Code assigned by AIC to the zone
58822       zone-name:
58823         type: string
58824         description: English name associated with the zone
58825       design-type:
58826         type: string
58827         description: Design of zone [Medium/Large…]
58828       zone-context:
58829         type: string
58830         description: Context of zone [production/test]
58831       status:
58832         type: string
58833         description: Status of a zone.
58834       resource-version:
58835         type: string
58836         description: Concurrency value
58837       relationship-list:
58838         type: array
58839         items:
58840           $ref: "#/definitions/relationship"
58841   zones:
58842     description: |
58843       Collection of zones
58844     properties:
58845       zone:
58846         type: array
58847         items:
58848           $ref: "#/definitions/zone"
58849 patchDefinitions:
58850   aai-internal:
58851     properties:
58852       property-name:
58853         type: string
58854       property-value:
58855         type: string
58856   action:
58857     properties:
58858       action-type:
58859         type: string
58860       action-data:
58861         type: array
58862         items:
58863           $ref: "#/patchDefinitions/action-data"
58864   action-data:
58865     properties:
58866       property-name:
58867         type: string
58868       property-value:
58869         type: string
58870   actions:
58871     description: |
58872       APIs that are more action related than REST (e.g., notify, update).
58873     properties:
58874       update:
58875         type: object
58876         $ref: "#/patchDefinitions/update"
58877       notify:
58878         type: object
58879         $ref: "#/patchDefinitions/notify"
58880   allotted-resource:
58881     description: |
58882       Represents a slice or partial piece of a resource that gets separately allotted
58883       ###### Related Nodes
58884       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
58885       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58886       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58887       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
58888       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
58889       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
58890       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
58891       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
58892       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58893       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
58894       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
58895       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58896       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
58897       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
58898       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
58899     required:
58900     - id
58901     properties:
58902       id:
58903         type: string
58904         description: Allotted Resource id UUID assigned to this instance.
58905       description:
58906         type: string
58907         description: The descriptive information assigned to this allotted resource instance
58908       selflink:
58909         type: string
58910         description: Link back to more information in the controller
58911       model-invariant-id:
58912         type: string
58913         description: the ASDC model id for this resource or service model.
58914       model-version-id:
58915         type: string
58916         description: the ASDC model version for this resource or service model.
58917       persona-model-version:
58918         type: string
58919         description: the ASDC model version for this resource or service model.
58920   allotted-resources:
58921     description: |
58922       This object is used to store slices of services being offered
58923     properties:
58924       allotted-resource:
58925         type: array
58926         items:
58927           $ref: "#/patchDefinitions/allotted-resource"
58928   availability-zone:
58929     description: |
58930       Availability zone, a collection of compute hosts/pservers
58931       ###### Related Nodes
58932       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58933       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58934       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58935       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58936       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58937       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58938       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
58939       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58940       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
58941     required:
58942     - availability-zone-name
58943     - hypervisor-type
58944     properties:
58945       availability-zone-name:
58946         type: string
58947         description: Name of the availability zone.  Unique across a cloud region
58948       hypervisor-type:
58949         type: string
58950         description: Type of hypervisor.  Source of truth should define valid values.
58951       operational-status:
58952         type: string
58953         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
58954   availability-zones:
58955     description: |
58956       Collection of availability zones
58957     properties:
58958       availability-zone:
58959         type: array
58960         items:
58961           $ref: "#/patchDefinitions/availability-zone"
58962   az-and-dvs-switches:
58963     properties:
58964       dvs-switches:
58965         type: object
58966         $ref: "#/patchDefinitions/dvs-switches"
58967       availability-zone:
58968         type: object
58969         $ref: "#/patchDefinitions/availability-zone"
58970   business:
58971     description: |
58972       Namespace for business related constructs
58973     properties:
58974       connectors:
58975         type: array
58976         items:
58977           $ref: "#/patchDefinitions/connector"
58978       customers:
58979         type: array
58980         items:
58981           $ref: "#/patchDefinitions/customer"
58982       lines-of-business:
58983         type: array
58984         items:
58985           $ref: "#/patchDefinitions/line-of-business"
58986       owning-entities:
58987         type: array
58988         items:
58989           $ref: "#/patchDefinitions/owning-entity"
58990       platforms:
58991         type: array
58992         items:
58993           $ref: "#/patchDefinitions/platform"
58994       projects:
58995         type: array
58996         items:
58997           $ref: "#/patchDefinitions/project"
58998   class-of-service:
58999     description: |
59000       ###### Related Nodes
59001       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
59002     required:
59003     - cos
59004     properties:
59005       cos:
59006         type: string
59007         description: unique identifier of probe
59008       probe-id:
59009         type: string
59010         description: identifier of probe
59011       probe-type:
59012         type: string
59013         description: type of probe
59014   classes-of-service:
59015     description: |
59016       class-of-service of probe
59017     properties:
59018       class-of-service:
59019         type: array
59020         items:
59021           $ref: "#/patchDefinitions/class-of-service"
59022   cloud-infrastructure:
59023     description: |
59024       Namespace for cloud infrastructure.
59025     properties:
59026       complexes:
59027         type: array
59028         items:
59029           $ref: "#/patchDefinitions/complex"
59030       cloud-regions:
59031         type: array
59032         items:
59033           $ref: "#/patchDefinitions/cloud-region"
59034       network-profiles:
59035         type: array
59036         items:
59037           $ref: "#/patchDefinitions/network-profile"
59038       pservers:
59039         type: array
59040         items:
59041           $ref: "#/patchDefinitions/pserver"
59042       virtual-data-centers:
59043         type: array
59044         items:
59045           $ref: "#/patchDefinitions/virtual-data-center"
59046       operational-environments:
59047         type: array
59048         items:
59049           $ref: "#/patchDefinitions/operational-environment"
59050   cloud-region:
59051     description: |
59052       cloud-region designates an installation of a cloud cluster or region or instantiation.
59053       ###### Related Nodes
59054       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
59055       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59056       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59057       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59058       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59059       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59060       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59061       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59062       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59063       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59064       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59065       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59066       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59067       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59068       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59069       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
59070       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
59071       - 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
59072       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
59073       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
59074     required:
59075     - cloud-owner
59076     - cloud-region-id
59077     - sriov-automation
59078     properties:
59079       cloud-owner:
59080         type: string
59081         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
59082       cloud-region-id:
59083         type: string
59084         description: Identifier used by the vendor for the region. Second part of composite key
59085       cloud-type:
59086         type: string
59087         description: Type of the cloud (e.g., openstack)
59088       owner-defined-type:
59089         type: string
59090         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
59091       cloud-region-version:
59092         type: string
59093         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
59094       identity-url:
59095         type: string
59096         description: URL of the keystone identity service
59097       cloud-zone:
59098         type: string
59099         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
59100       complex-name:
59101         type: string
59102         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
59103       sriov-automation:
59104         type: boolean
59105       cloud-extra-info:
59106         type: string
59107         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
59108       cloud-epa-caps:
59109         type: string
59110         description: MultiVIM will discover and expose EPA capabilities.
59111   cloud-regions:
59112     properties:
59113       cloud-region:
59114         type: array
59115         items:
59116           $ref: "#/patchDefinitions/cloud-region"
59117   complex:
59118     description: |
59119       Collection of physical locations that can house cloud-regions.
59120       ###### Related Nodes
59121       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59122       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59123       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59124       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
59125       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
59126       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
59127       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59128       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59129       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
59130       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59131       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59132       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59133       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
59134       - COMPLEX is DELETED when these are DELETED CTAG-POOL
59135     required:
59136     - physical-location-id
59137     - physical-location-type
59138     - street1
59139     - city
59140     - postal-code
59141     - country
59142     - region
59143     properties:
59144       physical-location-id:
59145         type: string
59146         description: Unique identifier for physical location, e.g., CLLI
59147       data-center-code:
59148         type: string
59149         description: Data center code which can be an alternate way to identify a complex
59150       complex-name:
59151         type: string
59152         description: Gamma complex name for LCP instance.
59153       identity-url:
59154         type: string
59155         description: URL of the keystone identity service
59156   complexes:
59157     description: |
59158       Collection of physical locations that can house cloud-regions.
59159     properties:
59160       complex:
59161         type: array
59162         items:
59163           $ref: "#/patchDefinitions/complex"
59164   configuration:
59165     description: |
59166       Port Mirror Configuration.
59167       ###### Related Nodes
59168       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
59169       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59170       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
59171       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
59172       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
59173       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
59174       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
59175       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
59176       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
59177       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
59178       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
59179       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
59180       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
59181     required:
59182     - configuration-id
59183     - configuration-type
59184     - configuration-sub-type
59185     - orchestration-status
59186     - operational-status
59187     - configuration-selflink
59188     - model-customization-id
59189     properties:
59190       configuration-id:
59191         type: string
59192         description: UUID assigned to configuration.
59193       management-option:
59194         type: string
59195         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
59196       configuration-name:
59197         type: string
59198         description: Name of the configuration.
59199       configuration-type:
59200         type: string
59201         description: port-mirroring-configuration.
59202       configuration-sub-type:
59203         type: string
59204         description: vprobe, pprobe.
59205       model-invariant-id:
59206         type: string
59207         description: the ASDC model id for this resource or service model.
59208       model-version-id:
59209         type: string
59210         description: the ASDC model version for this resource or service model.
59211       orchestration-status:
59212         type: string
59213         description: Orchestration status of the configuration.
59214       operational-status:
59215         type: string
59216         description: Indicator for whether the resource is considered operational.
59217       configuration-selflink:
59218         type: string
59219         description: URL to endpoint where AAI can get more details from SDN-GC.
59220       model-customization-id:
59221         type: string
59222         description: id of  the configuration used to customize the resource
59223       tunnel-bandwidth:
59224         type: string
59225         description: DHV Site Effective Bandwidth
59226       vendor-allowed-max-bandwidth:
59227         type: string
59228         description: Velocloud Nominal Throughput - VNT
59229   configurations:
59230     description: |
59231       Collection of configurations
59232     properties:
59233       configuration:
59234         type: array
59235         items:
59236           $ref: "#/patchDefinitions/configuration"
59237   connector:
59238     description: |
59239       Collection of resource instances used to connect a variety of disparate inventory widgets
59240       ###### Related Nodes
59241       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59242       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
59243       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
59244       - CONNECTOR is DELETED when these are DELETED METADATUM
59245     required:
59246     - resource-instance-id
59247     properties:
59248       resource-instance-id:
59249         type: string
59250         description: Unique id of resource instance.
59251   connectors:
59252     description: |
59253       Collection of resource instances used to connect a variety of disparate inventory widgets
59254     properties:
59255       connector:
59256         type: array
59257         items:
59258           $ref: "#/patchDefinitions/connector"
59259   constrained-element-set:
59260     description: |
59261       This is how we would capture constraints defining allowed sets of elements.
59262       ###### Related Nodes
59263       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
59264       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59265       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
59266       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
59267     required:
59268     - constrained-element-set-uuid
59269     - constraint-type
59270     - check-type
59271     properties:
59272       constrained-element-set-uuid:
59273         type: string
59274       constraint-type:
59275         type: string
59276       check-type:
59277         type: string
59278   constrained-element-sets:
59279     properties:
59280       constrained-element-set:
59281         type: array
59282         items:
59283           $ref: "#/patchDefinitions/constrained-element-set"
59284   ctag-assignment:
59285     description: |
59286       ###### Related Nodes
59287       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59288       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
59289     required:
59290     - vlan-id-inner
59291     properties:
59292       vlan-id-inner:
59293         type: integer
59294         format: int64
59295         description: id.
59296   ctag-assignments:
59297     properties:
59298       ctag-assignment:
59299         type: array
59300         items:
59301           $ref: "#/patchDefinitions/ctag-assignment"
59302   ctag-pool:
59303     description: |
59304       A collection of C tags (vlan tags) grouped for a specific purpose.
59305       ###### Related Nodes
59306       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
59307       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
59308       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
59309       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
59310     required:
59311     - target-pe
59312     - availability-zone-name
59313     - ctag-pool-purpose
59314     properties:
59315       target-pe:
59316         type: string
59317         description: The Target provider edge router
59318       availability-zone-name:
59319         type: string
59320         description: Name of the availability zone
59321       ctag-pool-purpose:
59322         type: string
59323         description: Describes what the intended purpose of this pool is.
59324       ctag-values:
59325         type: string
59326         description: Comma separated list of ctags
59327   ctag-pools:
59328     properties:
59329       ctag-pool:
59330         type: array
59331         items:
59332           $ref: "#/patchDefinitions/ctag-pool"
59333   customer:
59334     description: |
59335       customer identifiers to provide linkage back to BSS information.
59336       ###### Related Nodes
59337       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
59338       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
59339     required:
59340     - global-customer-id
59341     - subscriber-name
59342     - subscriber-type
59343     properties:
59344       global-customer-id:
59345         type: string
59346         description: Global customer id used across ECOMP to uniquely identify customer.
59347       subscriber-name:
59348         type: string
59349         description: Subscriber name, an alternate way to retrieve a customer.
59350       subscriber-type:
59351         type: string
59352         description: Subscriber type, a way to provide VID with only the INFRA customers.
59353   customers:
59354     description: |
59355       Collection of customer identifiers to provide linkage back to BSS information.
59356     properties:
59357       customer:
59358         type: array
59359         items:
59360           $ref: "#/patchDefinitions/customer"
59361   cvlan-tag-entry:
59362     required:
59363     - cvlan-tag
59364     properties:
59365       cvlan-tag:
59366         type: integer
59367         format: int64
59368         description: See mis-na-virtualization-platform.yang
59369   cvlan-tags:
59370     properties:
59371       cvlan-tag-entry:
59372         type: array
59373         items:
59374           $ref: "#/patchDefinitions/cvlan-tag-entry"
59375   dvs-switch:
59376     description: |
59377       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.
59378       ###### Related Nodes
59379       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59380       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
59381     required:
59382     - switch-name
59383     - vcenter-url
59384     properties:
59385       switch-name:
59386         type: string
59387         description: DVS switch name
59388       vcenter-url:
59389         type: string
59390         description: URL used to reach the vcenter
59391   dvs-switches:
59392     description: |
59393       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
59394     properties:
59395       dvs-switch:
59396         type: array
59397         items:
59398           $ref: "#/patchDefinitions/dvs-switch"
59399   edge-prop-names:
59400     description: |
59401       Internal map to define the properties of an edge and interpret the map EdgeRules
59402     properties:
59403       edgeLabel:
59404         type: string
59405       direction:
59406         type: string
59407       multiplicityRule:
59408         type: string
59409       contains-other-v:
59410         type: string
59411       delete-other-v:
59412         type: string
59413       SVC-INFRA:
59414         type: string
59415       prevent-delete:
59416         type: string
59417       aai-uuid:
59418         type: string
59419   edge-tag-query-request:
59420     properties:
59421       edge-tag:
59422         type: string
59423       result-detail:
59424         type: string
59425       start-node-type:
59426         type: string
59427       start-node-filter:
59428         type: array
59429         items:
59430           $ref: "#/patchDefinitions/start-node-filter"
59431       include-node-filter:
59432         type: array
59433         items:
59434           $ref: "#/patchDefinitions/include-node-filter"
59435       secondary-filter:
59436         type: array
59437         items:
59438           $ref: "#/patchDefinitions/secondary-filter"
59439   edge-tag-query-result:
59440     properties:
59441       tagged-inventory-item-list:
59442         type: array
59443         items:
59444           $ref: "#/patchDefinitions/tagged-inventory-item-list"
59445   element-choice-set:
59446     description: |
59447       This is how we would capture constraints defining allowed sets of elements.
59448       ###### Related Nodes
59449       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
59450       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
59451       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
59452     required:
59453     - element-choice-set-uuid
59454     - element-choice-set-name
59455     properties:
59456       element-choice-set-uuid:
59457         type: string
59458       element-choice-set-name:
59459         type: string
59460       cardinality:
59461         type: string
59462   element-choice-sets:
59463     properties:
59464       element-choice-set:
59465         type: array
59466         items:
59467           $ref: "#/patchDefinitions/element-choice-set"
59468   entitlement:
59469     description: |
59470       Metadata for entitlement group.
59471       ###### Related Nodes
59472       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59473       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59474     required:
59475     - group-uuid
59476     - resource-uuid
59477     properties:
59478       group-uuid:
59479         type: string
59480         description: Unique ID for the entitlement group the resource comes from, should be uuid.
59481       resource-uuid:
59482         type: string
59483         description: Unique ID of an entitlement resource.
59484   entitlements:
59485     description: |
59486       Entitlements, keyed by group-uuid and resource-uuid, related to license management
59487     properties:
59488       entitlement:
59489         type: array
59490         items:
59491           $ref: "#/patchDefinitions/entitlement"
59492   esr-ems:
59493     description: |
59494       Persist EMS address information used by EMS driver.
59495       ###### Related Nodes
59496       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
59497       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
59498     required:
59499     - ems-id
59500     properties:
59501       ems-id:
59502         type: string
59503         description: Unique ID of EMS.
59504   esr-ems-list:
59505     properties:
59506       esr-ems:
59507         type: array
59508         items:
59509           $ref: "#/patchDefinitions/esr-ems"
59510   esr-system-info:
59511     description: |
59512       Persist common address information of external systems.
59513       ###### Related Nodes
59514       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
59515       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
59516       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
59517       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
59518     required:
59519     - esr-system-info-id
59520     - user-name
59521     - password
59522     - system-type
59523     properties:
59524       esr-system-info-id:
59525         type: string
59526         description: Unique ID of esr system info.
59527       system-name:
59528         type: string
59529         description: name of external system.
59530       type:
59531         type: string
59532         description: type of external systems.
59533       vendor:
59534         type: string
59535         description: vendor of external systems.
59536       version:
59537         type: string
59538         description: version of external systems.
59539       service-url:
59540         type: string
59541         description: url used to access external systems.
59542       user-name:
59543         type: string
59544         description: username used to access external systems.
59545       password:
59546         type: string
59547         description: password used to access external systems.
59548       system-type:
59549         type: string
59550         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
59551       protocol:
59552         type: string
59553         description: protocol of third party SDNC, for example netconf/snmp.
59554       ssl-cacert:
59555         type: string
59556         description: ca file content if enabled ssl on auth-url.
59557       ssl-insecure:
59558         type: boolean
59559         description: Whether to verify VIM's certificate.
59560       ip-address:
59561         type: string
59562         description: service IP of ftp server.
59563       port:
59564         type: string
59565         description: service port of ftp server.
59566       cloud-domain:
59567         type: string
59568         description: domain info for authentication.
59569       default-tenant:
59570         type: string
59571         description: default tenant of VIM.
59572       passive:
59573         type: boolean
59574         description: ftp passive mode or not.
59575       remote-path:
59576         type: string
59577         description: resource or performance data file path.
59578       system-status:
59579         type: string
59580         description: the status of external system.
59581   esr-system-info-list:
59582     description: |
59583       Collection of persistent block-level external system auth info.
59584     properties:
59585       esr-system-info:
59586         type: array
59587         items:
59588           $ref: "#/patchDefinitions/esr-system-info"
59589   esr-thirdparty-sdnc:
59590     description: |
59591       Persist SDNC address information used by ONAP SDNC.
59592       ###### Related Nodes
59593       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
59594       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
59595       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
59596     required:
59597     - thirdparty-sdnc-id
59598     properties:
59599       thirdparty-sdnc-id:
59600         type: string
59601         description: Unique ID of SDNC.
59602       location:
59603         type: string
59604         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
59605       product-name:
59606         type: string
59607         description: password used to access SDNC server.
59608   esr-thirdparty-sdnc-list:
59609     properties:
59610       esr-thirdparty-sdnc:
59611         type: array
59612         items:
59613           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
59614   esr-vnfm:
59615     description: |
59616       Persist VNFM address information used by VF-C.
59617       ###### Related Nodes
59618       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
59619       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
59620     required:
59621     - vnfm-id
59622     properties:
59623       vnfm-id:
59624         type: string
59625         description: Unique ID of VNFM.
59626       vim-id:
59627         type: string
59628         description: indecate the VIM to deploy VNF.
59629       certificate-url:
59630         type: string
59631         description: certificate url of VNFM.
59632   esr-vnfm-list:
59633     properties:
59634       esr-vnfm:
59635         type: array
59636         items:
59637           $ref: "#/patchDefinitions/esr-vnfm"
59638   evc:
59639     description: |
59640       evc object is an optional child object of the Configuration object.
59641       ###### Related Nodes
59642       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
59643     required:
59644     - evc-id
59645     properties:
59646       evc-id:
59647         type: string
59648         description: Unique/key field for the evc object
59649       forwarding-path-topology:
59650         type: string
59651         description: Point-to-Point, Multi-Point
59652       cir-value:
59653         type: string
59654         description: Commited Information Rate
59655       cir-units:
59656         type: string
59657         description: CIR units
59658       connection-diversity-group-id:
59659         type: string
59660         description: Diversity Group ID
59661       service-hours:
59662         type: string
59663         description: formerly Performance Group
59664       esp-evc-circuit-id:
59665         type: string
59666         description: EVC Circuit ID of ESP EVC
59667       esp-evc-cir-value:
59668         type: string
59669         description: Committed Information Rate (For ESP)
59670       esp-evc-cir-units:
59671         type: string
59672         description: CIR units (For ESP)
59673       esp-itu-code:
59674         type: string
59675         description: Identifies ESP
59676       collector-pop-clli:
59677         type: string
59678         description: Collector POP CLLI (from the hostname of the access pnf)
59679       inter-connect-type-ingress:
59680         type: string
59681         description: Interconnect type on ingress side of EVC.
59682       tagmode-access-ingress:
59683         type: string
59684         description: tagode for collector side of EVC
59685       tagmode-access-egress:
59686         type: string
59687         description: tagMode for network side of EVC
59688   evcs:
59689     properties:
59690       evc:
59691         type: array
59692         items:
59693           $ref: "#/patchDefinitions/evc"
59694   external-system:
59695     description: |
59696       Namespace for external system.
59697     properties:
59698       esr-ems-list:
59699         type: object
59700         $ref: "#/patchDefinitions/esr-ems-list"
59701       esr-vnfm-list:
59702         type: object
59703         $ref: "#/patchDefinitions/esr-vnfm-list"
59704       esr-thirdparty-sdnc-list:
59705         type: object
59706         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
59707   extra-properties:
59708     description: |
59709       Extra properties for inventory item for response list
59710     properties:
59711       extra-property:
59712         type: array
59713         items:
59714           $ref: "#/patchDefinitions/extra-property"
59715   extra-property:
59716     properties:
59717       property-name:
59718         type: string
59719       property-value:
59720         type: string
59721   flavor:
59722     description: |
59723       Openstack flavor.
59724       ###### Related Nodes
59725       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59726       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
59727       - FLAVOR cannot be deleted if linked to VSERVER
59728     required:
59729     - flavor-id
59730     - flavor-name
59731     - flavor-selflink
59732     properties:
59733       flavor-id:
59734         type: string
59735         description: Flavor id, expected to be unique across cloud-region.
59736       flavor-name:
59737         type: string
59738         description: Flavor name
59739       flavor-vcpus:
59740         type: integer
59741         format: int32
59742         description: Number of CPUs
59743       flavor-ram:
59744         type: integer
59745         format: int32
59746         description: Amount of memory
59747       flavor-disk:
59748         type: integer
59749         format: int32
59750         description: Disk space
59751       flavor-ephemeral:
59752         type: integer
59753         format: int32
59754         description: Amount of ephemeral disk space
59755       flavor-swap:
59756         type: string
59757         description: amount of swap space allocation
59758       flavor-is-public:
59759         type: boolean
59760         description: whether flavor is available to all users or private to the tenant it was created in.
59761       flavor-selflink:
59762         type: string
59763         description: URL to endpoint where AAI can get more details
59764       flavor-disabled:
59765         type: boolean
59766         description: Boolean as to whether this flavor is no longer enabled
59767   flavors:
59768     description: |
59769       Collection of openstack flavors.
59770     properties:
59771       flavor:
59772         type: array
59773         items:
59774           $ref: "#/patchDefinitions/flavor"
59775   forwarder:
59776     description: |
59777       Entity describing a sequenced segment of forwarding path
59778       ###### Related Nodes
59779       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
59780       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
59781       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
59782       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
59783       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
59784       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
59785     required:
59786     - sequence
59787     properties:
59788       sequence:
59789         type: integer
59790         format: int32
59791         description: Unique ID of this segmentation
59792       forwarder-role:
59793         type: string
59794         description: ingress, intermediate, egress
59795   forwarder-evc:
59796     description: |
59797       forwarder object is an optional child object of the Configuration object.
59798       ###### Related Nodes
59799       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
59800     required:
59801     - forwarder-evc-id
59802     properties:
59803       forwarder-evc-id:
59804         type: string
59805         description: Key for forwarder-evc object
59806       circuit-id:
59807         type: string
59808         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
59809       ivlan:
59810         type: string
59811         description: Internal VLAN.
59812       svlan:
59813         type: string
59814         description: SVLAN value for ingress of egress forwarder.
59815       cvlan:
59816         type: string
59817         description: CVLAN value for ingress of egress forwarder.
59818   forwarder-evcs:
59819     properties:
59820       forwarder-evc:
59821         type: array
59822         items:
59823           $ref: "#/patchDefinitions/forwarder-evc"
59824   forwarders:
59825     properties:
59826       forwarder:
59827         type: array
59828         items:
59829           $ref: "#/patchDefinitions/forwarder"
59830   forwarding-path:
59831     description: |
59832       Entity that describes the sequenced forwarding path between interfaces of services or resources
59833       ###### Related Nodes
59834       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
59835       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
59836       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
59837       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
59838       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
59839     required:
59840     - forwarding-path-id
59841     - forwarding-path-name
59842     properties:
59843       forwarding-path-id:
59844         type: string
59845         description: Unique ID of this FP
59846       forwarding-path-name:
59847         type: string
59848         description: Name of the FP
59849   forwarding-paths:
59850     properties:
59851       forwarding-path:
59852         type: array
59853         items:
59854           $ref: "#/patchDefinitions/forwarding-path"
59855   generic-vnf:
59856     description: |
59857       General purpose VNF
59858       ###### Related Nodes
59859       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59860       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
59861       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
59862       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
59863       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59864       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59865       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59866       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
59867       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
59868       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
59869       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
59870       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59871       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
59872       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59873       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
59874       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
59875       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59876       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59877       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59878       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59879       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59880       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59881       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
59882       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59883       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59884       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59885       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59886       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59887       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
59888       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
59889     required:
59890     - vnf-id
59891     - vnf-instance-id
59892     - vnf-name
59893     - vnf-type
59894     - vnf-package-name
59895     - vnf-discriptor-name
59896     - job-id
59897     - in-maint
59898     - is-closed-loop-disabled
59899     properties:
59900       vnf-id:
59901         type: string
59902         description: Unique id of VNF.  This is unique across the graph.
59903       vnf-instance-id:
59904         type: string
59905         description: vnf instance id.
59906       vnf-name:
59907         type: string
59908         description: Name of VNF.
59909       vnf-name2:
59910         type: string
59911         description: Alternate name of VNF.
59912       vnf-type:
59913         type: string
59914         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.
59915       service-id:
59916         type: string
59917         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
59918       regional-resource-zone:
59919         type: string
59920         description: Regional way of organizing pservers, source of truth should define values
59921       prov-status:
59922         type: string
59923         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59924       operational-status:
59925         type: string
59926         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
59927       license-key:
59928         type: string
59929         description: OBSOLETE -  do not use
59930       equipment-role:
59931         type: string
59932         description: Client should send valid enumerated value
59933       orchestration-status:
59934         type: string
59935         description: Orchestration status of this VNF, used by MSO.
59936       vnf-package-name:
59937         type: string
59938       vnf-discriptor-name:
59939         type: string
59940         description: vnf discriptor name
59941       job-id:
59942         type: string
59943         description: job id corresponding to vnf
59944       heat-stack-id:
59945         type: string
59946         description: Heat stack id corresponding to this instance, managed by MSO
59947       mso-catalog-key:
59948         type: string
59949         description: Corresponds to the SDN-C catalog id used to configure this VCE
59950       management-option:
59951         type: string
59952         description: identifier of managed by ATT or customer
59953       ipv4-oam-address:
59954         type: string
59955         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
59956       ipv4-loopback0-address:
59957         type: string
59958         description: v4 Loopback0 address
59959       nm-lan-v6-address:
59960         type: string
59961         description: v6 Loopback address
59962       management-v6-address:
59963         type: string
59964         description: v6 management address
59965       vcpu:
59966         type: integer
59967         format: int64
59968         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
59969       vcpu-units:
59970         type: string
59971         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
59972       vmemory:
59973         type: integer
59974         format: int64
59975         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
59976       vmemory-units:
59977         type: string
59978         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
59979       vdisk:
59980         type: integer
59981         format: int64
59982         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
59983       vdisk-units:
59984         type: string
59985         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
59986       nshd:
59987         type: integer
59988         format: int64
59989         description: number of associated SHD in vnf.
59990       nvm:
59991         type: integer
59992         format: int64
59993         description: number of vms in vnf.
59994       nnet:
59995         type: integer
59996         format: int64
59997         description: number of network in vnf.
59998       in-maint:
59999         type: boolean
60000       is-closed-loop-disabled:
60001         type: boolean
60002   generic-vnfs:
60003     description: |
60004       Collection of VNFs
60005     properties:
60006       generic-vnf:
60007         type: array
60008         items:
60009           $ref: "#/patchDefinitions/generic-vnf"
60010   group-assignment:
60011     description: |
60012       Openstack group-assignment used to store exclusivity groups (EG).
60013       ###### Related Nodes
60014       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60015       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
60016       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
60017     required:
60018     - group-id
60019     - group-type
60020     - group-name
60021     properties:
60022       group-id:
60023         type: string
60024         description: Group id, expected to be unique across cloud-region.
60025       group-type:
60026         type: string
60027         description: Group type - the type of group this instance refers to
60028       group-name:
60029         type: string
60030         description: Group name - name assigned to the group
60031       group-description:
60032         type: string
60033         description: Group description - description of the group
60034   group-assignments:
60035     description: |
60036       Collection of openstack group assignments
60037     properties:
60038       group-assignment:
60039         type: array
60040         items:
60041           $ref: "#/patchDefinitions/group-assignment"
60042   host-route:
60043     description: |
60044       ###### Related Nodes
60045       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
60046     required:
60047     - host-route-id
60048     - route-prefix
60049     - next-hop
60050     properties:
60051       host-route-id:
60052         type: string
60053         description: host-route id
60054       route-prefix:
60055         type: string
60056         description: subnet prefix
60057       next-hop:
60058         type: string
60059         description: Could be ip-address, hostname, or service-instance
60060       next-hop-type:
60061         type: string
60062         description: Should be ip-address, hostname, or service-instance to match next-hop
60063   host-routes:
60064     properties:
60065       host-route:
60066         type: array
60067         items:
60068           $ref: "#/patchDefinitions/host-route"
60069   image:
60070     description: |
60071       Openstack image.
60072       ###### Related Nodes
60073       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60074       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
60075       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
60076       - IMAGE cannot be deleted if linked to VSERVER
60077       - IMAGE is DELETED when these are DELETED METADATUM
60078     required:
60079     - image-id
60080     - image-name
60081     - image-os-distro
60082     - image-os-version
60083     - image-selflink
60084     properties:
60085       image-id:
60086         type: string
60087         description: Image id, expected to be unique across cloud region
60088       image-name:
60089         type: string
60090         description: Image name
60091       image-architecture:
60092         type: string
60093         description: Operating system architecture.
60094       image-os-distro:
60095         type: string
60096         description: The common name of the operating system distribution in lowercase
60097       image-os-version:
60098         type: string
60099         description: The operating system version as specified by the distributor.
60100       application:
60101         type: string
60102         description: The application that the image instantiates.
60103       application-vendor:
60104         type: string
60105         description: The vendor of the application.
60106       application-version:
60107         type: string
60108         description: The version of the application.
60109       image-selflink:
60110         type: string
60111         description: URL to endpoint where AAI can get more details
60112   images:
60113     description: |
60114       Collectio of Openstack images.
60115     properties:
60116       image:
60117         type: array
60118         items:
60119           $ref: "#/patchDefinitions/image"
60120   include-node-filter:
60121     properties:
60122       include-node-type:
60123         type: string
60124   instance-filter:
60125     description: |
60126       InstanceFilter for performing a named-query or model query
60127   instance-filters:
60128     description: |
60129       InstanceFilters for performing a named-query or model query
60130     properties:
60131       instance-filter:
60132         type: array
60133         items:
60134           $ref: "#/patchDefinitions/instance-filter"
60135   instance-group:
60136     description: |
60137       General mechanism for grouping instances
60138       ###### Related Nodes
60139       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
60140       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60141       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60142       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
60143       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
60144       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60145       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60146       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60147       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60148       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60149       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60150       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60151     required:
60152     - instance-group-role
60153     - model-invariant-id
60154     - model-version-id
60155     - id
60156     - description
60157     - type
60158     properties:
60159       instance-group-role:
60160         type: string
60161         description: role of the instance group.
60162       model-invariant-id:
60163         type: string
60164         description: ASDC model id for this resource or service model.
60165       model-version-id:
60166         type: string
60167         description: ASDC model version uid for this resource model.
60168       id:
60169         type: string
60170         description: Instance Group ID, UUID assigned to this instance.
60171       description:
60172         type: string
60173         description: Descriptive text to help identify the usage of this instance-group
60174       type:
60175         type: string
60176         description: Only valid value today is lower case ha for high availability
60177       sub-type:
60178         type: string
60179         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
60180   instance-groups:
60181     description: |
60182       Collection of openstack route table references
60183     properties:
60184       instance-group:
60185         type: array
60186         items:
60187           $ref: "#/patchDefinitions/instance-group"
60188   inventory:
60189     properties:
60190       search:
60191         type: object
60192         $ref: "#/patchDefinitions/search"
60193       actions:
60194         type: object
60195         $ref: "#/patchDefinitions/actions"
60196       cloud-infrastructure:
60197         type: object
60198         $ref: "#/patchDefinitions/cloud-infrastructure"
60199       external-system:
60200         type: object
60201         $ref: "#/patchDefinitions/external-system"
60202       business:
60203         type: object
60204         $ref: "#/patchDefinitions/business"
60205       service-design-and-creation:
60206         type: object
60207         $ref: "#/patchDefinitions/service-design-and-creation"
60208       network:
60209         type: object
60210         $ref: "#/patchDefinitions/network"
60211       aai-internal:
60212         type: object
60213         $ref: "#/patchDefinitions/aai-internal"
60214       nodes:
60215         type: array
60216         items:
60217           $ref: "#/patchDefinitions/aai-internal"
60218   inventory-item:
60219     properties:
60220       inventory-item-type:
60221         type: string
60222       inventory-item-link:
60223         type: string
60224       inventory-item-data:
60225         type: array
60226         items:
60227           $ref: "#/patchDefinitions/inventory-item-data"
60228       tagged-inventory-item-list:
60229         type: array
60230         items:
60231           $ref: "#/patchDefinitions/tagged-inventory-item-list"
60232   inventory-item-data:
60233     properties:
60234       property-name:
60235         type: string
60236       property-value:
60237         type: string
60238   inventory-response-item:
60239     description: |
60240       Inventory item for response list
60241     properties:
60242       model-name:
60243         type: string
60244       extra-properties:
60245         type: object
60246         $ref: "#/patchDefinitions/extra-properties"
60247       inventory-response-items:
60248         type: object
60249         $ref: "#/patchDefinitions/inventory-response-items"
60250   inventory-response-items:
60251     description: |
60252       Container for inventory items in response list
60253     properties:
60254       inventory-response-item:
60255         type: array
60256         items:
60257           $ref: "#/patchDefinitions/inventory-response-item"
60258   ipsec-configuration:
60259     description: |
60260       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
60261       ###### Related Nodes
60262       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
60263       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
60264       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
60265     required:
60266     - ipsec-configuration-id
60267     properties:
60268       ipsec-configuration-id:
60269         type: string
60270         description: UUID of this configuration
60271       requested-vig-address-type:
60272         type: string
60273         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
60274       requested-encryption-strength:
60275         type: string
60276         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
60277       requested-dmz-type:
60278         type: string
60279         description: ATT can offer a shared DMZ or a DMZ specific to a customer
60280       shared-dmz-network-address:
60281         type: string
60282         description: Network address of shared DMZ
60283       requested-customer-name:
60284         type: string
60285         description: If the DMZ is a custom DMZ, this field will indicate the customer information
60286       ike-version:
60287         type: string
60288         description: can be 1 or 2
60289       ikev1-authentication:
60290         type: string
60291         description: Contains values like md5, sha1, sha256, sha384
60292       ikev1-encryption:
60293         type: string
60294         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
60295       ikev1-dh-group:
60296         type: string
60297         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
60298       ikev1-am-group-id:
60299         type: string
60300         description: Group name defined in VIG for clients using aggressive mode
60301       ikev1-am-password:
60302         type: string
60303         description: pre-shared key for the above group name
60304       ikev1-sa-lifetime:
60305         type: string
60306         description: Lifetime for IKEv1 SA
60307       ipsec-authentication:
60308         type: string
60309         description: md5, sha1, sha256, sha384
60310       ipsec-encryption:
60311         type: string
60312         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
60313       ipsec-sa-lifetime:
60314         type: string
60315         description: Life time for IPSec SA
60316       ipsec-pfs:
60317         type: string
60318         description: enable PFS or not
60319       xauth-userid:
60320         type: string
60321         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
60322       xauth-user-password:
60323         type: string
60324         description: Encrypted using the Juniper $9$ algorithm
60325       dpd-interval:
60326         type: string
60327         description: The time between DPD probe
60328       dpd-frequency:
60329         type: string
60330         description: Maximum number of DPD before claiming the tunnel is down
60331   ipsec-configurations:
60332     properties:
60333       ipsec-configuration:
60334         type: array
60335         items:
60336           $ref: "#/patchDefinitions/ipsec-configuration"
60337   key-data:
60338     properties:
60339       key-name:
60340         type: string
60341       key-value:
60342         type: string
60343   l-interface:
60344     description: |
60345       Logical interfaces, e.g., a vnic.
60346       ###### Related Nodes
60347       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60348       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
60349       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60350       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60351       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
60352       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
60353       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
60354       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
60355       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
60356       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60357       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60358       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
60359       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
60360       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
60361       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
60362       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
60363       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
60364       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60365       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
60366       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
60367     required:
60368     - interface-name
60369     - is-port-mirrored
60370     - in-maint
60371     - is-ip-unnumbered
60372     properties:
60373       interface-name:
60374         type: string
60375         description: Name given to the interface
60376       interface-role:
60377         type: string
60378         description: E.g., CUSTOMER, UPLINK, etc.
60379       v6-wan-link-ip:
60380         type: string
60381         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
60382       selflink:
60383         type: string
60384         description: URL to endpoint where AAI can get more details
60385       interface-id:
60386         type: string
60387         description: ID of interface
60388       macaddr:
60389         type: string
60390         description: MAC address for the interface
60391       network-name:
60392         type: string
60393         description: Name of the network
60394       management-option:
60395         type: string
60396         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
60397       interface-description:
60398         type: string
60399         description: Human friendly text regarding this interface.
60400       is-port-mirrored:
60401         type: boolean
60402   l-interfaces:
60403     description: |
60404       Collection of logical interfaces.
60405     properties:
60406       l-interface:
60407         type: array
60408         items:
60409           $ref: "#/patchDefinitions/l-interface"
60410   l3-interface-ipv4-address-list:
60411     description: |
60412       IPv4 Address Range
60413       ###### Related Nodes
60414       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
60415       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
60416       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
60417       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60418       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
60419       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
60420     required:
60421     - l3-interface-ipv4-address
60422     properties:
60423       l3-interface-ipv4-address:
60424         type: string
60425         description: IP address
60426       l3-interface-ipv4-prefix-length:
60427         type: integer
60428         format: int64
60429         description: Prefix length, 32 for single address
60430       vlan-id-inner:
60431         type: integer
60432         format: int64
60433         description: Inner VLAN tag
60434       vlan-id-outer:
60435         type: integer
60436         format: int64
60437         description: Outer VLAN tag
60438       is-floating:
60439         type: boolean
60440         description: Indicator of fixed or floating address
60441   l3-interface-ipv6-address-list:
60442     description: |
60443       IPv6 Address Range
60444       ###### Related Nodes
60445       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
60446       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
60447       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
60448       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
60449       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
60450       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
60451     required:
60452     - l3-interface-ipv6-address
60453     properties:
60454       l3-interface-ipv6-address:
60455         type: string
60456         description: IP address
60457       l3-interface-ipv6-prefix-length:
60458         type: integer
60459         format: int64
60460         description: Prefix length, 128 for single address
60461       vlan-id-inner:
60462         type: integer
60463         format: int64
60464         description: Inner VLAN tag
60465       vlan-id-outer:
60466         type: integer
60467         format: int64
60468         description: Outer VLAN tag
60469       is-floating:
60470         type: boolean
60471         description: Indicator of fixed or floating address
60472   l3-network:
60473     description: |
60474       Generic network definition
60475       ###### Related Nodes
60476       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60477       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
60478       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
60479       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
60480       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
60481       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
60482       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60483       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60484       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60485       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
60486       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
60487       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60488       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60489       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
60490       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60491       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60492       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
60493       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
60494     required:
60495     - network-id
60496     - network-name
60497     - is-bound-to-vpn
60498     - is-provider-network
60499     - is-shared-network
60500     - is-external-network
60501     properties:
60502       network-id:
60503         type: string
60504         description: Network ID, should be uuid. Unique across A&AI.
60505       network-name:
60506         type: string
60507         description: Name of the network, governed by some naming convention..
60508       network-type:
60509         type: string
60510         description: Type of the network - who defines these values?
60511       network-role:
60512         type: string
60513         description: Role the network plans - who defines these values?
60514       network-technology:
60515         type: string
60516         description: Network technology - who defines these values?
60517       neutron-network-id:
60518         type: string
60519         description: Neutron network id of this Interface
60520       is-bound-to-vpn:
60521         type: boolean
60522       service-id:
60523         type: string
60524         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
60525       network-role-instance:
60526         type: integer
60527         format: int64
60528         description: network role instance
60529   l3-networks:
60530     properties:
60531       l3-network:
60532         type: array
60533         items:
60534           $ref: "#/patchDefinitions/l3-network"
60535   lag-interface:
60536     description: |
60537       Link aggregate interface
60538       ###### Related Nodes
60539       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60540       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
60541       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60542       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
60543       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60544       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60545       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60546       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
60547       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
60548       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
60549       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
60550     required:
60551     - interface-name
60552     - in-maint
60553     properties:
60554       interface-name:
60555         type: string
60556         description: Name that identifies the link aggregate interface
60557       interface-description:
60558         type: string
60559         description: Human friendly text regarding this interface.
60560   lag-interfaces:
60561     description: |
60562       Collection of link aggregate interfaces.
60563     properties:
60564       lag-interface:
60565         type: array
60566         items:
60567           $ref: "#/patchDefinitions/lag-interface"
60568   lag-link:
60569     description: |
60570       LAG links can connect lag-interfaces
60571       ###### Related Nodes
60572       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
60573       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
60574     required:
60575     - link-name
60576     properties:
60577       link-name:
60578         type: string
60579         description: Alphabetical concatenation of lag-interface names
60580   lag-links:
60581     description: |
60582       Collection of link aggregation connections
60583     properties:
60584       lag-link:
60585         type: array
60586         items:
60587           $ref: "#/patchDefinitions/lag-link"
60588   license:
60589     description: |
60590       Metadata for license group.
60591       ###### Related Nodes
60592       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60593       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60594     required:
60595     - group-uuid
60596     - resource-uuid
60597     properties:
60598       group-uuid:
60599         type: string
60600         description: Unique ID for the license group the resource belongs to, should be uuid.
60601       resource-uuid:
60602         type: string
60603         description: Unique ID of a license resource.
60604   licenses:
60605     description: |
60606       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
60607     properties:
60608       license:
60609         type: array
60610         items:
60611           $ref: "#/patchDefinitions/license"
60612   line-of-business:
60613     description: |
60614       describes a line-of-business
60615       ###### Related Nodes
60616       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60617     required:
60618     - line-of-business-name
60619     properties:
60620       line-of-business-name:
60621         type: string
60622         description: Name of the line-of-business (product)
60623   lines-of-business:
60624     description: |
60625       Collection of lines-of-business
60626     properties:
60627       line-of-business:
60628         type: array
60629         items:
60630           $ref: "#/patchDefinitions/line-of-business"
60631   logical-link:
60632     description: |
60633       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
60634       ###### Related Nodes
60635       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
60636       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
60637       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
60638       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
60639       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
60640       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60641       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60642       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60643       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
60644       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
60645       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
60646       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60647       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60648       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
60649       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60650       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60651       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60652       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60653     required:
60654     - link-name
60655     - in-maint
60656     - link-type
60657     properties:
60658       link-name:
60659         type: string
60660         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
60661       in-maint:
60662         type: boolean
60663       link-type:
60664         type: string
60665         description: Type of logical link, e.g., evc
60666       speed-value:
60667         type: string
60668         description: Captures the numeric part of the speed
60669       speed-units:
60670         type: string
60671         description: Captures the units corresponding to the speed
60672       ip-version:
60673         type: string
60674         description: v4, v6, or ds for dual stack
60675       routing-protocol:
60676         type: string
60677         description: For example, static or BGP
60678   logical-links:
60679     description: |
60680       Collection of logical connections
60681     properties:
60682       logical-link:
60683         type: array
60684         items:
60685           $ref: "#/patchDefinitions/logical-link"
60686   metadata:
60687     description: |
60688       Collection of metadatum (key/value pairs)
60689     properties:
60690       metadatum:
60691         type: array
60692         items:
60693           $ref: "#/patchDefinitions/metadatum"
60694   metadatum:
60695     description: |
60696       Key/value pairs
60697       ###### Related Nodes
60698       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
60699       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
60700       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
60701       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60702       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60703     required:
60704     - metaname
60705     - metaval
60706     properties:
60707       metaname:
60708         type: string
60709       metaval:
60710         type: string
60711   model:
60712     description: |
60713       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
60714       ###### Related Nodes
60715       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60716       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
60717       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60718       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60719       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60720       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
60721       - MODEL is DELETED when these are DELETED MODEL-VER
60722     required:
60723     - model-invariant-id
60724     - model-type
60725     properties:
60726       model-invariant-id:
60727         type: string
60728         description: Unique identifier corresponding to the main definition of a model in ASDC
60729       model-type:
60730         type: string
60731         description: Type of the model, e.g., service, resource, widget, etc.
60732   model-and-named-query-search:
60733     description: |
60734       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
60735     properties:
60736       query-parameters:
60737         type: object
60738         $ref: "#/patchDefinitions/query-parameters"
60739       instance-filters:
60740         type: object
60741         $ref: "#/patchDefinitions/instance-filters"
60742       secondary-filts:
60743         type: object
60744         $ref: "#/patchDefinitions/secondary-filts"
60745       top-node-type:
60746         type: string
60747       secondary-filter-cut-point:
60748         type: string
60749   model-constraint:
60750     description: |
60751       This is how we would capture constraints defining allowed sets of elements.
60752       ###### Related Nodes
60753       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60754       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
60755       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
60756     required:
60757     - model-constraint-uuid
60758     - constrained-element-set-uuid-to-replace
60759     properties:
60760       model-constraint-uuid:
60761         type: string
60762       constrained-element-set-uuid-to-replace:
60763         type: string
60764       constrained-element-sets:
60765         type: array
60766         items:
60767           $ref: "#/patchDefinitions/constrained-element-set"
60768   model-constraints:
60769     properties:
60770       model-constraint:
60771         type: array
60772         items:
60773           $ref: "#/patchDefinitions/model-constraint"
60774   model-element:
60775     description: |
60776       Defines how other models combine to make up a higher-level model.
60777       ###### Related Nodes
60778       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
60779       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60780       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60781       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60782       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60783       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60784       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60785       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
60786     required:
60787     - model-element-uuid
60788     - new-data-del-flag
60789     - cardinality
60790     properties:
60791       model-element-uuid:
60792         type: string
60793       new-data-del-flag:
60794         type: string
60795         description: Indicates whether this element was created as part of instantiation from this model
60796       cardinality:
60797         type: string
60798         description: How many of this type of element are required/allowed
60799       linkage-points:
60800         type: string
60801   model-elements:
60802     properties:
60803       model-element:
60804         type: array
60805         items:
60806           $ref: "#/patchDefinitions/model-element"
60807   model-ver:
60808     description: |
60809       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
60810       ###### Related Nodes
60811       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60812       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60813       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60814       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60815       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
60816       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
60817       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
60818       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
60819       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
60820       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
60821       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
60822       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
60823     required:
60824     - model-version-id
60825     - model-name
60826     - model-version
60827     properties:
60828       model-version-id:
60829         type: string
60830         description: Unique identifier corresponding to one version of a model in ASDC
60831       model-name:
60832         type: string
60833         description: Name of the model, which can change from version to version.
60834       model-version:
60835         type: string
60836         description: Version
60837       distribution-status:
60838         type: string
60839         description: Distribution Status
60840       model-description:
60841         type: string
60842         description: Description
60843   model-vers:
60844     properties:
60845       model-ver:
60846         type: array
60847         items:
60848           $ref: "#/patchDefinitions/model-ver"
60849   models:
60850     description: |
60851       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
60852     properties:
60853       model:
60854         type: array
60855         items:
60856           $ref: "#/patchDefinitions/model"
60857   multicast-configuration:
60858     description: |
60859       ###### Related Nodes
60860       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
60861     required:
60862     - multicast-configuration-id
60863     - multicast-protocol
60864     - rp-type
60865     properties:
60866       multicast-configuration-id:
60867         type: string
60868         description: Unique id of multicast configuration.
60869       multicast-protocol:
60870         type: string
60871         description: protocol of multicast configuration
60872       rp-type:
60873         type: string
60874         description: rp type of multicast configuration
60875   multicast-configurations:
60876     description: |
60877       multicast configuration of generic-vnf ip-address
60878     properties:
60879       multicast-configuration:
60880         type: array
60881         items:
60882           $ref: "#/patchDefinitions/multicast-configuration"
60883   named-queries:
60884     properties:
60885       named-query:
60886         type: array
60887         items:
60888           $ref: "#/patchDefinitions/named-query"
60889   named-query:
60890     description: |
60891       TBD
60892       ###### Related Nodes
60893       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60894       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60895       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60896       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
60897     required:
60898     - named-query-uuid
60899     - named-query-name
60900     - named-query-version
60901     properties:
60902       named-query-uuid:
60903         type: string
60904       named-query-name:
60905         type: string
60906       named-query-version:
60907         type: string
60908       required-input-param:
60909         type: string
60910       description:
60911         type: string
60912   named-query-element:
60913     description: |
60914       TBD
60915       ###### Related Nodes
60916       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60917       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60918       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60919       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60920       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60921       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60922       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
60923     required:
60924     - named-query-element-uuid
60925     properties:
60926       named-query-element-uuid:
60927         type: string
60928       property-collect-list:
60929         type: string
60930   named-query-elements:
60931     properties:
60932       named-query-element:
60933         type: array
60934         items:
60935           $ref: "#/patchDefinitions/named-query-element"
60936   network:
60937     description: |
60938       Namespace for network inventory resources.
60939     properties:
60940       logical-links:
60941         type: array
60942         items:
60943           $ref: "#/patchDefinitions/logical-link"
60944       site-pair-sets:
60945         type: array
60946         items:
60947           $ref: "#/patchDefinitions/site-pair-set"
60948       vpn-bindings:
60949         type: array
60950         items:
60951           $ref: "#/patchDefinitions/vpn-binding"
60952       vpls-pes:
60953         type: array
60954         items:
60955           $ref: "#/patchDefinitions/vpls-pe"
60956       multicast-configurations:
60957         type: array
60958         items:
60959           $ref: "#/patchDefinitions/multicast-configuration"
60960       vces:
60961         type: array
60962         items:
60963           $ref: "#/patchDefinitions/vce"
60964       vnfcs:
60965         type: array
60966         items:
60967           $ref: "#/patchDefinitions/vnfc"
60968       l3-networks:
60969         type: array
60970         items:
60971           $ref: "#/patchDefinitions/l3-network"
60972       network-policies:
60973         type: array
60974         items:
60975           $ref: "#/patchDefinitions/network-policy"
60976       generic-vnfs:
60977         type: array
60978         items:
60979           $ref: "#/patchDefinitions/generic-vnf"
60980       lag-links:
60981         type: array
60982         items:
60983           $ref: "#/patchDefinitions/lag-link"
60984       newvces:
60985         type: array
60986         items:
60987           $ref: "#/patchDefinitions/newvce"
60988       pnfs:
60989         type: array
60990         items:
60991           $ref: "#/patchDefinitions/pnf"
60992       physical-links:
60993         type: array
60994         items:
60995           $ref: "#/patchDefinitions/physical-link"
60996       ipsec-configurations:
60997         type: array
60998         items:
60999           $ref: "#/patchDefinitions/ipsec-configuration"
61000       route-table-references:
61001         type: array
61002         items:
61003           $ref: "#/patchDefinitions/route-table-reference"
61004       instance-groups:
61005         type: array
61006         items:
61007           $ref: "#/patchDefinitions/instance-group"
61008       zones:
61009         type: array
61010         items:
61011           $ref: "#/patchDefinitions/zone"
61012       configurations:
61013         type: array
61014         items:
61015           $ref: "#/patchDefinitions/configuration"
61016       forwarding-paths:
61017         type: array
61018         items:
61019           $ref: "#/patchDefinitions/forwarding-path"
61020   network-policies:
61021     properties:
61022       network-policy:
61023         type: array
61024         items:
61025           $ref: "#/patchDefinitions/network-policy"
61026   network-policy:
61027     description: |
61028       ###### Related Nodes
61029       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
61030       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
61031     required:
61032     - network-policy-id
61033     properties:
61034       network-policy-id:
61035         type: string
61036         description: UUID representing unique key to this instance
61037       network-policy-fqdn:
61038         type: string
61039         description: Contrail FQDN for the policy
61040       heat-stack-id:
61041         type: string
61042         description: ID for the openStack Heat instance
61043   network-profile:
61044     description: |
61045       Network profile populated by SDN-GP for SNMP
61046       ###### Related Nodes
61047       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61048     required:
61049     - nm-profile-name
61050     properties:
61051       nm-profile-name:
61052         type: string
61053         description: Unique name of network profile.
61054       community-string:
61055         type: string
61056         description: Encrypted SNMP community string
61057   network-profiles:
61058     description: |
61059       Collection of network profiles
61060     properties:
61061       network-profile:
61062         type: array
61063         items:
61064           $ref: "#/patchDefinitions/network-profile"
61065   newvce:
61066     description: |
61067       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
61068       ###### Related Nodes
61069       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
61070       - NEWVCE is DELETED when these are DELETED L-INTERFACE
61071     required:
61072     - vnf-id2
61073     - vnf-name
61074     - vnf-type
61075     properties:
61076       vnf-id2:
61077         type: string
61078         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
61079       vnf-name:
61080         type: string
61081         description: Name of VNF.
61082       vnf-name2:
61083         type: string
61084         description: Alternate name of VNF.
61085       vnf-type:
61086         type: string
61087         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.
61088       prov-status:
61089         type: string
61090         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
61091       operational-status:
61092         type: string
61093         description: Indicator for whether the resource is considered operational
61094       license-key:
61095         type: string
61096         description: OBSOLETE -  do not use
61097       ipv4-oam-address:
61098         type: string
61099         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).
61100       equipment-role:
61101         type: string
61102         description: Client should send valid enumerated value.
61103   newvces:
61104     description: |
61105       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
61106     properties:
61107       newvce:
61108         type: array
61109         items:
61110           $ref: "#/patchDefinitions/newvce"
61111   notification-event:
61112     properties:
61113       cambria.partition:
61114         type: string
61115       notification-event-header:
61116         type: object
61117         $ref: "#/patchDefinitions/notification-event-header"
61118   notification-event-header:
61119     properties:
61120       id:
61121         type: string
61122       timestamp:
61123         type: string
61124       source-name:
61125         type: string
61126       domain:
61127         type: string
61128       sequence-number:
61129         type: string
61130       severity:
61131         type: string
61132       event-type:
61133         type: string
61134       version:
61135         type: string
61136       action:
61137         type: string
61138       entity-type:
61139         type: string
61140       top-entity-type:
61141         type: string
61142       entity-link:
61143         type: string
61144       status:
61145         type: string
61146   notify:
61147     required:
61148     - event-id
61149     properties:
61150       event-id:
61151         type: string
61152       node-type:
61153         type: string
61154       event-trigger:
61155         type: string
61156       key-data:
61157         type: array
61158         items:
61159           $ref: "#/patchDefinitions/key-data"
61160       selflink:
61161         type: string
61162   oam-network:
61163     description: |
61164       OAM network, to be deprecated shortly.  Do not use for new purposes.
61165       ###### Related Nodes
61166       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61167       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
61168       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61169     required:
61170     - network-uuid
61171     - network-name
61172     - cvlan-tag
61173     properties:
61174       network-uuid:
61175         type: string
61176         description: UUID of the network. Unique across a cloud-region
61177       network-name:
61178         type: string
61179         description: Name of the network.
61180       cvlan-tag:
61181         type: integer
61182         format: int64
61183         description: cvlan-id
61184       ipv4-oam-gateway-address:
61185         type: string
61186         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
61187       ipv4-oam-gateway-address-prefix-length:
61188         type: integer
61189         format: int32
61190         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
61191   oam-networks:
61192     description: |
61193       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
61194     properties:
61195       oam-network:
61196         type: array
61197         items:
61198           $ref: "#/patchDefinitions/oam-network"
61199   operational-environment:
61200     description: |
61201       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
61202       ###### Related Nodes
61203       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
61204       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
61205     required:
61206     - operational-environment-id
61207     - operational-environment-name
61208     - operational-environment-type
61209     - operational-environment-status
61210     - tenant-context
61211     - workload-context
61212     properties:
61213       operational-environment-id:
61214         type: string
61215         description: UUID of an operational environment
61216       operational-environment-name:
61217         type: string
61218         description: Operational Environment name
61219       operational-environment-type:
61220         type: string
61221         description: Operational Environment Type.
61222       operational-environment-status:
61223         type: string
61224         description: Status
61225       tenant-context:
61226         type: string
61227         description: Tenant Context.
61228       workload-context:
61229         type: string
61230         description: Workload Context.
61231   operational-environments:
61232     description: |
61233       a logical partition of the cloud which allows to have multiple environments in the production AIC.
61234     properties:
61235       operational-environment:
61236         type: array
61237         items:
61238           $ref: "#/patchDefinitions/operational-environment"
61239   overloaded-model:
61240     description: |
61241       Allows for legacy POST of old-style and new-style models
61242     required:
61243     - model-invariant-id
61244     - model-name-version-id
61245     - model-type
61246     - model-name
61247     - model-id
61248     - model-version
61249     properties:
61250       model-invariant-id:
61251         type: string
61252         description: Unique identifier corresponding to the main definition of a model in ASDC
61253       model-name-version-id:
61254         type: string
61255         description: Unique identifier corresponding to one version of a model in ASDC
61256       model-type:
61257         type: string
61258         description: Type of the model, e.g., service, resource, widget, etc.
61259       model-name:
61260         type: string
61261         description: Name of the model, which can change from version to version.
61262       model-id:
61263         type: string
61264         description: Invariant unique ID which does not change from version to version
61265       model-version:
61266         type: string
61267         description: Version
61268       model-description:
61269         type: string
61270         description: Description
61271   owning-entities:
61272     description: |
61273       Collection of owning-entities
61274     properties:
61275       owning-entity:
61276         type: array
61277         items:
61278           $ref: "#/patchDefinitions/owning-entity"
61279   owning-entity:
61280     description: |
61281       describes an owning-entity
61282       ###### Related Nodes
61283       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
61284     required:
61285     - owning-entity-id
61286     - owning-entity-name
61287     properties:
61288       owning-entity-id:
61289         type: string
61290         description: UUID of an owning entity
61291       owning-entity-name:
61292         type: string
61293         description: Owning entity name
61294   p-interface:
61295     description: |
61296       Physical interface (e.g., nic)
61297       ###### Related Nodes
61298       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
61299       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
61300       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61301       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61302       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61303       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
61304       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
61305       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
61306       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
61307       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
61308       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
61309     required:
61310     - interface-name
61311     - in-maint
61312     properties:
61313       interface-name:
61314         type: string
61315         description: Name that identifies the physical interface
61316       selflink:
61317         type: string
61318         description: URL to endpoint where AAI can get more details.
61319       speed-value:
61320         type: string
61321         description: Captures the numeric part of the speed
61322       speed-units:
61323         type: string
61324         description: Captures the units corresponding to the speed
61325       port-description:
61326         type: string
61327         description: Nature of the services and connectivity on this port.
61328       equipment-identifier:
61329         type: string
61330         description: CLEI or other specification for p-interface hardware.
61331       interface-role:
61332         type: string
61333         description: Role specification for p-interface hardware.
61334       interface-type:
61335         type: string
61336         description: Indicates the physical properties of the interface.
61337       prov-status:
61338         type: string
61339         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61340       mac-addresss:
61341         type: string
61342         description: MAC Address of the p-interface.
61343   p-interfaces:
61344     description: |
61345       Collection of physical interfaces.
61346     properties:
61347       p-interface:
61348         type: array
61349         items:
61350           $ref: "#/patchDefinitions/p-interface"
61351   physical-link:
61352     description: |
61353       Collection of physical connections, typically between p-interfaces
61354       ###### Related Nodes
61355       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
61356     required:
61357     - link-name
61358     properties:
61359       link-name:
61360         type: string
61361         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
61362       speed-value:
61363         type: string
61364         description: Captures the numeric part of the speed
61365       speed-units:
61366         type: string
61367         description: Captures the units corresponding to the speed
61368       circuit-id:
61369         type: string
61370         description: Circuit it
61371       dual-mode:
61372         type: string
61373         description: Dual access mode (e.g., primary, secondary
61374       management-option:
61375         type: string
61376         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
61377       service-provider-name:
61378         type: string
61379         description: Name of the service Provider on this link.
61380       service-provider-bandwidth-up-value:
61381         type: integer
61382         format: int32
61383         description: Upstream Bandwidth value agreed with the service provider
61384       service-provider-bandwidth-up-units:
61385         type: string
61386         description: Units for the upstream BW value
61387       service-provider-bandwidth-down-value:
61388         type: integer
61389         format: int32
61390         description: Downstream Bandwidth value agreed with the service provider
61391       service-provider-bandwidth-down-units:
61392         type: string
61393         description: Units for downstream BW value
61394   physical-links:
61395     description: |
61396       Collection of physical connections, typically between p-interfaces
61397     properties:
61398       physical-link:
61399         type: array
61400         items:
61401           $ref: "#/patchDefinitions/physical-link"
61402   platform:
61403     description: |
61404       describes a platform
61405       ###### Related Nodes
61406       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
61407     required:
61408     - platform-name
61409     properties:
61410       platform-name:
61411         type: string
61412         description: Name of the platform
61413   platforms:
61414     description: |
61415       Collection of platforms
61416     properties:
61417       platform:
61418         type: array
61419         items:
61420           $ref: "#/patchDefinitions/platform"
61421   pnf:
61422     description: |
61423       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.
61424       ###### Related Nodes
61425       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61426       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61427       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61428       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
61429       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
61430       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
61431       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61432       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61433       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61434       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
61435       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61436     required:
61437     - pnf-name
61438     - in-maint
61439     properties:
61440       pnf-name:
61441         type: string
61442         description: unique name of Physical Network Function.
61443       pnf-name2:
61444         type: string
61445         description: name of Physical Network Function.
61446       selflink:
61447         type: string
61448         description: URL to endpoint where AAI can get more details.
61449       pnf-name2-source:
61450         type: string
61451         description: source of name2
61452       pnf-id:
61453         type: string
61454         description: id of pnf
61455       equip-type:
61456         type: string
61457         description: Equipment type.  Source of truth should define valid values.
61458       equip-vendor:
61459         type: string
61460         description: Equipment vendor.  Source of truth should define valid values.
61461       equip-model:
61462         type: string
61463         description: Equipment model.  Source of truth should define valid values.
61464       management-option:
61465         type: string
61466         description: identifier of managed by ATT or customer
61467       ipaddress-v4-oam:
61468         type: string
61469         description: ipv4-oam-address with new naming convention for IP addresses
61470       sw-version:
61471         type: string
61472         description: sw-version is the version of SW for the hosted application on the PNF.
61473       in-maint:
61474         type: boolean
61475       frame-id:
61476         type: string
61477         description: ID of the physical frame (relay rack) where pnf is installed.
61478       serial-number:
61479         type: string
61480         description: Serial number of the device
61481       ipaddress-v4-loopback-0:
61482         type: string
61483         description: IPV4 Loopback 0 address
61484       ipaddress-v6-loopback-0:
61485         type: string
61486         description: IPV6 Loopback 0 address
61487       ipaddress-v4-aim:
61488         type: string
61489         description: IPV4 AIM address
61490       ipaddress-v6-aim:
61491         type: string
61492         description: IPV6 AIM address
61493       ipaddress-v6-oam:
61494         type: string
61495         description: IPV6 OAM address
61496       inv-status:
61497         type: string
61498         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
61499   pnfs:
61500     description: |
61501       Collection of Physical Network Functions.
61502     properties:
61503       pnf:
61504         type: array
61505         items:
61506           $ref: "#/patchDefinitions/pnf"
61507   port-group:
61508     description: |
61509       Used to capture the network interfaces of this VCE
61510       ###### Related Nodes
61511       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61512       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
61513       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
61514     required:
61515     - interface-id
61516     - orchestration-status
61517     properties:
61518       interface-id:
61519         type: string
61520         description: Unique ID of the interface
61521       neutron-network-id:
61522         type: string
61523         description: Neutron network id of this Interface
61524       neutron-network-name:
61525         type: string
61526         description: Neutron network name of this Interface
61527       interface-role:
61528         type: string
61529         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
61530   port-groups:
61531     properties:
61532       port-group:
61533         type: array
61534         items:
61535           $ref: "#/patchDefinitions/port-group"
61536   project:
61537     description: |
61538       describes the project
61539       ###### Related Nodes
61540       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
61541     required:
61542     - project-name
61543     properties:
61544       project-name:
61545         type: string
61546         description: Name of the project deploying a service
61547   projects:
61548     description: |
61549       Collection of projects
61550     properties:
61551       project:
61552         type: array
61553         items:
61554           $ref: "#/patchDefinitions/project"
61555   properties:
61556     description: |
61557       Property holder for query properties or instance properties
61558     properties:
61559       property-name:
61560         type: string
61561       property-value:
61562         type: string
61563   property-constraint:
61564     description: |
61565       TBD
61566       ###### Related Nodes
61567       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61568     required:
61569     - property-constraint-uuid
61570     - constraint-type
61571     - property-name
61572     - property-value
61573     properties:
61574       property-constraint-uuid:
61575         type: string
61576       constraint-type:
61577         type: string
61578       property-name:
61579         type: string
61580       property-value:
61581         type: string
61582   property-constraints:
61583     properties:
61584       property-constraint:
61585         type: array
61586         items:
61587           $ref: "#/patchDefinitions/property-constraint"
61588   pserver:
61589     description: |
61590       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
61591       ###### Related Nodes
61592       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
61593       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
61594       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
61595       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61596       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61597       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
61598       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
61599       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61600       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61601       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61602       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
61603       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61604       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
61605     required:
61606     - hostname
61607     - in-maint
61608     properties:
61609       hostname:
61610         type: string
61611         description: Value from executing hostname on the compute node.
61612       ptnii-equip-name:
61613         type: string
61614         description: PTNII name
61615       number-of-cpus:
61616         type: integer
61617         format: int32
61618         description: Number of cpus
61619       disk-in-gigabytes:
61620         type: integer
61621         format: int32
61622         description: Disk size, in GBs
61623       ram-in-megabytes:
61624         type: integer
61625         format: int32
61626         description: RAM size, in MBs
61627       equip-type:
61628         type: string
61629         description: Equipment type.  Source of truth should define valid values.
61630       equip-vendor:
61631         type: string
61632         description: Equipment vendor.  Source of truth should define valid values.
61633       equip-model:
61634         type: string
61635         description: Equipment model.  Source of truth should define valid values.
61636       fqdn:
61637         type: string
61638         description: Fully-qualified domain name
61639       pserver-selflink:
61640         type: string
61641         description: URL to endpoint where AAI can get more details
61642       ipv4-oam-address:
61643         type: string
61644         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
61645       serial-number:
61646         type: string
61647         description: Serial number, may be queried
61648       ipaddress-v4-loopback-0:
61649         type: string
61650         description: IPV4 Loopback 0 address
61651       ipaddress-v6-loopback-0:
61652         type: string
61653         description: IPV6 Loopback 0 address
61654       ipaddress-v4-aim:
61655         type: string
61656         description: IPV4 AIM address
61657       ipaddress-v6-aim:
61658         type: string
61659         description: IPV6 AIM address
61660       ipaddress-v6-oam:
61661         type: string
61662         description: IPV6 OAM address
61663       inv-status:
61664         type: string
61665         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
61666       pserver-id:
61667         type: string
61668         description: ID of Pserver
61669       internet-topology:
61670         type: string
61671         description: internet topology of Pserver
61672       in-maint:
61673         type: boolean
61674   pservers:
61675     description: |
61676       Collection of compute hosts.
61677     properties:
61678       pserver:
61679         type: array
61680         items:
61681           $ref: "#/patchDefinitions/pserver"
61682   query-parameters:
61683     description: |
61684       QueryParameters for performing a named-query or model query
61685     properties:
61686       named-query:
61687         type: object
61688         $ref: "#/patchDefinitions/named-query"
61689       overloaded-model:
61690         type: object
61691         $ref: "#/patchDefinitions/overloaded-model"
61692   related-lookup:
61693     description: |
61694       TBD
61695       ###### Related Nodes
61696       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61697     required:
61698     - related-lookup-uuid
61699     - source-node-type
61700     - source-node-property
61701     - target-node-type
61702     - target-node-property
61703     properties:
61704       related-lookup-uuid:
61705         type: string
61706       source-node-type:
61707         type: string
61708       source-node-property:
61709         type: string
61710       target-node-type:
61711         type: string
61712       target-node-property:
61713         type: string
61714       property-collect-list:
61715         type: string
61716   related-lookups:
61717     properties:
61718       related-lookup:
61719         type: array
61720         items:
61721           $ref: "#/patchDefinitions/related-lookup"
61722   related-to-property:
61723     properties:
61724       property-key:
61725         type: string
61726         description: Key part of a key/value pair
61727       property-value:
61728         type: string
61729         description: Value part of a key/value pair
61730   relationship:
61731     properties:
61732       related-to:
61733         type: string
61734         description: A keyword provided by A&AI to indicate type of node.
61735       relationship-label:
61736         type: string
61737         description: The edge label for this relationship.
61738       related-link:
61739         type: string
61740         description: URL to the object in A&AI.
61741       relationship-data:
61742         type: array
61743         items:
61744           $ref: "#/patchDefinitions/relationship-data"
61745       related-to-property:
61746         type: array
61747         items:
61748           $ref: "#/patchDefinitions/related-to-property"
61749   relationship-data:
61750     required:
61751     - relationship-key
61752     - relationship-value
61753     properties:
61754       relationship-key:
61755         type: string
61756         description: A keyword provided by A&AI to indicate an attribute.
61757       relationship-value:
61758         type: string
61759         description: Value of the attribute.
61760   reserved-prop-names:
61761     description: |
61762       Internal map to define some reserved properties of a vertex
61763     properties:
61764       last-mod-source-of-truth:
61765         type: string
61766       aai-node-type:
61767         type: string
61768       aai-created-ts:
61769         type: integer
61770         format: int64
61771       aai-unique-key:
61772         type: string
61773       aai-last-mod-ts:
61774         type: integer
61775         format: int64
61776       source-of-truth:
61777         type: string
61778       aai-uri:
61779         type: string
61780   response-list:
61781     description: |
61782       Response container for the results of a named-query or model query
61783     properties:
61784       inventory-response-items:
61785         type: object
61786         $ref: "#/patchDefinitions/inventory-response-items"
61787   result-data:
61788     properties:
61789       resource-type:
61790         type: string
61791         description: The specific type of node in the A&AI graph
61792       resource-link:
61793         type: string
61794         description: The URL to the specific resource
61795   route-table-reference:
61796     description: |
61797       Openstack route table reference.
61798       ###### Related Nodes
61799       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
61800     required:
61801     - route-table-reference-id
61802     - route-table-reference-fqdn
61803     properties:
61804       route-table-reference-id:
61805         type: string
61806         description: Route Table Reference id, UUID assigned to this instance.
61807       route-table-reference-fqdn:
61808         type: string
61809         description: FQDN entry in the route table.
61810   route-table-references:
61811     description: |
61812       Collection of openstack route table references
61813     properties:
61814       route-table-reference:
61815         type: array
61816         items:
61817           $ref: "#/patchDefinitions/route-table-reference"
61818   route-target:
61819     description: |
61820       Route target information
61821       ###### Related Nodes
61822       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
61823     required:
61824     - global-route-target
61825     - route-target-role
61826     properties:
61827       global-route-target:
61828         type: string
61829         description: Number used to identify an RT, globally unique in the network
61830       route-target-role:
61831         type: string
61832         description: Role assigned to this route target
61833   route-targets:
61834     description: |
61835       Collection of route target information
61836     properties:
61837       route-target:
61838         type: array
61839         items:
61840           $ref: "#/patchDefinitions/route-target"
61841   routing-instance:
61842     description: |
61843       ###### Related Nodes
61844       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61845       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61846       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
61847     required:
61848     - routing-instance-id
61849     properties:
61850       routing-instance-id:
61851         type: string
61852         description: Unique id of routing instance
61853       rpm-owner:
61854         type: string
61855         description: rpm owner
61856   routing-instances:
61857     description: |
61858       set of probes related to generic-vnf routing instance
61859     properties:
61860       routing-instance:
61861         type: array
61862         items:
61863           $ref: "#/patchDefinitions/routing-instance"
61864   sdn-zone-response:
61865     properties:
61866       oam-networks:
61867         type: object
61868         $ref: "#/patchDefinitions/oam-networks"
61869       az-and-dvs-switches:
61870         type: array
61871         items:
61872           $ref: "#/patchDefinitions/az-and-dvs-switches"
61873   search:
61874     properties:
61875       edge-tag-query-result:
61876         type: object
61877         $ref: "#/patchDefinitions/edge-tag-query-result"
61878       edge-tag-query-request:
61879         type: object
61880         $ref: "#/patchDefinitions/edge-tag-query-request"
61881       search-results:
61882         type: object
61883         $ref: "#/patchDefinitions/search-results"
61884       sdn-zone-response:
61885         type: object
61886         $ref: "#/patchDefinitions/sdn-zone-response"
61887   search-results:
61888     properties:
61889       result-data:
61890         type: array
61891         items:
61892           $ref: "#/patchDefinitions/result-data"
61893   secondary-filt:
61894     description: |
61895       SecondaryFilt for performing a named-query or model query
61896   secondary-filter:
61897     properties:
61898       property-name:
61899         type: string
61900       filter-type:
61901         type: string
61902       property-value:
61903         type: string
61904   secondary-filts:
61905     description: |
61906       SecondaryFilts for performing a named-query or model query
61907     properties:
61908       secondary-filt:
61909         type: array
61910         items:
61911           $ref: "#/patchDefinitions/secondary-filt"
61912   segmentation-assignment:
61913     description: |
61914       Openstack segmentation assignment.
61915       ###### Related Nodes
61916       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61917     required:
61918     - segmentation-id
61919     properties:
61920       segmentation-id:
61921         type: string
61922         description: Route Table Reference id, UUID assigned to this instance.
61923   segmentation-assignments:
61924     description: |
61925       Collection of openstack segmentation assignments
61926     properties:
61927       segmentation-assignment:
61928         type: array
61929         items:
61930           $ref: "#/patchDefinitions/segmentation-assignment"
61931   service:
61932     description: |
61933       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
61934     required:
61935     - service-id
61936     - service-description
61937     properties:
61938       service-id:
61939         type: string
61940         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61941       service-description:
61942         type: string
61943         description: Description of the service
61944       service-selflink:
61945         type: string
61946         description: URL to endpoint where AAI can get more details
61947   service-capabilities:
61948     description: |
61949       Collection of service capabilities.
61950     properties:
61951       service-capability:
61952         type: array
61953         items:
61954           $ref: "#/patchDefinitions/service-capability"
61955   service-capability:
61956     description: |
61957       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
61958       ###### Related Nodes
61959       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61960       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61961       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
61962     required:
61963     - service-type
61964     - vnf-type
61965     properties:
61966       service-type:
61967         type: string
61968         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61969       vnf-type:
61970         type: string
61971         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.
61972   service-design-and-creation:
61973     description: |
61974       Namespace for objects managed by ASDC
61975     properties:
61976       vnf-images:
61977         type: array
61978         items:
61979           $ref: "#/patchDefinitions/vnf-image"
61980       services:
61981         type: array
61982         items:
61983           $ref: "#/patchDefinitions/service"
61984       service-capabilities:
61985         type: array
61986         items:
61987           $ref: "#/patchDefinitions/service-capability"
61988       models:
61989         type: array
61990         items:
61991           $ref: "#/patchDefinitions/model"
61992       named-queries:
61993         type: array
61994         items:
61995           $ref: "#/patchDefinitions/named-query"
61996   service-instance:
61997     description: |
61998       Instance of a service
61999       ###### Related Nodes
62000       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
62001       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
62002       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
62003       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
62004       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
62005       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
62006       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
62007       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
62008       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62009       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
62010       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
62011       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
62012       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
62013       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62014       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
62015       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
62016       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
62017       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
62018       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
62019       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
62020       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
62021       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
62022       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
62023       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
62024     required:
62025     - service-instance-id
62026     - service-type
62027     - service-role
62028     - created-at
62029     - updated-at
62030     - description
62031     properties:
62032       service-instance-id:
62033         type: string
62034         description: Uniquely identifies this instance of a service
62035       service-instance-name:
62036         type: string
62037         description: This field will store a name assigned to the service-instance.
62038       service-type:
62039         type: string
62040         description: String capturing type of service.
62041       service-role:
62042         type: string
62043         description: String capturing the service role.
62044       environment-context:
62045         type: string
62046         description: This field will store the environment context assigned to the service-instance.
62047       workload-context:
62048         type: string
62049         description: This field will store the workload context assigned to the service-instance.
62050       created-at:
62051         type: string
62052         description: create time of Network Service.
62053       updated-at:
62054         type: string
62055         description: last update of Network Service.
62056       description:
62057         type: string
62058         description: short description for service-instance.
62059       model-invariant-id:
62060         type: string
62061         description: the ASDC model id for this resource or service model.
62062       model-version-id:
62063         type: string
62064         description: the ASDC model version for this resource or service model.
62065       persona-model-version:
62066         type: string
62067         description: the ASDC model version for this resource or service model.
62068       widget-model-id:
62069         type: string
62070         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62071       widget-model-version:
62072         type: string
62073         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62074       bandwidth-total:
62075         type: string
62076         description: Indicates the total bandwidth to be used for this service.
62077       bandwidth-up-wan1:
62078         type: string
62079         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
62080       bandwidth-down-wan1:
62081         type: string
62082         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
62083       bandwidth-up-wan2:
62084         type: string
62085         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
62086       bandwidth-down-wan2:
62087         type: string
62088         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
62089       vhn-portal-url:
62090         type: string
62091         description: URL customers will use to access the vHN Portal.
62092       service-instance-location-id:
62093         type: string
62094         description: An identifier that customers assign to the location where this service is being used.
62095   service-instances:
62096     description: |
62097       Collection of service instances
62098     properties:
62099       service-instance:
62100         type: array
62101         items:
62102           $ref: "#/patchDefinitions/service-instance"
62103   service-subscription:
62104     description: |
62105       Object that group service instances.
62106       ###### Related Nodes
62107       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
62108       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
62109       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
62110       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
62111     required:
62112     - service-type
62113     properties:
62114       service-type:
62115         type: string
62116         description: Value defined by orchestration to identify this service across ECOMP.
62117       temp-ub-sub-account-id:
62118         type: string
62119         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
62120   service-subscriptions:
62121     description: |
62122       Collection of objects that group service instances.
62123     properties:
62124       service-subscription:
62125         type: array
62126         items:
62127           $ref: "#/patchDefinitions/service-subscription"
62128   services:
62129     description: |
62130       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
62131     properties:
62132       service:
62133         type: array
62134         items:
62135           $ref: "#/patchDefinitions/service"
62136   site-pair:
62137     description: |
62138       ###### Related Nodes
62139       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
62140       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
62141       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
62142     required:
62143     - site-pair-id
62144     properties:
62145       site-pair-id:
62146         type: string
62147         description: unique identifier of probe
62148       source-ip:
62149         type: string
62150         description: Prefix address
62151       destination-ip:
62152         type: string
62153         description: Prefix address
62154       ip-version:
62155         type: string
62156         description: ip version, v4, v6
62157       destination-hostname:
62158         type: string
62159         description: Hostname of the destination equipment to which SLAs are measured against.
62160       destination-equip-type:
62161         type: string
62162         description: The type of destinatination equipment. Could be Router, UCPE, etc.
62163   site-pair-set:
62164     description: |
62165       Set of instances for probes used to measure service level agreements
62166       ###### Related Nodes
62167       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
62168       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
62169       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
62170     required:
62171     - site-pair-set-id
62172     properties:
62173       site-pair-set-id:
62174         type: string
62175         description: Unique id of site pair set.
62176   site-pair-sets:
62177     description: |
62178       Collection of sets of instances for probes related to generic-vnf
62179     properties:
62180       site-pair-set:
62181         type: array
62182         items:
62183           $ref: "#/patchDefinitions/site-pair-set"
62184   site-pairs:
62185     description: |
62186       probe within a set
62187     properties:
62188       site-pair:
62189         type: array
62190         items:
62191           $ref: "#/patchDefinitions/site-pair"
62192   snapshot:
62193     description: |
62194       Openstack snapshot
62195       ###### Related Nodes
62196       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62197       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62198     required:
62199     - snapshot-id
62200     properties:
62201       snapshot-id:
62202         type: string
62203         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
62204       snapshot-name:
62205         type: string
62206         description: Snapshot name
62207       snapshot-architecture:
62208         type: string
62209         description: Operating system architecture
62210       snapshot-os-distro:
62211         type: string
62212         description: The common name of the operating system distribution in lowercase
62213       snapshot-os-version:
62214         type: string
62215         description: The operating system version as specified by the distributor.
62216       application:
62217         type: string
62218         description: The application that the image instantiates.
62219       application-vendor:
62220         type: string
62221         description: The vendor of the application.
62222       application-version:
62223         type: string
62224         description: The version of the application.
62225       snapshot-selflink:
62226         type: string
62227         description: URL to endpoint where AAI can get more details
62228       prev-snapshot-id:
62229         type: string
62230         description: This field contains the UUID of the previous snapshot (if any).
62231   snapshots:
62232     description: |
62233       Collection of openstack snapshots
62234     properties:
62235       snapshot:
62236         type: array
62237         items:
62238           $ref: "#/patchDefinitions/snapshot"
62239   sriov-pf:
62240     description: |
62241       SR-IOV Physical Function
62242       ###### Related Nodes
62243       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
62244       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
62245     required:
62246     - pf-pci-id
62247     properties:
62248       pf-pci-id:
62249         type: string
62250         description: Identifier for the sriov-pf
62251   sriov-pfs:
62252     description: |
62253       Collection of SR-IOV Physical Functions.
62254     properties:
62255       sriov-pf:
62256         type: array
62257         items:
62258           $ref: "#/patchDefinitions/sriov-pf"
62259   sriov-vf:
62260     description: |
62261       SR-IOV Virtual Function (not to be confused with virtual network function)
62262       ###### Related Nodes
62263       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
62264       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
62265     required:
62266     - pci-id
62267     properties:
62268       pci-id:
62269         type: string
62270         description: PCI ID used to identify the sriov-vf
62271       vf-vlan-filter:
62272         type: string
62273         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
62274       vf-mac-filter:
62275         type: string
62276         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
62277       vf-vlan-strip:
62278         type: boolean
62279         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
62280       vf-vlan-anti-spoof-check:
62281         type: boolean
62282         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.
62283       vf-mac-anti-spoof-check:
62284         type: boolean
62285         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.
62286       vf-mirrors:
62287         type: string
62288         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
62289       vf-broadcast-allow:
62290         type: boolean
62291         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
62292       vf-unknown-multicast-allow:
62293         type: boolean
62294         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
62295       vf-unknown-unicast-allow:
62296         type: boolean
62297         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
62298       vf-insert-stag:
62299         type: boolean
62300         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
62301       vf-link-status:
62302         type: string
62303         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
62304   sriov-vfs:
62305     description: |
62306       Collection of SR-IOV Virtual Functions.
62307     properties:
62308       sriov-vf:
62309         type: array
62310         items:
62311           $ref: "#/patchDefinitions/sriov-vf"
62312   start-node-filter:
62313     properties:
62314       property-name:
62315         type: string
62316       property-value:
62317         type: string
62318   subnet:
62319     description: |
62320       ###### Related Nodes
62321       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
62322       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
62323       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
62324       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
62325       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62326       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62327       - 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
62328       - SUBNET is DELETED when these are DELETED HOST-ROUTE
62329     required:
62330     - subnet-id
62331     - dhcp-enabled
62332     properties:
62333       subnet-id:
62334         type: string
62335         description: Subnet ID, should be UUID.
62336       subnet-name:
62337         type: string
62338         description: Name associated with the subnet.
62339       neutron-subnet-id:
62340         type: string
62341         description: Neutron id of this subnet
62342       gateway-address:
62343         type: string
62344         description: gateway ip address
62345       network-start-address:
62346         type: string
62347         description: network start address
62348       cidr-mask:
62349         type: string
62350         description: cidr mask
62351       ip-version:
62352         type: string
62353         description: ip version
62354       orchestration-status:
62355         type: string
62356         description: Orchestration status of this VNF, mastered by MSO
62357       dhcp-enabled:
62358         type: boolean
62359       dhcp-start:
62360         type: string
62361         description: the start address reserved for use by dhcp
62362       dhcp-end:
62363         type: string
62364         description: the last address reserved for use by dhcp
62365       subnet-role:
62366         type: string
62367         description: role of the subnet, referenced when assigning IPs
62368       ip-assignment-direction:
62369         type: string
62370         description: ip address assignment direction of the subnet
62371   subnets:
62372     properties:
62373       subnet:
62374         type: array
62375         items:
62376           $ref: "#/patchDefinitions/subnet"
62377   tagged-inventory-item-list:
62378     properties:
62379       inventory-item:
62380         type: array
62381         items:
62382           $ref: "#/patchDefinitions/inventory-item"
62383   tenant:
62384     description: |
62385       Openstack tenant
62386       ###### Related Nodes
62387       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62388       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
62389       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62390       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62391       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
62392       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62393       - TENANT cannot be deleted if linked to VSERVER
62394     required:
62395     - tenant-id
62396     - tenant-name
62397     properties:
62398       tenant-id:
62399         type: string
62400         description: Unique id relative to the cloud-region.
62401       tenant-name:
62402         type: string
62403         description: Readable name of tenant
62404       tenant-context:
62405         type: string
62406         description: This field will store the tenant context.
62407   tenants:
62408     description: |
62409       Collection of openstack tenants.
62410     properties:
62411       tenant:
62412         type: array
62413         items:
62414           $ref: "#/patchDefinitions/tenant"
62415   tunnel-xconnect:
62416     description: |
62417       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
62418       ###### Related Nodes
62419       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
62420     required:
62421     - id
62422     properties:
62423       id:
62424         type: string
62425         description: Allotted Resource id UUID assigned to this instance.
62426       bandwidth-up-wan1:
62427         type: string
62428         description: The WAN uplink bandwidth for WAN1
62429       bandwidth-down-wan1:
62430         type: string
62431         description: The WAN downlink bandwidth for WAN1
62432       bandwidth-up-wan2:
62433         type: string
62434         description: The WAN uplink bandwidth for WAN2
62435       bandwidth-down-wan2:
62436         type: string
62437         description: The WAN downlink bandwidth for WAN2
62438   tunnel-xconnects:
62439     description: |
62440       This object is used to store the specific tunnel cross connect aspects of an allotted resource
62441     properties:
62442       tunnel-xconnect:
62443         type: array
62444         items:
62445           $ref: "#/patchDefinitions/tunnel-xconnect"
62446   update:
62447     description: |
62448       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
62449     required:
62450     - update-node-type
62451     properties:
62452       update-node-type:
62453         type: string
62454       update-node-key:
62455         type: array
62456         items:
62457           $ref: "#/patchDefinitions/update-node-key"
62458       update-node-uri:
62459         type: string
62460       action:
62461         type: array
62462         items:
62463           $ref: "#/patchDefinitions/action"
62464   update-node-key:
62465     properties:
62466       key-name:
62467         type: string
62468       key-value:
62469         type: string
62470   vce:
62471     description: |
62472       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
62473       ###### Related Nodes
62474       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62475       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62476       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62477       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62478       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62479       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62480       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
62481       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
62482     required:
62483     - vnf-id
62484     - vnf-name
62485     - vnf-type
62486     properties:
62487       vnf-id:
62488         type: string
62489         description: Unique id of VNF.  This is unique across the graph.
62490       vnf-name:
62491         type: string
62492         description: Name of VNF.
62493       vnf-name2:
62494         type: string
62495         description: Alternate name of VNF.
62496       vnf-type:
62497         type: string
62498         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.
62499       service-id:
62500         type: string
62501         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
62502       regional-resource-zone:
62503         type: string
62504         description: Regional way of organizing pservers, source of truth should define values
62505       prov-status:
62506         type: string
62507         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62508       operational-status:
62509         type: string
62510         description: Indicator for whether the resource is considered operational
62511       license-key:
62512         type: string
62513         description: OBSOLETE -  do not use
62514       equipment-role:
62515         type: string
62516         description: Network role being played by this VNF
62517       orchestration-status:
62518         type: string
62519         description: Orchestration status of this VNF, mastered by MSO
62520       heat-stack-id:
62521         type: string
62522         description: Heat stack id corresponding to this instance, managed by MSO
62523       mso-catalog-key:
62524         type: string
62525         description: Corresponds to the SDN-C catalog id used to configure this VCE
62526       vpe-id:
62527         type: string
62528         description: Unique ID of VPE connected to this VCE.
62529       v6-vce-wan-address:
62530         type: string
62531         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
62532       ipv4-oam-address:
62533         type: string
62534         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
62535   vces:
62536     description: |
62537       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
62538     properties:
62539       vce:
62540         type: array
62541         items:
62542           $ref: "#/patchDefinitions/vce"
62543   vf-module:
62544     description: |
62545       a deployment unit of VNFCs
62546       ###### Related Nodes
62547       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62548       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
62549       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62550       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62551       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62552       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
62553       - VF-MODULE cannot be deleted if linked to VNFC
62554     required:
62555     - vf-module-id
62556     - is-base-vf-module
62557     properties:
62558       vf-module-id:
62559         type: string
62560         description: Unique ID of vf-module.
62561       vf-module-name:
62562         type: string
62563         description: Name of vf-module
62564       heat-stack-id:
62565         type: string
62566         description: Heat stack id corresponding to this instance.
62567       orchestration-status:
62568         type: string
62569         description: orchestration status of this vf-module, mastered by MSO
62570       is-base-vf-module:
62571         type: boolean
62572   vf-modules:
62573     description: |
62574       Collection of vf-modules, a deployment unit of VNFCs
62575     properties:
62576       vf-module:
62577         type: array
62578         items:
62579           $ref: "#/patchDefinitions/vf-module"
62580   vig-server:
62581     description: |
62582       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62583       ###### Related Nodes
62584       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
62585     required:
62586     - vig-address-type
62587     properties:
62588       vig-address-type:
62589         type: string
62590         description: indicates whether the VIG is for AVPN or INTERNET
62591       ipaddress-v4-vig:
62592         type: string
62593         description: v4 IP of the vig server
62594       ipaddress-v6-vig:
62595         type: string
62596         description: v6 IP of the vig server
62597   vig-servers:
62598     properties:
62599       vig-server:
62600         type: array
62601         items:
62602           $ref: "#/patchDefinitions/vig-server"
62603   vip-ipv4-address-list:
62604     description: |
62605       IPv4 Address Range
62606       ###### Related Nodes
62607       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62608       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62609       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62610       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
62611     required:
62612     - vip-ipv4-address
62613     properties:
62614       vip-ipv4-address:
62615         type: string
62616         description: IP address
62617       vip-ipv4-prefix-length:
62618         type: integer
62619         format: int64
62620         description: Prefix length, 32 for single address
62621       vlan-id-inner:
62622         type: integer
62623         format: int64
62624         description: Inner VLAN tag
62625       vlan-id-outer:
62626         type: integer
62627         format: int64
62628         description: Outer VLAN tag
62629       is-floating:
62630         type: boolean
62631         description: Indicator of fixed or floating address
62632   vip-ipv6-address-list:
62633     description: |
62634       IPv6 Address Range
62635       ###### Related Nodes
62636       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62637       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62638       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62639       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
62640     required:
62641     - vip-ipv6-address
62642     properties:
62643       vip-ipv6-address:
62644         type: string
62645         description: IP address
62646       vip-ipv6-prefix-length:
62647         type: integer
62648         format: int64
62649         description: Prefix length, 128 for single address
62650       vlan-id-inner:
62651         type: integer
62652         format: int64
62653         description: Inner VLAN tag
62654       vlan-id-outer:
62655         type: integer
62656         format: int64
62657         description: Outer VLAN tag
62658       is-floating:
62659         type: boolean
62660         description: Indicator of fixed or floating address
62661   virtual-data-center:
62662     description: |
62663       Virtual organization of cloud infrastructure elements in a data center context
62664       ###### Related Nodes
62665       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62666       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62667       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62668     required:
62669     - vdc-id
62670     - vdc-name
62671     properties:
62672       vdc-id:
62673         type: string
62674         description: Unique ID of the vdc
62675       vdc-name:
62676         type: string
62677         description: Name of the virtual data center
62678   virtual-data-centers:
62679     description: |
62680       Virtual organization of cloud infrastructure elements in a data center context
62681     properties:
62682       virtual-data-center:
62683         type: array
62684         items:
62685           $ref: "#/patchDefinitions/virtual-data-center"
62686   vlan:
62687     description: |
62688       Definition of vlan
62689       ###### Related Nodes
62690       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
62691       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62692       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
62693       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
62694       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
62695       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62696       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62697       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
62698       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
62699     required:
62700     - vlan-interface
62701     - in-maint
62702     - is-ip-unnumbered
62703     properties:
62704       vlan-interface:
62705         type: string
62706         description: String that identifies the interface
62707       vlan-id-inner:
62708         type: integer
62709         format: int64
62710         description: Inner VLAN tag
62711       vlan-id-outer:
62712         type: integer
62713         format: int64
62714         description: Outer VLAN tag
62715   vlans:
62716     properties:
62717       vlan:
62718         type: array
62719         items:
62720           $ref: "#/patchDefinitions/vlan"
62721   vnf:
62722     description: |
62723       Abstract vnf class
62724     required:
62725     - vnf-id
62726     properties:
62727       vnf-id:
62728         type: string
62729         description: Unique id of VNF.  This is unique across the graph.
62730   vnf-image:
62731     description: |
62732       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62733       ###### Related Nodes
62734       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
62735       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
62736     required:
62737     - vnf-image-uuid
62738     - application
62739     - application-vendor
62740     properties:
62741       vnf-image-uuid:
62742         type: string
62743         description: Unique ID of this asset
62744       application:
62745         type: string
62746         description: The application that the image instantiates.
62747       application-vendor:
62748         type: string
62749         description: The vendor of the application.
62750       application-version:
62751         type: string
62752         description: The version of the application.
62753       selflink:
62754         type: string
62755         description: URL to endpoint where AAI can get more details
62756   vnf-images:
62757     description: |
62758       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62759     properties:
62760       vnf-image:
62761         type: array
62762         items:
62763           $ref: "#/patchDefinitions/vnf-image"
62764   vnfc:
62765     description: |
62766       ###### Related Nodes
62767       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62768       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62769       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
62770       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
62771       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62772       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62773       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
62774       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
62775       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
62776     required:
62777     - vnfc-name
62778     - nfc-naming-code
62779     - nfc-function
62780     - in-maint
62781     - is-closed-loop-disabled
62782     properties:
62783       vnfc-name:
62784         type: string
62785         description: Unique ID of vnfc.
62786       nfc-naming-code:
62787         type: string
62788         description: Short code that is used in naming instances of the item being modeled
62789       nfc-function:
62790         type: string
62791         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
62792       prov-status:
62793         type: string
62794         description: prov status of this vnfc
62795       orchestration-status:
62796         type: string
62797         description: Orchestration status of this VNF, mastered by APP-C
62798       ipaddress-v4-oam-vip:
62799         type: string
62800         description: Oam V4 vip address of this vnfc
62801       in-maint:
62802         type: boolean
62803       is-closed-loop-disabled:
62804         type: boolean
62805       group-notation:
62806         type: string
62807         description: Group notation of VNFC
62808       model-invariant-id:
62809         type: string
62810         description: the ASDC model id for this resource or service model.
62811       model-version-id:
62812         type: string
62813         description: the ASDC model version for this resource or service model.
62814   vnfcs:
62815     description: |
62816       virtual network components associated with a vserver from application controller.
62817     properties:
62818       vnfc:
62819         type: array
62820         items:
62821           $ref: "#/patchDefinitions/vnfc"
62822   volume:
62823     description: |
62824       Ephemeral Block storage volume.
62825       ###### Related Nodes
62826       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
62827     required:
62828     - volume-id
62829     - volume-selflink
62830     properties:
62831       volume-id:
62832         type: string
62833         description: Unique ID of block storage volume relative to the vserver.
62834       volume-selflink:
62835         type: string
62836         description: URL to endpoint where AAI can get more details
62837   volume-group:
62838     description: |
62839       Persistent block-level storage.
62840       ###### Related Nodes
62841       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62842       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62843       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62844       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62845       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62846     required:
62847     - volume-group-id
62848     - volume-group-name
62849     - vnf-type
62850     properties:
62851       volume-group-id:
62852         type: string
62853         description: Unique ID of volume-group.
62854       volume-group-name:
62855         type: string
62856         description: Name of the volume group.
62857       heat-stack-id:
62858         type: string
62859         description: Heat stack id corresponding to this volume-group
62860       vnf-type:
62861         type: string
62862         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.
62863       orchestration-status:
62864         type: string
62865         description: Orchestration status of this volume-group
62866       model-customization-id:
62867         type: string
62868         description: captures the id of all the configuration used to customize the resource for the service.
62869       vf-module-model-customization-id:
62870         type: string
62871         description: helps relate the volume group to the vf-module whose components will require the volume group
62872   volume-groups:
62873     description: |
62874       Collection of persistent block-level storage.
62875     properties:
62876       volume-group:
62877         type: array
62878         items:
62879           $ref: "#/patchDefinitions/volume-group"
62880   volumes:
62881     description: |
62882       Collection of ephemeral Block storage volumes.
62883     properties:
62884       volume:
62885         type: array
62886         items:
62887           $ref: "#/patchDefinitions/volume"
62888   vpls-pe:
62889     description: |
62890       VPLS Provider Edge routers.
62891       ###### Related Nodes
62892       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62893       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62894       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62895       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62896       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62897     required:
62898     - equipment-name
62899     properties:
62900       equipment-name:
62901         type: string
62902       prov-status:
62903         type: string
62904         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62905       ipv4-oam-address:
62906         type: string
62907         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).
62908       equipment-role:
62909         type: string
62910         description: Client should send valid enumerated value, e.g., VPLS-PE.
62911       vlan-id-outer:
62912         type: integer
62913         format: int64
62914         description: Temporary location for stag to get to VCE
62915   vpls-pes:
62916     description: |
62917       Collection of VPLS Provider Edge routers
62918     properties:
62919       vpls-pe:
62920         type: array
62921         items:
62922           $ref: "#/patchDefinitions/vpls-pe"
62923   vpn-binding:
62924     description: |
62925       VPN binding
62926       ###### Related Nodes
62927       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
62928       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62929       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62930       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
62931       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62932       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
62933     required:
62934     - vpn-id
62935     - vpn-name
62936     properties:
62937       vpn-id:
62938         type: string
62939         description: VPN ID, globally unique within A&AI
62940       vpn-name:
62941         type: string
62942         description: VPN Name
62943       vpn-platform:
62944         type: string
62945         description: the platform associated with the VPN example AVPN, Mobility
62946       vpn-type:
62947         type: string
62948         description: Type of the vpn, should be taken from enumerated/valid values
62949       vpn-region:
62950         type: string
62951         description: region of customer vpn
62952       customer-vpn-id:
62953         type: string
62954         description: id for this customer vpn
62955       route-distinguisher:
62956         type: string
62957         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62958   vpn-bindings:
62959     properties:
62960       vpn-binding:
62961         type: array
62962         items:
62963           $ref: "#/patchDefinitions/vpn-binding"
62964   vserver:
62965     description: |
62966       Virtual Servers, aka virtual machine or VM.
62967       ###### Related Nodes
62968       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62969       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
62970       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
62971       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
62972       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62973       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
62974       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
62975       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62976       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
62977       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62978       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62979       - VSERVER is DELETED when these are DELETED L-INTERFACE
62980       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
62981     required:
62982     - vserver-id
62983     - vserver-name
62984     - vserver-selflink
62985     - in-maint
62986     - is-closed-loop-disabled
62987     properties:
62988       vserver-id:
62989         type: string
62990         description: Unique identifier for this vserver relative to its tenant
62991       vserver-name:
62992         type: string
62993         description: Name of vserver
62994       vserver-name2:
62995         type: string
62996         description: Alternative name of vserver
62997       prov-status:
62998         type: string
62999         description: Trigger for operational monitoring of this resource by Service Assurance systems.
63000       vserver-selflink:
63001         type: string
63002         description: URL to endpoint where AAI can get more details
63003       in-maint:
63004         type: boolean
63005       is-closed-loop-disabled:
63006         type: boolean
63007   vservers:
63008     description: |
63009       Collection of virtual Servers, aka virtual machines or VMs.
63010     properties:
63011       vserver:
63012         type: array
63013         items:
63014           $ref: "#/patchDefinitions/vserver"
63015   zone:
63016     description: |
63017       A zone is a grouping of assets in a location homing to the same connections into the CBB
63018       ###### Related Nodes
63019       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63020       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63021       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63022       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63023       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63024     required:
63025     - zone-id
63026     - zone-name
63027     - design-type
63028     - zone-context
63029     properties:
63030       zone-id:
63031         type: string
63032         description: Code assigned by AIC to the zone
63033       zone-name:
63034         type: string
63035         description: English name associated with the zone
63036       design-type:
63037         type: string
63038         description: Design of zone [Medium/Large…]
63039       zone-context:
63040         type: string
63041         description: Context of zone [production/test]
63042       status:
63043         type: string
63044         description: Status of a zone.
63045   zones:
63046     description: |
63047       Collection of zones
63048     properties:
63049       zone:
63050         type: array
63051         items:
63052           $ref: "#/patchDefinitions/zone"
63053 getDefinitions:
63054   aai-internal:
63055     properties:
63056       property-name:
63057         type: string
63058       property-value:
63059         type: string
63060   action:
63061     properties:
63062       action-type:
63063         type: string
63064       action-data:
63065         type: array
63066         items:
63067           $ref: "#/getDefinitions/action-data"
63068   action-data:
63069     properties:
63070       property-name:
63071         type: string
63072       property-value:
63073         type: string
63074   actions:
63075     description: |
63076       APIs that are more action related than REST (e.g., notify, update).
63077     properties:
63078       update:
63079         type: object
63080         $ref: "#/getDefinitions/update"
63081       notify:
63082         type: object
63083         $ref: "#/getDefinitions/notify"
63084   allotted-resource:
63085     description: |
63086       Represents a slice or partial piece of a resource that gets separately allotted
63087       ###### Related Nodes
63088       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
63089       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
63090       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63091       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
63092       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
63093       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
63094       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
63095       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
63096       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
63097       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
63098       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
63099       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
63100       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
63101       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
63102       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
63103     required:
63104     - id
63105     properties:
63106       id:
63107         type: string
63108         description: Allotted Resource id UUID assigned to this instance.
63109       description:
63110         type: string
63111         description: The descriptive information assigned to this allotted resource instance
63112       selflink:
63113         type: string
63114         description: Link back to more information in the controller
63115       model-invariant-id:
63116         type: string
63117         description: the ASDC model id for this resource or service model.
63118       model-version-id:
63119         type: string
63120         description: the ASDC model version for this resource or service model.
63121       persona-model-version:
63122         type: string
63123         description: the ASDC model version for this resource or service model.
63124       resource-version:
63125         type: string
63126         description: Concurrency value
63127       orchestration-status:
63128         type: string
63129         description: Orchestration status
63130       operational-status:
63131         type: string
63132         description: Indicator for whether the resource is considered operational
63133       type:
63134         type: string
63135         description: Generic description of the type of allotted resource.
63136       role:
63137         type: string
63138         description: role in the network that this resource will be providing.
63139       tunnel-xconnects:
63140         type: array
63141         items:
63142           $ref: "#/getDefinitions/tunnel-xconnect"
63143       relationship-list:
63144         type: array
63145         items:
63146           $ref: "#/getDefinitions/relationship"
63147   allotted-resources:
63148     description: |
63149       This object is used to store slices of services being offered
63150     properties:
63151       allotted-resource:
63152         type: array
63153         items:
63154           $ref: "#/getDefinitions/allotted-resource"
63155   availability-zone:
63156     description: |
63157       Availability zone, a collection of compute hosts/pservers
63158       ###### Related Nodes
63159       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63160       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
63161       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63162       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
63163       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
63164       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63165       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
63166       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63167       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
63168     required:
63169     - availability-zone-name
63170     - hypervisor-type
63171     properties:
63172       availability-zone-name:
63173         type: string
63174         description: Name of the availability zone.  Unique across a cloud region
63175       hypervisor-type:
63176         type: string
63177         description: Type of hypervisor.  Source of truth should define valid values.
63178       operational-status:
63179         type: string
63180         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
63181       resource-version:
63182         type: string
63183         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63184       relationship-list:
63185         type: array
63186         items:
63187           $ref: "#/getDefinitions/relationship"
63188   availability-zones:
63189     description: |
63190       Collection of availability zones
63191     properties:
63192       availability-zone:
63193         type: array
63194         items:
63195           $ref: "#/getDefinitions/availability-zone"
63196   az-and-dvs-switches:
63197     properties:
63198       dvs-switches:
63199         type: object
63200         $ref: "#/getDefinitions/dvs-switches"
63201       availability-zone:
63202         type: object
63203         $ref: "#/getDefinitions/availability-zone"
63204   business:
63205     description: |
63206       Namespace for business related constructs
63207     properties:
63208       connectors:
63209         type: array
63210         items:
63211           $ref: "#/getDefinitions/connector"
63212       customers:
63213         type: array
63214         items:
63215           $ref: "#/getDefinitions/customer"
63216       lines-of-business:
63217         type: array
63218         items:
63219           $ref: "#/getDefinitions/line-of-business"
63220       owning-entities:
63221         type: array
63222         items:
63223           $ref: "#/getDefinitions/owning-entity"
63224       platforms:
63225         type: array
63226         items:
63227           $ref: "#/getDefinitions/platform"
63228       projects:
63229         type: array
63230         items:
63231           $ref: "#/getDefinitions/project"
63232   class-of-service:
63233     description: |
63234       ###### Related Nodes
63235       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
63236     required:
63237     - cos
63238     properties:
63239       cos:
63240         type: string
63241         description: unique identifier of probe
63242       probe-id:
63243         type: string
63244         description: identifier of probe
63245       probe-type:
63246         type: string
63247         description: type of probe
63248       resource-version:
63249         type: string
63250         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63251       relationship-list:
63252         type: array
63253         items:
63254           $ref: "#/getDefinitions/relationship"
63255   classes-of-service:
63256     description: |
63257       class-of-service of probe
63258     properties:
63259       class-of-service:
63260         type: array
63261         items:
63262           $ref: "#/getDefinitions/class-of-service"
63263   cloud-infrastructure:
63264     description: |
63265       Namespace for cloud infrastructure.
63266     properties:
63267       complexes:
63268         type: array
63269         items:
63270           $ref: "#/getDefinitions/complex"
63271       cloud-regions:
63272         type: array
63273         items:
63274           $ref: "#/getDefinitions/cloud-region"
63275       network-profiles:
63276         type: array
63277         items:
63278           $ref: "#/getDefinitions/network-profile"
63279       pservers:
63280         type: array
63281         items:
63282           $ref: "#/getDefinitions/pserver"
63283       virtual-data-centers:
63284         type: array
63285         items:
63286           $ref: "#/getDefinitions/virtual-data-center"
63287       operational-environments:
63288         type: array
63289         items:
63290           $ref: "#/getDefinitions/operational-environment"
63291   cloud-region:
63292     description: |
63293       cloud-region designates an installation of a cloud cluster or region or instantiation.
63294       ###### Related Nodes
63295       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
63296       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63297       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63298       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63299       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63300       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63301       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63302       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63303       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63304       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63305       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63306       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63307       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63308       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63309       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63310       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
63311       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
63312       - 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
63313       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
63314       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63315     required:
63316     - cloud-owner
63317     - cloud-region-id
63318     - sriov-automation
63319     properties:
63320       cloud-owner:
63321         type: string
63322         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
63323       cloud-region-id:
63324         type: string
63325         description: Identifier used by the vendor for the region. Second part of composite key
63326       cloud-type:
63327         type: string
63328         description: Type of the cloud (e.g., openstack)
63329       owner-defined-type:
63330         type: string
63331         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
63332       cloud-region-version:
63333         type: string
63334         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
63335       identity-url:
63336         type: string
63337         description: URL of the keystone identity service
63338       cloud-zone:
63339         type: string
63340         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
63341       complex-name:
63342         type: string
63343         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
63344       sriov-automation:
63345         type: boolean
63346       cloud-extra-info:
63347         type: string
63348         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
63349       cloud-epa-caps:
63350         type: string
63351         description: MultiVIM will discover and expose EPA capabilities.
63352       resource-version:
63353         type: string
63354         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63355       volume-groups:
63356         type: array
63357         items:
63358           $ref: "#/getDefinitions/volume-group"
63359       tenants:
63360         type: array
63361         items:
63362           $ref: "#/getDefinitions/tenant"
63363       flavors:
63364         type: array
63365         items:
63366           $ref: "#/getDefinitions/flavor"
63367       group-assignments:
63368         type: array
63369         items:
63370           $ref: "#/getDefinitions/group-assignment"
63371       snapshots:
63372         type: array
63373         items:
63374           $ref: "#/getDefinitions/snapshot"
63375       images:
63376         type: array
63377         items:
63378           $ref: "#/getDefinitions/image"
63379       dvs-switches:
63380         type: array
63381         items:
63382           $ref: "#/getDefinitions/dvs-switch"
63383       oam-networks:
63384         type: array
63385         items:
63386           $ref: "#/getDefinitions/oam-network"
63387       availability-zones:
63388         type: array
63389         items:
63390           $ref: "#/getDefinitions/availability-zone"
63391       relationship-list:
63392         type: array
63393         items:
63394           $ref: "#/getDefinitions/relationship"
63395       vip-ipv4-address-list:
63396         type: array
63397         items:
63398           $ref: "#/getDefinitions/vip-ipv4-address-list"
63399       vip-ipv6-address-list:
63400         type: array
63401         items:
63402           $ref: "#/getDefinitions/vip-ipv6-address-list"
63403   cloud-regions:
63404     properties:
63405       cloud-region:
63406         type: array
63407         items:
63408           $ref: "#/getDefinitions/cloud-region"
63409   complex:
63410     description: |
63411       Collection of physical locations that can house cloud-regions.
63412       ###### Related Nodes
63413       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63414       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63415       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63416       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
63417       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63418       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
63419       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63420       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63421       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63422       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63423       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63424       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63425       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
63426       - COMPLEX is DELETED when these are DELETED CTAG-POOL
63427     required:
63428     - physical-location-id
63429     - physical-location-type
63430     - street1
63431     - city
63432     - postal-code
63433     - country
63434     - region
63435     properties:
63436       physical-location-id:
63437         type: string
63438         description: Unique identifier for physical location, e.g., CLLI
63439       data-center-code:
63440         type: string
63441         description: Data center code which can be an alternate way to identify a complex
63442       complex-name:
63443         type: string
63444         description: Gamma complex name for LCP instance.
63445       identity-url:
63446         type: string
63447         description: URL of the keystone identity service
63448       resource-version:
63449         type: string
63450         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63451       physical-location-type:
63452         type: string
63453         description: Type, e.g., central office, data center.
63454       street1:
63455         type: string
63456       street2:
63457         type: string
63458       city:
63459         type: string
63460       state:
63461         type: string
63462       postal-code:
63463         type: string
63464       country:
63465         type: string
63466       region:
63467         type: string
63468       latitude:
63469         type: string
63470       longitude:
63471         type: string
63472       elevation:
63473         type: string
63474       lata:
63475         type: string
63476       ctag-pools:
63477         type: array
63478         items:
63479           $ref: "#/getDefinitions/ctag-pool"
63480       relationship-list:
63481         type: array
63482         items:
63483           $ref: "#/getDefinitions/relationship"
63484   complexes:
63485     description: |
63486       Collection of physical locations that can house cloud-regions.
63487     properties:
63488       complex:
63489         type: array
63490         items:
63491           $ref: "#/getDefinitions/complex"
63492   configuration:
63493     description: |
63494       Port Mirror Configuration.
63495       ###### Related Nodes
63496       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
63497       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
63498       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
63499       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
63500       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
63501       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63502       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63503       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63504       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63505       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63506       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63507       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
63508       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
63509     required:
63510     - configuration-id
63511     - configuration-type
63512     - configuration-sub-type
63513     - orchestration-status
63514     - operational-status
63515     - configuration-selflink
63516     - model-customization-id
63517     properties:
63518       configuration-id:
63519         type: string
63520         description: UUID assigned to configuration.
63521       management-option:
63522         type: string
63523         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
63524       configuration-name:
63525         type: string
63526         description: Name of the configuration.
63527       configuration-type:
63528         type: string
63529         description: port-mirroring-configuration.
63530       configuration-sub-type:
63531         type: string
63532         description: vprobe, pprobe.
63533       model-invariant-id:
63534         type: string
63535         description: the ASDC model id for this resource or service model.
63536       model-version-id:
63537         type: string
63538         description: the ASDC model version for this resource or service model.
63539       orchestration-status:
63540         type: string
63541         description: Orchestration status of the configuration.
63542       operational-status:
63543         type: string
63544         description: Indicator for whether the resource is considered operational.
63545       configuration-selflink:
63546         type: string
63547         description: URL to endpoint where AAI can get more details from SDN-GC.
63548       model-customization-id:
63549         type: string
63550         description: id of  the configuration used to customize the resource
63551       tunnel-bandwidth:
63552         type: string
63553         description: DHV Site Effective Bandwidth
63554       vendor-allowed-max-bandwidth:
63555         type: string
63556         description: Velocloud Nominal Throughput - VNT
63557       resource-version:
63558         type: string
63559         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63560       relationship-list:
63561         type: array
63562         items:
63563           $ref: "#/getDefinitions/relationship"
63564       metadata:
63565         type: array
63566         items:
63567           $ref: "#/getDefinitions/metadatum"
63568       forwarder-evcs:
63569         type: array
63570         items:
63571           $ref: "#/getDefinitions/forwarder-evc"
63572       evcs:
63573         type: array
63574         items:
63575           $ref: "#/getDefinitions/evc"
63576   configurations:
63577     description: |
63578       Collection of configurations
63579     properties:
63580       configuration:
63581         type: array
63582         items:
63583           $ref: "#/getDefinitions/configuration"
63584   connector:
63585     description: |
63586       Collection of resource instances used to connect a variety of disparate inventory widgets
63587       ###### Related Nodes
63588       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63589       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
63590       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
63591       - CONNECTOR is DELETED when these are DELETED METADATUM
63592     required:
63593     - resource-instance-id
63594     properties:
63595       resource-instance-id:
63596         type: string
63597         description: Unique id of resource instance.
63598       resource-version:
63599         type: string
63600         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63601       model-invariant-id:
63602         type: string
63603         description: the ASDC model id for this resource or service model.
63604       model-version-id:
63605         type: string
63606         description: the ASDC model version for this resource or service model.
63607       persona-model-version:
63608         type: string
63609         description: the ASDC model version for this resource or service model.
63610       widget-model-id:
63611         type: string
63612         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
63613       widget-model-version:
63614         type: string
63615         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
63616       relationship-list:
63617         type: array
63618         items:
63619           $ref: "#/getDefinitions/relationship"
63620       metadata:
63621         type: array
63622         items:
63623           $ref: "#/getDefinitions/metadatum"
63624   connectors:
63625     description: |
63626       Collection of resource instances used to connect a variety of disparate inventory widgets
63627     properties:
63628       connector:
63629         type: array
63630         items:
63631           $ref: "#/getDefinitions/connector"
63632   constrained-element-set:
63633     description: |
63634       This is how we would capture constraints defining allowed sets of elements.
63635       ###### Related Nodes
63636       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
63637       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
63638       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
63639       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
63640     required:
63641     - constrained-element-set-uuid
63642     - constraint-type
63643     - check-type
63644     properties:
63645       constrained-element-set-uuid:
63646         type: string
63647       constraint-type:
63648         type: string
63649       check-type:
63650         type: string
63651       resource-version:
63652         type: string
63653       element-choice-sets:
63654         type: array
63655         items:
63656           $ref: "#/getDefinitions/element-choice-set"
63657       relationship-list:
63658         type: array
63659         items:
63660           $ref: "#/getDefinitions/relationship"
63661   constrained-element-sets:
63662     properties:
63663       constrained-element-set:
63664         type: array
63665         items:
63666           $ref: "#/getDefinitions/constrained-element-set"
63667   ctag-assignment:
63668     description: |
63669       ###### Related Nodes
63670       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
63671       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
63672     required:
63673     - vlan-id-inner
63674     properties:
63675       vlan-id-inner:
63676         type: integer
63677         format: int64
63678         description: id.
63679       resource-version:
63680         type: string
63681         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63682       relationship-list:
63683         type: array
63684         items:
63685           $ref: "#/getDefinitions/relationship"
63686   ctag-assignments:
63687     properties:
63688       ctag-assignment:
63689         type: array
63690         items:
63691           $ref: "#/getDefinitions/ctag-assignment"
63692   ctag-pool:
63693     description: |
63694       A collection of C tags (vlan tags) grouped for a specific purpose.
63695       ###### Related Nodes
63696       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
63697       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
63698       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
63699       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
63700     required:
63701     - target-pe
63702     - availability-zone-name
63703     - ctag-pool-purpose
63704     properties:
63705       target-pe:
63706         type: string
63707         description: The Target provider edge router
63708       availability-zone-name:
63709         type: string
63710         description: Name of the availability zone
63711       ctag-pool-purpose:
63712         type: string
63713         description: Describes what the intended purpose of this pool is.
63714       ctag-values:
63715         type: string
63716         description: Comma separated list of ctags
63717       resource-version:
63718         type: string
63719         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63720       relationship-list:
63721         type: array
63722         items:
63723           $ref: "#/getDefinitions/relationship"
63724   ctag-pools:
63725     properties:
63726       ctag-pool:
63727         type: array
63728         items:
63729           $ref: "#/getDefinitions/ctag-pool"
63730   customer:
63731     description: |
63732       customer identifiers to provide linkage back to BSS information.
63733       ###### Related Nodes
63734       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
63735       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
63736     required:
63737     - global-customer-id
63738     - subscriber-name
63739     - subscriber-type
63740     properties:
63741       global-customer-id:
63742         type: string
63743         description: Global customer id used across ECOMP to uniquely identify customer.
63744       subscriber-name:
63745         type: string
63746         description: Subscriber name, an alternate way to retrieve a customer.
63747       subscriber-type:
63748         type: string
63749         description: Subscriber type, a way to provide VID with only the INFRA customers.
63750       resource-version:
63751         type: string
63752         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63753       service-subscriptions:
63754         type: array
63755         items:
63756           $ref: "#/getDefinitions/service-subscription"
63757       relationship-list:
63758         type: array
63759         items:
63760           $ref: "#/getDefinitions/relationship"
63761   customers:
63762     description: |
63763       Collection of customer identifiers to provide linkage back to BSS information.
63764     properties:
63765       customer:
63766         type: array
63767         items:
63768           $ref: "#/getDefinitions/customer"
63769   cvlan-tag-entry:
63770     required:
63771     - cvlan-tag
63772     properties:
63773       cvlan-tag:
63774         type: integer
63775         format: int64
63776         description: See mis-na-virtualization-platform.yang
63777       resource-version:
63778         type: string
63779         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63780       relationship-list:
63781         type: array
63782         items:
63783           $ref: "#/getDefinitions/relationship"
63784   cvlan-tags:
63785     properties:
63786       cvlan-tag-entry:
63787         type: array
63788         items:
63789           $ref: "#/getDefinitions/cvlan-tag-entry"
63790   dvs-switch:
63791     description: |
63792       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.
63793       ###### Related Nodes
63794       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63795       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
63796     required:
63797     - switch-name
63798     - vcenter-url
63799     properties:
63800       switch-name:
63801         type: string
63802         description: DVS switch name
63803       vcenter-url:
63804         type: string
63805         description: URL used to reach the vcenter
63806       resource-version:
63807         type: string
63808         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63809       relationship-list:
63810         type: array
63811         items:
63812           $ref: "#/getDefinitions/relationship"
63813   dvs-switches:
63814     description: |
63815       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
63816     properties:
63817       dvs-switch:
63818         type: array
63819         items:
63820           $ref: "#/getDefinitions/dvs-switch"
63821   edge-prop-names:
63822     description: |
63823       Internal map to define the properties of an edge and interpret the map EdgeRules
63824     properties:
63825       edgeLabel:
63826         type: string
63827       direction:
63828         type: string
63829       multiplicityRule:
63830         type: string
63831       contains-other-v:
63832         type: string
63833       delete-other-v:
63834         type: string
63835       SVC-INFRA:
63836         type: string
63837       prevent-delete:
63838         type: string
63839       aai-uuid:
63840         type: string
63841   edge-tag-query-request:
63842     properties:
63843       edge-tag:
63844         type: string
63845       result-detail:
63846         type: string
63847       start-node-type:
63848         type: string
63849       start-node-filter:
63850         type: array
63851         items:
63852           $ref: "#/getDefinitions/start-node-filter"
63853       include-node-filter:
63854         type: array
63855         items:
63856           $ref: "#/getDefinitions/include-node-filter"
63857       secondary-filter:
63858         type: array
63859         items:
63860           $ref: "#/getDefinitions/secondary-filter"
63861   edge-tag-query-result:
63862     properties:
63863       tagged-inventory-item-list:
63864         type: array
63865         items:
63866           $ref: "#/getDefinitions/tagged-inventory-item-list"
63867   element-choice-set:
63868     description: |
63869       This is how we would capture constraints defining allowed sets of elements.
63870       ###### Related Nodes
63871       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
63872       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
63873       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
63874     required:
63875     - element-choice-set-uuid
63876     - element-choice-set-name
63877     properties:
63878       element-choice-set-uuid:
63879         type: string
63880       element-choice-set-name:
63881         type: string
63882       cardinality:
63883         type: string
63884       resource-version:
63885         type: string
63886       model-elements:
63887         type: array
63888         items:
63889           $ref: "#/getDefinitions/model-element"
63890       relationship-list:
63891         type: array
63892         items:
63893           $ref: "#/getDefinitions/relationship"
63894   element-choice-sets:
63895     properties:
63896       element-choice-set:
63897         type: array
63898         items:
63899           $ref: "#/getDefinitions/element-choice-set"
63900   entitlement:
63901     description: |
63902       Metadata for entitlement group.
63903       ###### Related Nodes
63904       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63905       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63906     required:
63907     - group-uuid
63908     - resource-uuid
63909     properties:
63910       group-uuid:
63911         type: string
63912         description: Unique ID for the entitlement group the resource comes from, should be uuid.
63913       resource-uuid:
63914         type: string
63915         description: Unique ID of an entitlement resource.
63916       resource-version:
63917         type: string
63918         description: Concurrency value
63919       relationship-list:
63920         type: array
63921         items:
63922           $ref: "#/getDefinitions/relationship"
63923   entitlements:
63924     description: |
63925       Entitlements, keyed by group-uuid and resource-uuid, related to license management
63926     properties:
63927       entitlement:
63928         type: array
63929         items:
63930           $ref: "#/getDefinitions/entitlement"
63931   esr-ems:
63932     description: |
63933       Persist EMS address information used by EMS driver.
63934       ###### Related Nodes
63935       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
63936       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63937     required:
63938     - ems-id
63939     properties:
63940       ems-id:
63941         type: string
63942         description: Unique ID of EMS.
63943       resource-version:
63944         type: string
63945         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63946       esr-system-info-list:
63947         type: object
63948         $ref: "#/getDefinitions/esr-system-info-list"
63949       relationship-list:
63950         type: object
63951         $ref: "#/getDefinitions/relationship-list"
63952   esr-ems-list:
63953     properties:
63954       esr-ems:
63955         type: array
63956         items:
63957           $ref: "#/getDefinitions/esr-ems"
63958   esr-system-info:
63959     description: |
63960       Persist common address information of external systems.
63961       ###### Related Nodes
63962       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
63963       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
63964       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
63965       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
63966     required:
63967     - esr-system-info-id
63968     - user-name
63969     - password
63970     - system-type
63971     properties:
63972       esr-system-info-id:
63973         type: string
63974         description: Unique ID of esr system info.
63975       system-name:
63976         type: string
63977         description: name of external system.
63978       type:
63979         type: string
63980         description: type of external systems.
63981       vendor:
63982         type: string
63983         description: vendor of external systems.
63984       version:
63985         type: string
63986         description: version of external systems.
63987       service-url:
63988         type: string
63989         description: url used to access external systems.
63990       user-name:
63991         type: string
63992         description: username used to access external systems.
63993       password:
63994         type: string
63995         description: password used to access external systems.
63996       system-type:
63997         type: string
63998         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
63999       protocol:
64000         type: string
64001         description: protocol of third party SDNC, for example netconf/snmp.
64002       ssl-cacert:
64003         type: string
64004         description: ca file content if enabled ssl on auth-url.
64005       ssl-insecure:
64006         type: boolean
64007         description: Whether to verify VIM's certificate.
64008       ip-address:
64009         type: string
64010         description: service IP of ftp server.
64011       port:
64012         type: string
64013         description: service port of ftp server.
64014       cloud-domain:
64015         type: string
64016         description: domain info for authentication.
64017       default-tenant:
64018         type: string
64019         description: default tenant of VIM.
64020       passive:
64021         type: boolean
64022         description: ftp passive mode or not.
64023       remote-path:
64024         type: string
64025         description: resource or performance data file path.
64026       system-status:
64027         type: string
64028         description: the status of external system.
64029       resource-version:
64030         type: string
64031         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64032       relationship-list:
64033         type: object
64034         $ref: "#/getDefinitions/relationship-list"
64035   esr-system-info-list:
64036     description: |
64037       Collection of persistent block-level external system auth info.
64038     properties:
64039       esr-system-info:
64040         type: array
64041         items:
64042           $ref: "#/getDefinitions/esr-system-info"
64043   esr-thirdparty-sdnc:
64044     description: |
64045       Persist SDNC address information used by ONAP SDNC.
64046       ###### Related Nodes
64047       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
64048       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
64049       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
64050     required:
64051     - thirdparty-sdnc-id
64052     properties:
64053       thirdparty-sdnc-id:
64054         type: string
64055         description: Unique ID of SDNC.
64056       location:
64057         type: string
64058         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
64059       product-name:
64060         type: string
64061         description: password used to access SDNC server.
64062       resource-version:
64063         type: string
64064         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64065       esr-system-info-list:
64066         type: object
64067         $ref: "#/getDefinitions/esr-system-info-list"
64068       relationship-list:
64069         type: object
64070         $ref: "#/getDefinitions/relationship-list"
64071   esr-thirdparty-sdnc-list:
64072     properties:
64073       esr-thirdparty-sdnc:
64074         type: array
64075         items:
64076           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
64077   esr-vnfm:
64078     description: |
64079       Persist VNFM address information used by VF-C.
64080       ###### Related Nodes
64081       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
64082       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
64083     required:
64084     - vnfm-id
64085     properties:
64086       vnfm-id:
64087         type: string
64088         description: Unique ID of VNFM.
64089       vim-id:
64090         type: string
64091         description: indecate the VIM to deploy VNF.
64092       certificate-url:
64093         type: string
64094         description: certificate url of VNFM.
64095       resource-version:
64096         type: string
64097         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64098       esr-system-info-list:
64099         type: object
64100         $ref: "#/getDefinitions/esr-system-info-list"
64101       relationship-list:
64102         type: object
64103         $ref: "#/getDefinitions/relationship-list"
64104   esr-vnfm-list:
64105     properties:
64106       esr-vnfm:
64107         type: array
64108         items:
64109           $ref: "#/getDefinitions/esr-vnfm"
64110   evc:
64111     description: |
64112       evc object is an optional child object of the Configuration object.
64113       ###### Related Nodes
64114       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64115     required:
64116     - evc-id
64117     properties:
64118       evc-id:
64119         type: string
64120         description: Unique/key field for the evc object
64121       forwarding-path-topology:
64122         type: string
64123         description: Point-to-Point, Multi-Point
64124       cir-value:
64125         type: string
64126         description: Commited Information Rate
64127       cir-units:
64128         type: string
64129         description: CIR units
64130       connection-diversity-group-id:
64131         type: string
64132         description: Diversity Group ID
64133       service-hours:
64134         type: string
64135         description: formerly Performance Group
64136       esp-evc-circuit-id:
64137         type: string
64138         description: EVC Circuit ID of ESP EVC
64139       esp-evc-cir-value:
64140         type: string
64141         description: Committed Information Rate (For ESP)
64142       esp-evc-cir-units:
64143         type: string
64144         description: CIR units (For ESP)
64145       esp-itu-code:
64146         type: string
64147         description: Identifies ESP
64148       collector-pop-clli:
64149         type: string
64150         description: Collector POP CLLI (from the hostname of the access pnf)
64151       inter-connect-type-ingress:
64152         type: string
64153         description: Interconnect type on ingress side of EVC.
64154       tagmode-access-ingress:
64155         type: string
64156         description: tagode for collector side of EVC
64157       tagmode-access-egress:
64158         type: string
64159         description: tagMode for network side of EVC
64160       relationship-list:
64161         type: array
64162         items:
64163           $ref: "#/getDefinitions/relationship"
64164       resource-version:
64165         type: string
64166         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64167   evcs:
64168     properties:
64169       evc:
64170         type: array
64171         items:
64172           $ref: "#/getDefinitions/evc"
64173   external-system:
64174     description: |
64175       Namespace for external system.
64176     properties:
64177       esr-ems-list:
64178         type: object
64179         $ref: "#/getDefinitions/esr-ems-list"
64180       esr-vnfm-list:
64181         type: object
64182         $ref: "#/getDefinitions/esr-vnfm-list"
64183       esr-thirdparty-sdnc-list:
64184         type: object
64185         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
64186   extra-properties:
64187     description: |
64188       Extra properties for inventory item for response list
64189     properties:
64190       extra-property:
64191         type: array
64192         items:
64193           $ref: "#/getDefinitions/extra-property"
64194   extra-property:
64195     properties:
64196       property-name:
64197         type: string
64198       property-value:
64199         type: string
64200   flavor:
64201     description: |
64202       Openstack flavor.
64203       ###### Related Nodes
64204       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64205       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
64206       - FLAVOR cannot be deleted if linked to VSERVER
64207     required:
64208     - flavor-id
64209     - flavor-name
64210     - flavor-selflink
64211     properties:
64212       flavor-id:
64213         type: string
64214         description: Flavor id, expected to be unique across cloud-region.
64215       flavor-name:
64216         type: string
64217         description: Flavor name
64218       flavor-vcpus:
64219         type: integer
64220         format: int32
64221         description: Number of CPUs
64222       flavor-ram:
64223         type: integer
64224         format: int32
64225         description: Amount of memory
64226       flavor-disk:
64227         type: integer
64228         format: int32
64229         description: Disk space
64230       flavor-ephemeral:
64231         type: integer
64232         format: int32
64233         description: Amount of ephemeral disk space
64234       flavor-swap:
64235         type: string
64236         description: amount of swap space allocation
64237       flavor-is-public:
64238         type: boolean
64239         description: whether flavor is available to all users or private to the tenant it was created in.
64240       flavor-selflink:
64241         type: string
64242         description: URL to endpoint where AAI can get more details
64243       flavor-disabled:
64244         type: boolean
64245         description: Boolean as to whether this flavor is no longer enabled
64246       resource-version:
64247         type: string
64248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64249       relationship-list:
64250         type: array
64251         items:
64252           $ref: "#/getDefinitions/relationship"
64253   flavors:
64254     description: |
64255       Collection of openstack flavors.
64256     properties:
64257       flavor:
64258         type: array
64259         items:
64260           $ref: "#/getDefinitions/flavor"
64261   forwarder:
64262     description: |
64263       Entity describing a sequenced segment of forwarding path
64264       ###### Related Nodes
64265       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
64266       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
64267       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64268       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
64269       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
64270       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
64271     required:
64272     - sequence
64273     properties:
64274       sequence:
64275         type: integer
64276         format: int32
64277         description: Unique ID of this segmentation
64278       forwarder-role:
64279         type: string
64280         description: ingress, intermediate, egress
64281       relationship-list:
64282         type: array
64283         items:
64284           $ref: "#/getDefinitions/relationship"
64285       resource-version:
64286         type: string
64287         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64288   forwarder-evc:
64289     description: |
64290       forwarder object is an optional child object of the Configuration object.
64291       ###### Related Nodes
64292       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64293     required:
64294     - forwarder-evc-id
64295     properties:
64296       forwarder-evc-id:
64297         type: string
64298         description: Key for forwarder-evc object
64299       circuit-id:
64300         type: string
64301         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
64302       ivlan:
64303         type: string
64304         description: Internal VLAN.
64305       svlan:
64306         type: string
64307         description: SVLAN value for ingress of egress forwarder.
64308       cvlan:
64309         type: string
64310         description: CVLAN value for ingress of egress forwarder.
64311       relationship-list:
64312         type: array
64313         items:
64314           $ref: "#/getDefinitions/relationship"
64315       resource-version:
64316         type: string
64317         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64318   forwarder-evcs:
64319     properties:
64320       forwarder-evc:
64321         type: array
64322         items:
64323           $ref: "#/getDefinitions/forwarder-evc"
64324   forwarders:
64325     properties:
64326       forwarder:
64327         type: array
64328         items:
64329           $ref: "#/getDefinitions/forwarder"
64330   forwarding-path:
64331     description: |
64332       Entity that describes the sequenced forwarding path between interfaces of services or resources
64333       ###### Related Nodes
64334       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
64335       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64336       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
64337       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
64338       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
64339     required:
64340     - forwarding-path-id
64341     - forwarding-path-name
64342     properties:
64343       forwarding-path-id:
64344         type: string
64345         description: Unique ID of this FP
64346       forwarding-path-name:
64347         type: string
64348         description: Name of the FP
64349       relationship-list:
64350         type: array
64351         items:
64352           $ref: "#/getDefinitions/relationship"
64353       resource-version:
64354         type: string
64355         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64356       selflink:
64357         type: string
64358         description: the self link for this FP
64359       forwarders:
64360         type: array
64361         items:
64362           $ref: "#/getDefinitions/forwarder"
64363   forwarding-paths:
64364     properties:
64365       forwarding-path:
64366         type: array
64367         items:
64368           $ref: "#/getDefinitions/forwarding-path"
64369   generic-vnf:
64370     description: |
64371       General purpose VNF
64372       ###### Related Nodes
64373       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
64374       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
64375       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
64376       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
64377       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64378       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
64379       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64380       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
64381       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
64382       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
64383       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
64384       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
64385       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
64386       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64387       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
64388       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
64389       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64390       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64391       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64392       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64393       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64394       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
64395       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
64396       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
64397       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64398       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
64399       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
64400       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
64401       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
64402       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
64403     required:
64404     - vnf-id
64405     - vnf-instance-id
64406     - vnf-name
64407     - vnf-type
64408     - vnf-package-name
64409     - vnf-discriptor-name
64410     - job-id
64411     - in-maint
64412     - is-closed-loop-disabled
64413     properties:
64414       vnf-id:
64415         type: string
64416         description: Unique id of VNF.  This is unique across the graph.
64417       vnf-instance-id:
64418         type: string
64419         description: vnf instance id.
64420       vnf-name:
64421         type: string
64422         description: Name of VNF.
64423       vnf-name2:
64424         type: string
64425         description: Alternate name of VNF.
64426       vnf-type:
64427         type: string
64428         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.
64429       service-id:
64430         type: string
64431         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
64432       regional-resource-zone:
64433         type: string
64434         description: Regional way of organizing pservers, source of truth should define values
64435       prov-status:
64436         type: string
64437         description: Trigger for operational monitoring of this resource by Service Assurance systems.
64438       operational-status:
64439         type: string
64440         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
64441       license-key:
64442         type: string
64443         description: OBSOLETE -  do not use
64444       equipment-role:
64445         type: string
64446         description: Client should send valid enumerated value
64447       orchestration-status:
64448         type: string
64449         description: Orchestration status of this VNF, used by MSO.
64450       vnf-package-name:
64451         type: string
64452       vnf-discriptor-name:
64453         type: string
64454         description: vnf discriptor name
64455       job-id:
64456         type: string
64457         description: job id corresponding to vnf
64458       heat-stack-id:
64459         type: string
64460         description: Heat stack id corresponding to this instance, managed by MSO
64461       mso-catalog-key:
64462         type: string
64463         description: Corresponds to the SDN-C catalog id used to configure this VCE
64464       management-option:
64465         type: string
64466         description: identifier of managed by ATT or customer
64467       ipv4-oam-address:
64468         type: string
64469         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
64470       ipv4-loopback0-address:
64471         type: string
64472         description: v4 Loopback0 address
64473       nm-lan-v6-address:
64474         type: string
64475         description: v6 Loopback address
64476       management-v6-address:
64477         type: string
64478         description: v6 management address
64479       vcpu:
64480         type: integer
64481         format: int64
64482         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
64483       vcpu-units:
64484         type: string
64485         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
64486       vmemory:
64487         type: integer
64488         format: int64
64489         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
64490       vmemory-units:
64491         type: string
64492         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
64493       vdisk:
64494         type: integer
64495         format: int64
64496         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
64497       vdisk-units:
64498         type: string
64499         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
64500       nshd:
64501         type: integer
64502         format: int64
64503         description: number of associated SHD in vnf.
64504       nvm:
64505         type: integer
64506         format: int64
64507         description: number of vms in vnf.
64508       nnet:
64509         type: integer
64510         format: int64
64511         description: number of network in vnf.
64512       in-maint:
64513         type: boolean
64514       is-closed-loop-disabled:
64515         type: boolean
64516       resource-version:
64517         type: string
64518         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64519       summary-status:
64520         type: string
64521         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
64522       encrypted-access-flag:
64523         type: boolean
64524         description: indicates whether generic-vnf access uses SSH
64525       entitlement-assignment-group-uuid:
64526         type: string
64527         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
64528       entitlement-resource-uuid:
64529         type: string
64530         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
64531       license-assignment-group-uuid:
64532         type: string
64533         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
64534       license-key-uuid:
64535         type: string
64536         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
64537       model-invariant-id:
64538         type: string
64539         description: the ASDC model id for this resource or service model.
64540       model-version-id:
64541         type: string
64542         description: the ASDC model version for this resource or service model.
64543       persona-model-version:
64544         type: string
64545         description: the ASDC model version for this resource or service model.
64546       model-customization-id:
64547         type: string
64548         description: captures the id of all the configuration used to customize the resource for the service.
64549       widget-model-id:
64550         type: string
64551         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64552       widget-model-version:
64553         type: string
64554         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64555       as-number:
64556         type: string
64557         description: as-number of the VNF
64558       regional-resource-subzone:
64559         type: string
64560         description: represents sub zone of the rr plane
64561       nf-type:
64562         type: string
64563         description: Generic description of the type of NF
64564       nf-function:
64565         type: string
64566         description: English description of Network function that the specific VNF deployment is providing
64567       nf-role:
64568         type: string
64569         description: role in the network that this model will be providing
64570       nf-naming-code:
64571         type: string
64572         description: string assigned to this model used for naming purposes
64573       selflink:
64574         type: string
64575         description: Path to the controller object.
64576       ipv4-oam-gateway-address:
64577         type: string
64578         description: Gateway address
64579       ipv4-oam-gateway-address-prefix-length:
64580         type: integer
64581         format: int32
64582         description: Prefix length for oam-address
64583       vlan-id-outer:
64584         type: integer
64585         format: int64
64586         description: Temporary location for S-TAG to get to VCE
64587       nm-profile-name:
64588         type: string
64589         description: Network Management profile of this VNF
64590       relationship-list:
64591         type: array
64592         items:
64593           $ref: "#/getDefinitions/relationship"
64594       l-interfaces:
64595         type: array
64596         items:
64597           $ref: "#/getDefinitions/l-interface"
64598       lag-interfaces:
64599         type: array
64600         items:
64601           $ref: "#/getDefinitions/lag-interface"
64602       vf-modules:
64603         type: array
64604         items:
64605           $ref: "#/getDefinitions/vf-module"
64606       licenses:
64607         type: array
64608         items:
64609           $ref: "#/getDefinitions/license"
64610       entitlements:
64611         type: array
64612         items:
64613           $ref: "#/getDefinitions/entitlement"
64614   generic-vnfs:
64615     description: |
64616       Collection of VNFs
64617     properties:
64618       generic-vnf:
64619         type: array
64620         items:
64621           $ref: "#/getDefinitions/generic-vnf"
64622   group-assignment:
64623     description: |
64624       Openstack group-assignment used to store exclusivity groups (EG).
64625       ###### Related Nodes
64626       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64627       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
64628       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
64629     required:
64630     - group-id
64631     - group-type
64632     - group-name
64633     properties:
64634       group-id:
64635         type: string
64636         description: Group id, expected to be unique across cloud-region.
64637       group-type:
64638         type: string
64639         description: Group type - the type of group this instance refers to
64640       group-name:
64641         type: string
64642         description: Group name - name assigned to the group
64643       group-description:
64644         type: string
64645         description: Group description - description of the group
64646       resource-version:
64647         type: string
64648         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64649       relationship-list:
64650         type: array
64651         items:
64652           $ref: "#/getDefinitions/relationship"
64653   group-assignments:
64654     description: |
64655       Collection of openstack group assignments
64656     properties:
64657       group-assignment:
64658         type: array
64659         items:
64660           $ref: "#/getDefinitions/group-assignment"
64661   host-route:
64662     description: |
64663       ###### Related Nodes
64664       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
64665     required:
64666     - host-route-id
64667     - route-prefix
64668     - next-hop
64669     properties:
64670       host-route-id:
64671         type: string
64672         description: host-route id
64673       route-prefix:
64674         type: string
64675         description: subnet prefix
64676       next-hop:
64677         type: string
64678         description: Could be ip-address, hostname, or service-instance
64679       next-hop-type:
64680         type: string
64681         description: Should be ip-address, hostname, or service-instance to match next-hop
64682       resource-version:
64683         type: string
64684         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64685       relationship-list:
64686         type: array
64687         items:
64688           $ref: "#/getDefinitions/relationship"
64689   host-routes:
64690     properties:
64691       host-route:
64692         type: array
64693         items:
64694           $ref: "#/getDefinitions/host-route"
64695   image:
64696     description: |
64697       Openstack image.
64698       ###### Related Nodes
64699       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64700       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
64701       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
64702       - IMAGE cannot be deleted if linked to VSERVER
64703       - IMAGE is DELETED when these are DELETED METADATUM
64704     required:
64705     - image-id
64706     - image-name
64707     - image-os-distro
64708     - image-os-version
64709     - image-selflink
64710     properties:
64711       image-id:
64712         type: string
64713         description: Image id, expected to be unique across cloud region
64714       image-name:
64715         type: string
64716         description: Image name
64717       image-architecture:
64718         type: string
64719         description: Operating system architecture.
64720       image-os-distro:
64721         type: string
64722         description: The common name of the operating system distribution in lowercase
64723       image-os-version:
64724         type: string
64725         description: The operating system version as specified by the distributor.
64726       application:
64727         type: string
64728         description: The application that the image instantiates.
64729       application-vendor:
64730         type: string
64731         description: The vendor of the application.
64732       application-version:
64733         type: string
64734         description: The version of the application.
64735       image-selflink:
64736         type: string
64737         description: URL to endpoint where AAI can get more details
64738       resource-version:
64739         type: string
64740         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64741       relationship-list:
64742         type: array
64743         items:
64744           $ref: "#/getDefinitions/relationship"
64745       metadata:
64746         type: array
64747         items:
64748           $ref: "#/getDefinitions/metadatum"
64749   images:
64750     description: |
64751       Collectio of Openstack images.
64752     properties:
64753       image:
64754         type: array
64755         items:
64756           $ref: "#/getDefinitions/image"
64757   include-node-filter:
64758     properties:
64759       include-node-type:
64760         type: string
64761   instance-filter:
64762     description: |
64763       InstanceFilter for performing a named-query or model query
64764   instance-filters:
64765     description: |
64766       InstanceFilters for performing a named-query or model query
64767     properties:
64768       instance-filter:
64769         type: array
64770         items:
64771           $ref: "#/getDefinitions/instance-filter"
64772   instance-group:
64773     description: |
64774       General mechanism for grouping instances
64775       ###### Related Nodes
64776       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
64777       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64778       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64779       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64780       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64781       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64782       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64783       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64784       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64785       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64786       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64787       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64788     required:
64789     - instance-group-role
64790     - model-invariant-id
64791     - model-version-id
64792     - id
64793     - description
64794     - type
64795     properties:
64796       instance-group-role:
64797         type: string
64798         description: role of the instance group.
64799       model-invariant-id:
64800         type: string
64801         description: ASDC model id for this resource or service model.
64802       model-version-id:
64803         type: string
64804         description: ASDC model version uid for this resource model.
64805       id:
64806         type: string
64807         description: Instance Group ID, UUID assigned to this instance.
64808       description:
64809         type: string
64810         description: Descriptive text to help identify the usage of this instance-group
64811       type:
64812         type: string
64813         description: Only valid value today is lower case ha for high availability
64814       sub-type:
64815         type: string
64816         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
64817       resource-version:
64818         type: string
64819         description: Concurrency value
64820       relationship-list:
64821         type: array
64822         items:
64823           $ref: "#/getDefinitions/relationship"
64824   instance-groups:
64825     description: |
64826       Collection of openstack route table references
64827     properties:
64828       instance-group:
64829         type: array
64830         items:
64831           $ref: "#/getDefinitions/instance-group"
64832   inventory:
64833     properties:
64834       search:
64835         type: object
64836         $ref: "#/getDefinitions/search"
64837       actions:
64838         type: object
64839         $ref: "#/getDefinitions/actions"
64840       cloud-infrastructure:
64841         type: object
64842         $ref: "#/getDefinitions/cloud-infrastructure"
64843       external-system:
64844         type: object
64845         $ref: "#/getDefinitions/external-system"
64846       business:
64847         type: object
64848         $ref: "#/getDefinitions/business"
64849       service-design-and-creation:
64850         type: object
64851         $ref: "#/getDefinitions/service-design-and-creation"
64852       network:
64853         type: object
64854         $ref: "#/getDefinitions/network"
64855       aai-internal:
64856         type: object
64857         $ref: "#/getDefinitions/aai-internal"
64858       nodes:
64859         type: array
64860         items:
64861           $ref: "#/getDefinitions/aai-internal"
64862   inventory-item:
64863     properties:
64864       inventory-item-type:
64865         type: string
64866       inventory-item-link:
64867         type: string
64868       inventory-item-data:
64869         type: array
64870         items:
64871           $ref: "#/getDefinitions/inventory-item-data"
64872       tagged-inventory-item-list:
64873         type: array
64874         items:
64875           $ref: "#/getDefinitions/tagged-inventory-item-list"
64876   inventory-item-data:
64877     properties:
64878       property-name:
64879         type: string
64880       property-value:
64881         type: string
64882   inventory-response-item:
64883     description: |
64884       Inventory item for response list
64885     properties:
64886       model-name:
64887         type: string
64888       extra-properties:
64889         type: object
64890         $ref: "#/getDefinitions/extra-properties"
64891       inventory-response-items:
64892         type: object
64893         $ref: "#/getDefinitions/inventory-response-items"
64894   inventory-response-items:
64895     description: |
64896       Container for inventory items in response list
64897     properties:
64898       inventory-response-item:
64899         type: array
64900         items:
64901           $ref: "#/getDefinitions/inventory-response-item"
64902   ipsec-configuration:
64903     description: |
64904       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
64905       ###### Related Nodes
64906       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
64907       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
64908       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
64909     required:
64910     - ipsec-configuration-id
64911     properties:
64912       ipsec-configuration-id:
64913         type: string
64914         description: UUID of this configuration
64915       requested-vig-address-type:
64916         type: string
64917         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
64918       requested-encryption-strength:
64919         type: string
64920         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
64921       requested-dmz-type:
64922         type: string
64923         description: ATT can offer a shared DMZ or a DMZ specific to a customer
64924       shared-dmz-network-address:
64925         type: string
64926         description: Network address of shared DMZ
64927       requested-customer-name:
64928         type: string
64929         description: If the DMZ is a custom DMZ, this field will indicate the customer information
64930       ike-version:
64931         type: string
64932         description: can be 1 or 2
64933       ikev1-authentication:
64934         type: string
64935         description: Contains values like md5, sha1, sha256, sha384
64936       ikev1-encryption:
64937         type: string
64938         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
64939       ikev1-dh-group:
64940         type: string
64941         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
64942       ikev1-am-group-id:
64943         type: string
64944         description: Group name defined in VIG for clients using aggressive mode
64945       ikev1-am-password:
64946         type: string
64947         description: pre-shared key for the above group name
64948       ikev1-sa-lifetime:
64949         type: string
64950         description: Lifetime for IKEv1 SA
64951       ipsec-authentication:
64952         type: string
64953         description: md5, sha1, sha256, sha384
64954       ipsec-encryption:
64955         type: string
64956         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
64957       ipsec-sa-lifetime:
64958         type: string
64959         description: Life time for IPSec SA
64960       ipsec-pfs:
64961         type: string
64962         description: enable PFS or not
64963       xauth-userid:
64964         type: string
64965         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
64966       xauth-user-password:
64967         type: string
64968         description: Encrypted using the Juniper $9$ algorithm
64969       dpd-interval:
64970         type: string
64971         description: The time between DPD probe
64972       dpd-frequency:
64973         type: string
64974         description: Maximum number of DPD before claiming the tunnel is down
64975       resource-version:
64976         type: string
64977         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64978       relationship-list:
64979         type: array
64980         items:
64981           $ref: "#/getDefinitions/relationship"
64982       vig-servers:
64983         type: array
64984         items:
64985           $ref: "#/getDefinitions/vig-server"
64986   ipsec-configurations:
64987     properties:
64988       ipsec-configuration:
64989         type: array
64990         items:
64991           $ref: "#/getDefinitions/ipsec-configuration"
64992   key-data:
64993     properties:
64994       key-name:
64995         type: string
64996       key-value:
64997         type: string
64998   l-interface:
64999     description: |
65000       Logical interfaces, e.g., a vnic.
65001       ###### Related Nodes
65002       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65003       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
65004       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65005       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65006       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
65007       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
65008       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
65009       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
65010       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
65011       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65012       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65013       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
65014       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
65015       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
65016       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
65017       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
65018       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
65019       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65020       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
65021       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
65022     required:
65023     - interface-name
65024     - is-port-mirrored
65025     - in-maint
65026     - is-ip-unnumbered
65027     properties:
65028       interface-name:
65029         type: string
65030         description: Name given to the interface
65031       interface-role:
65032         type: string
65033         description: E.g., CUSTOMER, UPLINK, etc.
65034       v6-wan-link-ip:
65035         type: string
65036         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
65037       selflink:
65038         type: string
65039         description: URL to endpoint where AAI can get more details
65040       interface-id:
65041         type: string
65042         description: ID of interface
65043       macaddr:
65044         type: string
65045         description: MAC address for the interface
65046       network-name:
65047         type: string
65048         description: Name of the network
65049       management-option:
65050         type: string
65051         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
65052       interface-description:
65053         type: string
65054         description: Human friendly text regarding this interface.
65055       is-port-mirrored:
65056         type: boolean
65057       resource-version:
65058         type: string
65059         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65060       in-maint:
65061         type: boolean
65062       prov-status:
65063         type: string
65064         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
65065       is-ip-unnumbered:
65066         type: boolean
65067       allowed-address-pairs:
65068         type: string
65069         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
65070       vlans:
65071         type: array
65072         items:
65073           $ref: "#/getDefinitions/vlan"
65074       sriov-vfs:
65075         type: array
65076         items:
65077           $ref: "#/getDefinitions/sriov-vf"
65078       l-interfaces:
65079         type: array
65080         items:
65081           $ref: "#/getDefinitions/l-interface"
65082       relationship-list:
65083         type: array
65084         items:
65085           $ref: "#/getDefinitions/relationship"
65086       l3-interface-ipv4-address-list:
65087         type: array
65088         items:
65089           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
65090       l3-interface-ipv6-address-list:
65091         type: array
65092         items:
65093           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
65094   l-interfaces:
65095     description: |
65096       Collection of logical interfaces.
65097     properties:
65098       l-interface:
65099         type: array
65100         items:
65101           $ref: "#/getDefinitions/l-interface"
65102   l3-interface-ipv4-address-list:
65103     description: |
65104       IPv4 Address Range
65105       ###### Related Nodes
65106       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
65107       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
65108       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
65109       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65110       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
65111       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
65112     required:
65113     - l3-interface-ipv4-address
65114     properties:
65115       l3-interface-ipv4-address:
65116         type: string
65117         description: IP address
65118       l3-interface-ipv4-prefix-length:
65119         type: integer
65120         format: int64
65121         description: Prefix length, 32 for single address
65122       vlan-id-inner:
65123         type: integer
65124         format: int64
65125         description: Inner VLAN tag
65126       vlan-id-outer:
65127         type: integer
65128         format: int64
65129         description: Outer VLAN tag
65130       is-floating:
65131         type: boolean
65132         description: Indicator of fixed or floating address
65133       resource-version:
65134         type: string
65135         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65136       neutron-network-id:
65137         type: string
65138         description: Neutron network id of the interface that address belongs to
65139       neutron-subnet-id:
65140         type: string
65141         description: Neutron id of subnet that address belongs to
65142       relationship-list:
65143         type: array
65144         items:
65145           $ref: "#/getDefinitions/relationship"
65146   l3-interface-ipv6-address-list:
65147     description: |
65148       IPv6 Address Range
65149       ###### Related Nodes
65150       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
65151       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
65152       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
65153       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
65154       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
65155       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
65156     required:
65157     - l3-interface-ipv6-address
65158     properties:
65159       l3-interface-ipv6-address:
65160         type: string
65161         description: IP address
65162       l3-interface-ipv6-prefix-length:
65163         type: integer
65164         format: int64
65165         description: Prefix length, 128 for single address
65166       vlan-id-inner:
65167         type: integer
65168         format: int64
65169         description: Inner VLAN tag
65170       vlan-id-outer:
65171         type: integer
65172         format: int64
65173         description: Outer VLAN tag
65174       is-floating:
65175         type: boolean
65176         description: Indicator of fixed or floating address
65177       resource-version:
65178         type: string
65179         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65180       neutron-network-id:
65181         type: string
65182         description: Neutron network id of the interface that address belongs to
65183       neutron-subnet-id:
65184         type: string
65185         description: Neutron id of subnet that address belongs to
65186       relationship-list:
65187         type: array
65188         items:
65189           $ref: "#/getDefinitions/relationship"
65190   l3-network:
65191     description: |
65192       Generic network definition
65193       ###### Related Nodes
65194       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65195       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
65196       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
65197       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
65198       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
65199       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
65200       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65201       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65202       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65203       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
65204       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
65205       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
65206       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
65207       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
65208       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
65209       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65210       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
65211       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
65212     required:
65213     - network-id
65214     - network-name
65215     - is-bound-to-vpn
65216     - is-provider-network
65217     - is-shared-network
65218     - is-external-network
65219     properties:
65220       network-id:
65221         type: string
65222         description: Network ID, should be uuid. Unique across A&AI.
65223       network-name:
65224         type: string
65225         description: Name of the network, governed by some naming convention..
65226       network-type:
65227         type: string
65228         description: Type of the network - who defines these values?
65229       network-role:
65230         type: string
65231         description: Role the network plans - who defines these values?
65232       network-technology:
65233         type: string
65234         description: Network technology - who defines these values?
65235       neutron-network-id:
65236         type: string
65237         description: Neutron network id of this Interface
65238       is-bound-to-vpn:
65239         type: boolean
65240       service-id:
65241         type: string
65242         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
65243       network-role-instance:
65244         type: integer
65245         format: int64
65246         description: network role instance
65247       resource-version:
65248         type: string
65249         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65250       orchestration-status:
65251         type: string
65252         description: Orchestration status of this VNF, mastered by MSO
65253       heat-stack-id:
65254         type: string
65255         description: Heat stack id corresponding to this instance, managed by MSO
65256       mso-catalog-key:
65257         type: string
65258         description: Corresponds to the SDN-C catalog id used to configure this VCE
65259       contrail-network-fqdn:
65260         type: string
65261         description: Contrail FQDN for the network
65262       model-invariant-id:
65263         type: string
65264         description: the ASDC model id for this resource or service model.
65265       model-version-id:
65266         type: string
65267         description: the ASDC model version for this resource or service model.
65268       persona-model-version:
65269         type: string
65270         description: the ASDC model version for this resource or service model.
65271       model-customization-id:
65272         type: string
65273         description: captures the id of all the configuration used to customize the resource for the service.
65274       widget-model-id:
65275         type: string
65276         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
65277       widget-model-version:
65278         type: string
65279         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
65280       physical-network-name:
65281         type: string
65282         description: Name associated with the physical network.
65283       is-provider-network:
65284         type: boolean
65285       is-shared-network:
65286         type: boolean
65287       is-external-network:
65288         type: boolean
65289       selflink:
65290         type: string
65291         description: Path to the controller object.
65292       operational-status:
65293         type: string
65294         description: Indicator for whether the resource is considered operational.
65295       subnets:
65296         type: array
65297         items:
65298           $ref: "#/getDefinitions/subnet"
65299       ctag-assignments:
65300         type: array
65301         items:
65302           $ref: "#/getDefinitions/ctag-assignment"
65303       segmentation-assignments:
65304         type: array
65305         items:
65306           $ref: "#/getDefinitions/segmentation-assignment"
65307       relationship-list:
65308         type: array
65309         items:
65310           $ref: "#/getDefinitions/relationship"
65311         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
65312   l3-networks:
65313     properties:
65314       l3-network:
65315         type: array
65316         items:
65317           $ref: "#/getDefinitions/l3-network"
65318   lag-interface:
65319     description: |
65320       Link aggregate interface
65321       ###### Related Nodes
65322       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65323       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
65324       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
65325       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
65326       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65327       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65328       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
65329       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
65330       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
65331       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
65332       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
65333     required:
65334     - interface-name
65335     - in-maint
65336     properties:
65337       interface-name:
65338         type: string
65339         description: Name that identifies the link aggregate interface
65340       interface-description:
65341         type: string
65342         description: Human friendly text regarding this interface.
65343       resource-version:
65344         type: string
65345         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65346       speed-value:
65347         type: string
65348         description: Captures the numeric part of the speed
65349       speed-units:
65350         type: string
65351         description: Captures the units corresponding to the speed
65352       interface-id:
65353         type: string
65354         description: ID of interface
65355       interface-role:
65356         type: string
65357         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
65358       prov-status:
65359         type: string
65360         description: Trigger for operational monitoring of this resource by Service Assurance systems.
65361       in-maint:
65362         type: boolean
65363       relationship-list:
65364         type: array
65365         items:
65366           $ref: "#/getDefinitions/relationship"
65367       l-interfaces:
65368         type: array
65369         items:
65370           $ref: "#/getDefinitions/l-interface"
65371   lag-interfaces:
65372     description: |
65373       Collection of link aggregate interfaces.
65374     properties:
65375       lag-interface:
65376         type: array
65377         items:
65378           $ref: "#/getDefinitions/lag-interface"
65379   lag-link:
65380     description: |
65381       LAG links can connect lag-interfaces
65382       ###### Related Nodes
65383       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
65384       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
65385     required:
65386     - link-name
65387     properties:
65388       link-name:
65389         type: string
65390         description: Alphabetical concatenation of lag-interface names
65391       resource-version:
65392         type: string
65393         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65394       relationship-list:
65395         type: array
65396         items:
65397           $ref: "#/getDefinitions/relationship"
65398   lag-links:
65399     description: |
65400       Collection of link aggregation connections
65401     properties:
65402       lag-link:
65403         type: array
65404         items:
65405           $ref: "#/getDefinitions/lag-link"
65406   license:
65407     description: |
65408       Metadata for license group.
65409       ###### Related Nodes
65410       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65411       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
65412     required:
65413     - group-uuid
65414     - resource-uuid
65415     properties:
65416       group-uuid:
65417         type: string
65418         description: Unique ID for the license group the resource belongs to, should be uuid.
65419       resource-uuid:
65420         type: string
65421         description: Unique ID of a license resource.
65422       resource-version:
65423         type: string
65424         description: Concurrency value
65425       relationship-list:
65426         type: array
65427         items:
65428           $ref: "#/getDefinitions/relationship"
65429   licenses:
65430     description: |
65431       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
65432     properties:
65433       license:
65434         type: array
65435         items:
65436           $ref: "#/getDefinitions/license"
65437   line-of-business:
65438     description: |
65439       describes a line-of-business
65440       ###### Related Nodes
65441       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65442     required:
65443     - line-of-business-name
65444     properties:
65445       line-of-business-name:
65446         type: string
65447         description: Name of the line-of-business (product)
65448       resource-version:
65449         type: string
65450         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65451       relationship-list:
65452         type: array
65453         items:
65454           $ref: "#/getDefinitions/relationship"
65455   lines-of-business:
65456     description: |
65457       Collection of lines-of-business
65458     properties:
65459       line-of-business:
65460         type: array
65461         items:
65462           $ref: "#/getDefinitions/line-of-business"
65463   logical-link:
65464     description: |
65465       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
65466       ###### Related Nodes
65467       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
65468       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
65469       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
65470       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
65471       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
65472       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
65473       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
65474       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
65475       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
65476       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
65477       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
65478       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
65479       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
65480       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
65481       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
65482       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
65483       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
65484       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
65485     required:
65486     - link-name
65487     - in-maint
65488     - link-type
65489     properties:
65490       link-name:
65491         type: string
65492         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
65493       in-maint:
65494         type: boolean
65495       link-type:
65496         type: string
65497         description: Type of logical link, e.g., evc
65498       speed-value:
65499         type: string
65500         description: Captures the numeric part of the speed
65501       speed-units:
65502         type: string
65503         description: Captures the units corresponding to the speed
65504       ip-version:
65505         type: string
65506         description: v4, v6, or ds for dual stack
65507       routing-protocol:
65508         type: string
65509         description: For example, static or BGP
65510       resource-version:
65511         type: string
65512         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65513       model-invariant-id:
65514         type: string
65515         description: the ASDC model id for this resource or service model.
65516       model-version-id:
65517         type: string
65518         description: the ASDC model version for this resource or service model.
65519       persona-model-version:
65520         type: string
65521         description: the ASDC model version for this resource or service model.
65522       widget-model-id:
65523         type: string
65524         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
65525       widget-model-version:
65526         type: string
65527         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
65528       operational-status:
65529         type: string
65530         description: Indication of operational status of the logical link.
65531       prov-status:
65532         type: string
65533         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
65534       link-role:
65535         type: string
65536         description: Indication of the network use of the logical link.
65537       link-name2:
65538         type: string
65539         description: Alias or alternate name (CLCI or D1 name).
65540       link-id:
65541         type: string
65542         description: UUID of the logical-link, SDNC generates this.
65543       circuit-id:
65544         type: string
65545         description: Circuit id
65546       purpose:
65547         type: string
65548         description: Reason for this entity, role it is playing
65549       relationship-list:
65550         type: array
65551         items:
65552           $ref: "#/getDefinitions/relationship"
65553   logical-links:
65554     description: |
65555       Collection of logical connections
65556     properties:
65557       logical-link:
65558         type: array
65559         items:
65560           $ref: "#/getDefinitions/logical-link"
65561   metadata:
65562     description: |
65563       Collection of metadatum (key/value pairs)
65564     properties:
65565       metadatum:
65566         type: array
65567         items:
65568           $ref: "#/getDefinitions/metadatum"
65569   metadatum:
65570     description: |
65571       Key/value pairs
65572       ###### Related Nodes
65573       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
65574       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
65575       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
65576       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
65577       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
65578     required:
65579     - metaname
65580     - metaval
65581     properties:
65582       metaname:
65583         type: string
65584       metaval:
65585         type: string
65586       resource-version:
65587         type: string
65588         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65589   model:
65590     description: |
65591       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
65592       ###### Related Nodes
65593       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
65594       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
65595       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
65596       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
65597       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
65598       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
65599       - MODEL is DELETED when these are DELETED MODEL-VER
65600     required:
65601     - model-invariant-id
65602     - model-type
65603     properties:
65604       model-invariant-id:
65605         type: string
65606         description: Unique identifier corresponding to the main definition of a model in ASDC
65607       model-type:
65608         type: string
65609         description: Type of the model, e.g., service, resource, widget, etc.
65610       resource-version:
65611         type: string
65612         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65613       model-vers:
65614         type: array
65615         items:
65616           $ref: "#/getDefinitions/model-ver"
65617       relationship-list:
65618         type: array
65619         items:
65620           $ref: "#/getDefinitions/relationship"
65621   model-and-named-query-search:
65622     description: |
65623       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
65624     properties:
65625       query-parameters:
65626         type: object
65627         $ref: "#/getDefinitions/query-parameters"
65628       instance-filters:
65629         type: object
65630         $ref: "#/getDefinitions/instance-filters"
65631       secondary-filts:
65632         type: object
65633         $ref: "#/getDefinitions/secondary-filts"
65634       top-node-type:
65635         type: string
65636       secondary-filter-cut-point:
65637         type: string
65638   model-constraint:
65639     description: |
65640       This is how we would capture constraints defining allowed sets of elements.
65641       ###### Related Nodes
65642       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65643       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
65644       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
65645     required:
65646     - model-constraint-uuid
65647     - constrained-element-set-uuid-to-replace
65648     properties:
65649       model-constraint-uuid:
65650         type: string
65651       constrained-element-set-uuid-to-replace:
65652         type: string
65653       constrained-element-sets:
65654         type: array
65655         items:
65656           $ref: "#/getDefinitions/constrained-element-set"
65657       resource-version:
65658         type: string
65659         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65660   model-constraints:
65661     properties:
65662       model-constraint:
65663         type: array
65664         items:
65665           $ref: "#/getDefinitions/model-constraint"
65666   model-element:
65667     description: |
65668       Defines how other models combine to make up a higher-level model.
65669       ###### Related Nodes
65670       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
65671       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65672       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
65673       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
65674       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65675       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65676       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65677       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
65678     required:
65679     - model-element-uuid
65680     - new-data-del-flag
65681     - cardinality
65682     properties:
65683       model-element-uuid:
65684         type: string
65685       new-data-del-flag:
65686         type: string
65687         description: Indicates whether this element was created as part of instantiation from this model
65688       cardinality:
65689         type: string
65690         description: How many of this type of element are required/allowed
65691       linkage-points:
65692         type: string
65693       resource-version:
65694         type: string
65695         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65696       model-elements:
65697         type: array
65698         items:
65699           $ref: "#/getDefinitions/model-element"
65700         description: Defines how other models combine to make up a higher-level model
65701       model-constraints:
65702         type: array
65703         items:
65704           $ref: "#/getDefinitions/model-constraint"
65705         description: Describes new constraints on this model element that are not part of that model's definition
65706       relationship-list:
65707         type: array
65708         items:
65709           $ref: "#/getDefinitions/relationship"
65710   model-elements:
65711     properties:
65712       model-element:
65713         type: array
65714         items:
65715           $ref: "#/getDefinitions/model-element"
65716   model-ver:
65717     description: |
65718       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
65719       ###### Related Nodes
65720       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
65721       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
65722       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
65723       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
65724       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
65725       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
65726       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
65727       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
65728       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
65729       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
65730       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
65731       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
65732     required:
65733     - model-version-id
65734     - model-name
65735     - model-version
65736     properties:
65737       model-version-id:
65738         type: string
65739         description: Unique identifier corresponding to one version of a model in ASDC
65740       model-name:
65741         type: string
65742         description: Name of the model, which can change from version to version.
65743       model-version:
65744         type: string
65745         description: Version
65746       distribution-status:
65747         type: string
65748         description: Distribution Status
65749       model-description:
65750         type: string
65751         description: Description
65752       resource-version:
65753         type: string
65754         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65755       model-elements:
65756         type: array
65757         items:
65758           $ref: "#/getDefinitions/model-element"
65759       metadata:
65760         type: array
65761         items:
65762           $ref: "#/getDefinitions/metadatum"
65763       relationship-list:
65764         type: array
65765         items:
65766           $ref: "#/getDefinitions/relationship"
65767   model-vers:
65768     properties:
65769       model-ver:
65770         type: array
65771         items:
65772           $ref: "#/getDefinitions/model-ver"
65773   models:
65774     description: |
65775       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
65776     properties:
65777       model:
65778         type: array
65779         items:
65780           $ref: "#/getDefinitions/model"
65781   multicast-configuration:
65782     description: |
65783       ###### Related Nodes
65784       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
65785     required:
65786     - multicast-configuration-id
65787     - multicast-protocol
65788     - rp-type
65789     properties:
65790       multicast-configuration-id:
65791         type: string
65792         description: Unique id of multicast configuration.
65793       multicast-protocol:
65794         type: string
65795         description: protocol of multicast configuration
65796       rp-type:
65797         type: string
65798         description: rp type of multicast configuration
65799       resource-version:
65800         type: string
65801         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65802       relationship-list:
65803         type: array
65804         items:
65805           $ref: "#/getDefinitions/relationship"
65806   multicast-configurations:
65807     description: |
65808       multicast configuration of generic-vnf ip-address
65809     properties:
65810       multicast-configuration:
65811         type: array
65812         items:
65813           $ref: "#/getDefinitions/multicast-configuration"
65814   named-queries:
65815     properties:
65816       named-query:
65817         type: array
65818         items:
65819           $ref: "#/getDefinitions/named-query"
65820   named-query:
65821     description: |
65822       TBD
65823       ###### Related Nodes
65824       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
65825       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
65826       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
65827       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
65828     required:
65829     - named-query-uuid
65830     - named-query-name
65831     - named-query-version
65832     properties:
65833       named-query-uuid:
65834         type: string
65835       named-query-name:
65836         type: string
65837       named-query-version:
65838         type: string
65839       required-input-param:
65840         type: string
65841       description:
65842         type: string
65843       resource-version:
65844         type: string
65845       named-query-elements:
65846         type: array
65847         items:
65848           $ref: "#/getDefinitions/named-query-element"
65849       relationship-list:
65850         type: array
65851         items:
65852           $ref: "#/getDefinitions/relationship"
65853   named-query-element:
65854     description: |
65855       TBD
65856       ###### Related Nodes
65857       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
65858       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
65859       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65860       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65861       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65862       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65863       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
65864     required:
65865     - named-query-element-uuid
65866     properties:
65867       named-query-element-uuid:
65868         type: string
65869       property-collect-list:
65870         type: string
65871       resource-version:
65872         type: string
65873       property-limit-desc:
65874         type: string
65875       do-not-output:
65876         type: string
65877       named-query-elements:
65878         type: array
65879         items:
65880           $ref: "#/getDefinitions/named-query-element"
65881       related-lookups:
65882         type: array
65883         items:
65884           $ref: "#/getDefinitions/related-lookup"
65885       property-constraints:
65886         type: array
65887         items:
65888           $ref: "#/getDefinitions/property-constraint"
65889       relationship-list:
65890         type: array
65891         items:
65892           $ref: "#/getDefinitions/relationship"
65893   named-query-elements:
65894     properties:
65895       named-query-element:
65896         type: array
65897         items:
65898           $ref: "#/getDefinitions/named-query-element"
65899   network:
65900     description: |
65901       Namespace for network inventory resources.
65902     properties:
65903       logical-links:
65904         type: array
65905         items:
65906           $ref: "#/getDefinitions/logical-link"
65907       site-pair-sets:
65908         type: array
65909         items:
65910           $ref: "#/getDefinitions/site-pair-set"
65911       vpn-bindings:
65912         type: array
65913         items:
65914           $ref: "#/getDefinitions/vpn-binding"
65915       vpls-pes:
65916         type: array
65917         items:
65918           $ref: "#/getDefinitions/vpls-pe"
65919       multicast-configurations:
65920         type: array
65921         items:
65922           $ref: "#/getDefinitions/multicast-configuration"
65923       vces:
65924         type: array
65925         items:
65926           $ref: "#/getDefinitions/vce"
65927       vnfcs:
65928         type: array
65929         items:
65930           $ref: "#/getDefinitions/vnfc"
65931       l3-networks:
65932         type: array
65933         items:
65934           $ref: "#/getDefinitions/l3-network"
65935       network-policies:
65936         type: array
65937         items:
65938           $ref: "#/getDefinitions/network-policy"
65939       generic-vnfs:
65940         type: array
65941         items:
65942           $ref: "#/getDefinitions/generic-vnf"
65943       lag-links:
65944         type: array
65945         items:
65946           $ref: "#/getDefinitions/lag-link"
65947       newvces:
65948         type: array
65949         items:
65950           $ref: "#/getDefinitions/newvce"
65951       pnfs:
65952         type: array
65953         items:
65954           $ref: "#/getDefinitions/pnf"
65955       physical-links:
65956         type: array
65957         items:
65958           $ref: "#/getDefinitions/physical-link"
65959       ipsec-configurations:
65960         type: array
65961         items:
65962           $ref: "#/getDefinitions/ipsec-configuration"
65963       route-table-references:
65964         type: array
65965         items:
65966           $ref: "#/getDefinitions/route-table-reference"
65967       instance-groups:
65968         type: array
65969         items:
65970           $ref: "#/getDefinitions/instance-group"
65971       zones:
65972         type: array
65973         items:
65974           $ref: "#/getDefinitions/zone"
65975       configurations:
65976         type: array
65977         items:
65978           $ref: "#/getDefinitions/configuration"
65979       forwarding-paths:
65980         type: array
65981         items:
65982           $ref: "#/getDefinitions/forwarding-path"
65983   network-policies:
65984     properties:
65985       network-policy:
65986         type: array
65987         items:
65988           $ref: "#/getDefinitions/network-policy"
65989   network-policy:
65990     description: |
65991       ###### Related Nodes
65992       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
65993       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
65994     required:
65995     - network-policy-id
65996     properties:
65997       network-policy-id:
65998         type: string
65999         description: UUID representing unique key to this instance
66000       network-policy-fqdn:
66001         type: string
66002         description: Contrail FQDN for the policy
66003       heat-stack-id:
66004         type: string
66005         description: ID for the openStack Heat instance
66006       resource-version:
66007         type: string
66008         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66009       relationship-list:
66010         type: array
66011         items:
66012           $ref: "#/getDefinitions/relationship"
66013   network-profile:
66014     description: |
66015       Network profile populated by SDN-GP for SNMP
66016       ###### Related Nodes
66017       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
66018     required:
66019     - nm-profile-name
66020     properties:
66021       nm-profile-name:
66022         type: string
66023         description: Unique name of network profile.
66024       community-string:
66025         type: string
66026         description: Encrypted SNMP community string
66027       resource-version:
66028         type: string
66029         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66030       relationship-list:
66031         type: array
66032         items:
66033           $ref: "#/getDefinitions/relationship"
66034   network-profiles:
66035     description: |
66036       Collection of network profiles
66037     properties:
66038       network-profile:
66039         type: array
66040         items:
66041           $ref: "#/getDefinitions/network-profile"
66042   newvce:
66043     description: |
66044       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
66045       ###### Related Nodes
66046       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
66047       - NEWVCE is DELETED when these are DELETED L-INTERFACE
66048     required:
66049     - vnf-id2
66050     - vnf-name
66051     - vnf-type
66052     properties:
66053       vnf-id2:
66054         type: string
66055         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
66056       vnf-name:
66057         type: string
66058         description: Name of VNF.
66059       vnf-name2:
66060         type: string
66061         description: Alternate name of VNF.
66062       vnf-type:
66063         type: string
66064         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.
66065       prov-status:
66066         type: string
66067         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
66068       operational-status:
66069         type: string
66070         description: Indicator for whether the resource is considered operational
66071       license-key:
66072         type: string
66073         description: OBSOLETE -  do not use
66074       ipv4-oam-address:
66075         type: string
66076         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).
66077       equipment-role:
66078         type: string
66079         description: Client should send valid enumerated value.
66080       resource-version:
66081         type: string
66082         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66083       ipv4-loopback0-address:
66084         type: string
66085         description: v4 Loopback0 address
66086       orchestration-status:
66087         type: string
66088         description: Orchestration status of this VNF, mastered by MSO.
66089       heat-stack-id:
66090         type: string
66091         description: Heat stack id corresponding to this instance, managed by MSO
66092       mso-catalog-key:
66093         type: string
66094         description: Corresponds to the SDN-C catalog id used to configure this VCE
66095       relationship-list:
66096         type: array
66097         items:
66098           $ref: "#/getDefinitions/relationship"
66099       l-interfaces:
66100         type: array
66101         items:
66102           $ref: "#/getDefinitions/l-interface"
66103   newvces:
66104     description: |
66105       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
66106     properties:
66107       newvce:
66108         type: array
66109         items:
66110           $ref: "#/getDefinitions/newvce"
66111   notification-event:
66112     properties:
66113       cambria.partition:
66114         type: string
66115       notification-event-header:
66116         type: object
66117         $ref: "#/getDefinitions/notification-event-header"
66118   notification-event-header:
66119     properties:
66120       id:
66121         type: string
66122       timestamp:
66123         type: string
66124       source-name:
66125         type: string
66126       domain:
66127         type: string
66128       sequence-number:
66129         type: string
66130       severity:
66131         type: string
66132       event-type:
66133         type: string
66134       version:
66135         type: string
66136       action:
66137         type: string
66138       entity-type:
66139         type: string
66140       top-entity-type:
66141         type: string
66142       entity-link:
66143         type: string
66144       status:
66145         type: string
66146   notify:
66147     required:
66148     - event-id
66149     properties:
66150       event-id:
66151         type: string
66152       node-type:
66153         type: string
66154       event-trigger:
66155         type: string
66156       key-data:
66157         type: array
66158         items:
66159           $ref: "#/getDefinitions/key-data"
66160       selflink:
66161         type: string
66162   oam-network:
66163     description: |
66164       OAM network, to be deprecated shortly.  Do not use for new purposes.
66165       ###### Related Nodes
66166       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66167       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
66168       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
66169     required:
66170     - network-uuid
66171     - network-name
66172     - cvlan-tag
66173     properties:
66174       network-uuid:
66175         type: string
66176         description: UUID of the network. Unique across a cloud-region
66177       network-name:
66178         type: string
66179         description: Name of the network.
66180       cvlan-tag:
66181         type: integer
66182         format: int64
66183         description: cvlan-id
66184       ipv4-oam-gateway-address:
66185         type: string
66186         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
66187       ipv4-oam-gateway-address-prefix-length:
66188         type: integer
66189         format: int32
66190         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
66191       resource-version:
66192         type: string
66193         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66194       relationship-list:
66195         type: array
66196         items:
66197           $ref: "#/getDefinitions/relationship"
66198   oam-networks:
66199     description: |
66200       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
66201     properties:
66202       oam-network:
66203         type: array
66204         items:
66205           $ref: "#/getDefinitions/oam-network"
66206   operational-environment:
66207     description: |
66208       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
66209       ###### Related Nodes
66210       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
66211       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
66212     required:
66213     - operational-environment-id
66214     - operational-environment-name
66215     - operational-environment-type
66216     - operational-environment-status
66217     - tenant-context
66218     - workload-context
66219     properties:
66220       operational-environment-id:
66221         type: string
66222         description: UUID of an operational environment
66223       operational-environment-name:
66224         type: string
66225         description: Operational Environment name
66226       operational-environment-type:
66227         type: string
66228         description: Operational Environment Type.
66229       operational-environment-status:
66230         type: string
66231         description: Status
66232       tenant-context:
66233         type: string
66234         description: Tenant Context.
66235       workload-context:
66236         type: string
66237         description: Workload Context.
66238       resource-version:
66239         type: string
66240         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66241       relationship-list:
66242         type: array
66243         items:
66244           $ref: "#/getDefinitions/relationship"
66245   operational-environments:
66246     description: |
66247       a logical partition of the cloud which allows to have multiple environments in the production AIC.
66248     properties:
66249       operational-environment:
66250         type: array
66251         items:
66252           $ref: "#/getDefinitions/operational-environment"
66253   overloaded-model:
66254     description: |
66255       Allows for legacy POST of old-style and new-style models
66256     required:
66257     - model-invariant-id
66258     - model-name-version-id
66259     - model-type
66260     - model-name
66261     - model-id
66262     - model-version
66263     properties:
66264       model-invariant-id:
66265         type: string
66266         description: Unique identifier corresponding to the main definition of a model in ASDC
66267       model-name-version-id:
66268         type: string
66269         description: Unique identifier corresponding to one version of a model in ASDC
66270       model-type:
66271         type: string
66272         description: Type of the model, e.g., service, resource, widget, etc.
66273       model-name:
66274         type: string
66275         description: Name of the model, which can change from version to version.
66276       model-id:
66277         type: string
66278         description: Invariant unique ID which does not change from version to version
66279       model-version:
66280         type: string
66281         description: Version
66282       model-description:
66283         type: string
66284         description: Description
66285       resource-version:
66286         type: string
66287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66288       model-vers:
66289         type: object
66290         $ref: "#/getDefinitions/model-vers"
66291       relationship-list:
66292         type: object
66293         $ref: "#/getDefinitions/relationship-list"
66294   owning-entities:
66295     description: |
66296       Collection of owning-entities
66297     properties:
66298       owning-entity:
66299         type: array
66300         items:
66301           $ref: "#/getDefinitions/owning-entity"
66302   owning-entity:
66303     description: |
66304       describes an owning-entity
66305       ###### Related Nodes
66306       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
66307     required:
66308     - owning-entity-id
66309     - owning-entity-name
66310     properties:
66311       owning-entity-id:
66312         type: string
66313         description: UUID of an owning entity
66314       owning-entity-name:
66315         type: string
66316         description: Owning entity name
66317       resource-version:
66318         type: string
66319         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66320       relationship-list:
66321         type: array
66322         items:
66323           $ref: "#/getDefinitions/relationship"
66324   p-interface:
66325     description: |
66326       Physical interface (e.g., nic)
66327       ###### Related Nodes
66328       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
66329       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
66330       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
66331       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
66332       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
66333       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
66334       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
66335       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
66336       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
66337       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
66338       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
66339     required:
66340     - interface-name
66341     - in-maint
66342     properties:
66343       interface-name:
66344         type: string
66345         description: Name that identifies the physical interface
66346       selflink:
66347         type: string
66348         description: URL to endpoint where AAI can get more details.
66349       speed-value:
66350         type: string
66351         description: Captures the numeric part of the speed
66352       speed-units:
66353         type: string
66354         description: Captures the units corresponding to the speed
66355       port-description:
66356         type: string
66357         description: Nature of the services and connectivity on this port.
66358       equipment-identifier:
66359         type: string
66360         description: CLEI or other specification for p-interface hardware.
66361       interface-role:
66362         type: string
66363         description: Role specification for p-interface hardware.
66364       interface-type:
66365         type: string
66366         description: Indicates the physical properties of the interface.
66367       prov-status:
66368         type: string
66369         description: Trigger for operational monitoring of this resource by Service Assurance systems.
66370       mac-addresss:
66371         type: string
66372         description: MAC Address of the p-interface.
66373       resource-version:
66374         type: string
66375         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66376       in-maint:
66377         type: boolean
66378       inv-status:
66379         type: string
66380         description: inventory status
66381       relationship-list:
66382         type: array
66383         items:
66384           $ref: "#/getDefinitions/relationship"
66385       sriov-pfs:
66386         type: array
66387         items:
66388           $ref: "#/getDefinitions/sriov-pf"
66389       l-interfaces:
66390         type: array
66391         items:
66392           $ref: "#/getDefinitions/l-interface"
66393   p-interfaces:
66394     description: |
66395       Collection of physical interfaces.
66396     properties:
66397       p-interface:
66398         type: array
66399         items:
66400           $ref: "#/getDefinitions/p-interface"
66401   physical-link:
66402     description: |
66403       Collection of physical connections, typically between p-interfaces
66404       ###### Related Nodes
66405       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
66406     required:
66407     - link-name
66408     properties:
66409       link-name:
66410         type: string
66411         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
66412       speed-value:
66413         type: string
66414         description: Captures the numeric part of the speed
66415       speed-units:
66416         type: string
66417         description: Captures the units corresponding to the speed
66418       circuit-id:
66419         type: string
66420         description: Circuit it
66421       dual-mode:
66422         type: string
66423         description: Dual access mode (e.g., primary, secondary
66424       management-option:
66425         type: string
66426         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
66427       service-provider-name:
66428         type: string
66429         description: Name of the service Provider on this link.
66430       service-provider-bandwidth-up-value:
66431         type: integer
66432         format: int32
66433         description: Upstream Bandwidth value agreed with the service provider
66434       service-provider-bandwidth-up-units:
66435         type: string
66436         description: Units for the upstream BW value
66437       service-provider-bandwidth-down-value:
66438         type: integer
66439         format: int32
66440         description: Downstream Bandwidth value agreed with the service provider
66441       service-provider-bandwidth-down-units:
66442         type: string
66443         description: Units for downstream BW value
66444       resource-version:
66445         type: string
66446         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66447       relationship-list:
66448         type: array
66449         items:
66450           $ref: "#/getDefinitions/relationship"
66451   physical-links:
66452     description: |
66453       Collection of physical connections, typically between p-interfaces
66454     properties:
66455       physical-link:
66456         type: array
66457         items:
66458           $ref: "#/getDefinitions/physical-link"
66459   platform:
66460     description: |
66461       describes a platform
66462       ###### Related Nodes
66463       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
66464     required:
66465     - platform-name
66466     properties:
66467       platform-name:
66468         type: string
66469         description: Name of the platform
66470       resource-version:
66471         type: string
66472         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66473       relationship-list:
66474         type: array
66475         items:
66476           $ref: "#/getDefinitions/relationship"
66477   platforms:
66478     description: |
66479       Collection of platforms
66480     properties:
66481       platform:
66482         type: array
66483         items:
66484           $ref: "#/getDefinitions/platform"
66485   pnf:
66486     description: |
66487       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.
66488       ###### Related Nodes
66489       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
66490       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66491       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
66492       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
66493       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
66494       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
66495       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
66496       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
66497       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
66498       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
66499       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
66500     required:
66501     - pnf-name
66502     - in-maint
66503     properties:
66504       pnf-name:
66505         type: string
66506         description: unique name of Physical Network Function.
66507       pnf-name2:
66508         type: string
66509         description: name of Physical Network Function.
66510       selflink:
66511         type: string
66512         description: URL to endpoint where AAI can get more details.
66513       pnf-name2-source:
66514         type: string
66515         description: source of name2
66516       pnf-id:
66517         type: string
66518         description: id of pnf
66519       equip-type:
66520         type: string
66521         description: Equipment type.  Source of truth should define valid values.
66522       equip-vendor:
66523         type: string
66524         description: Equipment vendor.  Source of truth should define valid values.
66525       equip-model:
66526         type: string
66527         description: Equipment model.  Source of truth should define valid values.
66528       management-option:
66529         type: string
66530         description: identifier of managed by ATT or customer
66531       ipaddress-v4-oam:
66532         type: string
66533         description: ipv4-oam-address with new naming convention for IP addresses
66534       sw-version:
66535         type: string
66536         description: sw-version is the version of SW for the hosted application on the PNF.
66537       in-maint:
66538         type: boolean
66539       frame-id:
66540         type: string
66541         description: ID of the physical frame (relay rack) where pnf is installed.
66542       serial-number:
66543         type: string
66544         description: Serial number of the device
66545       ipaddress-v4-loopback-0:
66546         type: string
66547         description: IPV4 Loopback 0 address
66548       ipaddress-v6-loopback-0:
66549         type: string
66550         description: IPV6 Loopback 0 address
66551       ipaddress-v4-aim:
66552         type: string
66553         description: IPV4 AIM address
66554       ipaddress-v6-aim:
66555         type: string
66556         description: IPV6 AIM address
66557       ipaddress-v6-oam:
66558         type: string
66559         description: IPV6 OAM address
66560       inv-status:
66561         type: string
66562         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
66563       resource-version:
66564         type: string
66565         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66566       prov-status:
66567         type: string
66568         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
66569       nf-role:
66570         type: string
66571         description: Nf Role is the role performed by this instance in the network.
66572       relationship-list:
66573         type: array
66574         items:
66575           $ref: "#/getDefinitions/relationship"
66576       p-interfaces:
66577         type: array
66578         items:
66579           $ref: "#/getDefinitions/p-interface"
66580       lag-interfaces:
66581         type: array
66582         items:
66583           $ref: "#/getDefinitions/lag-interface"
66584   pnfs:
66585     description: |
66586       Collection of Physical Network Functions.
66587     properties:
66588       pnf:
66589         type: array
66590         items:
66591           $ref: "#/getDefinitions/pnf"
66592   port-group:
66593     description: |
66594       Used to capture the network interfaces of this VCE
66595       ###### Related Nodes
66596       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66597       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
66598       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
66599     required:
66600     - interface-id
66601     - orchestration-status
66602     properties:
66603       interface-id:
66604         type: string
66605         description: Unique ID of the interface
66606       neutron-network-id:
66607         type: string
66608         description: Neutron network id of this Interface
66609       neutron-network-name:
66610         type: string
66611         description: Neutron network name of this Interface
66612       interface-role:
66613         type: string
66614         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
66615       resource-version:
66616         type: string
66617         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66618       port-group-id:
66619         type: string
66620         description: Unique ID for port group in vmware
66621       port-group-name:
66622         type: string
66623         description: Likely to duplicate value of neutron network name
66624       switch-name:
66625         type: string
66626         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
66627       orchestration-status:
66628         type: string
66629         description: Orchestration status of this VNF, mastered by MSO
66630       heat-stack-id:
66631         type: string
66632         description: Heat stack id corresponding to this instance, managed by MSO
66633       mso-catalog-key:
66634         type: string
66635         description: Corresponds to the SDN-C catalog id used to configure this VCE
66636       cvlan-tags:
66637         type: array
66638         items:
66639           $ref: "#/getDefinitions/cvlan-tag-entry"
66640       relationship-list:
66641         type: array
66642         items:
66643           $ref: "#/getDefinitions/relationship"
66644   port-groups:
66645     properties:
66646       port-group:
66647         type: array
66648         items:
66649           $ref: "#/getDefinitions/port-group"
66650   project:
66651     description: |
66652       describes the project
66653       ###### Related Nodes
66654       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
66655     required:
66656     - project-name
66657     properties:
66658       project-name:
66659         type: string
66660         description: Name of the project deploying a service
66661       resource-version:
66662         type: string
66663         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66664       relationship-list:
66665         type: array
66666         items:
66667           $ref: "#/getDefinitions/relationship"
66668   projects:
66669     description: |
66670       Collection of projects
66671     properties:
66672       project:
66673         type: array
66674         items:
66675           $ref: "#/getDefinitions/project"
66676   properties:
66677     description: |
66678       Property holder for query properties or instance properties
66679     properties:
66680       property-name:
66681         type: string
66682       property-value:
66683         type: string
66684   property-constraint:
66685     description: |
66686       TBD
66687       ###### Related Nodes
66688       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
66689     required:
66690     - property-constraint-uuid
66691     - constraint-type
66692     - property-name
66693     - property-value
66694     properties:
66695       property-constraint-uuid:
66696         type: string
66697       constraint-type:
66698         type: string
66699       property-name:
66700         type: string
66701       property-value:
66702         type: string
66703       resource-version:
66704         type: string
66705   property-constraints:
66706     properties:
66707       property-constraint:
66708         type: array
66709         items:
66710           $ref: "#/getDefinitions/property-constraint"
66711   pserver:
66712     description: |
66713       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
66714       ###### Related Nodes
66715       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
66716       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
66717       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
66718       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
66719       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
66720       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
66721       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
66722       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
66723       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
66724       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
66725       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
66726       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
66727       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
66728     required:
66729     - hostname
66730     - in-maint
66731     properties:
66732       hostname:
66733         type: string
66734         description: Value from executing hostname on the compute node.
66735       ptnii-equip-name:
66736         type: string
66737         description: PTNII name
66738       number-of-cpus:
66739         type: integer
66740         format: int32
66741         description: Number of cpus
66742       disk-in-gigabytes:
66743         type: integer
66744         format: int32
66745         description: Disk size, in GBs
66746       ram-in-megabytes:
66747         type: integer
66748         format: int32
66749         description: RAM size, in MBs
66750       equip-type:
66751         type: string
66752         description: Equipment type.  Source of truth should define valid values.
66753       equip-vendor:
66754         type: string
66755         description: Equipment vendor.  Source of truth should define valid values.
66756       equip-model:
66757         type: string
66758         description: Equipment model.  Source of truth should define valid values.
66759       fqdn:
66760         type: string
66761         description: Fully-qualified domain name
66762       pserver-selflink:
66763         type: string
66764         description: URL to endpoint where AAI can get more details
66765       ipv4-oam-address:
66766         type: string
66767         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
66768       serial-number:
66769         type: string
66770         description: Serial number, may be queried
66771       ipaddress-v4-loopback-0:
66772         type: string
66773         description: IPV4 Loopback 0 address
66774       ipaddress-v6-loopback-0:
66775         type: string
66776         description: IPV6 Loopback 0 address
66777       ipaddress-v4-aim:
66778         type: string
66779         description: IPV4 AIM address
66780       ipaddress-v6-aim:
66781         type: string
66782         description: IPV6 AIM address
66783       ipaddress-v6-oam:
66784         type: string
66785         description: IPV6 OAM address
66786       inv-status:
66787         type: string
66788         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
66789       pserver-id:
66790         type: string
66791         description: ID of Pserver
66792       internet-topology:
66793         type: string
66794         description: internet topology of Pserver
66795       in-maint:
66796         type: boolean
66797       resource-version:
66798         type: string
66799         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66800       pserver-name2:
66801         type: string
66802         description: alternative pserver name
66803       purpose:
66804         type: string
66805         description: purpose of pserver
66806       prov-status:
66807         type: string
66808         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
66809       management-option:
66810         type: string
66811         description: Indicates who owns and or manages the device.
66812       host-profile:
66813         type: string
66814         description: The host profile that defines the configuration of the pserver.
66815       relationship-list:
66816         type: array
66817         items:
66818           $ref: "#/getDefinitions/relationship"
66819       p-interfaces:
66820         type: array
66821         items:
66822           $ref: "#/getDefinitions/p-interface"
66823       lag-interfaces:
66824         type: array
66825         items:
66826           $ref: "#/getDefinitions/lag-interface"
66827   pservers:
66828     description: |
66829       Collection of compute hosts.
66830     properties:
66831       pserver:
66832         type: array
66833         items:
66834           $ref: "#/getDefinitions/pserver"
66835   query-parameters:
66836     description: |
66837       QueryParameters for performing a named-query or model query
66838     properties:
66839       named-query:
66840         type: object
66841         $ref: "#/getDefinitions/named-query"
66842       overloaded-model:
66843         type: object
66844         $ref: "#/getDefinitions/overloaded-model"
66845   related-lookup:
66846     description: |
66847       TBD
66848       ###### Related Nodes
66849       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
66850     required:
66851     - related-lookup-uuid
66852     - source-node-type
66853     - source-node-property
66854     - target-node-type
66855     - target-node-property
66856     properties:
66857       related-lookup-uuid:
66858         type: string
66859       source-node-type:
66860         type: string
66861       source-node-property:
66862         type: string
66863       target-node-type:
66864         type: string
66865       target-node-property:
66866         type: string
66867       property-collect-list:
66868         type: string
66869       resource-version:
66870         type: string
66871       relationship-list:
66872         type: array
66873         items:
66874           $ref: "#/getDefinitions/relationship"
66875   related-lookups:
66876     properties:
66877       related-lookup:
66878         type: array
66879         items:
66880           $ref: "#/getDefinitions/related-lookup"
66881   related-to-property:
66882     properties:
66883       property-key:
66884         type: string
66885         description: Key part of a key/value pair
66886       property-value:
66887         type: string
66888         description: Value part of a key/value pair
66889   relationship:
66890     properties:
66891       related-to:
66892         type: string
66893         description: A keyword provided by A&AI to indicate type of node.
66894       relationship-label:
66895         type: string
66896         description: The edge label for this relationship.
66897       related-link:
66898         type: string
66899         description: URL to the object in A&AI.
66900       relationship-data:
66901         type: array
66902         items:
66903           $ref: "#/getDefinitions/relationship-data"
66904       related-to-property:
66905         type: array
66906         items:
66907           $ref: "#/getDefinitions/related-to-property"
66908   relationship-data:
66909     required:
66910     - relationship-key
66911     - relationship-value
66912     properties:
66913       relationship-key:
66914         type: string
66915         description: A keyword provided by A&AI to indicate an attribute.
66916       relationship-value:
66917         type: string
66918         description: Value of the attribute.
66919   relationship-list:
66920     properties:
66921       relationship:
66922         type: array
66923         items:
66924           $ref: "#/getDefinitions/relationship"
66925   reserved-prop-names:
66926     description: |
66927       Internal map to define some reserved properties of a vertex
66928     properties:
66929       last-mod-source-of-truth:
66930         type: string
66931       aai-node-type:
66932         type: string
66933       aai-created-ts:
66934         type: integer
66935         format: int64
66936       aai-unique-key:
66937         type: string
66938       aai-last-mod-ts:
66939         type: integer
66940         format: int64
66941       source-of-truth:
66942         type: string
66943       aai-uri:
66944         type: string
66945   response-list:
66946     description: |
66947       Response container for the results of a named-query or model query
66948     properties:
66949       inventory-response-items:
66950         type: object
66951         $ref: "#/getDefinitions/inventory-response-items"
66952   result-data:
66953     properties:
66954       resource-type:
66955         type: string
66956         description: The specific type of node in the A&AI graph
66957       resource-link:
66958         type: string
66959         description: The URL to the specific resource
66960   route-table-reference:
66961     description: |
66962       Openstack route table reference.
66963       ###### Related Nodes
66964       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
66965     required:
66966     - route-table-reference-id
66967     - route-table-reference-fqdn
66968     properties:
66969       route-table-reference-id:
66970         type: string
66971         description: Route Table Reference id, UUID assigned to this instance.
66972       route-table-reference-fqdn:
66973         type: string
66974         description: FQDN entry in the route table.
66975       resource-version:
66976         type: string
66977         description: Concurrency value
66978       relationship-list:
66979         type: array
66980         items:
66981           $ref: "#/getDefinitions/relationship"
66982   route-table-references:
66983     description: |
66984       Collection of openstack route table references
66985     properties:
66986       route-table-reference:
66987         type: array
66988         items:
66989           $ref: "#/getDefinitions/route-table-reference"
66990   route-target:
66991     description: |
66992       Route target information
66993       ###### Related Nodes
66994       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
66995     required:
66996     - global-route-target
66997     - route-target-role
66998     properties:
66999       global-route-target:
67000         type: string
67001         description: Number used to identify an RT, globally unique in the network
67002       route-target-role:
67003         type: string
67004         description: Role assigned to this route target
67005       resource-version:
67006         type: string
67007         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67008       relationship-list:
67009         type: array
67010         items:
67011           $ref: "#/getDefinitions/relationship"
67012   route-targets:
67013     description: |
67014       Collection of route target information
67015     properties:
67016       route-target:
67017         type: array
67018         items:
67019           $ref: "#/getDefinitions/route-target"
67020   routing-instance:
67021     description: |
67022       ###### Related Nodes
67023       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
67024       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
67025       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
67026     required:
67027     - routing-instance-id
67028     properties:
67029       routing-instance-id:
67030         type: string
67031         description: Unique id of routing instance
67032       rpm-owner:
67033         type: string
67034         description: rpm owner
67035       resource-version:
67036         type: string
67037         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67038       site-pairs:
67039         type: array
67040         items:
67041           $ref: "#/getDefinitions/site-pair"
67042       relationship-list:
67043         type: array
67044         items:
67045           $ref: "#/getDefinitions/relationship"
67046   routing-instances:
67047     description: |
67048       set of probes related to generic-vnf routing instance
67049     properties:
67050       routing-instance:
67051         type: array
67052         items:
67053           $ref: "#/getDefinitions/routing-instance"
67054   sdn-zone-response:
67055     properties:
67056       oam-networks:
67057         type: object
67058         $ref: "#/getDefinitions/oam-networks"
67059       az-and-dvs-switches:
67060         type: array
67061         items:
67062           $ref: "#/getDefinitions/az-and-dvs-switches"
67063   search:
67064     properties:
67065       edge-tag-query-result:
67066         type: object
67067         $ref: "#/getDefinitions/edge-tag-query-result"
67068       edge-tag-query-request:
67069         type: object
67070         $ref: "#/getDefinitions/edge-tag-query-request"
67071       search-results:
67072         type: object
67073         $ref: "#/getDefinitions/search-results"
67074       sdn-zone-response:
67075         type: object
67076         $ref: "#/getDefinitions/sdn-zone-response"
67077   search-results:
67078     properties:
67079       result-data:
67080         type: array
67081         items:
67082           $ref: "#/getDefinitions/result-data"
67083   secondary-filt:
67084     description: |
67085       SecondaryFilt for performing a named-query or model query
67086   secondary-filter:
67087     properties:
67088       property-name:
67089         type: string
67090       filter-type:
67091         type: string
67092       property-value:
67093         type: string
67094   secondary-filts:
67095     description: |
67096       SecondaryFilts for performing a named-query or model query
67097     properties:
67098       secondary-filt:
67099         type: array
67100         items:
67101           $ref: "#/getDefinitions/secondary-filt"
67102   segmentation-assignment:
67103     description: |
67104       Openstack segmentation assignment.
67105       ###### Related Nodes
67106       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
67107     required:
67108     - segmentation-id
67109     properties:
67110       segmentation-id:
67111         type: string
67112         description: Route Table Reference id, UUID assigned to this instance.
67113       resource-version:
67114         type: string
67115         description: Concurrency value
67116       relationship-list:
67117         type: array
67118         items:
67119           $ref: "#/getDefinitions/relationship"
67120   segmentation-assignments:
67121     description: |
67122       Collection of openstack segmentation assignments
67123     properties:
67124       segmentation-assignment:
67125         type: array
67126         items:
67127           $ref: "#/getDefinitions/segmentation-assignment"
67128   service:
67129     description: |
67130       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
67131     required:
67132     - service-id
67133     - service-description
67134     properties:
67135       service-id:
67136         type: string
67137         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
67138       service-description:
67139         type: string
67140         description: Description of the service
67141       service-selflink:
67142         type: string
67143         description: URL to endpoint where AAI can get more details
67144       resource-version:
67145         type: string
67146         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67147       service-version:
67148         type: string
67149         description: service version
67150       relationship-list:
67151         type: array
67152         items:
67153           $ref: "#/getDefinitions/relationship"
67154   service-capabilities:
67155     description: |
67156       Collection of service capabilities.
67157     properties:
67158       service-capability:
67159         type: array
67160         items:
67161           $ref: "#/getDefinitions/service-capability"
67162   service-capability:
67163     description: |
67164       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
67165       ###### Related Nodes
67166       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
67167       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
67168       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
67169     required:
67170     - service-type
67171     - vnf-type
67172     properties:
67173       service-type:
67174         type: string
67175         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
67176       vnf-type:
67177         type: string
67178         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.
67179       resource-version:
67180         type: string
67181         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67182       relationship-list:
67183         type: array
67184         items:
67185           $ref: "#/getDefinitions/relationship"
67186   service-design-and-creation:
67187     description: |
67188       Namespace for objects managed by ASDC
67189     properties:
67190       vnf-images:
67191         type: array
67192         items:
67193           $ref: "#/getDefinitions/vnf-image"
67194       services:
67195         type: array
67196         items:
67197           $ref: "#/getDefinitions/service"
67198       service-capabilities:
67199         type: array
67200         items:
67201           $ref: "#/getDefinitions/service-capability"
67202       models:
67203         type: array
67204         items:
67205           $ref: "#/getDefinitions/model"
67206       named-queries:
67207         type: array
67208         items:
67209           $ref: "#/getDefinitions/named-query"
67210   service-instance:
67211     description: |
67212       Instance of a service
67213       ###### Related Nodes
67214       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
67215       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
67216       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
67217       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
67218       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
67219       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
67220       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
67221       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
67222       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67223       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
67224       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
67225       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
67226       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
67227       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67228       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
67229       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
67230       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
67231       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
67232       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
67233       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
67234       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
67235       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
67236       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
67237       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
67238     required:
67239     - service-instance-id
67240     - service-type
67241     - service-role
67242     - created-at
67243     - updated-at
67244     - description
67245     properties:
67246       service-instance-id:
67247         type: string
67248         description: Uniquely identifies this instance of a service
67249       service-instance-name:
67250         type: string
67251         description: This field will store a name assigned to the service-instance.
67252       service-type:
67253         type: string
67254         description: String capturing type of service.
67255       service-role:
67256         type: string
67257         description: String capturing the service role.
67258       environment-context:
67259         type: string
67260         description: This field will store the environment context assigned to the service-instance.
67261       workload-context:
67262         type: string
67263         description: This field will store the workload context assigned to the service-instance.
67264       created-at:
67265         type: string
67266         description: create time of Network Service.
67267       updated-at:
67268         type: string
67269         description: last update of Network Service.
67270       description:
67271         type: string
67272         description: short description for service-instance.
67273       model-invariant-id:
67274         type: string
67275         description: the ASDC model id for this resource or service model.
67276       model-version-id:
67277         type: string
67278         description: the ASDC model version for this resource or service model.
67279       persona-model-version:
67280         type: string
67281         description: the ASDC model version for this resource or service model.
67282       widget-model-id:
67283         type: string
67284         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
67285       widget-model-version:
67286         type: string
67287         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
67288       bandwidth-total:
67289         type: string
67290         description: Indicates the total bandwidth to be used for this service.
67291       bandwidth-up-wan1:
67292         type: string
67293         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
67294       bandwidth-down-wan1:
67295         type: string
67296         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
67297       bandwidth-up-wan2:
67298         type: string
67299         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
67300       bandwidth-down-wan2:
67301         type: string
67302         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
67303       vhn-portal-url:
67304         type: string
67305         description: URL customers will use to access the vHN Portal.
67306       service-instance-location-id:
67307         type: string
67308         description: An identifier that customers assign to the location where this service is being used.
67309       resource-version:
67310         type: string
67311         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67312       selflink:
67313         type: string
67314         description: Path to the controller object.
67315       orchestration-status:
67316         type: string
67317         description: Orchestration status of this service.
67318       relationship-list:
67319         type: array
67320         items:
67321           $ref: "#/getDefinitions/relationship"
67322       metadata:
67323         type: array
67324         items:
67325           $ref: "#/getDefinitions/metadatum"
67326       allotted-resources:
67327         type: array
67328         items:
67329           $ref: "#/getDefinitions/allotted-resource"
67330   service-instances:
67331     description: |
67332       Collection of service instances
67333     properties:
67334       service-instance:
67335         type: array
67336         items:
67337           $ref: "#/getDefinitions/service-instance"
67338   service-subscription:
67339     description: |
67340       Object that group service instances.
67341       ###### Related Nodes
67342       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
67343       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
67344       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
67345       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
67346     required:
67347     - service-type
67348     properties:
67349       service-type:
67350         type: string
67351         description: Value defined by orchestration to identify this service across ECOMP.
67352       temp-ub-sub-account-id:
67353         type: string
67354         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
67355       resource-version:
67356         type: string
67357         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67358       service-instances:
67359         type: array
67360         items:
67361           $ref: "#/getDefinitions/service-instance"
67362       relationship-list:
67363         type: array
67364         items:
67365           $ref: "#/getDefinitions/relationship"
67366   service-subscriptions:
67367     description: |
67368       Collection of objects that group service instances.
67369     properties:
67370       service-subscription:
67371         type: array
67372         items:
67373           $ref: "#/getDefinitions/service-subscription"
67374   services:
67375     description: |
67376       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
67377     properties:
67378       service:
67379         type: array
67380         items:
67381           $ref: "#/getDefinitions/service"
67382   site-pair:
67383     description: |
67384       ###### Related Nodes
67385       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
67386       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
67387       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
67388     required:
67389     - site-pair-id
67390     properties:
67391       site-pair-id:
67392         type: string
67393         description: unique identifier of probe
67394       source-ip:
67395         type: string
67396         description: Prefix address
67397       destination-ip:
67398         type: string
67399         description: Prefix address
67400       ip-version:
67401         type: string
67402         description: ip version, v4, v6
67403       destination-hostname:
67404         type: string
67405         description: Hostname of the destination equipment to which SLAs are measured against.
67406       destination-equip-type:
67407         type: string
67408         description: The type of destinatination equipment. Could be Router, UCPE, etc.
67409       resource-version:
67410         type: string
67411         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67412       classes-of-service:
67413         type: array
67414         items:
67415           $ref: "#/getDefinitions/class-of-service"
67416       relationship-list:
67417         type: array
67418         items:
67419           $ref: "#/getDefinitions/relationship"
67420   site-pair-set:
67421     description: |
67422       Set of instances for probes used to measure service level agreements
67423       ###### Related Nodes
67424       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
67425       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
67426       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
67427     required:
67428     - site-pair-set-id
67429     properties:
67430       site-pair-set-id:
67431         type: string
67432         description: Unique id of site pair set.
67433       resource-version:
67434         type: string
67435         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67436       routing-instances:
67437         type: array
67438         items:
67439           $ref: "#/getDefinitions/routing-instance"
67440       relationship-list:
67441         type: array
67442         items:
67443           $ref: "#/getDefinitions/relationship"
67444   site-pair-sets:
67445     description: |
67446       Collection of sets of instances for probes related to generic-vnf
67447     properties:
67448       site-pair-set:
67449         type: array
67450         items:
67451           $ref: "#/getDefinitions/site-pair-set"
67452   site-pairs:
67453     description: |
67454       probe within a set
67455     properties:
67456       site-pair:
67457         type: array
67458         items:
67459           $ref: "#/getDefinitions/site-pair"
67460   snapshot:
67461     description: |
67462       Openstack snapshot
67463       ###### Related Nodes
67464       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67465       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
67466     required:
67467     - snapshot-id
67468     properties:
67469       snapshot-id:
67470         type: string
67471         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
67472       snapshot-name:
67473         type: string
67474         description: Snapshot name
67475       snapshot-architecture:
67476         type: string
67477         description: Operating system architecture
67478       snapshot-os-distro:
67479         type: string
67480         description: The common name of the operating system distribution in lowercase
67481       snapshot-os-version:
67482         type: string
67483         description: The operating system version as specified by the distributor.
67484       application:
67485         type: string
67486         description: The application that the image instantiates.
67487       application-vendor:
67488         type: string
67489         description: The vendor of the application.
67490       application-version:
67491         type: string
67492         description: The version of the application.
67493       snapshot-selflink:
67494         type: string
67495         description: URL to endpoint where AAI can get more details
67496       prev-snapshot-id:
67497         type: string
67498         description: This field contains the UUID of the previous snapshot (if any).
67499       resource-version:
67500         type: string
67501         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67502       relationship-list:
67503         type: array
67504         items:
67505           $ref: "#/getDefinitions/relationship"
67506   snapshots:
67507     description: |
67508       Collection of openstack snapshots
67509     properties:
67510       snapshot:
67511         type: array
67512         items:
67513           $ref: "#/getDefinitions/snapshot"
67514   sriov-pf:
67515     description: |
67516       SR-IOV Physical Function
67517       ###### Related Nodes
67518       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
67519       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
67520     required:
67521     - pf-pci-id
67522     properties:
67523       pf-pci-id:
67524         type: string
67525         description: Identifier for the sriov-pf
67526       resource-version:
67527         type: string
67528         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67529       relationship-list:
67530         type: array
67531         items:
67532           $ref: "#/getDefinitions/relationship"
67533   sriov-pfs:
67534     description: |
67535       Collection of SR-IOV Physical Functions.
67536     properties:
67537       sriov-pf:
67538         type: array
67539         items:
67540           $ref: "#/getDefinitions/sriov-pf"
67541   sriov-vf:
67542     description: |
67543       SR-IOV Virtual Function (not to be confused with virtual network function)
67544       ###### Related Nodes
67545       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
67546       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
67547     required:
67548     - pci-id
67549     properties:
67550       pci-id:
67551         type: string
67552         description: PCI ID used to identify the sriov-vf
67553       vf-vlan-filter:
67554         type: string
67555         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
67556       vf-mac-filter:
67557         type: string
67558         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
67559       vf-vlan-strip:
67560         type: boolean
67561         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
67562       vf-vlan-anti-spoof-check:
67563         type: boolean
67564         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.
67565       vf-mac-anti-spoof-check:
67566         type: boolean
67567         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.
67568       vf-mirrors:
67569         type: string
67570         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
67571       vf-broadcast-allow:
67572         type: boolean
67573         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
67574       vf-unknown-multicast-allow:
67575         type: boolean
67576         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
67577       vf-unknown-unicast-allow:
67578         type: boolean
67579         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
67580       vf-insert-stag:
67581         type: boolean
67582         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
67583       vf-link-status:
67584         type: string
67585         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
67586       resource-version:
67587         type: string
67588         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67589       neutron-network-id:
67590         type: string
67591         description: Neutron network id of the interface
67592       relationship-list:
67593         type: array
67594         items:
67595           $ref: "#/getDefinitions/relationship"
67596   sriov-vfs:
67597     description: |
67598       Collection of SR-IOV Virtual Functions.
67599     properties:
67600       sriov-vf:
67601         type: array
67602         items:
67603           $ref: "#/getDefinitions/sriov-vf"
67604   start-node-filter:
67605     properties:
67606       property-name:
67607         type: string
67608       property-value:
67609         type: string
67610   subnet:
67611     description: |
67612       ###### Related Nodes
67613       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
67614       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
67615       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
67616       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
67617       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
67618       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
67619       - 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
67620       - SUBNET is DELETED when these are DELETED HOST-ROUTE
67621     required:
67622     - subnet-id
67623     - dhcp-enabled
67624     properties:
67625       subnet-id:
67626         type: string
67627         description: Subnet ID, should be UUID.
67628       subnet-name:
67629         type: string
67630         description: Name associated with the subnet.
67631       neutron-subnet-id:
67632         type: string
67633         description: Neutron id of this subnet
67634       gateway-address:
67635         type: string
67636         description: gateway ip address
67637       network-start-address:
67638         type: string
67639         description: network start address
67640       cidr-mask:
67641         type: string
67642         description: cidr mask
67643       ip-version:
67644         type: string
67645         description: ip version
67646       orchestration-status:
67647         type: string
67648         description: Orchestration status of this VNF, mastered by MSO
67649       dhcp-enabled:
67650         type: boolean
67651       dhcp-start:
67652         type: string
67653         description: the start address reserved for use by dhcp
67654       dhcp-end:
67655         type: string
67656         description: the last address reserved for use by dhcp
67657       subnet-role:
67658         type: string
67659         description: role of the subnet, referenced when assigning IPs
67660       ip-assignment-direction:
67661         type: string
67662         description: ip address assignment direction of the subnet
67663       resource-version:
67664         type: string
67665         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67666       subnet-sequence:
67667         type: integer
67668         format: int32
67669         description: sequence of the subnet
67670       host-routes:
67671         type: array
67672         items:
67673           $ref: "#/getDefinitions/host-route"
67674       relationship-list:
67675         type: array
67676         items:
67677           $ref: "#/getDefinitions/relationship"
67678   subnets:
67679     properties:
67680       subnet:
67681         type: array
67682         items:
67683           $ref: "#/getDefinitions/subnet"
67684   tagged-inventory-item-list:
67685     properties:
67686       inventory-item:
67687         type: array
67688         items:
67689           $ref: "#/getDefinitions/inventory-item"
67690   tenant:
67691     description: |
67692       Openstack tenant
67693       ###### Related Nodes
67694       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67695       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
67696       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
67697       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
67698       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
67699       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
67700       - TENANT cannot be deleted if linked to VSERVER
67701     required:
67702     - tenant-id
67703     - tenant-name
67704     properties:
67705       tenant-id:
67706         type: string
67707         description: Unique id relative to the cloud-region.
67708       tenant-name:
67709         type: string
67710         description: Readable name of tenant
67711       tenant-context:
67712         type: string
67713         description: This field will store the tenant context.
67714       resource-version:
67715         type: string
67716         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67717       vservers:
67718         type: array
67719         items:
67720           $ref: "#/getDefinitions/vserver"
67721       relationship-list:
67722         type: array
67723         items:
67724           $ref: "#/getDefinitions/relationship"
67725   tenants:
67726     description: |
67727       Collection of openstack tenants.
67728     properties:
67729       tenant:
67730         type: array
67731         items:
67732           $ref: "#/getDefinitions/tenant"
67733   tunnel-xconnect:
67734     description: |
67735       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
67736       ###### Related Nodes
67737       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
67738     required:
67739     - id
67740     properties:
67741       id:
67742         type: string
67743         description: Allotted Resource id UUID assigned to this instance.
67744       bandwidth-up-wan1:
67745         type: string
67746         description: The WAN uplink bandwidth for WAN1
67747       bandwidth-down-wan1:
67748         type: string
67749         description: The WAN downlink bandwidth for WAN1
67750       bandwidth-up-wan2:
67751         type: string
67752         description: The WAN uplink bandwidth for WAN2
67753       bandwidth-down-wan2:
67754         type: string
67755         description: The WAN downlink bandwidth for WAN2
67756       resource-version:
67757         type: string
67758         description: Concurrency value
67759       relationship-list:
67760         type: array
67761         items:
67762           $ref: "#/getDefinitions/relationship"
67763   tunnel-xconnects:
67764     description: |
67765       This object is used to store the specific tunnel cross connect aspects of an allotted resource
67766     properties:
67767       tunnel-xconnect:
67768         type: array
67769         items:
67770           $ref: "#/getDefinitions/tunnel-xconnect"
67771   update:
67772     description: |
67773       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
67774     required:
67775     - update-node-type
67776     properties:
67777       update-node-type:
67778         type: string
67779       update-node-key:
67780         type: array
67781         items:
67782           $ref: "#/getDefinitions/update-node-key"
67783       update-node-uri:
67784         type: string
67785       action:
67786         type: array
67787         items:
67788           $ref: "#/getDefinitions/action"
67789   update-node-key:
67790     properties:
67791       key-name:
67792         type: string
67793       key-value:
67794         type: string
67795   vce:
67796     description: |
67797       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
67798       ###### Related Nodes
67799       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
67800       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
67801       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
67802       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
67803       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
67804       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
67805       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
67806       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
67807     required:
67808     - vnf-id
67809     - vnf-name
67810     - vnf-type
67811     properties:
67812       vnf-id:
67813         type: string
67814         description: Unique id of VNF.  This is unique across the graph.
67815       vnf-name:
67816         type: string
67817         description: Name of VNF.
67818       vnf-name2:
67819         type: string
67820         description: Alternate name of VNF.
67821       vnf-type:
67822         type: string
67823         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.
67824       service-id:
67825         type: string
67826         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
67827       regional-resource-zone:
67828         type: string
67829         description: Regional way of organizing pservers, source of truth should define values
67830       prov-status:
67831         type: string
67832         description: Trigger for operational monitoring of this resource by Service Assurance systems.
67833       operational-status:
67834         type: string
67835         description: Indicator for whether the resource is considered operational
67836       license-key:
67837         type: string
67838         description: OBSOLETE -  do not use
67839       equipment-role:
67840         type: string
67841         description: Network role being played by this VNF
67842       orchestration-status:
67843         type: string
67844         description: Orchestration status of this VNF, mastered by MSO
67845       heat-stack-id:
67846         type: string
67847         description: Heat stack id corresponding to this instance, managed by MSO
67848       mso-catalog-key:
67849         type: string
67850         description: Corresponds to the SDN-C catalog id used to configure this VCE
67851       vpe-id:
67852         type: string
67853         description: Unique ID of VPE connected to this VCE.
67854       v6-vce-wan-address:
67855         type: string
67856         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
67857       ipv4-oam-address:
67858         type: string
67859         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
67860       resource-version:
67861         type: string
67862         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67863       ipv4-loopback0-address:
67864         type: string
67865         description: Loopback0 address
67866       entitlement-resource-uuid:
67867         type: string
67868         description: OBSOLETE -  see child relationships
67869       port-groups:
67870         type: array
67871         items:
67872           $ref: "#/getDefinitions/port-group"
67873       licenses:
67874         type: array
67875         items:
67876           $ref: "#/getDefinitions/license"
67877       entitlements:
67878         type: array
67879         items:
67880           $ref: "#/getDefinitions/entitlement"
67881       relationship-list:
67882         type: array
67883         items:
67884           $ref: "#/getDefinitions/relationship"
67885   vces:
67886     description: |
67887       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
67888     properties:
67889       vce:
67890         type: array
67891         items:
67892           $ref: "#/getDefinitions/vce"
67893   vf-module:
67894     description: |
67895       a deployment unit of VNFCs
67896       ###### Related Nodes
67897       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
67898       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
67899       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
67900       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
67901       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
67902       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
67903       - VF-MODULE cannot be deleted if linked to VNFC
67904     required:
67905     - vf-module-id
67906     - is-base-vf-module
67907     properties:
67908       vf-module-id:
67909         type: string
67910         description: Unique ID of vf-module.
67911       vf-module-name:
67912         type: string
67913         description: Name of vf-module
67914       heat-stack-id:
67915         type: string
67916         description: Heat stack id corresponding to this instance.
67917       orchestration-status:
67918         type: string
67919         description: orchestration status of this vf-module, mastered by MSO
67920       is-base-vf-module:
67921         type: boolean
67922       resource-version:
67923         type: string
67924         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67925       model-invariant-id:
67926         type: string
67927         description: the ASDC model id for this resource or service model.
67928       model-version-id:
67929         type: string
67930         description: the ASDC model version for this resource or service model.
67931       persona-model-version:
67932         type: string
67933         description: the ASDC model version for this resource or service model.
67934       model-customization-id:
67935         type: string
67936         description: captures the id of all the configuration used to customize the resource for the service.
67937       widget-model-id:
67938         type: string
67939         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
67940       widget-model-version:
67941         type: string
67942         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
67943       contrail-service-instance-fqdn:
67944         type: string
67945         description: the Contrail unique ID for a service-instance
67946       module-index:
67947         type: integer
67948         format: int32
67949         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
67950       selflink:
67951         type: string
67952         description: Path to the controller object.
67953       relationship-list:
67954         type: array
67955         items:
67956           $ref: "#/getDefinitions/relationship"
67957   vf-modules:
67958     description: |
67959       Collection of vf-modules, a deployment unit of VNFCs
67960     properties:
67961       vf-module:
67962         type: array
67963         items:
67964           $ref: "#/getDefinitions/vf-module"
67965   vig-server:
67966     description: |
67967       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
67968       ###### Related Nodes
67969       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
67970     required:
67971     - vig-address-type
67972     properties:
67973       vig-address-type:
67974         type: string
67975         description: indicates whether the VIG is for AVPN or INTERNET
67976       ipaddress-v4-vig:
67977         type: string
67978         description: v4 IP of the vig server
67979       ipaddress-v6-vig:
67980         type: string
67981         description: v6 IP of the vig server
67982       resource-version:
67983         type: string
67984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67985       relationship-list:
67986         type: array
67987         items:
67988           $ref: "#/getDefinitions/relationship"
67989   vig-servers:
67990     properties:
67991       vig-server:
67992         type: array
67993         items:
67994           $ref: "#/getDefinitions/vig-server"
67995   vip-ipv4-address-list:
67996     description: |
67997       IPv4 Address Range
67998       ###### Related Nodes
67999       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68000       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
68001       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
68002       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
68003     required:
68004     - vip-ipv4-address
68005     properties:
68006       vip-ipv4-address:
68007         type: string
68008         description: IP address
68009       vip-ipv4-prefix-length:
68010         type: integer
68011         format: int64
68012         description: Prefix length, 32 for single address
68013       vlan-id-inner:
68014         type: integer
68015         format: int64
68016         description: Inner VLAN tag
68017       vlan-id-outer:
68018         type: integer
68019         format: int64
68020         description: Outer VLAN tag
68021       is-floating:
68022         type: boolean
68023         description: Indicator of fixed or floating address
68024       resource-version:
68025         type: string
68026         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68027       neutron-network-id:
68028         type: string
68029         description: Neutron network id of the interface that address belongs to
68030       neutron-subnet-id:
68031         type: string
68032         description: Neutron id of subnet that address belongs to
68033       relationship-list:
68034         type: array
68035         items:
68036           $ref: "#/getDefinitions/relationship"
68037   vip-ipv6-address-list:
68038     description: |
68039       IPv6 Address Range
68040       ###### Related Nodes
68041       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68042       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
68043       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
68044       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
68045     required:
68046     - vip-ipv6-address
68047     properties:
68048       vip-ipv6-address:
68049         type: string
68050         description: IP address
68051       vip-ipv6-prefix-length:
68052         type: integer
68053         format: int64
68054         description: Prefix length, 128 for single address
68055       vlan-id-inner:
68056         type: integer
68057         format: int64
68058         description: Inner VLAN tag
68059       vlan-id-outer:
68060         type: integer
68061         format: int64
68062         description: Outer VLAN tag
68063       is-floating:
68064         type: boolean
68065         description: Indicator of fixed or floating address
68066       resource-version:
68067         type: string
68068         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68069       neutron-network-id:
68070         type: string
68071         description: Neutron network id of the interface that address belongs to
68072       neutron-subnet-id:
68073         type: string
68074         description: Neutron id of subnet that address belongs to
68075       relationship-list:
68076         type: array
68077         items:
68078           $ref: "#/getDefinitions/relationship"
68079   virtual-data-center:
68080     description: |
68081       Virtual organization of cloud infrastructure elements in a data center context
68082       ###### Related Nodes
68083       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
68084       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
68085       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
68086     required:
68087     - vdc-id
68088     - vdc-name
68089     properties:
68090       vdc-id:
68091         type: string
68092         description: Unique ID of the vdc
68093       vdc-name:
68094         type: string
68095         description: Name of the virtual data center
68096       resource-version:
68097         type: string
68098         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68099       relationship-list:
68100         type: array
68101         items:
68102           $ref: "#/getDefinitions/relationship"
68103   virtual-data-centers:
68104     description: |
68105       Virtual organization of cloud infrastructure elements in a data center context
68106     properties:
68107       virtual-data-center:
68108         type: array
68109         items:
68110           $ref: "#/getDefinitions/virtual-data-center"
68111   vlan:
68112     description: |
68113       Definition of vlan
68114       ###### Related Nodes
68115       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
68116       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
68117       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
68118       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
68119       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
68120       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
68121       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
68122       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
68123       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
68124     required:
68125     - vlan-interface
68126     - in-maint
68127     - is-ip-unnumbered
68128     properties:
68129       vlan-interface:
68130         type: string
68131         description: String that identifies the interface
68132       vlan-id-inner:
68133         type: integer
68134         format: int64
68135         description: Inner VLAN tag
68136       vlan-id-outer:
68137         type: integer
68138         format: int64
68139         description: Outer VLAN tag
68140       resource-version:
68141         type: string
68142         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68143       speed-value:
68144         type: string
68145         description: Captures the numeric part of the speed
68146       speed-units:
68147         type: string
68148         description: Captures the units corresponding to the speed
68149       vlan-description:
68150         type: string
68151         description: Used to describe (the service associated with) the vlan
68152       backdoor-connection:
68153         type: string
68154         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
68155       vpn-key:
68156         type: string
68157         description: This indicates the customers VPN ID associated with this vlan
68158       orchestration-status:
68159         type: string
68160         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
68161       in-maint:
68162         type: boolean
68163       prov-status:
68164         type: string
68165         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
68166       is-ip-unnumbered:
68167         type: boolean
68168       relationship-list:
68169         type: array
68170         items:
68171           $ref: "#/getDefinitions/relationship"
68172       l3-interface-ipv4-address-list:
68173         type: array
68174         items:
68175           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
68176       l3-interface-ipv6-address-list:
68177         type: array
68178         items:
68179           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
68180   vlans:
68181     properties:
68182       vlan:
68183         type: array
68184         items:
68185           $ref: "#/getDefinitions/vlan"
68186   vnf:
68187     description: |
68188       Abstract vnf class
68189     required:
68190     - vnf-id
68191     properties:
68192       vnf-id:
68193         type: string
68194         description: Unique id of VNF.  This is unique across the graph.
68195   vnf-image:
68196     description: |
68197       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
68198       ###### Related Nodes
68199       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
68200       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
68201     required:
68202     - vnf-image-uuid
68203     - application
68204     - application-vendor
68205     properties:
68206       vnf-image-uuid:
68207         type: string
68208         description: Unique ID of this asset
68209       application:
68210         type: string
68211         description: The application that the image instantiates.
68212       application-vendor:
68213         type: string
68214         description: The vendor of the application.
68215       application-version:
68216         type: string
68217         description: The version of the application.
68218       selflink:
68219         type: string
68220         description: URL to endpoint where AAI can get more details
68221       resource-version:
68222         type: string
68223         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68224       relationship-list:
68225         type: array
68226         items:
68227           $ref: "#/getDefinitions/relationship"
68228   vnf-images:
68229     description: |
68230       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
68231     properties:
68232       vnf-image:
68233         type: array
68234         items:
68235           $ref: "#/getDefinitions/vnf-image"
68236   vnfc:
68237     description: |
68238       ###### Related Nodes
68239       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
68240       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
68241       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
68242       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
68243       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
68244       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
68245       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
68246       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
68247       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
68248     required:
68249     - vnfc-name
68250     - nfc-naming-code
68251     - nfc-function
68252     - in-maint
68253     - is-closed-loop-disabled
68254     properties:
68255       vnfc-name:
68256         type: string
68257         description: Unique ID of vnfc.
68258       nfc-naming-code:
68259         type: string
68260         description: Short code that is used in naming instances of the item being modeled
68261       nfc-function:
68262         type: string
68263         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
68264       prov-status:
68265         type: string
68266         description: prov status of this vnfc
68267       orchestration-status:
68268         type: string
68269         description: Orchestration status of this VNF, mastered by APP-C
68270       ipaddress-v4-oam-vip:
68271         type: string
68272         description: Oam V4 vip address of this vnfc
68273       in-maint:
68274         type: boolean
68275       is-closed-loop-disabled:
68276         type: boolean
68277       group-notation:
68278         type: string
68279         description: Group notation of VNFC
68280       model-invariant-id:
68281         type: string
68282         description: the ASDC model id for this resource or service model.
68283       model-version-id:
68284         type: string
68285         description: the ASDC model version for this resource or service model.
68286       resource-version:
68287         type: string
68288         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68289       relationship-list:
68290         type: array
68291         items:
68292           $ref: "#/getDefinitions/relationship"
68293       l3-interface-ipv4-address-list:
68294         type: array
68295         items:
68296           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
68297       l3-interface-ipv6-address-list:
68298         type: array
68299         items:
68300           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
68301   vnfcs:
68302     description: |
68303       virtual network components associated with a vserver from application controller.
68304     properties:
68305       vnfc:
68306         type: array
68307         items:
68308           $ref: "#/getDefinitions/vnfc"
68309   volume:
68310     description: |
68311       Ephemeral Block storage volume.
68312       ###### Related Nodes
68313       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
68314     required:
68315     - volume-id
68316     - volume-selflink
68317     properties:
68318       volume-id:
68319         type: string
68320         description: Unique ID of block storage volume relative to the vserver.
68321       volume-selflink:
68322         type: string
68323         description: URL to endpoint where AAI can get more details
68324       resource-version:
68325         type: string
68326         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68327       relationship-list:
68328         type: array
68329         items:
68330           $ref: "#/getDefinitions/relationship"
68331   volume-group:
68332     description: |
68333       Persistent block-level storage.
68334       ###### Related Nodes
68335       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68336       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
68337       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
68338       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
68339       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
68340     required:
68341     - volume-group-id
68342     - volume-group-name
68343     - vnf-type
68344     properties:
68345       volume-group-id:
68346         type: string
68347         description: Unique ID of volume-group.
68348       volume-group-name:
68349         type: string
68350         description: Name of the volume group.
68351       heat-stack-id:
68352         type: string
68353         description: Heat stack id corresponding to this volume-group
68354       vnf-type:
68355         type: string
68356         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.
68357       orchestration-status:
68358         type: string
68359         description: Orchestration status of this volume-group
68360       model-customization-id:
68361         type: string
68362         description: captures the id of all the configuration used to customize the resource for the service.
68363       vf-module-model-customization-id:
68364         type: string
68365         description: helps relate the volume group to the vf-module whose components will require the volume group
68366       resource-version:
68367         type: string
68368         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68369       relationship-list:
68370         type: array
68371         items:
68372           $ref: "#/getDefinitions/relationship"
68373   volume-groups:
68374     description: |
68375       Collection of persistent block-level storage.
68376     properties:
68377       volume-group:
68378         type: array
68379         items:
68380           $ref: "#/getDefinitions/volume-group"
68381   volumes:
68382     description: |
68383       Collection of ephemeral Block storage volumes.
68384     properties:
68385       volume:
68386         type: array
68387         items:
68388           $ref: "#/getDefinitions/volume"
68389   vpls-pe:
68390     description: |
68391       VPLS Provider Edge routers.
68392       ###### Related Nodes
68393       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
68394       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
68395       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
68396       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
68397       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
68398     required:
68399     - equipment-name
68400     properties:
68401       equipment-name:
68402         type: string
68403       prov-status:
68404         type: string
68405         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
68406       ipv4-oam-address:
68407         type: string
68408         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).
68409       equipment-role:
68410         type: string
68411         description: Client should send valid enumerated value, e.g., VPLS-PE.
68412       vlan-id-outer:
68413         type: integer
68414         format: int64
68415         description: Temporary location for stag to get to VCE
68416       resource-version:
68417         type: string
68418         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68419       relationship-list:
68420         type: array
68421         items:
68422           $ref: "#/getDefinitions/relationship"
68423       p-interfaces:
68424         type: array
68425         items:
68426           $ref: "#/getDefinitions/p-interface"
68427       lag-interfaces:
68428         type: array
68429         items:
68430           $ref: "#/getDefinitions/lag-interface"
68431   vpls-pes:
68432     description: |
68433       Collection of VPLS Provider Edge routers
68434     properties:
68435       vpls-pe:
68436         type: array
68437         items:
68438           $ref: "#/getDefinitions/vpls-pe"
68439   vpn-binding:
68440     description: |
68441       VPN binding
68442       ###### Related Nodes
68443       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
68444       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
68445       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
68446       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
68447       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
68448       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
68449     required:
68450     - vpn-id
68451     - vpn-name
68452     properties:
68453       vpn-id:
68454         type: string
68455         description: VPN ID, globally unique within A&AI
68456       vpn-name:
68457         type: string
68458         description: VPN Name
68459       vpn-platform:
68460         type: string
68461         description: the platform associated with the VPN example AVPN, Mobility
68462       vpn-type:
68463         type: string
68464         description: Type of the vpn, should be taken from enumerated/valid values
68465       vpn-region:
68466         type: string
68467         description: region of customer vpn
68468       customer-vpn-id:
68469         type: string
68470         description: id for this customer vpn
68471       route-distinguisher:
68472         type: string
68473         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
68474       resource-version:
68475         type: string
68476         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68477       route-targets:
68478         type: array
68479         items:
68480           $ref: "#/getDefinitions/route-target"
68481       relationship-list:
68482         type: array
68483         items:
68484           $ref: "#/getDefinitions/relationship"
68485         description: l3-networks relate to vpn-bindings
68486   vpn-bindings:
68487     properties:
68488       vpn-binding:
68489         type: array
68490         items:
68491           $ref: "#/getDefinitions/vpn-binding"
68492   vserver:
68493     description: |
68494       Virtual Servers, aka virtual machine or VM.
68495       ###### Related Nodes
68496       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
68497       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
68498       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
68499       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
68500       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
68501       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
68502       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
68503       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
68504       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
68505       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
68506       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
68507       - VSERVER is DELETED when these are DELETED L-INTERFACE
68508       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
68509     required:
68510     - vserver-id
68511     - vserver-name
68512     - vserver-selflink
68513     - in-maint
68514     - is-closed-loop-disabled
68515     properties:
68516       vserver-id:
68517         type: string
68518         description: Unique identifier for this vserver relative to its tenant
68519       vserver-name:
68520         type: string
68521         description: Name of vserver
68522       vserver-name2:
68523         type: string
68524         description: Alternative name of vserver
68525       prov-status:
68526         type: string
68527         description: Trigger for operational monitoring of this resource by Service Assurance systems.
68528       vserver-selflink:
68529         type: string
68530         description: URL to endpoint where AAI can get more details
68531       in-maint:
68532         type: boolean
68533       is-closed-loop-disabled:
68534         type: boolean
68535       resource-version:
68536         type: string
68537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68538       volumes:
68539         type: array
68540         items:
68541           $ref: "#/getDefinitions/volume"
68542       relationship-list:
68543         type: array
68544         items:
68545           $ref: "#/getDefinitions/relationship"
68546       l-interfaces:
68547         type: array
68548         items:
68549           $ref: "#/getDefinitions/l-interface"
68550   vservers:
68551     description: |
68552       Collection of virtual Servers, aka virtual machines or VMs.
68553     properties:
68554       vserver:
68555         type: array
68556         items:
68557           $ref: "#/getDefinitions/vserver"
68558   zone:
68559     description: |
68560       A zone is a grouping of assets in a location homing to the same connections into the CBB
68561       ###### Related Nodes
68562       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
68563       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68564       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68565       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68566       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68567     required:
68568     - zone-id
68569     - zone-name
68570     - design-type
68571     - zone-context
68572     properties:
68573       zone-id:
68574         type: string
68575         description: Code assigned by AIC to the zone
68576       zone-name:
68577         type: string
68578         description: English name associated with the zone
68579       design-type:
68580         type: string
68581         description: Design of zone [Medium/Large…]
68582       zone-context:
68583         type: string
68584         description: Context of zone [production/test]
68585       status:
68586         type: string
68587         description: Status of a zone.
68588       resource-version:
68589         type: string
68590         description: Concurrency value
68591       relationship-list:
68592         type: array
68593         items:
68594           $ref: "#/getDefinitions/relationship"
68595   zones:
68596     description: |
68597       Collection of zones
68598     properties:
68599       zone:
68600         type: array
68601         items:
68602           $ref: "#/getDefinitions/zone"