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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v8.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v8"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v8
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144     put:
 145       tags:
 146         - CloudInfrastructure
 147       summary: create or update an existing ctag-pool
 148       description: |
 149         Create or update an existing ctag-pool.
 150         #
 151         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 152       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 153       consumes:
 154         - application/json
 155         - application/xml
 156       produces:
 157         - application/json
 158         - application/xml
 159       responses:
 160         "default":
 161           description: Response codes found in [response codes](https://wiki.onap.org/).
 162       parameters:
 163         - name: physical-location-id
 164           in: path
 165           description: Unique identifier for physical location, e.g., CLLI
 166           required: true
 167           type: string
 168           example: __PHYSICAL-LOCATION-ID__
 169         - name: target-pe
 170           in: path
 171           description: The Target provider edge router
 172           required: true
 173           type: string
 174           example: __TARGET-PE__
 175         - name: availability-zone-name
 176           in: path
 177           description: Name of the availability zone
 178           required: true
 179           type: string
 180           example: __AVAILABILITY-ZONE-NAME__
 181         - name: body
 182           in: body
 183           description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
 184           required: true
 185           schema:
 186             $ref: "#/definitions/ctag-pool"
 187     patch:
 188       tags:
 189         - CloudInfrastructure
 190       summary: update an existing ctag-pool
 191       description: |
 192         Update an existing ctag-pool
 193         #
 194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 195         The PUT operation will entirely replace an existing object.
 196         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 197         #
 198         Other differences between PUT and PATCH are:
 199         #
 200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 203       operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 204       consumes:
 205         - application/json
 206         - application/xml
 207       produces:
 208         - application/json
 209         - application/xml
 210       responses:
 211         "default":
 212           description: Response codes found in [response codes](https://wiki.onap.org/).
 213       parameters:
 214         - name: physical-location-id
 215           in: path
 216           description: Unique identifier for physical location, e.g., CLLI
 217           required: true
 218           type: string
 219           example: __PHYSICAL-LOCATION-ID__
 220         - name: target-pe
 221           in: path
 222           description: The Target provider edge router
 223           required: true
 224           type: string
 225           example: __TARGET-PE__
 226         - name: availability-zone-name
 227           in: path
 228           description: Name of the availability zone
 229           required: true
 230           type: string
 231           example: __AVAILABILITY-ZONE-NAME__
 232         - name: body
 233           in: body
 234           description: ctag-pool object that needs to be updated.
 235           required: true
 236           schema:
 237             $ref: "#/patchDefinitions/ctag-pool"
 238     delete:
 239       tags:
 240         - CloudInfrastructure
 241       summary: delete an existing ctag-pool
 242       description: delete an existing ctag-pool
 243       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 244       consumes:
 245         - application/json
 246         - application/xml
 247       produces:
 248         - application/json
 249         - application/xml
 250       responses:
 251         "default":
 252           description: Response codes found in [response codes](https://wiki.onap.org/).
 253       parameters:
 254         - name: physical-location-id
 255           in: path
 256           description: Unique identifier for physical location, e.g., CLLI
 257           required: true
 258           type: string
 259           example: __PHYSICAL-LOCATION-ID__
 260         - name: target-pe
 261           in: path
 262           description: The Target provider edge router
 263           required: true
 264           type: string
 265           example: __TARGET-PE__
 266         - name: availability-zone-name
 267           in: path
 268           description: Name of the availability zone
 269           required: true
 270           type: string
 271           example: __AVAILABILITY-ZONE-NAME__
 272         - name: resource-version
 273           in: query
 274           description: resource-version for concurrency
 275           required: true
 276           type: string
 277   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
 278     get:
 279       tags:
 280         - CloudInfrastructure
 281       summary: returns ctag-pools
 282       description: returns ctag-pools
 283       operationId: getCloudInfrastructureComplexesComplexCtagPools
 284       produces:
 285         - application/json
 286         - application/xml
 287       responses:
 288         "200":
 289           description: successful operation
 290           schema:
 291               $ref: "#/getDefinitions/ctag-pools"
 292         "default":
 293           description: Response codes found in [response codes](https://wiki.onap.org/).
 294       parameters:
 295         - name: physical-location-id
 296           in: path
 297           description: Unique identifier for physical location, e.g., CLLI
 298           required: true
 299           type: string
 300           example: __PHYSICAL-LOCATION-ID__
 301         - name: availability-zone-name
 302           in: query
 303           description:
 304           required: false
 305           type: string
 306   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
 307     put:
 308       tags:
 309         - CloudInfrastructure
 310       summary: see node definition for valid relationships
 311       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
 312       consumes:
 313         - application/json
 314         - application/xml
 315       produces:
 316         - application/json
 317         - application/xml
 318       responses:
 319         "default":
 320           description: Response codes found in [response codes](https://wiki.onap.org/).
 321       parameters:
 322         - name: physical-location-id
 323           in: path
 324           description: Unique identifier for physical location, e.g., CLLI
 325           required: true
 326           type: string
 327           example: __PHYSICAL-LOCATION-ID__
 328         - name: body
 329           in: body
 330           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
 331           required: true
 332           schema:
 333             $ref: "#/definitions/relationship"
 334     delete:
 335       tags:
 336         - CloudInfrastructure
 337       summary: delete an existing relationship
 338       description: delete an existing relationship
 339       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
 340       consumes:
 341         - application/json
 342         - application/xml
 343       produces:
 344         - application/json
 345         - application/xml
 346       responses:
 347         "default":
 348           description: Response codes found in [response codes](https://wiki.onap.org/).
 349       parameters:
 350         - name: physical-location-id
 351           in: path
 352           description: Unique identifier for physical location, e.g., CLLI
 353           required: true
 354           type: string
 355           example: __PHYSICAL-LOCATION-ID__
 356   /cloud-infrastructure/complexes/complex/{physical-location-id}:
 357     get:
 358       tags:
 359         - CloudInfrastructure
 360       summary: returns complex
 361       description: returns complex
 362       operationId: getCloudInfrastructureComplexesComplex
 363       produces:
 364         - application/json
 365         - application/xml
 366       responses:
 367         "200":
 368           description: successful operation
 369           schema:
 370               $ref: "#/getDefinitions/complex"
 371         "default":
 372           description: Response codes found in [response codes](https://wiki.onap.org/).
 373       parameters:
 374         - name: physical-location-id
 375           in: path
 376           description: Unique identifier for physical location, e.g., CLLI
 377           required: true
 378           type: string
 379           example: __PHYSICAL-LOCATION-ID__
 380     put:
 381       tags:
 382         - CloudInfrastructure
 383       summary: create or update an existing complex
 384       description: |
 385         Create or update an existing complex.
 386         #
 387         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 388       operationId: createOrUpdateCloudInfrastructureComplexesComplex
 389       consumes:
 390         - application/json
 391         - application/xml
 392       produces:
 393         - application/json
 394         - application/xml
 395       responses:
 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: body
 406           in: body
 407           description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
 408           required: true
 409           schema:
 410             $ref: "#/definitions/complex"
 411     patch:
 412       tags:
 413         - CloudInfrastructure
 414       summary: update an existing complex
 415       description: |
 416         Update an existing complex
 417         #
 418         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 419         The PUT operation will entirely replace an existing object.
 420         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 421         #
 422         Other differences between PUT and PATCH are:
 423         #
 424         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 425         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 426         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 427       operationId: UpdateCloudInfrastructureComplexesComplex
 428       consumes:
 429         - application/json
 430         - application/xml
 431       produces:
 432         - application/json
 433         - application/xml
 434       responses:
 435         "default":
 436           description: Response codes found in [response codes](https://wiki.onap.org/).
 437       parameters:
 438         - name: physical-location-id
 439           in: path
 440           description: Unique identifier for physical location, e.g., CLLI
 441           required: true
 442           type: string
 443           example: __PHYSICAL-LOCATION-ID__
 444         - name: body
 445           in: body
 446           description: complex object that needs to be updated.
 447           required: true
 448           schema:
 449             $ref: "#/patchDefinitions/complex"
 450     delete:
 451       tags:
 452         - CloudInfrastructure
 453       summary: delete an existing complex
 454       description: delete an existing complex
 455       operationId: deleteCloudInfrastructureComplexesComplex
 456       consumes:
 457         - application/json
 458         - application/xml
 459       produces:
 460         - application/json
 461         - application/xml
 462       responses:
 463         "default":
 464           description: Response codes found in [response codes](https://wiki.onap.org/).
 465       parameters:
 466         - name: physical-location-id
 467           in: path
 468           description: Unique identifier for physical location, e.g., CLLI
 469           required: true
 470           type: string
 471           example: __PHYSICAL-LOCATION-ID__
 472         - name: resource-version
 473           in: query
 474           description: resource-version for concurrency
 475           required: true
 476           type: string
 477   /cloud-infrastructure/complexes:
 478     get:
 479       tags:
 480         - CloudInfrastructure
 481       summary: returns complexes
 482       description: returns complexes
 483       operationId: getCloudInfrastructureComplexes
 484       produces:
 485         - application/json
 486         - application/xml
 487       responses:
 488         "200":
 489           description: successful operation
 490           schema:
 491               $ref: "#/getDefinitions/complexes"
 492         "default":
 493           description: Response codes found in [response codes](https://wiki.onap.org/).
 494       parameters:
 495         - name: physical-location-id
 496           in: query
 497           description:
 498           required: false
 499           type: string
 500         - name: data-center-code
 501           in: query
 502           description:
 503           required: false
 504           type: string
 505         - name: complex-name
 506           in: query
 507           description:
 508           required: false
 509           type: string
 510         - name: identity-url
 511           in: query
 512           description:
 513           required: false
 514           type: string
 515   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
 516     put:
 517       tags:
 518         - CloudInfrastructure
 519       summary: see node definition for valid relationships
 520       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 521       consumes:
 522         - application/json
 523         - application/xml
 524       produces:
 525         - application/json
 526         - application/xml
 527       responses:
 528         "default":
 529           description: Response codes found in [response codes](https://wiki.onap.org/).
 530       parameters:
 531         - name: cloud-owner
 532           in: path
 533           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 534           required: true
 535           type: string
 536           example: __CLOUD-OWNER__
 537         - name: cloud-region-id
 538           in: path
 539           description: Identifier used by the vendor for the region. Second part of composite key
 540           required: true
 541           type: string
 542           example: __CLOUD-REGION-ID__
 543         - name: volume-group-id
 544           in: path
 545           description: Unique ID of volume-group.
 546           required: true
 547           type: string
 548           example: __VOLUME-GROUP-ID__
 549         - name: body
 550           in: body
 551           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 552           required: true
 553           schema:
 554             $ref: "#/definitions/relationship"
 555     delete:
 556       tags:
 557         - CloudInfrastructure
 558       summary: delete an existing relationship
 559       description: delete an existing relationship
 560       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 561       consumes:
 562         - application/json
 563         - application/xml
 564       produces:
 565         - application/json
 566         - application/xml
 567       responses:
 568         "default":
 569           description: Response codes found in [response codes](https://wiki.onap.org/).
 570       parameters:
 571         - name: cloud-owner
 572           in: path
 573           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 574           required: true
 575           type: string
 576           example: __CLOUD-OWNER__
 577         - name: cloud-region-id
 578           in: path
 579           description: Identifier used by the vendor for the region. Second part of composite key
 580           required: true
 581           type: string
 582           example: __CLOUD-REGION-ID__
 583         - name: volume-group-id
 584           in: path
 585           description: Unique ID of volume-group.
 586           required: true
 587           type: string
 588           example: __VOLUME-GROUP-ID__
 589   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 590     get:
 591       tags:
 592         - CloudInfrastructure
 593       summary: returns volume-group
 594       description: returns volume-group
 595       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 596       produces:
 597         - application/json
 598         - application/xml
 599       responses:
 600         "200":
 601           description: successful operation
 602           schema:
 603               $ref: "#/getDefinitions/volume-group"
 604         "default":
 605           description: Response codes found in [response codes](https://wiki.onap.org/).
 606       parameters:
 607         - name: cloud-owner
 608           in: path
 609           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 610           required: true
 611           type: string
 612           example: __CLOUD-OWNER__
 613         - name: cloud-region-id
 614           in: path
 615           description: Identifier used by the vendor for the region. Second part of composite key
 616           required: true
 617           type: string
 618           example: __CLOUD-REGION-ID__
 619         - name: volume-group-id
 620           in: path
 621           description: Unique ID of volume-group.
 622           required: true
 623           type: string
 624           example: __VOLUME-GROUP-ID__
 625     put:
 626       tags:
 627         - CloudInfrastructure
 628       summary: create or update an existing volume-group
 629       description: |
 630         Create or update an existing volume-group.
 631         #
 632         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 633       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 634       consumes:
 635         - application/json
 636         - application/xml
 637       produces:
 638         - application/json
 639         - application/xml
 640       responses:
 641         "default":
 642           description: Response codes found in [response codes](https://wiki.onap.org/).
 643       parameters:
 644         - name: cloud-owner
 645           in: path
 646           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 647           required: true
 648           type: string
 649           example: __CLOUD-OWNER__
 650         - name: cloud-region-id
 651           in: path
 652           description: Identifier used by the vendor for the region. Second part of composite key
 653           required: true
 654           type: string
 655           example: __CLOUD-REGION-ID__
 656         - name: volume-group-id
 657           in: path
 658           description: Unique ID of volume-group.
 659           required: true
 660           type: string
 661           example: __VOLUME-GROUP-ID__
 662         - name: body
 663           in: body
 664           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 665           required: true
 666           schema:
 667             $ref: "#/definitions/volume-group"
 668     patch:
 669       tags:
 670         - CloudInfrastructure
 671       summary: update an existing volume-group
 672       description: |
 673         Update an existing volume-group
 674         #
 675         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 676         The PUT operation will entirely replace an existing object.
 677         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 678         #
 679         Other differences between PUT and PATCH are:
 680         #
 681         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 682         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 683         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 684       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 685       consumes:
 686         - application/json
 687         - application/xml
 688       produces:
 689         - application/json
 690         - application/xml
 691       responses:
 692         "default":
 693           description: Response codes found in [response codes](https://wiki.onap.org/).
 694       parameters:
 695         - name: cloud-owner
 696           in: path
 697           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 698           required: true
 699           type: string
 700           example: __CLOUD-OWNER__
 701         - name: cloud-region-id
 702           in: path
 703           description: Identifier used by the vendor for the region. Second part of composite key
 704           required: true
 705           type: string
 706           example: __CLOUD-REGION-ID__
 707         - name: volume-group-id
 708           in: path
 709           description: Unique ID of volume-group.
 710           required: true
 711           type: string
 712           example: __VOLUME-GROUP-ID__
 713         - name: body
 714           in: body
 715           description: volume-group object that needs to be updated.
 716           required: true
 717           schema:
 718             $ref: "#/patchDefinitions/volume-group"
 719     delete:
 720       tags:
 721         - CloudInfrastructure
 722       summary: delete an existing volume-group
 723       description: delete an existing volume-group
 724       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 725       consumes:
 726         - application/json
 727         - application/xml
 728       produces:
 729         - application/json
 730         - application/xml
 731       responses:
 732         "default":
 733           description: Response codes found in [response codes](https://wiki.onap.org/).
 734       parameters:
 735         - name: cloud-owner
 736           in: path
 737           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 738           required: true
 739           type: string
 740           example: __CLOUD-OWNER__
 741         - name: cloud-region-id
 742           in: path
 743           description: Identifier used by the vendor for the region. Second part of composite key
 744           required: true
 745           type: string
 746           example: __CLOUD-REGION-ID__
 747         - name: volume-group-id
 748           in: path
 749           description: Unique ID of volume-group.
 750           required: true
 751           type: string
 752           example: __VOLUME-GROUP-ID__
 753         - name: resource-version
 754           in: query
 755           description: resource-version for concurrency
 756           required: true
 757           type: string
 758   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
 759     get:
 760       tags:
 761         - CloudInfrastructure
 762       summary: returns volume-groups
 763       description: returns volume-groups
 764       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
 765       produces:
 766         - application/json
 767         - application/xml
 768       responses:
 769         "200":
 770           description: successful operation
 771           schema:
 772               $ref: "#/getDefinitions/volume-groups"
 773         "default":
 774           description: Response codes found in [response codes](https://wiki.onap.org/).
 775       parameters:
 776         - name: cloud-owner
 777           in: path
 778           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 779           required: true
 780           type: string
 781           example: __CLOUD-OWNER__
 782         - name: cloud-region-id
 783           in: path
 784           description: Identifier used by the vendor for the region. Second part of composite key
 785           required: true
 786           type: string
 787           example: __CLOUD-REGION-ID__
 788         - name: volume-group-id
 789           in: query
 790           description:
 791           required: false
 792           type: string
 793         - name: volume-group-name
 794           in: query
 795           description:
 796           required: false
 797           type: string
 798         - name: heat-stack-id
 799           in: query
 800           description:
 801           required: false
 802           type: string
 803         - name: vnf-type
 804           in: query
 805           description:
 806           required: false
 807           type: string
 808   /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:
 809     put:
 810       tags:
 811         - CloudInfrastructure
 812       summary: see node definition for valid relationships
 813       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 814       consumes:
 815         - application/json
 816         - application/xml
 817       produces:
 818         - application/json
 819         - application/xml
 820       responses:
 821         "default":
 822           description: Response codes found in [response codes](https://wiki.onap.org/).
 823       parameters:
 824         - name: cloud-owner
 825           in: path
 826           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 827           required: true
 828           type: string
 829           example: __CLOUD-OWNER__
 830         - name: cloud-region-id
 831           in: path
 832           description: Identifier used by the vendor for the region. Second part of composite key
 833           required: true
 834           type: string
 835           example: __CLOUD-REGION-ID__
 836         - name: tenant-id
 837           in: path
 838           description: Unique id relative to the cloud-region.
 839           required: true
 840           type: string
 841           example: __TENANT-ID__
 842         - name: vserver-id
 843           in: path
 844           description: Unique identifier for this vserver relative to its tenant
 845           required: true
 846           type: string
 847           example: __VSERVER-ID__
 848         - name: volume-id
 849           in: path
 850           description: Unique ID of block storage volume relative to the vserver.
 851           required: true
 852           type: string
 853           example: __VOLUME-ID__
 854         - name: body
 855           in: body
 856           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
 857           required: true
 858           schema:
 859             $ref: "#/definitions/relationship"
 860     delete:
 861       tags:
 862         - CloudInfrastructure
 863       summary: delete an existing relationship
 864       description: delete an existing relationship
 865       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 866       consumes:
 867         - application/json
 868         - application/xml
 869       produces:
 870         - application/json
 871         - application/xml
 872       responses:
 873         "default":
 874           description: Response codes found in [response codes](https://wiki.onap.org/).
 875       parameters:
 876         - name: cloud-owner
 877           in: path
 878           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 879           required: true
 880           type: string
 881           example: __CLOUD-OWNER__
 882         - name: cloud-region-id
 883           in: path
 884           description: Identifier used by the vendor for the region. Second part of composite key
 885           required: true
 886           type: string
 887           example: __CLOUD-REGION-ID__
 888         - name: tenant-id
 889           in: path
 890           description: Unique id relative to the cloud-region.
 891           required: true
 892           type: string
 893           example: __TENANT-ID__
 894         - name: vserver-id
 895           in: path
 896           description: Unique identifier for this vserver relative to its tenant
 897           required: true
 898           type: string
 899           example: __VSERVER-ID__
 900         - name: volume-id
 901           in: path
 902           description: Unique ID of block storage volume relative to the vserver.
 903           required: true
 904           type: string
 905           example: __VOLUME-ID__
 906   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
 907     get:
 908       tags:
 909         - CloudInfrastructure
 910       summary: returns volume
 911       description: returns volume
 912       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 913       produces:
 914         - application/json
 915         - application/xml
 916       responses:
 917         "200":
 918           description: successful operation
 919           schema:
 920               $ref: "#/getDefinitions/volume"
 921         "default":
 922           description: Response codes found in [response codes](https://wiki.onap.org/).
 923       parameters:
 924         - name: cloud-owner
 925           in: path
 926           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 927           required: true
 928           type: string
 929           example: __CLOUD-OWNER__
 930         - name: cloud-region-id
 931           in: path
 932           description: Identifier used by the vendor for the region. Second part of composite key
 933           required: true
 934           type: string
 935           example: __CLOUD-REGION-ID__
 936         - name: tenant-id
 937           in: path
 938           description: Unique id relative to the cloud-region.
 939           required: true
 940           type: string
 941           example: __TENANT-ID__
 942         - name: vserver-id
 943           in: path
 944           description: Unique identifier for this vserver relative to its tenant
 945           required: true
 946           type: string
 947           example: __VSERVER-ID__
 948         - name: volume-id
 949           in: path
 950           description: Unique ID of block storage volume relative to the vserver.
 951           required: true
 952           type: string
 953           example: __VOLUME-ID__
 954     put:
 955       tags:
 956         - CloudInfrastructure
 957       summary: create or update an existing volume
 958       description: |
 959         Create or update an existing volume.
 960         #
 961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 962       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 963       consumes:
 964         - application/json
 965         - application/xml
 966       produces:
 967         - application/json
 968         - application/xml
 969       responses:
 970         "default":
 971           description: Response codes found in [response codes](https://wiki.onap.org/).
 972       parameters:
 973         - name: cloud-owner
 974           in: path
 975           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 976           required: true
 977           type: string
 978           example: __CLOUD-OWNER__
 979         - name: cloud-region-id
 980           in: path
 981           description: Identifier used by the vendor for the region. Second part of composite key
 982           required: true
 983           type: string
 984           example: __CLOUD-REGION-ID__
 985         - name: tenant-id
 986           in: path
 987           description: Unique id relative to the cloud-region.
 988           required: true
 989           type: string
 990           example: __TENANT-ID__
 991         - name: vserver-id
 992           in: path
 993           description: Unique identifier for this vserver relative to its tenant
 994           required: true
 995           type: string
 996           example: __VSERVER-ID__
 997         - name: volume-id
 998           in: path
 999           description: Unique ID of block storage volume relative to the vserver.
1000           required: true
1001           type: string
1002           example: __VOLUME-ID__
1003         - name: body
1004           in: body
1005           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1006           required: true
1007           schema:
1008             $ref: "#/definitions/volume"
1009     patch:
1010       tags:
1011         - CloudInfrastructure
1012       summary: update an existing volume
1013       description: |
1014         Update an existing volume
1015         #
1016         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1017         The PUT operation will entirely replace an existing object.
1018         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1019         #
1020         Other differences between PUT and PATCH are:
1021         #
1022         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1023         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1024         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1025       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1026       consumes:
1027         - application/json
1028         - application/xml
1029       produces:
1030         - application/json
1031         - application/xml
1032       responses:
1033         "default":
1034           description: Response codes found in [response codes](https://wiki.onap.org/).
1035       parameters:
1036         - name: cloud-owner
1037           in: path
1038           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1039           required: true
1040           type: string
1041           example: __CLOUD-OWNER__
1042         - name: cloud-region-id
1043           in: path
1044           description: Identifier used by the vendor for the region. Second part of composite key
1045           required: true
1046           type: string
1047           example: __CLOUD-REGION-ID__
1048         - name: tenant-id
1049           in: path
1050           description: Unique id relative to the cloud-region.
1051           required: true
1052           type: string
1053           example: __TENANT-ID__
1054         - name: vserver-id
1055           in: path
1056           description: Unique identifier for this vserver relative to its tenant
1057           required: true
1058           type: string
1059           example: __VSERVER-ID__
1060         - name: volume-id
1061           in: path
1062           description: Unique ID of block storage volume relative to the vserver.
1063           required: true
1064           type: string
1065           example: __VOLUME-ID__
1066         - name: body
1067           in: body
1068           description: volume object that needs to be updated.
1069           required: true
1070           schema:
1071             $ref: "#/patchDefinitions/volume"
1072     delete:
1073       tags:
1074         - CloudInfrastructure
1075       summary: delete an existing volume
1076       description: delete an existing volume
1077       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1078       consumes:
1079         - application/json
1080         - application/xml
1081       produces:
1082         - application/json
1083         - application/xml
1084       responses:
1085         "default":
1086           description: Response codes found in [response codes](https://wiki.onap.org/).
1087       parameters:
1088         - name: cloud-owner
1089           in: path
1090           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1091           required: true
1092           type: string
1093           example: __CLOUD-OWNER__
1094         - name: cloud-region-id
1095           in: path
1096           description: Identifier used by the vendor for the region. Second part of composite key
1097           required: true
1098           type: string
1099           example: __CLOUD-REGION-ID__
1100         - name: tenant-id
1101           in: path
1102           description: Unique id relative to the cloud-region.
1103           required: true
1104           type: string
1105           example: __TENANT-ID__
1106         - name: vserver-id
1107           in: path
1108           description: Unique identifier for this vserver relative to its tenant
1109           required: true
1110           type: string
1111           example: __VSERVER-ID__
1112         - name: volume-id
1113           in: path
1114           description: Unique ID of block storage volume relative to the vserver.
1115           required: true
1116           type: string
1117           example: __VOLUME-ID__
1118         - name: resource-version
1119           in: query
1120           description: resource-version for concurrency
1121           required: true
1122           type: string
1123   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1124     get:
1125       tags:
1126         - CloudInfrastructure
1127       summary: returns volumes
1128       description: returns volumes
1129       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1130       produces:
1131         - application/json
1132         - application/xml
1133       responses:
1134         "200":
1135           description: successful operation
1136           schema:
1137               $ref: "#/getDefinitions/volumes"
1138         "default":
1139           description: Response codes found in [response codes](https://wiki.onap.org/).
1140       parameters:
1141         - name: cloud-owner
1142           in: path
1143           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1144           required: true
1145           type: string
1146           example: __CLOUD-OWNER__
1147         - name: cloud-region-id
1148           in: path
1149           description: Identifier used by the vendor for the region. Second part of composite key
1150           required: true
1151           type: string
1152           example: __CLOUD-REGION-ID__
1153         - name: tenant-id
1154           in: path
1155           description: Unique id relative to the cloud-region.
1156           required: true
1157           type: string
1158           example: __TENANT-ID__
1159         - name: vserver-id
1160           in: path
1161           description: Unique identifier for this vserver relative to its tenant
1162           required: true
1163           type: string
1164           example: __VSERVER-ID__
1165         - name: volume-id
1166           in: query
1167           description:
1168           required: false
1169           type: string
1170   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1171     put:
1172       tags:
1173         - CloudInfrastructure
1174       summary: see node definition for valid relationships
1175       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1176       consumes:
1177         - application/json
1178         - application/xml
1179       produces:
1180         - application/json
1181         - application/xml
1182       responses:
1183         "default":
1184           description: Response codes found in [response codes](https://wiki.onap.org/).
1185       parameters:
1186         - name: cloud-owner
1187           in: path
1188           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1189           required: true
1190           type: string
1191           example: __CLOUD-OWNER__
1192         - name: cloud-region-id
1193           in: path
1194           description: Identifier used by the vendor for the region. Second part of composite key
1195           required: true
1196           type: string
1197           example: __CLOUD-REGION-ID__
1198         - name: tenant-id
1199           in: path
1200           description: Unique id relative to the cloud-region.
1201           required: true
1202           type: string
1203           example: __TENANT-ID__
1204         - name: vserver-id
1205           in: path
1206           description: Unique identifier for this vserver relative to its tenant
1207           required: true
1208           type: string
1209           example: __VSERVER-ID__
1210         - name: body
1211           in: body
1212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1213           required: true
1214           schema:
1215             $ref: "#/definitions/relationship"
1216     delete:
1217       tags:
1218         - CloudInfrastructure
1219       summary: delete an existing relationship
1220       description: delete an existing relationship
1221       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1222       consumes:
1223         - application/json
1224         - application/xml
1225       produces:
1226         - application/json
1227         - application/xml
1228       responses:
1229         "default":
1230           description: Response codes found in [response codes](https://wiki.onap.org/).
1231       parameters:
1232         - name: cloud-owner
1233           in: path
1234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1235           required: true
1236           type: string
1237           example: __CLOUD-OWNER__
1238         - name: cloud-region-id
1239           in: path
1240           description: Identifier used by the vendor for the region. Second part of composite key
1241           required: true
1242           type: string
1243           example: __CLOUD-REGION-ID__
1244         - name: tenant-id
1245           in: path
1246           description: Unique id relative to the cloud-region.
1247           required: true
1248           type: string
1249           example: __TENANT-ID__
1250         - name: vserver-id
1251           in: path
1252           description: Unique identifier for this vserver relative to its tenant
1253           required: true
1254           type: string
1255           example: __VSERVER-ID__
1256   /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:
1257     put:
1258       tags:
1259         - CloudInfrastructure
1260       summary: see node definition for valid relationships
1261       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1262       consumes:
1263         - application/json
1264         - application/xml
1265       produces:
1266         - application/json
1267         - application/xml
1268       responses:
1269         "default":
1270           description: Response codes found in [response codes](https://wiki.onap.org/).
1271       parameters:
1272         - name: cloud-owner
1273           in: path
1274           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1275           required: true
1276           type: string
1277           example: __CLOUD-OWNER__
1278         - name: cloud-region-id
1279           in: path
1280           description: Identifier used by the vendor for the region. Second part of composite key
1281           required: true
1282           type: string
1283           example: __CLOUD-REGION-ID__
1284         - name: tenant-id
1285           in: path
1286           description: Unique id relative to the cloud-region.
1287           required: true
1288           type: string
1289           example: __TENANT-ID__
1290         - name: vserver-id
1291           in: path
1292           description: Unique identifier for this vserver relative to its tenant
1293           required: true
1294           type: string
1295           example: __VSERVER-ID__
1296         - name: interface-name
1297           in: path
1298           description: Name given to the interface
1299           required: true
1300           type: string
1301           example: __INTERFACE-NAME__
1302         - name: vlan-interface
1303           in: path
1304           description: String that identifies the interface
1305           required: true
1306           type: string
1307           example: __VLAN-INTERFACE__
1308         - name: body
1309           in: body
1310           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1311           required: true
1312           schema:
1313             $ref: "#/definitions/relationship"
1314     delete:
1315       tags:
1316         - CloudInfrastructure
1317       summary: delete an existing relationship
1318       description: delete an existing relationship
1319       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1320       consumes:
1321         - application/json
1322         - application/xml
1323       produces:
1324         - application/json
1325         - application/xml
1326       responses:
1327         "default":
1328           description: Response codes found in [response codes](https://wiki.onap.org/).
1329       parameters:
1330         - name: cloud-owner
1331           in: path
1332           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1333           required: true
1334           type: string
1335           example: __CLOUD-OWNER__
1336         - name: cloud-region-id
1337           in: path
1338           description: Identifier used by the vendor for the region. Second part of composite key
1339           required: true
1340           type: string
1341           example: __CLOUD-REGION-ID__
1342         - name: tenant-id
1343           in: path
1344           description: Unique id relative to the cloud-region.
1345           required: true
1346           type: string
1347           example: __TENANT-ID__
1348         - name: vserver-id
1349           in: path
1350           description: Unique identifier for this vserver relative to its tenant
1351           required: true
1352           type: string
1353           example: __VSERVER-ID__
1354         - name: interface-name
1355           in: path
1356           description: Name given to the interface
1357           required: true
1358           type: string
1359           example: __INTERFACE-NAME__
1360         - name: vlan-interface
1361           in: path
1362           description: String that identifies the interface
1363           required: true
1364           type: string
1365           example: __VLAN-INTERFACE__
1366   /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:
1367     put:
1368       tags:
1369         - CloudInfrastructure
1370       summary: see node definition for valid relationships
1371       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1372       consumes:
1373         - application/json
1374         - application/xml
1375       produces:
1376         - application/json
1377         - application/xml
1378       responses:
1379         "default":
1380           description: Response codes found in [response codes](https://wiki.onap.org/).
1381       parameters:
1382         - name: cloud-owner
1383           in: path
1384           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1385           required: true
1386           type: string
1387           example: __CLOUD-OWNER__
1388         - name: cloud-region-id
1389           in: path
1390           description: Identifier used by the vendor for the region. Second part of composite key
1391           required: true
1392           type: string
1393           example: __CLOUD-REGION-ID__
1394         - name: tenant-id
1395           in: path
1396           description: Unique id relative to the cloud-region.
1397           required: true
1398           type: string
1399           example: __TENANT-ID__
1400         - name: vserver-id
1401           in: path
1402           description: Unique identifier for this vserver relative to its tenant
1403           required: true
1404           type: string
1405           example: __VSERVER-ID__
1406         - name: interface-name
1407           in: path
1408           description: Name given to the interface
1409           required: true
1410           type: string
1411           example: __INTERFACE-NAME__
1412         - name: vlan-interface
1413           in: path
1414           description: String that identifies the interface
1415           required: true
1416           type: string
1417           example: __VLAN-INTERFACE__
1418         - name: l3-interface-ipv4-address
1419           in: path
1420           description: IP address
1421           required: true
1422           type: string
1423           example: __L3-INTERFACE-IPV4-ADDRESS__
1424         - name: body
1425           in: body
1426           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1427           required: true
1428           schema:
1429             $ref: "#/definitions/relationship"
1430     delete:
1431       tags:
1432         - CloudInfrastructure
1433       summary: delete an existing relationship
1434       description: delete an existing relationship
1435       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1436       consumes:
1437         - application/json
1438         - application/xml
1439       produces:
1440         - application/json
1441         - application/xml
1442       responses:
1443         "default":
1444           description: Response codes found in [response codes](https://wiki.onap.org/).
1445       parameters:
1446         - name: cloud-owner
1447           in: path
1448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1449           required: true
1450           type: string
1451           example: __CLOUD-OWNER__
1452         - name: cloud-region-id
1453           in: path
1454           description: Identifier used by the vendor for the region. Second part of composite key
1455           required: true
1456           type: string
1457           example: __CLOUD-REGION-ID__
1458         - name: tenant-id
1459           in: path
1460           description: Unique id relative to the cloud-region.
1461           required: true
1462           type: string
1463           example: __TENANT-ID__
1464         - name: vserver-id
1465           in: path
1466           description: Unique identifier for this vserver relative to its tenant
1467           required: true
1468           type: string
1469           example: __VSERVER-ID__
1470         - name: interface-name
1471           in: path
1472           description: Name given to the interface
1473           required: true
1474           type: string
1475           example: __INTERFACE-NAME__
1476         - name: vlan-interface
1477           in: path
1478           description: String that identifies the interface
1479           required: true
1480           type: string
1481           example: __VLAN-INTERFACE__
1482         - name: l3-interface-ipv4-address
1483           in: path
1484           description: IP address
1485           required: true
1486           type: string
1487           example: __L3-INTERFACE-IPV4-ADDRESS__
1488   /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}:
1489     get:
1490       tags:
1491         - CloudInfrastructure
1492       summary: returns l3-interface-ipv4-address-list
1493       description: returns l3-interface-ipv4-address-list
1494       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1495       produces:
1496         - application/json
1497         - application/xml
1498       responses:
1499         "200":
1500           description: successful operation
1501           schema:
1502               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1503         "default":
1504           description: Response codes found in [response codes](https://wiki.onap.org/).
1505       parameters:
1506         - name: cloud-owner
1507           in: path
1508           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1509           required: true
1510           type: string
1511           example: __CLOUD-OWNER__
1512         - name: cloud-region-id
1513           in: path
1514           description: Identifier used by the vendor for the region. Second part of composite key
1515           required: true
1516           type: string
1517           example: __CLOUD-REGION-ID__
1518         - name: tenant-id
1519           in: path
1520           description: Unique id relative to the cloud-region.
1521           required: true
1522           type: string
1523           example: __TENANT-ID__
1524         - name: vserver-id
1525           in: path
1526           description: Unique identifier for this vserver relative to its tenant
1527           required: true
1528           type: string
1529           example: __VSERVER-ID__
1530         - name: interface-name
1531           in: path
1532           description: Name given to the interface
1533           required: true
1534           type: string
1535           example: __INTERFACE-NAME__
1536         - name: vlan-interface
1537           in: path
1538           description: String that identifies the interface
1539           required: true
1540           type: string
1541           example: __VLAN-INTERFACE__
1542         - name: l3-interface-ipv4-address
1543           in: path
1544           description: IP address
1545           required: true
1546           type: string
1547           example: __L3-INTERFACE-IPV4-ADDRESS__
1548     put:
1549       tags:
1550         - CloudInfrastructure
1551       summary: create or update an existing l3-interface-ipv4-address-list
1552       description: |
1553         Create or update an existing l3-interface-ipv4-address-list.
1554         #
1555         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1557       consumes:
1558         - application/json
1559         - application/xml
1560       produces:
1561         - application/json
1562         - application/xml
1563       responses:
1564         "default":
1565           description: Response codes found in [response codes](https://wiki.onap.org/).
1566       parameters:
1567         - name: cloud-owner
1568           in: path
1569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1570           required: true
1571           type: string
1572           example: __CLOUD-OWNER__
1573         - name: cloud-region-id
1574           in: path
1575           description: Identifier used by the vendor for the region. Second part of composite key
1576           required: true
1577           type: string
1578           example: __CLOUD-REGION-ID__
1579         - name: tenant-id
1580           in: path
1581           description: Unique id relative to the cloud-region.
1582           required: true
1583           type: string
1584           example: __TENANT-ID__
1585         - name: vserver-id
1586           in: path
1587           description: Unique identifier for this vserver relative to its tenant
1588           required: true
1589           type: string
1590           example: __VSERVER-ID__
1591         - name: interface-name
1592           in: path
1593           description: Name given to the interface
1594           required: true
1595           type: string
1596           example: __INTERFACE-NAME__
1597         - name: vlan-interface
1598           in: path
1599           description: String that identifies the interface
1600           required: true
1601           type: string
1602           example: __VLAN-INTERFACE__
1603         - name: l3-interface-ipv4-address
1604           in: path
1605           description: IP address
1606           required: true
1607           type: string
1608           example: __L3-INTERFACE-IPV4-ADDRESS__
1609         - name: body
1610           in: body
1611           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1612           required: true
1613           schema:
1614             $ref: "#/definitions/l3-interface-ipv4-address-list"
1615     patch:
1616       tags:
1617         - CloudInfrastructure
1618       summary: update an existing l3-interface-ipv4-address-list
1619       description: |
1620         Update an existing l3-interface-ipv4-address-list
1621         #
1622         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1623         The PUT operation will entirely replace an existing object.
1624         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1625         #
1626         Other differences between PUT and PATCH are:
1627         #
1628         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1629         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1630         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1631       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1632       consumes:
1633         - application/json
1634         - application/xml
1635       produces:
1636         - application/json
1637         - application/xml
1638       responses:
1639         "default":
1640           description: Response codes found in [response codes](https://wiki.onap.org/).
1641       parameters:
1642         - name: cloud-owner
1643           in: path
1644           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1645           required: true
1646           type: string
1647           example: __CLOUD-OWNER__
1648         - name: cloud-region-id
1649           in: path
1650           description: Identifier used by the vendor for the region. Second part of composite key
1651           required: true
1652           type: string
1653           example: __CLOUD-REGION-ID__
1654         - name: tenant-id
1655           in: path
1656           description: Unique id relative to the cloud-region.
1657           required: true
1658           type: string
1659           example: __TENANT-ID__
1660         - name: vserver-id
1661           in: path
1662           description: Unique identifier for this vserver relative to its tenant
1663           required: true
1664           type: string
1665           example: __VSERVER-ID__
1666         - name: interface-name
1667           in: path
1668           description: Name given to the interface
1669           required: true
1670           type: string
1671           example: __INTERFACE-NAME__
1672         - name: vlan-interface
1673           in: path
1674           description: String that identifies the interface
1675           required: true
1676           type: string
1677           example: __VLAN-INTERFACE__
1678         - name: l3-interface-ipv4-address
1679           in: path
1680           description: IP address
1681           required: true
1682           type: string
1683           example: __L3-INTERFACE-IPV4-ADDRESS__
1684         - name: body
1685           in: body
1686           description: l3-interface-ipv4-address-list object that needs to be updated.
1687           required: true
1688           schema:
1689             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1690     delete:
1691       tags:
1692         - CloudInfrastructure
1693       summary: delete an existing l3-interface-ipv4-address-list
1694       description: delete an existing l3-interface-ipv4-address-list
1695       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1696       consumes:
1697         - application/json
1698         - application/xml
1699       produces:
1700         - application/json
1701         - application/xml
1702       responses:
1703         "default":
1704           description: Response codes found in [response codes](https://wiki.onap.org/).
1705       parameters:
1706         - name: cloud-owner
1707           in: path
1708           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1709           required: true
1710           type: string
1711           example: __CLOUD-OWNER__
1712         - name: cloud-region-id
1713           in: path
1714           description: Identifier used by the vendor for the region. Second part of composite key
1715           required: true
1716           type: string
1717           example: __CLOUD-REGION-ID__
1718         - name: tenant-id
1719           in: path
1720           description: Unique id relative to the cloud-region.
1721           required: true
1722           type: string
1723           example: __TENANT-ID__
1724         - name: vserver-id
1725           in: path
1726           description: Unique identifier for this vserver relative to its tenant
1727           required: true
1728           type: string
1729           example: __VSERVER-ID__
1730         - name: interface-name
1731           in: path
1732           description: Name given to the interface
1733           required: true
1734           type: string
1735           example: __INTERFACE-NAME__
1736         - name: vlan-interface
1737           in: path
1738           description: String that identifies the interface
1739           required: true
1740           type: string
1741           example: __VLAN-INTERFACE__
1742         - name: l3-interface-ipv4-address
1743           in: path
1744           description: IP address
1745           required: true
1746           type: string
1747           example: __L3-INTERFACE-IPV4-ADDRESS__
1748         - name: resource-version
1749           in: query
1750           description: resource-version for concurrency
1751           required: true
1752           type: string
1753   /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:
1754     put:
1755       tags:
1756         - CloudInfrastructure
1757       summary: see node definition for valid relationships
1758       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1759       consumes:
1760         - application/json
1761         - application/xml
1762       produces:
1763         - application/json
1764         - application/xml
1765       responses:
1766         "default":
1767           description: Response codes found in [response codes](https://wiki.onap.org/).
1768       parameters:
1769         - name: cloud-owner
1770           in: path
1771           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1772           required: true
1773           type: string
1774           example: __CLOUD-OWNER__
1775         - name: cloud-region-id
1776           in: path
1777           description: Identifier used by the vendor for the region. Second part of composite key
1778           required: true
1779           type: string
1780           example: __CLOUD-REGION-ID__
1781         - name: tenant-id
1782           in: path
1783           description: Unique id relative to the cloud-region.
1784           required: true
1785           type: string
1786           example: __TENANT-ID__
1787         - name: vserver-id
1788           in: path
1789           description: Unique identifier for this vserver relative to its tenant
1790           required: true
1791           type: string
1792           example: __VSERVER-ID__
1793         - name: interface-name
1794           in: path
1795           description: Name given to the interface
1796           required: true
1797           type: string
1798           example: __INTERFACE-NAME__
1799         - name: vlan-interface
1800           in: path
1801           description: String that identifies the interface
1802           required: true
1803           type: string
1804           example: __VLAN-INTERFACE__
1805         - name: l3-interface-ipv6-address
1806           in: path
1807           description: IP address
1808           required: true
1809           type: string
1810           example: __L3-INTERFACE-IPV6-ADDRESS__
1811         - name: body
1812           in: body
1813           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1814           required: true
1815           schema:
1816             $ref: "#/definitions/relationship"
1817     delete:
1818       tags:
1819         - CloudInfrastructure
1820       summary: delete an existing relationship
1821       description: delete an existing relationship
1822       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1823       consumes:
1824         - application/json
1825         - application/xml
1826       produces:
1827         - application/json
1828         - application/xml
1829       responses:
1830         "default":
1831           description: Response codes found in [response codes](https://wiki.onap.org/).
1832       parameters:
1833         - name: cloud-owner
1834           in: path
1835           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1836           required: true
1837           type: string
1838           example: __CLOUD-OWNER__
1839         - name: cloud-region-id
1840           in: path
1841           description: Identifier used by the vendor for the region. Second part of composite key
1842           required: true
1843           type: string
1844           example: __CLOUD-REGION-ID__
1845         - name: tenant-id
1846           in: path
1847           description: Unique id relative to the cloud-region.
1848           required: true
1849           type: string
1850           example: __TENANT-ID__
1851         - name: vserver-id
1852           in: path
1853           description: Unique identifier for this vserver relative to its tenant
1854           required: true
1855           type: string
1856           example: __VSERVER-ID__
1857         - name: interface-name
1858           in: path
1859           description: Name given to the interface
1860           required: true
1861           type: string
1862           example: __INTERFACE-NAME__
1863         - name: vlan-interface
1864           in: path
1865           description: String that identifies the interface
1866           required: true
1867           type: string
1868           example: __VLAN-INTERFACE__
1869         - name: l3-interface-ipv6-address
1870           in: path
1871           description: IP address
1872           required: true
1873           type: string
1874           example: __L3-INTERFACE-IPV6-ADDRESS__
1875   /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}:
1876     get:
1877       tags:
1878         - CloudInfrastructure
1879       summary: returns l3-interface-ipv6-address-list
1880       description: returns l3-interface-ipv6-address-list
1881       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1882       produces:
1883         - application/json
1884         - application/xml
1885       responses:
1886         "200":
1887           description: successful operation
1888           schema:
1889               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
1890         "default":
1891           description: Response codes found in [response codes](https://wiki.onap.org/).
1892       parameters:
1893         - name: cloud-owner
1894           in: path
1895           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1896           required: true
1897           type: string
1898           example: __CLOUD-OWNER__
1899         - name: cloud-region-id
1900           in: path
1901           description: Identifier used by the vendor for the region. Second part of composite key
1902           required: true
1903           type: string
1904           example: __CLOUD-REGION-ID__
1905         - name: tenant-id
1906           in: path
1907           description: Unique id relative to the cloud-region.
1908           required: true
1909           type: string
1910           example: __TENANT-ID__
1911         - name: vserver-id
1912           in: path
1913           description: Unique identifier for this vserver relative to its tenant
1914           required: true
1915           type: string
1916           example: __VSERVER-ID__
1917         - name: interface-name
1918           in: path
1919           description: Name given to the interface
1920           required: true
1921           type: string
1922           example: __INTERFACE-NAME__
1923         - name: vlan-interface
1924           in: path
1925           description: String that identifies the interface
1926           required: true
1927           type: string
1928           example: __VLAN-INTERFACE__
1929         - name: l3-interface-ipv6-address
1930           in: path
1931           description: IP address
1932           required: true
1933           type: string
1934           example: __L3-INTERFACE-IPV6-ADDRESS__
1935     put:
1936       tags:
1937         - CloudInfrastructure
1938       summary: create or update an existing l3-interface-ipv6-address-list
1939       description: |
1940         Create or update an existing l3-interface-ipv6-address-list.
1941         #
1942         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1944       consumes:
1945         - application/json
1946         - application/xml
1947       produces:
1948         - application/json
1949         - application/xml
1950       responses:
1951         "default":
1952           description: Response codes found in [response codes](https://wiki.onap.org/).
1953       parameters:
1954         - name: cloud-owner
1955           in: path
1956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1957           required: true
1958           type: string
1959           example: __CLOUD-OWNER__
1960         - name: cloud-region-id
1961           in: path
1962           description: Identifier used by the vendor for the region. Second part of composite key
1963           required: true
1964           type: string
1965           example: __CLOUD-REGION-ID__
1966         - name: tenant-id
1967           in: path
1968           description: Unique id relative to the cloud-region.
1969           required: true
1970           type: string
1971           example: __TENANT-ID__
1972         - name: vserver-id
1973           in: path
1974           description: Unique identifier for this vserver relative to its tenant
1975           required: true
1976           type: string
1977           example: __VSERVER-ID__
1978         - name: interface-name
1979           in: path
1980           description: Name given to the interface
1981           required: true
1982           type: string
1983           example: __INTERFACE-NAME__
1984         - name: vlan-interface
1985           in: path
1986           description: String that identifies the interface
1987           required: true
1988           type: string
1989           example: __VLAN-INTERFACE__
1990         - name: l3-interface-ipv6-address
1991           in: path
1992           description: IP address
1993           required: true
1994           type: string
1995           example: __L3-INTERFACE-IPV6-ADDRESS__
1996         - name: body
1997           in: body
1998           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1999           required: true
2000           schema:
2001             $ref: "#/definitions/l3-interface-ipv6-address-list"
2002     patch:
2003       tags:
2004         - CloudInfrastructure
2005       summary: update an existing l3-interface-ipv6-address-list
2006       description: |
2007         Update an existing l3-interface-ipv6-address-list
2008         #
2009         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2010         The PUT operation will entirely replace an existing object.
2011         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2012         #
2013         Other differences between PUT and PATCH are:
2014         #
2015         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2016         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2017         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2018       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2019       consumes:
2020         - application/json
2021         - application/xml
2022       produces:
2023         - application/json
2024         - application/xml
2025       responses:
2026         "default":
2027           description: Response codes found in [response codes](https://wiki.onap.org/).
2028       parameters:
2029         - name: cloud-owner
2030           in: path
2031           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2032           required: true
2033           type: string
2034           example: __CLOUD-OWNER__
2035         - name: cloud-region-id
2036           in: path
2037           description: Identifier used by the vendor for the region. Second part of composite key
2038           required: true
2039           type: string
2040           example: __CLOUD-REGION-ID__
2041         - name: tenant-id
2042           in: path
2043           description: Unique id relative to the cloud-region.
2044           required: true
2045           type: string
2046           example: __TENANT-ID__
2047         - name: vserver-id
2048           in: path
2049           description: Unique identifier for this vserver relative to its tenant
2050           required: true
2051           type: string
2052           example: __VSERVER-ID__
2053         - name: interface-name
2054           in: path
2055           description: Name given to the interface
2056           required: true
2057           type: string
2058           example: __INTERFACE-NAME__
2059         - name: vlan-interface
2060           in: path
2061           description: String that identifies the interface
2062           required: true
2063           type: string
2064           example: __VLAN-INTERFACE__
2065         - name: l3-interface-ipv6-address
2066           in: path
2067           description: IP address
2068           required: true
2069           type: string
2070           example: __L3-INTERFACE-IPV6-ADDRESS__
2071         - name: body
2072           in: body
2073           description: l3-interface-ipv6-address-list object that needs to be updated.
2074           required: true
2075           schema:
2076             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2077     delete:
2078       tags:
2079         - CloudInfrastructure
2080       summary: delete an existing l3-interface-ipv6-address-list
2081       description: delete an existing l3-interface-ipv6-address-list
2082       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2083       consumes:
2084         - application/json
2085         - application/xml
2086       produces:
2087         - application/json
2088         - application/xml
2089       responses:
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: resource-version
2136           in: query
2137           description: resource-version for concurrency
2138           required: true
2139           type: string
2140   /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}:
2141     get:
2142       tags:
2143         - CloudInfrastructure
2144       summary: returns vlan
2145       description: returns vlan
2146       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2147       produces:
2148         - application/json
2149         - application/xml
2150       responses:
2151         "200":
2152           description: successful operation
2153           schema:
2154               $ref: "#/getDefinitions/vlan"
2155         "default":
2156           description: Response codes found in [response codes](https://wiki.onap.org/).
2157       parameters:
2158         - name: cloud-owner
2159           in: path
2160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2161           required: true
2162           type: string
2163           example: __CLOUD-OWNER__
2164         - name: cloud-region-id
2165           in: path
2166           description: Identifier used by the vendor for the region. Second part of composite key
2167           required: true
2168           type: string
2169           example: __CLOUD-REGION-ID__
2170         - name: tenant-id
2171           in: path
2172           description: Unique id relative to the cloud-region.
2173           required: true
2174           type: string
2175           example: __TENANT-ID__
2176         - name: vserver-id
2177           in: path
2178           description: Unique identifier for this vserver relative to its tenant
2179           required: true
2180           type: string
2181           example: __VSERVER-ID__
2182         - name: interface-name
2183           in: path
2184           description: Name given to the interface
2185           required: true
2186           type: string
2187           example: __INTERFACE-NAME__
2188         - name: vlan-interface
2189           in: path
2190           description: String that identifies the interface
2191           required: true
2192           type: string
2193           example: __VLAN-INTERFACE__
2194     put:
2195       tags:
2196         - CloudInfrastructure
2197       summary: create or update an existing vlan
2198       description: |
2199         Create or update an existing vlan.
2200         #
2201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2202       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2203       consumes:
2204         - application/json
2205         - application/xml
2206       produces:
2207         - application/json
2208         - application/xml
2209       responses:
2210         "default":
2211           description: Response codes found in [response codes](https://wiki.onap.org/).
2212       parameters:
2213         - name: cloud-owner
2214           in: path
2215           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2216           required: true
2217           type: string
2218           example: __CLOUD-OWNER__
2219         - name: cloud-region-id
2220           in: path
2221           description: Identifier used by the vendor for the region. Second part of composite key
2222           required: true
2223           type: string
2224           example: __CLOUD-REGION-ID__
2225         - name: tenant-id
2226           in: path
2227           description: Unique id relative to the cloud-region.
2228           required: true
2229           type: string
2230           example: __TENANT-ID__
2231         - name: vserver-id
2232           in: path
2233           description: Unique identifier for this vserver relative to its tenant
2234           required: true
2235           type: string
2236           example: __VSERVER-ID__
2237         - name: interface-name
2238           in: path
2239           description: Name given to the interface
2240           required: true
2241           type: string
2242           example: __INTERFACE-NAME__
2243         - name: vlan-interface
2244           in: path
2245           description: String that identifies the interface
2246           required: true
2247           type: string
2248           example: __VLAN-INTERFACE__
2249         - name: body
2250           in: body
2251           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2252           required: true
2253           schema:
2254             $ref: "#/definitions/vlan"
2255     patch:
2256       tags:
2257         - CloudInfrastructure
2258       summary: update an existing vlan
2259       description: |
2260         Update an existing vlan
2261         #
2262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2263         The PUT operation will entirely replace an existing object.
2264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2265         #
2266         Other differences between PUT and PATCH are:
2267         #
2268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2271       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2272       consumes:
2273         - application/json
2274         - application/xml
2275       produces:
2276         - application/json
2277         - application/xml
2278       responses:
2279         "default":
2280           description: Response codes found in [response codes](https://wiki.onap.org/).
2281       parameters:
2282         - name: cloud-owner
2283           in: path
2284           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2285           required: true
2286           type: string
2287           example: __CLOUD-OWNER__
2288         - name: cloud-region-id
2289           in: path
2290           description: Identifier used by the vendor for the region. Second part of composite key
2291           required: true
2292           type: string
2293           example: __CLOUD-REGION-ID__
2294         - name: tenant-id
2295           in: path
2296           description: Unique id relative to the cloud-region.
2297           required: true
2298           type: string
2299           example: __TENANT-ID__
2300         - name: vserver-id
2301           in: path
2302           description: Unique identifier for this vserver relative to its tenant
2303           required: true
2304           type: string
2305           example: __VSERVER-ID__
2306         - name: interface-name
2307           in: path
2308           description: Name given to the interface
2309           required: true
2310           type: string
2311           example: __INTERFACE-NAME__
2312         - name: vlan-interface
2313           in: path
2314           description: String that identifies the interface
2315           required: true
2316           type: string
2317           example: __VLAN-INTERFACE__
2318         - name: body
2319           in: body
2320           description: vlan object that needs to be updated.
2321           required: true
2322           schema:
2323             $ref: "#/patchDefinitions/vlan"
2324     delete:
2325       tags:
2326         - CloudInfrastructure
2327       summary: delete an existing vlan
2328       description: delete an existing vlan
2329       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2330       consumes:
2331         - application/json
2332         - application/xml
2333       produces:
2334         - application/json
2335         - application/xml
2336       responses:
2337         "default":
2338           description: Response codes found in [response codes](https://wiki.onap.org/).
2339       parameters:
2340         - name: cloud-owner
2341           in: path
2342           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2343           required: true
2344           type: string
2345           example: __CLOUD-OWNER__
2346         - name: cloud-region-id
2347           in: path
2348           description: Identifier used by the vendor for the region. Second part of composite key
2349           required: true
2350           type: string
2351           example: __CLOUD-REGION-ID__
2352         - name: tenant-id
2353           in: path
2354           description: Unique id relative to the cloud-region.
2355           required: true
2356           type: string
2357           example: __TENANT-ID__
2358         - name: vserver-id
2359           in: path
2360           description: Unique identifier for this vserver relative to its tenant
2361           required: true
2362           type: string
2363           example: __VSERVER-ID__
2364         - name: interface-name
2365           in: path
2366           description: Name given to the interface
2367           required: true
2368           type: string
2369           example: __INTERFACE-NAME__
2370         - name: vlan-interface
2371           in: path
2372           description: String that identifies the interface
2373           required: true
2374           type: string
2375           example: __VLAN-INTERFACE__
2376         - name: resource-version
2377           in: query
2378           description: resource-version for concurrency
2379           required: true
2380           type: string
2381   /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:
2382     get:
2383       tags:
2384         - CloudInfrastructure
2385       summary: returns vlans
2386       description: returns vlans
2387       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2388       produces:
2389         - application/json
2390         - application/xml
2391       responses:
2392         "200":
2393           description: successful operation
2394           schema:
2395               $ref: "#/getDefinitions/vlans"
2396         "default":
2397           description: Response codes found in [response codes](https://wiki.onap.org/).
2398       parameters:
2399         - name: cloud-owner
2400           in: path
2401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2402           required: true
2403           type: string
2404           example: __CLOUD-OWNER__
2405         - name: cloud-region-id
2406           in: path
2407           description: Identifier used by the vendor for the region. Second part of composite key
2408           required: true
2409           type: string
2410           example: __CLOUD-REGION-ID__
2411         - name: tenant-id
2412           in: path
2413           description: Unique id relative to the cloud-region.
2414           required: true
2415           type: string
2416           example: __TENANT-ID__
2417         - name: vserver-id
2418           in: path
2419           description: Unique identifier for this vserver relative to its tenant
2420           required: true
2421           type: string
2422           example: __VSERVER-ID__
2423         - name: interface-name
2424           in: path
2425           description: Name given to the interface
2426           required: true
2427           type: string
2428           example: __INTERFACE-NAME__
2429         - name: vlan-interface
2430           in: query
2431           description:
2432           required: false
2433           type: string
2434         - name: vlan-id-inner
2435           in: query
2436           description:
2437           required: false
2438           type: integer
2439           format: int64
2440         - name: vpn-id
2441           in: query
2442           description:
2443           required: false
2444           type: string
2445   /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:
2446     put:
2447       tags:
2448         - CloudInfrastructure
2449       summary: see node definition for valid relationships
2450       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2451       consumes:
2452         - application/json
2453         - application/xml
2454       produces:
2455         - application/json
2456         - application/xml
2457       responses:
2458         "default":
2459           description: Response codes found in [response codes](https://wiki.onap.org/).
2460       parameters:
2461         - name: cloud-owner
2462           in: path
2463           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2464           required: true
2465           type: string
2466           example: __CLOUD-OWNER__
2467         - name: cloud-region-id
2468           in: path
2469           description: Identifier used by the vendor for the region. Second part of composite key
2470           required: true
2471           type: string
2472           example: __CLOUD-REGION-ID__
2473         - name: tenant-id
2474           in: path
2475           description: Unique id relative to the cloud-region.
2476           required: true
2477           type: string
2478           example: __TENANT-ID__
2479         - name: vserver-id
2480           in: path
2481           description: Unique identifier for this vserver relative to its tenant
2482           required: true
2483           type: string
2484           example: __VSERVER-ID__
2485         - name: interface-name
2486           in: path
2487           description: Name given to the interface
2488           required: true
2489           type: string
2490           example: __INTERFACE-NAME__
2491         - name: pci-id
2492           in: path
2493           description: PCI ID used to identify the sriov-vf
2494           required: true
2495           type: string
2496           example: __PCI-ID__
2497         - name: body
2498           in: body
2499           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2500           required: true
2501           schema:
2502             $ref: "#/definitions/relationship"
2503     delete:
2504       tags:
2505         - CloudInfrastructure
2506       summary: delete an existing relationship
2507       description: delete an existing relationship
2508       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2509       consumes:
2510         - application/json
2511         - application/xml
2512       produces:
2513         - application/json
2514         - application/xml
2515       responses:
2516         "default":
2517           description: Response codes found in [response codes](https://wiki.onap.org/).
2518       parameters:
2519         - name: cloud-owner
2520           in: path
2521           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2522           required: true
2523           type: string
2524           example: __CLOUD-OWNER__
2525         - name: cloud-region-id
2526           in: path
2527           description: Identifier used by the vendor for the region. Second part of composite key
2528           required: true
2529           type: string
2530           example: __CLOUD-REGION-ID__
2531         - name: tenant-id
2532           in: path
2533           description: Unique id relative to the cloud-region.
2534           required: true
2535           type: string
2536           example: __TENANT-ID__
2537         - name: vserver-id
2538           in: path
2539           description: Unique identifier for this vserver relative to its tenant
2540           required: true
2541           type: string
2542           example: __VSERVER-ID__
2543         - name: interface-name
2544           in: path
2545           description: Name given to the interface
2546           required: true
2547           type: string
2548           example: __INTERFACE-NAME__
2549         - name: pci-id
2550           in: path
2551           description: PCI ID used to identify the sriov-vf
2552           required: true
2553           type: string
2554           example: __PCI-ID__
2555   /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}:
2556     get:
2557       tags:
2558         - CloudInfrastructure
2559       summary: returns sriov-vf
2560       description: returns sriov-vf
2561       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2562       produces:
2563         - application/json
2564         - application/xml
2565       responses:
2566         "200":
2567           description: successful operation
2568           schema:
2569               $ref: "#/getDefinitions/sriov-vf"
2570         "default":
2571           description: Response codes found in [response codes](https://wiki.onap.org/).
2572       parameters:
2573         - name: cloud-owner
2574           in: path
2575           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2576           required: true
2577           type: string
2578           example: __CLOUD-OWNER__
2579         - name: cloud-region-id
2580           in: path
2581           description: Identifier used by the vendor for the region. Second part of composite key
2582           required: true
2583           type: string
2584           example: __CLOUD-REGION-ID__
2585         - name: tenant-id
2586           in: path
2587           description: Unique id relative to the cloud-region.
2588           required: true
2589           type: string
2590           example: __TENANT-ID__
2591         - name: vserver-id
2592           in: path
2593           description: Unique identifier for this vserver relative to its tenant
2594           required: true
2595           type: string
2596           example: __VSERVER-ID__
2597         - name: interface-name
2598           in: path
2599           description: Name given to the interface
2600           required: true
2601           type: string
2602           example: __INTERFACE-NAME__
2603         - name: pci-id
2604           in: path
2605           description: PCI ID used to identify the sriov-vf
2606           required: true
2607           type: string
2608           example: __PCI-ID__
2609     put:
2610       tags:
2611         - CloudInfrastructure
2612       summary: create or update an existing sriov-vf
2613       description: |
2614         Create or update an existing sriov-vf.
2615         #
2616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2617       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2618       consumes:
2619         - application/json
2620         - application/xml
2621       produces:
2622         - application/json
2623         - application/xml
2624       responses:
2625         "default":
2626           description: Response codes found in [response codes](https://wiki.onap.org/).
2627       parameters:
2628         - name: cloud-owner
2629           in: path
2630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2631           required: true
2632           type: string
2633           example: __CLOUD-OWNER__
2634         - name: cloud-region-id
2635           in: path
2636           description: Identifier used by the vendor for the region. Second part of composite key
2637           required: true
2638           type: string
2639           example: __CLOUD-REGION-ID__
2640         - name: tenant-id
2641           in: path
2642           description: Unique id relative to the cloud-region.
2643           required: true
2644           type: string
2645           example: __TENANT-ID__
2646         - name: vserver-id
2647           in: path
2648           description: Unique identifier for this vserver relative to its tenant
2649           required: true
2650           type: string
2651           example: __VSERVER-ID__
2652         - name: interface-name
2653           in: path
2654           description: Name given to the interface
2655           required: true
2656           type: string
2657           example: __INTERFACE-NAME__
2658         - name: pci-id
2659           in: path
2660           description: PCI ID used to identify the sriov-vf
2661           required: true
2662           type: string
2663           example: __PCI-ID__
2664         - name: body
2665           in: body
2666           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2667           required: true
2668           schema:
2669             $ref: "#/definitions/sriov-vf"
2670     patch:
2671       tags:
2672         - CloudInfrastructure
2673       summary: update an existing sriov-vf
2674       description: |
2675         Update an existing sriov-vf
2676         #
2677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2678         The PUT operation will entirely replace an existing object.
2679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2680         #
2681         Other differences between PUT and PATCH are:
2682         #
2683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2686       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2687       consumes:
2688         - application/json
2689         - application/xml
2690       produces:
2691         - application/json
2692         - application/xml
2693       responses:
2694         "default":
2695           description: Response codes found in [response codes](https://wiki.onap.org/).
2696       parameters:
2697         - name: cloud-owner
2698           in: path
2699           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2700           required: true
2701           type: string
2702           example: __CLOUD-OWNER__
2703         - name: cloud-region-id
2704           in: path
2705           description: Identifier used by the vendor for the region. Second part of composite key
2706           required: true
2707           type: string
2708           example: __CLOUD-REGION-ID__
2709         - name: tenant-id
2710           in: path
2711           description: Unique id relative to the cloud-region.
2712           required: true
2713           type: string
2714           example: __TENANT-ID__
2715         - name: vserver-id
2716           in: path
2717           description: Unique identifier for this vserver relative to its tenant
2718           required: true
2719           type: string
2720           example: __VSERVER-ID__
2721         - name: interface-name
2722           in: path
2723           description: Name given to the interface
2724           required: true
2725           type: string
2726           example: __INTERFACE-NAME__
2727         - name: pci-id
2728           in: path
2729           description: PCI ID used to identify the sriov-vf
2730           required: true
2731           type: string
2732           example: __PCI-ID__
2733         - name: body
2734           in: body
2735           description: sriov-vf object that needs to be updated.
2736           required: true
2737           schema:
2738             $ref: "#/patchDefinitions/sriov-vf"
2739     delete:
2740       tags:
2741         - CloudInfrastructure
2742       summary: delete an existing sriov-vf
2743       description: delete an existing sriov-vf
2744       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2745       consumes:
2746         - application/json
2747         - application/xml
2748       produces:
2749         - application/json
2750         - application/xml
2751       responses:
2752         "default":
2753           description: Response codes found in [response codes](https://wiki.onap.org/).
2754       parameters:
2755         - name: cloud-owner
2756           in: path
2757           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2758           required: true
2759           type: string
2760           example: __CLOUD-OWNER__
2761         - name: cloud-region-id
2762           in: path
2763           description: Identifier used by the vendor for the region. Second part of composite key
2764           required: true
2765           type: string
2766           example: __CLOUD-REGION-ID__
2767         - name: tenant-id
2768           in: path
2769           description: Unique id relative to the cloud-region.
2770           required: true
2771           type: string
2772           example: __TENANT-ID__
2773         - name: vserver-id
2774           in: path
2775           description: Unique identifier for this vserver relative to its tenant
2776           required: true
2777           type: string
2778           example: __VSERVER-ID__
2779         - name: interface-name
2780           in: path
2781           description: Name given to the interface
2782           required: true
2783           type: string
2784           example: __INTERFACE-NAME__
2785         - name: pci-id
2786           in: path
2787           description: PCI ID used to identify the sriov-vf
2788           required: true
2789           type: string
2790           example: __PCI-ID__
2791         - name: resource-version
2792           in: query
2793           description: resource-version for concurrency
2794           required: true
2795           type: string
2796   /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:
2797     get:
2798       tags:
2799         - CloudInfrastructure
2800       summary: returns sriov-vfs
2801       description: returns sriov-vfs
2802       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
2803       produces:
2804         - application/json
2805         - application/xml
2806       responses:
2807         "200":
2808           description: successful operation
2809           schema:
2810               $ref: "#/getDefinitions/sriov-vfs"
2811         "default":
2812           description: Response codes found in [response codes](https://wiki.onap.org/).
2813       parameters:
2814         - name: cloud-owner
2815           in: path
2816           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2817           required: true
2818           type: string
2819           example: __CLOUD-OWNER__
2820         - name: cloud-region-id
2821           in: path
2822           description: Identifier used by the vendor for the region. Second part of composite key
2823           required: true
2824           type: string
2825           example: __CLOUD-REGION-ID__
2826         - name: tenant-id
2827           in: path
2828           description: Unique id relative to the cloud-region.
2829           required: true
2830           type: string
2831           example: __TENANT-ID__
2832         - name: vserver-id
2833           in: path
2834           description: Unique identifier for this vserver relative to its tenant
2835           required: true
2836           type: string
2837           example: __VSERVER-ID__
2838         - name: interface-name
2839           in: path
2840           description: Name given to the interface
2841           required: true
2842           type: string
2843           example: __INTERFACE-NAME__
2844         - name: pci-id
2845           in: query
2846           description:
2847           required: false
2848           type: string
2849         - name: vf-vlan-filter
2850           in: query
2851           description:
2852           required: false
2853           type: string
2854         - name: vf-mac-filter
2855           in: query
2856           description:
2857           required: false
2858           type: string
2859         - name: vf-vlan-strip
2860           in: query
2861           description:
2862           required: false
2863           type: boolean
2864         - name: neutron-network-id
2865           in: query
2866           description:
2867           required: false
2868           type: string
2869   /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:
2870     put:
2871       tags:
2872         - CloudInfrastructure
2873       summary: see node definition for valid relationships
2874       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2875       consumes:
2876         - application/json
2877         - application/xml
2878       produces:
2879         - application/json
2880         - application/xml
2881       responses:
2882         "default":
2883           description: Response codes found in [response codes](https://wiki.onap.org/).
2884       parameters:
2885         - name: cloud-owner
2886           in: path
2887           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2888           required: true
2889           type: string
2890           example: __CLOUD-OWNER__
2891         - name: cloud-region-id
2892           in: path
2893           description: Identifier used by the vendor for the region. Second part of composite key
2894           required: true
2895           type: string
2896           example: __CLOUD-REGION-ID__
2897         - name: tenant-id
2898           in: path
2899           description: Unique id relative to the cloud-region.
2900           required: true
2901           type: string
2902           example: __TENANT-ID__
2903         - name: vserver-id
2904           in: path
2905           description: Unique identifier for this vserver relative to its tenant
2906           required: true
2907           type: string
2908           example: __VSERVER-ID__
2909         - name: interface-name
2910           in: path
2911           description: Name given to the interface
2912           required: true
2913           type: string
2914           example: __INTERFACE-NAME__
2915         - name: body
2916           in: body
2917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
2918           required: true
2919           schema:
2920             $ref: "#/definitions/relationship"
2921     delete:
2922       tags:
2923         - CloudInfrastructure
2924       summary: delete an existing relationship
2925       description: delete an existing relationship
2926       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2927       consumes:
2928         - application/json
2929         - application/xml
2930       produces:
2931         - application/json
2932         - application/xml
2933       responses:
2934         "default":
2935           description: Response codes found in [response codes](https://wiki.onap.org/).
2936       parameters:
2937         - name: cloud-owner
2938           in: path
2939           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2940           required: true
2941           type: string
2942           example: __CLOUD-OWNER__
2943         - name: cloud-region-id
2944           in: path
2945           description: Identifier used by the vendor for the region. Second part of composite key
2946           required: true
2947           type: string
2948           example: __CLOUD-REGION-ID__
2949         - name: tenant-id
2950           in: path
2951           description: Unique id relative to the cloud-region.
2952           required: true
2953           type: string
2954           example: __TENANT-ID__
2955         - name: vserver-id
2956           in: path
2957           description: Unique identifier for this vserver relative to its tenant
2958           required: true
2959           type: string
2960           example: __VSERVER-ID__
2961         - name: interface-name
2962           in: path
2963           description: Name given to the interface
2964           required: true
2965           type: string
2966           example: __INTERFACE-NAME__
2967   /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:
2968     put:
2969       tags:
2970         - CloudInfrastructure
2971       summary: see node definition for valid relationships
2972       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2973       consumes:
2974         - application/json
2975         - application/xml
2976       produces:
2977         - application/json
2978         - application/xml
2979       responses:
2980         "default":
2981           description: Response codes found in [response codes](https://wiki.onap.org/).
2982       parameters:
2983         - name: cloud-owner
2984           in: path
2985           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2986           required: true
2987           type: string
2988           example: __CLOUD-OWNER__
2989         - name: cloud-region-id
2990           in: path
2991           description: Identifier used by the vendor for the region. Second part of composite key
2992           required: true
2993           type: string
2994           example: __CLOUD-REGION-ID__
2995         - name: tenant-id
2996           in: path
2997           description: Unique id relative to the cloud-region.
2998           required: true
2999           type: string
3000           example: __TENANT-ID__
3001         - name: vserver-id
3002           in: path
3003           description: Unique identifier for this vserver relative to its tenant
3004           required: true
3005           type: string
3006           example: __VSERVER-ID__
3007         - name: interface-name
3008           in: path
3009           description: Name given to the interface
3010           required: true
3011           type: string
3012           example: __INTERFACE-NAME__
3013         - name: l3-interface-ipv4-address
3014           in: path
3015           description: IP address
3016           required: true
3017           type: string
3018           example: __L3-INTERFACE-IPV4-ADDRESS__
3019         - name: body
3020           in: body
3021           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3022           required: true
3023           schema:
3024             $ref: "#/definitions/relationship"
3025     delete:
3026       tags:
3027         - CloudInfrastructure
3028       summary: delete an existing relationship
3029       description: delete an existing relationship
3030       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3031       consumes:
3032         - application/json
3033         - application/xml
3034       produces:
3035         - application/json
3036         - application/xml
3037       responses:
3038         "default":
3039           description: Response codes found in [response codes](https://wiki.onap.org/).
3040       parameters:
3041         - name: cloud-owner
3042           in: path
3043           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3044           required: true
3045           type: string
3046           example: __CLOUD-OWNER__
3047         - name: cloud-region-id
3048           in: path
3049           description: Identifier used by the vendor for the region. Second part of composite key
3050           required: true
3051           type: string
3052           example: __CLOUD-REGION-ID__
3053         - name: tenant-id
3054           in: path
3055           description: Unique id relative to the cloud-region.
3056           required: true
3057           type: string
3058           example: __TENANT-ID__
3059         - name: vserver-id
3060           in: path
3061           description: Unique identifier for this vserver relative to its tenant
3062           required: true
3063           type: string
3064           example: __VSERVER-ID__
3065         - name: interface-name
3066           in: path
3067           description: Name given to the interface
3068           required: true
3069           type: string
3070           example: __INTERFACE-NAME__
3071         - name: l3-interface-ipv4-address
3072           in: path
3073           description: IP address
3074           required: true
3075           type: string
3076           example: __L3-INTERFACE-IPV4-ADDRESS__
3077   /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}:
3078     get:
3079       tags:
3080         - CloudInfrastructure
3081       summary: returns l3-interface-ipv4-address-list
3082       description: returns l3-interface-ipv4-address-list
3083       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3084       produces:
3085         - application/json
3086         - application/xml
3087       responses:
3088         "200":
3089           description: successful operation
3090           schema:
3091               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3092         "default":
3093           description: Response codes found in [response codes](https://wiki.onap.org/).
3094       parameters:
3095         - name: cloud-owner
3096           in: path
3097           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3098           required: true
3099           type: string
3100           example: __CLOUD-OWNER__
3101         - name: cloud-region-id
3102           in: path
3103           description: Identifier used by the vendor for the region. Second part of composite key
3104           required: true
3105           type: string
3106           example: __CLOUD-REGION-ID__
3107         - name: tenant-id
3108           in: path
3109           description: Unique id relative to the cloud-region.
3110           required: true
3111           type: string
3112           example: __TENANT-ID__
3113         - name: vserver-id
3114           in: path
3115           description: Unique identifier for this vserver relative to its tenant
3116           required: true
3117           type: string
3118           example: __VSERVER-ID__
3119         - name: interface-name
3120           in: path
3121           description: Name given to the interface
3122           required: true
3123           type: string
3124           example: __INTERFACE-NAME__
3125         - name: l3-interface-ipv4-address
3126           in: path
3127           description: IP address
3128           required: true
3129           type: string
3130           example: __L3-INTERFACE-IPV4-ADDRESS__
3131     put:
3132       tags:
3133         - CloudInfrastructure
3134       summary: create or update an existing l3-interface-ipv4-address-list
3135       description: |
3136         Create or update an existing l3-interface-ipv4-address-list.
3137         #
3138         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3139       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3140       consumes:
3141         - application/json
3142         - application/xml
3143       produces:
3144         - application/json
3145         - application/xml
3146       responses:
3147         "default":
3148           description: Response codes found in [response codes](https://wiki.onap.org/).
3149       parameters:
3150         - name: cloud-owner
3151           in: path
3152           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3153           required: true
3154           type: string
3155           example: __CLOUD-OWNER__
3156         - name: cloud-region-id
3157           in: path
3158           description: Identifier used by the vendor for the region. Second part of composite key
3159           required: true
3160           type: string
3161           example: __CLOUD-REGION-ID__
3162         - name: tenant-id
3163           in: path
3164           description: Unique id relative to the cloud-region.
3165           required: true
3166           type: string
3167           example: __TENANT-ID__
3168         - name: vserver-id
3169           in: path
3170           description: Unique identifier for this vserver relative to its tenant
3171           required: true
3172           type: string
3173           example: __VSERVER-ID__
3174         - name: interface-name
3175           in: path
3176           description: Name given to the interface
3177           required: true
3178           type: string
3179           example: __INTERFACE-NAME__
3180         - name: l3-interface-ipv4-address
3181           in: path
3182           description: IP address
3183           required: true
3184           type: string
3185           example: __L3-INTERFACE-IPV4-ADDRESS__
3186         - name: body
3187           in: body
3188           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3189           required: true
3190           schema:
3191             $ref: "#/definitions/l3-interface-ipv4-address-list"
3192     patch:
3193       tags:
3194         - CloudInfrastructure
3195       summary: update an existing l3-interface-ipv4-address-list
3196       description: |
3197         Update an existing l3-interface-ipv4-address-list
3198         #
3199         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3200         The PUT operation will entirely replace an existing object.
3201         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3202         #
3203         Other differences between PUT and PATCH are:
3204         #
3205         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3206         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3207         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3208       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3209       consumes:
3210         - application/json
3211         - application/xml
3212       produces:
3213         - application/json
3214         - application/xml
3215       responses:
3216         "default":
3217           description: Response codes found in [response codes](https://wiki.onap.org/).
3218       parameters:
3219         - name: cloud-owner
3220           in: path
3221           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3222           required: true
3223           type: string
3224           example: __CLOUD-OWNER__
3225         - name: cloud-region-id
3226           in: path
3227           description: Identifier used by the vendor for the region. Second part of composite key
3228           required: true
3229           type: string
3230           example: __CLOUD-REGION-ID__
3231         - name: tenant-id
3232           in: path
3233           description: Unique id relative to the cloud-region.
3234           required: true
3235           type: string
3236           example: __TENANT-ID__
3237         - name: vserver-id
3238           in: path
3239           description: Unique identifier for this vserver relative to its tenant
3240           required: true
3241           type: string
3242           example: __VSERVER-ID__
3243         - name: interface-name
3244           in: path
3245           description: Name given to the interface
3246           required: true
3247           type: string
3248           example: __INTERFACE-NAME__
3249         - name: l3-interface-ipv4-address
3250           in: path
3251           description: IP address
3252           required: true
3253           type: string
3254           example: __L3-INTERFACE-IPV4-ADDRESS__
3255         - name: body
3256           in: body
3257           description: l3-interface-ipv4-address-list object that needs to be updated.
3258           required: true
3259           schema:
3260             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3261     delete:
3262       tags:
3263         - CloudInfrastructure
3264       summary: delete an existing l3-interface-ipv4-address-list
3265       description: delete an existing l3-interface-ipv4-address-list
3266       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3267       consumes:
3268         - application/json
3269         - application/xml
3270       produces:
3271         - application/json
3272         - application/xml
3273       responses:
3274         "default":
3275           description: Response codes found in [response codes](https://wiki.onap.org/).
3276       parameters:
3277         - name: cloud-owner
3278           in: path
3279           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3280           required: true
3281           type: string
3282           example: __CLOUD-OWNER__
3283         - name: cloud-region-id
3284           in: path
3285           description: Identifier used by the vendor for the region. Second part of composite key
3286           required: true
3287           type: string
3288           example: __CLOUD-REGION-ID__
3289         - name: tenant-id
3290           in: path
3291           description: Unique id relative to the cloud-region.
3292           required: true
3293           type: string
3294           example: __TENANT-ID__
3295         - name: vserver-id
3296           in: path
3297           description: Unique identifier for this vserver relative to its tenant
3298           required: true
3299           type: string
3300           example: __VSERVER-ID__
3301         - name: interface-name
3302           in: path
3303           description: Name given to the interface
3304           required: true
3305           type: string
3306           example: __INTERFACE-NAME__
3307         - name: l3-interface-ipv4-address
3308           in: path
3309           description: IP address
3310           required: true
3311           type: string
3312           example: __L3-INTERFACE-IPV4-ADDRESS__
3313         - name: resource-version
3314           in: query
3315           description: resource-version for concurrency
3316           required: true
3317           type: string
3318   /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:
3319     put:
3320       tags:
3321         - CloudInfrastructure
3322       summary: see node definition for valid relationships
3323       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3324       consumes:
3325         - application/json
3326         - application/xml
3327       produces:
3328         - application/json
3329         - application/xml
3330       responses:
3331         "default":
3332           description: Response codes found in [response codes](https://wiki.onap.org/).
3333       parameters:
3334         - name: cloud-owner
3335           in: path
3336           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3337           required: true
3338           type: string
3339           example: __CLOUD-OWNER__
3340         - name: cloud-region-id
3341           in: path
3342           description: Identifier used by the vendor for the region. Second part of composite key
3343           required: true
3344           type: string
3345           example: __CLOUD-REGION-ID__
3346         - name: tenant-id
3347           in: path
3348           description: Unique id relative to the cloud-region.
3349           required: true
3350           type: string
3351           example: __TENANT-ID__
3352         - name: vserver-id
3353           in: path
3354           description: Unique identifier for this vserver relative to its tenant
3355           required: true
3356           type: string
3357           example: __VSERVER-ID__
3358         - name: interface-name
3359           in: path
3360           description: Name given to the interface
3361           required: true
3362           type: string
3363           example: __INTERFACE-NAME__
3364         - name: l3-interface-ipv6-address
3365           in: path
3366           description: IP address
3367           required: true
3368           type: string
3369           example: __L3-INTERFACE-IPV6-ADDRESS__
3370         - name: body
3371           in: body
3372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3373           required: true
3374           schema:
3375             $ref: "#/definitions/relationship"
3376     delete:
3377       tags:
3378         - CloudInfrastructure
3379       summary: delete an existing relationship
3380       description: delete an existing relationship
3381       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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: l3-interface-ipv6-address
3423           in: path
3424           description: IP address
3425           required: true
3426           type: string
3427           example: __L3-INTERFACE-IPV6-ADDRESS__
3428   /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}:
3429     get:
3430       tags:
3431         - CloudInfrastructure
3432       summary: returns l3-interface-ipv6-address-list
3433       description: returns l3-interface-ipv6-address-list
3434       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3435       produces:
3436         - application/json
3437         - application/xml
3438       responses:
3439         "200":
3440           description: successful operation
3441           schema:
3442               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3443         "default":
3444           description: Response codes found in [response codes](https://wiki.onap.org/).
3445       parameters:
3446         - name: cloud-owner
3447           in: path
3448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3449           required: true
3450           type: string
3451           example: __CLOUD-OWNER__
3452         - name: cloud-region-id
3453           in: path
3454           description: Identifier used by the vendor for the region. Second part of composite key
3455           required: true
3456           type: string
3457           example: __CLOUD-REGION-ID__
3458         - name: tenant-id
3459           in: path
3460           description: Unique id relative to the cloud-region.
3461           required: true
3462           type: string
3463           example: __TENANT-ID__
3464         - name: vserver-id
3465           in: path
3466           description: Unique identifier for this vserver relative to its tenant
3467           required: true
3468           type: string
3469           example: __VSERVER-ID__
3470         - name: interface-name
3471           in: path
3472           description: Name given to the interface
3473           required: true
3474           type: string
3475           example: __INTERFACE-NAME__
3476         - name: l3-interface-ipv6-address
3477           in: path
3478           description: IP address
3479           required: true
3480           type: string
3481           example: __L3-INTERFACE-IPV6-ADDRESS__
3482     put:
3483       tags:
3484         - CloudInfrastructure
3485       summary: create or update an existing l3-interface-ipv6-address-list
3486       description: |
3487         Create or update an existing l3-interface-ipv6-address-list.
3488         #
3489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3490       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3491       consumes:
3492         - application/json
3493         - application/xml
3494       produces:
3495         - application/json
3496         - application/xml
3497       responses:
3498         "default":
3499           description: Response codes found in [response codes](https://wiki.onap.org/).
3500       parameters:
3501         - name: cloud-owner
3502           in: path
3503           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3504           required: true
3505           type: string
3506           example: __CLOUD-OWNER__
3507         - name: cloud-region-id
3508           in: path
3509           description: Identifier used by the vendor for the region. Second part of composite key
3510           required: true
3511           type: string
3512           example: __CLOUD-REGION-ID__
3513         - name: tenant-id
3514           in: path
3515           description: Unique id relative to the cloud-region.
3516           required: true
3517           type: string
3518           example: __TENANT-ID__
3519         - name: vserver-id
3520           in: path
3521           description: Unique identifier for this vserver relative to its tenant
3522           required: true
3523           type: string
3524           example: __VSERVER-ID__
3525         - name: interface-name
3526           in: path
3527           description: Name given to the interface
3528           required: true
3529           type: string
3530           example: __INTERFACE-NAME__
3531         - name: l3-interface-ipv6-address
3532           in: path
3533           description: IP address
3534           required: true
3535           type: string
3536           example: __L3-INTERFACE-IPV6-ADDRESS__
3537         - name: body
3538           in: body
3539           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3540           required: true
3541           schema:
3542             $ref: "#/definitions/l3-interface-ipv6-address-list"
3543     patch:
3544       tags:
3545         - CloudInfrastructure
3546       summary: update an existing l3-interface-ipv6-address-list
3547       description: |
3548         Update an existing l3-interface-ipv6-address-list
3549         #
3550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3551         The PUT operation will entirely replace an existing object.
3552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3553         #
3554         Other differences between PUT and PATCH are:
3555         #
3556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3559       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3560       consumes:
3561         - application/json
3562         - application/xml
3563       produces:
3564         - application/json
3565         - application/xml
3566       responses:
3567         "default":
3568           description: Response codes found in [response codes](https://wiki.onap.org/).
3569       parameters:
3570         - name: cloud-owner
3571           in: path
3572           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3573           required: true
3574           type: string
3575           example: __CLOUD-OWNER__
3576         - name: cloud-region-id
3577           in: path
3578           description: Identifier used by the vendor for the region. Second part of composite key
3579           required: true
3580           type: string
3581           example: __CLOUD-REGION-ID__
3582         - name: tenant-id
3583           in: path
3584           description: Unique id relative to the cloud-region.
3585           required: true
3586           type: string
3587           example: __TENANT-ID__
3588         - name: vserver-id
3589           in: path
3590           description: Unique identifier for this vserver relative to its tenant
3591           required: true
3592           type: string
3593           example: __VSERVER-ID__
3594         - name: interface-name
3595           in: path
3596           description: Name given to the interface
3597           required: true
3598           type: string
3599           example: __INTERFACE-NAME__
3600         - name: l3-interface-ipv6-address
3601           in: path
3602           description: IP address
3603           required: true
3604           type: string
3605           example: __L3-INTERFACE-IPV6-ADDRESS__
3606         - name: body
3607           in: body
3608           description: l3-interface-ipv6-address-list object that needs to be updated.
3609           required: true
3610           schema:
3611             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
3612     delete:
3613       tags:
3614         - CloudInfrastructure
3615       summary: delete an existing l3-interface-ipv6-address-list
3616       description: delete an existing l3-interface-ipv6-address-list
3617       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3618       consumes:
3619         - application/json
3620         - application/xml
3621       produces:
3622         - application/json
3623         - application/xml
3624       responses:
3625         "default":
3626           description: Response codes found in [response codes](https://wiki.onap.org/).
3627       parameters:
3628         - name: cloud-owner
3629           in: path
3630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3631           required: true
3632           type: string
3633           example: __CLOUD-OWNER__
3634         - name: cloud-region-id
3635           in: path
3636           description: Identifier used by the vendor for the region. Second part of composite key
3637           required: true
3638           type: string
3639           example: __CLOUD-REGION-ID__
3640         - name: tenant-id
3641           in: path
3642           description: Unique id relative to the cloud-region.
3643           required: true
3644           type: string
3645           example: __TENANT-ID__
3646         - name: vserver-id
3647           in: path
3648           description: Unique identifier for this vserver relative to its tenant
3649           required: true
3650           type: string
3651           example: __VSERVER-ID__
3652         - name: interface-name
3653           in: path
3654           description: Name given to the interface
3655           required: true
3656           type: string
3657           example: __INTERFACE-NAME__
3658         - name: l3-interface-ipv6-address
3659           in: path
3660           description: IP address
3661           required: true
3662           type: string
3663           example: __L3-INTERFACE-IPV6-ADDRESS__
3664         - name: resource-version
3665           in: query
3666           description: resource-version for concurrency
3667           required: true
3668           type: string
3669   /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}:
3670     get:
3671       tags:
3672         - CloudInfrastructure
3673       summary: returns l-interface
3674       description: returns l-interface
3675       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3676       produces:
3677         - application/json
3678         - application/xml
3679       responses:
3680         "200":
3681           description: successful operation
3682           schema:
3683               $ref: "#/getDefinitions/l-interface"
3684         "default":
3685           description: Response codes found in [response codes](https://wiki.onap.org/).
3686       parameters:
3687         - name: cloud-owner
3688           in: path
3689           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3690           required: true
3691           type: string
3692           example: __CLOUD-OWNER__
3693         - name: cloud-region-id
3694           in: path
3695           description: Identifier used by the vendor for the region. Second part of composite key
3696           required: true
3697           type: string
3698           example: __CLOUD-REGION-ID__
3699         - name: tenant-id
3700           in: path
3701           description: Unique id relative to the cloud-region.
3702           required: true
3703           type: string
3704           example: __TENANT-ID__
3705         - name: vserver-id
3706           in: path
3707           description: Unique identifier for this vserver relative to its tenant
3708           required: true
3709           type: string
3710           example: __VSERVER-ID__
3711         - name: interface-name
3712           in: path
3713           description: Name given to the interface
3714           required: true
3715           type: string
3716           example: __INTERFACE-NAME__
3717     put:
3718       tags:
3719         - CloudInfrastructure
3720       summary: create or update an existing l-interface
3721       description: |
3722         Create or update an existing l-interface.
3723         #
3724         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3725       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3726       consumes:
3727         - application/json
3728         - application/xml
3729       produces:
3730         - application/json
3731         - application/xml
3732       responses:
3733         "default":
3734           description: Response codes found in [response codes](https://wiki.onap.org/).
3735       parameters:
3736         - name: cloud-owner
3737           in: path
3738           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3739           required: true
3740           type: string
3741           example: __CLOUD-OWNER__
3742         - name: cloud-region-id
3743           in: path
3744           description: Identifier used by the vendor for the region. Second part of composite key
3745           required: true
3746           type: string
3747           example: __CLOUD-REGION-ID__
3748         - name: tenant-id
3749           in: path
3750           description: Unique id relative to the cloud-region.
3751           required: true
3752           type: string
3753           example: __TENANT-ID__
3754         - name: vserver-id
3755           in: path
3756           description: Unique identifier for this vserver relative to its tenant
3757           required: true
3758           type: string
3759           example: __VSERVER-ID__
3760         - name: interface-name
3761           in: path
3762           description: Name given to the interface
3763           required: true
3764           type: string
3765           example: __INTERFACE-NAME__
3766         - name: body
3767           in: body
3768           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3769           required: true
3770           schema:
3771             $ref: "#/definitions/l-interface"
3772     patch:
3773       tags:
3774         - CloudInfrastructure
3775       summary: update an existing l-interface
3776       description: |
3777         Update an existing l-interface
3778         #
3779         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3780         The PUT operation will entirely replace an existing object.
3781         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3782         #
3783         Other differences between PUT and PATCH are:
3784         #
3785         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3786         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3787         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3788       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3789       consumes:
3790         - application/json
3791         - application/xml
3792       produces:
3793         - application/json
3794         - application/xml
3795       responses:
3796         "default":
3797           description: Response codes found in [response codes](https://wiki.onap.org/).
3798       parameters:
3799         - name: cloud-owner
3800           in: path
3801           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3802           required: true
3803           type: string
3804           example: __CLOUD-OWNER__
3805         - name: cloud-region-id
3806           in: path
3807           description: Identifier used by the vendor for the region. Second part of composite key
3808           required: true
3809           type: string
3810           example: __CLOUD-REGION-ID__
3811         - name: tenant-id
3812           in: path
3813           description: Unique id relative to the cloud-region.
3814           required: true
3815           type: string
3816           example: __TENANT-ID__
3817         - name: vserver-id
3818           in: path
3819           description: Unique identifier for this vserver relative to its tenant
3820           required: true
3821           type: string
3822           example: __VSERVER-ID__
3823         - name: interface-name
3824           in: path
3825           description: Name given to the interface
3826           required: true
3827           type: string
3828           example: __INTERFACE-NAME__
3829         - name: body
3830           in: body
3831           description: l-interface object that needs to be updated.
3832           required: true
3833           schema:
3834             $ref: "#/patchDefinitions/l-interface"
3835     delete:
3836       tags:
3837         - CloudInfrastructure
3838       summary: delete an existing l-interface
3839       description: delete an existing l-interface
3840       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3841       consumes:
3842         - application/json
3843         - application/xml
3844       produces:
3845         - application/json
3846         - application/xml
3847       responses:
3848         "default":
3849           description: Response codes found in [response codes](https://wiki.onap.org/).
3850       parameters:
3851         - name: cloud-owner
3852           in: path
3853           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3854           required: true
3855           type: string
3856           example: __CLOUD-OWNER__
3857         - name: cloud-region-id
3858           in: path
3859           description: Identifier used by the vendor for the region. Second part of composite key
3860           required: true
3861           type: string
3862           example: __CLOUD-REGION-ID__
3863         - name: tenant-id
3864           in: path
3865           description: Unique id relative to the cloud-region.
3866           required: true
3867           type: string
3868           example: __TENANT-ID__
3869         - name: vserver-id
3870           in: path
3871           description: Unique identifier for this vserver relative to its tenant
3872           required: true
3873           type: string
3874           example: __VSERVER-ID__
3875         - name: interface-name
3876           in: path
3877           description: Name given to the interface
3878           required: true
3879           type: string
3880           example: __INTERFACE-NAME__
3881         - name: resource-version
3882           in: query
3883           description: resource-version for concurrency
3884           required: true
3885           type: string
3886   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
3887     get:
3888       tags:
3889         - CloudInfrastructure
3890       summary: returns l-interfaces
3891       description: returns l-interfaces
3892       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
3893       produces:
3894         - application/json
3895         - application/xml
3896       responses:
3897         "200":
3898           description: successful operation
3899           schema:
3900               $ref: "#/getDefinitions/l-interfaces"
3901         "default":
3902           description: Response codes found in [response codes](https://wiki.onap.org/).
3903       parameters:
3904         - name: cloud-owner
3905           in: path
3906           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3907           required: true
3908           type: string
3909           example: __CLOUD-OWNER__
3910         - name: cloud-region-id
3911           in: path
3912           description: Identifier used by the vendor for the region. Second part of composite key
3913           required: true
3914           type: string
3915           example: __CLOUD-REGION-ID__
3916         - name: tenant-id
3917           in: path
3918           description: Unique id relative to the cloud-region.
3919           required: true
3920           type: string
3921           example: __TENANT-ID__
3922         - name: vserver-id
3923           in: path
3924           description: Unique identifier for this vserver relative to its tenant
3925           required: true
3926           type: string
3927           example: __VSERVER-ID__
3928         - name: interface-name
3929           in: query
3930           description:
3931           required: false
3932           type: string
3933         - name: interface-id
3934           in: query
3935           description:
3936           required: false
3937           type: string
3938         - name: macaddr
3939           in: query
3940           description:
3941           required: false
3942           type: string
3943         - name: network-name
3944           in: query
3945           description:
3946           required: false
3947           type: string
3948   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
3949     get:
3950       tags:
3951         - CloudInfrastructure
3952       summary: returns vserver
3953       description: returns vserver
3954       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3955       produces:
3956         - application/json
3957         - application/xml
3958       responses:
3959         "200":
3960           description: successful operation
3961           schema:
3962               $ref: "#/getDefinitions/vserver"
3963         "default":
3964           description: Response codes found in [response codes](https://wiki.onap.org/).
3965       parameters:
3966         - name: cloud-owner
3967           in: path
3968           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3969           required: true
3970           type: string
3971           example: __CLOUD-OWNER__
3972         - name: cloud-region-id
3973           in: path
3974           description: Identifier used by the vendor for the region. Second part of composite key
3975           required: true
3976           type: string
3977           example: __CLOUD-REGION-ID__
3978         - name: tenant-id
3979           in: path
3980           description: Unique id relative to the cloud-region.
3981           required: true
3982           type: string
3983           example: __TENANT-ID__
3984         - name: vserver-id
3985           in: path
3986           description: Unique identifier for this vserver relative to its tenant
3987           required: true
3988           type: string
3989           example: __VSERVER-ID__
3990     put:
3991       tags:
3992         - CloudInfrastructure
3993       summary: create or update an existing vserver
3994       description: |
3995         Create or update an existing vserver.
3996         #
3997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3998       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3999       consumes:
4000         - application/json
4001         - application/xml
4002       produces:
4003         - application/json
4004         - application/xml
4005       responses:
4006         "default":
4007           description: Response codes found in [response codes](https://wiki.onap.org/).
4008       parameters:
4009         - name: cloud-owner
4010           in: path
4011           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4012           required: true
4013           type: string
4014           example: __CLOUD-OWNER__
4015         - name: cloud-region-id
4016           in: path
4017           description: Identifier used by the vendor for the region. Second part of composite key
4018           required: true
4019           type: string
4020           example: __CLOUD-REGION-ID__
4021         - name: tenant-id
4022           in: path
4023           description: Unique id relative to the cloud-region.
4024           required: true
4025           type: string
4026           example: __TENANT-ID__
4027         - name: vserver-id
4028           in: path
4029           description: Unique identifier for this vserver relative to its tenant
4030           required: true
4031           type: string
4032           example: __VSERVER-ID__
4033         - name: body
4034           in: body
4035           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4036           required: true
4037           schema:
4038             $ref: "#/definitions/vserver"
4039     patch:
4040       tags:
4041         - CloudInfrastructure
4042       summary: update an existing vserver
4043       description: |
4044         Update an existing vserver
4045         #
4046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4047         The PUT operation will entirely replace an existing object.
4048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4049         #
4050         Other differences between PUT and PATCH are:
4051         #
4052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4055       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4056       consumes:
4057         - application/json
4058         - application/xml
4059       produces:
4060         - application/json
4061         - application/xml
4062       responses:
4063         "default":
4064           description: Response codes found in [response codes](https://wiki.onap.org/).
4065       parameters:
4066         - name: cloud-owner
4067           in: path
4068           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4069           required: true
4070           type: string
4071           example: __CLOUD-OWNER__
4072         - name: cloud-region-id
4073           in: path
4074           description: Identifier used by the vendor for the region. Second part of composite key
4075           required: true
4076           type: string
4077           example: __CLOUD-REGION-ID__
4078         - name: tenant-id
4079           in: path
4080           description: Unique id relative to the cloud-region.
4081           required: true
4082           type: string
4083           example: __TENANT-ID__
4084         - name: vserver-id
4085           in: path
4086           description: Unique identifier for this vserver relative to its tenant
4087           required: true
4088           type: string
4089           example: __VSERVER-ID__
4090         - name: body
4091           in: body
4092           description: vserver object that needs to be updated.
4093           required: true
4094           schema:
4095             $ref: "#/patchDefinitions/vserver"
4096     delete:
4097       tags:
4098         - CloudInfrastructure
4099       summary: delete an existing vserver
4100       description: delete an existing vserver
4101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4102       consumes:
4103         - application/json
4104         - application/xml
4105       produces:
4106         - application/json
4107         - application/xml
4108       responses:
4109         "default":
4110           description: Response codes found in [response codes](https://wiki.onap.org/).
4111       parameters:
4112         - name: cloud-owner
4113           in: path
4114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4115           required: true
4116           type: string
4117           example: __CLOUD-OWNER__
4118         - name: cloud-region-id
4119           in: path
4120           description: Identifier used by the vendor for the region. Second part of composite key
4121           required: true
4122           type: string
4123           example: __CLOUD-REGION-ID__
4124         - name: tenant-id
4125           in: path
4126           description: Unique id relative to the cloud-region.
4127           required: true
4128           type: string
4129           example: __TENANT-ID__
4130         - name: vserver-id
4131           in: path
4132           description: Unique identifier for this vserver relative to its tenant
4133           required: true
4134           type: string
4135           example: __VSERVER-ID__
4136         - name: resource-version
4137           in: query
4138           description: resource-version for concurrency
4139           required: true
4140           type: string
4141   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4142     get:
4143       tags:
4144         - CloudInfrastructure
4145       summary: returns vservers
4146       description: returns vservers
4147       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4148       produces:
4149         - application/json
4150         - application/xml
4151       responses:
4152         "200":
4153           description: successful operation
4154           schema:
4155               $ref: "#/getDefinitions/vservers"
4156         "default":
4157           description: Response codes found in [response codes](https://wiki.onap.org/).
4158       parameters:
4159         - name: cloud-owner
4160           in: path
4161           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4162           required: true
4163           type: string
4164           example: __CLOUD-OWNER__
4165         - name: cloud-region-id
4166           in: path
4167           description: Identifier used by the vendor for the region. Second part of composite key
4168           required: true
4169           type: string
4170           example: __CLOUD-REGION-ID__
4171         - name: tenant-id
4172           in: path
4173           description: Unique id relative to the cloud-region.
4174           required: true
4175           type: string
4176           example: __TENANT-ID__
4177         - name: vserver-id
4178           in: query
4179           description:
4180           required: false
4181           type: string
4182         - name: vserver-name
4183           in: query
4184           description:
4185           required: false
4186           type: string
4187         - name: vserver-name2
4188           in: query
4189           description:
4190           required: false
4191           type: string
4192         - name: prov-status
4193           in: query
4194           description:
4195           required: false
4196           type: string
4197         - name: in-maint
4198           in: query
4199           description:
4200           required: false
4201           type: boolean
4202         - name: is-closed-loop-disabled
4203           in: query
4204           description:
4205           required: false
4206           type: boolean
4207   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4208     put:
4209       tags:
4210         - CloudInfrastructure
4211       summary: see node definition for valid relationships
4212       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4213       consumes:
4214         - application/json
4215         - application/xml
4216       produces:
4217         - application/json
4218         - application/xml
4219       responses:
4220         "default":
4221           description: Response codes found in [response codes](https://wiki.onap.org/).
4222       parameters:
4223         - name: cloud-owner
4224           in: path
4225           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4226           required: true
4227           type: string
4228           example: __CLOUD-OWNER__
4229         - name: cloud-region-id
4230           in: path
4231           description: Identifier used by the vendor for the region. Second part of composite key
4232           required: true
4233           type: string
4234           example: __CLOUD-REGION-ID__
4235         - name: tenant-id
4236           in: path
4237           description: Unique id relative to the cloud-region.
4238           required: true
4239           type: string
4240           example: __TENANT-ID__
4241         - name: body
4242           in: body
4243           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4244           required: true
4245           schema:
4246             $ref: "#/definitions/relationship"
4247     delete:
4248       tags:
4249         - CloudInfrastructure
4250       summary: delete an existing relationship
4251       description: delete an existing relationship
4252       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4253       consumes:
4254         - application/json
4255         - application/xml
4256       produces:
4257         - application/json
4258         - application/xml
4259       responses:
4260         "default":
4261           description: Response codes found in [response codes](https://wiki.onap.org/).
4262       parameters:
4263         - name: cloud-owner
4264           in: path
4265           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4266           required: true
4267           type: string
4268           example: __CLOUD-OWNER__
4269         - name: cloud-region-id
4270           in: path
4271           description: Identifier used by the vendor for the region. Second part of composite key
4272           required: true
4273           type: string
4274           example: __CLOUD-REGION-ID__
4275         - name: tenant-id
4276           in: path
4277           description: Unique id relative to the cloud-region.
4278           required: true
4279           type: string
4280           example: __TENANT-ID__
4281   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4282     get:
4283       tags:
4284         - CloudInfrastructure
4285       summary: returns tenant
4286       description: returns tenant
4287       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4288       produces:
4289         - application/json
4290         - application/xml
4291       responses:
4292         "200":
4293           description: successful operation
4294           schema:
4295               $ref: "#/getDefinitions/tenant"
4296         "default":
4297           description: Response codes found in [response codes](https://wiki.onap.org/).
4298       parameters:
4299         - name: cloud-owner
4300           in: path
4301           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4302           required: true
4303           type: string
4304           example: __CLOUD-OWNER__
4305         - name: cloud-region-id
4306           in: path
4307           description: Identifier used by the vendor for the region. Second part of composite key
4308           required: true
4309           type: string
4310           example: __CLOUD-REGION-ID__
4311         - name: tenant-id
4312           in: path
4313           description: Unique id relative to the cloud-region.
4314           required: true
4315           type: string
4316           example: __TENANT-ID__
4317     put:
4318       tags:
4319         - CloudInfrastructure
4320       summary: create or update an existing tenant
4321       description: |
4322         Create or update an existing tenant.
4323         #
4324         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4325       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4326       consumes:
4327         - application/json
4328         - application/xml
4329       produces:
4330         - application/json
4331         - application/xml
4332       responses:
4333         "default":
4334           description: Response codes found in [response codes](https://wiki.onap.org/).
4335       parameters:
4336         - name: cloud-owner
4337           in: path
4338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4339           required: true
4340           type: string
4341           example: __CLOUD-OWNER__
4342         - name: cloud-region-id
4343           in: path
4344           description: Identifier used by the vendor for the region. Second part of composite key
4345           required: true
4346           type: string
4347           example: __CLOUD-REGION-ID__
4348         - name: tenant-id
4349           in: path
4350           description: Unique id relative to the cloud-region.
4351           required: true
4352           type: string
4353           example: __TENANT-ID__
4354         - name: body
4355           in: body
4356           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4357           required: true
4358           schema:
4359             $ref: "#/definitions/tenant"
4360     patch:
4361       tags:
4362         - CloudInfrastructure
4363       summary: update an existing tenant
4364       description: |
4365         Update an existing tenant
4366         #
4367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368         The PUT operation will entirely replace an existing object.
4369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4370         #
4371         Other differences between PUT and PATCH are:
4372         #
4373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4377       consumes:
4378         - application/json
4379         - application/xml
4380       produces:
4381         - application/json
4382         - application/xml
4383       responses:
4384         "default":
4385           description: Response codes found in [response codes](https://wiki.onap.org/).
4386       parameters:
4387         - name: cloud-owner
4388           in: path
4389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4390           required: true
4391           type: string
4392           example: __CLOUD-OWNER__
4393         - name: cloud-region-id
4394           in: path
4395           description: Identifier used by the vendor for the region. Second part of composite key
4396           required: true
4397           type: string
4398           example: __CLOUD-REGION-ID__
4399         - name: tenant-id
4400           in: path
4401           description: Unique id relative to the cloud-region.
4402           required: true
4403           type: string
4404           example: __TENANT-ID__
4405         - name: body
4406           in: body
4407           description: tenant object that needs to be updated.
4408           required: true
4409           schema:
4410             $ref: "#/patchDefinitions/tenant"
4411     delete:
4412       tags:
4413         - CloudInfrastructure
4414       summary: delete an existing tenant
4415       description: delete an existing tenant
4416       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4417       consumes:
4418         - application/json
4419         - application/xml
4420       produces:
4421         - application/json
4422         - application/xml
4423       responses:
4424         "default":
4425           description: Response codes found in [response codes](https://wiki.onap.org/).
4426       parameters:
4427         - name: cloud-owner
4428           in: path
4429           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4430           required: true
4431           type: string
4432           example: __CLOUD-OWNER__
4433         - name: cloud-region-id
4434           in: path
4435           description: Identifier used by the vendor for the region. Second part of composite key
4436           required: true
4437           type: string
4438           example: __CLOUD-REGION-ID__
4439         - name: tenant-id
4440           in: path
4441           description: Unique id relative to the cloud-region.
4442           required: true
4443           type: string
4444           example: __TENANT-ID__
4445         - name: resource-version
4446           in: query
4447           description: resource-version for concurrency
4448           required: true
4449           type: string
4450   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4451     get:
4452       tags:
4453         - CloudInfrastructure
4454       summary: returns tenants
4455       description: returns tenants
4456       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4457       produces:
4458         - application/json
4459         - application/xml
4460       responses:
4461         "200":
4462           description: successful operation
4463           schema:
4464               $ref: "#/getDefinitions/tenants"
4465         "default":
4466           description: Response codes found in [response codes](https://wiki.onap.org/).
4467       parameters:
4468         - name: cloud-owner
4469           in: path
4470           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4471           required: true
4472           type: string
4473           example: __CLOUD-OWNER__
4474         - name: cloud-region-id
4475           in: path
4476           description: Identifier used by the vendor for the region. Second part of composite key
4477           required: true
4478           type: string
4479           example: __CLOUD-REGION-ID__
4480         - name: tenant-id
4481           in: query
4482           description:
4483           required: false
4484           type: string
4485         - name: tenant-name
4486           in: query
4487           description:
4488           required: false
4489           type: string
4490   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4491     put:
4492       tags:
4493         - CloudInfrastructure
4494       summary: see node definition for valid relationships
4495       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4496       consumes:
4497         - application/json
4498         - application/xml
4499       produces:
4500         - application/json
4501         - application/xml
4502       responses:
4503         "default":
4504           description: Response codes found in [response codes](https://wiki.onap.org/).
4505       parameters:
4506         - name: cloud-owner
4507           in: path
4508           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4509           required: true
4510           type: string
4511           example: __CLOUD-OWNER__
4512         - name: cloud-region-id
4513           in: path
4514           description: Identifier used by the vendor for the region. Second part of composite key
4515           required: true
4516           type: string
4517           example: __CLOUD-REGION-ID__
4518         - name: flavor-id
4519           in: path
4520           description: Flavor id, expected to be unique across cloud-region.
4521           required: true
4522           type: string
4523           example: __FLAVOR-ID__
4524         - name: body
4525           in: body
4526           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4527           required: true
4528           schema:
4529             $ref: "#/definitions/relationship"
4530     delete:
4531       tags:
4532         - CloudInfrastructure
4533       summary: delete an existing relationship
4534       description: delete an existing relationship
4535       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4536       consumes:
4537         - application/json
4538         - application/xml
4539       produces:
4540         - application/json
4541         - application/xml
4542       responses:
4543         "default":
4544           description: Response codes found in [response codes](https://wiki.onap.org/).
4545       parameters:
4546         - name: cloud-owner
4547           in: path
4548           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4549           required: true
4550           type: string
4551           example: __CLOUD-OWNER__
4552         - name: cloud-region-id
4553           in: path
4554           description: Identifier used by the vendor for the region. Second part of composite key
4555           required: true
4556           type: string
4557           example: __CLOUD-REGION-ID__
4558         - name: flavor-id
4559           in: path
4560           description: Flavor id, expected to be unique across cloud-region.
4561           required: true
4562           type: string
4563           example: __FLAVOR-ID__
4564   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4565     get:
4566       tags:
4567         - CloudInfrastructure
4568       summary: returns flavor
4569       description: returns flavor
4570       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4571       produces:
4572         - application/json
4573         - application/xml
4574       responses:
4575         "200":
4576           description: successful operation
4577           schema:
4578               $ref: "#/getDefinitions/flavor"
4579         "default":
4580           description: Response codes found in [response codes](https://wiki.onap.org/).
4581       parameters:
4582         - name: cloud-owner
4583           in: path
4584           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4585           required: true
4586           type: string
4587           example: __CLOUD-OWNER__
4588         - name: cloud-region-id
4589           in: path
4590           description: Identifier used by the vendor for the region. Second part of composite key
4591           required: true
4592           type: string
4593           example: __CLOUD-REGION-ID__
4594         - name: flavor-id
4595           in: path
4596           description: Flavor id, expected to be unique across cloud-region.
4597           required: true
4598           type: string
4599           example: __FLAVOR-ID__
4600     put:
4601       tags:
4602         - CloudInfrastructure
4603       summary: create or update an existing flavor
4604       description: |
4605         Create or update an existing flavor.
4606         #
4607         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4608       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4609       consumes:
4610         - application/json
4611         - application/xml
4612       produces:
4613         - application/json
4614         - application/xml
4615       responses:
4616         "default":
4617           description: Response codes found in [response codes](https://wiki.onap.org/).
4618       parameters:
4619         - name: cloud-owner
4620           in: path
4621           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4622           required: true
4623           type: string
4624           example: __CLOUD-OWNER__
4625         - name: cloud-region-id
4626           in: path
4627           description: Identifier used by the vendor for the region. Second part of composite key
4628           required: true
4629           type: string
4630           example: __CLOUD-REGION-ID__
4631         - name: flavor-id
4632           in: path
4633           description: Flavor id, expected to be unique across cloud-region.
4634           required: true
4635           type: string
4636           example: __FLAVOR-ID__
4637         - name: body
4638           in: body
4639           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4640           required: true
4641           schema:
4642             $ref: "#/definitions/flavor"
4643     patch:
4644       tags:
4645         - CloudInfrastructure
4646       summary: update an existing flavor
4647       description: |
4648         Update an existing flavor
4649         #
4650         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4651         The PUT operation will entirely replace an existing object.
4652         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4653         #
4654         Other differences between PUT and PATCH are:
4655         #
4656         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4657         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4658         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4659       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4660       consumes:
4661         - application/json
4662         - application/xml
4663       produces:
4664         - application/json
4665         - application/xml
4666       responses:
4667         "default":
4668           description: Response codes found in [response codes](https://wiki.onap.org/).
4669       parameters:
4670         - name: cloud-owner
4671           in: path
4672           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4673           required: true
4674           type: string
4675           example: __CLOUD-OWNER__
4676         - name: cloud-region-id
4677           in: path
4678           description: Identifier used by the vendor for the region. Second part of composite key
4679           required: true
4680           type: string
4681           example: __CLOUD-REGION-ID__
4682         - name: flavor-id
4683           in: path
4684           description: Flavor id, expected to be unique across cloud-region.
4685           required: true
4686           type: string
4687           example: __FLAVOR-ID__
4688         - name: body
4689           in: body
4690           description: flavor object that needs to be updated.
4691           required: true
4692           schema:
4693             $ref: "#/patchDefinitions/flavor"
4694     delete:
4695       tags:
4696         - CloudInfrastructure
4697       summary: delete an existing flavor
4698       description: delete an existing flavor
4699       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4700       consumes:
4701         - application/json
4702         - application/xml
4703       produces:
4704         - application/json
4705         - application/xml
4706       responses:
4707         "default":
4708           description: Response codes found in [response codes](https://wiki.onap.org/).
4709       parameters:
4710         - name: cloud-owner
4711           in: path
4712           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4713           required: true
4714           type: string
4715           example: __CLOUD-OWNER__
4716         - name: cloud-region-id
4717           in: path
4718           description: Identifier used by the vendor for the region. Second part of composite key
4719           required: true
4720           type: string
4721           example: __CLOUD-REGION-ID__
4722         - name: flavor-id
4723           in: path
4724           description: Flavor id, expected to be unique across cloud-region.
4725           required: true
4726           type: string
4727           example: __FLAVOR-ID__
4728         - name: resource-version
4729           in: query
4730           description: resource-version for concurrency
4731           required: true
4732           type: string
4733   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4734     get:
4735       tags:
4736         - CloudInfrastructure
4737       summary: returns flavors
4738       description: returns flavors
4739       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4740       produces:
4741         - application/json
4742         - application/xml
4743       responses:
4744         "200":
4745           description: successful operation
4746           schema:
4747               $ref: "#/getDefinitions/flavors"
4748         "default":
4749           description: Response codes found in [response codes](https://wiki.onap.org/).
4750       parameters:
4751         - name: cloud-owner
4752           in: path
4753           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4754           required: true
4755           type: string
4756           example: __CLOUD-OWNER__
4757         - name: cloud-region-id
4758           in: path
4759           description: Identifier used by the vendor for the region. Second part of composite key
4760           required: true
4761           type: string
4762           example: __CLOUD-REGION-ID__
4763         - name: flavor-id
4764           in: query
4765           description:
4766           required: false
4767           type: string
4768         - name: flavor-name
4769           in: query
4770           description:
4771           required: false
4772           type: string
4773   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4774     put:
4775       tags:
4776         - CloudInfrastructure
4777       summary: see node definition for valid relationships
4778       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4779       consumes:
4780         - application/json
4781         - application/xml
4782       produces:
4783         - application/json
4784         - application/xml
4785       responses:
4786         "default":
4787           description: Response codes found in [response codes](https://wiki.onap.org/).
4788       parameters:
4789         - name: cloud-owner
4790           in: path
4791           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4792           required: true
4793           type: string
4794           example: __CLOUD-OWNER__
4795         - name: cloud-region-id
4796           in: path
4797           description: Identifier used by the vendor for the region. Second part of composite key
4798           required: true
4799           type: string
4800           example: __CLOUD-REGION-ID__
4801         - name: group-id
4802           in: path
4803           description: Group id, expected to be unique across cloud-region.
4804           required: true
4805           type: string
4806           example: __GROUP-ID__
4807         - name: body
4808           in: body
4809           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4810           required: true
4811           schema:
4812             $ref: "#/definitions/relationship"
4813     delete:
4814       tags:
4815         - CloudInfrastructure
4816       summary: delete an existing relationship
4817       description: delete an existing relationship
4818       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4819       consumes:
4820         - application/json
4821         - application/xml
4822       produces:
4823         - application/json
4824         - application/xml
4825       responses:
4826         "default":
4827           description: Response codes found in [response codes](https://wiki.onap.org/).
4828       parameters:
4829         - name: cloud-owner
4830           in: path
4831           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4832           required: true
4833           type: string
4834           example: __CLOUD-OWNER__
4835         - name: cloud-region-id
4836           in: path
4837           description: Identifier used by the vendor for the region. Second part of composite key
4838           required: true
4839           type: string
4840           example: __CLOUD-REGION-ID__
4841         - name: group-id
4842           in: path
4843           description: Group id, expected to be unique across cloud-region.
4844           required: true
4845           type: string
4846           example: __GROUP-ID__
4847   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4848     get:
4849       tags:
4850         - CloudInfrastructure
4851       summary: returns group-assignment
4852       description: returns group-assignment
4853       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4854       produces:
4855         - application/json
4856         - application/xml
4857       responses:
4858         "200":
4859           description: successful operation
4860           schema:
4861               $ref: "#/getDefinitions/group-assignment"
4862         "default":
4863           description: Response codes found in [response codes](https://wiki.onap.org/).
4864       parameters:
4865         - name: cloud-owner
4866           in: path
4867           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4868           required: true
4869           type: string
4870           example: __CLOUD-OWNER__
4871         - name: cloud-region-id
4872           in: path
4873           description: Identifier used by the vendor for the region. Second part of composite key
4874           required: true
4875           type: string
4876           example: __CLOUD-REGION-ID__
4877         - name: group-id
4878           in: path
4879           description: Group id, expected to be unique across cloud-region.
4880           required: true
4881           type: string
4882           example: __GROUP-ID__
4883     put:
4884       tags:
4885         - CloudInfrastructure
4886       summary: create or update an existing group-assignment
4887       description: |
4888         Create or update an existing group-assignment.
4889         #
4890         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4891       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4892       consumes:
4893         - application/json
4894         - application/xml
4895       produces:
4896         - application/json
4897         - application/xml
4898       responses:
4899         "default":
4900           description: Response codes found in [response codes](https://wiki.onap.org/).
4901       parameters:
4902         - name: cloud-owner
4903           in: path
4904           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4905           required: true
4906           type: string
4907           example: __CLOUD-OWNER__
4908         - name: cloud-region-id
4909           in: path
4910           description: Identifier used by the vendor for the region. Second part of composite key
4911           required: true
4912           type: string
4913           example: __CLOUD-REGION-ID__
4914         - name: group-id
4915           in: path
4916           description: Group id, expected to be unique across cloud-region.
4917           required: true
4918           type: string
4919           example: __GROUP-ID__
4920         - name: body
4921           in: body
4922           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4923           required: true
4924           schema:
4925             $ref: "#/definitions/group-assignment"
4926     patch:
4927       tags:
4928         - CloudInfrastructure
4929       summary: update an existing group-assignment
4930       description: |
4931         Update an existing group-assignment
4932         #
4933         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4934         The PUT operation will entirely replace an existing object.
4935         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4936         #
4937         Other differences between PUT and PATCH are:
4938         #
4939         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4940         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4941         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4942       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4943       consumes:
4944         - application/json
4945         - application/xml
4946       produces:
4947         - application/json
4948         - application/xml
4949       responses:
4950         "default":
4951           description: Response codes found in [response codes](https://wiki.onap.org/).
4952       parameters:
4953         - name: cloud-owner
4954           in: path
4955           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4956           required: true
4957           type: string
4958           example: __CLOUD-OWNER__
4959         - name: cloud-region-id
4960           in: path
4961           description: Identifier used by the vendor for the region. Second part of composite key
4962           required: true
4963           type: string
4964           example: __CLOUD-REGION-ID__
4965         - name: group-id
4966           in: path
4967           description: Group id, expected to be unique across cloud-region.
4968           required: true
4969           type: string
4970           example: __GROUP-ID__
4971         - name: body
4972           in: body
4973           description: group-assignment object that needs to be updated.
4974           required: true
4975           schema:
4976             $ref: "#/patchDefinitions/group-assignment"
4977     delete:
4978       tags:
4979         - CloudInfrastructure
4980       summary: delete an existing group-assignment
4981       description: delete an existing group-assignment
4982       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4983       consumes:
4984         - application/json
4985         - application/xml
4986       produces:
4987         - application/json
4988         - application/xml
4989       responses:
4990         "default":
4991           description: Response codes found in [response codes](https://wiki.onap.org/).
4992       parameters:
4993         - name: cloud-owner
4994           in: path
4995           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4996           required: true
4997           type: string
4998           example: __CLOUD-OWNER__
4999         - name: cloud-region-id
5000           in: path
5001           description: Identifier used by the vendor for the region. Second part of composite key
5002           required: true
5003           type: string
5004           example: __CLOUD-REGION-ID__
5005         - name: group-id
5006           in: path
5007           description: Group id, expected to be unique across cloud-region.
5008           required: true
5009           type: string
5010           example: __GROUP-ID__
5011         - name: resource-version
5012           in: query
5013           description: resource-version for concurrency
5014           required: true
5015           type: string
5016   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5017     get:
5018       tags:
5019         - CloudInfrastructure
5020       summary: returns group-assignments
5021       description: returns group-assignments
5022       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5023       produces:
5024         - application/json
5025         - application/xml
5026       responses:
5027         "200":
5028           description: successful operation
5029           schema:
5030               $ref: "#/getDefinitions/group-assignments"
5031         "default":
5032           description: Response codes found in [response codes](https://wiki.onap.org/).
5033       parameters:
5034         - name: cloud-owner
5035           in: path
5036           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5037           required: true
5038           type: string
5039           example: __CLOUD-OWNER__
5040         - name: cloud-region-id
5041           in: path
5042           description: Identifier used by the vendor for the region. Second part of composite key
5043           required: true
5044           type: string
5045           example: __CLOUD-REGION-ID__
5046         - name: group-id
5047           in: query
5048           description:
5049           required: false
5050           type: string
5051         - name: group-type
5052           in: query
5053           description:
5054           required: false
5055           type: string
5056         - name: group-name
5057           in: query
5058           description:
5059           required: false
5060           type: string
5061   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5062     put:
5063       tags:
5064         - CloudInfrastructure
5065       summary: see node definition for valid relationships
5066       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5067       consumes:
5068         - application/json
5069         - application/xml
5070       produces:
5071         - application/json
5072         - application/xml
5073       responses:
5074         "default":
5075           description: Response codes found in [response codes](https://wiki.onap.org/).
5076       parameters:
5077         - name: cloud-owner
5078           in: path
5079           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5080           required: true
5081           type: string
5082           example: __CLOUD-OWNER__
5083         - name: cloud-region-id
5084           in: path
5085           description: Identifier used by the vendor for the region. Second part of composite key
5086           required: true
5087           type: string
5088           example: __CLOUD-REGION-ID__
5089         - name: snapshot-id
5090           in: path
5091           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5092           required: true
5093           type: string
5094           example: __SNAPSHOT-ID__
5095         - name: body
5096           in: body
5097           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5098           required: true
5099           schema:
5100             $ref: "#/definitions/relationship"
5101     delete:
5102       tags:
5103         - CloudInfrastructure
5104       summary: delete an existing relationship
5105       description: delete an existing relationship
5106       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5107       consumes:
5108         - application/json
5109         - application/xml
5110       produces:
5111         - application/json
5112         - application/xml
5113       responses:
5114         "default":
5115           description: Response codes found in [response codes](https://wiki.onap.org/).
5116       parameters:
5117         - name: cloud-owner
5118           in: path
5119           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5120           required: true
5121           type: string
5122           example: __CLOUD-OWNER__
5123         - name: cloud-region-id
5124           in: path
5125           description: Identifier used by the vendor for the region. Second part of composite key
5126           required: true
5127           type: string
5128           example: __CLOUD-REGION-ID__
5129         - name: snapshot-id
5130           in: path
5131           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5132           required: true
5133           type: string
5134           example: __SNAPSHOT-ID__
5135   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5136     get:
5137       tags:
5138         - CloudInfrastructure
5139       summary: returns snapshot
5140       description: returns snapshot
5141       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5142       produces:
5143         - application/json
5144         - application/xml
5145       responses:
5146         "200":
5147           description: successful operation
5148           schema:
5149               $ref: "#/getDefinitions/snapshot"
5150         "default":
5151           description: Response codes found in [response codes](https://wiki.onap.org/).
5152       parameters:
5153         - name: cloud-owner
5154           in: path
5155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5156           required: true
5157           type: string
5158           example: __CLOUD-OWNER__
5159         - name: cloud-region-id
5160           in: path
5161           description: Identifier used by the vendor for the region. Second part of composite key
5162           required: true
5163           type: string
5164           example: __CLOUD-REGION-ID__
5165         - name: snapshot-id
5166           in: path
5167           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5168           required: true
5169           type: string
5170           example: __SNAPSHOT-ID__
5171     put:
5172       tags:
5173         - CloudInfrastructure
5174       summary: create or update an existing snapshot
5175       description: |
5176         Create or update an existing snapshot.
5177         #
5178         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5179       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5180       consumes:
5181         - application/json
5182         - application/xml
5183       produces:
5184         - application/json
5185         - application/xml
5186       responses:
5187         "default":
5188           description: Response codes found in [response codes](https://wiki.onap.org/).
5189       parameters:
5190         - name: cloud-owner
5191           in: path
5192           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5193           required: true
5194           type: string
5195           example: __CLOUD-OWNER__
5196         - name: cloud-region-id
5197           in: path
5198           description: Identifier used by the vendor for the region. Second part of composite key
5199           required: true
5200           type: string
5201           example: __CLOUD-REGION-ID__
5202         - name: snapshot-id
5203           in: path
5204           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5205           required: true
5206           type: string
5207           example: __SNAPSHOT-ID__
5208         - name: body
5209           in: body
5210           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5211           required: true
5212           schema:
5213             $ref: "#/definitions/snapshot"
5214     patch:
5215       tags:
5216         - CloudInfrastructure
5217       summary: update an existing snapshot
5218       description: |
5219         Update an existing snapshot
5220         #
5221         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5222         The PUT operation will entirely replace an existing object.
5223         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5224         #
5225         Other differences between PUT and PATCH are:
5226         #
5227         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5228         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5229         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5230       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5231       consumes:
5232         - application/json
5233         - application/xml
5234       produces:
5235         - application/json
5236         - application/xml
5237       responses:
5238         "default":
5239           description: Response codes found in [response codes](https://wiki.onap.org/).
5240       parameters:
5241         - name: cloud-owner
5242           in: path
5243           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5244           required: true
5245           type: string
5246           example: __CLOUD-OWNER__
5247         - name: cloud-region-id
5248           in: path
5249           description: Identifier used by the vendor for the region. Second part of composite key
5250           required: true
5251           type: string
5252           example: __CLOUD-REGION-ID__
5253         - name: snapshot-id
5254           in: path
5255           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5256           required: true
5257           type: string
5258           example: __SNAPSHOT-ID__
5259         - name: body
5260           in: body
5261           description: snapshot object that needs to be updated.
5262           required: true
5263           schema:
5264             $ref: "#/patchDefinitions/snapshot"
5265     delete:
5266       tags:
5267         - CloudInfrastructure
5268       summary: delete an existing snapshot
5269       description: delete an existing snapshot
5270       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5271       consumes:
5272         - application/json
5273         - application/xml
5274       produces:
5275         - application/json
5276         - application/xml
5277       responses:
5278         "default":
5279           description: Response codes found in [response codes](https://wiki.onap.org/).
5280       parameters:
5281         - name: cloud-owner
5282           in: path
5283           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5284           required: true
5285           type: string
5286           example: __CLOUD-OWNER__
5287         - name: cloud-region-id
5288           in: path
5289           description: Identifier used by the vendor for the region. Second part of composite key
5290           required: true
5291           type: string
5292           example: __CLOUD-REGION-ID__
5293         - name: snapshot-id
5294           in: path
5295           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5296           required: true
5297           type: string
5298           example: __SNAPSHOT-ID__
5299         - name: resource-version
5300           in: query
5301           description: resource-version for concurrency
5302           required: true
5303           type: string
5304   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5305     get:
5306       tags:
5307         - CloudInfrastructure
5308       summary: returns snapshots
5309       description: returns snapshots
5310       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5311       produces:
5312         - application/json
5313         - application/xml
5314       responses:
5315         "200":
5316           description: successful operation
5317           schema:
5318               $ref: "#/getDefinitions/snapshots"
5319         "default":
5320           description: Response codes found in [response codes](https://wiki.onap.org/).
5321       parameters:
5322         - name: cloud-owner
5323           in: path
5324           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5325           required: true
5326           type: string
5327           example: __CLOUD-OWNER__
5328         - name: cloud-region-id
5329           in: path
5330           description: Identifier used by the vendor for the region. Second part of composite key
5331           required: true
5332           type: string
5333           example: __CLOUD-REGION-ID__
5334         - name: snapshot-id
5335           in: query
5336           description:
5337           required: false
5338           type: string
5339         - name: snapshot-name
5340           in: query
5341           description:
5342           required: false
5343           type: string
5344         - name: application
5345           in: query
5346           description:
5347           required: false
5348           type: string
5349         - name: application-vendor
5350           in: query
5351           description:
5352           required: false
5353           type: string
5354         - name: application-version
5355           in: query
5356           description:
5357           required: false
5358           type: string
5359         - name: prev-snapshot-id
5360           in: query
5361           description:
5362           required: false
5363           type: string
5364   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5365     put:
5366       tags:
5367         - CloudInfrastructure
5368       summary: see node definition for valid relationships
5369       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5370       consumes:
5371         - application/json
5372         - application/xml
5373       produces:
5374         - application/json
5375         - application/xml
5376       responses:
5377         "default":
5378           description: Response codes found in [response codes](https://wiki.onap.org/).
5379       parameters:
5380         - name: cloud-owner
5381           in: path
5382           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5383           required: true
5384           type: string
5385           example: __CLOUD-OWNER__
5386         - name: cloud-region-id
5387           in: path
5388           description: Identifier used by the vendor for the region. Second part of composite key
5389           required: true
5390           type: string
5391           example: __CLOUD-REGION-ID__
5392         - name: image-id
5393           in: path
5394           description: Image id, expected to be unique across cloud region
5395           required: true
5396           type: string
5397           example: __IMAGE-ID__
5398         - name: body
5399           in: body
5400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5401           required: true
5402           schema:
5403             $ref: "#/definitions/relationship"
5404     delete:
5405       tags:
5406         - CloudInfrastructure
5407       summary: delete an existing relationship
5408       description: delete an existing relationship
5409       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5410       consumes:
5411         - application/json
5412         - application/xml
5413       produces:
5414         - application/json
5415         - application/xml
5416       responses:
5417         "default":
5418           description: Response codes found in [response codes](https://wiki.onap.org/).
5419       parameters:
5420         - name: cloud-owner
5421           in: path
5422           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5423           required: true
5424           type: string
5425           example: __CLOUD-OWNER__
5426         - name: cloud-region-id
5427           in: path
5428           description: Identifier used by the vendor for the region. Second part of composite key
5429           required: true
5430           type: string
5431           example: __CLOUD-REGION-ID__
5432         - name: image-id
5433           in: path
5434           description: Image id, expected to be unique across cloud region
5435           required: true
5436           type: string
5437           example: __IMAGE-ID__
5438   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5439     get:
5440       tags:
5441         - CloudInfrastructure
5442       summary: returns metadatum
5443       description: returns metadatum
5444       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5445       produces:
5446         - application/json
5447         - application/xml
5448       responses:
5449         "200":
5450           description: successful operation
5451           schema:
5452               $ref: "#/getDefinitions/metadatum"
5453         "default":
5454           description: Response codes found in [response codes](https://wiki.onap.org/).
5455       parameters:
5456         - name: cloud-owner
5457           in: path
5458           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5459           required: true
5460           type: string
5461           example: __CLOUD-OWNER__
5462         - name: cloud-region-id
5463           in: path
5464           description: Identifier used by the vendor for the region. Second part of composite key
5465           required: true
5466           type: string
5467           example: __CLOUD-REGION-ID__
5468         - name: image-id
5469           in: path
5470           description: Image id, expected to be unique across cloud region
5471           required: true
5472           type: string
5473           example: __IMAGE-ID__
5474         - name: metaname
5475           in: path
5476           required: true
5477           type: string
5478           example: __METANAME__
5479     put:
5480       tags:
5481         - CloudInfrastructure
5482       summary: create or update an existing metadatum
5483       description: |
5484         Create or update an existing metadatum.
5485         #
5486         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5487       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5488       consumes:
5489         - application/json
5490         - application/xml
5491       produces:
5492         - application/json
5493         - application/xml
5494       responses:
5495         "default":
5496           description: Response codes found in [response codes](https://wiki.onap.org/).
5497       parameters:
5498         - name: cloud-owner
5499           in: path
5500           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5501           required: true
5502           type: string
5503           example: __CLOUD-OWNER__
5504         - name: cloud-region-id
5505           in: path
5506           description: Identifier used by the vendor for the region. Second part of composite key
5507           required: true
5508           type: string
5509           example: __CLOUD-REGION-ID__
5510         - name: image-id
5511           in: path
5512           description: Image id, expected to be unique across cloud region
5513           required: true
5514           type: string
5515           example: __IMAGE-ID__
5516         - name: metaname
5517           in: path
5518           required: true
5519           type: string
5520           example: __METANAME__
5521         - name: body
5522           in: body
5523           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5524           required: true
5525           schema:
5526             $ref: "#/definitions/metadatum"
5527     patch:
5528       tags:
5529         - CloudInfrastructure
5530       summary: update an existing metadatum
5531       description: |
5532         Update an existing metadatum
5533         #
5534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5535         The PUT operation will entirely replace an existing object.
5536         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5537         #
5538         Other differences between PUT and PATCH are:
5539         #
5540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5543       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5544       consumes:
5545         - application/json
5546         - application/xml
5547       produces:
5548         - application/json
5549         - application/xml
5550       responses:
5551         "default":
5552           description: Response codes found in [response codes](https://wiki.onap.org/).
5553       parameters:
5554         - name: cloud-owner
5555           in: path
5556           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5557           required: true
5558           type: string
5559           example: __CLOUD-OWNER__
5560         - name: cloud-region-id
5561           in: path
5562           description: Identifier used by the vendor for the region. Second part of composite key
5563           required: true
5564           type: string
5565           example: __CLOUD-REGION-ID__
5566         - name: image-id
5567           in: path
5568           description: Image id, expected to be unique across cloud region
5569           required: true
5570           type: string
5571           example: __IMAGE-ID__
5572         - name: metaname
5573           in: path
5574           required: true
5575           type: string
5576           example: __METANAME__
5577         - name: body
5578           in: body
5579           description: metadatum object that needs to be updated.
5580           required: true
5581           schema:
5582             $ref: "#/patchDefinitions/metadatum"
5583     delete:
5584       tags:
5585         - CloudInfrastructure
5586       summary: delete an existing metadatum
5587       description: delete an existing metadatum
5588       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5589       consumes:
5590         - application/json
5591         - application/xml
5592       produces:
5593         - application/json
5594         - application/xml
5595       responses:
5596         "default":
5597           description: Response codes found in [response codes](https://wiki.onap.org/).
5598       parameters:
5599         - name: cloud-owner
5600           in: path
5601           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5602           required: true
5603           type: string
5604           example: __CLOUD-OWNER__
5605         - name: cloud-region-id
5606           in: path
5607           description: Identifier used by the vendor for the region. Second part of composite key
5608           required: true
5609           type: string
5610           example: __CLOUD-REGION-ID__
5611         - name: image-id
5612           in: path
5613           description: Image id, expected to be unique across cloud region
5614           required: true
5615           type: string
5616           example: __IMAGE-ID__
5617         - name: metaname
5618           in: path
5619           required: true
5620           type: string
5621           example: __METANAME__
5622         - name: resource-version
5623           in: query
5624           description: resource-version for concurrency
5625           required: true
5626           type: string
5627   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5628     get:
5629       tags:
5630         - CloudInfrastructure
5631       summary: returns metadata
5632       description: returns metadata
5633       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5634       produces:
5635         - application/json
5636         - application/xml
5637       responses:
5638         "200":
5639           description: successful operation
5640           schema:
5641               $ref: "#/getDefinitions/metadata"
5642         "default":
5643           description: Response codes found in [response codes](https://wiki.onap.org/).
5644       parameters:
5645         - name: cloud-owner
5646           in: path
5647           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5648           required: true
5649           type: string
5650           example: __CLOUD-OWNER__
5651         - name: cloud-region-id
5652           in: path
5653           description: Identifier used by the vendor for the region. Second part of composite key
5654           required: true
5655           type: string
5656           example: __CLOUD-REGION-ID__
5657         - name: image-id
5658           in: path
5659           description: Image id, expected to be unique across cloud region
5660           required: true
5661           type: string
5662           example: __IMAGE-ID__
5663         - name: metaname
5664           in: query
5665           description:
5666           required: false
5667           type: string
5668   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5669     get:
5670       tags:
5671         - CloudInfrastructure
5672       summary: returns image
5673       description: returns image
5674       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5675       produces:
5676         - application/json
5677         - application/xml
5678       responses:
5679         "200":
5680           description: successful operation
5681           schema:
5682               $ref: "#/getDefinitions/image"
5683         "default":
5684           description: Response codes found in [response codes](https://wiki.onap.org/).
5685       parameters:
5686         - name: cloud-owner
5687           in: path
5688           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5689           required: true
5690           type: string
5691           example: __CLOUD-OWNER__
5692         - name: cloud-region-id
5693           in: path
5694           description: Identifier used by the vendor for the region. Second part of composite key
5695           required: true
5696           type: string
5697           example: __CLOUD-REGION-ID__
5698         - name: image-id
5699           in: path
5700           description: Image id, expected to be unique across cloud region
5701           required: true
5702           type: string
5703           example: __IMAGE-ID__
5704     put:
5705       tags:
5706         - CloudInfrastructure
5707       summary: create or update an existing image
5708       description: |
5709         Create or update an existing image.
5710         #
5711         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5712       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5713       consumes:
5714         - application/json
5715         - application/xml
5716       produces:
5717         - application/json
5718         - application/xml
5719       responses:
5720         "default":
5721           description: Response codes found in [response codes](https://wiki.onap.org/).
5722       parameters:
5723         - name: cloud-owner
5724           in: path
5725           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5726           required: true
5727           type: string
5728           example: __CLOUD-OWNER__
5729         - name: cloud-region-id
5730           in: path
5731           description: Identifier used by the vendor for the region. Second part of composite key
5732           required: true
5733           type: string
5734           example: __CLOUD-REGION-ID__
5735         - name: image-id
5736           in: path
5737           description: Image id, expected to be unique across cloud region
5738           required: true
5739           type: string
5740           example: __IMAGE-ID__
5741         - name: body
5742           in: body
5743           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5744           required: true
5745           schema:
5746             $ref: "#/definitions/image"
5747     patch:
5748       tags:
5749         - CloudInfrastructure
5750       summary: update an existing image
5751       description: |
5752         Update an existing image
5753         #
5754         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5755         The PUT operation will entirely replace an existing object.
5756         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5757         #
5758         Other differences between PUT and PATCH are:
5759         #
5760         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5761         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5762         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5763       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5764       consumes:
5765         - application/json
5766         - application/xml
5767       produces:
5768         - application/json
5769         - application/xml
5770       responses:
5771         "default":
5772           description: Response codes found in [response codes](https://wiki.onap.org/).
5773       parameters:
5774         - name: cloud-owner
5775           in: path
5776           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5777           required: true
5778           type: string
5779           example: __CLOUD-OWNER__
5780         - name: cloud-region-id
5781           in: path
5782           description: Identifier used by the vendor for the region. Second part of composite key
5783           required: true
5784           type: string
5785           example: __CLOUD-REGION-ID__
5786         - name: image-id
5787           in: path
5788           description: Image id, expected to be unique across cloud region
5789           required: true
5790           type: string
5791           example: __IMAGE-ID__
5792         - name: body
5793           in: body
5794           description: image object that needs to be updated.
5795           required: true
5796           schema:
5797             $ref: "#/patchDefinitions/image"
5798     delete:
5799       tags:
5800         - CloudInfrastructure
5801       summary: delete an existing image
5802       description: delete an existing image
5803       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5804       consumes:
5805         - application/json
5806         - application/xml
5807       produces:
5808         - application/json
5809         - application/xml
5810       responses:
5811         "default":
5812           description: Response codes found in [response codes](https://wiki.onap.org/).
5813       parameters:
5814         - name: cloud-owner
5815           in: path
5816           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5817           required: true
5818           type: string
5819           example: __CLOUD-OWNER__
5820         - name: cloud-region-id
5821           in: path
5822           description: Identifier used by the vendor for the region. Second part of composite key
5823           required: true
5824           type: string
5825           example: __CLOUD-REGION-ID__
5826         - name: image-id
5827           in: path
5828           description: Image id, expected to be unique across cloud region
5829           required: true
5830           type: string
5831           example: __IMAGE-ID__
5832         - name: resource-version
5833           in: query
5834           description: resource-version for concurrency
5835           required: true
5836           type: string
5837   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5838     get:
5839       tags:
5840         - CloudInfrastructure
5841       summary: returns images
5842       description: returns images
5843       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5844       produces:
5845         - application/json
5846         - application/xml
5847       responses:
5848         "200":
5849           description: successful operation
5850           schema:
5851               $ref: "#/getDefinitions/images"
5852         "default":
5853           description: Response codes found in [response codes](https://wiki.onap.org/).
5854       parameters:
5855         - name: cloud-owner
5856           in: path
5857           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5858           required: true
5859           type: string
5860           example: __CLOUD-OWNER__
5861         - name: cloud-region-id
5862           in: path
5863           description: Identifier used by the vendor for the region. Second part of composite key
5864           required: true
5865           type: string
5866           example: __CLOUD-REGION-ID__
5867         - name: image-id
5868           in: query
5869           description:
5870           required: false
5871           type: string
5872         - name: image-name
5873           in: query
5874           description:
5875           required: false
5876           type: string
5877         - name: application
5878           in: query
5879           description:
5880           required: false
5881           type: string
5882         - name: application-vendor
5883           in: query
5884           description:
5885           required: false
5886           type: string
5887         - name: application-version
5888           in: query
5889           description:
5890           required: false
5891           type: string
5892   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5893     put:
5894       tags:
5895         - CloudInfrastructure
5896       summary: see node definition for valid relationships
5897       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5898       consumes:
5899         - application/json
5900         - application/xml
5901       produces:
5902         - application/json
5903         - application/xml
5904       responses:
5905         "default":
5906           description: Response codes found in [response codes](https://wiki.onap.org/).
5907       parameters:
5908         - name: cloud-owner
5909           in: path
5910           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5911           required: true
5912           type: string
5913           example: __CLOUD-OWNER__
5914         - name: cloud-region-id
5915           in: path
5916           description: Identifier used by the vendor for the region. Second part of composite key
5917           required: true
5918           type: string
5919           example: __CLOUD-REGION-ID__
5920         - name: switch-name
5921           in: path
5922           description: DVS switch name
5923           required: true
5924           type: string
5925           example: __SWITCH-NAME__
5926         - name: body
5927           in: body
5928           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5929           required: true
5930           schema:
5931             $ref: "#/definitions/relationship"
5932     delete:
5933       tags:
5934         - CloudInfrastructure
5935       summary: delete an existing relationship
5936       description: delete an existing relationship
5937       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5938       consumes:
5939         - application/json
5940         - application/xml
5941       produces:
5942         - application/json
5943         - application/xml
5944       responses:
5945         "default":
5946           description: Response codes found in [response codes](https://wiki.onap.org/).
5947       parameters:
5948         - name: cloud-owner
5949           in: path
5950           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5951           required: true
5952           type: string
5953           example: __CLOUD-OWNER__
5954         - name: cloud-region-id
5955           in: path
5956           description: Identifier used by the vendor for the region. Second part of composite key
5957           required: true
5958           type: string
5959           example: __CLOUD-REGION-ID__
5960         - name: switch-name
5961           in: path
5962           description: DVS switch name
5963           required: true
5964           type: string
5965           example: __SWITCH-NAME__
5966   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5967     get:
5968       tags:
5969         - CloudInfrastructure
5970       summary: returns dvs-switch
5971       description: returns dvs-switch
5972       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5973       produces:
5974         - application/json
5975         - application/xml
5976       responses:
5977         "200":
5978           description: successful operation
5979           schema:
5980               $ref: "#/getDefinitions/dvs-switch"
5981         "default":
5982           description: Response codes found in [response codes](https://wiki.onap.org/).
5983       parameters:
5984         - name: cloud-owner
5985           in: path
5986           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5987           required: true
5988           type: string
5989           example: __CLOUD-OWNER__
5990         - name: cloud-region-id
5991           in: path
5992           description: Identifier used by the vendor for the region. Second part of composite key
5993           required: true
5994           type: string
5995           example: __CLOUD-REGION-ID__
5996         - name: switch-name
5997           in: path
5998           description: DVS switch name
5999           required: true
6000           type: string
6001           example: __SWITCH-NAME__
6002     put:
6003       tags:
6004         - CloudInfrastructure
6005       summary: create or update an existing dvs-switch
6006       description: |
6007         Create or update an existing dvs-switch.
6008         #
6009         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6010       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6011       consumes:
6012         - application/json
6013         - application/xml
6014       produces:
6015         - application/json
6016         - application/xml
6017       responses:
6018         "default":
6019           description: Response codes found in [response codes](https://wiki.onap.org/).
6020       parameters:
6021         - name: cloud-owner
6022           in: path
6023           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6024           required: true
6025           type: string
6026           example: __CLOUD-OWNER__
6027         - name: cloud-region-id
6028           in: path
6029           description: Identifier used by the vendor for the region. Second part of composite key
6030           required: true
6031           type: string
6032           example: __CLOUD-REGION-ID__
6033         - name: switch-name
6034           in: path
6035           description: DVS switch name
6036           required: true
6037           type: string
6038           example: __SWITCH-NAME__
6039         - name: body
6040           in: body
6041           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6042           required: true
6043           schema:
6044             $ref: "#/definitions/dvs-switch"
6045     patch:
6046       tags:
6047         - CloudInfrastructure
6048       summary: update an existing dvs-switch
6049       description: |
6050         Update an existing dvs-switch
6051         #
6052         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6053         The PUT operation will entirely replace an existing object.
6054         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6055         #
6056         Other differences between PUT and PATCH are:
6057         #
6058         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6059         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6060         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6061       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6062       consumes:
6063         - application/json
6064         - application/xml
6065       produces:
6066         - application/json
6067         - application/xml
6068       responses:
6069         "default":
6070           description: Response codes found in [response codes](https://wiki.onap.org/).
6071       parameters:
6072         - name: cloud-owner
6073           in: path
6074           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6075           required: true
6076           type: string
6077           example: __CLOUD-OWNER__
6078         - name: cloud-region-id
6079           in: path
6080           description: Identifier used by the vendor for the region. Second part of composite key
6081           required: true
6082           type: string
6083           example: __CLOUD-REGION-ID__
6084         - name: switch-name
6085           in: path
6086           description: DVS switch name
6087           required: true
6088           type: string
6089           example: __SWITCH-NAME__
6090         - name: body
6091           in: body
6092           description: dvs-switch object that needs to be updated.
6093           required: true
6094           schema:
6095             $ref: "#/patchDefinitions/dvs-switch"
6096     delete:
6097       tags:
6098         - CloudInfrastructure
6099       summary: delete an existing dvs-switch
6100       description: delete an existing dvs-switch
6101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6102       consumes:
6103         - application/json
6104         - application/xml
6105       produces:
6106         - application/json
6107         - application/xml
6108       responses:
6109         "default":
6110           description: Response codes found in [response codes](https://wiki.onap.org/).
6111       parameters:
6112         - name: cloud-owner
6113           in: path
6114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6115           required: true
6116           type: string
6117           example: __CLOUD-OWNER__
6118         - name: cloud-region-id
6119           in: path
6120           description: Identifier used by the vendor for the region. Second part of composite key
6121           required: true
6122           type: string
6123           example: __CLOUD-REGION-ID__
6124         - name: switch-name
6125           in: path
6126           description: DVS switch name
6127           required: true
6128           type: string
6129           example: __SWITCH-NAME__
6130         - name: resource-version
6131           in: query
6132           description: resource-version for concurrency
6133           required: true
6134           type: string
6135   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6136     get:
6137       tags:
6138         - CloudInfrastructure
6139       summary: returns dvs-switches
6140       description: returns dvs-switches
6141       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6142       produces:
6143         - application/json
6144         - application/xml
6145       responses:
6146         "200":
6147           description: successful operation
6148           schema:
6149               $ref: "#/getDefinitions/dvs-switches"
6150         "default":
6151           description: Response codes found in [response codes](https://wiki.onap.org/).
6152       parameters:
6153         - name: cloud-owner
6154           in: path
6155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6156           required: true
6157           type: string
6158           example: __CLOUD-OWNER__
6159         - name: cloud-region-id
6160           in: path
6161           description: Identifier used by the vendor for the region. Second part of composite key
6162           required: true
6163           type: string
6164           example: __CLOUD-REGION-ID__
6165         - name: switch-name
6166           in: query
6167           description:
6168           required: false
6169           type: string
6170         - name: vcenter-url
6171           in: query
6172           description:
6173           required: false
6174           type: string
6175   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6176     put:
6177       tags:
6178         - CloudInfrastructure
6179       summary: see node definition for valid relationships
6180       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6181       consumes:
6182         - application/json
6183         - application/xml
6184       produces:
6185         - application/json
6186         - application/xml
6187       responses:
6188         "default":
6189           description: Response codes found in [response codes](https://wiki.onap.org/).
6190       parameters:
6191         - name: cloud-owner
6192           in: path
6193           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6194           required: true
6195           type: string
6196           example: __CLOUD-OWNER__
6197         - name: cloud-region-id
6198           in: path
6199           description: Identifier used by the vendor for the region. Second part of composite key
6200           required: true
6201           type: string
6202           example: __CLOUD-REGION-ID__
6203         - name: network-uuid
6204           in: path
6205           description: UUID of the network. Unique across a cloud-region
6206           required: true
6207           type: string
6208           example: __NETWORK-UUID__
6209         - name: body
6210           in: body
6211           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6212           required: true
6213           schema:
6214             $ref: "#/definitions/relationship"
6215     delete:
6216       tags:
6217         - CloudInfrastructure
6218       summary: delete an existing relationship
6219       description: delete an existing relationship
6220       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6221       consumes:
6222         - application/json
6223         - application/xml
6224       produces:
6225         - application/json
6226         - application/xml
6227       responses:
6228         "default":
6229           description: Response codes found in [response codes](https://wiki.onap.org/).
6230       parameters:
6231         - name: cloud-owner
6232           in: path
6233           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6234           required: true
6235           type: string
6236           example: __CLOUD-OWNER__
6237         - name: cloud-region-id
6238           in: path
6239           description: Identifier used by the vendor for the region. Second part of composite key
6240           required: true
6241           type: string
6242           example: __CLOUD-REGION-ID__
6243         - name: network-uuid
6244           in: path
6245           description: UUID of the network. Unique across a cloud-region
6246           required: true
6247           type: string
6248           example: __NETWORK-UUID__
6249   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6250     get:
6251       tags:
6252         - CloudInfrastructure
6253       summary: returns oam-network
6254       description: returns oam-network
6255       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6256       produces:
6257         - application/json
6258         - application/xml
6259       responses:
6260         "200":
6261           description: successful operation
6262           schema:
6263               $ref: "#/getDefinitions/oam-network"
6264         "default":
6265           description: Response codes found in [response codes](https://wiki.onap.org/).
6266       parameters:
6267         - name: cloud-owner
6268           in: path
6269           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6270           required: true
6271           type: string
6272           example: __CLOUD-OWNER__
6273         - name: cloud-region-id
6274           in: path
6275           description: Identifier used by the vendor for the region. Second part of composite key
6276           required: true
6277           type: string
6278           example: __CLOUD-REGION-ID__
6279         - name: network-uuid
6280           in: path
6281           description: UUID of the network. Unique across a cloud-region
6282           required: true
6283           type: string
6284           example: __NETWORK-UUID__
6285     put:
6286       tags:
6287         - CloudInfrastructure
6288       summary: create or update an existing oam-network
6289       description: |
6290         Create or update an existing oam-network.
6291         #
6292         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6293       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6294       consumes:
6295         - application/json
6296         - application/xml
6297       produces:
6298         - application/json
6299         - application/xml
6300       responses:
6301         "default":
6302           description: Response codes found in [response codes](https://wiki.onap.org/).
6303       parameters:
6304         - name: cloud-owner
6305           in: path
6306           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6307           required: true
6308           type: string
6309           example: __CLOUD-OWNER__
6310         - name: cloud-region-id
6311           in: path
6312           description: Identifier used by the vendor for the region. Second part of composite key
6313           required: true
6314           type: string
6315           example: __CLOUD-REGION-ID__
6316         - name: network-uuid
6317           in: path
6318           description: UUID of the network. Unique across a cloud-region
6319           required: true
6320           type: string
6321           example: __NETWORK-UUID__
6322         - name: body
6323           in: body
6324           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6325           required: true
6326           schema:
6327             $ref: "#/definitions/oam-network"
6328     patch:
6329       tags:
6330         - CloudInfrastructure
6331       summary: update an existing oam-network
6332       description: |
6333         Update an existing oam-network
6334         #
6335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6336         The PUT operation will entirely replace an existing object.
6337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6338         #
6339         Other differences between PUT and PATCH are:
6340         #
6341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6344       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6345       consumes:
6346         - application/json
6347         - application/xml
6348       produces:
6349         - application/json
6350         - application/xml
6351       responses:
6352         "default":
6353           description: Response codes found in [response codes](https://wiki.onap.org/).
6354       parameters:
6355         - name: cloud-owner
6356           in: path
6357           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6358           required: true
6359           type: string
6360           example: __CLOUD-OWNER__
6361         - name: cloud-region-id
6362           in: path
6363           description: Identifier used by the vendor for the region. Second part of composite key
6364           required: true
6365           type: string
6366           example: __CLOUD-REGION-ID__
6367         - name: network-uuid
6368           in: path
6369           description: UUID of the network. Unique across a cloud-region
6370           required: true
6371           type: string
6372           example: __NETWORK-UUID__
6373         - name: body
6374           in: body
6375           description: oam-network object that needs to be updated.
6376           required: true
6377           schema:
6378             $ref: "#/patchDefinitions/oam-network"
6379     delete:
6380       tags:
6381         - CloudInfrastructure
6382       summary: delete an existing oam-network
6383       description: delete an existing oam-network
6384       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6385       consumes:
6386         - application/json
6387         - application/xml
6388       produces:
6389         - application/json
6390         - application/xml
6391       responses:
6392         "default":
6393           description: Response codes found in [response codes](https://wiki.onap.org/).
6394       parameters:
6395         - name: cloud-owner
6396           in: path
6397           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6398           required: true
6399           type: string
6400           example: __CLOUD-OWNER__
6401         - name: cloud-region-id
6402           in: path
6403           description: Identifier used by the vendor for the region. Second part of composite key
6404           required: true
6405           type: string
6406           example: __CLOUD-REGION-ID__
6407         - name: network-uuid
6408           in: path
6409           description: UUID of the network. Unique across a cloud-region
6410           required: true
6411           type: string
6412           example: __NETWORK-UUID__
6413         - name: resource-version
6414           in: query
6415           description: resource-version for concurrency
6416           required: true
6417           type: string
6418   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6419     get:
6420       tags:
6421         - CloudInfrastructure
6422       summary: returns oam-networks
6423       description: returns oam-networks
6424       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6425       produces:
6426         - application/json
6427         - application/xml
6428       responses:
6429         "200":
6430           description: successful operation
6431           schema:
6432               $ref: "#/getDefinitions/oam-networks"
6433         "default":
6434           description: Response codes found in [response codes](https://wiki.onap.org/).
6435       parameters:
6436         - name: cloud-owner
6437           in: path
6438           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6439           required: true
6440           type: string
6441           example: __CLOUD-OWNER__
6442         - name: cloud-region-id
6443           in: path
6444           description: Identifier used by the vendor for the region. Second part of composite key
6445           required: true
6446           type: string
6447           example: __CLOUD-REGION-ID__
6448         - name: network-uuid
6449           in: query
6450           description:
6451           required: false
6452           type: string
6453         - name: network-name
6454           in: query
6455           description:
6456           required: false
6457           type: string
6458         - name: cvlan-tag
6459           in: query
6460           description:
6461           required: false
6462           type: integer
6463           format: int64
6464   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6465     put:
6466       tags:
6467         - CloudInfrastructure
6468       summary: see node definition for valid relationships
6469       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6470       consumes:
6471         - application/json
6472         - application/xml
6473       produces:
6474         - application/json
6475         - application/xml
6476       responses:
6477         "default":
6478           description: Response codes found in [response codes](https://wiki.onap.org/).
6479       parameters:
6480         - name: cloud-owner
6481           in: path
6482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6483           required: true
6484           type: string
6485           example: __CLOUD-OWNER__
6486         - name: cloud-region-id
6487           in: path
6488           description: Identifier used by the vendor for the region. Second part of composite key
6489           required: true
6490           type: string
6491           example: __CLOUD-REGION-ID__
6492         - name: availability-zone-name
6493           in: path
6494           description: Name of the availability zone.  Unique across a cloud region
6495           required: true
6496           type: string
6497           example: __AVAILABILITY-ZONE-NAME__
6498         - name: body
6499           in: body
6500           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6501           required: true
6502           schema:
6503             $ref: "#/definitions/relationship"
6504     delete:
6505       tags:
6506         - CloudInfrastructure
6507       summary: delete an existing relationship
6508       description: delete an existing relationship
6509       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6510       consumes:
6511         - application/json
6512         - application/xml
6513       produces:
6514         - application/json
6515         - application/xml
6516       responses:
6517         "default":
6518           description: Response codes found in [response codes](https://wiki.onap.org/).
6519       parameters:
6520         - name: cloud-owner
6521           in: path
6522           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6523           required: true
6524           type: string
6525           example: __CLOUD-OWNER__
6526         - name: cloud-region-id
6527           in: path
6528           description: Identifier used by the vendor for the region. Second part of composite key
6529           required: true
6530           type: string
6531           example: __CLOUD-REGION-ID__
6532         - name: availability-zone-name
6533           in: path
6534           description: Name of the availability zone.  Unique across a cloud region
6535           required: true
6536           type: string
6537           example: __AVAILABILITY-ZONE-NAME__
6538   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6539     get:
6540       tags:
6541         - CloudInfrastructure
6542       summary: returns availability-zone
6543       description: returns availability-zone
6544       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6545       produces:
6546         - application/json
6547         - application/xml
6548       responses:
6549         "200":
6550           description: successful operation
6551           schema:
6552               $ref: "#/getDefinitions/availability-zone"
6553         "default":
6554           description: Response codes found in [response codes](https://wiki.onap.org/).
6555       parameters:
6556         - name: cloud-owner
6557           in: path
6558           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6559           required: true
6560           type: string
6561           example: __CLOUD-OWNER__
6562         - name: cloud-region-id
6563           in: path
6564           description: Identifier used by the vendor for the region. Second part of composite key
6565           required: true
6566           type: string
6567           example: __CLOUD-REGION-ID__
6568         - name: availability-zone-name
6569           in: path
6570           description: Name of the availability zone.  Unique across a cloud region
6571           required: true
6572           type: string
6573           example: __AVAILABILITY-ZONE-NAME__
6574     put:
6575       tags:
6576         - CloudInfrastructure
6577       summary: create or update an existing availability-zone
6578       description: |
6579         Create or update an existing availability-zone.
6580         #
6581         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6582       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6583       consumes:
6584         - application/json
6585         - application/xml
6586       produces:
6587         - application/json
6588         - application/xml
6589       responses:
6590         "default":
6591           description: Response codes found in [response codes](https://wiki.onap.org/).
6592       parameters:
6593         - name: cloud-owner
6594           in: path
6595           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6596           required: true
6597           type: string
6598           example: __CLOUD-OWNER__
6599         - name: cloud-region-id
6600           in: path
6601           description: Identifier used by the vendor for the region. Second part of composite key
6602           required: true
6603           type: string
6604           example: __CLOUD-REGION-ID__
6605         - name: availability-zone-name
6606           in: path
6607           description: Name of the availability zone.  Unique across a cloud region
6608           required: true
6609           type: string
6610           example: __AVAILABILITY-ZONE-NAME__
6611         - name: body
6612           in: body
6613           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6614           required: true
6615           schema:
6616             $ref: "#/definitions/availability-zone"
6617     patch:
6618       tags:
6619         - CloudInfrastructure
6620       summary: update an existing availability-zone
6621       description: |
6622         Update an existing availability-zone
6623         #
6624         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6625         The PUT operation will entirely replace an existing object.
6626         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6627         #
6628         Other differences between PUT and PATCH are:
6629         #
6630         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6631         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6632         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6633       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6634       consumes:
6635         - application/json
6636         - application/xml
6637       produces:
6638         - application/json
6639         - application/xml
6640       responses:
6641         "default":
6642           description: Response codes found in [response codes](https://wiki.onap.org/).
6643       parameters:
6644         - name: cloud-owner
6645           in: path
6646           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6647           required: true
6648           type: string
6649           example: __CLOUD-OWNER__
6650         - name: cloud-region-id
6651           in: path
6652           description: Identifier used by the vendor for the region. Second part of composite key
6653           required: true
6654           type: string
6655           example: __CLOUD-REGION-ID__
6656         - name: availability-zone-name
6657           in: path
6658           description: Name of the availability zone.  Unique across a cloud region
6659           required: true
6660           type: string
6661           example: __AVAILABILITY-ZONE-NAME__
6662         - name: body
6663           in: body
6664           description: availability-zone object that needs to be updated.
6665           required: true
6666           schema:
6667             $ref: "#/patchDefinitions/availability-zone"
6668     delete:
6669       tags:
6670         - CloudInfrastructure
6671       summary: delete an existing availability-zone
6672       description: delete an existing availability-zone
6673       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6674       consumes:
6675         - application/json
6676         - application/xml
6677       produces:
6678         - application/json
6679         - application/xml
6680       responses:
6681         "default":
6682           description: Response codes found in [response codes](https://wiki.onap.org/).
6683       parameters:
6684         - name: cloud-owner
6685           in: path
6686           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6687           required: true
6688           type: string
6689           example: __CLOUD-OWNER__
6690         - name: cloud-region-id
6691           in: path
6692           description: Identifier used by the vendor for the region. Second part of composite key
6693           required: true
6694           type: string
6695           example: __CLOUD-REGION-ID__
6696         - name: availability-zone-name
6697           in: path
6698           description: Name of the availability zone.  Unique across a cloud region
6699           required: true
6700           type: string
6701           example: __AVAILABILITY-ZONE-NAME__
6702         - name: resource-version
6703           in: query
6704           description: resource-version for concurrency
6705           required: true
6706           type: string
6707   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6708     get:
6709       tags:
6710         - CloudInfrastructure
6711       summary: returns availability-zones
6712       description: returns availability-zones
6713       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6714       produces:
6715         - application/json
6716         - application/xml
6717       responses:
6718         "200":
6719           description: successful operation
6720           schema:
6721               $ref: "#/getDefinitions/availability-zones"
6722         "default":
6723           description: Response codes found in [response codes](https://wiki.onap.org/).
6724       parameters:
6725         - name: cloud-owner
6726           in: path
6727           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6728           required: true
6729           type: string
6730           example: __CLOUD-OWNER__
6731         - name: cloud-region-id
6732           in: path
6733           description: Identifier used by the vendor for the region. Second part of composite key
6734           required: true
6735           type: string
6736           example: __CLOUD-REGION-ID__
6737         - name: availability-zone-name
6738           in: query
6739           description:
6740           required: false
6741           type: string
6742   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6743     put:
6744       tags:
6745         - CloudInfrastructure
6746       summary: see node definition for valid relationships
6747       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6748       consumes:
6749         - application/json
6750         - application/xml
6751       produces:
6752         - application/json
6753         - application/xml
6754       responses:
6755         "default":
6756           description: Response codes found in [response codes](https://wiki.onap.org/).
6757       parameters:
6758         - name: cloud-owner
6759           in: path
6760           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6761           required: true
6762           type: string
6763           example: __CLOUD-OWNER__
6764         - name: cloud-region-id
6765           in: path
6766           description: Identifier used by the vendor for the region. Second part of composite key
6767           required: true
6768           type: string
6769           example: __CLOUD-REGION-ID__
6770         - name: body
6771           in: body
6772           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
6773           required: true
6774           schema:
6775             $ref: "#/definitions/relationship"
6776     delete:
6777       tags:
6778         - CloudInfrastructure
6779       summary: delete an existing relationship
6780       description: delete an existing relationship
6781       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6782       consumes:
6783         - application/json
6784         - application/xml
6785       produces:
6786         - application/json
6787         - application/xml
6788       responses:
6789         "default":
6790           description: Response codes found in [response codes](https://wiki.onap.org/).
6791       parameters:
6792         - name: cloud-owner
6793           in: path
6794           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6795           required: true
6796           type: string
6797           example: __CLOUD-OWNER__
6798         - name: cloud-region-id
6799           in: path
6800           description: Identifier used by the vendor for the region. Second part of composite key
6801           required: true
6802           type: string
6803           example: __CLOUD-REGION-ID__
6804   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
6805     get:
6806       tags:
6807         - CloudInfrastructure
6808       summary: returns cloud-region
6809       description: returns cloud-region
6810       operationId: getCloudInfrastructureCloudRegionsCloudRegion
6811       produces:
6812         - application/json
6813         - application/xml
6814       responses:
6815         "200":
6816           description: successful operation
6817           schema:
6818               $ref: "#/getDefinitions/cloud-region"
6819         "default":
6820           description: Response codes found in [response codes](https://wiki.onap.org/).
6821       parameters:
6822         - name: cloud-owner
6823           in: path
6824           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6825           required: true
6826           type: string
6827           example: __CLOUD-OWNER__
6828         - name: cloud-region-id
6829           in: path
6830           description: Identifier used by the vendor for the region. Second part of composite key
6831           required: true
6832           type: string
6833           example: __CLOUD-REGION-ID__
6834     put:
6835       tags:
6836         - CloudInfrastructure
6837       summary: create or update an existing cloud-region
6838       description: |
6839         Create or update an existing cloud-region.
6840         #
6841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6842       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
6843       consumes:
6844         - application/json
6845         - application/xml
6846       produces:
6847         - application/json
6848         - application/xml
6849       responses:
6850         "default":
6851           description: Response codes found in [response codes](https://wiki.onap.org/).
6852       parameters:
6853         - name: cloud-owner
6854           in: path
6855           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6856           required: true
6857           type: string
6858           example: __CLOUD-OWNER__
6859         - name: cloud-region-id
6860           in: path
6861           description: Identifier used by the vendor for the region. Second part of composite key
6862           required: true
6863           type: string
6864           example: __CLOUD-REGION-ID__
6865         - name: body
6866           in: body
6867           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
6868           required: true
6869           schema:
6870             $ref: "#/definitions/cloud-region"
6871     patch:
6872       tags:
6873         - CloudInfrastructure
6874       summary: update an existing cloud-region
6875       description: |
6876         Update an existing cloud-region
6877         #
6878         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6879         The PUT operation will entirely replace an existing object.
6880         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6881         #
6882         Other differences between PUT and PATCH are:
6883         #
6884         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6885         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6886         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6887       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
6888       consumes:
6889         - application/json
6890         - application/xml
6891       produces:
6892         - application/json
6893         - application/xml
6894       responses:
6895         "default":
6896           description: Response codes found in [response codes](https://wiki.onap.org/).
6897       parameters:
6898         - name: cloud-owner
6899           in: path
6900           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6901           required: true
6902           type: string
6903           example: __CLOUD-OWNER__
6904         - name: cloud-region-id
6905           in: path
6906           description: Identifier used by the vendor for the region. Second part of composite key
6907           required: true
6908           type: string
6909           example: __CLOUD-REGION-ID__
6910         - name: body
6911           in: body
6912           description: cloud-region object that needs to be updated.
6913           required: true
6914           schema:
6915             $ref: "#/patchDefinitions/cloud-region"
6916     delete:
6917       tags:
6918         - CloudInfrastructure
6919       summary: delete an existing cloud-region
6920       description: delete an existing cloud-region
6921       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
6922       consumes:
6923         - application/json
6924         - application/xml
6925       produces:
6926         - application/json
6927         - application/xml
6928       responses:
6929         "default":
6930           description: Response codes found in [response codes](https://wiki.onap.org/).
6931       parameters:
6932         - name: cloud-owner
6933           in: path
6934           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6935           required: true
6936           type: string
6937           example: __CLOUD-OWNER__
6938         - name: cloud-region-id
6939           in: path
6940           description: Identifier used by the vendor for the region. Second part of composite key
6941           required: true
6942           type: string
6943           example: __CLOUD-REGION-ID__
6944         - name: resource-version
6945           in: query
6946           description: resource-version for concurrency
6947           required: true
6948           type: string
6949   /cloud-infrastructure/cloud-regions:
6950     get:
6951       tags:
6952         - CloudInfrastructure
6953       summary: returns cloud-regions
6954       description: returns cloud-regions
6955       operationId: getCloudInfrastructureCloudRegions
6956       produces:
6957         - application/json
6958         - application/xml
6959       responses:
6960         "200":
6961           description: successful operation
6962           schema:
6963               $ref: "#/getDefinitions/cloud-regions"
6964         "default":
6965           description: Response codes found in [response codes](https://wiki.onap.org/).
6966       parameters:
6967         - name: cloud-owner
6968           in: query
6969           description:
6970           required: false
6971           type: string
6972         - name: cloud-region-id
6973           in: query
6974           description:
6975           required: false
6976           type: string
6977         - name: cloud-type
6978           in: query
6979           description:
6980           required: false
6981           type: string
6982         - name: owner-defined-type
6983           in: query
6984           description:
6985           required: false
6986           type: string
6987   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
6988     put:
6989       tags:
6990         - CloudInfrastructure
6991       summary: see node definition for valid relationships
6992       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
6993       consumes:
6994         - application/json
6995         - application/xml
6996       produces:
6997         - application/json
6998         - application/xml
6999       responses:
7000         "default":
7001           description: Response codes found in [response codes](https://wiki.onap.org/).
7002       parameters:
7003         - name: nm-profile-name
7004           in: path
7005           description: Unique name of network profile.
7006           required: true
7007           type: string
7008           example: __NM-PROFILE-NAME__
7009         - name: body
7010           in: body
7011           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7012           required: true
7013           schema:
7014             $ref: "#/definitions/relationship"
7015     delete:
7016       tags:
7017         - CloudInfrastructure
7018       summary: delete an existing relationship
7019       description: delete an existing relationship
7020       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
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: nm-profile-name
7032           in: path
7033           description: Unique name of network profile.
7034           required: true
7035           type: string
7036           example: __NM-PROFILE-NAME__
7037   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7038     get:
7039       tags:
7040         - CloudInfrastructure
7041       summary: returns network-profile
7042       description: returns network-profile
7043       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7044       produces:
7045         - application/json
7046         - application/xml
7047       responses:
7048         "200":
7049           description: successful operation
7050           schema:
7051               $ref: "#/getDefinitions/network-profile"
7052         "default":
7053           description: Response codes found in [response codes](https://wiki.onap.org/).
7054       parameters:
7055         - name: nm-profile-name
7056           in: path
7057           description: Unique name of network profile.
7058           required: true
7059           type: string
7060           example: __NM-PROFILE-NAME__
7061     put:
7062       tags:
7063         - CloudInfrastructure
7064       summary: create or update an existing network-profile
7065       description: |
7066         Create or update an existing network-profile.
7067         #
7068         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7069       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7070       consumes:
7071         - application/json
7072         - application/xml
7073       produces:
7074         - application/json
7075         - application/xml
7076       responses:
7077         "default":
7078           description: Response codes found in [response codes](https://wiki.onap.org/).
7079       parameters:
7080         - name: nm-profile-name
7081           in: path
7082           description: Unique name of network profile.
7083           required: true
7084           type: string
7085           example: __NM-PROFILE-NAME__
7086         - name: body
7087           in: body
7088           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7089           required: true
7090           schema:
7091             $ref: "#/definitions/network-profile"
7092     patch:
7093       tags:
7094         - CloudInfrastructure
7095       summary: update an existing network-profile
7096       description: |
7097         Update an existing network-profile
7098         #
7099         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7100         The PUT operation will entirely replace an existing object.
7101         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7102         #
7103         Other differences between PUT and PATCH are:
7104         #
7105         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7106         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7107         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7108       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7109       consumes:
7110         - application/json
7111         - application/xml
7112       produces:
7113         - application/json
7114         - application/xml
7115       responses:
7116         "default":
7117           description: Response codes found in [response codes](https://wiki.onap.org/).
7118       parameters:
7119         - name: nm-profile-name
7120           in: path
7121           description: Unique name of network profile.
7122           required: true
7123           type: string
7124           example: __NM-PROFILE-NAME__
7125         - name: body
7126           in: body
7127           description: network-profile object that needs to be updated.
7128           required: true
7129           schema:
7130             $ref: "#/patchDefinitions/network-profile"
7131     delete:
7132       tags:
7133         - CloudInfrastructure
7134       summary: delete an existing network-profile
7135       description: delete an existing network-profile
7136       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7137       consumes:
7138         - application/json
7139         - application/xml
7140       produces:
7141         - application/json
7142         - application/xml
7143       responses:
7144         "default":
7145           description: Response codes found in [response codes](https://wiki.onap.org/).
7146       parameters:
7147         - name: nm-profile-name
7148           in: path
7149           description: Unique name of network profile.
7150           required: true
7151           type: string
7152           example: __NM-PROFILE-NAME__
7153         - name: resource-version
7154           in: query
7155           description: resource-version for concurrency
7156           required: true
7157           type: string
7158   /cloud-infrastructure/network-profiles:
7159     get:
7160       tags:
7161         - CloudInfrastructure
7162       summary: returns network-profiles
7163       description: returns network-profiles
7164       operationId: getCloudInfrastructureNetworkProfiles
7165       produces:
7166         - application/json
7167         - application/xml
7168       responses:
7169         "200":
7170           description: successful operation
7171           schema:
7172               $ref: "#/getDefinitions/network-profiles"
7173         "default":
7174           description: Response codes found in [response codes](https://wiki.onap.org/).
7175       parameters:
7176         - name: nm-profile-name
7177           in: query
7178           description:
7179           required: false
7180           type: string
7181   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7182     put:
7183       tags:
7184         - CloudInfrastructure
7185       summary: see node definition for valid relationships
7186       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7187       consumes:
7188         - application/json
7189         - application/xml
7190       produces:
7191         - application/json
7192         - application/xml
7193       responses:
7194         "default":
7195           description: Response codes found in [response codes](https://wiki.onap.org/).
7196       parameters:
7197         - name: hostname
7198           in: path
7199           description: Value from executing hostname on the compute node.
7200           required: true
7201           type: string
7202           example: __HOSTNAME__
7203         - name: body
7204           in: body
7205           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
7206           required: true
7207           schema:
7208             $ref: "#/definitions/relationship"
7209     delete:
7210       tags:
7211         - CloudInfrastructure
7212       summary: delete an existing relationship
7213       description: delete an existing relationship
7214       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7215       consumes:
7216         - application/json
7217         - application/xml
7218       produces:
7219         - application/json
7220         - application/xml
7221       responses:
7222         "default":
7223           description: Response codes found in [response codes](https://wiki.onap.org/).
7224       parameters:
7225         - name: hostname
7226           in: path
7227           description: Value from executing hostname on the compute node.
7228           required: true
7229           type: string
7230           example: __HOSTNAME__
7231   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
7232     put:
7233       tags:
7234         - CloudInfrastructure
7235       summary: see node definition for valid relationships
7236       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7237       consumes:
7238         - application/json
7239         - application/xml
7240       produces:
7241         - application/json
7242         - application/xml
7243       responses:
7244         "default":
7245           description: Response codes found in [response codes](https://wiki.onap.org/).
7246       parameters:
7247         - name: hostname
7248           in: path
7249           description: Value from executing hostname on the compute node.
7250           required: true
7251           type: string
7252           example: __HOSTNAME__
7253         - name: interface-name
7254           in: path
7255           description: Name that identifies the physical interface
7256           required: true
7257           type: string
7258           example: __INTERFACE-NAME__
7259         - name: body
7260           in: body
7261           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
7262           required: true
7263           schema:
7264             $ref: "#/definitions/relationship"
7265     delete:
7266       tags:
7267         - CloudInfrastructure
7268       summary: delete an existing relationship
7269       description: delete an existing relationship
7270       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7271       consumes:
7272         - application/json
7273         - application/xml
7274       produces:
7275         - application/json
7276         - application/xml
7277       responses:
7278         "default":
7279           description: Response codes found in [response codes](https://wiki.onap.org/).
7280       parameters:
7281         - name: hostname
7282           in: path
7283           description: Value from executing hostname on the compute node.
7284           required: true
7285           type: string
7286           example: __HOSTNAME__
7287         - name: interface-name
7288           in: path
7289           description: Name that identifies the physical interface
7290           required: true
7291           type: string
7292           example: __INTERFACE-NAME__
7293   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
7294     put:
7295       tags:
7296         - CloudInfrastructure
7297       summary: see node definition for valid relationships
7298       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7299       consumes:
7300         - application/json
7301         - application/xml
7302       produces:
7303         - application/json
7304         - application/xml
7305       responses:
7306         "default":
7307           description: Response codes found in [response codes](https://wiki.onap.org/).
7308       parameters:
7309         - name: hostname
7310           in: path
7311           description: Value from executing hostname on the compute node.
7312           required: true
7313           type: string
7314           example: __HOSTNAME__
7315         - name: interface-name
7316           in: path
7317           description: Name that identifies the physical interface
7318           required: true
7319           type: string
7320           example: __INTERFACE-NAME__
7321         - name: interface-name
7322           in: path
7323           description: Name given to the interface
7324           required: true
7325           type: string
7326           example: __INTERFACE-NAME__
7327         - name: vlan-interface
7328           in: path
7329           description: String that identifies the interface
7330           required: true
7331           type: string
7332           example: __VLAN-INTERFACE__
7333         - name: body
7334           in: body
7335           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
7336           required: true
7337           schema:
7338             $ref: "#/definitions/relationship"
7339     delete:
7340       tags:
7341         - CloudInfrastructure
7342       summary: delete an existing relationship
7343       description: delete an existing relationship
7344       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7345       consumes:
7346         - application/json
7347         - application/xml
7348       produces:
7349         - application/json
7350         - application/xml
7351       responses:
7352         "default":
7353           description: Response codes found in [response codes](https://wiki.onap.org/).
7354       parameters:
7355         - name: hostname
7356           in: path
7357           description: Value from executing hostname on the compute node.
7358           required: true
7359           type: string
7360           example: __HOSTNAME__
7361         - name: interface-name
7362           in: path
7363           description: Name that identifies the physical interface
7364           required: true
7365           type: string
7366           example: __INTERFACE-NAME__
7367         - name: interface-name
7368           in: path
7369           description: Name given to the interface
7370           required: true
7371           type: string
7372           example: __INTERFACE-NAME__
7373         - name: vlan-interface
7374           in: path
7375           description: String that identifies the interface
7376           required: true
7377           type: string
7378           example: __VLAN-INTERFACE__
7379   /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:
7380     put:
7381       tags:
7382         - CloudInfrastructure
7383       summary: see node definition for valid relationships
7384       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7385       consumes:
7386         - application/json
7387         - application/xml
7388       produces:
7389         - application/json
7390         - application/xml
7391       responses:
7392         "default":
7393           description: Response codes found in [response codes](https://wiki.onap.org/).
7394       parameters:
7395         - name: hostname
7396           in: path
7397           description: Value from executing hostname on the compute node.
7398           required: true
7399           type: string
7400           example: __HOSTNAME__
7401         - name: interface-name
7402           in: path
7403           description: Name that identifies the physical interface
7404           required: true
7405           type: string
7406           example: __INTERFACE-NAME__
7407         - name: interface-name
7408           in: path
7409           description: Name given to the interface
7410           required: true
7411           type: string
7412           example: __INTERFACE-NAME__
7413         - name: vlan-interface
7414           in: path
7415           description: String that identifies the interface
7416           required: true
7417           type: string
7418           example: __VLAN-INTERFACE__
7419         - name: l3-interface-ipv4-address
7420           in: path
7421           description: IP address
7422           required: true
7423           type: string
7424           example: __L3-INTERFACE-IPV4-ADDRESS__
7425         - name: body
7426           in: body
7427           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7428           required: true
7429           schema:
7430             $ref: "#/definitions/relationship"
7431     delete:
7432       tags:
7433         - CloudInfrastructure
7434       summary: delete an existing relationship
7435       description: delete an existing relationship
7436       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7437       consumes:
7438         - application/json
7439         - application/xml
7440       produces:
7441         - application/json
7442         - application/xml
7443       responses:
7444         "default":
7445           description: Response codes found in [response codes](https://wiki.onap.org/).
7446       parameters:
7447         - name: hostname
7448           in: path
7449           description: Value from executing hostname on the compute node.
7450           required: true
7451           type: string
7452           example: __HOSTNAME__
7453         - name: interface-name
7454           in: path
7455           description: Name that identifies the physical interface
7456           required: true
7457           type: string
7458           example: __INTERFACE-NAME__
7459         - name: interface-name
7460           in: path
7461           description: Name given to the interface
7462           required: true
7463           type: string
7464           example: __INTERFACE-NAME__
7465         - name: vlan-interface
7466           in: path
7467           description: String that identifies the interface
7468           required: true
7469           type: string
7470           example: __VLAN-INTERFACE__
7471         - name: l3-interface-ipv4-address
7472           in: path
7473           description: IP address
7474           required: true
7475           type: string
7476           example: __L3-INTERFACE-IPV4-ADDRESS__
7477   /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}:
7478     get:
7479       tags:
7480         - CloudInfrastructure
7481       summary: returns l3-interface-ipv4-address-list
7482       description: returns l3-interface-ipv4-address-list
7483       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7484       produces:
7485         - application/json
7486         - application/xml
7487       responses:
7488         "200":
7489           description: successful operation
7490           schema:
7491               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
7492         "default":
7493           description: Response codes found in [response codes](https://wiki.onap.org/).
7494       parameters:
7495         - name: hostname
7496           in: path
7497           description: Value from executing hostname on the compute node.
7498           required: true
7499           type: string
7500           example: __HOSTNAME__
7501         - name: interface-name
7502           in: path
7503           description: Name that identifies the physical interface
7504           required: true
7505           type: string
7506           example: __INTERFACE-NAME__
7507         - name: interface-name
7508           in: path
7509           description: Name given to the interface
7510           required: true
7511           type: string
7512           example: __INTERFACE-NAME__
7513         - name: vlan-interface
7514           in: path
7515           description: String that identifies the interface
7516           required: true
7517           type: string
7518           example: __VLAN-INTERFACE__
7519         - name: l3-interface-ipv4-address
7520           in: path
7521           description: IP address
7522           required: true
7523           type: string
7524           example: __L3-INTERFACE-IPV4-ADDRESS__
7525     put:
7526       tags:
7527         - CloudInfrastructure
7528       summary: create or update an existing l3-interface-ipv4-address-list
7529       description: |
7530         Create or update an existing l3-interface-ipv4-address-list.
7531         #
7532         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7533       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7534       consumes:
7535         - application/json
7536         - application/xml
7537       produces:
7538         - application/json
7539         - application/xml
7540       responses:
7541         "default":
7542           description: Response codes found in [response codes](https://wiki.onap.org/).
7543       parameters:
7544         - name: hostname
7545           in: path
7546           description: Value from executing hostname on the compute node.
7547           required: true
7548           type: string
7549           example: __HOSTNAME__
7550         - name: interface-name
7551           in: path
7552           description: Name that identifies the physical interface
7553           required: true
7554           type: string
7555           example: __INTERFACE-NAME__
7556         - name: interface-name
7557           in: path
7558           description: Name given to the interface
7559           required: true
7560           type: string
7561           example: __INTERFACE-NAME__
7562         - name: vlan-interface
7563           in: path
7564           description: String that identifies the interface
7565           required: true
7566           type: string
7567           example: __VLAN-INTERFACE__
7568         - name: l3-interface-ipv4-address
7569           in: path
7570           description: IP address
7571           required: true
7572           type: string
7573           example: __L3-INTERFACE-IPV4-ADDRESS__
7574         - name: body
7575           in: body
7576           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7577           required: true
7578           schema:
7579             $ref: "#/definitions/l3-interface-ipv4-address-list"
7580     patch:
7581       tags:
7582         - CloudInfrastructure
7583       summary: update an existing l3-interface-ipv4-address-list
7584       description: |
7585         Update an existing l3-interface-ipv4-address-list
7586         #
7587         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7588         The PUT operation will entirely replace an existing object.
7589         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7590         #
7591         Other differences between PUT and PATCH are:
7592         #
7593         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7594         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7595         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7596       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7597       consumes:
7598         - application/json
7599         - application/xml
7600       produces:
7601         - application/json
7602         - application/xml
7603       responses:
7604         "default":
7605           description: Response codes found in [response codes](https://wiki.onap.org/).
7606       parameters:
7607         - name: hostname
7608           in: path
7609           description: Value from executing hostname on the compute node.
7610           required: true
7611           type: string
7612           example: __HOSTNAME__
7613         - name: interface-name
7614           in: path
7615           description: Name that identifies the physical interface
7616           required: true
7617           type: string
7618           example: __INTERFACE-NAME__
7619         - name: interface-name
7620           in: path
7621           description: Name given to the interface
7622           required: true
7623           type: string
7624           example: __INTERFACE-NAME__
7625         - name: vlan-interface
7626           in: path
7627           description: String that identifies the interface
7628           required: true
7629           type: string
7630           example: __VLAN-INTERFACE__
7631         - name: l3-interface-ipv4-address
7632           in: path
7633           description: IP address
7634           required: true
7635           type: string
7636           example: __L3-INTERFACE-IPV4-ADDRESS__
7637         - name: body
7638           in: body
7639           description: l3-interface-ipv4-address-list object that needs to be updated.
7640           required: true
7641           schema:
7642             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
7643     delete:
7644       tags:
7645         - CloudInfrastructure
7646       summary: delete an existing l3-interface-ipv4-address-list
7647       description: delete an existing l3-interface-ipv4-address-list
7648       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7649       consumes:
7650         - application/json
7651         - application/xml
7652       produces:
7653         - application/json
7654         - application/xml
7655       responses:
7656         "default":
7657           description: Response codes found in [response codes](https://wiki.onap.org/).
7658       parameters:
7659         - name: hostname
7660           in: path
7661           description: Value from executing hostname on the compute node.
7662           required: true
7663           type: string
7664           example: __HOSTNAME__
7665         - name: interface-name
7666           in: path
7667           description: Name that identifies the physical interface
7668           required: true
7669           type: string
7670           example: __INTERFACE-NAME__
7671         - name: interface-name
7672           in: path
7673           description: Name given to the interface
7674           required: true
7675           type: string
7676           example: __INTERFACE-NAME__
7677         - name: vlan-interface
7678           in: path
7679           description: String that identifies the interface
7680           required: true
7681           type: string
7682           example: __VLAN-INTERFACE__
7683         - name: l3-interface-ipv4-address
7684           in: path
7685           description: IP address
7686           required: true
7687           type: string
7688           example: __L3-INTERFACE-IPV4-ADDRESS__
7689         - name: resource-version
7690           in: query
7691           description: resource-version for concurrency
7692           required: true
7693           type: string
7694   /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:
7695     put:
7696       tags:
7697         - CloudInfrastructure
7698       summary: see node definition for valid relationships
7699       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7700       consumes:
7701         - application/json
7702         - application/xml
7703       produces:
7704         - application/json
7705         - application/xml
7706       responses:
7707         "default":
7708           description: Response codes found in [response codes](https://wiki.onap.org/).
7709       parameters:
7710         - name: hostname
7711           in: path
7712           description: Value from executing hostname on the compute node.
7713           required: true
7714           type: string
7715           example: __HOSTNAME__
7716         - name: interface-name
7717           in: path
7718           description: Name that identifies the physical interface
7719           required: true
7720           type: string
7721           example: __INTERFACE-NAME__
7722         - name: interface-name
7723           in: path
7724           description: Name given to the interface
7725           required: true
7726           type: string
7727           example: __INTERFACE-NAME__
7728         - name: vlan-interface
7729           in: path
7730           description: String that identifies the interface
7731           required: true
7732           type: string
7733           example: __VLAN-INTERFACE__
7734         - name: l3-interface-ipv6-address
7735           in: path
7736           description: IP address
7737           required: true
7738           type: string
7739           example: __L3-INTERFACE-IPV6-ADDRESS__
7740         - name: body
7741           in: body
7742           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7743           required: true
7744           schema:
7745             $ref: "#/definitions/relationship"
7746     delete:
7747       tags:
7748         - CloudInfrastructure
7749       summary: delete an existing relationship
7750       description: delete an existing relationship
7751       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7752       consumes:
7753         - application/json
7754         - application/xml
7755       produces:
7756         - application/json
7757         - application/xml
7758       responses:
7759         "default":
7760           description: Response codes found in [response codes](https://wiki.onap.org/).
7761       parameters:
7762         - name: hostname
7763           in: path
7764           description: Value from executing hostname on the compute node.
7765           required: true
7766           type: string
7767           example: __HOSTNAME__
7768         - name: interface-name
7769           in: path
7770           description: Name that identifies the physical interface
7771           required: true
7772           type: string
7773           example: __INTERFACE-NAME__
7774         - name: interface-name
7775           in: path
7776           description: Name given to the interface
7777           required: true
7778           type: string
7779           example: __INTERFACE-NAME__
7780         - name: vlan-interface
7781           in: path
7782           description: String that identifies the interface
7783           required: true
7784           type: string
7785           example: __VLAN-INTERFACE__
7786         - name: l3-interface-ipv6-address
7787           in: path
7788           description: IP address
7789           required: true
7790           type: string
7791           example: __L3-INTERFACE-IPV6-ADDRESS__
7792   /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}:
7793     get:
7794       tags:
7795         - CloudInfrastructure
7796       summary: returns l3-interface-ipv6-address-list
7797       description: returns l3-interface-ipv6-address-list
7798       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7799       produces:
7800         - application/json
7801         - application/xml
7802       responses:
7803         "200":
7804           description: successful operation
7805           schema:
7806               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
7807         "default":
7808           description: Response codes found in [response codes](https://wiki.onap.org/).
7809       parameters:
7810         - name: hostname
7811           in: path
7812           description: Value from executing hostname on the compute node.
7813           required: true
7814           type: string
7815           example: __HOSTNAME__
7816         - name: interface-name
7817           in: path
7818           description: Name that identifies the physical interface
7819           required: true
7820           type: string
7821           example: __INTERFACE-NAME__
7822         - name: interface-name
7823           in: path
7824           description: Name given to the interface
7825           required: true
7826           type: string
7827           example: __INTERFACE-NAME__
7828         - name: vlan-interface
7829           in: path
7830           description: String that identifies the interface
7831           required: true
7832           type: string
7833           example: __VLAN-INTERFACE__
7834         - name: l3-interface-ipv6-address
7835           in: path
7836           description: IP address
7837           required: true
7838           type: string
7839           example: __L3-INTERFACE-IPV6-ADDRESS__
7840     put:
7841       tags:
7842         - CloudInfrastructure
7843       summary: create or update an existing l3-interface-ipv6-address-list
7844       description: |
7845         Create or update an existing l3-interface-ipv6-address-list.
7846         #
7847         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7848       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7849       consumes:
7850         - application/json
7851         - application/xml
7852       produces:
7853         - application/json
7854         - application/xml
7855       responses:
7856         "default":
7857           description: Response codes found in [response codes](https://wiki.onap.org/).
7858       parameters:
7859         - name: hostname
7860           in: path
7861           description: Value from executing hostname on the compute node.
7862           required: true
7863           type: string
7864           example: __HOSTNAME__
7865         - name: interface-name
7866           in: path
7867           description: Name that identifies the physical interface
7868           required: true
7869           type: string
7870           example: __INTERFACE-NAME__
7871         - name: interface-name
7872           in: path
7873           description: Name given to the interface
7874           required: true
7875           type: string
7876           example: __INTERFACE-NAME__
7877         - name: vlan-interface
7878           in: path
7879           description: String that identifies the interface
7880           required: true
7881           type: string
7882           example: __VLAN-INTERFACE__
7883         - name: l3-interface-ipv6-address
7884           in: path
7885           description: IP address
7886           required: true
7887           type: string
7888           example: __L3-INTERFACE-IPV6-ADDRESS__
7889         - name: body
7890           in: body
7891           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7892           required: true
7893           schema:
7894             $ref: "#/definitions/l3-interface-ipv6-address-list"
7895     patch:
7896       tags:
7897         - CloudInfrastructure
7898       summary: update an existing l3-interface-ipv6-address-list
7899       description: |
7900         Update an existing l3-interface-ipv6-address-list
7901         #
7902         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7903         The PUT operation will entirely replace an existing object.
7904         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7905         #
7906         Other differences between PUT and PATCH are:
7907         #
7908         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7909         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7910         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7911       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7912       consumes:
7913         - application/json
7914         - application/xml
7915       produces:
7916         - application/json
7917         - application/xml
7918       responses:
7919         "default":
7920           description: Response codes found in [response codes](https://wiki.onap.org/).
7921       parameters:
7922         - name: hostname
7923           in: path
7924           description: Value from executing hostname on the compute node.
7925           required: true
7926           type: string
7927           example: __HOSTNAME__
7928         - name: interface-name
7929           in: path
7930           description: Name that identifies the physical interface
7931           required: true
7932           type: string
7933           example: __INTERFACE-NAME__
7934         - name: interface-name
7935           in: path
7936           description: Name given to the interface
7937           required: true
7938           type: string
7939           example: __INTERFACE-NAME__
7940         - name: vlan-interface
7941           in: path
7942           description: String that identifies the interface
7943           required: true
7944           type: string
7945           example: __VLAN-INTERFACE__
7946         - name: l3-interface-ipv6-address
7947           in: path
7948           description: IP address
7949           required: true
7950           type: string
7951           example: __L3-INTERFACE-IPV6-ADDRESS__
7952         - name: body
7953           in: body
7954           description: l3-interface-ipv6-address-list object that needs to be updated.
7955           required: true
7956           schema:
7957             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
7958     delete:
7959       tags:
7960         - CloudInfrastructure
7961       summary: delete an existing l3-interface-ipv6-address-list
7962       description: delete an existing l3-interface-ipv6-address-list
7963       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7964       consumes:
7965         - application/json
7966         - application/xml
7967       produces:
7968         - application/json
7969         - application/xml
7970       responses:
7971         "default":
7972           description: Response codes found in [response codes](https://wiki.onap.org/).
7973       parameters:
7974         - name: hostname
7975           in: path
7976           description: Value from executing hostname on the compute node.
7977           required: true
7978           type: string
7979           example: __HOSTNAME__
7980         - name: interface-name
7981           in: path
7982           description: Name that identifies the physical interface
7983           required: true
7984           type: string
7985           example: __INTERFACE-NAME__
7986         - name: interface-name
7987           in: path
7988           description: Name given to the interface
7989           required: true
7990           type: string
7991           example: __INTERFACE-NAME__
7992         - name: vlan-interface
7993           in: path
7994           description: String that identifies the interface
7995           required: true
7996           type: string
7997           example: __VLAN-INTERFACE__
7998         - name: l3-interface-ipv6-address
7999           in: path
8000           description: IP address
8001           required: true
8002           type: string
8003           example: __L3-INTERFACE-IPV6-ADDRESS__
8004         - name: resource-version
8005           in: query
8006           description: resource-version for concurrency
8007           required: true
8008           type: string
8009   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8010     get:
8011       tags:
8012         - CloudInfrastructure
8013       summary: returns vlan
8014       description: returns vlan
8015       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8016       produces:
8017         - application/json
8018         - application/xml
8019       responses:
8020         "200":
8021           description: successful operation
8022           schema:
8023               $ref: "#/getDefinitions/vlan"
8024         "default":
8025           description: Response codes found in [response codes](https://wiki.onap.org/).
8026       parameters:
8027         - name: hostname
8028           in: path
8029           description: Value from executing hostname on the compute node.
8030           required: true
8031           type: string
8032           example: __HOSTNAME__
8033         - name: interface-name
8034           in: path
8035           description: Name that identifies the physical interface
8036           required: true
8037           type: string
8038           example: __INTERFACE-NAME__
8039         - name: interface-name
8040           in: path
8041           description: Name given to the interface
8042           required: true
8043           type: string
8044           example: __INTERFACE-NAME__
8045         - name: vlan-interface
8046           in: path
8047           description: String that identifies the interface
8048           required: true
8049           type: string
8050           example: __VLAN-INTERFACE__
8051     put:
8052       tags:
8053         - CloudInfrastructure
8054       summary: create or update an existing vlan
8055       description: |
8056         Create or update an existing vlan.
8057         #
8058         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8059       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8060       consumes:
8061         - application/json
8062         - application/xml
8063       produces:
8064         - application/json
8065         - application/xml
8066       responses:
8067         "default":
8068           description: Response codes found in [response codes](https://wiki.onap.org/).
8069       parameters:
8070         - name: hostname
8071           in: path
8072           description: Value from executing hostname on the compute node.
8073           required: true
8074           type: string
8075           example: __HOSTNAME__
8076         - name: interface-name
8077           in: path
8078           description: Name that identifies the physical interface
8079           required: true
8080           type: string
8081           example: __INTERFACE-NAME__
8082         - name: interface-name
8083           in: path
8084           description: Name given to the interface
8085           required: true
8086           type: string
8087           example: __INTERFACE-NAME__
8088         - name: vlan-interface
8089           in: path
8090           description: String that identifies the interface
8091           required: true
8092           type: string
8093           example: __VLAN-INTERFACE__
8094         - name: body
8095           in: body
8096           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8097           required: true
8098           schema:
8099             $ref: "#/definitions/vlan"
8100     patch:
8101       tags:
8102         - CloudInfrastructure
8103       summary: update an existing vlan
8104       description: |
8105         Update an existing vlan
8106         #
8107         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8108         The PUT operation will entirely replace an existing object.
8109         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8110         #
8111         Other differences between PUT and PATCH are:
8112         #
8113         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8114         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8115         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8116       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8117       consumes:
8118         - application/json
8119         - application/xml
8120       produces:
8121         - application/json
8122         - application/xml
8123       responses:
8124         "default":
8125           description: Response codes found in [response codes](https://wiki.onap.org/).
8126       parameters:
8127         - name: hostname
8128           in: path
8129           description: Value from executing hostname on the compute node.
8130           required: true
8131           type: string
8132           example: __HOSTNAME__
8133         - name: interface-name
8134           in: path
8135           description: Name that identifies the physical interface
8136           required: true
8137           type: string
8138           example: __INTERFACE-NAME__
8139         - name: interface-name
8140           in: path
8141           description: Name given to the interface
8142           required: true
8143           type: string
8144           example: __INTERFACE-NAME__
8145         - name: vlan-interface
8146           in: path
8147           description: String that identifies the interface
8148           required: true
8149           type: string
8150           example: __VLAN-INTERFACE__
8151         - name: body
8152           in: body
8153           description: vlan object that needs to be updated.
8154           required: true
8155           schema:
8156             $ref: "#/patchDefinitions/vlan"
8157     delete:
8158       tags:
8159         - CloudInfrastructure
8160       summary: delete an existing vlan
8161       description: delete an existing vlan
8162       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8163       consumes:
8164         - application/json
8165         - application/xml
8166       produces:
8167         - application/json
8168         - application/xml
8169       responses:
8170         "default":
8171           description: Response codes found in [response codes](https://wiki.onap.org/).
8172       parameters:
8173         - name: hostname
8174           in: path
8175           description: Value from executing hostname on the compute node.
8176           required: true
8177           type: string
8178           example: __HOSTNAME__
8179         - name: interface-name
8180           in: path
8181           description: Name that identifies the physical interface
8182           required: true
8183           type: string
8184           example: __INTERFACE-NAME__
8185         - name: interface-name
8186           in: path
8187           description: Name given to the interface
8188           required: true
8189           type: string
8190           example: __INTERFACE-NAME__
8191         - name: vlan-interface
8192           in: path
8193           description: String that identifies the interface
8194           required: true
8195           type: string
8196           example: __VLAN-INTERFACE__
8197         - name: resource-version
8198           in: query
8199           description: resource-version for concurrency
8200           required: true
8201           type: string
8202   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
8203     get:
8204       tags:
8205         - CloudInfrastructure
8206       summary: returns vlans
8207       description: returns vlans
8208       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
8209       produces:
8210         - application/json
8211         - application/xml
8212       responses:
8213         "200":
8214           description: successful operation
8215           schema:
8216               $ref: "#/getDefinitions/vlans"
8217         "default":
8218           description: Response codes found in [response codes](https://wiki.onap.org/).
8219       parameters:
8220         - name: hostname
8221           in: path
8222           description: Value from executing hostname on the compute node.
8223           required: true
8224           type: string
8225           example: __HOSTNAME__
8226         - name: interface-name
8227           in: path
8228           description: Name that identifies the physical interface
8229           required: true
8230           type: string
8231           example: __INTERFACE-NAME__
8232         - name: interface-name
8233           in: path
8234           description: Name given to the interface
8235           required: true
8236           type: string
8237           example: __INTERFACE-NAME__
8238         - name: vlan-interface
8239           in: query
8240           description:
8241           required: false
8242           type: string
8243         - name: vlan-id-inner
8244           in: query
8245           description:
8246           required: false
8247           type: integer
8248           format: int64
8249         - name: vpn-id
8250           in: query
8251           description:
8252           required: false
8253           type: string
8254   /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:
8255     put:
8256       tags:
8257         - CloudInfrastructure
8258       summary: see node definition for valid relationships
8259       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8260       consumes:
8261         - application/json
8262         - application/xml
8263       produces:
8264         - application/json
8265         - application/xml
8266       responses:
8267         "default":
8268           description: Response codes found in [response codes](https://wiki.onap.org/).
8269       parameters:
8270         - name: hostname
8271           in: path
8272           description: Value from executing hostname on the compute node.
8273           required: true
8274           type: string
8275           example: __HOSTNAME__
8276         - name: interface-name
8277           in: path
8278           description: Name that identifies the physical interface
8279           required: true
8280           type: string
8281           example: __INTERFACE-NAME__
8282         - name: interface-name
8283           in: path
8284           description: Name given to the interface
8285           required: true
8286           type: string
8287           example: __INTERFACE-NAME__
8288         - name: pci-id
8289           in: path
8290           description: PCI ID used to identify the sriov-vf
8291           required: true
8292           type: string
8293           example: __PCI-ID__
8294         - name: body
8295           in: body
8296           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8297           required: true
8298           schema:
8299             $ref: "#/definitions/relationship"
8300     delete:
8301       tags:
8302         - CloudInfrastructure
8303       summary: delete an existing relationship
8304       description: delete an existing relationship
8305       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8306       consumes:
8307         - application/json
8308         - application/xml
8309       produces:
8310         - application/json
8311         - application/xml
8312       responses:
8313         "default":
8314           description: Response codes found in [response codes](https://wiki.onap.org/).
8315       parameters:
8316         - name: hostname
8317           in: path
8318           description: Value from executing hostname on the compute node.
8319           required: true
8320           type: string
8321           example: __HOSTNAME__
8322         - name: interface-name
8323           in: path
8324           description: Name that identifies the physical interface
8325           required: true
8326           type: string
8327           example: __INTERFACE-NAME__
8328         - name: interface-name
8329           in: path
8330           description: Name given to the interface
8331           required: true
8332           type: string
8333           example: __INTERFACE-NAME__
8334         - name: pci-id
8335           in: path
8336           description: PCI ID used to identify the sriov-vf
8337           required: true
8338           type: string
8339           example: __PCI-ID__
8340   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
8341     get:
8342       tags:
8343         - CloudInfrastructure
8344       summary: returns sriov-vf
8345       description: returns sriov-vf
8346       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8347       produces:
8348         - application/json
8349         - application/xml
8350       responses:
8351         "200":
8352           description: successful operation
8353           schema:
8354               $ref: "#/getDefinitions/sriov-vf"
8355         "default":
8356           description: Response codes found in [response codes](https://wiki.onap.org/).
8357       parameters:
8358         - name: hostname
8359           in: path
8360           description: Value from executing hostname on the compute node.
8361           required: true
8362           type: string
8363           example: __HOSTNAME__
8364         - name: interface-name
8365           in: path
8366           description: Name that identifies the physical interface
8367           required: true
8368           type: string
8369           example: __INTERFACE-NAME__
8370         - name: interface-name
8371           in: path
8372           description: Name given to the interface
8373           required: true
8374           type: string
8375           example: __INTERFACE-NAME__
8376         - name: pci-id
8377           in: path
8378           description: PCI ID used to identify the sriov-vf
8379           required: true
8380           type: string
8381           example: __PCI-ID__
8382     put:
8383       tags:
8384         - CloudInfrastructure
8385       summary: create or update an existing sriov-vf
8386       description: |
8387         Create or update an existing sriov-vf.
8388         #
8389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8390       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8391       consumes:
8392         - application/json
8393         - application/xml
8394       produces:
8395         - application/json
8396         - application/xml
8397       responses:
8398         "default":
8399           description: Response codes found in [response codes](https://wiki.onap.org/).
8400       parameters:
8401         - name: hostname
8402           in: path
8403           description: Value from executing hostname on the compute node.
8404           required: true
8405           type: string
8406           example: __HOSTNAME__
8407         - name: interface-name
8408           in: path
8409           description: Name that identifies the physical interface
8410           required: true
8411           type: string
8412           example: __INTERFACE-NAME__
8413         - name: interface-name
8414           in: path
8415           description: Name given to the interface
8416           required: true
8417           type: string
8418           example: __INTERFACE-NAME__
8419         - name: pci-id
8420           in: path
8421           description: PCI ID used to identify the sriov-vf
8422           required: true
8423           type: string
8424           example: __PCI-ID__
8425         - name: body
8426           in: body
8427           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8428           required: true
8429           schema:
8430             $ref: "#/definitions/sriov-vf"
8431     patch:
8432       tags:
8433         - CloudInfrastructure
8434       summary: update an existing sriov-vf
8435       description: |
8436         Update an existing sriov-vf
8437         #
8438         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8439         The PUT operation will entirely replace an existing object.
8440         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8441         #
8442         Other differences between PUT and PATCH are:
8443         #
8444         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8445         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8446         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8447       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8448       consumes:
8449         - application/json
8450         - application/xml
8451       produces:
8452         - application/json
8453         - application/xml
8454       responses:
8455         "default":
8456           description: Response codes found in [response codes](https://wiki.onap.org/).
8457       parameters:
8458         - name: hostname
8459           in: path
8460           description: Value from executing hostname on the compute node.
8461           required: true
8462           type: string
8463           example: __HOSTNAME__
8464         - name: interface-name
8465           in: path
8466           description: Name that identifies the physical interface
8467           required: true
8468           type: string
8469           example: __INTERFACE-NAME__
8470         - name: interface-name
8471           in: path
8472           description: Name given to the interface
8473           required: true
8474           type: string
8475           example: __INTERFACE-NAME__
8476         - name: pci-id
8477           in: path
8478           description: PCI ID used to identify the sriov-vf
8479           required: true
8480           type: string
8481           example: __PCI-ID__
8482         - name: body
8483           in: body
8484           description: sriov-vf object that needs to be updated.
8485           required: true
8486           schema:
8487             $ref: "#/patchDefinitions/sriov-vf"
8488     delete:
8489       tags:
8490         - CloudInfrastructure
8491       summary: delete an existing sriov-vf
8492       description: delete an existing sriov-vf
8493       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8494       consumes:
8495         - application/json
8496         - application/xml
8497       produces:
8498         - application/json
8499         - application/xml
8500       responses:
8501         "default":
8502           description: Response codes found in [response codes](https://wiki.onap.org/).
8503       parameters:
8504         - name: hostname
8505           in: path
8506           description: Value from executing hostname on the compute node.
8507           required: true
8508           type: string
8509           example: __HOSTNAME__
8510         - name: interface-name
8511           in: path
8512           description: Name that identifies the physical interface
8513           required: true
8514           type: string
8515           example: __INTERFACE-NAME__
8516         - name: interface-name
8517           in: path
8518           description: Name given to the interface
8519           required: true
8520           type: string
8521           example: __INTERFACE-NAME__
8522         - name: pci-id
8523           in: path
8524           description: PCI ID used to identify the sriov-vf
8525           required: true
8526           type: string
8527           example: __PCI-ID__
8528         - name: resource-version
8529           in: query
8530           description: resource-version for concurrency
8531           required: true
8532           type: string
8533   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
8534     get:
8535       tags:
8536         - CloudInfrastructure
8537       summary: returns sriov-vfs
8538       description: returns sriov-vfs
8539       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
8540       produces:
8541         - application/json
8542         - application/xml
8543       responses:
8544         "200":
8545           description: successful operation
8546           schema:
8547               $ref: "#/getDefinitions/sriov-vfs"
8548         "default":
8549           description: Response codes found in [response codes](https://wiki.onap.org/).
8550       parameters:
8551         - name: hostname
8552           in: path
8553           description: Value from executing hostname on the compute node.
8554           required: true
8555           type: string
8556           example: __HOSTNAME__
8557         - name: interface-name
8558           in: path
8559           description: Name that identifies the physical interface
8560           required: true
8561           type: string
8562           example: __INTERFACE-NAME__
8563         - name: interface-name
8564           in: path
8565           description: Name given to the interface
8566           required: true
8567           type: string
8568           example: __INTERFACE-NAME__
8569         - name: pci-id
8570           in: query
8571           description:
8572           required: false
8573           type: string
8574         - name: vf-vlan-filter
8575           in: query
8576           description:
8577           required: false
8578           type: string
8579         - name: vf-mac-filter
8580           in: query
8581           description:
8582           required: false
8583           type: string
8584         - name: vf-vlan-strip
8585           in: query
8586           description:
8587           required: false
8588           type: boolean
8589         - name: neutron-network-id
8590           in: query
8591           description:
8592           required: false
8593           type: string
8594   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
8595     put:
8596       tags:
8597         - CloudInfrastructure
8598       summary: see node definition for valid relationships
8599       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8600       consumes:
8601         - application/json
8602         - application/xml
8603       produces:
8604         - application/json
8605         - application/xml
8606       responses:
8607         "default":
8608           description: Response codes found in [response codes](https://wiki.onap.org/).
8609       parameters:
8610         - name: hostname
8611           in: path
8612           description: Value from executing hostname on the compute node.
8613           required: true
8614           type: string
8615           example: __HOSTNAME__
8616         - name: interface-name
8617           in: path
8618           description: Name that identifies the physical interface
8619           required: true
8620           type: string
8621           example: __INTERFACE-NAME__
8622         - name: interface-name
8623           in: path
8624           description: Name given to the interface
8625           required: true
8626           type: string
8627           example: __INTERFACE-NAME__
8628         - name: body
8629           in: body
8630           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
8631           required: true
8632           schema:
8633             $ref: "#/definitions/relationship"
8634     delete:
8635       tags:
8636         - CloudInfrastructure
8637       summary: delete an existing relationship
8638       description: delete an existing relationship
8639       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8640       consumes:
8641         - application/json
8642         - application/xml
8643       produces:
8644         - application/json
8645         - application/xml
8646       responses:
8647         "default":
8648           description: Response codes found in [response codes](https://wiki.onap.org/).
8649       parameters:
8650         - name: hostname
8651           in: path
8652           description: Value from executing hostname on the compute node.
8653           required: true
8654           type: string
8655           example: __HOSTNAME__
8656         - name: interface-name
8657           in: path
8658           description: Name that identifies the physical interface
8659           required: true
8660           type: string
8661           example: __INTERFACE-NAME__
8662         - name: interface-name
8663           in: path
8664           description: Name given to the interface
8665           required: true
8666           type: string
8667           example: __INTERFACE-NAME__
8668   /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:
8669     put:
8670       tags:
8671         - CloudInfrastructure
8672       summary: see node definition for valid relationships
8673       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8674       consumes:
8675         - application/json
8676         - application/xml
8677       produces:
8678         - application/json
8679         - application/xml
8680       responses:
8681         "default":
8682           description: Response codes found in [response codes](https://wiki.onap.org/).
8683       parameters:
8684         - name: hostname
8685           in: path
8686           description: Value from executing hostname on the compute node.
8687           required: true
8688           type: string
8689           example: __HOSTNAME__
8690         - name: interface-name
8691           in: path
8692           description: Name that identifies the physical interface
8693           required: true
8694           type: string
8695           example: __INTERFACE-NAME__
8696         - name: interface-name
8697           in: path
8698           description: Name given to the interface
8699           required: true
8700           type: string
8701           example: __INTERFACE-NAME__
8702         - name: l3-interface-ipv4-address
8703           in: path
8704           description: IP address
8705           required: true
8706           type: string
8707           example: __L3-INTERFACE-IPV4-ADDRESS__
8708         - name: body
8709           in: body
8710           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8711           required: true
8712           schema:
8713             $ref: "#/definitions/relationship"
8714     delete:
8715       tags:
8716         - CloudInfrastructure
8717       summary: delete an existing relationship
8718       description: delete an existing relationship
8719       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8720       consumes:
8721         - application/json
8722         - application/xml
8723       produces:
8724         - application/json
8725         - application/xml
8726       responses:
8727         "default":
8728           description: Response codes found in [response codes](https://wiki.onap.org/).
8729       parameters:
8730         - name: hostname
8731           in: path
8732           description: Value from executing hostname on the compute node.
8733           required: true
8734           type: string
8735           example: __HOSTNAME__
8736         - name: interface-name
8737           in: path
8738           description: Name that identifies the physical interface
8739           required: true
8740           type: string
8741           example: __INTERFACE-NAME__
8742         - name: interface-name
8743           in: path
8744           description: Name given to the interface
8745           required: true
8746           type: string
8747           example: __INTERFACE-NAME__
8748         - name: l3-interface-ipv4-address
8749           in: path
8750           description: IP address
8751           required: true
8752           type: string
8753           example: __L3-INTERFACE-IPV4-ADDRESS__
8754   /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}:
8755     get:
8756       tags:
8757         - CloudInfrastructure
8758       summary: returns l3-interface-ipv4-address-list
8759       description: returns l3-interface-ipv4-address-list
8760       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8761       produces:
8762         - application/json
8763         - application/xml
8764       responses:
8765         "200":
8766           description: successful operation
8767           schema:
8768               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8769         "default":
8770           description: Response codes found in [response codes](https://wiki.onap.org/).
8771       parameters:
8772         - name: hostname
8773           in: path
8774           description: Value from executing hostname on the compute node.
8775           required: true
8776           type: string
8777           example: __HOSTNAME__
8778         - name: interface-name
8779           in: path
8780           description: Name that identifies the physical interface
8781           required: true
8782           type: string
8783           example: __INTERFACE-NAME__
8784         - name: interface-name
8785           in: path
8786           description: Name given to the interface
8787           required: true
8788           type: string
8789           example: __INTERFACE-NAME__
8790         - name: l3-interface-ipv4-address
8791           in: path
8792           description: IP address
8793           required: true
8794           type: string
8795           example: __L3-INTERFACE-IPV4-ADDRESS__
8796     put:
8797       tags:
8798         - CloudInfrastructure
8799       summary: create or update an existing l3-interface-ipv4-address-list
8800       description: |
8801         Create or update an existing l3-interface-ipv4-address-list.
8802         #
8803         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8804       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8805       consumes:
8806         - application/json
8807         - application/xml
8808       produces:
8809         - application/json
8810         - application/xml
8811       responses:
8812         "default":
8813           description: Response codes found in [response codes](https://wiki.onap.org/).
8814       parameters:
8815         - name: hostname
8816           in: path
8817           description: Value from executing hostname on the compute node.
8818           required: true
8819           type: string
8820           example: __HOSTNAME__
8821         - name: interface-name
8822           in: path
8823           description: Name that identifies the physical interface
8824           required: true
8825           type: string
8826           example: __INTERFACE-NAME__
8827         - name: interface-name
8828           in: path
8829           description: Name given to the interface
8830           required: true
8831           type: string
8832           example: __INTERFACE-NAME__
8833         - name: l3-interface-ipv4-address
8834           in: path
8835           description: IP address
8836           required: true
8837           type: string
8838           example: __L3-INTERFACE-IPV4-ADDRESS__
8839         - name: body
8840           in: body
8841           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8842           required: true
8843           schema:
8844             $ref: "#/definitions/l3-interface-ipv4-address-list"
8845     patch:
8846       tags:
8847         - CloudInfrastructure
8848       summary: update an existing l3-interface-ipv4-address-list
8849       description: |
8850         Update an existing l3-interface-ipv4-address-list
8851         #
8852         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8853         The PUT operation will entirely replace an existing object.
8854         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8855         #
8856         Other differences between PUT and PATCH are:
8857         #
8858         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8859         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8860         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8861       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8862       consumes:
8863         - application/json
8864         - application/xml
8865       produces:
8866         - application/json
8867         - application/xml
8868       responses:
8869         "default":
8870           description: Response codes found in [response codes](https://wiki.onap.org/).
8871       parameters:
8872         - name: hostname
8873           in: path
8874           description: Value from executing hostname on the compute node.
8875           required: true
8876           type: string
8877           example: __HOSTNAME__
8878         - name: interface-name
8879           in: path
8880           description: Name that identifies the physical interface
8881           required: true
8882           type: string
8883           example: __INTERFACE-NAME__
8884         - name: interface-name
8885           in: path
8886           description: Name given to the interface
8887           required: true
8888           type: string
8889           example: __INTERFACE-NAME__
8890         - name: l3-interface-ipv4-address
8891           in: path
8892           description: IP address
8893           required: true
8894           type: string
8895           example: __L3-INTERFACE-IPV4-ADDRESS__
8896         - name: body
8897           in: body
8898           description: l3-interface-ipv4-address-list object that needs to be updated.
8899           required: true
8900           schema:
8901             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8902     delete:
8903       tags:
8904         - CloudInfrastructure
8905       summary: delete an existing l3-interface-ipv4-address-list
8906       description: delete an existing l3-interface-ipv4-address-list
8907       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8908       consumes:
8909         - application/json
8910         - application/xml
8911       produces:
8912         - application/json
8913         - application/xml
8914       responses:
8915         "default":
8916           description: Response codes found in [response codes](https://wiki.onap.org/).
8917       parameters:
8918         - name: hostname
8919           in: path
8920           description: Value from executing hostname on the compute node.
8921           required: true
8922           type: string
8923           example: __HOSTNAME__
8924         - name: interface-name
8925           in: path
8926           description: Name that identifies the physical interface
8927           required: true
8928           type: string
8929           example: __INTERFACE-NAME__
8930         - name: interface-name
8931           in: path
8932           description: Name given to the interface
8933           required: true
8934           type: string
8935           example: __INTERFACE-NAME__
8936         - name: l3-interface-ipv4-address
8937           in: path
8938           description: IP address
8939           required: true
8940           type: string
8941           example: __L3-INTERFACE-IPV4-ADDRESS__
8942         - name: resource-version
8943           in: query
8944           description: resource-version for concurrency
8945           required: true
8946           type: string
8947   /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:
8948     put:
8949       tags:
8950         - CloudInfrastructure
8951       summary: see node definition for valid relationships
8952       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8953       consumes:
8954         - application/json
8955         - application/xml
8956       produces:
8957         - application/json
8958         - application/xml
8959       responses:
8960         "default":
8961           description: Response codes found in [response codes](https://wiki.onap.org/).
8962       parameters:
8963         - name: hostname
8964           in: path
8965           description: Value from executing hostname on the compute node.
8966           required: true
8967           type: string
8968           example: __HOSTNAME__
8969         - name: interface-name
8970           in: path
8971           description: Name that identifies the physical interface
8972           required: true
8973           type: string
8974           example: __INTERFACE-NAME__
8975         - name: interface-name
8976           in: path
8977           description: Name given to the interface
8978           required: true
8979           type: string
8980           example: __INTERFACE-NAME__
8981         - name: l3-interface-ipv6-address
8982           in: path
8983           description: IP address
8984           required: true
8985           type: string
8986           example: __L3-INTERFACE-IPV6-ADDRESS__
8987         - name: body
8988           in: body
8989           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
8990           required: true
8991           schema:
8992             $ref: "#/definitions/relationship"
8993     delete:
8994       tags:
8995         - CloudInfrastructure
8996       summary: delete an existing relationship
8997       description: delete an existing relationship
8998       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8999       consumes:
9000         - application/json
9001         - application/xml
9002       produces:
9003         - application/json
9004         - application/xml
9005       responses:
9006         "default":
9007           description: Response codes found in [response codes](https://wiki.onap.org/).
9008       parameters:
9009         - name: hostname
9010           in: path
9011           description: Value from executing hostname on the compute node.
9012           required: true
9013           type: string
9014           example: __HOSTNAME__
9015         - name: interface-name
9016           in: path
9017           description: Name that identifies the physical interface
9018           required: true
9019           type: string
9020           example: __INTERFACE-NAME__
9021         - name: interface-name
9022           in: path
9023           description: Name given to the interface
9024           required: true
9025           type: string
9026           example: __INTERFACE-NAME__
9027         - name: l3-interface-ipv6-address
9028           in: path
9029           description: IP address
9030           required: true
9031           type: string
9032           example: __L3-INTERFACE-IPV6-ADDRESS__
9033   /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}:
9034     get:
9035       tags:
9036         - CloudInfrastructure
9037       summary: returns l3-interface-ipv6-address-list
9038       description: returns l3-interface-ipv6-address-list
9039       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9040       produces:
9041         - application/json
9042         - application/xml
9043       responses:
9044         "200":
9045           description: successful operation
9046           schema:
9047               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9048         "default":
9049           description: Response codes found in [response codes](https://wiki.onap.org/).
9050       parameters:
9051         - name: hostname
9052           in: path
9053           description: Value from executing hostname on the compute node.
9054           required: true
9055           type: string
9056           example: __HOSTNAME__
9057         - name: interface-name
9058           in: path
9059           description: Name that identifies the physical interface
9060           required: true
9061           type: string
9062           example: __INTERFACE-NAME__
9063         - name: interface-name
9064           in: path
9065           description: Name given to the interface
9066           required: true
9067           type: string
9068           example: __INTERFACE-NAME__
9069         - name: l3-interface-ipv6-address
9070           in: path
9071           description: IP address
9072           required: true
9073           type: string
9074           example: __L3-INTERFACE-IPV6-ADDRESS__
9075     put:
9076       tags:
9077         - CloudInfrastructure
9078       summary: create or update an existing l3-interface-ipv6-address-list
9079       description: |
9080         Create or update an existing l3-interface-ipv6-address-list.
9081         #
9082         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9083       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9084       consumes:
9085         - application/json
9086         - application/xml
9087       produces:
9088         - application/json
9089         - application/xml
9090       responses:
9091         "default":
9092           description: Response codes found in [response codes](https://wiki.onap.org/).
9093       parameters:
9094         - name: hostname
9095           in: path
9096           description: Value from executing hostname on the compute node.
9097           required: true
9098           type: string
9099           example: __HOSTNAME__
9100         - name: interface-name
9101           in: path
9102           description: Name that identifies the physical interface
9103           required: true
9104           type: string
9105           example: __INTERFACE-NAME__
9106         - name: interface-name
9107           in: path
9108           description: Name given to the interface
9109           required: true
9110           type: string
9111           example: __INTERFACE-NAME__
9112         - name: l3-interface-ipv6-address
9113           in: path
9114           description: IP address
9115           required: true
9116           type: string
9117           example: __L3-INTERFACE-IPV6-ADDRESS__
9118         - name: body
9119           in: body
9120           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
9121           required: true
9122           schema:
9123             $ref: "#/definitions/l3-interface-ipv6-address-list"
9124     patch:
9125       tags:
9126         - CloudInfrastructure
9127       summary: update an existing l3-interface-ipv6-address-list
9128       description: |
9129         Update an existing l3-interface-ipv6-address-list
9130         #
9131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9132         The PUT operation will entirely replace an existing object.
9133         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9134         #
9135         Other differences between PUT and PATCH are:
9136         #
9137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9140       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9141       consumes:
9142         - application/json
9143         - application/xml
9144       produces:
9145         - application/json
9146         - application/xml
9147       responses:
9148         "default":
9149           description: Response codes found in [response codes](https://wiki.onap.org/).
9150       parameters:
9151         - name: hostname
9152           in: path
9153           description: Value from executing hostname on the compute node.
9154           required: true
9155           type: string
9156           example: __HOSTNAME__
9157         - name: interface-name
9158           in: path
9159           description: Name that identifies the physical interface
9160           required: true
9161           type: string
9162           example: __INTERFACE-NAME__
9163         - name: interface-name
9164           in: path
9165           description: Name given to the interface
9166           required: true
9167           type: string
9168           example: __INTERFACE-NAME__
9169         - name: l3-interface-ipv6-address
9170           in: path
9171           description: IP address
9172           required: true
9173           type: string
9174           example: __L3-INTERFACE-IPV6-ADDRESS__
9175         - name: body
9176           in: body
9177           description: l3-interface-ipv6-address-list object that needs to be updated.
9178           required: true
9179           schema:
9180             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9181     delete:
9182       tags:
9183         - CloudInfrastructure
9184       summary: delete an existing l3-interface-ipv6-address-list
9185       description: delete an existing l3-interface-ipv6-address-list
9186       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9187       consumes:
9188         - application/json
9189         - application/xml
9190       produces:
9191         - application/json
9192         - application/xml
9193       responses:
9194         "default":
9195           description: Response codes found in [response codes](https://wiki.onap.org/).
9196       parameters:
9197         - name: hostname
9198           in: path
9199           description: Value from executing hostname on the compute node.
9200           required: true
9201           type: string
9202           example: __HOSTNAME__
9203         - name: interface-name
9204           in: path
9205           description: Name that identifies the physical interface
9206           required: true
9207           type: string
9208           example: __INTERFACE-NAME__
9209         - name: interface-name
9210           in: path
9211           description: Name given to the interface
9212           required: true
9213           type: string
9214           example: __INTERFACE-NAME__
9215         - name: l3-interface-ipv6-address
9216           in: path
9217           description: IP address
9218           required: true
9219           type: string
9220           example: __L3-INTERFACE-IPV6-ADDRESS__
9221         - name: resource-version
9222           in: query
9223           description: resource-version for concurrency
9224           required: true
9225           type: string
9226   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
9227     get:
9228       tags:
9229         - CloudInfrastructure
9230       summary: returns l-interface
9231       description: returns l-interface
9232       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9233       produces:
9234         - application/json
9235         - application/xml
9236       responses:
9237         "200":
9238           description: successful operation
9239           schema:
9240               $ref: "#/getDefinitions/l-interface"
9241         "default":
9242           description: Response codes found in [response codes](https://wiki.onap.org/).
9243       parameters:
9244         - name: hostname
9245           in: path
9246           description: Value from executing hostname on the compute node.
9247           required: true
9248           type: string
9249           example: __HOSTNAME__
9250         - name: interface-name
9251           in: path
9252           description: Name that identifies the physical interface
9253           required: true
9254           type: string
9255           example: __INTERFACE-NAME__
9256         - name: interface-name
9257           in: path
9258           description: Name given to the interface
9259           required: true
9260           type: string
9261           example: __INTERFACE-NAME__
9262     put:
9263       tags:
9264         - CloudInfrastructure
9265       summary: create or update an existing l-interface
9266       description: |
9267         Create or update an existing l-interface.
9268         #
9269         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9270       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9271       consumes:
9272         - application/json
9273         - application/xml
9274       produces:
9275         - application/json
9276         - application/xml
9277       responses:
9278         "default":
9279           description: Response codes found in [response codes](https://wiki.onap.org/).
9280       parameters:
9281         - name: hostname
9282           in: path
9283           description: Value from executing hostname on the compute node.
9284           required: true
9285           type: string
9286           example: __HOSTNAME__
9287         - name: interface-name
9288           in: path
9289           description: Name that identifies the physical interface
9290           required: true
9291           type: string
9292           example: __INTERFACE-NAME__
9293         - name: interface-name
9294           in: path
9295           description: Name given to the interface
9296           required: true
9297           type: string
9298           example: __INTERFACE-NAME__
9299         - name: body
9300           in: body
9301           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9302           required: true
9303           schema:
9304             $ref: "#/definitions/l-interface"
9305     patch:
9306       tags:
9307         - CloudInfrastructure
9308       summary: update an existing l-interface
9309       description: |
9310         Update an existing l-interface
9311         #
9312         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9313         The PUT operation will entirely replace an existing object.
9314         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9315         #
9316         Other differences between PUT and PATCH are:
9317         #
9318         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9319         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9320         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9321       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9322       consumes:
9323         - application/json
9324         - application/xml
9325       produces:
9326         - application/json
9327         - application/xml
9328       responses:
9329         "default":
9330           description: Response codes found in [response codes](https://wiki.onap.org/).
9331       parameters:
9332         - name: hostname
9333           in: path
9334           description: Value from executing hostname on the compute node.
9335           required: true
9336           type: string
9337           example: __HOSTNAME__
9338         - name: interface-name
9339           in: path
9340           description: Name that identifies the physical interface
9341           required: true
9342           type: string
9343           example: __INTERFACE-NAME__
9344         - name: interface-name
9345           in: path
9346           description: Name given to the interface
9347           required: true
9348           type: string
9349           example: __INTERFACE-NAME__
9350         - name: body
9351           in: body
9352           description: l-interface object that needs to be updated.
9353           required: true
9354           schema:
9355             $ref: "#/patchDefinitions/l-interface"
9356     delete:
9357       tags:
9358         - CloudInfrastructure
9359       summary: delete an existing l-interface
9360       description: delete an existing l-interface
9361       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9362       consumes:
9363         - application/json
9364         - application/xml
9365       produces:
9366         - application/json
9367         - application/xml
9368       responses:
9369         "default":
9370           description: Response codes found in [response codes](https://wiki.onap.org/).
9371       parameters:
9372         - name: hostname
9373           in: path
9374           description: Value from executing hostname on the compute node.
9375           required: true
9376           type: string
9377           example: __HOSTNAME__
9378         - name: interface-name
9379           in: path
9380           description: Name that identifies the physical interface
9381           required: true
9382           type: string
9383           example: __INTERFACE-NAME__
9384         - name: interface-name
9385           in: path
9386           description: Name given to the interface
9387           required: true
9388           type: string
9389           example: __INTERFACE-NAME__
9390         - name: resource-version
9391           in: query
9392           description: resource-version for concurrency
9393           required: true
9394           type: string
9395   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
9396     get:
9397       tags:
9398         - CloudInfrastructure
9399       summary: returns l-interfaces
9400       description: returns l-interfaces
9401       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
9402       produces:
9403         - application/json
9404         - application/xml
9405       responses:
9406         "200":
9407           description: successful operation
9408           schema:
9409               $ref: "#/getDefinitions/l-interfaces"
9410         "default":
9411           description: Response codes found in [response codes](https://wiki.onap.org/).
9412       parameters:
9413         - name: hostname
9414           in: path
9415           description: Value from executing hostname on the compute node.
9416           required: true
9417           type: string
9418           example: __HOSTNAME__
9419         - name: interface-name
9420           in: path
9421           description: Name that identifies the physical interface
9422           required: true
9423           type: string
9424           example: __INTERFACE-NAME__
9425         - name: interface-name
9426           in: query
9427           description:
9428           required: false
9429           type: string
9430         - name: interface-id
9431           in: query
9432           description:
9433           required: false
9434           type: string
9435         - name: macaddr
9436           in: query
9437           description:
9438           required: false
9439           type: string
9440         - name: network-name
9441           in: query
9442           description:
9443           required: false
9444           type: string
9445   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
9446     get:
9447       tags:
9448         - CloudInfrastructure
9449       summary: returns p-interface
9450       description: returns p-interface
9451       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
9452       produces:
9453         - application/json
9454         - application/xml
9455       responses:
9456         "200":
9457           description: successful operation
9458           schema:
9459               $ref: "#/getDefinitions/p-interface"
9460         "default":
9461           description: Response codes found in [response codes](https://wiki.onap.org/).
9462       parameters:
9463         - name: hostname
9464           in: path
9465           description: Value from executing hostname on the compute node.
9466           required: true
9467           type: string
9468           example: __HOSTNAME__
9469         - name: interface-name
9470           in: path
9471           description: Name that identifies the physical interface
9472           required: true
9473           type: string
9474           example: __INTERFACE-NAME__
9475     put:
9476       tags:
9477         - CloudInfrastructure
9478       summary: create or update an existing p-interface
9479       description: |
9480         Create or update an existing p-interface.
9481         #
9482         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9483       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9484       consumes:
9485         - application/json
9486         - application/xml
9487       produces:
9488         - application/json
9489         - application/xml
9490       responses:
9491         "default":
9492           description: Response codes found in [response codes](https://wiki.onap.org/).
9493       parameters:
9494         - name: hostname
9495           in: path
9496           description: Value from executing hostname on the compute node.
9497           required: true
9498           type: string
9499           example: __HOSTNAME__
9500         - name: interface-name
9501           in: path
9502           description: Name that identifies the physical interface
9503           required: true
9504           type: string
9505           example: __INTERFACE-NAME__
9506         - name: body
9507           in: body
9508           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9509           required: true
9510           schema:
9511             $ref: "#/definitions/p-interface"
9512     patch:
9513       tags:
9514         - CloudInfrastructure
9515       summary: update an existing p-interface
9516       description: |
9517         Update an existing p-interface
9518         #
9519         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9520         The PUT operation will entirely replace an existing object.
9521         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9522         #
9523         Other differences between PUT and PATCH are:
9524         #
9525         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9526         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9527         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9528       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9529       consumes:
9530         - application/json
9531         - application/xml
9532       produces:
9533         - application/json
9534         - application/xml
9535       responses:
9536         "default":
9537           description: Response codes found in [response codes](https://wiki.onap.org/).
9538       parameters:
9539         - name: hostname
9540           in: path
9541           description: Value from executing hostname on the compute node.
9542           required: true
9543           type: string
9544           example: __HOSTNAME__
9545         - name: interface-name
9546           in: path
9547           description: Name that identifies the physical interface
9548           required: true
9549           type: string
9550           example: __INTERFACE-NAME__
9551         - name: body
9552           in: body
9553           description: p-interface object that needs to be updated.
9554           required: true
9555           schema:
9556             $ref: "#/patchDefinitions/p-interface"
9557     delete:
9558       tags:
9559         - CloudInfrastructure
9560       summary: delete an existing p-interface
9561       description: delete an existing p-interface
9562       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
9563       consumes:
9564         - application/json
9565         - application/xml
9566       produces:
9567         - application/json
9568         - application/xml
9569       responses:
9570         "default":
9571           description: Response codes found in [response codes](https://wiki.onap.org/).
9572       parameters:
9573         - name: hostname
9574           in: path
9575           description: Value from executing hostname on the compute node.
9576           required: true
9577           type: string
9578           example: __HOSTNAME__
9579         - name: interface-name
9580           in: path
9581           description: Name that identifies the physical interface
9582           required: true
9583           type: string
9584           example: __INTERFACE-NAME__
9585         - name: resource-version
9586           in: query
9587           description: resource-version for concurrency
9588           required: true
9589           type: string
9590   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
9591     get:
9592       tags:
9593         - CloudInfrastructure
9594       summary: returns p-interfaces
9595       description: returns p-interfaces
9596       operationId: getCloudInfrastructurePserversPserverPInterfaces
9597       produces:
9598         - application/json
9599         - application/xml
9600       responses:
9601         "200":
9602           description: successful operation
9603           schema:
9604               $ref: "#/getDefinitions/p-interfaces"
9605         "default":
9606           description: Response codes found in [response codes](https://wiki.onap.org/).
9607       parameters:
9608         - name: hostname
9609           in: path
9610           description: Value from executing hostname on the compute node.
9611           required: true
9612           type: string
9613           example: __HOSTNAME__
9614         - name: interface-name
9615           in: query
9616           description:
9617           required: false
9618           type: string
9619   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9620     put:
9621       tags:
9622         - CloudInfrastructure
9623       summary: see node definition for valid relationships
9624       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9625       consumes:
9626         - application/json
9627         - application/xml
9628       produces:
9629         - application/json
9630         - application/xml
9631       responses:
9632         "default":
9633           description: Response codes found in [response codes](https://wiki.onap.org/).
9634       parameters:
9635         - name: hostname
9636           in: path
9637           description: Value from executing hostname on the compute node.
9638           required: true
9639           type: string
9640           example: __HOSTNAME__
9641         - name: interface-name
9642           in: path
9643           description: Name that identifies the link aggregate interface
9644           required: true
9645           type: string
9646           example: __INTERFACE-NAME__
9647         - name: body
9648           in: body
9649           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9650           required: true
9651           schema:
9652             $ref: "#/definitions/relationship"
9653     delete:
9654       tags:
9655         - CloudInfrastructure
9656       summary: delete an existing relationship
9657       description: delete an existing relationship
9658       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9659       consumes:
9660         - application/json
9661         - application/xml
9662       produces:
9663         - application/json
9664         - application/xml
9665       responses:
9666         "default":
9667           description: Response codes found in [response codes](https://wiki.onap.org/).
9668       parameters:
9669         - name: hostname
9670           in: path
9671           description: Value from executing hostname on the compute node.
9672           required: true
9673           type: string
9674           example: __HOSTNAME__
9675         - name: interface-name
9676           in: path
9677           description: Name that identifies the link aggregate interface
9678           required: true
9679           type: string
9680           example: __INTERFACE-NAME__
9681   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9682     put:
9683       tags:
9684         - CloudInfrastructure
9685       summary: see node definition for valid relationships
9686       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9687       consumes:
9688         - application/json
9689         - application/xml
9690       produces:
9691         - application/json
9692         - application/xml
9693       responses:
9694         "default":
9695           description: Response codes found in [response codes](https://wiki.onap.org/).
9696       parameters:
9697         - name: hostname
9698           in: path
9699           description: Value from executing hostname on the compute node.
9700           required: true
9701           type: string
9702           example: __HOSTNAME__
9703         - name: interface-name
9704           in: path
9705           description: Name that identifies the link aggregate interface
9706           required: true
9707           type: string
9708           example: __INTERFACE-NAME__
9709         - name: interface-name
9710           in: path
9711           description: Name given to the interface
9712           required: true
9713           type: string
9714           example: __INTERFACE-NAME__
9715         - name: vlan-interface
9716           in: path
9717           description: String that identifies the interface
9718           required: true
9719           type: string
9720           example: __VLAN-INTERFACE__
9721         - name: body
9722           in: body
9723           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9724           required: true
9725           schema:
9726             $ref: "#/definitions/relationship"
9727     delete:
9728       tags:
9729         - CloudInfrastructure
9730       summary: delete an existing relationship
9731       description: delete an existing relationship
9732       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9733       consumes:
9734         - application/json
9735         - application/xml
9736       produces:
9737         - application/json
9738         - application/xml
9739       responses:
9740         "default":
9741           description: Response codes found in [response codes](https://wiki.onap.org/).
9742       parameters:
9743         - name: hostname
9744           in: path
9745           description: Value from executing hostname on the compute node.
9746           required: true
9747           type: string
9748           example: __HOSTNAME__
9749         - name: interface-name
9750           in: path
9751           description: Name that identifies the link aggregate interface
9752           required: true
9753           type: string
9754           example: __INTERFACE-NAME__
9755         - name: interface-name
9756           in: path
9757           description: Name given to the interface
9758           required: true
9759           type: string
9760           example: __INTERFACE-NAME__
9761         - name: vlan-interface
9762           in: path
9763           description: String that identifies the interface
9764           required: true
9765           type: string
9766           example: __VLAN-INTERFACE__
9767   /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:
9768     put:
9769       tags:
9770         - CloudInfrastructure
9771       summary: see node definition for valid relationships
9772       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9773       consumes:
9774         - application/json
9775         - application/xml
9776       produces:
9777         - application/json
9778         - application/xml
9779       responses:
9780         "default":
9781           description: Response codes found in [response codes](https://wiki.onap.org/).
9782       parameters:
9783         - name: hostname
9784           in: path
9785           description: Value from executing hostname on the compute node.
9786           required: true
9787           type: string
9788           example: __HOSTNAME__
9789         - name: interface-name
9790           in: path
9791           description: Name that identifies the link aggregate interface
9792           required: true
9793           type: string
9794           example: __INTERFACE-NAME__
9795         - name: interface-name
9796           in: path
9797           description: Name given to the interface
9798           required: true
9799           type: string
9800           example: __INTERFACE-NAME__
9801         - name: vlan-interface
9802           in: path
9803           description: String that identifies the interface
9804           required: true
9805           type: string
9806           example: __VLAN-INTERFACE__
9807         - name: l3-interface-ipv4-address
9808           in: path
9809           description: IP address
9810           required: true
9811           type: string
9812           example: __L3-INTERFACE-IPV4-ADDRESS__
9813         - name: body
9814           in: body
9815           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9816           required: true
9817           schema:
9818             $ref: "#/definitions/relationship"
9819     delete:
9820       tags:
9821         - CloudInfrastructure
9822       summary: delete an existing relationship
9823       description: delete an existing relationship
9824       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9825       consumes:
9826         - application/json
9827         - application/xml
9828       produces:
9829         - application/json
9830         - application/xml
9831       responses:
9832         "default":
9833           description: Response codes found in [response codes](https://wiki.onap.org/).
9834       parameters:
9835         - name: hostname
9836           in: path
9837           description: Value from executing hostname on the compute node.
9838           required: true
9839           type: string
9840           example: __HOSTNAME__
9841         - name: interface-name
9842           in: path
9843           description: Name that identifies the link aggregate interface
9844           required: true
9845           type: string
9846           example: __INTERFACE-NAME__
9847         - name: interface-name
9848           in: path
9849           description: Name given to the interface
9850           required: true
9851           type: string
9852           example: __INTERFACE-NAME__
9853         - name: vlan-interface
9854           in: path
9855           description: String that identifies the interface
9856           required: true
9857           type: string
9858           example: __VLAN-INTERFACE__
9859         - name: l3-interface-ipv4-address
9860           in: path
9861           description: IP address
9862           required: true
9863           type: string
9864           example: __L3-INTERFACE-IPV4-ADDRESS__
9865   /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}:
9866     get:
9867       tags:
9868         - CloudInfrastructure
9869       summary: returns l3-interface-ipv4-address-list
9870       description: returns l3-interface-ipv4-address-list
9871       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9872       produces:
9873         - application/json
9874         - application/xml
9875       responses:
9876         "200":
9877           description: successful operation
9878           schema:
9879               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9880         "default":
9881           description: Response codes found in [response codes](https://wiki.onap.org/).
9882       parameters:
9883         - name: hostname
9884           in: path
9885           description: Value from executing hostname on the compute node.
9886           required: true
9887           type: string
9888           example: __HOSTNAME__
9889         - name: interface-name
9890           in: path
9891           description: Name that identifies the link aggregate interface
9892           required: true
9893           type: string
9894           example: __INTERFACE-NAME__
9895         - name: interface-name
9896           in: path
9897           description: Name given to the interface
9898           required: true
9899           type: string
9900           example: __INTERFACE-NAME__
9901         - name: vlan-interface
9902           in: path
9903           description: String that identifies the interface
9904           required: true
9905           type: string
9906           example: __VLAN-INTERFACE__
9907         - name: l3-interface-ipv4-address
9908           in: path
9909           description: IP address
9910           required: true
9911           type: string
9912           example: __L3-INTERFACE-IPV4-ADDRESS__
9913     put:
9914       tags:
9915         - CloudInfrastructure
9916       summary: create or update an existing l3-interface-ipv4-address-list
9917       description: |
9918         Create or update an existing l3-interface-ipv4-address-list.
9919         #
9920         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9921       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9922       consumes:
9923         - application/json
9924         - application/xml
9925       produces:
9926         - application/json
9927         - application/xml
9928       responses:
9929         "default":
9930           description: Response codes found in [response codes](https://wiki.onap.org/).
9931       parameters:
9932         - name: hostname
9933           in: path
9934           description: Value from executing hostname on the compute node.
9935           required: true
9936           type: string
9937           example: __HOSTNAME__
9938         - name: interface-name
9939           in: path
9940           description: Name that identifies the link aggregate interface
9941           required: true
9942           type: string
9943           example: __INTERFACE-NAME__
9944         - name: interface-name
9945           in: path
9946           description: Name given to the interface
9947           required: true
9948           type: string
9949           example: __INTERFACE-NAME__
9950         - name: vlan-interface
9951           in: path
9952           description: String that identifies the interface
9953           required: true
9954           type: string
9955           example: __VLAN-INTERFACE__
9956         - name: l3-interface-ipv4-address
9957           in: path
9958           description: IP address
9959           required: true
9960           type: string
9961           example: __L3-INTERFACE-IPV4-ADDRESS__
9962         - name: body
9963           in: body
9964           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9965           required: true
9966           schema:
9967             $ref: "#/definitions/l3-interface-ipv4-address-list"
9968     patch:
9969       tags:
9970         - CloudInfrastructure
9971       summary: update an existing l3-interface-ipv4-address-list
9972       description: |
9973         Update an existing l3-interface-ipv4-address-list
9974         #
9975         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9976         The PUT operation will entirely replace an existing object.
9977         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9978         #
9979         Other differences between PUT and PATCH are:
9980         #
9981         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9982         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9983         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9984       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9985       consumes:
9986         - application/json
9987         - application/xml
9988       produces:
9989         - application/json
9990         - application/xml
9991       responses:
9992         "default":
9993           description: Response codes found in [response codes](https://wiki.onap.org/).
9994       parameters:
9995         - name: hostname
9996           in: path
9997           description: Value from executing hostname on the compute node.
9998           required: true
9999           type: string
10000           example: __HOSTNAME__
10001         - name: interface-name
10002           in: path
10003           description: Name that identifies the link aggregate interface
10004           required: true
10005           type: string
10006           example: __INTERFACE-NAME__
10007         - name: interface-name
10008           in: path
10009           description: Name given to the interface
10010           required: true
10011           type: string
10012           example: __INTERFACE-NAME__
10013         - name: vlan-interface
10014           in: path
10015           description: String that identifies the interface
10016           required: true
10017           type: string
10018           example: __VLAN-INTERFACE__
10019         - name: l3-interface-ipv4-address
10020           in: path
10021           description: IP address
10022           required: true
10023           type: string
10024           example: __L3-INTERFACE-IPV4-ADDRESS__
10025         - name: body
10026           in: body
10027           description: l3-interface-ipv4-address-list object that needs to be updated.
10028           required: true
10029           schema:
10030             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10031     delete:
10032       tags:
10033         - CloudInfrastructure
10034       summary: delete an existing l3-interface-ipv4-address-list
10035       description: delete an existing l3-interface-ipv4-address-list
10036       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10037       consumes:
10038         - application/json
10039         - application/xml
10040       produces:
10041         - application/json
10042         - application/xml
10043       responses:
10044         "default":
10045           description: Response codes found in [response codes](https://wiki.onap.org/).
10046       parameters:
10047         - name: hostname
10048           in: path
10049           description: Value from executing hostname on the compute node.
10050           required: true
10051           type: string
10052           example: __HOSTNAME__
10053         - name: interface-name
10054           in: path
10055           description: Name that identifies the link aggregate interface
10056           required: true
10057           type: string
10058           example: __INTERFACE-NAME__
10059         - name: interface-name
10060           in: path
10061           description: Name given to the interface
10062           required: true
10063           type: string
10064           example: __INTERFACE-NAME__
10065         - name: vlan-interface
10066           in: path
10067           description: String that identifies the interface
10068           required: true
10069           type: string
10070           example: __VLAN-INTERFACE__
10071         - name: l3-interface-ipv4-address
10072           in: path
10073           description: IP address
10074           required: true
10075           type: string
10076           example: __L3-INTERFACE-IPV4-ADDRESS__
10077         - name: resource-version
10078           in: query
10079           description: resource-version for concurrency
10080           required: true
10081           type: string
10082   /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:
10083     put:
10084       tags:
10085         - CloudInfrastructure
10086       summary: see node definition for valid relationships
10087       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10088       consumes:
10089         - application/json
10090         - application/xml
10091       produces:
10092         - application/json
10093         - application/xml
10094       responses:
10095         "default":
10096           description: Response codes found in [response codes](https://wiki.onap.org/).
10097       parameters:
10098         - name: hostname
10099           in: path
10100           description: Value from executing hostname on the compute node.
10101           required: true
10102           type: string
10103           example: __HOSTNAME__
10104         - name: interface-name
10105           in: path
10106           description: Name that identifies the link aggregate interface
10107           required: true
10108           type: string
10109           example: __INTERFACE-NAME__
10110         - name: interface-name
10111           in: path
10112           description: Name given to the interface
10113           required: true
10114           type: string
10115           example: __INTERFACE-NAME__
10116         - name: vlan-interface
10117           in: path
10118           description: String that identifies the interface
10119           required: true
10120           type: string
10121           example: __VLAN-INTERFACE__
10122         - name: l3-interface-ipv6-address
10123           in: path
10124           description: IP address
10125           required: true
10126           type: string
10127           example: __L3-INTERFACE-IPV6-ADDRESS__
10128         - name: body
10129           in: body
10130           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10131           required: true
10132           schema:
10133             $ref: "#/definitions/relationship"
10134     delete:
10135       tags:
10136         - CloudInfrastructure
10137       summary: delete an existing relationship
10138       description: delete an existing relationship
10139       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10140       consumes:
10141         - application/json
10142         - application/xml
10143       produces:
10144         - application/json
10145         - application/xml
10146       responses:
10147         "default":
10148           description: Response codes found in [response codes](https://wiki.onap.org/).
10149       parameters:
10150         - name: hostname
10151           in: path
10152           description: Value from executing hostname on the compute node.
10153           required: true
10154           type: string
10155           example: __HOSTNAME__
10156         - name: interface-name
10157           in: path
10158           description: Name that identifies the link aggregate interface
10159           required: true
10160           type: string
10161           example: __INTERFACE-NAME__
10162         - name: interface-name
10163           in: path
10164           description: Name given to the interface
10165           required: true
10166           type: string
10167           example: __INTERFACE-NAME__
10168         - name: vlan-interface
10169           in: path
10170           description: String that identifies the interface
10171           required: true
10172           type: string
10173           example: __VLAN-INTERFACE__
10174         - name: l3-interface-ipv6-address
10175           in: path
10176           description: IP address
10177           required: true
10178           type: string
10179           example: __L3-INTERFACE-IPV6-ADDRESS__
10180   /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}:
10181     get:
10182       tags:
10183         - CloudInfrastructure
10184       summary: returns l3-interface-ipv6-address-list
10185       description: returns l3-interface-ipv6-address-list
10186       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10187       produces:
10188         - application/json
10189         - application/xml
10190       responses:
10191         "200":
10192           description: successful operation
10193           schema:
10194               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10195         "default":
10196           description: Response codes found in [response codes](https://wiki.onap.org/).
10197       parameters:
10198         - name: hostname
10199           in: path
10200           description: Value from executing hostname on the compute node.
10201           required: true
10202           type: string
10203           example: __HOSTNAME__
10204         - name: interface-name
10205           in: path
10206           description: Name that identifies the link aggregate interface
10207           required: true
10208           type: string
10209           example: __INTERFACE-NAME__
10210         - name: interface-name
10211           in: path
10212           description: Name given to the interface
10213           required: true
10214           type: string
10215           example: __INTERFACE-NAME__
10216         - name: vlan-interface
10217           in: path
10218           description: String that identifies the interface
10219           required: true
10220           type: string
10221           example: __VLAN-INTERFACE__
10222         - name: l3-interface-ipv6-address
10223           in: path
10224           description: IP address
10225           required: true
10226           type: string
10227           example: __L3-INTERFACE-IPV6-ADDRESS__
10228     put:
10229       tags:
10230         - CloudInfrastructure
10231       summary: create or update an existing l3-interface-ipv6-address-list
10232       description: |
10233         Create or update an existing l3-interface-ipv6-address-list.
10234         #
10235         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10236       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10237       consumes:
10238         - application/json
10239         - application/xml
10240       produces:
10241         - application/json
10242         - application/xml
10243       responses:
10244         "default":
10245           description: Response codes found in [response codes](https://wiki.onap.org/).
10246       parameters:
10247         - name: hostname
10248           in: path
10249           description: Value from executing hostname on the compute node.
10250           required: true
10251           type: string
10252           example: __HOSTNAME__
10253         - name: interface-name
10254           in: path
10255           description: Name that identifies the link aggregate interface
10256           required: true
10257           type: string
10258           example: __INTERFACE-NAME__
10259         - name: interface-name
10260           in: path
10261           description: Name given to the interface
10262           required: true
10263           type: string
10264           example: __INTERFACE-NAME__
10265         - name: vlan-interface
10266           in: path
10267           description: String that identifies the interface
10268           required: true
10269           type: string
10270           example: __VLAN-INTERFACE__
10271         - name: l3-interface-ipv6-address
10272           in: path
10273           description: IP address
10274           required: true
10275           type: string
10276           example: __L3-INTERFACE-IPV6-ADDRESS__
10277         - name: body
10278           in: body
10279           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10280           required: true
10281           schema:
10282             $ref: "#/definitions/l3-interface-ipv6-address-list"
10283     patch:
10284       tags:
10285         - CloudInfrastructure
10286       summary: update an existing l3-interface-ipv6-address-list
10287       description: |
10288         Update an existing l3-interface-ipv6-address-list
10289         #
10290         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10291         The PUT operation will entirely replace an existing object.
10292         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10293         #
10294         Other differences between PUT and PATCH are:
10295         #
10296         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10297         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10298         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10299       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10300       consumes:
10301         - application/json
10302         - application/xml
10303       produces:
10304         - application/json
10305         - application/xml
10306       responses:
10307         "default":
10308           description: Response codes found in [response codes](https://wiki.onap.org/).
10309       parameters:
10310         - name: hostname
10311           in: path
10312           description: Value from executing hostname on the compute node.
10313           required: true
10314           type: string
10315           example: __HOSTNAME__
10316         - name: interface-name
10317           in: path
10318           description: Name that identifies the link aggregate interface
10319           required: true
10320           type: string
10321           example: __INTERFACE-NAME__
10322         - name: interface-name
10323           in: path
10324           description: Name given to the interface
10325           required: true
10326           type: string
10327           example: __INTERFACE-NAME__
10328         - name: vlan-interface
10329           in: path
10330           description: String that identifies the interface
10331           required: true
10332           type: string
10333           example: __VLAN-INTERFACE__
10334         - name: l3-interface-ipv6-address
10335           in: path
10336           description: IP address
10337           required: true
10338           type: string
10339           example: __L3-INTERFACE-IPV6-ADDRESS__
10340         - name: body
10341           in: body
10342           description: l3-interface-ipv6-address-list object that needs to be updated.
10343           required: true
10344           schema:
10345             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10346     delete:
10347       tags:
10348         - CloudInfrastructure
10349       summary: delete an existing l3-interface-ipv6-address-list
10350       description: delete an existing l3-interface-ipv6-address-list
10351       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10352       consumes:
10353         - application/json
10354         - application/xml
10355       produces:
10356         - application/json
10357         - application/xml
10358       responses:
10359         "default":
10360           description: Response codes found in [response codes](https://wiki.onap.org/).
10361       parameters:
10362         - name: hostname
10363           in: path
10364           description: Value from executing hostname on the compute node.
10365           required: true
10366           type: string
10367           example: __HOSTNAME__
10368         - name: interface-name
10369           in: path
10370           description: Name that identifies the link aggregate interface
10371           required: true
10372           type: string
10373           example: __INTERFACE-NAME__
10374         - name: interface-name
10375           in: path
10376           description: Name given to the interface
10377           required: true
10378           type: string
10379           example: __INTERFACE-NAME__
10380         - name: vlan-interface
10381           in: path
10382           description: String that identifies the interface
10383           required: true
10384           type: string
10385           example: __VLAN-INTERFACE__
10386         - name: l3-interface-ipv6-address
10387           in: path
10388           description: IP address
10389           required: true
10390           type: string
10391           example: __L3-INTERFACE-IPV6-ADDRESS__
10392         - name: resource-version
10393           in: query
10394           description: resource-version for concurrency
10395           required: true
10396           type: string
10397   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10398     get:
10399       tags:
10400         - CloudInfrastructure
10401       summary: returns vlan
10402       description: returns vlan
10403       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10404       produces:
10405         - application/json
10406         - application/xml
10407       responses:
10408         "200":
10409           description: successful operation
10410           schema:
10411               $ref: "#/getDefinitions/vlan"
10412         "default":
10413           description: Response codes found in [response codes](https://wiki.onap.org/).
10414       parameters:
10415         - name: hostname
10416           in: path
10417           description: Value from executing hostname on the compute node.
10418           required: true
10419           type: string
10420           example: __HOSTNAME__
10421         - name: interface-name
10422           in: path
10423           description: Name that identifies the link aggregate interface
10424           required: true
10425           type: string
10426           example: __INTERFACE-NAME__
10427         - name: interface-name
10428           in: path
10429           description: Name given to the interface
10430           required: true
10431           type: string
10432           example: __INTERFACE-NAME__
10433         - name: vlan-interface
10434           in: path
10435           description: String that identifies the interface
10436           required: true
10437           type: string
10438           example: __VLAN-INTERFACE__
10439     put:
10440       tags:
10441         - CloudInfrastructure
10442       summary: create or update an existing vlan
10443       description: |
10444         Create or update an existing vlan.
10445         #
10446         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10447       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10448       consumes:
10449         - application/json
10450         - application/xml
10451       produces:
10452         - application/json
10453         - application/xml
10454       responses:
10455         "default":
10456           description: Response codes found in [response codes](https://wiki.onap.org/).
10457       parameters:
10458         - name: hostname
10459           in: path
10460           description: Value from executing hostname on the compute node.
10461           required: true
10462           type: string
10463           example: __HOSTNAME__
10464         - name: interface-name
10465           in: path
10466           description: Name that identifies the link aggregate interface
10467           required: true
10468           type: string
10469           example: __INTERFACE-NAME__
10470         - name: interface-name
10471           in: path
10472           description: Name given to the interface
10473           required: true
10474           type: string
10475           example: __INTERFACE-NAME__
10476         - name: vlan-interface
10477           in: path
10478           description: String that identifies the interface
10479           required: true
10480           type: string
10481           example: __VLAN-INTERFACE__
10482         - name: body
10483           in: body
10484           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10485           required: true
10486           schema:
10487             $ref: "#/definitions/vlan"
10488     patch:
10489       tags:
10490         - CloudInfrastructure
10491       summary: update an existing vlan
10492       description: |
10493         Update an existing vlan
10494         #
10495         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10496         The PUT operation will entirely replace an existing object.
10497         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10498         #
10499         Other differences between PUT and PATCH are:
10500         #
10501         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10502         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10503         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10504       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10505       consumes:
10506         - application/json
10507         - application/xml
10508       produces:
10509         - application/json
10510         - application/xml
10511       responses:
10512         "default":
10513           description: Response codes found in [response codes](https://wiki.onap.org/).
10514       parameters:
10515         - name: hostname
10516           in: path
10517           description: Value from executing hostname on the compute node.
10518           required: true
10519           type: string
10520           example: __HOSTNAME__
10521         - name: interface-name
10522           in: path
10523           description: Name that identifies the link aggregate interface
10524           required: true
10525           type: string
10526           example: __INTERFACE-NAME__
10527         - name: interface-name
10528           in: path
10529           description: Name given to the interface
10530           required: true
10531           type: string
10532           example: __INTERFACE-NAME__
10533         - name: vlan-interface
10534           in: path
10535           description: String that identifies the interface
10536           required: true
10537           type: string
10538           example: __VLAN-INTERFACE__
10539         - name: body
10540           in: body
10541           description: vlan object that needs to be updated.
10542           required: true
10543           schema:
10544             $ref: "#/patchDefinitions/vlan"
10545     delete:
10546       tags:
10547         - CloudInfrastructure
10548       summary: delete an existing vlan
10549       description: delete an existing vlan
10550       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10551       consumes:
10552         - application/json
10553         - application/xml
10554       produces:
10555         - application/json
10556         - application/xml
10557       responses:
10558         "default":
10559           description: Response codes found in [response codes](https://wiki.onap.org/).
10560       parameters:
10561         - name: hostname
10562           in: path
10563           description: Value from executing hostname on the compute node.
10564           required: true
10565           type: string
10566           example: __HOSTNAME__
10567         - name: interface-name
10568           in: path
10569           description: Name that identifies the link aggregate interface
10570           required: true
10571           type: string
10572           example: __INTERFACE-NAME__
10573         - name: interface-name
10574           in: path
10575           description: Name given to the interface
10576           required: true
10577           type: string
10578           example: __INTERFACE-NAME__
10579         - name: vlan-interface
10580           in: path
10581           description: String that identifies the interface
10582           required: true
10583           type: string
10584           example: __VLAN-INTERFACE__
10585         - name: resource-version
10586           in: query
10587           description: resource-version for concurrency
10588           required: true
10589           type: string
10590   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10591     get:
10592       tags:
10593         - CloudInfrastructure
10594       summary: returns vlans
10595       description: returns vlans
10596       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10597       produces:
10598         - application/json
10599         - application/xml
10600       responses:
10601         "200":
10602           description: successful operation
10603           schema:
10604               $ref: "#/getDefinitions/vlans"
10605         "default":
10606           description: Response codes found in [response codes](https://wiki.onap.org/).
10607       parameters:
10608         - name: hostname
10609           in: path
10610           description: Value from executing hostname on the compute node.
10611           required: true
10612           type: string
10613           example: __HOSTNAME__
10614         - name: interface-name
10615           in: path
10616           description: Name that identifies the link aggregate interface
10617           required: true
10618           type: string
10619           example: __INTERFACE-NAME__
10620         - name: interface-name
10621           in: path
10622           description: Name given to the interface
10623           required: true
10624           type: string
10625           example: __INTERFACE-NAME__
10626         - name: vlan-interface
10627           in: query
10628           description:
10629           required: false
10630           type: string
10631         - name: vlan-id-inner
10632           in: query
10633           description:
10634           required: false
10635           type: integer
10636           format: int64
10637         - name: vpn-id
10638           in: query
10639           description:
10640           required: false
10641           type: string
10642   /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:
10643     put:
10644       tags:
10645         - CloudInfrastructure
10646       summary: see node definition for valid relationships
10647       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10648       consumes:
10649         - application/json
10650         - application/xml
10651       produces:
10652         - application/json
10653         - application/xml
10654       responses:
10655         "default":
10656           description: Response codes found in [response codes](https://wiki.onap.org/).
10657       parameters:
10658         - name: hostname
10659           in: path
10660           description: Value from executing hostname on the compute node.
10661           required: true
10662           type: string
10663           example: __HOSTNAME__
10664         - name: interface-name
10665           in: path
10666           description: Name that identifies the link aggregate interface
10667           required: true
10668           type: string
10669           example: __INTERFACE-NAME__
10670         - name: interface-name
10671           in: path
10672           description: Name given to the interface
10673           required: true
10674           type: string
10675           example: __INTERFACE-NAME__
10676         - name: pci-id
10677           in: path
10678           description: PCI ID used to identify the sriov-vf
10679           required: true
10680           type: string
10681           example: __PCI-ID__
10682         - name: body
10683           in: body
10684           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10685           required: true
10686           schema:
10687             $ref: "#/definitions/relationship"
10688     delete:
10689       tags:
10690         - CloudInfrastructure
10691       summary: delete an existing relationship
10692       description: delete an existing relationship
10693       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10694       consumes:
10695         - application/json
10696         - application/xml
10697       produces:
10698         - application/json
10699         - application/xml
10700       responses:
10701         "default":
10702           description: Response codes found in [response codes](https://wiki.onap.org/).
10703       parameters:
10704         - name: hostname
10705           in: path
10706           description: Value from executing hostname on the compute node.
10707           required: true
10708           type: string
10709           example: __HOSTNAME__
10710         - name: interface-name
10711           in: path
10712           description: Name that identifies the link aggregate interface
10713           required: true
10714           type: string
10715           example: __INTERFACE-NAME__
10716         - name: interface-name
10717           in: path
10718           description: Name given to the interface
10719           required: true
10720           type: string
10721           example: __INTERFACE-NAME__
10722         - name: pci-id
10723           in: path
10724           description: PCI ID used to identify the sriov-vf
10725           required: true
10726           type: string
10727           example: __PCI-ID__
10728   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10729     get:
10730       tags:
10731         - CloudInfrastructure
10732       summary: returns sriov-vf
10733       description: returns sriov-vf
10734       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10735       produces:
10736         - application/json
10737         - application/xml
10738       responses:
10739         "200":
10740           description: successful operation
10741           schema:
10742               $ref: "#/getDefinitions/sriov-vf"
10743         "default":
10744           description: Response codes found in [response codes](https://wiki.onap.org/).
10745       parameters:
10746         - name: hostname
10747           in: path
10748           description: Value from executing hostname on the compute node.
10749           required: true
10750           type: string
10751           example: __HOSTNAME__
10752         - name: interface-name
10753           in: path
10754           description: Name that identifies the link aggregate interface
10755           required: true
10756           type: string
10757           example: __INTERFACE-NAME__
10758         - name: interface-name
10759           in: path
10760           description: Name given to the interface
10761           required: true
10762           type: string
10763           example: __INTERFACE-NAME__
10764         - name: pci-id
10765           in: path
10766           description: PCI ID used to identify the sriov-vf
10767           required: true
10768           type: string
10769           example: __PCI-ID__
10770     put:
10771       tags:
10772         - CloudInfrastructure
10773       summary: create or update an existing sriov-vf
10774       description: |
10775         Create or update an existing sriov-vf.
10776         #
10777         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10778       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10779       consumes:
10780         - application/json
10781         - application/xml
10782       produces:
10783         - application/json
10784         - application/xml
10785       responses:
10786         "default":
10787           description: Response codes found in [response codes](https://wiki.onap.org/).
10788       parameters:
10789         - name: hostname
10790           in: path
10791           description: Value from executing hostname on the compute node.
10792           required: true
10793           type: string
10794           example: __HOSTNAME__
10795         - name: interface-name
10796           in: path
10797           description: Name that identifies the link aggregate interface
10798           required: true
10799           type: string
10800           example: __INTERFACE-NAME__
10801         - name: interface-name
10802           in: path
10803           description: Name given to the interface
10804           required: true
10805           type: string
10806           example: __INTERFACE-NAME__
10807         - name: pci-id
10808           in: path
10809           description: PCI ID used to identify the sriov-vf
10810           required: true
10811           type: string
10812           example: __PCI-ID__
10813         - name: body
10814           in: body
10815           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10816           required: true
10817           schema:
10818             $ref: "#/definitions/sriov-vf"
10819     patch:
10820       tags:
10821         - CloudInfrastructure
10822       summary: update an existing sriov-vf
10823       description: |
10824         Update an existing sriov-vf
10825         #
10826         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10827         The PUT operation will entirely replace an existing object.
10828         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10829         #
10830         Other differences between PUT and PATCH are:
10831         #
10832         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10833         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10834         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10835       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10836       consumes:
10837         - application/json
10838         - application/xml
10839       produces:
10840         - application/json
10841         - application/xml
10842       responses:
10843         "default":
10844           description: Response codes found in [response codes](https://wiki.onap.org/).
10845       parameters:
10846         - name: hostname
10847           in: path
10848           description: Value from executing hostname on the compute node.
10849           required: true
10850           type: string
10851           example: __HOSTNAME__
10852         - name: interface-name
10853           in: path
10854           description: Name that identifies the link aggregate interface
10855           required: true
10856           type: string
10857           example: __INTERFACE-NAME__
10858         - name: interface-name
10859           in: path
10860           description: Name given to the interface
10861           required: true
10862           type: string
10863           example: __INTERFACE-NAME__
10864         - name: pci-id
10865           in: path
10866           description: PCI ID used to identify the sriov-vf
10867           required: true
10868           type: string
10869           example: __PCI-ID__
10870         - name: body
10871           in: body
10872           description: sriov-vf object that needs to be updated.
10873           required: true
10874           schema:
10875             $ref: "#/patchDefinitions/sriov-vf"
10876     delete:
10877       tags:
10878         - CloudInfrastructure
10879       summary: delete an existing sriov-vf
10880       description: delete an existing sriov-vf
10881       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10882       consumes:
10883         - application/json
10884         - application/xml
10885       produces:
10886         - application/json
10887         - application/xml
10888       responses:
10889         "default":
10890           description: Response codes found in [response codes](https://wiki.onap.org/).
10891       parameters:
10892         - name: hostname
10893           in: path
10894           description: Value from executing hostname on the compute node.
10895           required: true
10896           type: string
10897           example: __HOSTNAME__
10898         - name: interface-name
10899           in: path
10900           description: Name that identifies the link aggregate interface
10901           required: true
10902           type: string
10903           example: __INTERFACE-NAME__
10904         - name: interface-name
10905           in: path
10906           description: Name given to the interface
10907           required: true
10908           type: string
10909           example: __INTERFACE-NAME__
10910         - name: pci-id
10911           in: path
10912           description: PCI ID used to identify the sriov-vf
10913           required: true
10914           type: string
10915           example: __PCI-ID__
10916         - name: resource-version
10917           in: query
10918           description: resource-version for concurrency
10919           required: true
10920           type: string
10921   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10922     get:
10923       tags:
10924         - CloudInfrastructure
10925       summary: returns sriov-vfs
10926       description: returns sriov-vfs
10927       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10928       produces:
10929         - application/json
10930         - application/xml
10931       responses:
10932         "200":
10933           description: successful operation
10934           schema:
10935               $ref: "#/getDefinitions/sriov-vfs"
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 link aggregate 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: pci-id
10958           in: query
10959           description:
10960           required: false
10961           type: string
10962         - name: vf-vlan-filter
10963           in: query
10964           description:
10965           required: false
10966           type: string
10967         - name: vf-mac-filter
10968           in: query
10969           description:
10970           required: false
10971           type: string
10972         - name: vf-vlan-strip
10973           in: query
10974           description:
10975           required: false
10976           type: boolean
10977         - name: neutron-network-id
10978           in: query
10979           description:
10980           required: false
10981           type: string
10982   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10983     put:
10984       tags:
10985         - CloudInfrastructure
10986       summary: see node definition for valid relationships
10987       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
10988       consumes:
10989         - application/json
10990         - application/xml
10991       produces:
10992         - application/json
10993         - application/xml
10994       responses:
10995         "default":
10996           description: Response codes found in [response codes](https://wiki.onap.org/).
10997       parameters:
10998         - name: hostname
10999           in: path
11000           description: Value from executing hostname on the compute node.
11001           required: true
11002           type: string
11003           example: __HOSTNAME__
11004         - name: interface-name
11005           in: path
11006           description: Name that identifies the link aggregate interface
11007           required: true
11008           type: string
11009           example: __INTERFACE-NAME__
11010         - name: interface-name
11011           in: path
11012           description: Name given to the interface
11013           required: true
11014           type: string
11015           example: __INTERFACE-NAME__
11016         - name: body
11017           in: body
11018           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11019           required: true
11020           schema:
11021             $ref: "#/definitions/relationship"
11022     delete:
11023       tags:
11024         - CloudInfrastructure
11025       summary: delete an existing relationship
11026       description: delete an existing relationship
11027       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11028       consumes:
11029         - application/json
11030         - application/xml
11031       produces:
11032         - application/json
11033         - application/xml
11034       responses:
11035         "default":
11036           description: Response codes found in [response codes](https://wiki.onap.org/).
11037       parameters:
11038         - name: hostname
11039           in: path
11040           description: Value from executing hostname on the compute node.
11041           required: true
11042           type: string
11043           example: __HOSTNAME__
11044         - name: interface-name
11045           in: path
11046           description: Name that identifies the link aggregate interface
11047           required: true
11048           type: string
11049           example: __INTERFACE-NAME__
11050         - name: interface-name
11051           in: path
11052           description: Name given to the interface
11053           required: true
11054           type: string
11055           example: __INTERFACE-NAME__
11056   /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:
11057     put:
11058       tags:
11059         - CloudInfrastructure
11060       summary: see node definition for valid relationships
11061       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11062       consumes:
11063         - application/json
11064         - application/xml
11065       produces:
11066         - application/json
11067         - application/xml
11068       responses:
11069         "default":
11070           description: Response codes found in [response codes](https://wiki.onap.org/).
11071       parameters:
11072         - name: hostname
11073           in: path
11074           description: Value from executing hostname on the compute node.
11075           required: true
11076           type: string
11077           example: __HOSTNAME__
11078         - name: interface-name
11079           in: path
11080           description: Name that identifies the link aggregate interface
11081           required: true
11082           type: string
11083           example: __INTERFACE-NAME__
11084         - name: interface-name
11085           in: path
11086           description: Name given to the interface
11087           required: true
11088           type: string
11089           example: __INTERFACE-NAME__
11090         - name: l3-interface-ipv4-address
11091           in: path
11092           description: IP address
11093           required: true
11094           type: string
11095           example: __L3-INTERFACE-IPV4-ADDRESS__
11096         - name: body
11097           in: body
11098           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11099           required: true
11100           schema:
11101             $ref: "#/definitions/relationship"
11102     delete:
11103       tags:
11104         - CloudInfrastructure
11105       summary: delete an existing relationship
11106       description: delete an existing relationship
11107       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11108       consumes:
11109         - application/json
11110         - application/xml
11111       produces:
11112         - application/json
11113         - application/xml
11114       responses:
11115         "default":
11116           description: Response codes found in [response codes](https://wiki.onap.org/).
11117       parameters:
11118         - name: hostname
11119           in: path
11120           description: Value from executing hostname on the compute node.
11121           required: true
11122           type: string
11123           example: __HOSTNAME__
11124         - name: interface-name
11125           in: path
11126           description: Name that identifies the link aggregate interface
11127           required: true
11128           type: string
11129           example: __INTERFACE-NAME__
11130         - name: interface-name
11131           in: path
11132           description: Name given to the interface
11133           required: true
11134           type: string
11135           example: __INTERFACE-NAME__
11136         - name: l3-interface-ipv4-address
11137           in: path
11138           description: IP address
11139           required: true
11140           type: string
11141           example: __L3-INTERFACE-IPV4-ADDRESS__
11142   /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}:
11143     get:
11144       tags:
11145         - CloudInfrastructure
11146       summary: returns l3-interface-ipv4-address-list
11147       description: returns l3-interface-ipv4-address-list
11148       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11149       produces:
11150         - application/json
11151         - application/xml
11152       responses:
11153         "200":
11154           description: successful operation
11155           schema:
11156               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11157         "default":
11158           description: Response codes found in [response codes](https://wiki.onap.org/).
11159       parameters:
11160         - name: hostname
11161           in: path
11162           description: Value from executing hostname on the compute node.
11163           required: true
11164           type: string
11165           example: __HOSTNAME__
11166         - name: interface-name
11167           in: path
11168           description: Name that identifies the link aggregate interface
11169           required: true
11170           type: string
11171           example: __INTERFACE-NAME__
11172         - name: interface-name
11173           in: path
11174           description: Name given to the interface
11175           required: true
11176           type: string
11177           example: __INTERFACE-NAME__
11178         - name: l3-interface-ipv4-address
11179           in: path
11180           description: IP address
11181           required: true
11182           type: string
11183           example: __L3-INTERFACE-IPV4-ADDRESS__
11184     put:
11185       tags:
11186         - CloudInfrastructure
11187       summary: create or update an existing l3-interface-ipv4-address-list
11188       description: |
11189         Create or update an existing l3-interface-ipv4-address-list.
11190         #
11191         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11192       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11193       consumes:
11194         - application/json
11195         - application/xml
11196       produces:
11197         - application/json
11198         - application/xml
11199       responses:
11200         "default":
11201           description: Response codes found in [response codes](https://wiki.onap.org/).
11202       parameters:
11203         - name: hostname
11204           in: path
11205           description: Value from executing hostname on the compute node.
11206           required: true
11207           type: string
11208           example: __HOSTNAME__
11209         - name: interface-name
11210           in: path
11211           description: Name that identifies the link aggregate interface
11212           required: true
11213           type: string
11214           example: __INTERFACE-NAME__
11215         - name: interface-name
11216           in: path
11217           description: Name given to the interface
11218           required: true
11219           type: string
11220           example: __INTERFACE-NAME__
11221         - name: l3-interface-ipv4-address
11222           in: path
11223           description: IP address
11224           required: true
11225           type: string
11226           example: __L3-INTERFACE-IPV4-ADDRESS__
11227         - name: body
11228           in: body
11229           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11230           required: true
11231           schema:
11232             $ref: "#/definitions/l3-interface-ipv4-address-list"
11233     patch:
11234       tags:
11235         - CloudInfrastructure
11236       summary: update an existing l3-interface-ipv4-address-list
11237       description: |
11238         Update an existing l3-interface-ipv4-address-list
11239         #
11240         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11241         The PUT operation will entirely replace an existing object.
11242         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11243         #
11244         Other differences between PUT and PATCH are:
11245         #
11246         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11247         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11248         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11249       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11250       consumes:
11251         - application/json
11252         - application/xml
11253       produces:
11254         - application/json
11255         - application/xml
11256       responses:
11257         "default":
11258           description: Response codes found in [response codes](https://wiki.onap.org/).
11259       parameters:
11260         - name: hostname
11261           in: path
11262           description: Value from executing hostname on the compute node.
11263           required: true
11264           type: string
11265           example: __HOSTNAME__
11266         - name: interface-name
11267           in: path
11268           description: Name that identifies the link aggregate interface
11269           required: true
11270           type: string
11271           example: __INTERFACE-NAME__
11272         - name: interface-name
11273           in: path
11274           description: Name given to the interface
11275           required: true
11276           type: string
11277           example: __INTERFACE-NAME__
11278         - name: l3-interface-ipv4-address
11279           in: path
11280           description: IP address
11281           required: true
11282           type: string
11283           example: __L3-INTERFACE-IPV4-ADDRESS__
11284         - name: body
11285           in: body
11286           description: l3-interface-ipv4-address-list object that needs to be updated.
11287           required: true
11288           schema:
11289             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11290     delete:
11291       tags:
11292         - CloudInfrastructure
11293       summary: delete an existing l3-interface-ipv4-address-list
11294       description: delete an existing l3-interface-ipv4-address-list
11295       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11296       consumes:
11297         - application/json
11298         - application/xml
11299       produces:
11300         - application/json
11301         - application/xml
11302       responses:
11303         "default":
11304           description: Response codes found in [response codes](https://wiki.onap.org/).
11305       parameters:
11306         - name: hostname
11307           in: path
11308           description: Value from executing hostname on the compute node.
11309           required: true
11310           type: string
11311           example: __HOSTNAME__
11312         - name: interface-name
11313           in: path
11314           description: Name that identifies the link aggregate interface
11315           required: true
11316           type: string
11317           example: __INTERFACE-NAME__
11318         - name: interface-name
11319           in: path
11320           description: Name given to the interface
11321           required: true
11322           type: string
11323           example: __INTERFACE-NAME__
11324         - name: l3-interface-ipv4-address
11325           in: path
11326           description: IP address
11327           required: true
11328           type: string
11329           example: __L3-INTERFACE-IPV4-ADDRESS__
11330         - name: resource-version
11331           in: query
11332           description: resource-version for concurrency
11333           required: true
11334           type: string
11335   /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:
11336     put:
11337       tags:
11338         - CloudInfrastructure
11339       summary: see node definition for valid relationships
11340       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11341       consumes:
11342         - application/json
11343         - application/xml
11344       produces:
11345         - application/json
11346         - application/xml
11347       responses:
11348         "default":
11349           description: Response codes found in [response codes](https://wiki.onap.org/).
11350       parameters:
11351         - name: hostname
11352           in: path
11353           description: Value from executing hostname on the compute node.
11354           required: true
11355           type: string
11356           example: __HOSTNAME__
11357         - name: interface-name
11358           in: path
11359           description: Name that identifies the link aggregate interface
11360           required: true
11361           type: string
11362           example: __INTERFACE-NAME__
11363         - name: interface-name
11364           in: path
11365           description: Name given to the interface
11366           required: true
11367           type: string
11368           example: __INTERFACE-NAME__
11369         - name: l3-interface-ipv6-address
11370           in: path
11371           description: IP address
11372           required: true
11373           type: string
11374           example: __L3-INTERFACE-IPV6-ADDRESS__
11375         - name: body
11376           in: body
11377           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11378           required: true
11379           schema:
11380             $ref: "#/definitions/relationship"
11381     delete:
11382       tags:
11383         - CloudInfrastructure
11384       summary: delete an existing relationship
11385       description: delete an existing relationship
11386       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11387       consumes:
11388         - application/json
11389         - application/xml
11390       produces:
11391         - application/json
11392         - application/xml
11393       responses:
11394         "default":
11395           description: Response codes found in [response codes](https://wiki.onap.org/).
11396       parameters:
11397         - name: hostname
11398           in: path
11399           description: Value from executing hostname on the compute node.
11400           required: true
11401           type: string
11402           example: __HOSTNAME__
11403         - name: interface-name
11404           in: path
11405           description: Name that identifies the link aggregate interface
11406           required: true
11407           type: string
11408           example: __INTERFACE-NAME__
11409         - name: interface-name
11410           in: path
11411           description: Name given to the interface
11412           required: true
11413           type: string
11414           example: __INTERFACE-NAME__
11415         - name: l3-interface-ipv6-address
11416           in: path
11417           description: IP address
11418           required: true
11419           type: string
11420           example: __L3-INTERFACE-IPV6-ADDRESS__
11421   /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}:
11422     get:
11423       tags:
11424         - CloudInfrastructure
11425       summary: returns l3-interface-ipv6-address-list
11426       description: returns l3-interface-ipv6-address-list
11427       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11428       produces:
11429         - application/json
11430         - application/xml
11431       responses:
11432         "200":
11433           description: successful operation
11434           schema:
11435               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11436         "default":
11437           description: Response codes found in [response codes](https://wiki.onap.org/).
11438       parameters:
11439         - name: hostname
11440           in: path
11441           description: Value from executing hostname on the compute node.
11442           required: true
11443           type: string
11444           example: __HOSTNAME__
11445         - name: interface-name
11446           in: path
11447           description: Name that identifies the link aggregate interface
11448           required: true
11449           type: string
11450           example: __INTERFACE-NAME__
11451         - name: interface-name
11452           in: path
11453           description: Name given to the interface
11454           required: true
11455           type: string
11456           example: __INTERFACE-NAME__
11457         - name: l3-interface-ipv6-address
11458           in: path
11459           description: IP address
11460           required: true
11461           type: string
11462           example: __L3-INTERFACE-IPV6-ADDRESS__
11463     put:
11464       tags:
11465         - CloudInfrastructure
11466       summary: create or update an existing l3-interface-ipv6-address-list
11467       description: |
11468         Create or update an existing l3-interface-ipv6-address-list.
11469         #
11470         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11471       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11472       consumes:
11473         - application/json
11474         - application/xml
11475       produces:
11476         - application/json
11477         - application/xml
11478       responses:
11479         "default":
11480           description: Response codes found in [response codes](https://wiki.onap.org/).
11481       parameters:
11482         - name: hostname
11483           in: path
11484           description: Value from executing hostname on the compute node.
11485           required: true
11486           type: string
11487           example: __HOSTNAME__
11488         - name: interface-name
11489           in: path
11490           description: Name that identifies the link aggregate interface
11491           required: true
11492           type: string
11493           example: __INTERFACE-NAME__
11494         - name: interface-name
11495           in: path
11496           description: Name given to the interface
11497           required: true
11498           type: string
11499           example: __INTERFACE-NAME__
11500         - name: l3-interface-ipv6-address
11501           in: path
11502           description: IP address
11503           required: true
11504           type: string
11505           example: __L3-INTERFACE-IPV6-ADDRESS__
11506         - name: body
11507           in: body
11508           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11509           required: true
11510           schema:
11511             $ref: "#/definitions/l3-interface-ipv6-address-list"
11512     patch:
11513       tags:
11514         - CloudInfrastructure
11515       summary: update an existing l3-interface-ipv6-address-list
11516       description: |
11517         Update an existing l3-interface-ipv6-address-list
11518         #
11519         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11520         The PUT operation will entirely replace an existing object.
11521         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11522         #
11523         Other differences between PUT and PATCH are:
11524         #
11525         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11526         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11527         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11528       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11529       consumes:
11530         - application/json
11531         - application/xml
11532       produces:
11533         - application/json
11534         - application/xml
11535       responses:
11536         "default":
11537           description: Response codes found in [response codes](https://wiki.onap.org/).
11538       parameters:
11539         - name: hostname
11540           in: path
11541           description: Value from executing hostname on the compute node.
11542           required: true
11543           type: string
11544           example: __HOSTNAME__
11545         - name: interface-name
11546           in: path
11547           description: Name that identifies the link aggregate interface
11548           required: true
11549           type: string
11550           example: __INTERFACE-NAME__
11551         - name: interface-name
11552           in: path
11553           description: Name given to the interface
11554           required: true
11555           type: string
11556           example: __INTERFACE-NAME__
11557         - name: l3-interface-ipv6-address
11558           in: path
11559           description: IP address
11560           required: true
11561           type: string
11562           example: __L3-INTERFACE-IPV6-ADDRESS__
11563         - name: body
11564           in: body
11565           description: l3-interface-ipv6-address-list object that needs to be updated.
11566           required: true
11567           schema:
11568             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11569     delete:
11570       tags:
11571         - CloudInfrastructure
11572       summary: delete an existing l3-interface-ipv6-address-list
11573       description: delete an existing l3-interface-ipv6-address-list
11574       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11575       consumes:
11576         - application/json
11577         - application/xml
11578       produces:
11579         - application/json
11580         - application/xml
11581       responses:
11582         "default":
11583           description: Response codes found in [response codes](https://wiki.onap.org/).
11584       parameters:
11585         - name: hostname
11586           in: path
11587           description: Value from executing hostname on the compute node.
11588           required: true
11589           type: string
11590           example: __HOSTNAME__
11591         - name: interface-name
11592           in: path
11593           description: Name that identifies the link aggregate interface
11594           required: true
11595           type: string
11596           example: __INTERFACE-NAME__
11597         - name: interface-name
11598           in: path
11599           description: Name given to the interface
11600           required: true
11601           type: string
11602           example: __INTERFACE-NAME__
11603         - name: l3-interface-ipv6-address
11604           in: path
11605           description: IP address
11606           required: true
11607           type: string
11608           example: __L3-INTERFACE-IPV6-ADDRESS__
11609         - name: resource-version
11610           in: query
11611           description: resource-version for concurrency
11612           required: true
11613           type: string
11614   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11615     get:
11616       tags:
11617         - CloudInfrastructure
11618       summary: returns l-interface
11619       description: returns l-interface
11620       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11621       produces:
11622         - application/json
11623         - application/xml
11624       responses:
11625         "200":
11626           description: successful operation
11627           schema:
11628               $ref: "#/getDefinitions/l-interface"
11629         "default":
11630           description: Response codes found in [response codes](https://wiki.onap.org/).
11631       parameters:
11632         - name: hostname
11633           in: path
11634           description: Value from executing hostname on the compute node.
11635           required: true
11636           type: string
11637           example: __HOSTNAME__
11638         - name: interface-name
11639           in: path
11640           description: Name that identifies the link aggregate interface
11641           required: true
11642           type: string
11643           example: __INTERFACE-NAME__
11644         - name: interface-name
11645           in: path
11646           description: Name given to the interface
11647           required: true
11648           type: string
11649           example: __INTERFACE-NAME__
11650     put:
11651       tags:
11652         - CloudInfrastructure
11653       summary: create or update an existing l-interface
11654       description: |
11655         Create or update an existing l-interface.
11656         #
11657         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11658       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11659       consumes:
11660         - application/json
11661         - application/xml
11662       produces:
11663         - application/json
11664         - application/xml
11665       responses:
11666         "default":
11667           description: Response codes found in [response codes](https://wiki.onap.org/).
11668       parameters:
11669         - name: hostname
11670           in: path
11671           description: Value from executing hostname on the compute node.
11672           required: true
11673           type: string
11674           example: __HOSTNAME__
11675         - name: interface-name
11676           in: path
11677           description: Name that identifies the link aggregate interface
11678           required: true
11679           type: string
11680           example: __INTERFACE-NAME__
11681         - name: interface-name
11682           in: path
11683           description: Name given to the interface
11684           required: true
11685           type: string
11686           example: __INTERFACE-NAME__
11687         - name: body
11688           in: body
11689           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11690           required: true
11691           schema:
11692             $ref: "#/definitions/l-interface"
11693     patch:
11694       tags:
11695         - CloudInfrastructure
11696       summary: update an existing l-interface
11697       description: |
11698         Update an existing l-interface
11699         #
11700         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11701         The PUT operation will entirely replace an existing object.
11702         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11703         #
11704         Other differences between PUT and PATCH are:
11705         #
11706         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11707         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11708         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11709       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11710       consumes:
11711         - application/json
11712         - application/xml
11713       produces:
11714         - application/json
11715         - application/xml
11716       responses:
11717         "default":
11718           description: Response codes found in [response codes](https://wiki.onap.org/).
11719       parameters:
11720         - name: hostname
11721           in: path
11722           description: Value from executing hostname on the compute node.
11723           required: true
11724           type: string
11725           example: __HOSTNAME__
11726         - name: interface-name
11727           in: path
11728           description: Name that identifies the link aggregate interface
11729           required: true
11730           type: string
11731           example: __INTERFACE-NAME__
11732         - name: interface-name
11733           in: path
11734           description: Name given to the interface
11735           required: true
11736           type: string
11737           example: __INTERFACE-NAME__
11738         - name: body
11739           in: body
11740           description: l-interface object that needs to be updated.
11741           required: true
11742           schema:
11743             $ref: "#/patchDefinitions/l-interface"
11744     delete:
11745       tags:
11746         - CloudInfrastructure
11747       summary: delete an existing l-interface
11748       description: delete an existing l-interface
11749       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11750       consumes:
11751         - application/json
11752         - application/xml
11753       produces:
11754         - application/json
11755         - application/xml
11756       responses:
11757         "default":
11758           description: Response codes found in [response codes](https://wiki.onap.org/).
11759       parameters:
11760         - name: hostname
11761           in: path
11762           description: Value from executing hostname on the compute node.
11763           required: true
11764           type: string
11765           example: __HOSTNAME__
11766         - name: interface-name
11767           in: path
11768           description: Name that identifies the link aggregate interface
11769           required: true
11770           type: string
11771           example: __INTERFACE-NAME__
11772         - name: interface-name
11773           in: path
11774           description: Name given to the interface
11775           required: true
11776           type: string
11777           example: __INTERFACE-NAME__
11778         - name: resource-version
11779           in: query
11780           description: resource-version for concurrency
11781           required: true
11782           type: string
11783   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11784     get:
11785       tags:
11786         - CloudInfrastructure
11787       summary: returns l-interfaces
11788       description: returns l-interfaces
11789       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11790       produces:
11791         - application/json
11792         - application/xml
11793       responses:
11794         "200":
11795           description: successful operation
11796           schema:
11797               $ref: "#/getDefinitions/l-interfaces"
11798         "default":
11799           description: Response codes found in [response codes](https://wiki.onap.org/).
11800       parameters:
11801         - name: hostname
11802           in: path
11803           description: Value from executing hostname on the compute node.
11804           required: true
11805           type: string
11806           example: __HOSTNAME__
11807         - name: interface-name
11808           in: path
11809           description: Name that identifies the link aggregate interface
11810           required: true
11811           type: string
11812           example: __INTERFACE-NAME__
11813         - name: interface-name
11814           in: query
11815           description:
11816           required: false
11817           type: string
11818         - name: interface-id
11819           in: query
11820           description:
11821           required: false
11822           type: string
11823         - name: macaddr
11824           in: query
11825           description:
11826           required: false
11827           type: string
11828         - name: network-name
11829           in: query
11830           description:
11831           required: false
11832           type: string
11833   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11834     get:
11835       tags:
11836         - CloudInfrastructure
11837       summary: returns lag-interface
11838       description: returns lag-interface
11839       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11840       produces:
11841         - application/json
11842         - application/xml
11843       responses:
11844         "200":
11845           description: successful operation
11846           schema:
11847               $ref: "#/getDefinitions/lag-interface"
11848         "default":
11849           description: Response codes found in [response codes](https://wiki.onap.org/).
11850       parameters:
11851         - name: hostname
11852           in: path
11853           description: Value from executing hostname on the compute node.
11854           required: true
11855           type: string
11856           example: __HOSTNAME__
11857         - name: interface-name
11858           in: path
11859           description: Name that identifies the link aggregate interface
11860           required: true
11861           type: string
11862           example: __INTERFACE-NAME__
11863     put:
11864       tags:
11865         - CloudInfrastructure
11866       summary: create or update an existing lag-interface
11867       description: |
11868         Create or update an existing lag-interface.
11869         #
11870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11871       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11872       consumes:
11873         - application/json
11874         - application/xml
11875       produces:
11876         - application/json
11877         - application/xml
11878       responses:
11879         "default":
11880           description: Response codes found in [response codes](https://wiki.onap.org/).
11881       parameters:
11882         - name: hostname
11883           in: path
11884           description: Value from executing hostname on the compute node.
11885           required: true
11886           type: string
11887           example: __HOSTNAME__
11888         - name: interface-name
11889           in: path
11890           description: Name that identifies the link aggregate interface
11891           required: true
11892           type: string
11893           example: __INTERFACE-NAME__
11894         - name: body
11895           in: body
11896           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11897           required: true
11898           schema:
11899             $ref: "#/definitions/lag-interface"
11900     patch:
11901       tags:
11902         - CloudInfrastructure
11903       summary: update an existing lag-interface
11904       description: |
11905         Update an existing lag-interface
11906         #
11907         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11908         The PUT operation will entirely replace an existing object.
11909         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11910         #
11911         Other differences between PUT and PATCH are:
11912         #
11913         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11914         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11915         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11916       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11917       consumes:
11918         - application/json
11919         - application/xml
11920       produces:
11921         - application/json
11922         - application/xml
11923       responses:
11924         "default":
11925           description: Response codes found in [response codes](https://wiki.onap.org/).
11926       parameters:
11927         - name: hostname
11928           in: path
11929           description: Value from executing hostname on the compute node.
11930           required: true
11931           type: string
11932           example: __HOSTNAME__
11933         - name: interface-name
11934           in: path
11935           description: Name that identifies the link aggregate interface
11936           required: true
11937           type: string
11938           example: __INTERFACE-NAME__
11939         - name: body
11940           in: body
11941           description: lag-interface object that needs to be updated.
11942           required: true
11943           schema:
11944             $ref: "#/patchDefinitions/lag-interface"
11945     delete:
11946       tags:
11947         - CloudInfrastructure
11948       summary: delete an existing lag-interface
11949       description: delete an existing lag-interface
11950       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11951       consumes:
11952         - application/json
11953         - application/xml
11954       produces:
11955         - application/json
11956         - application/xml
11957       responses:
11958         "default":
11959           description: Response codes found in [response codes](https://wiki.onap.org/).
11960       parameters:
11961         - name: hostname
11962           in: path
11963           description: Value from executing hostname on the compute node.
11964           required: true
11965           type: string
11966           example: __HOSTNAME__
11967         - name: interface-name
11968           in: path
11969           description: Name that identifies the link aggregate interface
11970           required: true
11971           type: string
11972           example: __INTERFACE-NAME__
11973         - name: resource-version
11974           in: query
11975           description: resource-version for concurrency
11976           required: true
11977           type: string
11978   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11979     get:
11980       tags:
11981         - CloudInfrastructure
11982       summary: returns lag-interfaces
11983       description: returns lag-interfaces
11984       operationId: getCloudInfrastructurePserversPserverLagInterfaces
11985       produces:
11986         - application/json
11987         - application/xml
11988       responses:
11989         "200":
11990           description: successful operation
11991           schema:
11992               $ref: "#/getDefinitions/lag-interfaces"
11993         "default":
11994           description: Response codes found in [response codes](https://wiki.onap.org/).
11995       parameters:
11996         - name: hostname
11997           in: path
11998           description: Value from executing hostname on the compute node.
11999           required: true
12000           type: string
12001           example: __HOSTNAME__
12002         - name: interface-name
12003           in: query
12004           description:
12005           required: false
12006           type: string
12007   /cloud-infrastructure/pservers/pserver/{hostname}:
12008     get:
12009       tags:
12010         - CloudInfrastructure
12011       summary: returns pserver
12012       description: returns pserver
12013       operationId: getCloudInfrastructurePserversPserver
12014       produces:
12015         - application/json
12016         - application/xml
12017       responses:
12018         "200":
12019           description: successful operation
12020           schema:
12021               $ref: "#/getDefinitions/pserver"
12022         "default":
12023           description: Response codes found in [response codes](https://wiki.onap.org/).
12024       parameters:
12025         - name: hostname
12026           in: path
12027           description: Value from executing hostname on the compute node.
12028           required: true
12029           type: string
12030           example: __HOSTNAME__
12031     put:
12032       tags:
12033         - CloudInfrastructure
12034       summary: create or update an existing pserver
12035       description: |
12036         Create or update an existing pserver.
12037         #
12038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12039       operationId: createOrUpdateCloudInfrastructurePserversPserver
12040       consumes:
12041         - application/json
12042         - application/xml
12043       produces:
12044         - application/json
12045         - application/xml
12046       responses:
12047         "default":
12048           description: Response codes found in [response codes](https://wiki.onap.org/).
12049       parameters:
12050         - name: hostname
12051           in: path
12052           description: Value from executing hostname on the compute node.
12053           required: true
12054           type: string
12055           example: __HOSTNAME__
12056         - name: body
12057           in: body
12058           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
12059           required: true
12060           schema:
12061             $ref: "#/definitions/pserver"
12062     patch:
12063       tags:
12064         - CloudInfrastructure
12065       summary: update an existing pserver
12066       description: |
12067         Update an existing pserver
12068         #
12069         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12070         The PUT operation will entirely replace an existing object.
12071         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12072         #
12073         Other differences between PUT and PATCH are:
12074         #
12075         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12076         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12077         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12078       operationId: UpdateCloudInfrastructurePserversPserver
12079       consumes:
12080         - application/json
12081         - application/xml
12082       produces:
12083         - application/json
12084         - application/xml
12085       responses:
12086         "default":
12087           description: Response codes found in [response codes](https://wiki.onap.org/).
12088       parameters:
12089         - name: hostname
12090           in: path
12091           description: Value from executing hostname on the compute node.
12092           required: true
12093           type: string
12094           example: __HOSTNAME__
12095         - name: body
12096           in: body
12097           description: pserver object that needs to be updated.
12098           required: true
12099           schema:
12100             $ref: "#/patchDefinitions/pserver"
12101     delete:
12102       tags:
12103         - CloudInfrastructure
12104       summary: delete an existing pserver
12105       description: delete an existing pserver
12106       operationId: deleteCloudInfrastructurePserversPserver
12107       consumes:
12108         - application/json
12109         - application/xml
12110       produces:
12111         - application/json
12112         - application/xml
12113       responses:
12114         "default":
12115           description: Response codes found in [response codes](https://wiki.onap.org/).
12116       parameters:
12117         - name: hostname
12118           in: path
12119           description: Value from executing hostname on the compute node.
12120           required: true
12121           type: string
12122           example: __HOSTNAME__
12123         - name: resource-version
12124           in: query
12125           description: resource-version for concurrency
12126           required: true
12127           type: string
12128   /cloud-infrastructure/pservers:
12129     get:
12130       tags:
12131         - CloudInfrastructure
12132       summary: returns pservers
12133       description: returns pservers
12134       operationId: getCloudInfrastructurePservers
12135       produces:
12136         - application/json
12137         - application/xml
12138       responses:
12139         "200":
12140           description: successful operation
12141           schema:
12142               $ref: "#/getDefinitions/pservers"
12143         "default":
12144           description: Response codes found in [response codes](https://wiki.onap.org/).
12145       parameters:
12146         - name: hostname
12147           in: query
12148           description:
12149           required: false
12150           type: string
12151         - name: pserver-id
12152           in: query
12153           description:
12154           required: false
12155           type: string
12156         - name: in-maint
12157           in: query
12158           description:
12159           required: false
12160           type: boolean
12161         - name: pserver-name2
12162           in: query
12163           description:
12164           required: false
12165           type: string
12166   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12167     put:
12168       tags:
12169         - CloudInfrastructure
12170       summary: see node definition for valid relationships
12171       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12172       consumes:
12173         - application/json
12174         - application/xml
12175       produces:
12176         - application/json
12177         - application/xml
12178       responses:
12179         "default":
12180           description: Response codes found in [response codes](https://wiki.onap.org/).
12181       parameters:
12182         - name: vdc-id
12183           in: path
12184           description: Unique ID of the vdc
12185           required: true
12186           type: string
12187           example: __VDC-ID__
12188         - name: body
12189           in: body
12190           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12191           required: true
12192           schema:
12193             $ref: "#/definitions/relationship"
12194     delete:
12195       tags:
12196         - CloudInfrastructure
12197       summary: delete an existing relationship
12198       description: delete an existing relationship
12199       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12200       consumes:
12201         - application/json
12202         - application/xml
12203       produces:
12204         - application/json
12205         - application/xml
12206       responses:
12207         "default":
12208           description: Response codes found in [response codes](https://wiki.onap.org/).
12209       parameters:
12210         - name: vdc-id
12211           in: path
12212           description: Unique ID of the vdc
12213           required: true
12214           type: string
12215           example: __VDC-ID__
12216   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12217     get:
12218       tags:
12219         - CloudInfrastructure
12220       summary: returns virtual-data-center
12221       description: returns virtual-data-center
12222       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12223       produces:
12224         - application/json
12225         - application/xml
12226       responses:
12227         "200":
12228           description: successful operation
12229           schema:
12230               $ref: "#/getDefinitions/virtual-data-center"
12231         "default":
12232           description: Response codes found in [response codes](https://wiki.onap.org/).
12233       parameters:
12234         - name: vdc-id
12235           in: path
12236           description: Unique ID of the vdc
12237           required: true
12238           type: string
12239           example: __VDC-ID__
12240     put:
12241       tags:
12242         - CloudInfrastructure
12243       summary: create or update an existing virtual-data-center
12244       description: |
12245         Create or update an existing virtual-data-center.
12246         #
12247         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12248       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12249       consumes:
12250         - application/json
12251         - application/xml
12252       produces:
12253         - application/json
12254         - application/xml
12255       responses:
12256         "default":
12257           description: Response codes found in [response codes](https://wiki.onap.org/).
12258       parameters:
12259         - name: vdc-id
12260           in: path
12261           description: Unique ID of the vdc
12262           required: true
12263           type: string
12264           example: __VDC-ID__
12265         - name: body
12266           in: body
12267           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12268           required: true
12269           schema:
12270             $ref: "#/definitions/virtual-data-center"
12271     patch:
12272       tags:
12273         - CloudInfrastructure
12274       summary: update an existing virtual-data-center
12275       description: |
12276         Update an existing virtual-data-center
12277         #
12278         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12279         The PUT operation will entirely replace an existing object.
12280         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12281         #
12282         Other differences between PUT and PATCH are:
12283         #
12284         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12285         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12286         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12287       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12288       consumes:
12289         - application/json
12290         - application/xml
12291       produces:
12292         - application/json
12293         - application/xml
12294       responses:
12295         "default":
12296           description: Response codes found in [response codes](https://wiki.onap.org/).
12297       parameters:
12298         - name: vdc-id
12299           in: path
12300           description: Unique ID of the vdc
12301           required: true
12302           type: string
12303           example: __VDC-ID__
12304         - name: body
12305           in: body
12306           description: virtual-data-center object that needs to be updated.
12307           required: true
12308           schema:
12309             $ref: "#/patchDefinitions/virtual-data-center"
12310     delete:
12311       tags:
12312         - CloudInfrastructure
12313       summary: delete an existing virtual-data-center
12314       description: delete an existing virtual-data-center
12315       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
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: vdc-id
12327           in: path
12328           description: Unique ID of the vdc
12329           required: true
12330           type: string
12331           example: __VDC-ID__
12332         - name: resource-version
12333           in: query
12334           description: resource-version for concurrency
12335           required: true
12336           type: string
12337   /cloud-infrastructure/virtual-data-centers:
12338     get:
12339       tags:
12340         - CloudInfrastructure
12341       summary: returns virtual-data-centers
12342       description: returns virtual-data-centers
12343       operationId: getCloudInfrastructureVirtualDataCenters
12344       produces:
12345         - application/json
12346         - application/xml
12347       responses:
12348         "200":
12349           description: successful operation
12350           schema:
12351               $ref: "#/getDefinitions/virtual-data-centers"
12352         "default":
12353           description: Response codes found in [response codes](https://wiki.onap.org/).
12354       parameters:
12355         - name: vdc-id
12356           in: query
12357           description:
12358           required: false
12359           type: string
12360         - name: vdc-name
12361           in: query
12362           description:
12363           required: false
12364           type: string
12365   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12366     put:
12367       tags:
12368         - Business
12369       summary: see node definition for valid relationships
12370       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12371       consumes:
12372         - application/json
12373         - application/xml
12374       produces:
12375         - application/json
12376         - application/xml
12377       responses:
12378         "default":
12379           description: Response codes found in [response codes](https://wiki.onap.org/).
12380       parameters:
12381         - name: resource-instance-id
12382           in: path
12383           description: Unique id of resource instance.
12384           required: true
12385           type: string
12386           example: __RESOURCE-INSTANCE-ID__
12387         - name: body
12388           in: body
12389           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
12390           required: true
12391           schema:
12392             $ref: "#/definitions/relationship"
12393     delete:
12394       tags:
12395         - Business
12396       summary: delete an existing relationship
12397       description: delete an existing relationship
12398       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12399       consumes:
12400         - application/json
12401         - application/xml
12402       produces:
12403         - application/json
12404         - application/xml
12405       responses:
12406         "default":
12407           description: Response codes found in [response codes](https://wiki.onap.org/).
12408       parameters:
12409         - name: resource-instance-id
12410           in: path
12411           description: Unique id of resource instance.
12412           required: true
12413           type: string
12414           example: __RESOURCE-INSTANCE-ID__
12415   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12416     get:
12417       tags:
12418         - Business
12419       summary: returns metadatum
12420       description: returns metadatum
12421       operationId: getBusinessConnectorsConnectorMetadataMetadatum
12422       produces:
12423         - application/json
12424         - application/xml
12425       responses:
12426         "200":
12427           description: successful operation
12428           schema:
12429               $ref: "#/getDefinitions/metadatum"
12430         "default":
12431           description: Response codes found in [response codes](https://wiki.onap.org/).
12432       parameters:
12433         - name: resource-instance-id
12434           in: path
12435           description: Unique id of resource instance.
12436           required: true
12437           type: string
12438           example: __RESOURCE-INSTANCE-ID__
12439         - name: metaname
12440           in: path
12441           required: true
12442           type: string
12443           example: __METANAME__
12444     put:
12445       tags:
12446         - Business
12447       summary: create or update an existing metadatum
12448       description: |
12449         Create or update an existing metadatum.
12450         #
12451         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12452       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12453       consumes:
12454         - application/json
12455         - application/xml
12456       produces:
12457         - application/json
12458         - application/xml
12459       responses:
12460         "default":
12461           description: Response codes found in [response codes](https://wiki.onap.org/).
12462       parameters:
12463         - name: resource-instance-id
12464           in: path
12465           description: Unique id of resource instance.
12466           required: true
12467           type: string
12468           example: __RESOURCE-INSTANCE-ID__
12469         - name: metaname
12470           in: path
12471           required: true
12472           type: string
12473           example: __METANAME__
12474         - name: body
12475           in: body
12476           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)
12477           required: true
12478           schema:
12479             $ref: "#/definitions/metadatum"
12480     patch:
12481       tags:
12482         - Business
12483       summary: update an existing metadatum
12484       description: |
12485         Update an existing metadatum
12486         #
12487         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12488         The PUT operation will entirely replace an existing object.
12489         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12490         #
12491         Other differences between PUT and PATCH are:
12492         #
12493         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12494         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12495         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12496       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12497       consumes:
12498         - application/json
12499         - application/xml
12500       produces:
12501         - application/json
12502         - application/xml
12503       responses:
12504         "default":
12505           description: Response codes found in [response codes](https://wiki.onap.org/).
12506       parameters:
12507         - name: resource-instance-id
12508           in: path
12509           description: Unique id of resource instance.
12510           required: true
12511           type: string
12512           example: __RESOURCE-INSTANCE-ID__
12513         - name: metaname
12514           in: path
12515           required: true
12516           type: string
12517           example: __METANAME__
12518         - name: body
12519           in: body
12520           description: metadatum object that needs to be updated.
12521           required: true
12522           schema:
12523             $ref: "#/patchDefinitions/metadatum"
12524     delete:
12525       tags:
12526         - Business
12527       summary: delete an existing metadatum
12528       description: delete an existing metadatum
12529       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12530       consumes:
12531         - application/json
12532         - application/xml
12533       produces:
12534         - application/json
12535         - application/xml
12536       responses:
12537         "default":
12538           description: Response codes found in [response codes](https://wiki.onap.org/).
12539       parameters:
12540         - name: resource-instance-id
12541           in: path
12542           description: Unique id of resource instance.
12543           required: true
12544           type: string
12545           example: __RESOURCE-INSTANCE-ID__
12546         - name: metaname
12547           in: path
12548           required: true
12549           type: string
12550           example: __METANAME__
12551         - name: resource-version
12552           in: query
12553           description: resource-version for concurrency
12554           required: true
12555           type: string
12556   /business/connectors/connector/{resource-instance-id}/metadata:
12557     get:
12558       tags:
12559         - Business
12560       summary: returns metadata
12561       description: returns metadata
12562       operationId: getBusinessConnectorsConnectorMetadata
12563       produces:
12564         - application/json
12565         - application/xml
12566       responses:
12567         "200":
12568           description: successful operation
12569           schema:
12570               $ref: "#/getDefinitions/metadata"
12571         "default":
12572           description: Response codes found in [response codes](https://wiki.onap.org/).
12573       parameters:
12574         - name: resource-instance-id
12575           in: path
12576           description: Unique id of resource instance.
12577           required: true
12578           type: string
12579           example: __RESOURCE-INSTANCE-ID__
12580         - name: metaname
12581           in: query
12582           description:
12583           required: false
12584           type: string
12585   /business/connectors/connector/{resource-instance-id}:
12586     get:
12587       tags:
12588         - Business
12589       summary: returns connector
12590       description: returns connector
12591       operationId: getBusinessConnectorsConnector
12592       produces:
12593         - application/json
12594         - application/xml
12595       responses:
12596         "200":
12597           description: successful operation
12598           schema:
12599               $ref: "#/getDefinitions/connector"
12600         "default":
12601           description: Response codes found in [response codes](https://wiki.onap.org/).
12602       parameters:
12603         - name: resource-instance-id
12604           in: path
12605           description: Unique id of resource instance.
12606           required: true
12607           type: string
12608           example: __RESOURCE-INSTANCE-ID__
12609     put:
12610       tags:
12611         - Business
12612       summary: create or update an existing connector
12613       description: |
12614         Create or update an existing connector.
12615         #
12616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12617       operationId: createOrUpdateBusinessConnectorsConnector
12618       consumes:
12619         - application/json
12620         - application/xml
12621       produces:
12622         - application/json
12623         - application/xml
12624       responses:
12625         "default":
12626           description: Response codes found in [response codes](https://wiki.onap.org/).
12627       parameters:
12628         - name: resource-instance-id
12629           in: path
12630           description: Unique id of resource instance.
12631           required: true
12632           type: string
12633           example: __RESOURCE-INSTANCE-ID__
12634         - name: body
12635           in: body
12636           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
12637           required: true
12638           schema:
12639             $ref: "#/definitions/connector"
12640     patch:
12641       tags:
12642         - Business
12643       summary: update an existing connector
12644       description: |
12645         Update an existing connector
12646         #
12647         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12648         The PUT operation will entirely replace an existing object.
12649         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12650         #
12651         Other differences between PUT and PATCH are:
12652         #
12653         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12654         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12655         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12656       operationId: UpdateBusinessConnectorsConnector
12657       consumes:
12658         - application/json
12659         - application/xml
12660       produces:
12661         - application/json
12662         - application/xml
12663       responses:
12664         "default":
12665           description: Response codes found in [response codes](https://wiki.onap.org/).
12666       parameters:
12667         - name: resource-instance-id
12668           in: path
12669           description: Unique id of resource instance.
12670           required: true
12671           type: string
12672           example: __RESOURCE-INSTANCE-ID__
12673         - name: body
12674           in: body
12675           description: connector object that needs to be updated.
12676           required: true
12677           schema:
12678             $ref: "#/patchDefinitions/connector"
12679     delete:
12680       tags:
12681         - Business
12682       summary: delete an existing connector
12683       description: delete an existing connector
12684       operationId: deleteBusinessConnectorsConnector
12685       consumes:
12686         - application/json
12687         - application/xml
12688       produces:
12689         - application/json
12690         - application/xml
12691       responses:
12692         "default":
12693           description: Response codes found in [response codes](https://wiki.onap.org/).
12694       parameters:
12695         - name: resource-instance-id
12696           in: path
12697           description: Unique id of resource instance.
12698           required: true
12699           type: string
12700           example: __RESOURCE-INSTANCE-ID__
12701         - name: resource-version
12702           in: query
12703           description: resource-version for concurrency
12704           required: true
12705           type: string
12706   /business/connectors:
12707     get:
12708       tags:
12709         - Business
12710       summary: returns connectors
12711       description: returns connectors
12712       operationId: getBusinessConnectors
12713       produces:
12714         - application/json
12715         - application/xml
12716       responses:
12717         "200":
12718           description: successful operation
12719           schema:
12720               $ref: "#/getDefinitions/connectors"
12721         "default":
12722           description: Response codes found in [response codes](https://wiki.onap.org/).
12723       parameters:
12724         - name: resource-instance-id
12725           in: query
12726           description:
12727           required: false
12728           type: string
12729         - name: persona-model-id
12730           in: query
12731           description:
12732           required: false
12733           type: string
12734         - name: persona-model-version
12735           in: query
12736           description:
12737           required: false
12738           type: string
12739         - name: widget-model-id
12740           in: query
12741           description:
12742           required: false
12743           type: string
12744         - name: widget-model-version
12745           in: query
12746           description:
12747           required: false
12748           type: string
12749   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12750     put:
12751       tags:
12752         - Business
12753       summary: see node definition for valid relationships
12754       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12755       consumes:
12756         - application/json
12757         - application/xml
12758       produces:
12759         - application/json
12760         - application/xml
12761       responses:
12762         "default":
12763           description: Response codes found in [response codes](https://wiki.onap.org/).
12764       parameters:
12765         - name: global-customer-id
12766           in: path
12767           description: Global customer id used across ECOMP to uniquely identify customer.
12768           required: true
12769           type: string
12770           example: __GLOBAL-CUSTOMER-ID__
12771         - name: service-type
12772           in: path
12773           description: Value defined by orchestration to identify this service across ECOMP.
12774           required: true
12775           type: string
12776           example: __SERVICE-TYPE__
12777         - name: service-instance-id
12778           in: path
12779           description: Uniquely identifies this instance of a service
12780           required: true
12781           type: string
12782           example: __SERVICE-INSTANCE-ID__
12783         - name: body
12784           in: body
12785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12786           required: true
12787           schema:
12788             $ref: "#/definitions/relationship"
12789     delete:
12790       tags:
12791         - Business
12792       summary: delete an existing relationship
12793       description: delete an existing relationship
12794       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12795       consumes:
12796         - application/json
12797         - application/xml
12798       produces:
12799         - application/json
12800         - application/xml
12801       responses:
12802         "default":
12803           description: Response codes found in [response codes](https://wiki.onap.org/).
12804       parameters:
12805         - name: global-customer-id
12806           in: path
12807           description: Global customer id used across ECOMP to uniquely identify customer.
12808           required: true
12809           type: string
12810           example: __GLOBAL-CUSTOMER-ID__
12811         - name: service-type
12812           in: path
12813           description: Value defined by orchestration to identify this service across ECOMP.
12814           required: true
12815           type: string
12816           example: __SERVICE-TYPE__
12817         - name: service-instance-id
12818           in: path
12819           description: Uniquely identifies this instance of a service
12820           required: true
12821           type: string
12822           example: __SERVICE-INSTANCE-ID__
12823   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12824     get:
12825       tags:
12826         - Business
12827       summary: returns metadatum
12828       description: returns metadatum
12829       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12830       produces:
12831         - application/json
12832         - application/xml
12833       responses:
12834         "200":
12835           description: successful operation
12836           schema:
12837               $ref: "#/getDefinitions/metadatum"
12838         "default":
12839           description: Response codes found in [response codes](https://wiki.onap.org/).
12840       parameters:
12841         - name: global-customer-id
12842           in: path
12843           description: Global customer id used across ECOMP to uniquely identify customer.
12844           required: true
12845           type: string
12846           example: __GLOBAL-CUSTOMER-ID__
12847         - name: service-type
12848           in: path
12849           description: Value defined by orchestration to identify this service across ECOMP.
12850           required: true
12851           type: string
12852           example: __SERVICE-TYPE__
12853         - name: service-instance-id
12854           in: path
12855           description: Uniquely identifies this instance of a service
12856           required: true
12857           type: string
12858           example: __SERVICE-INSTANCE-ID__
12859         - name: metaname
12860           in: path
12861           required: true
12862           type: string
12863           example: __METANAME__
12864     put:
12865       tags:
12866         - Business
12867       summary: create or update an existing metadatum
12868       description: |
12869         Create or update an existing metadatum.
12870         #
12871         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12872       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12873       consumes:
12874         - application/json
12875         - application/xml
12876       produces:
12877         - application/json
12878         - application/xml
12879       responses:
12880         "default":
12881           description: Response codes found in [response codes](https://wiki.onap.org/).
12882       parameters:
12883         - name: global-customer-id
12884           in: path
12885           description: Global customer id used across ECOMP to uniquely identify customer.
12886           required: true
12887           type: string
12888           example: __GLOBAL-CUSTOMER-ID__
12889         - name: service-type
12890           in: path
12891           description: Value defined by orchestration to identify this service across ECOMP.
12892           required: true
12893           type: string
12894           example: __SERVICE-TYPE__
12895         - name: service-instance-id
12896           in: path
12897           description: Uniquely identifies this instance of a service
12898           required: true
12899           type: string
12900           example: __SERVICE-INSTANCE-ID__
12901         - name: metaname
12902           in: path
12903           required: true
12904           type: string
12905           example: __METANAME__
12906         - name: body
12907           in: body
12908           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12909           required: true
12910           schema:
12911             $ref: "#/definitions/metadatum"
12912     patch:
12913       tags:
12914         - Business
12915       summary: update an existing metadatum
12916       description: |
12917         Update an existing metadatum
12918         #
12919         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12920         The PUT operation will entirely replace an existing object.
12921         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12922         #
12923         Other differences between PUT and PATCH are:
12924         #
12925         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12926         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12927         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12928       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12929       consumes:
12930         - application/json
12931         - application/xml
12932       produces:
12933         - application/json
12934         - application/xml
12935       responses:
12936         "default":
12937           description: Response codes found in [response codes](https://wiki.onap.org/).
12938       parameters:
12939         - name: global-customer-id
12940           in: path
12941           description: Global customer id used across ECOMP to uniquely identify customer.
12942           required: true
12943           type: string
12944           example: __GLOBAL-CUSTOMER-ID__
12945         - name: service-type
12946           in: path
12947           description: Value defined by orchestration to identify this service across ECOMP.
12948           required: true
12949           type: string
12950           example: __SERVICE-TYPE__
12951         - name: service-instance-id
12952           in: path
12953           description: Uniquely identifies this instance of a service
12954           required: true
12955           type: string
12956           example: __SERVICE-INSTANCE-ID__
12957         - name: metaname
12958           in: path
12959           required: true
12960           type: string
12961           example: __METANAME__
12962         - name: body
12963           in: body
12964           description: metadatum object that needs to be updated.
12965           required: true
12966           schema:
12967             $ref: "#/patchDefinitions/metadatum"
12968     delete:
12969       tags:
12970         - Business
12971       summary: delete an existing metadatum
12972       description: delete an existing metadatum
12973       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12974       consumes:
12975         - application/json
12976         - application/xml
12977       produces:
12978         - application/json
12979         - application/xml
12980       responses:
12981         "default":
12982           description: Response codes found in [response codes](https://wiki.onap.org/).
12983       parameters:
12984         - name: global-customer-id
12985           in: path
12986           description: Global customer id used across ECOMP to uniquely identify customer.
12987           required: true
12988           type: string
12989           example: __GLOBAL-CUSTOMER-ID__
12990         - name: service-type
12991           in: path
12992           description: Value defined by orchestration to identify this service across ECOMP.
12993           required: true
12994           type: string
12995           example: __SERVICE-TYPE__
12996         - name: service-instance-id
12997           in: path
12998           description: Uniquely identifies this instance of a service
12999           required: true
13000           type: string
13001           example: __SERVICE-INSTANCE-ID__
13002         - name: metaname
13003           in: path
13004           required: true
13005           type: string
13006           example: __METANAME__
13007         - name: resource-version
13008           in: query
13009           description: resource-version for concurrency
13010           required: true
13011           type: string
13012   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13013     get:
13014       tags:
13015         - Business
13016       summary: returns metadata
13017       description: returns metadata
13018       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13019       produces:
13020         - application/json
13021         - application/xml
13022       responses:
13023         "200":
13024           description: successful operation
13025           schema:
13026               $ref: "#/getDefinitions/metadata"
13027         "default":
13028           description: Response codes found in [response codes](https://wiki.onap.org/).
13029       parameters:
13030         - name: global-customer-id
13031           in: path
13032           description: Global customer id used across ECOMP to uniquely identify customer.
13033           required: true
13034           type: string
13035           example: __GLOBAL-CUSTOMER-ID__
13036         - name: service-type
13037           in: path
13038           description: Value defined by orchestration to identify this service across ECOMP.
13039           required: true
13040           type: string
13041           example: __SERVICE-TYPE__
13042         - name: service-instance-id
13043           in: path
13044           description: Uniquely identifies this instance of a service
13045           required: true
13046           type: string
13047           example: __SERVICE-INSTANCE-ID__
13048         - name: metaname
13049           in: query
13050           description:
13051           required: false
13052           type: string
13053   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13054     get:
13055       tags:
13056         - Business
13057       summary: returns service-instance
13058       description: returns service-instance
13059       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13060       produces:
13061         - application/json
13062         - application/xml
13063       responses:
13064         "200":
13065           description: successful operation
13066           schema:
13067               $ref: "#/getDefinitions/service-instance"
13068         "default":
13069           description: Response codes found in [response codes](https://wiki.onap.org/).
13070       parameters:
13071         - name: global-customer-id
13072           in: path
13073           description: Global customer id used across ECOMP to uniquely identify customer.
13074           required: true
13075           type: string
13076           example: __GLOBAL-CUSTOMER-ID__
13077         - name: service-type
13078           in: path
13079           description: Value defined by orchestration to identify this service across ECOMP.
13080           required: true
13081           type: string
13082           example: __SERVICE-TYPE__
13083         - name: service-instance-id
13084           in: path
13085           description: Uniquely identifies this instance of a service
13086           required: true
13087           type: string
13088           example: __SERVICE-INSTANCE-ID__
13089     put:
13090       tags:
13091         - Business
13092       summary: create or update an existing service-instance
13093       description: |
13094         Create or update an existing service-instance.
13095         #
13096         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13097       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13098       consumes:
13099         - application/json
13100         - application/xml
13101       produces:
13102         - application/json
13103         - application/xml
13104       responses:
13105         "default":
13106           description: Response codes found in [response codes](https://wiki.onap.org/).
13107       parameters:
13108         - name: global-customer-id
13109           in: path
13110           description: Global customer id used across ECOMP to uniquely identify customer.
13111           required: true
13112           type: string
13113           example: __GLOBAL-CUSTOMER-ID__
13114         - name: service-type
13115           in: path
13116           description: Value defined by orchestration to identify this service across ECOMP.
13117           required: true
13118           type: string
13119           example: __SERVICE-TYPE__
13120         - name: service-instance-id
13121           in: path
13122           description: Uniquely identifies this instance of a service
13123           required: true
13124           type: string
13125           example: __SERVICE-INSTANCE-ID__
13126         - name: body
13127           in: body
13128           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13129           required: true
13130           schema:
13131             $ref: "#/definitions/service-instance"
13132     patch:
13133       tags:
13134         - Business
13135       summary: update an existing service-instance
13136       description: |
13137         Update an existing service-instance
13138         #
13139         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13140         The PUT operation will entirely replace an existing object.
13141         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13142         #
13143         Other differences between PUT and PATCH are:
13144         #
13145         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13146         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13147         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13148       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13149       consumes:
13150         - application/json
13151         - application/xml
13152       produces:
13153         - application/json
13154         - application/xml
13155       responses:
13156         "default":
13157           description: Response codes found in [response codes](https://wiki.onap.org/).
13158       parameters:
13159         - name: global-customer-id
13160           in: path
13161           description: Global customer id used across ECOMP to uniquely identify customer.
13162           required: true
13163           type: string
13164           example: __GLOBAL-CUSTOMER-ID__
13165         - name: service-type
13166           in: path
13167           description: Value defined by orchestration to identify this service across ECOMP.
13168           required: true
13169           type: string
13170           example: __SERVICE-TYPE__
13171         - name: service-instance-id
13172           in: path
13173           description: Uniquely identifies this instance of a service
13174           required: true
13175           type: string
13176           example: __SERVICE-INSTANCE-ID__
13177         - name: body
13178           in: body
13179           description: service-instance object that needs to be updated.
13180           required: true
13181           schema:
13182             $ref: "#/patchDefinitions/service-instance"
13183     delete:
13184       tags:
13185         - Business
13186       summary: delete an existing service-instance
13187       description: delete an existing service-instance
13188       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13189       consumes:
13190         - application/json
13191         - application/xml
13192       produces:
13193         - application/json
13194         - application/xml
13195       responses:
13196         "default":
13197           description: Response codes found in [response codes](https://wiki.onap.org/).
13198       parameters:
13199         - name: global-customer-id
13200           in: path
13201           description: Global customer id used across ECOMP to uniquely identify customer.
13202           required: true
13203           type: string
13204           example: __GLOBAL-CUSTOMER-ID__
13205         - name: service-type
13206           in: path
13207           description: Value defined by orchestration to identify this service across ECOMP.
13208           required: true
13209           type: string
13210           example: __SERVICE-TYPE__
13211         - name: service-instance-id
13212           in: path
13213           description: Uniquely identifies this instance of a service
13214           required: true
13215           type: string
13216           example: __SERVICE-INSTANCE-ID__
13217         - name: resource-version
13218           in: query
13219           description: resource-version for concurrency
13220           required: true
13221           type: string
13222   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13223     get:
13224       tags:
13225         - Business
13226       summary: returns service-instances
13227       description: returns service-instances
13228       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13229       produces:
13230         - application/json
13231         - application/xml
13232       responses:
13233         "200":
13234           description: successful operation
13235           schema:
13236               $ref: "#/getDefinitions/service-instances"
13237         "default":
13238           description: Response codes found in [response codes](https://wiki.onap.org/).
13239       parameters:
13240         - name: global-customer-id
13241           in: path
13242           description: Global customer id used across ECOMP to uniquely identify customer.
13243           required: true
13244           type: string
13245           example: __GLOBAL-CUSTOMER-ID__
13246         - name: service-type
13247           in: path
13248           description: Value defined by orchestration to identify this service across ECOMP.
13249           required: true
13250           type: string
13251           example: __SERVICE-TYPE__
13252         - name: service-instance-id
13253           in: query
13254           description:
13255           required: false
13256           type: string
13257         - name: service-instance-name
13258           in: query
13259           description:
13260           required: false
13261           type: string
13262         - name: persona-model-id
13263           in: query
13264           description:
13265           required: false
13266           type: string
13267         - name: persona-model-version
13268           in: query
13269           description:
13270           required: false
13271           type: string
13272         - name: widget-model-id
13273           in: query
13274           description:
13275           required: false
13276           type: string
13277         - name: widget-model-version
13278           in: query
13279           description:
13280           required: false
13281           type: string
13282         - name: service-instance-location-id
13283           in: query
13284           description:
13285           required: false
13286           type: string
13287   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
13288     put:
13289       tags:
13290         - Business
13291       summary: see node definition for valid relationships
13292       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
13293       consumes:
13294         - application/json
13295         - application/xml
13296       produces:
13297         - application/json
13298         - application/xml
13299       responses:
13300         "default":
13301           description: Response codes found in [response codes](https://wiki.onap.org/).
13302       parameters:
13303         - name: global-customer-id
13304           in: path
13305           description: Global customer id used across ECOMP to uniquely identify customer.
13306           required: true
13307           type: string
13308           example: __GLOBAL-CUSTOMER-ID__
13309         - name: service-type
13310           in: path
13311           description: Value defined by orchestration to identify this service across ECOMP.
13312           required: true
13313           type: string
13314           example: __SERVICE-TYPE__
13315         - name: body
13316           in: body
13317           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
13318           required: true
13319           schema:
13320             $ref: "#/definitions/relationship"
13321     delete:
13322       tags:
13323         - Business
13324       summary: delete an existing relationship
13325       description: delete an existing relationship
13326       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
13327       consumes:
13328         - application/json
13329         - application/xml
13330       produces:
13331         - application/json
13332         - application/xml
13333       responses:
13334         "default":
13335           description: Response codes found in [response codes](https://wiki.onap.org/).
13336       parameters:
13337         - name: global-customer-id
13338           in: path
13339           description: Global customer id used across ECOMP to uniquely identify customer.
13340           required: true
13341           type: string
13342           example: __GLOBAL-CUSTOMER-ID__
13343         - name: service-type
13344           in: path
13345           description: Value defined by orchestration to identify this service across ECOMP.
13346           required: true
13347           type: string
13348           example: __SERVICE-TYPE__
13349   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
13350     get:
13351       tags:
13352         - Business
13353       summary: returns service-subscription
13354       description: returns service-subscription
13355       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13356       produces:
13357         - application/json
13358         - application/xml
13359       responses:
13360         "200":
13361           description: successful operation
13362           schema:
13363               $ref: "#/getDefinitions/service-subscription"
13364         "default":
13365           description: Response codes found in [response codes](https://wiki.onap.org/).
13366       parameters:
13367         - name: global-customer-id
13368           in: path
13369           description: Global customer id used across ECOMP to uniquely identify customer.
13370           required: true
13371           type: string
13372           example: __GLOBAL-CUSTOMER-ID__
13373         - name: service-type
13374           in: path
13375           description: Value defined by orchestration to identify this service across ECOMP.
13376           required: true
13377           type: string
13378           example: __SERVICE-TYPE__
13379     put:
13380       tags:
13381         - Business
13382       summary: create or update an existing service-subscription
13383       description: |
13384         Create or update an existing service-subscription.
13385         #
13386         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13387       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13388       consumes:
13389         - application/json
13390         - application/xml
13391       produces:
13392         - application/json
13393         - application/xml
13394       responses:
13395         "default":
13396           description: Response codes found in [response codes](https://wiki.onap.org/).
13397       parameters:
13398         - name: global-customer-id
13399           in: path
13400           description: Global customer id used across ECOMP to uniquely identify customer.
13401           required: true
13402           type: string
13403           example: __GLOBAL-CUSTOMER-ID__
13404         - name: service-type
13405           in: path
13406           description: Value defined by orchestration to identify this service across ECOMP.
13407           required: true
13408           type: string
13409           example: __SERVICE-TYPE__
13410         - name: body
13411           in: body
13412           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
13413           required: true
13414           schema:
13415             $ref: "#/definitions/service-subscription"
13416     patch:
13417       tags:
13418         - Business
13419       summary: update an existing service-subscription
13420       description: |
13421         Update an existing service-subscription
13422         #
13423         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13424         The PUT operation will entirely replace an existing object.
13425         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13426         #
13427         Other differences between PUT and PATCH are:
13428         #
13429         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13430         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13431         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13432       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13433       consumes:
13434         - application/json
13435         - application/xml
13436       produces:
13437         - application/json
13438         - application/xml
13439       responses:
13440         "default":
13441           description: Response codes found in [response codes](https://wiki.onap.org/).
13442       parameters:
13443         - name: global-customer-id
13444           in: path
13445           description: Global customer id used across ECOMP to uniquely identify customer.
13446           required: true
13447           type: string
13448           example: __GLOBAL-CUSTOMER-ID__
13449         - name: service-type
13450           in: path
13451           description: Value defined by orchestration to identify this service across ECOMP.
13452           required: true
13453           type: string
13454           example: __SERVICE-TYPE__
13455         - name: body
13456           in: body
13457           description: service-subscription object that needs to be updated.
13458           required: true
13459           schema:
13460             $ref: "#/patchDefinitions/service-subscription"
13461     delete:
13462       tags:
13463         - Business
13464       summary: delete an existing service-subscription
13465       description: delete an existing service-subscription
13466       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13467       consumes:
13468         - application/json
13469         - application/xml
13470       produces:
13471         - application/json
13472         - application/xml
13473       responses:
13474         "default":
13475           description: Response codes found in [response codes](https://wiki.onap.org/).
13476       parameters:
13477         - name: global-customer-id
13478           in: path
13479           description: Global customer id used across ECOMP to uniquely identify customer.
13480           required: true
13481           type: string
13482           example: __GLOBAL-CUSTOMER-ID__
13483         - name: service-type
13484           in: path
13485           description: Value defined by orchestration to identify this service across ECOMP.
13486           required: true
13487           type: string
13488           example: __SERVICE-TYPE__
13489         - name: resource-version
13490           in: query
13491           description: resource-version for concurrency
13492           required: true
13493           type: string
13494   /business/customers/customer/{global-customer-id}/service-subscriptions:
13495     get:
13496       tags:
13497         - Business
13498       summary: returns service-subscriptions
13499       description: returns service-subscriptions
13500       operationId: getBusinessCustomersCustomerServiceSubscriptions
13501       produces:
13502         - application/json
13503         - application/xml
13504       responses:
13505         "200":
13506           description: successful operation
13507           schema:
13508               $ref: "#/getDefinitions/service-subscriptions"
13509         "default":
13510           description: Response codes found in [response codes](https://wiki.onap.org/).
13511       parameters:
13512         - name: global-customer-id
13513           in: path
13514           description: Global customer id used across ECOMP to uniquely identify customer.
13515           required: true
13516           type: string
13517           example: __GLOBAL-CUSTOMER-ID__
13518         - name: service-type
13519           in: query
13520           description:
13521           required: false
13522           type: string
13523   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
13524     put:
13525       tags:
13526         - Business
13527       summary: see node definition for valid relationships
13528       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
13529       consumes:
13530         - application/json
13531         - application/xml
13532       produces:
13533         - application/json
13534         - application/xml
13535       responses:
13536         "default":
13537           description: Response codes found in [response codes](https://wiki.onap.org/).
13538       parameters:
13539         - name: global-customer-id
13540           in: path
13541           description: Global customer id used across ECOMP to uniquely identify customer.
13542           required: true
13543           type: string
13544           example: __GLOBAL-CUSTOMER-ID__
13545         - name: body
13546           in: body
13547           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
13548           required: true
13549           schema:
13550             $ref: "#/definitions/relationship"
13551     delete:
13552       tags:
13553         - Business
13554       summary: delete an existing relationship
13555       description: delete an existing relationship
13556       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
13557       consumes:
13558         - application/json
13559         - application/xml
13560       produces:
13561         - application/json
13562         - application/xml
13563       responses:
13564         "default":
13565           description: Response codes found in [response codes](https://wiki.onap.org/).
13566       parameters:
13567         - name: global-customer-id
13568           in: path
13569           description: Global customer id used across ECOMP to uniquely identify customer.
13570           required: true
13571           type: string
13572           example: __GLOBAL-CUSTOMER-ID__
13573   /business/customers/customer/{global-customer-id}:
13574     get:
13575       tags:
13576         - Business
13577       summary: returns customer
13578       description: returns customer
13579       operationId: getBusinessCustomersCustomer
13580       produces:
13581         - application/json
13582         - application/xml
13583       responses:
13584         "200":
13585           description: successful operation
13586           schema:
13587               $ref: "#/getDefinitions/customer"
13588         "default":
13589           description: Response codes found in [response codes](https://wiki.onap.org/).
13590       parameters:
13591         - name: global-customer-id
13592           in: path
13593           description: Global customer id used across ECOMP to uniquely identify customer.
13594           required: true
13595           type: string
13596           example: __GLOBAL-CUSTOMER-ID__
13597     put:
13598       tags:
13599         - Business
13600       summary: create or update an existing customer
13601       description: |
13602         Create or update an existing customer.
13603         #
13604         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13605       operationId: createOrUpdateBusinessCustomersCustomer
13606       consumes:
13607         - application/json
13608         - application/xml
13609       produces:
13610         - application/json
13611         - application/xml
13612       responses:
13613         "default":
13614           description: Response codes found in [response codes](https://wiki.onap.org/).
13615       parameters:
13616         - name: global-customer-id
13617           in: path
13618           description: Global customer id used across ECOMP to uniquely identify customer.
13619           required: true
13620           type: string
13621           example: __GLOBAL-CUSTOMER-ID__
13622         - name: body
13623           in: body
13624           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
13625           required: true
13626           schema:
13627             $ref: "#/definitions/customer"
13628     patch:
13629       tags:
13630         - Business
13631       summary: update an existing customer
13632       description: |
13633         Update an existing customer
13634         #
13635         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13636         The PUT operation will entirely replace an existing object.
13637         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13638         #
13639         Other differences between PUT and PATCH are:
13640         #
13641         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13642         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13643         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13644       operationId: UpdateBusinessCustomersCustomer
13645       consumes:
13646         - application/json
13647         - application/xml
13648       produces:
13649         - application/json
13650         - application/xml
13651       responses:
13652         "default":
13653           description: Response codes found in [response codes](https://wiki.onap.org/).
13654       parameters:
13655         - name: global-customer-id
13656           in: path
13657           description: Global customer id used across ECOMP to uniquely identify customer.
13658           required: true
13659           type: string
13660           example: __GLOBAL-CUSTOMER-ID__
13661         - name: body
13662           in: body
13663           description: customer object that needs to be updated.
13664           required: true
13665           schema:
13666             $ref: "#/patchDefinitions/customer"
13667     delete:
13668       tags:
13669         - Business
13670       summary: delete an existing customer
13671       description: delete an existing customer
13672       operationId: deleteBusinessCustomersCustomer
13673       consumes:
13674         - application/json
13675         - application/xml
13676       produces:
13677         - application/json
13678         - application/xml
13679       responses:
13680         "default":
13681           description: Response codes found in [response codes](https://wiki.onap.org/).
13682       parameters:
13683         - name: global-customer-id
13684           in: path
13685           description: Global customer id used across ECOMP to uniquely identify customer.
13686           required: true
13687           type: string
13688           example: __GLOBAL-CUSTOMER-ID__
13689         - name: resource-version
13690           in: query
13691           description: resource-version for concurrency
13692           required: true
13693           type: string
13694   /business/customers:
13695     get:
13696       tags:
13697         - Business
13698       summary: returns customers
13699       description: returns customers
13700       operationId: getBusinessCustomers
13701       produces:
13702         - application/json
13703         - application/xml
13704       responses:
13705         "200":
13706           description: successful operation
13707           schema:
13708               $ref: "#/getDefinitions/customers"
13709         "default":
13710           description: Response codes found in [response codes](https://wiki.onap.org/).
13711       parameters:
13712         - name: global-customer-id
13713           in: query
13714           description:
13715           required: false
13716           type: string
13717         - name: subscriber-name
13718           in: query
13719           description:
13720           required: false
13721           type: string
13722         - name: subscriber-type
13723           in: query
13724           description:
13725           required: false
13726           type: string
13727   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
13728     put:
13729       tags:
13730         - ServiceDesignAndCreation
13731       summary: see node definition for valid relationships
13732       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
13733       consumes:
13734         - application/json
13735         - application/xml
13736       produces:
13737         - application/json
13738         - application/xml
13739       responses:
13740         "default":
13741           description: Response codes found in [response codes](https://wiki.onap.org/).
13742       parameters:
13743         - name: vnf-image-uuid
13744           in: path
13745           description: Unique ID of this asset
13746           required: true
13747           type: string
13748           example: __VNF-IMAGE-UUID__
13749         - name: body
13750           in: body
13751           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
13752           required: true
13753           schema:
13754             $ref: "#/definitions/relationship"
13755     delete:
13756       tags:
13757         - ServiceDesignAndCreation
13758       summary: delete an existing relationship
13759       description: delete an existing relationship
13760       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
13761       consumes:
13762         - application/json
13763         - application/xml
13764       produces:
13765         - application/json
13766         - application/xml
13767       responses:
13768         "default":
13769           description: Response codes found in [response codes](https://wiki.onap.org/).
13770       parameters:
13771         - name: vnf-image-uuid
13772           in: path
13773           description: Unique ID of this asset
13774           required: true
13775           type: string
13776           example: __VNF-IMAGE-UUID__
13777   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
13778     get:
13779       tags:
13780         - ServiceDesignAndCreation
13781       summary: returns vnf-image
13782       description: returns vnf-image
13783       operationId: getServiceDesignAndCreationVnfImagesVnfImage
13784       produces:
13785         - application/json
13786         - application/xml
13787       responses:
13788         "200":
13789           description: successful operation
13790           schema:
13791               $ref: "#/getDefinitions/vnf-image"
13792         "default":
13793           description: Response codes found in [response codes](https://wiki.onap.org/).
13794       parameters:
13795         - name: vnf-image-uuid
13796           in: path
13797           description: Unique ID of this asset
13798           required: true
13799           type: string
13800           example: __VNF-IMAGE-UUID__
13801     put:
13802       tags:
13803         - ServiceDesignAndCreation
13804       summary: create or update an existing vnf-image
13805       description: |
13806         Create or update an existing vnf-image.
13807         #
13808         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13809       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
13810       consumes:
13811         - application/json
13812         - application/xml
13813       produces:
13814         - application/json
13815         - application/xml
13816       responses:
13817         "default":
13818           description: Response codes found in [response codes](https://wiki.onap.org/).
13819       parameters:
13820         - name: vnf-image-uuid
13821           in: path
13822           description: Unique ID of this asset
13823           required: true
13824           type: string
13825           example: __VNF-IMAGE-UUID__
13826         - name: body
13827           in: body
13828           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
13829           required: true
13830           schema:
13831             $ref: "#/definitions/vnf-image"
13832     patch:
13833       tags:
13834         - ServiceDesignAndCreation
13835       summary: update an existing vnf-image
13836       description: |
13837         Update an existing vnf-image
13838         #
13839         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13840         The PUT operation will entirely replace an existing object.
13841         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13842         #
13843         Other differences between PUT and PATCH are:
13844         #
13845         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13846         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13847         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13848       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
13849       consumes:
13850         - application/json
13851         - application/xml
13852       produces:
13853         - application/json
13854         - application/xml
13855       responses:
13856         "default":
13857           description: Response codes found in [response codes](https://wiki.onap.org/).
13858       parameters:
13859         - name: vnf-image-uuid
13860           in: path
13861           description: Unique ID of this asset
13862           required: true
13863           type: string
13864           example: __VNF-IMAGE-UUID__
13865         - name: body
13866           in: body
13867           description: vnf-image object that needs to be updated.
13868           required: true
13869           schema:
13870             $ref: "#/patchDefinitions/vnf-image"
13871     delete:
13872       tags:
13873         - ServiceDesignAndCreation
13874       summary: delete an existing vnf-image
13875       description: delete an existing vnf-image
13876       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
13877       consumes:
13878         - application/json
13879         - application/xml
13880       produces:
13881         - application/json
13882         - application/xml
13883       responses:
13884         "default":
13885           description: Response codes found in [response codes](https://wiki.onap.org/).
13886       parameters:
13887         - name: vnf-image-uuid
13888           in: path
13889           description: Unique ID of this asset
13890           required: true
13891           type: string
13892           example: __VNF-IMAGE-UUID__
13893         - name: resource-version
13894           in: query
13895           description: resource-version for concurrency
13896           required: true
13897           type: string
13898   /service-design-and-creation/vnf-images:
13899     get:
13900       tags:
13901         - ServiceDesignAndCreation
13902       summary: returns vnf-images
13903       description: returns vnf-images
13904       operationId: getServiceDesignAndCreationVnfImages
13905       produces:
13906         - application/json
13907         - application/xml
13908       responses:
13909         "200":
13910           description: successful operation
13911           schema:
13912               $ref: "#/getDefinitions/vnf-images"
13913         "default":
13914           description: Response codes found in [response codes](https://wiki.onap.org/).
13915       parameters:
13916         - name: vnf-image-uuid
13917           in: query
13918           description:
13919           required: false
13920           type: string
13921         - name: application
13922           in: query
13923           description:
13924           required: false
13925           type: string
13926         - name: application-vendor
13927           in: query
13928           description:
13929           required: false
13930           type: string
13931         - name: application-version
13932           in: query
13933           description:
13934           required: false
13935           type: string
13936   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
13937     put:
13938       tags:
13939         - ServiceDesignAndCreation
13940       summary: see node definition for valid relationships
13941       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
13942       consumes:
13943         - application/json
13944         - application/xml
13945       produces:
13946         - application/json
13947         - application/xml
13948       responses:
13949         "default":
13950           description: Response codes found in [response codes](https://wiki.onap.org/).
13951       parameters:
13952         - name: service-id
13953           in: path
13954           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
13955           required: true
13956           type: string
13957           example: __SERVICE-ID__
13958         - name: body
13959           in: body
13960           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
13961           required: true
13962           schema:
13963             $ref: "#/definitions/relationship"
13964     delete:
13965       tags:
13966         - ServiceDesignAndCreation
13967       summary: delete an existing relationship
13968       description: delete an existing relationship
13969       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
13970       consumes:
13971         - application/json
13972         - application/xml
13973       produces:
13974         - application/json
13975         - application/xml
13976       responses:
13977         "default":
13978           description: Response codes found in [response codes](https://wiki.onap.org/).
13979       parameters:
13980         - name: service-id
13981           in: path
13982           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
13983           required: true
13984           type: string
13985           example: __SERVICE-ID__
13986   /service-design-and-creation/services/service/{service-id}:
13987     get:
13988       tags:
13989         - ServiceDesignAndCreation
13990       summary: returns service
13991       description: returns service
13992       operationId: getServiceDesignAndCreationServicesService
13993       produces:
13994         - application/json
13995         - application/xml
13996       responses:
13997         "200":
13998           description: successful operation
13999           schema:
14000               $ref: "#/getDefinitions/service"
14001         "default":
14002           description: Response codes found in [response codes](https://wiki.onap.org/).
14003       parameters:
14004         - name: service-id
14005           in: path
14006           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14007           required: true
14008           type: string
14009           example: __SERVICE-ID__
14010     put:
14011       tags:
14012         - ServiceDesignAndCreation
14013       summary: create or update an existing service
14014       description: |
14015         Create or update an existing service.
14016         #
14017         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14018       operationId: createOrUpdateServiceDesignAndCreationServicesService
14019       consumes:
14020         - application/json
14021         - application/xml
14022       produces:
14023         - application/json
14024         - application/xml
14025       responses:
14026         "default":
14027           description: Response codes found in [response codes](https://wiki.onap.org/).
14028       parameters:
14029         - name: service-id
14030           in: path
14031           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14032           required: true
14033           type: string
14034           example: __SERVICE-ID__
14035         - name: body
14036           in: body
14037           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
14038           required: true
14039           schema:
14040             $ref: "#/definitions/service"
14041     patch:
14042       tags:
14043         - ServiceDesignAndCreation
14044       summary: update an existing service
14045       description: |
14046         Update an existing service
14047         #
14048         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14049         The PUT operation will entirely replace an existing object.
14050         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14051         #
14052         Other differences between PUT and PATCH are:
14053         #
14054         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14055         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14056         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14057       operationId: UpdateServiceDesignAndCreationServicesService
14058       consumes:
14059         - application/json
14060         - application/xml
14061       produces:
14062         - application/json
14063         - application/xml
14064       responses:
14065         "default":
14066           description: Response codes found in [response codes](https://wiki.onap.org/).
14067       parameters:
14068         - name: service-id
14069           in: path
14070           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14071           required: true
14072           type: string
14073           example: __SERVICE-ID__
14074         - name: body
14075           in: body
14076           description: service object that needs to be updated.
14077           required: true
14078           schema:
14079             $ref: "#/patchDefinitions/service"
14080     delete:
14081       tags:
14082         - ServiceDesignAndCreation
14083       summary: delete an existing service
14084       description: delete an existing service
14085       operationId: deleteServiceDesignAndCreationServicesService
14086       consumes:
14087         - application/json
14088         - application/xml
14089       produces:
14090         - application/json
14091         - application/xml
14092       responses:
14093         "default":
14094           description: Response codes found in [response codes](https://wiki.onap.org/).
14095       parameters:
14096         - name: service-id
14097           in: path
14098           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14099           required: true
14100           type: string
14101           example: __SERVICE-ID__
14102         - name: resource-version
14103           in: query
14104           description: resource-version for concurrency
14105           required: true
14106           type: string
14107   /service-design-and-creation/services:
14108     get:
14109       tags:
14110         - ServiceDesignAndCreation
14111       summary: returns services
14112       description: returns services
14113       operationId: getServiceDesignAndCreationServices
14114       produces:
14115         - application/json
14116         - application/xml
14117       responses:
14118         "200":
14119           description: successful operation
14120           schema:
14121               $ref: "#/getDefinitions/services"
14122         "default":
14123           description: Response codes found in [response codes](https://wiki.onap.org/).
14124       parameters:
14125         - name: service-id
14126           in: query
14127           description:
14128           required: false
14129           type: string
14130         - name: service-description
14131           in: query
14132           description:
14133           required: false
14134           type: string
14135   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14136     put:
14137       tags:
14138         - ServiceDesignAndCreation
14139       summary: see node definition for valid relationships
14140       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14141       consumes:
14142         - application/json
14143         - application/xml
14144       produces:
14145         - application/json
14146         - application/xml
14147       responses:
14148         "default":
14149           description: Response codes found in [response codes](https://wiki.onap.org/).
14150       parameters:
14151         - name: service-type
14152           in: path
14153           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14154           required: true
14155           type: string
14156           example: __SERVICE-TYPE__
14157         - name: vnf-type
14158           in: path
14159           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14160           required: true
14161           type: string
14162           example: __VNF-TYPE__
14163         - name: body
14164           in: body
14165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14166           required: true
14167           schema:
14168             $ref: "#/definitions/relationship"
14169     delete:
14170       tags:
14171         - ServiceDesignAndCreation
14172       summary: delete an existing relationship
14173       description: delete an existing relationship
14174       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14175       consumes:
14176         - application/json
14177         - application/xml
14178       produces:
14179         - application/json
14180         - application/xml
14181       responses:
14182         "default":
14183           description: Response codes found in [response codes](https://wiki.onap.org/).
14184       parameters:
14185         - name: service-type
14186           in: path
14187           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14188           required: true
14189           type: string
14190           example: __SERVICE-TYPE__
14191         - name: vnf-type
14192           in: path
14193           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14194           required: true
14195           type: string
14196           example: __VNF-TYPE__
14197   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14198     get:
14199       tags:
14200         - ServiceDesignAndCreation
14201       summary: returns service-capability
14202       description: returns service-capability
14203       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14204       produces:
14205         - application/json
14206         - application/xml
14207       responses:
14208         "200":
14209           description: successful operation
14210           schema:
14211               $ref: "#/getDefinitions/service-capability"
14212         "default":
14213           description: Response codes found in [response codes](https://wiki.onap.org/).
14214       parameters:
14215         - name: service-type
14216           in: path
14217           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14218           required: true
14219           type: string
14220           example: __SERVICE-TYPE__
14221         - name: vnf-type
14222           in: path
14223           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14224           required: true
14225           type: string
14226           example: __VNF-TYPE__
14227     put:
14228       tags:
14229         - ServiceDesignAndCreation
14230       summary: create or update an existing service-capability
14231       description: |
14232         Create or update an existing service-capability.
14233         #
14234         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14235       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14236       consumes:
14237         - application/json
14238         - application/xml
14239       produces:
14240         - application/json
14241         - application/xml
14242       responses:
14243         "default":
14244           description: Response codes found in [response codes](https://wiki.onap.org/).
14245       parameters:
14246         - name: service-type
14247           in: path
14248           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14249           required: true
14250           type: string
14251           example: __SERVICE-TYPE__
14252         - name: vnf-type
14253           in: path
14254           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14255           required: true
14256           type: string
14257           example: __VNF-TYPE__
14258         - name: body
14259           in: body
14260           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14261           required: true
14262           schema:
14263             $ref: "#/definitions/service-capability"
14264     patch:
14265       tags:
14266         - ServiceDesignAndCreation
14267       summary: update an existing service-capability
14268       description: |
14269         Update an existing service-capability
14270         #
14271         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14272         The PUT operation will entirely replace an existing object.
14273         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14274         #
14275         Other differences between PUT and PATCH are:
14276         #
14277         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14278         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14279         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14280       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14281       consumes:
14282         - application/json
14283         - application/xml
14284       produces:
14285         - application/json
14286         - application/xml
14287       responses:
14288         "default":
14289           description: Response codes found in [response codes](https://wiki.onap.org/).
14290       parameters:
14291         - name: service-type
14292           in: path
14293           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14294           required: true
14295           type: string
14296           example: __SERVICE-TYPE__
14297         - name: vnf-type
14298           in: path
14299           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14300           required: true
14301           type: string
14302           example: __VNF-TYPE__
14303         - name: body
14304           in: body
14305           description: service-capability object that needs to be updated.
14306           required: true
14307           schema:
14308             $ref: "#/patchDefinitions/service-capability"
14309     delete:
14310       tags:
14311         - ServiceDesignAndCreation
14312       summary: delete an existing service-capability
14313       description: delete an existing service-capability
14314       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
14315       consumes:
14316         - application/json
14317         - application/xml
14318       produces:
14319         - application/json
14320         - application/xml
14321       responses:
14322         "default":
14323           description: Response codes found in [response codes](https://wiki.onap.org/).
14324       parameters:
14325         - name: service-type
14326           in: path
14327           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14328           required: true
14329           type: string
14330           example: __SERVICE-TYPE__
14331         - name: vnf-type
14332           in: path
14333           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
14334           required: true
14335           type: string
14336           example: __VNF-TYPE__
14337         - name: resource-version
14338           in: query
14339           description: resource-version for concurrency
14340           required: true
14341           type: string
14342   /service-design-and-creation/service-capabilities:
14343     get:
14344       tags:
14345         - ServiceDesignAndCreation
14346       summary: returns service-capabilities
14347       description: returns service-capabilities
14348       operationId: getServiceDesignAndCreationServiceCapabilities
14349       produces:
14350         - application/json
14351         - application/xml
14352       responses:
14353         "200":
14354           description: successful operation
14355           schema:
14356               $ref: "#/getDefinitions/service-capabilities"
14357         "default":
14358           description: Response codes found in [response codes](https://wiki.onap.org/).
14359       parameters:
14360         - name: service-type
14361           in: query
14362           description:
14363           required: false
14364           type: string
14365         - name: vnf-type
14366           in: query
14367           description:
14368           required: false
14369           type: string
14370   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
14371     put:
14372       tags:
14373         - ServiceDesignAndCreation
14374       summary: see node definition for valid relationships
14375       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
14376       consumes:
14377         - application/json
14378         - application/xml
14379       produces:
14380         - application/json
14381         - application/xml
14382       responses:
14383         "default":
14384           description: Response codes found in [response codes](https://wiki.onap.org/).
14385       parameters:
14386         - name: model-name-version-id
14387           in: path
14388           description: Unique identifier corresponding to one version of a model in ASDC
14389           required: true
14390           type: string
14391           example: __MODEL-NAME-VERSION-ID__
14392         - name: model-element-uuid
14393           in: path
14394           required: true
14395           type: string
14396           example: __MODEL-ELEMENT-UUID__
14397         - name: model-constraint-uuid
14398           in: path
14399           required: true
14400           type: string
14401           example: __MODEL-CONSTRAINT-UUID__
14402         - name: constrained-element-set-uuid
14403           in: path
14404           required: true
14405           type: string
14406           example: __CONSTRAINED-ELEMENT-SET-UUID__
14407         - name: element-choice-set-uuid
14408           in: path
14409           required: true
14410           type: string
14411           example: __ELEMENT-CHOICE-SET-UUID__
14412         - name: body
14413           in: body
14414           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
14415           required: true
14416           schema:
14417             $ref: "#/definitions/relationship"
14418     delete:
14419       tags:
14420         - ServiceDesignAndCreation
14421       summary: delete an existing relationship
14422       description: delete an existing relationship
14423       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
14424       consumes:
14425         - application/json
14426         - application/xml
14427       produces:
14428         - application/json
14429         - application/xml
14430       responses:
14431         "default":
14432           description: Response codes found in [response codes](https://wiki.onap.org/).
14433       parameters:
14434         - name: model-name-version-id
14435           in: path
14436           description: Unique identifier corresponding to one version of a model in ASDC
14437           required: true
14438           type: string
14439           example: __MODEL-NAME-VERSION-ID__
14440         - name: model-element-uuid
14441           in: path
14442           required: true
14443           type: string
14444           example: __MODEL-ELEMENT-UUID__
14445         - name: model-constraint-uuid
14446           in: path
14447           required: true
14448           type: string
14449           example: __MODEL-CONSTRAINT-UUID__
14450         - name: constrained-element-set-uuid
14451           in: path
14452           required: true
14453           type: string
14454           example: __CONSTRAINED-ELEMENT-SET-UUID__
14455         - name: element-choice-set-uuid
14456           in: path
14457           required: true
14458           type: string
14459           example: __ELEMENT-CHOICE-SET-UUID__
14460   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
14461     get:
14462       tags:
14463         - ServiceDesignAndCreation
14464       summary: returns element-choice-set
14465       description: returns element-choice-set
14466       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14467       produces:
14468         - application/json
14469         - application/xml
14470       responses:
14471         "200":
14472           description: successful operation
14473           schema:
14474               $ref: "#/getDefinitions/element-choice-set"
14475         "default":
14476           description: Response codes found in [response codes](https://wiki.onap.org/).
14477       parameters:
14478         - name: model-name-version-id
14479           in: path
14480           description: Unique identifier corresponding to one version of a model in ASDC
14481           required: true
14482           type: string
14483           example: __MODEL-NAME-VERSION-ID__
14484         - name: model-element-uuid
14485           in: path
14486           required: true
14487           type: string
14488           example: __MODEL-ELEMENT-UUID__
14489         - name: model-constraint-uuid
14490           in: path
14491           required: true
14492           type: string
14493           example: __MODEL-CONSTRAINT-UUID__
14494         - name: constrained-element-set-uuid
14495           in: path
14496           required: true
14497           type: string
14498           example: __CONSTRAINED-ELEMENT-SET-UUID__
14499         - name: element-choice-set-uuid
14500           in: path
14501           required: true
14502           type: string
14503           example: __ELEMENT-CHOICE-SET-UUID__
14504     put:
14505       tags:
14506         - ServiceDesignAndCreation
14507       summary: create or update an existing element-choice-set
14508       description: |
14509         Create or update an existing element-choice-set.
14510         #
14511         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14512       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14513       consumes:
14514         - application/json
14515         - application/xml
14516       produces:
14517         - application/json
14518         - application/xml
14519       responses:
14520         "default":
14521           description: Response codes found in [response codes](https://wiki.onap.org/).
14522       parameters:
14523         - name: model-name-version-id
14524           in: path
14525           description: Unique identifier corresponding to one version of a model in ASDC
14526           required: true
14527           type: string
14528           example: __MODEL-NAME-VERSION-ID__
14529         - name: model-element-uuid
14530           in: path
14531           required: true
14532           type: string
14533           example: __MODEL-ELEMENT-UUID__
14534         - name: model-constraint-uuid
14535           in: path
14536           required: true
14537           type: string
14538           example: __MODEL-CONSTRAINT-UUID__
14539         - name: constrained-element-set-uuid
14540           in: path
14541           required: true
14542           type: string
14543           example: __CONSTRAINED-ELEMENT-SET-UUID__
14544         - name: element-choice-set-uuid
14545           in: path
14546           required: true
14547           type: string
14548           example: __ELEMENT-CHOICE-SET-UUID__
14549         - name: body
14550           in: body
14551           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
14552           required: true
14553           schema:
14554             $ref: "#/definitions/element-choice-set"
14555     patch:
14556       tags:
14557         - ServiceDesignAndCreation
14558       summary: update an existing element-choice-set
14559       description: |
14560         Update an existing element-choice-set
14561         #
14562         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14563         The PUT operation will entirely replace an existing object.
14564         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14565         #
14566         Other differences between PUT and PATCH are:
14567         #
14568         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14569         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14570         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14571       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14572       consumes:
14573         - application/json
14574         - application/xml
14575       produces:
14576         - application/json
14577         - application/xml
14578       responses:
14579         "default":
14580           description: Response codes found in [response codes](https://wiki.onap.org/).
14581       parameters:
14582         - name: model-name-version-id
14583           in: path
14584           description: Unique identifier corresponding to one version of a model in ASDC
14585           required: true
14586           type: string
14587           example: __MODEL-NAME-VERSION-ID__
14588         - name: model-element-uuid
14589           in: path
14590           required: true
14591           type: string
14592           example: __MODEL-ELEMENT-UUID__
14593         - name: model-constraint-uuid
14594           in: path
14595           required: true
14596           type: string
14597           example: __MODEL-CONSTRAINT-UUID__
14598         - name: constrained-element-set-uuid
14599           in: path
14600           required: true
14601           type: string
14602           example: __CONSTRAINED-ELEMENT-SET-UUID__
14603         - name: element-choice-set-uuid
14604           in: path
14605           required: true
14606           type: string
14607           example: __ELEMENT-CHOICE-SET-UUID__
14608         - name: body
14609           in: body
14610           description: element-choice-set object that needs to be updated.
14611           required: true
14612           schema:
14613             $ref: "#/patchDefinitions/element-choice-set"
14614     delete:
14615       tags:
14616         - ServiceDesignAndCreation
14617       summary: delete an existing element-choice-set
14618       description: delete an existing element-choice-set
14619       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14620       consumes:
14621         - application/json
14622         - application/xml
14623       produces:
14624         - application/json
14625         - application/xml
14626       responses:
14627         "default":
14628           description: Response codes found in [response codes](https://wiki.onap.org/).
14629       parameters:
14630         - name: model-name-version-id
14631           in: path
14632           description: Unique identifier corresponding to one version of a model in ASDC
14633           required: true
14634           type: string
14635           example: __MODEL-NAME-VERSION-ID__
14636         - name: model-element-uuid
14637           in: path
14638           required: true
14639           type: string
14640           example: __MODEL-ELEMENT-UUID__
14641         - name: model-constraint-uuid
14642           in: path
14643           required: true
14644           type: string
14645           example: __MODEL-CONSTRAINT-UUID__
14646         - name: constrained-element-set-uuid
14647           in: path
14648           required: true
14649           type: string
14650           example: __CONSTRAINED-ELEMENT-SET-UUID__
14651         - name: element-choice-set-uuid
14652           in: path
14653           required: true
14654           type: string
14655           example: __ELEMENT-CHOICE-SET-UUID__
14656         - name: resource-version
14657           in: query
14658           description: resource-version for concurrency
14659           required: true
14660           type: string
14661   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
14662     get:
14663       tags:
14664         - ServiceDesignAndCreation
14665       summary: returns element-choice-sets
14666       description: returns element-choice-sets
14667       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
14668       produces:
14669         - application/json
14670         - application/xml
14671       responses:
14672         "200":
14673           description: successful operation
14674           schema:
14675               $ref: "#/getDefinitions/element-choice-sets"
14676         "default":
14677           description: Response codes found in [response codes](https://wiki.onap.org/).
14678       parameters:
14679         - name: model-name-version-id
14680           in: path
14681           description: Unique identifier corresponding to one version of a model in ASDC
14682           required: true
14683           type: string
14684           example: __MODEL-NAME-VERSION-ID__
14685         - name: model-element-uuid
14686           in: path
14687           required: true
14688           type: string
14689           example: __MODEL-ELEMENT-UUID__
14690         - name: model-constraint-uuid
14691           in: path
14692           required: true
14693           type: string
14694           example: __MODEL-CONSTRAINT-UUID__
14695         - name: constrained-element-set-uuid
14696           in: path
14697           required: true
14698           type: string
14699           example: __CONSTRAINED-ELEMENT-SET-UUID__
14700         - name: element-choice-set-uuid
14701           in: query
14702           description:
14703           required: false
14704           type: string
14705   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
14706     put:
14707       tags:
14708         - ServiceDesignAndCreation
14709       summary: see node definition for valid relationships
14710       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
14711       consumes:
14712         - application/json
14713         - application/xml
14714       produces:
14715         - application/json
14716         - application/xml
14717       responses:
14718         "default":
14719           description: Response codes found in [response codes](https://wiki.onap.org/).
14720       parameters:
14721         - name: model-name-version-id
14722           in: path
14723           description: Unique identifier corresponding to one version of a model in ASDC
14724           required: true
14725           type: string
14726           example: __MODEL-NAME-VERSION-ID__
14727         - name: model-element-uuid
14728           in: path
14729           required: true
14730           type: string
14731           example: __MODEL-ELEMENT-UUID__
14732         - name: model-constraint-uuid
14733           in: path
14734           required: true
14735           type: string
14736           example: __MODEL-CONSTRAINT-UUID__
14737         - name: constrained-element-set-uuid
14738           in: path
14739           required: true
14740           type: string
14741           example: __CONSTRAINED-ELEMENT-SET-UUID__
14742         - name: body
14743           in: body
14744           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
14745           required: true
14746           schema:
14747             $ref: "#/definitions/relationship"
14748     delete:
14749       tags:
14750         - ServiceDesignAndCreation
14751       summary: delete an existing relationship
14752       description: delete an existing relationship
14753       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
14754       consumes:
14755         - application/json
14756         - application/xml
14757       produces:
14758         - application/json
14759         - application/xml
14760       responses:
14761         "default":
14762           description: Response codes found in [response codes](https://wiki.onap.org/).
14763       parameters:
14764         - name: model-name-version-id
14765           in: path
14766           description: Unique identifier corresponding to one version of a model in ASDC
14767           required: true
14768           type: string
14769           example: __MODEL-NAME-VERSION-ID__
14770         - name: model-element-uuid
14771           in: path
14772           required: true
14773           type: string
14774           example: __MODEL-ELEMENT-UUID__
14775         - name: model-constraint-uuid
14776           in: path
14777           required: true
14778           type: string
14779           example: __MODEL-CONSTRAINT-UUID__
14780         - name: constrained-element-set-uuid
14781           in: path
14782           required: true
14783           type: string
14784           example: __CONSTRAINED-ELEMENT-SET-UUID__
14785   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
14786     get:
14787       tags:
14788         - ServiceDesignAndCreation
14789       summary: returns constrained-element-set
14790       description: returns constrained-element-set
14791       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14792       produces:
14793         - application/json
14794         - application/xml
14795       responses:
14796         "200":
14797           description: successful operation
14798           schema:
14799               $ref: "#/getDefinitions/constrained-element-set"
14800         "default":
14801           description: Response codes found in [response codes](https://wiki.onap.org/).
14802       parameters:
14803         - name: model-name-version-id
14804           in: path
14805           description: Unique identifier corresponding to one version of a model in ASDC
14806           required: true
14807           type: string
14808           example: __MODEL-NAME-VERSION-ID__
14809         - name: model-element-uuid
14810           in: path
14811           required: true
14812           type: string
14813           example: __MODEL-ELEMENT-UUID__
14814         - name: model-constraint-uuid
14815           in: path
14816           required: true
14817           type: string
14818           example: __MODEL-CONSTRAINT-UUID__
14819         - name: constrained-element-set-uuid
14820           in: path
14821           required: true
14822           type: string
14823           example: __CONSTRAINED-ELEMENT-SET-UUID__
14824     put:
14825       tags:
14826         - ServiceDesignAndCreation
14827       summary: create or update an existing constrained-element-set
14828       description: |
14829         Create or update an existing constrained-element-set.
14830         #
14831         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14832       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14833       consumes:
14834         - application/json
14835         - application/xml
14836       produces:
14837         - application/json
14838         - application/xml
14839       responses:
14840         "default":
14841           description: Response codes found in [response codes](https://wiki.onap.org/).
14842       parameters:
14843         - name: model-name-version-id
14844           in: path
14845           description: Unique identifier corresponding to one version of a model in ASDC
14846           required: true
14847           type: string
14848           example: __MODEL-NAME-VERSION-ID__
14849         - name: model-element-uuid
14850           in: path
14851           required: true
14852           type: string
14853           example: __MODEL-ELEMENT-UUID__
14854         - name: model-constraint-uuid
14855           in: path
14856           required: true
14857           type: string
14858           example: __MODEL-CONSTRAINT-UUID__
14859         - name: constrained-element-set-uuid
14860           in: path
14861           required: true
14862           type: string
14863           example: __CONSTRAINED-ELEMENT-SET-UUID__
14864         - name: body
14865           in: body
14866           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
14867           required: true
14868           schema:
14869             $ref: "#/definitions/constrained-element-set"
14870     patch:
14871       tags:
14872         - ServiceDesignAndCreation
14873       summary: update an existing constrained-element-set
14874       description: |
14875         Update an existing constrained-element-set
14876         #
14877         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14878         The PUT operation will entirely replace an existing object.
14879         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14880         #
14881         Other differences between PUT and PATCH are:
14882         #
14883         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14884         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14885         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14886       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14887       consumes:
14888         - application/json
14889         - application/xml
14890       produces:
14891         - application/json
14892         - application/xml
14893       responses:
14894         "default":
14895           description: Response codes found in [response codes](https://wiki.onap.org/).
14896       parameters:
14897         - name: model-name-version-id
14898           in: path
14899           description: Unique identifier corresponding to one version of a model in ASDC
14900           required: true
14901           type: string
14902           example: __MODEL-NAME-VERSION-ID__
14903         - name: model-element-uuid
14904           in: path
14905           required: true
14906           type: string
14907           example: __MODEL-ELEMENT-UUID__
14908         - name: model-constraint-uuid
14909           in: path
14910           required: true
14911           type: string
14912           example: __MODEL-CONSTRAINT-UUID__
14913         - name: constrained-element-set-uuid
14914           in: path
14915           required: true
14916           type: string
14917           example: __CONSTRAINED-ELEMENT-SET-UUID__
14918         - name: body
14919           in: body
14920           description: constrained-element-set object that needs to be updated.
14921           required: true
14922           schema:
14923             $ref: "#/patchDefinitions/constrained-element-set"
14924     delete:
14925       tags:
14926         - ServiceDesignAndCreation
14927       summary: delete an existing constrained-element-set
14928       description: delete an existing constrained-element-set
14929       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14930       consumes:
14931         - application/json
14932         - application/xml
14933       produces:
14934         - application/json
14935         - application/xml
14936       responses:
14937         "default":
14938           description: Response codes found in [response codes](https://wiki.onap.org/).
14939       parameters:
14940         - name: model-name-version-id
14941           in: path
14942           description: Unique identifier corresponding to one version of a model in ASDC
14943           required: true
14944           type: string
14945           example: __MODEL-NAME-VERSION-ID__
14946         - name: model-element-uuid
14947           in: path
14948           required: true
14949           type: string
14950           example: __MODEL-ELEMENT-UUID__
14951         - name: model-constraint-uuid
14952           in: path
14953           required: true
14954           type: string
14955           example: __MODEL-CONSTRAINT-UUID__
14956         - name: constrained-element-set-uuid
14957           in: path
14958           required: true
14959           type: string
14960           example: __CONSTRAINED-ELEMENT-SET-UUID__
14961         - name: resource-version
14962           in: query
14963           description: resource-version for concurrency
14964           required: true
14965           type: string
14966   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
14967     get:
14968       tags:
14969         - ServiceDesignAndCreation
14970       summary: returns constrained-element-sets
14971       description: returns constrained-element-sets
14972       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
14973       produces:
14974         - application/json
14975         - application/xml
14976       responses:
14977         "200":
14978           description: successful operation
14979           schema:
14980               $ref: "#/getDefinitions/constrained-element-sets"
14981         "default":
14982           description: Response codes found in [response codes](https://wiki.onap.org/).
14983       parameters:
14984         - name: model-name-version-id
14985           in: path
14986           description: Unique identifier corresponding to one version of a model in ASDC
14987           required: true
14988           type: string
14989           example: __MODEL-NAME-VERSION-ID__
14990         - name: model-element-uuid
14991           in: path
14992           required: true
14993           type: string
14994           example: __MODEL-ELEMENT-UUID__
14995         - name: model-constraint-uuid
14996           in: path
14997           required: true
14998           type: string
14999           example: __MODEL-CONSTRAINT-UUID__
15000         - name: constrained-element-set-uuid
15001           in: query
15002           description:
15003           required: false
15004           type: string
15005   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
15006     get:
15007       tags:
15008         - ServiceDesignAndCreation
15009       summary: returns model-constraint
15010       description: returns model-constraint
15011       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15012       produces:
15013         - application/json
15014         - application/xml
15015       responses:
15016         "200":
15017           description: successful operation
15018           schema:
15019               $ref: "#/getDefinitions/model-constraint"
15020         "default":
15021           description: Response codes found in [response codes](https://wiki.onap.org/).
15022       parameters:
15023         - name: model-name-version-id
15024           in: path
15025           description: Unique identifier corresponding to one version of a model in ASDC
15026           required: true
15027           type: string
15028           example: __MODEL-NAME-VERSION-ID__
15029         - name: model-element-uuid
15030           in: path
15031           required: true
15032           type: string
15033           example: __MODEL-ELEMENT-UUID__
15034         - name: model-constraint-uuid
15035           in: path
15036           required: true
15037           type: string
15038           example: __MODEL-CONSTRAINT-UUID__
15039     put:
15040       tags:
15041         - ServiceDesignAndCreation
15042       summary: create or update an existing model-constraint
15043       description: |
15044         Create or update an existing model-constraint.
15045         #
15046         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15047       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15048       consumes:
15049         - application/json
15050         - application/xml
15051       produces:
15052         - application/json
15053         - application/xml
15054       responses:
15055         "default":
15056           description: Response codes found in [response codes](https://wiki.onap.org/).
15057       parameters:
15058         - name: model-name-version-id
15059           in: path
15060           description: Unique identifier corresponding to one version of a model in ASDC
15061           required: true
15062           type: string
15063           example: __MODEL-NAME-VERSION-ID__
15064         - name: model-element-uuid
15065           in: path
15066           required: true
15067           type: string
15068           example: __MODEL-ELEMENT-UUID__
15069         - name: model-constraint-uuid
15070           in: path
15071           required: true
15072           type: string
15073           example: __MODEL-CONSTRAINT-UUID__
15074         - name: body
15075           in: body
15076           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)
15077           required: true
15078           schema:
15079             $ref: "#/definitions/model-constraint"
15080     patch:
15081       tags:
15082         - ServiceDesignAndCreation
15083       summary: update an existing model-constraint
15084       description: |
15085         Update an existing model-constraint
15086         #
15087         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15088         The PUT operation will entirely replace an existing object.
15089         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15090         #
15091         Other differences between PUT and PATCH are:
15092         #
15093         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15094         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15095         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15096       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15097       consumes:
15098         - application/json
15099         - application/xml
15100       produces:
15101         - application/json
15102         - application/xml
15103       responses:
15104         "default":
15105           description: Response codes found in [response codes](https://wiki.onap.org/).
15106       parameters:
15107         - name: model-name-version-id
15108           in: path
15109           description: Unique identifier corresponding to one version of a model in ASDC
15110           required: true
15111           type: string
15112           example: __MODEL-NAME-VERSION-ID__
15113         - name: model-element-uuid
15114           in: path
15115           required: true
15116           type: string
15117           example: __MODEL-ELEMENT-UUID__
15118         - name: model-constraint-uuid
15119           in: path
15120           required: true
15121           type: string
15122           example: __MODEL-CONSTRAINT-UUID__
15123         - name: body
15124           in: body
15125           description: model-constraint object that needs to be updated.
15126           required: true
15127           schema:
15128             $ref: "#/patchDefinitions/model-constraint"
15129     delete:
15130       tags:
15131         - ServiceDesignAndCreation
15132       summary: delete an existing model-constraint
15133       description: delete an existing model-constraint
15134       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15135       consumes:
15136         - application/json
15137         - application/xml
15138       produces:
15139         - application/json
15140         - application/xml
15141       responses:
15142         "default":
15143           description: Response codes found in [response codes](https://wiki.onap.org/).
15144       parameters:
15145         - name: model-name-version-id
15146           in: path
15147           description: Unique identifier corresponding to one version of a model in ASDC
15148           required: true
15149           type: string
15150           example: __MODEL-NAME-VERSION-ID__
15151         - name: model-element-uuid
15152           in: path
15153           required: true
15154           type: string
15155           example: __MODEL-ELEMENT-UUID__
15156         - name: model-constraint-uuid
15157           in: path
15158           required: true
15159           type: string
15160           example: __MODEL-CONSTRAINT-UUID__
15161         - name: resource-version
15162           in: query
15163           description: resource-version for concurrency
15164           required: true
15165           type: string
15166   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
15167     get:
15168       tags:
15169         - ServiceDesignAndCreation
15170       summary: returns model-constraints
15171       description: returns model-constraints
15172       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraints
15173       produces:
15174         - application/json
15175         - application/xml
15176       responses:
15177         "200":
15178           description: successful operation
15179           schema:
15180               $ref: "#/getDefinitions/model-constraints"
15181         "default":
15182           description: Response codes found in [response codes](https://wiki.onap.org/).
15183       parameters:
15184         - name: model-name-version-id
15185           in: path
15186           description: Unique identifier corresponding to one version of a model in ASDC
15187           required: true
15188           type: string
15189           example: __MODEL-NAME-VERSION-ID__
15190         - name: model-element-uuid
15191           in: path
15192           required: true
15193           type: string
15194           example: __MODEL-ELEMENT-UUID__
15195         - name: model-constraint-uuid
15196           in: query
15197           description:
15198           required: false
15199           type: string
15200   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
15201     put:
15202       tags:
15203         - ServiceDesignAndCreation
15204       summary: see node definition for valid relationships
15205       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
15206       consumes:
15207         - application/json
15208         - application/xml
15209       produces:
15210         - application/json
15211         - application/xml
15212       responses:
15213         "default":
15214           description: Response codes found in [response codes](https://wiki.onap.org/).
15215       parameters:
15216         - name: model-name-version-id
15217           in: path
15218           description: Unique identifier corresponding to one version of a model in ASDC
15219           required: true
15220           type: string
15221           example: __MODEL-NAME-VERSION-ID__
15222         - name: model-element-uuid
15223           in: path
15224           required: true
15225           type: string
15226           example: __MODEL-ELEMENT-UUID__
15227         - name: body
15228           in: body
15229           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
15230           required: true
15231           schema:
15232             $ref: "#/definitions/relationship"
15233     delete:
15234       tags:
15235         - ServiceDesignAndCreation
15236       summary: delete an existing relationship
15237       description: delete an existing relationship
15238       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
15239       consumes:
15240         - application/json
15241         - application/xml
15242       produces:
15243         - application/json
15244         - application/xml
15245       responses:
15246         "default":
15247           description: Response codes found in [response codes](https://wiki.onap.org/).
15248       parameters:
15249         - name: model-name-version-id
15250           in: path
15251           description: Unique identifier corresponding to one version of a model in ASDC
15252           required: true
15253           type: string
15254           example: __MODEL-NAME-VERSION-ID__
15255         - name: model-element-uuid
15256           in: path
15257           required: true
15258           type: string
15259           example: __MODEL-ELEMENT-UUID__
15260   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}:
15261     get:
15262       tags:
15263         - ServiceDesignAndCreation
15264       summary: returns model-element
15265       description: returns model-element
15266       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElement
15267       produces:
15268         - application/json
15269         - application/xml
15270       responses:
15271         "200":
15272           description: successful operation
15273           schema:
15274               $ref: "#/getDefinitions/model-element"
15275         "default":
15276           description: Response codes found in [response codes](https://wiki.onap.org/).
15277       parameters:
15278         - name: model-name-version-id
15279           in: path
15280           description: Unique identifier corresponding to one version of a model in ASDC
15281           required: true
15282           type: string
15283           example: __MODEL-NAME-VERSION-ID__
15284         - name: model-element-uuid
15285           in: path
15286           required: true
15287           type: string
15288           example: __MODEL-ELEMENT-UUID__
15289     put:
15290       tags:
15291         - ServiceDesignAndCreation
15292       summary: create or update an existing model-element
15293       description: |
15294         Create or update an existing model-element.
15295         #
15296         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15297       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElement
15298       consumes:
15299         - application/json
15300         - application/xml
15301       produces:
15302         - application/json
15303         - application/xml
15304       responses:
15305         "default":
15306           description: Response codes found in [response codes](https://wiki.onap.org/).
15307       parameters:
15308         - name: model-name-version-id
15309           in: path
15310           description: Unique identifier corresponding to one version of a model in ASDC
15311           required: true
15312           type: string
15313           example: __MODEL-NAME-VERSION-ID__
15314         - name: model-element-uuid
15315           in: path
15316           required: true
15317           type: string
15318           example: __MODEL-ELEMENT-UUID__
15319         - name: body
15320           in: body
15321           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
15322           required: true
15323           schema:
15324             $ref: "#/definitions/model-element"
15325     patch:
15326       tags:
15327         - ServiceDesignAndCreation
15328       summary: update an existing model-element
15329       description: |
15330         Update an existing model-element
15331         #
15332         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15333         The PUT operation will entirely replace an existing object.
15334         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15335         #
15336         Other differences between PUT and PATCH are:
15337         #
15338         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15339         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15340         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15341       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElement
15342       consumes:
15343         - application/json
15344         - application/xml
15345       produces:
15346         - application/json
15347         - application/xml
15348       responses:
15349         "default":
15350           description: Response codes found in [response codes](https://wiki.onap.org/).
15351       parameters:
15352         - name: model-name-version-id
15353           in: path
15354           description: Unique identifier corresponding to one version of a model in ASDC
15355           required: true
15356           type: string
15357           example: __MODEL-NAME-VERSION-ID__
15358         - name: model-element-uuid
15359           in: path
15360           required: true
15361           type: string
15362           example: __MODEL-ELEMENT-UUID__
15363         - name: body
15364           in: body
15365           description: model-element object that needs to be updated.
15366           required: true
15367           schema:
15368             $ref: "#/patchDefinitions/model-element"
15369     delete:
15370       tags:
15371         - ServiceDesignAndCreation
15372       summary: delete an existing model-element
15373       description: delete an existing model-element
15374       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElement
15375       consumes:
15376         - application/json
15377         - application/xml
15378       produces:
15379         - application/json
15380         - application/xml
15381       responses:
15382         "default":
15383           description: Response codes found in [response codes](https://wiki.onap.org/).
15384       parameters:
15385         - name: model-name-version-id
15386           in: path
15387           description: Unique identifier corresponding to one version of a model in ASDC
15388           required: true
15389           type: string
15390           example: __MODEL-NAME-VERSION-ID__
15391         - name: model-element-uuid
15392           in: path
15393           required: true
15394           type: string
15395           example: __MODEL-ELEMENT-UUID__
15396         - name: resource-version
15397           in: query
15398           description: resource-version for concurrency
15399           required: true
15400           type: string
15401   /service-design-and-creation/models/model/{model-name-version-id}/model-elements:
15402     get:
15403       tags:
15404         - ServiceDesignAndCreation
15405       summary: returns model-elements
15406       description: returns model-elements
15407       operationId: getServiceDesignAndCreationModelsModelModelElements
15408       produces:
15409         - application/json
15410         - application/xml
15411       responses:
15412         "200":
15413           description: successful operation
15414           schema:
15415               $ref: "#/getDefinitions/model-elements"
15416         "default":
15417           description: Response codes found in [response codes](https://wiki.onap.org/).
15418       parameters:
15419         - name: model-name-version-id
15420           in: path
15421           description: Unique identifier corresponding to one version of a model in ASDC
15422           required: true
15423           type: string
15424           example: __MODEL-NAME-VERSION-ID__
15425         - name: model-element-uuid
15426           in: query
15427           description:
15428           required: false
15429           type: string
15430   /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}:
15431     get:
15432       tags:
15433         - ServiceDesignAndCreation
15434       summary: returns metadatum
15435       description: returns metadatum
15436       operationId: getServiceDesignAndCreationModelsModelMetadataMetadatum
15437       produces:
15438         - application/json
15439         - application/xml
15440       responses:
15441         "200":
15442           description: successful operation
15443           schema:
15444               $ref: "#/getDefinitions/metadatum"
15445         "default":
15446           description: Response codes found in [response codes](https://wiki.onap.org/).
15447       parameters:
15448         - name: model-name-version-id
15449           in: path
15450           description: Unique identifier corresponding to one version of a model in ASDC
15451           required: true
15452           type: string
15453           example: __MODEL-NAME-VERSION-ID__
15454         - name: metaname
15455           in: path
15456           required: true
15457           type: string
15458           example: __METANAME__
15459     put:
15460       tags:
15461         - ServiceDesignAndCreation
15462       summary: create or update an existing metadatum
15463       description: |
15464         Create or update an existing metadatum.
15465         #
15466         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15467       operationId: createOrUpdateServiceDesignAndCreationModelsModelMetadataMetadatum
15468       consumes:
15469         - application/json
15470         - application/xml
15471       produces:
15472         - application/json
15473         - application/xml
15474       responses:
15475         "default":
15476           description: Response codes found in [response codes](https://wiki.onap.org/).
15477       parameters:
15478         - name: model-name-version-id
15479           in: path
15480           description: Unique identifier corresponding to one version of a model in ASDC
15481           required: true
15482           type: string
15483           example: __MODEL-NAME-VERSION-ID__
15484         - name: metaname
15485           in: path
15486           required: true
15487           type: string
15488           example: __METANAME__
15489         - name: body
15490           in: body
15491           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)
15492           required: true
15493           schema:
15494             $ref: "#/definitions/metadatum"
15495     patch:
15496       tags:
15497         - ServiceDesignAndCreation
15498       summary: update an existing metadatum
15499       description: |
15500         Update an existing metadatum
15501         #
15502         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15503         The PUT operation will entirely replace an existing object.
15504         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15505         #
15506         Other differences between PUT and PATCH are:
15507         #
15508         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15509         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15510         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15511       operationId: UpdateServiceDesignAndCreationModelsModelMetadataMetadatum
15512       consumes:
15513         - application/json
15514         - application/xml
15515       produces:
15516         - application/json
15517         - application/xml
15518       responses:
15519         "default":
15520           description: Response codes found in [response codes](https://wiki.onap.org/).
15521       parameters:
15522         - name: model-name-version-id
15523           in: path
15524           description: Unique identifier corresponding to one version of a model in ASDC
15525           required: true
15526           type: string
15527           example: __MODEL-NAME-VERSION-ID__
15528         - name: metaname
15529           in: path
15530           required: true
15531           type: string
15532           example: __METANAME__
15533         - name: body
15534           in: body
15535           description: metadatum object that needs to be updated.
15536           required: true
15537           schema:
15538             $ref: "#/patchDefinitions/metadatum"
15539     delete:
15540       tags:
15541         - ServiceDesignAndCreation
15542       summary: delete an existing metadatum
15543       description: delete an existing metadatum
15544       operationId: deleteServiceDesignAndCreationModelsModelMetadataMetadatum
15545       consumes:
15546         - application/json
15547         - application/xml
15548       produces:
15549         - application/json
15550         - application/xml
15551       responses:
15552         "default":
15553           description: Response codes found in [response codes](https://wiki.onap.org/).
15554       parameters:
15555         - name: model-name-version-id
15556           in: path
15557           description: Unique identifier corresponding to one version of a model in ASDC
15558           required: true
15559           type: string
15560           example: __MODEL-NAME-VERSION-ID__
15561         - name: metaname
15562           in: path
15563           required: true
15564           type: string
15565           example: __METANAME__
15566         - name: resource-version
15567           in: query
15568           description: resource-version for concurrency
15569           required: true
15570           type: string
15571   /service-design-and-creation/models/model/{model-name-version-id}/metadata:
15572     get:
15573       tags:
15574         - ServiceDesignAndCreation
15575       summary: returns metadata
15576       description: returns metadata
15577       operationId: getServiceDesignAndCreationModelsModelMetadata
15578       produces:
15579         - application/json
15580         - application/xml
15581       responses:
15582         "200":
15583           description: successful operation
15584           schema:
15585               $ref: "#/getDefinitions/metadata"
15586         "default":
15587           description: Response codes found in [response codes](https://wiki.onap.org/).
15588       parameters:
15589         - name: model-name-version-id
15590           in: path
15591           description: Unique identifier corresponding to one version of a model in ASDC
15592           required: true
15593           type: string
15594           example: __MODEL-NAME-VERSION-ID__
15595         - name: metaname
15596           in: query
15597           description:
15598           required: false
15599           type: string
15600   /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship:
15601     put:
15602       tags:
15603         - ServiceDesignAndCreation
15604       summary: see node definition for valid relationships
15605       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
15606       consumes:
15607         - application/json
15608         - application/xml
15609       produces:
15610         - application/json
15611         - application/xml
15612       responses:
15613         "default":
15614           description: Response codes found in [response codes](https://wiki.onap.org/).
15615       parameters:
15616         - name: model-name-version-id
15617           in: path
15618           description: Unique identifier corresponding to one version of a model in ASDC
15619           required: true
15620           type: string
15621           example: __MODEL-NAME-VERSION-ID__
15622         - name: body
15623           in: body
15624           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
15625           required: true
15626           schema:
15627             $ref: "#/definitions/relationship"
15628     delete:
15629       tags:
15630         - ServiceDesignAndCreation
15631       summary: delete an existing relationship
15632       description: delete an existing relationship
15633       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
15634       consumes:
15635         - application/json
15636         - application/xml
15637       produces:
15638         - application/json
15639         - application/xml
15640       responses:
15641         "default":
15642           description: Response codes found in [response codes](https://wiki.onap.org/).
15643       parameters:
15644         - name: model-name-version-id
15645           in: path
15646           description: Unique identifier corresponding to one version of a model in ASDC
15647           required: true
15648           type: string
15649           example: __MODEL-NAME-VERSION-ID__
15650   /service-design-and-creation/models/model/{model-name-version-id}:
15651     get:
15652       tags:
15653         - ServiceDesignAndCreation
15654       summary: returns model
15655       description: returns model
15656       operationId: getServiceDesignAndCreationModelsModel
15657       produces:
15658         - application/json
15659         - application/xml
15660       responses:
15661         "200":
15662           description: successful operation
15663           schema:
15664               $ref: "#/getDefinitions/model"
15665         "default":
15666           description: Response codes found in [response codes](https://wiki.onap.org/).
15667       parameters:
15668         - name: model-name-version-id
15669           in: path
15670           description: Unique identifier corresponding to one version of a model in ASDC
15671           required: true
15672           type: string
15673           example: __MODEL-NAME-VERSION-ID__
15674     put:
15675       tags:
15676         - ServiceDesignAndCreation
15677       summary: create or update an existing model
15678       description: |
15679         Create or update an existing model.
15680         #
15681         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15682       operationId: createOrUpdateServiceDesignAndCreationModelsModel
15683       consumes:
15684         - application/json
15685         - application/xml
15686       produces:
15687         - application/json
15688         - application/xml
15689       responses:
15690         "default":
15691           description: Response codes found in [response codes](https://wiki.onap.org/).
15692       parameters:
15693         - name: model-name-version-id
15694           in: path
15695           description: Unique identifier corresponding to one version of a model in ASDC
15696           required: true
15697           type: string
15698           example: __MODEL-NAME-VERSION-ID__
15699         - name: body
15700           in: body
15701           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
15702           required: true
15703           schema:
15704             $ref: "#/definitions/model"
15705     patch:
15706       tags:
15707         - ServiceDesignAndCreation
15708       summary: update an existing model
15709       description: |
15710         Update an existing model
15711         #
15712         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15713         The PUT operation will entirely replace an existing object.
15714         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15715         #
15716         Other differences between PUT and PATCH are:
15717         #
15718         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15719         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15720         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15721       operationId: UpdateServiceDesignAndCreationModelsModel
15722       consumes:
15723         - application/json
15724         - application/xml
15725       produces:
15726         - application/json
15727         - application/xml
15728       responses:
15729         "default":
15730           description: Response codes found in [response codes](https://wiki.onap.org/).
15731       parameters:
15732         - name: model-name-version-id
15733           in: path
15734           description: Unique identifier corresponding to one version of a model in ASDC
15735           required: true
15736           type: string
15737           example: __MODEL-NAME-VERSION-ID__
15738         - name: body
15739           in: body
15740           description: model object that needs to be updated.
15741           required: true
15742           schema:
15743             $ref: "#/patchDefinitions/model"
15744     delete:
15745       tags:
15746         - ServiceDesignAndCreation
15747       summary: delete an existing model
15748       description: delete an existing model
15749       operationId: deleteServiceDesignAndCreationModelsModel
15750       consumes:
15751         - application/json
15752         - application/xml
15753       produces:
15754         - application/json
15755         - application/xml
15756       responses:
15757         "default":
15758           description: Response codes found in [response codes](https://wiki.onap.org/).
15759       parameters:
15760         - name: model-name-version-id
15761           in: path
15762           description: Unique identifier corresponding to one version of a model in ASDC
15763           required: true
15764           type: string
15765           example: __MODEL-NAME-VERSION-ID__
15766         - name: resource-version
15767           in: query
15768           description: resource-version for concurrency
15769           required: true
15770           type: string
15771   /service-design-and-creation/models:
15772     get:
15773       tags:
15774         - ServiceDesignAndCreation
15775       summary: returns models
15776       description: returns models
15777       operationId: getServiceDesignAndCreationModels
15778       produces:
15779         - application/json
15780         - application/xml
15781       responses:
15782         "200":
15783           description: successful operation
15784           schema:
15785               $ref: "#/getDefinitions/models"
15786         "default":
15787           description: Response codes found in [response codes](https://wiki.onap.org/).
15788       parameters:
15789         - name: model-name-version-id
15790           in: query
15791           description:
15792           required: false
15793           type: string
15794         - name: model-type
15795           in: query
15796           description:
15797           required: false
15798           type: string
15799         - name: model-name
15800           in: query
15801           description:
15802           required: false
15803           type: string
15804         - name: model-id
15805           in: query
15806           description:
15807           required: false
15808           type: string
15809         - name: model-version
15810           in: query
15811           description:
15812           required: false
15813           type: string
15814   /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:
15815     put:
15816       tags:
15817         - ServiceDesignAndCreation
15818       summary: see node definition for valid relationships
15819       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
15820       consumes:
15821         - application/json
15822         - application/xml
15823       produces:
15824         - application/json
15825         - application/xml
15826       responses:
15827         "default":
15828           description: Response codes found in [response codes](https://wiki.onap.org/).
15829       parameters:
15830         - name: named-query-uuid
15831           in: path
15832           required: true
15833           type: string
15834           example: __NAMED-QUERY-UUID__
15835         - name: named-query-element-uuid
15836           in: path
15837           required: true
15838           type: string
15839           example: __NAMED-QUERY-ELEMENT-UUID__
15840         - name: related-lookup-uuid
15841           in: path
15842           required: true
15843           type: string
15844           example: __RELATED-LOOKUP-UUID__
15845         - name: body
15846           in: body
15847           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
15848           required: true
15849           schema:
15850             $ref: "#/definitions/relationship"
15851     delete:
15852       tags:
15853         - ServiceDesignAndCreation
15854       summary: delete an existing relationship
15855       description: delete an existing relationship
15856       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
15857       consumes:
15858         - application/json
15859         - application/xml
15860       produces:
15861         - application/json
15862         - application/xml
15863       responses:
15864         "default":
15865           description: Response codes found in [response codes](https://wiki.onap.org/).
15866       parameters:
15867         - name: named-query-uuid
15868           in: path
15869           required: true
15870           type: string
15871           example: __NAMED-QUERY-UUID__
15872         - name: named-query-element-uuid
15873           in: path
15874           required: true
15875           type: string
15876           example: __NAMED-QUERY-ELEMENT-UUID__
15877         - name: related-lookup-uuid
15878           in: path
15879           required: true
15880           type: string
15881           example: __RELATED-LOOKUP-UUID__
15882   /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}:
15883     get:
15884       tags:
15885         - ServiceDesignAndCreation
15886       summary: returns related-lookup
15887       description: returns related-lookup
15888       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15889       produces:
15890         - application/json
15891         - application/xml
15892       responses:
15893         "200":
15894           description: successful operation
15895           schema:
15896               $ref: "#/getDefinitions/related-lookup"
15897         "default":
15898           description: Response codes found in [response codes](https://wiki.onap.org/).
15899       parameters:
15900         - name: named-query-uuid
15901           in: path
15902           required: true
15903           type: string
15904           example: __NAMED-QUERY-UUID__
15905         - name: named-query-element-uuid
15906           in: path
15907           required: true
15908           type: string
15909           example: __NAMED-QUERY-ELEMENT-UUID__
15910         - name: related-lookup-uuid
15911           in: path
15912           required: true
15913           type: string
15914           example: __RELATED-LOOKUP-UUID__
15915     put:
15916       tags:
15917         - ServiceDesignAndCreation
15918       summary: create or update an existing related-lookup
15919       description: |
15920         Create or update an existing related-lookup.
15921         #
15922         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15923       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15924       consumes:
15925         - application/json
15926         - application/xml
15927       produces:
15928         - application/json
15929         - application/xml
15930       responses:
15931         "default":
15932           description: Response codes found in [response codes](https://wiki.onap.org/).
15933       parameters:
15934         - name: named-query-uuid
15935           in: path
15936           required: true
15937           type: string
15938           example: __NAMED-QUERY-UUID__
15939         - name: named-query-element-uuid
15940           in: path
15941           required: true
15942           type: string
15943           example: __NAMED-QUERY-ELEMENT-UUID__
15944         - name: related-lookup-uuid
15945           in: path
15946           required: true
15947           type: string
15948           example: __RELATED-LOOKUP-UUID__
15949         - name: body
15950           in: body
15951           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
15952           required: true
15953           schema:
15954             $ref: "#/definitions/related-lookup"
15955     patch:
15956       tags:
15957         - ServiceDesignAndCreation
15958       summary: update an existing related-lookup
15959       description: |
15960         Update an existing related-lookup
15961         #
15962         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15963         The PUT operation will entirely replace an existing object.
15964         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15965         #
15966         Other differences between PUT and PATCH are:
15967         #
15968         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15969         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15970         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15971       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15972       consumes:
15973         - application/json
15974         - application/xml
15975       produces:
15976         - application/json
15977         - application/xml
15978       responses:
15979         "default":
15980           description: Response codes found in [response codes](https://wiki.onap.org/).
15981       parameters:
15982         - name: named-query-uuid
15983           in: path
15984           required: true
15985           type: string
15986           example: __NAMED-QUERY-UUID__
15987         - name: named-query-element-uuid
15988           in: path
15989           required: true
15990           type: string
15991           example: __NAMED-QUERY-ELEMENT-UUID__
15992         - name: related-lookup-uuid
15993           in: path
15994           required: true
15995           type: string
15996           example: __RELATED-LOOKUP-UUID__
15997         - name: body
15998           in: body
15999           description: related-lookup object that needs to be updated.
16000           required: true
16001           schema:
16002             $ref: "#/patchDefinitions/related-lookup"
16003     delete:
16004       tags:
16005         - ServiceDesignAndCreation
16006       summary: delete an existing related-lookup
16007       description: delete an existing related-lookup
16008       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
16009       consumes:
16010         - application/json
16011         - application/xml
16012       produces:
16013         - application/json
16014         - application/xml
16015       responses:
16016         "default":
16017           description: Response codes found in [response codes](https://wiki.onap.org/).
16018       parameters:
16019         - name: named-query-uuid
16020           in: path
16021           required: true
16022           type: string
16023           example: __NAMED-QUERY-UUID__
16024         - name: named-query-element-uuid
16025           in: path
16026           required: true
16027           type: string
16028           example: __NAMED-QUERY-ELEMENT-UUID__
16029         - name: related-lookup-uuid
16030           in: path
16031           required: true
16032           type: string
16033           example: __RELATED-LOOKUP-UUID__
16034         - name: resource-version
16035           in: query
16036           description: resource-version for concurrency
16037           required: true
16038           type: string
16039   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
16040     get:
16041       tags:
16042         - ServiceDesignAndCreation
16043       summary: returns related-lookups
16044       description: returns related-lookups
16045       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
16046       produces:
16047         - application/json
16048         - application/xml
16049       responses:
16050         "200":
16051           description: successful operation
16052           schema:
16053               $ref: "#/getDefinitions/related-lookups"
16054         "default":
16055           description: Response codes found in [response codes](https://wiki.onap.org/).
16056       parameters:
16057         - name: named-query-uuid
16058           in: path
16059           required: true
16060           type: string
16061           example: __NAMED-QUERY-UUID__
16062         - name: named-query-element-uuid
16063           in: path
16064           required: true
16065           type: string
16066           example: __NAMED-QUERY-ELEMENT-UUID__
16067         - name: related-lookup-uuid
16068           in: query
16069           description:
16070           required: false
16071           type: string
16072   /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}:
16073     get:
16074       tags:
16075         - ServiceDesignAndCreation
16076       summary: returns property-constraint
16077       description: returns property-constraint
16078       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16079       produces:
16080         - application/json
16081         - application/xml
16082       responses:
16083         "200":
16084           description: successful operation
16085           schema:
16086               $ref: "#/getDefinitions/property-constraint"
16087         "default":
16088           description: Response codes found in [response codes](https://wiki.onap.org/).
16089       parameters:
16090         - name: named-query-uuid
16091           in: path
16092           required: true
16093           type: string
16094           example: __NAMED-QUERY-UUID__
16095         - name: named-query-element-uuid
16096           in: path
16097           required: true
16098           type: string
16099           example: __NAMED-QUERY-ELEMENT-UUID__
16100         - name: property-constraint-uuid
16101           in: path
16102           required: true
16103           type: string
16104           example: __PROPERTY-CONSTRAINT-UUID__
16105     put:
16106       tags:
16107         - ServiceDesignAndCreation
16108       summary: create or update an existing property-constraint
16109       description: |
16110         Create or update an existing property-constraint.
16111         #
16112         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16113       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16114       consumes:
16115         - application/json
16116         - application/xml
16117       produces:
16118         - application/json
16119         - application/xml
16120       responses:
16121         "default":
16122           description: Response codes found in [response codes](https://wiki.onap.org/).
16123       parameters:
16124         - name: named-query-uuid
16125           in: path
16126           required: true
16127           type: string
16128           example: __NAMED-QUERY-UUID__
16129         - name: named-query-element-uuid
16130           in: path
16131           required: true
16132           type: string
16133           example: __NAMED-QUERY-ELEMENT-UUID__
16134         - name: property-constraint-uuid
16135           in: path
16136           required: true
16137           type: string
16138           example: __PROPERTY-CONSTRAINT-UUID__
16139         - name: body
16140           in: body
16141           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
16142           required: true
16143           schema:
16144             $ref: "#/definitions/property-constraint"
16145     patch:
16146       tags:
16147         - ServiceDesignAndCreation
16148       summary: update an existing property-constraint
16149       description: |
16150         Update an existing property-constraint
16151         #
16152         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16153         The PUT operation will entirely replace an existing object.
16154         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16155         #
16156         Other differences between PUT and PATCH are:
16157         #
16158         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16159         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16160         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16161       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16162       consumes:
16163         - application/json
16164         - application/xml
16165       produces:
16166         - application/json
16167         - application/xml
16168       responses:
16169         "default":
16170           description: Response codes found in [response codes](https://wiki.onap.org/).
16171       parameters:
16172         - name: named-query-uuid
16173           in: path
16174           required: true
16175           type: string
16176           example: __NAMED-QUERY-UUID__
16177         - name: named-query-element-uuid
16178           in: path
16179           required: true
16180           type: string
16181           example: __NAMED-QUERY-ELEMENT-UUID__
16182         - name: property-constraint-uuid
16183           in: path
16184           required: true
16185           type: string
16186           example: __PROPERTY-CONSTRAINT-UUID__
16187         - name: body
16188           in: body
16189           description: property-constraint object that needs to be updated.
16190           required: true
16191           schema:
16192             $ref: "#/patchDefinitions/property-constraint"
16193     delete:
16194       tags:
16195         - ServiceDesignAndCreation
16196       summary: delete an existing property-constraint
16197       description: delete an existing property-constraint
16198       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16199       consumes:
16200         - application/json
16201         - application/xml
16202       produces:
16203         - application/json
16204         - application/xml
16205       responses:
16206         "default":
16207           description: Response codes found in [response codes](https://wiki.onap.org/).
16208       parameters:
16209         - name: named-query-uuid
16210           in: path
16211           required: true
16212           type: string
16213           example: __NAMED-QUERY-UUID__
16214         - name: named-query-element-uuid
16215           in: path
16216           required: true
16217           type: string
16218           example: __NAMED-QUERY-ELEMENT-UUID__
16219         - name: property-constraint-uuid
16220           in: path
16221           required: true
16222           type: string
16223           example: __PROPERTY-CONSTRAINT-UUID__
16224         - name: resource-version
16225           in: query
16226           description: resource-version for concurrency
16227           required: true
16228           type: string
16229   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
16230     get:
16231       tags:
16232         - ServiceDesignAndCreation
16233       summary: returns property-constraints
16234       description: returns property-constraints
16235       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
16236       produces:
16237         - application/json
16238         - application/xml
16239       responses:
16240         "200":
16241           description: successful operation
16242           schema:
16243               $ref: "#/getDefinitions/property-constraints"
16244         "default":
16245           description: Response codes found in [response codes](https://wiki.onap.org/).
16246       parameters:
16247         - name: named-query-uuid
16248           in: path
16249           required: true
16250           type: string
16251           example: __NAMED-QUERY-UUID__
16252         - name: named-query-element-uuid
16253           in: path
16254           required: true
16255           type: string
16256           example: __NAMED-QUERY-ELEMENT-UUID__
16257         - name: property-constraint-uuid
16258           in: query
16259           description:
16260           required: false
16261           type: string
16262   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
16263     put:
16264       tags:
16265         - ServiceDesignAndCreation
16266       summary: see node definition for valid relationships
16267       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
16268       consumes:
16269         - application/json
16270         - application/xml
16271       produces:
16272         - application/json
16273         - application/xml
16274       responses:
16275         "default":
16276           description: Response codes found in [response codes](https://wiki.onap.org/).
16277       parameters:
16278         - name: named-query-uuid
16279           in: path
16280           required: true
16281           type: string
16282           example: __NAMED-QUERY-UUID__
16283         - name: named-query-element-uuid
16284           in: path
16285           required: true
16286           type: string
16287           example: __NAMED-QUERY-ELEMENT-UUID__
16288         - name: body
16289           in: body
16290           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
16291           required: true
16292           schema:
16293             $ref: "#/definitions/relationship"
16294     delete:
16295       tags:
16296         - ServiceDesignAndCreation
16297       summary: delete an existing relationship
16298       description: delete an existing relationship
16299       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
16300       consumes:
16301         - application/json
16302         - application/xml
16303       produces:
16304         - application/json
16305         - application/xml
16306       responses:
16307         "default":
16308           description: Response codes found in [response codes](https://wiki.onap.org/).
16309       parameters:
16310         - name: named-query-uuid
16311           in: path
16312           required: true
16313           type: string
16314           example: __NAMED-QUERY-UUID__
16315         - name: named-query-element-uuid
16316           in: path
16317           required: true
16318           type: string
16319           example: __NAMED-QUERY-ELEMENT-UUID__
16320   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
16321     get:
16322       tags:
16323         - ServiceDesignAndCreation
16324       summary: returns named-query-element
16325       description: returns named-query-element
16326       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16327       produces:
16328         - application/json
16329         - application/xml
16330       responses:
16331         "200":
16332           description: successful operation
16333           schema:
16334               $ref: "#/getDefinitions/named-query-element"
16335         "default":
16336           description: Response codes found in [response codes](https://wiki.onap.org/).
16337       parameters:
16338         - name: named-query-uuid
16339           in: path
16340           required: true
16341           type: string
16342           example: __NAMED-QUERY-UUID__
16343         - name: named-query-element-uuid
16344           in: path
16345           required: true
16346           type: string
16347           example: __NAMED-QUERY-ELEMENT-UUID__
16348     put:
16349       tags:
16350         - ServiceDesignAndCreation
16351       summary: create or update an existing named-query-element
16352       description: |
16353         Create or update an existing named-query-element.
16354         #
16355         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16356       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16357       consumes:
16358         - application/json
16359         - application/xml
16360       produces:
16361         - application/json
16362         - application/xml
16363       responses:
16364         "default":
16365           description: Response codes found in [response codes](https://wiki.onap.org/).
16366       parameters:
16367         - name: named-query-uuid
16368           in: path
16369           required: true
16370           type: string
16371           example: __NAMED-QUERY-UUID__
16372         - name: named-query-element-uuid
16373           in: path
16374           required: true
16375           type: string
16376           example: __NAMED-QUERY-ELEMENT-UUID__
16377         - name: body
16378           in: body
16379           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
16380           required: true
16381           schema:
16382             $ref: "#/definitions/named-query-element"
16383     patch:
16384       tags:
16385         - ServiceDesignAndCreation
16386       summary: update an existing named-query-element
16387       description: |
16388         Update an existing named-query-element
16389         #
16390         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16391         The PUT operation will entirely replace an existing object.
16392         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16393         #
16394         Other differences between PUT and PATCH are:
16395         #
16396         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16397         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16398         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16399       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16400       consumes:
16401         - application/json
16402         - application/xml
16403       produces:
16404         - application/json
16405         - application/xml
16406       responses:
16407         "default":
16408           description: Response codes found in [response codes](https://wiki.onap.org/).
16409       parameters:
16410         - name: named-query-uuid
16411           in: path
16412           required: true
16413           type: string
16414           example: __NAMED-QUERY-UUID__
16415         - name: named-query-element-uuid
16416           in: path
16417           required: true
16418           type: string
16419           example: __NAMED-QUERY-ELEMENT-UUID__
16420         - name: body
16421           in: body
16422           description: named-query-element object that needs to be updated.
16423           required: true
16424           schema:
16425             $ref: "#/patchDefinitions/named-query-element"
16426     delete:
16427       tags:
16428         - ServiceDesignAndCreation
16429       summary: delete an existing named-query-element
16430       description: delete an existing named-query-element
16431       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16432       consumes:
16433         - application/json
16434         - application/xml
16435       produces:
16436         - application/json
16437         - application/xml
16438       responses:
16439         "default":
16440           description: Response codes found in [response codes](https://wiki.onap.org/).
16441       parameters:
16442         - name: named-query-uuid
16443           in: path
16444           required: true
16445           type: string
16446           example: __NAMED-QUERY-UUID__
16447         - name: named-query-element-uuid
16448           in: path
16449           required: true
16450           type: string
16451           example: __NAMED-QUERY-ELEMENT-UUID__
16452         - name: resource-version
16453           in: query
16454           description: resource-version for concurrency
16455           required: true
16456           type: string
16457   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
16458     get:
16459       tags:
16460         - ServiceDesignAndCreation
16461       summary: returns named-query-elements
16462       description: returns named-query-elements
16463       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
16464       produces:
16465         - application/json
16466         - application/xml
16467       responses:
16468         "200":
16469           description: successful operation
16470           schema:
16471               $ref: "#/getDefinitions/named-query-elements"
16472         "default":
16473           description: Response codes found in [response codes](https://wiki.onap.org/).
16474       parameters:
16475         - name: named-query-uuid
16476           in: path
16477           required: true
16478           type: string
16479           example: __NAMED-QUERY-UUID__
16480         - name: named-query-element-uuid
16481           in: query
16482           description:
16483           required: false
16484           type: string
16485   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
16486     put:
16487       tags:
16488         - ServiceDesignAndCreation
16489       summary: see node definition for valid relationships
16490       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
16491       consumes:
16492         - application/json
16493         - application/xml
16494       produces:
16495         - application/json
16496         - application/xml
16497       responses:
16498         "default":
16499           description: Response codes found in [response codes](https://wiki.onap.org/).
16500       parameters:
16501         - name: named-query-uuid
16502           in: path
16503           required: true
16504           type: string
16505           example: __NAMED-QUERY-UUID__
16506         - name: body
16507           in: body
16508           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
16509           required: true
16510           schema:
16511             $ref: "#/definitions/relationship"
16512     delete:
16513       tags:
16514         - ServiceDesignAndCreation
16515       summary: delete an existing relationship
16516       description: delete an existing relationship
16517       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
16518       consumes:
16519         - application/json
16520         - application/xml
16521       produces:
16522         - application/json
16523         - application/xml
16524       responses:
16525         "default":
16526           description: Response codes found in [response codes](https://wiki.onap.org/).
16527       parameters:
16528         - name: named-query-uuid
16529           in: path
16530           required: true
16531           type: string
16532           example: __NAMED-QUERY-UUID__
16533   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
16534     get:
16535       tags:
16536         - ServiceDesignAndCreation
16537       summary: returns named-query
16538       description: returns named-query
16539       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
16540       produces:
16541         - application/json
16542         - application/xml
16543       responses:
16544         "200":
16545           description: successful operation
16546           schema:
16547               $ref: "#/getDefinitions/named-query"
16548         "default":
16549           description: Response codes found in [response codes](https://wiki.onap.org/).
16550       parameters:
16551         - name: named-query-uuid
16552           in: path
16553           required: true
16554           type: string
16555           example: __NAMED-QUERY-UUID__
16556     put:
16557       tags:
16558         - ServiceDesignAndCreation
16559       summary: create or update an existing named-query
16560       description: |
16561         Create or update an existing named-query.
16562         #
16563         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16564       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
16565       consumes:
16566         - application/json
16567         - application/xml
16568       produces:
16569         - application/json
16570         - application/xml
16571       responses:
16572         "default":
16573           description: Response codes found in [response codes](https://wiki.onap.org/).
16574       parameters:
16575         - name: named-query-uuid
16576           in: path
16577           required: true
16578           type: string
16579           example: __NAMED-QUERY-UUID__
16580         - name: body
16581           in: body
16582           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
16583           required: true
16584           schema:
16585             $ref: "#/definitions/named-query"
16586     patch:
16587       tags:
16588         - ServiceDesignAndCreation
16589       summary: update an existing named-query
16590       description: |
16591         Update an existing named-query
16592         #
16593         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16594         The PUT operation will entirely replace an existing object.
16595         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16596         #
16597         Other differences between PUT and PATCH are:
16598         #
16599         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16600         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16601         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16602       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
16603       consumes:
16604         - application/json
16605         - application/xml
16606       produces:
16607         - application/json
16608         - application/xml
16609       responses:
16610         "default":
16611           description: Response codes found in [response codes](https://wiki.onap.org/).
16612       parameters:
16613         - name: named-query-uuid
16614           in: path
16615           required: true
16616           type: string
16617           example: __NAMED-QUERY-UUID__
16618         - name: body
16619           in: body
16620           description: named-query object that needs to be updated.
16621           required: true
16622           schema:
16623             $ref: "#/patchDefinitions/named-query"
16624     delete:
16625       tags:
16626         - ServiceDesignAndCreation
16627       summary: delete an existing named-query
16628       description: delete an existing named-query
16629       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
16630       consumes:
16631         - application/json
16632         - application/xml
16633       produces:
16634         - application/json
16635         - application/xml
16636       responses:
16637         "default":
16638           description: Response codes found in [response codes](https://wiki.onap.org/).
16639       parameters:
16640         - name: named-query-uuid
16641           in: path
16642           required: true
16643           type: string
16644           example: __NAMED-QUERY-UUID__
16645         - name: resource-version
16646           in: query
16647           description: resource-version for concurrency
16648           required: true
16649           type: string
16650   /service-design-and-creation/named-queries:
16651     get:
16652       tags:
16653         - ServiceDesignAndCreation
16654       summary: returns named-queries
16655       description: returns named-queries
16656       operationId: getServiceDesignAndCreationNamedQueries
16657       produces:
16658         - application/json
16659         - application/xml
16660       responses:
16661         "200":
16662           description: successful operation
16663           schema:
16664               $ref: "#/getDefinitions/named-queries"
16665         "default":
16666           description: Response codes found in [response codes](https://wiki.onap.org/).
16667       parameters:
16668         - name: named-query-uuid
16669           in: query
16670           description:
16671           required: false
16672           type: string
16673         - name: named-query-name
16674           in: query
16675           description:
16676           required: false
16677           type: string
16678   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
16679     put:
16680       tags:
16681         - Network
16682       summary: see node definition for valid relationships
16683       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
16684       consumes:
16685         - application/json
16686         - application/xml
16687       produces:
16688         - application/json
16689         - application/xml
16690       responses:
16691         "default":
16692           description: Response codes found in [response codes](https://wiki.onap.org/).
16693       parameters:
16694         - name: link-name
16695           in: path
16696           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16697           required: true
16698           type: string
16699           example: __LINK-NAME__
16700         - name: body
16701           in: body
16702           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
16703           required: true
16704           schema:
16705             $ref: "#/definitions/relationship"
16706     delete:
16707       tags:
16708         - Network
16709       summary: delete an existing relationship
16710       description: delete an existing relationship
16711       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
16712       consumes:
16713         - application/json
16714         - application/xml
16715       produces:
16716         - application/json
16717         - application/xml
16718       responses:
16719         "default":
16720           description: Response codes found in [response codes](https://wiki.onap.org/).
16721       parameters:
16722         - name: link-name
16723           in: path
16724           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16725           required: true
16726           type: string
16727           example: __LINK-NAME__
16728   /network/logical-links/logical-link/{link-name}:
16729     get:
16730       tags:
16731         - Network
16732       summary: returns logical-link
16733       description: returns logical-link
16734       operationId: getNetworkLogicalLinksLogicalLink
16735       produces:
16736         - application/json
16737         - application/xml
16738       responses:
16739         "200":
16740           description: successful operation
16741           schema:
16742               $ref: "#/getDefinitions/logical-link"
16743         "default":
16744           description: Response codes found in [response codes](https://wiki.onap.org/).
16745       parameters:
16746         - name: link-name
16747           in: path
16748           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16749           required: true
16750           type: string
16751           example: __LINK-NAME__
16752     put:
16753       tags:
16754         - Network
16755       summary: create or update an existing logical-link
16756       description: |
16757         Create or update an existing logical-link.
16758         #
16759         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16760       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
16761       consumes:
16762         - application/json
16763         - application/xml
16764       produces:
16765         - application/json
16766         - application/xml
16767       responses:
16768         "default":
16769           description: Response codes found in [response codes](https://wiki.onap.org/).
16770       parameters:
16771         - name: link-name
16772           in: path
16773           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16774           required: true
16775           type: string
16776           example: __LINK-NAME__
16777         - name: body
16778           in: body
16779           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
16780           required: true
16781           schema:
16782             $ref: "#/definitions/logical-link"
16783     patch:
16784       tags:
16785         - Network
16786       summary: update an existing logical-link
16787       description: |
16788         Update an existing logical-link
16789         #
16790         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16791         The PUT operation will entirely replace an existing object.
16792         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16793         #
16794         Other differences between PUT and PATCH are:
16795         #
16796         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16797         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16798         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16799       operationId: UpdateNetworkLogicalLinksLogicalLink
16800       consumes:
16801         - application/json
16802         - application/xml
16803       produces:
16804         - application/json
16805         - application/xml
16806       responses:
16807         "default":
16808           description: Response codes found in [response codes](https://wiki.onap.org/).
16809       parameters:
16810         - name: link-name
16811           in: path
16812           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16813           required: true
16814           type: string
16815           example: __LINK-NAME__
16816         - name: body
16817           in: body
16818           description: logical-link object that needs to be updated.
16819           required: true
16820           schema:
16821             $ref: "#/patchDefinitions/logical-link"
16822     delete:
16823       tags:
16824         - Network
16825       summary: delete an existing logical-link
16826       description: delete an existing logical-link
16827       operationId: deleteNetworkLogicalLinksLogicalLink
16828       consumes:
16829         - application/json
16830         - application/xml
16831       produces:
16832         - application/json
16833         - application/xml
16834       responses:
16835         "default":
16836           description: Response codes found in [response codes](https://wiki.onap.org/).
16837       parameters:
16838         - name: link-name
16839           in: path
16840           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16841           required: true
16842           type: string
16843           example: __LINK-NAME__
16844         - name: resource-version
16845           in: query
16846           description: resource-version for concurrency
16847           required: true
16848           type: string
16849   /network/logical-links:
16850     get:
16851       tags:
16852         - Network
16853       summary: returns logical-links
16854       description: returns logical-links
16855       operationId: getNetworkLogicalLinks
16856       produces:
16857         - application/json
16858         - application/xml
16859       responses:
16860         "200":
16861           description: successful operation
16862           schema:
16863               $ref: "#/getDefinitions/logical-links"
16864         "default":
16865           description: Response codes found in [response codes](https://wiki.onap.org/).
16866       parameters:
16867         - name: link-name
16868           in: query
16869           description:
16870           required: false
16871           type: string
16872         - name: persona-model-id
16873           in: query
16874           description:
16875           required: false
16876           type: string
16877         - name: persona-model-version
16878           in: query
16879           description:
16880           required: false
16881           type: string
16882         - name: widget-model-id
16883           in: query
16884           description:
16885           required: false
16886           type: string
16887         - name: widget-model-version
16888           in: query
16889           description:
16890           required: false
16891           type: string
16892         - name: link-id
16893           in: query
16894           description:
16895           required: false
16896           type: string
16897   /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:
16898     put:
16899       tags:
16900         - Network
16901       summary: see node definition for valid relationships
16902       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
16903       consumes:
16904         - application/json
16905         - application/xml
16906       produces:
16907         - application/json
16908         - application/xml
16909       responses:
16910         "default":
16911           description: Response codes found in [response codes](https://wiki.onap.org/).
16912       parameters:
16913         - name: site-pair-set-id
16914           in: path
16915           description: Unique id of site pair set.
16916           required: true
16917           type: string
16918           example: __SITE-PAIR-SET-ID__
16919         - name: routing-instance-id
16920           in: path
16921           description: Unique id of routing instance
16922           required: true
16923           type: string
16924           example: __ROUTING-INSTANCE-ID__
16925         - name: site-pair-id
16926           in: path
16927           description: unique identifier of probe
16928           required: true
16929           type: string
16930           example: __SITE-PAIR-ID__
16931         - name: cos
16932           in: path
16933           description: unique identifier of probe
16934           required: true
16935           type: string
16936           example: __COS__
16937         - name: body
16938           in: body
16939           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
16940           required: true
16941           schema:
16942             $ref: "#/definitions/relationship"
16943     delete:
16944       tags:
16945         - Network
16946       summary: delete an existing relationship
16947       description: delete an existing relationship
16948       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
16949       consumes:
16950         - application/json
16951         - application/xml
16952       produces:
16953         - application/json
16954         - application/xml
16955       responses:
16956         "default":
16957           description: Response codes found in [response codes](https://wiki.onap.org/).
16958       parameters:
16959         - name: site-pair-set-id
16960           in: path
16961           description: Unique id of site pair set.
16962           required: true
16963           type: string
16964           example: __SITE-PAIR-SET-ID__
16965         - name: routing-instance-id
16966           in: path
16967           description: Unique id of routing instance
16968           required: true
16969           type: string
16970           example: __ROUTING-INSTANCE-ID__
16971         - name: site-pair-id
16972           in: path
16973           description: unique identifier of probe
16974           required: true
16975           type: string
16976           example: __SITE-PAIR-ID__
16977         - name: cos
16978           in: path
16979           description: unique identifier of probe
16980           required: true
16981           type: string
16982           example: __COS__
16983   /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}:
16984     get:
16985       tags:
16986         - Network
16987       summary: returns class-of-service
16988       description: returns class-of-service
16989       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
16990       produces:
16991         - application/json
16992         - application/xml
16993       responses:
16994         "200":
16995           description: successful operation
16996           schema:
16997               $ref: "#/getDefinitions/class-of-service"
16998         "default":
16999           description: Response codes found in [response codes](https://wiki.onap.org/).
17000       parameters:
17001         - name: site-pair-set-id
17002           in: path
17003           description: Unique id of site pair set.
17004           required: true
17005           type: string
17006           example: __SITE-PAIR-SET-ID__
17007         - name: routing-instance-id
17008           in: path
17009           description: Unique id of routing instance
17010           required: true
17011           type: string
17012           example: __ROUTING-INSTANCE-ID__
17013         - name: site-pair-id
17014           in: path
17015           description: unique identifier of probe
17016           required: true
17017           type: string
17018           example: __SITE-PAIR-ID__
17019         - name: cos
17020           in: path
17021           description: unique identifier of probe
17022           required: true
17023           type: string
17024           example: __COS__
17025     put:
17026       tags:
17027         - Network
17028       summary: create or update an existing class-of-service
17029       description: |
17030         Create or update an existing class-of-service.
17031         #
17032         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17033       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17034       consumes:
17035         - application/json
17036         - application/xml
17037       produces:
17038         - application/json
17039         - application/xml
17040       responses:
17041         "default":
17042           description: Response codes found in [response codes](https://wiki.onap.org/).
17043       parameters:
17044         - name: site-pair-set-id
17045           in: path
17046           description: Unique id of site pair set.
17047           required: true
17048           type: string
17049           example: __SITE-PAIR-SET-ID__
17050         - name: routing-instance-id
17051           in: path
17052           description: Unique id of routing instance
17053           required: true
17054           type: string
17055           example: __ROUTING-INSTANCE-ID__
17056         - name: site-pair-id
17057           in: path
17058           description: unique identifier of probe
17059           required: true
17060           type: string
17061           example: __SITE-PAIR-ID__
17062         - name: cos
17063           in: path
17064           description: unique identifier of probe
17065           required: true
17066           type: string
17067           example: __COS__
17068         - name: body
17069           in: body
17070           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
17071           required: true
17072           schema:
17073             $ref: "#/definitions/class-of-service"
17074     patch:
17075       tags:
17076         - Network
17077       summary: update an existing class-of-service
17078       description: |
17079         Update an existing class-of-service
17080         #
17081         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17082         The PUT operation will entirely replace an existing object.
17083         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17084         #
17085         Other differences between PUT and PATCH are:
17086         #
17087         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17088         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17089         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17090       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17091       consumes:
17092         - application/json
17093         - application/xml
17094       produces:
17095         - application/json
17096         - application/xml
17097       responses:
17098         "default":
17099           description: Response codes found in [response codes](https://wiki.onap.org/).
17100       parameters:
17101         - name: site-pair-set-id
17102           in: path
17103           description: Unique id of site pair set.
17104           required: true
17105           type: string
17106           example: __SITE-PAIR-SET-ID__
17107         - name: routing-instance-id
17108           in: path
17109           description: Unique id of routing instance
17110           required: true
17111           type: string
17112           example: __ROUTING-INSTANCE-ID__
17113         - name: site-pair-id
17114           in: path
17115           description: unique identifier of probe
17116           required: true
17117           type: string
17118           example: __SITE-PAIR-ID__
17119         - name: cos
17120           in: path
17121           description: unique identifier of probe
17122           required: true
17123           type: string
17124           example: __COS__
17125         - name: body
17126           in: body
17127           description: class-of-service object that needs to be updated.
17128           required: true
17129           schema:
17130             $ref: "#/patchDefinitions/class-of-service"
17131     delete:
17132       tags:
17133         - Network
17134       summary: delete an existing class-of-service
17135       description: delete an existing class-of-service
17136       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17137       consumes:
17138         - application/json
17139         - application/xml
17140       produces:
17141         - application/json
17142         - application/xml
17143       responses:
17144         "default":
17145           description: Response codes found in [response codes](https://wiki.onap.org/).
17146       parameters:
17147         - name: site-pair-set-id
17148           in: path
17149           description: Unique id of site pair set.
17150           required: true
17151           type: string
17152           example: __SITE-PAIR-SET-ID__
17153         - name: routing-instance-id
17154           in: path
17155           description: Unique id of routing instance
17156           required: true
17157           type: string
17158           example: __ROUTING-INSTANCE-ID__
17159         - name: site-pair-id
17160           in: path
17161           description: unique identifier of probe
17162           required: true
17163           type: string
17164           example: __SITE-PAIR-ID__
17165         - name: cos
17166           in: path
17167           description: unique identifier of probe
17168           required: true
17169           type: string
17170           example: __COS__
17171         - name: resource-version
17172           in: query
17173           description: resource-version for concurrency
17174           required: true
17175           type: string
17176   /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:
17177     get:
17178       tags:
17179         - Network
17180       summary: returns classes-of-service
17181       description: returns classes-of-service
17182       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
17183       produces:
17184         - application/json
17185         - application/xml
17186       responses:
17187         "200":
17188           description: successful operation
17189           schema:
17190               $ref: "#/getDefinitions/classes-of-service"
17191         "default":
17192           description: Response codes found in [response codes](https://wiki.onap.org/).
17193       parameters:
17194         - name: site-pair-set-id
17195           in: path
17196           description: Unique id of site pair set.
17197           required: true
17198           type: string
17199           example: __SITE-PAIR-SET-ID__
17200         - name: routing-instance-id
17201           in: path
17202           description: Unique id of routing instance
17203           required: true
17204           type: string
17205           example: __ROUTING-INSTANCE-ID__
17206         - name: site-pair-id
17207           in: path
17208           description: unique identifier of probe
17209           required: true
17210           type: string
17211           example: __SITE-PAIR-ID__
17212         - name: cos
17213           in: query
17214           description:
17215           required: false
17216           type: string
17217   /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:
17218     put:
17219       tags:
17220         - Network
17221       summary: see node definition for valid relationships
17222       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
17223       consumes:
17224         - application/json
17225         - application/xml
17226       produces:
17227         - application/json
17228         - application/xml
17229       responses:
17230         "default":
17231           description: Response codes found in [response codes](https://wiki.onap.org/).
17232       parameters:
17233         - name: site-pair-set-id
17234           in: path
17235           description: Unique id of site pair set.
17236           required: true
17237           type: string
17238           example: __SITE-PAIR-SET-ID__
17239         - name: routing-instance-id
17240           in: path
17241           description: Unique id of routing instance
17242           required: true
17243           type: string
17244           example: __ROUTING-INSTANCE-ID__
17245         - name: site-pair-id
17246           in: path
17247           description: unique identifier of probe
17248           required: true
17249           type: string
17250           example: __SITE-PAIR-ID__
17251         - name: body
17252           in: body
17253           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
17254           required: true
17255           schema:
17256             $ref: "#/definitions/relationship"
17257     delete:
17258       tags:
17259         - Network
17260       summary: delete an existing relationship
17261       description: delete an existing relationship
17262       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
17263       consumes:
17264         - application/json
17265         - application/xml
17266       produces:
17267         - application/json
17268         - application/xml
17269       responses:
17270         "default":
17271           description: Response codes found in [response codes](https://wiki.onap.org/).
17272       parameters:
17273         - name: site-pair-set-id
17274           in: path
17275           description: Unique id of site pair set.
17276           required: true
17277           type: string
17278           example: __SITE-PAIR-SET-ID__
17279         - name: routing-instance-id
17280           in: path
17281           description: Unique id of routing instance
17282           required: true
17283           type: string
17284           example: __ROUTING-INSTANCE-ID__
17285         - name: site-pair-id
17286           in: path
17287           description: unique identifier of probe
17288           required: true
17289           type: string
17290           example: __SITE-PAIR-ID__
17291   /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}:
17292     get:
17293       tags:
17294         - Network
17295       summary: returns site-pair
17296       description: returns site-pair
17297       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17298       produces:
17299         - application/json
17300         - application/xml
17301       responses:
17302         "200":
17303           description: successful operation
17304           schema:
17305               $ref: "#/getDefinitions/site-pair"
17306         "default":
17307           description: Response codes found in [response codes](https://wiki.onap.org/).
17308       parameters:
17309         - name: site-pair-set-id
17310           in: path
17311           description: Unique id of site pair set.
17312           required: true
17313           type: string
17314           example: __SITE-PAIR-SET-ID__
17315         - name: routing-instance-id
17316           in: path
17317           description: Unique id of routing instance
17318           required: true
17319           type: string
17320           example: __ROUTING-INSTANCE-ID__
17321         - name: site-pair-id
17322           in: path
17323           description: unique identifier of probe
17324           required: true
17325           type: string
17326           example: __SITE-PAIR-ID__
17327     put:
17328       tags:
17329         - Network
17330       summary: create or update an existing site-pair
17331       description: |
17332         Create or update an existing site-pair.
17333         #
17334         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17335       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17336       consumes:
17337         - application/json
17338         - application/xml
17339       produces:
17340         - application/json
17341         - application/xml
17342       responses:
17343         "default":
17344           description: Response codes found in [response codes](https://wiki.onap.org/).
17345       parameters:
17346         - name: site-pair-set-id
17347           in: path
17348           description: Unique id of site pair set.
17349           required: true
17350           type: string
17351           example: __SITE-PAIR-SET-ID__
17352         - name: routing-instance-id
17353           in: path
17354           description: Unique id of routing instance
17355           required: true
17356           type: string
17357           example: __ROUTING-INSTANCE-ID__
17358         - name: site-pair-id
17359           in: path
17360           description: unique identifier of probe
17361           required: true
17362           type: string
17363           example: __SITE-PAIR-ID__
17364         - name: body
17365           in: body
17366           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
17367           required: true
17368           schema:
17369             $ref: "#/definitions/site-pair"
17370     patch:
17371       tags:
17372         - Network
17373       summary: update an existing site-pair
17374       description: |
17375         Update an existing site-pair
17376         #
17377         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17378         The PUT operation will entirely replace an existing object.
17379         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17380         #
17381         Other differences between PUT and PATCH are:
17382         #
17383         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17384         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17385         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17386       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17387       consumes:
17388         - application/json
17389         - application/xml
17390       produces:
17391         - application/json
17392         - application/xml
17393       responses:
17394         "default":
17395           description: Response codes found in [response codes](https://wiki.onap.org/).
17396       parameters:
17397         - name: site-pair-set-id
17398           in: path
17399           description: Unique id of site pair set.
17400           required: true
17401           type: string
17402           example: __SITE-PAIR-SET-ID__
17403         - name: routing-instance-id
17404           in: path
17405           description: Unique id of routing instance
17406           required: true
17407           type: string
17408           example: __ROUTING-INSTANCE-ID__
17409         - name: site-pair-id
17410           in: path
17411           description: unique identifier of probe
17412           required: true
17413           type: string
17414           example: __SITE-PAIR-ID__
17415         - name: body
17416           in: body
17417           description: site-pair object that needs to be updated.
17418           required: true
17419           schema:
17420             $ref: "#/patchDefinitions/site-pair"
17421     delete:
17422       tags:
17423         - Network
17424       summary: delete an existing site-pair
17425       description: delete an existing site-pair
17426       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17427       consumes:
17428         - application/json
17429         - application/xml
17430       produces:
17431         - application/json
17432         - application/xml
17433       responses:
17434         "default":
17435           description: Response codes found in [response codes](https://wiki.onap.org/).
17436       parameters:
17437         - name: site-pair-set-id
17438           in: path
17439           description: Unique id of site pair set.
17440           required: true
17441           type: string
17442           example: __SITE-PAIR-SET-ID__
17443         - name: routing-instance-id
17444           in: path
17445           description: Unique id of routing instance
17446           required: true
17447           type: string
17448           example: __ROUTING-INSTANCE-ID__
17449         - name: site-pair-id
17450           in: path
17451           description: unique identifier of probe
17452           required: true
17453           type: string
17454           example: __SITE-PAIR-ID__
17455         - name: resource-version
17456           in: query
17457           description: resource-version for concurrency
17458           required: true
17459           type: string
17460   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
17461     get:
17462       tags:
17463         - Network
17464       summary: returns site-pairs
17465       description: returns site-pairs
17466       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
17467       produces:
17468         - application/json
17469         - application/xml
17470       responses:
17471         "200":
17472           description: successful operation
17473           schema:
17474               $ref: "#/getDefinitions/site-pairs"
17475         "default":
17476           description: Response codes found in [response codes](https://wiki.onap.org/).
17477       parameters:
17478         - name: site-pair-set-id
17479           in: path
17480           description: Unique id of site pair set.
17481           required: true
17482           type: string
17483           example: __SITE-PAIR-SET-ID__
17484         - name: routing-instance-id
17485           in: path
17486           description: Unique id of routing instance
17487           required: true
17488           type: string
17489           example: __ROUTING-INSTANCE-ID__
17490         - name: site-pair-id
17491           in: query
17492           description:
17493           required: false
17494           type: string
17495   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
17496     put:
17497       tags:
17498         - Network
17499       summary: see node definition for valid relationships
17500       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
17501       consumes:
17502         - application/json
17503         - application/xml
17504       produces:
17505         - application/json
17506         - application/xml
17507       responses:
17508         "default":
17509           description: Response codes found in [response codes](https://wiki.onap.org/).
17510       parameters:
17511         - name: site-pair-set-id
17512           in: path
17513           description: Unique id of site pair set.
17514           required: true
17515           type: string
17516           example: __SITE-PAIR-SET-ID__
17517         - name: routing-instance-id
17518           in: path
17519           description: Unique id of routing instance
17520           required: true
17521           type: string
17522           example: __ROUTING-INSTANCE-ID__
17523         - name: body
17524           in: body
17525           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
17526           required: true
17527           schema:
17528             $ref: "#/definitions/relationship"
17529     delete:
17530       tags:
17531         - Network
17532       summary: delete an existing relationship
17533       description: delete an existing relationship
17534       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
17535       consumes:
17536         - application/json
17537         - application/xml
17538       produces:
17539         - application/json
17540         - application/xml
17541       responses:
17542         "default":
17543           description: Response codes found in [response codes](https://wiki.onap.org/).
17544       parameters:
17545         - name: site-pair-set-id
17546           in: path
17547           description: Unique id of site pair set.
17548           required: true
17549           type: string
17550           example: __SITE-PAIR-SET-ID__
17551         - name: routing-instance-id
17552           in: path
17553           description: Unique id of routing instance
17554           required: true
17555           type: string
17556           example: __ROUTING-INSTANCE-ID__
17557   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
17558     get:
17559       tags:
17560         - Network
17561       summary: returns routing-instance
17562       description: returns routing-instance
17563       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17564       produces:
17565         - application/json
17566         - application/xml
17567       responses:
17568         "200":
17569           description: successful operation
17570           schema:
17571               $ref: "#/getDefinitions/routing-instance"
17572         "default":
17573           description: Response codes found in [response codes](https://wiki.onap.org/).
17574       parameters:
17575         - name: site-pair-set-id
17576           in: path
17577           description: Unique id of site pair set.
17578           required: true
17579           type: string
17580           example: __SITE-PAIR-SET-ID__
17581         - name: routing-instance-id
17582           in: path
17583           description: Unique id of routing instance
17584           required: true
17585           type: string
17586           example: __ROUTING-INSTANCE-ID__
17587     put:
17588       tags:
17589         - Network
17590       summary: create or update an existing routing-instance
17591       description: |
17592         Create or update an existing routing-instance.
17593         #
17594         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17595       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17596       consumes:
17597         - application/json
17598         - application/xml
17599       produces:
17600         - application/json
17601         - application/xml
17602       responses:
17603         "default":
17604           description: Response codes found in [response codes](https://wiki.onap.org/).
17605       parameters:
17606         - name: site-pair-set-id
17607           in: path
17608           description: Unique id of site pair set.
17609           required: true
17610           type: string
17611           example: __SITE-PAIR-SET-ID__
17612         - name: routing-instance-id
17613           in: path
17614           description: Unique id of routing instance
17615           required: true
17616           type: string
17617           example: __ROUTING-INSTANCE-ID__
17618         - name: body
17619           in: body
17620           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
17621           required: true
17622           schema:
17623             $ref: "#/definitions/routing-instance"
17624     patch:
17625       tags:
17626         - Network
17627       summary: update an existing routing-instance
17628       description: |
17629         Update an existing routing-instance
17630         #
17631         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17632         The PUT operation will entirely replace an existing object.
17633         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17634         #
17635         Other differences between PUT and PATCH are:
17636         #
17637         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17638         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17639         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17640       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17641       consumes:
17642         - application/json
17643         - application/xml
17644       produces:
17645         - application/json
17646         - application/xml
17647       responses:
17648         "default":
17649           description: Response codes found in [response codes](https://wiki.onap.org/).
17650       parameters:
17651         - name: site-pair-set-id
17652           in: path
17653           description: Unique id of site pair set.
17654           required: true
17655           type: string
17656           example: __SITE-PAIR-SET-ID__
17657         - name: routing-instance-id
17658           in: path
17659           description: Unique id of routing instance
17660           required: true
17661           type: string
17662           example: __ROUTING-INSTANCE-ID__
17663         - name: body
17664           in: body
17665           description: routing-instance object that needs to be updated.
17666           required: true
17667           schema:
17668             $ref: "#/patchDefinitions/routing-instance"
17669     delete:
17670       tags:
17671         - Network
17672       summary: delete an existing routing-instance
17673       description: delete an existing routing-instance
17674       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17675       consumes:
17676         - application/json
17677         - application/xml
17678       produces:
17679         - application/json
17680         - application/xml
17681       responses:
17682         "default":
17683           description: Response codes found in [response codes](https://wiki.onap.org/).
17684       parameters:
17685         - name: site-pair-set-id
17686           in: path
17687           description: Unique id of site pair set.
17688           required: true
17689           type: string
17690           example: __SITE-PAIR-SET-ID__
17691         - name: routing-instance-id
17692           in: path
17693           description: Unique id of routing instance
17694           required: true
17695           type: string
17696           example: __ROUTING-INSTANCE-ID__
17697         - name: resource-version
17698           in: query
17699           description: resource-version for concurrency
17700           required: true
17701           type: string
17702   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
17703     get:
17704       tags:
17705         - Network
17706       summary: returns routing-instances
17707       description: returns routing-instances
17708       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
17709       produces:
17710         - application/json
17711         - application/xml
17712       responses:
17713         "200":
17714           description: successful operation
17715           schema:
17716               $ref: "#/getDefinitions/routing-instances"
17717         "default":
17718           description: Response codes found in [response codes](https://wiki.onap.org/).
17719       parameters:
17720         - name: site-pair-set-id
17721           in: path
17722           description: Unique id of site pair set.
17723           required: true
17724           type: string
17725           example: __SITE-PAIR-SET-ID__
17726         - name: routing-instance-id
17727           in: query
17728           description:
17729           required: false
17730           type: string
17731   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
17732     put:
17733       tags:
17734         - Network
17735       summary: see node definition for valid relationships
17736       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
17737       consumes:
17738         - application/json
17739         - application/xml
17740       produces:
17741         - application/json
17742         - application/xml
17743       responses:
17744         "default":
17745           description: Response codes found in [response codes](https://wiki.onap.org/).
17746       parameters:
17747         - name: site-pair-set-id
17748           in: path
17749           description: Unique id of site pair set.
17750           required: true
17751           type: string
17752           example: __SITE-PAIR-SET-ID__
17753         - name: body
17754           in: body
17755           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
17756           required: true
17757           schema:
17758             $ref: "#/definitions/relationship"
17759     delete:
17760       tags:
17761         - Network
17762       summary: delete an existing relationship
17763       description: delete an existing relationship
17764       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
17765       consumes:
17766         - application/json
17767         - application/xml
17768       produces:
17769         - application/json
17770         - application/xml
17771       responses:
17772         "default":
17773           description: Response codes found in [response codes](https://wiki.onap.org/).
17774       parameters:
17775         - name: site-pair-set-id
17776           in: path
17777           description: Unique id of site pair set.
17778           required: true
17779           type: string
17780           example: __SITE-PAIR-SET-ID__
17781   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
17782     get:
17783       tags:
17784         - Network
17785       summary: returns site-pair-set
17786       description: returns site-pair-set
17787       operationId: getNetworkSitePairSetsSitePairSet
17788       produces:
17789         - application/json
17790         - application/xml
17791       responses:
17792         "200":
17793           description: successful operation
17794           schema:
17795               $ref: "#/getDefinitions/site-pair-set"
17796         "default":
17797           description: Response codes found in [response codes](https://wiki.onap.org/).
17798       parameters:
17799         - name: site-pair-set-id
17800           in: path
17801           description: Unique id of site pair set.
17802           required: true
17803           type: string
17804           example: __SITE-PAIR-SET-ID__
17805     put:
17806       tags:
17807         - Network
17808       summary: create or update an existing site-pair-set
17809       description: |
17810         Create or update an existing site-pair-set.
17811         #
17812         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17813       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
17814       consumes:
17815         - application/json
17816         - application/xml
17817       produces:
17818         - application/json
17819         - application/xml
17820       responses:
17821         "default":
17822           description: Response codes found in [response codes](https://wiki.onap.org/).
17823       parameters:
17824         - name: site-pair-set-id
17825           in: path
17826           description: Unique id of site pair set.
17827           required: true
17828           type: string
17829           example: __SITE-PAIR-SET-ID__
17830         - name: body
17831           in: body
17832           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
17833           required: true
17834           schema:
17835             $ref: "#/definitions/site-pair-set"
17836     patch:
17837       tags:
17838         - Network
17839       summary: update an existing site-pair-set
17840       description: |
17841         Update an existing site-pair-set
17842         #
17843         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17844         The PUT operation will entirely replace an existing object.
17845         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17846         #
17847         Other differences between PUT and PATCH are:
17848         #
17849         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17850         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17851         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17852       operationId: UpdateNetworkSitePairSetsSitePairSet
17853       consumes:
17854         - application/json
17855         - application/xml
17856       produces:
17857         - application/json
17858         - application/xml
17859       responses:
17860         "default":
17861           description: Response codes found in [response codes](https://wiki.onap.org/).
17862       parameters:
17863         - name: site-pair-set-id
17864           in: path
17865           description: Unique id of site pair set.
17866           required: true
17867           type: string
17868           example: __SITE-PAIR-SET-ID__
17869         - name: body
17870           in: body
17871           description: site-pair-set object that needs to be updated.
17872           required: true
17873           schema:
17874             $ref: "#/patchDefinitions/site-pair-set"
17875     delete:
17876       tags:
17877         - Network
17878       summary: delete an existing site-pair-set
17879       description: delete an existing site-pair-set
17880       operationId: deleteNetworkSitePairSetsSitePairSet
17881       consumes:
17882         - application/json
17883         - application/xml
17884       produces:
17885         - application/json
17886         - application/xml
17887       responses:
17888         "default":
17889           description: Response codes found in [response codes](https://wiki.onap.org/).
17890       parameters:
17891         - name: site-pair-set-id
17892           in: path
17893           description: Unique id of site pair set.
17894           required: true
17895           type: string
17896           example: __SITE-PAIR-SET-ID__
17897         - name: resource-version
17898           in: query
17899           description: resource-version for concurrency
17900           required: true
17901           type: string
17902   /network/site-pair-sets:
17903     get:
17904       tags:
17905         - Network
17906       summary: returns site-pair-sets
17907       description: returns site-pair-sets
17908       operationId: getNetworkSitePairSets
17909       produces:
17910         - application/json
17911         - application/xml
17912       responses:
17913         "200":
17914           description: successful operation
17915           schema:
17916               $ref: "#/getDefinitions/site-pair-sets"
17917         "default":
17918           description: Response codes found in [response codes](https://wiki.onap.org/).
17919       parameters:
17920         - name: site-pair-set-id
17921           in: query
17922           description:
17923           required: false
17924           type: string
17925   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
17926     put:
17927       tags:
17928         - Network
17929       summary: see node definition for valid relationships
17930       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
17931       consumes:
17932         - application/json
17933         - application/xml
17934       produces:
17935         - application/json
17936         - application/xml
17937       responses:
17938         "default":
17939           description: Response codes found in [response codes](https://wiki.onap.org/).
17940       parameters:
17941         - name: vpn-id
17942           in: path
17943           description: VPN ID, globally unique within A&AI
17944           required: true
17945           type: string
17946           example: __VPN-ID__
17947         - name: body
17948           in: body
17949           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
17950           required: true
17951           schema:
17952             $ref: "#/definitions/relationship"
17953     delete:
17954       tags:
17955         - Network
17956       summary: delete an existing relationship
17957       description: delete an existing relationship
17958       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
17959       consumes:
17960         - application/json
17961         - application/xml
17962       produces:
17963         - application/json
17964         - application/xml
17965       responses:
17966         "default":
17967           description: Response codes found in [response codes](https://wiki.onap.org/).
17968       parameters:
17969         - name: vpn-id
17970           in: path
17971           description: VPN ID, globally unique within A&AI
17972           required: true
17973           type: string
17974           example: __VPN-ID__
17975   /network/vpn-bindings/vpn-binding/{vpn-id}:
17976     get:
17977       tags:
17978         - Network
17979       summary: returns vpn-binding
17980       description: returns vpn-binding
17981       operationId: getNetworkVpnBindingsVpnBinding
17982       produces:
17983         - application/json
17984         - application/xml
17985       responses:
17986         "200":
17987           description: successful operation
17988           schema:
17989               $ref: "#/getDefinitions/vpn-binding"
17990         "default":
17991           description: Response codes found in [response codes](https://wiki.onap.org/).
17992       parameters:
17993         - name: vpn-id
17994           in: path
17995           description: VPN ID, globally unique within A&AI
17996           required: true
17997           type: string
17998           example: __VPN-ID__
17999     put:
18000       tags:
18001         - Network
18002       summary: create or update an existing vpn-binding
18003       description: |
18004         Create or update an existing vpn-binding.
18005         #
18006         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18007       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
18008       consumes:
18009         - application/json
18010         - application/xml
18011       produces:
18012         - application/json
18013         - application/xml
18014       responses:
18015         "default":
18016           description: Response codes found in [response codes](https://wiki.onap.org/).
18017       parameters:
18018         - name: vpn-id
18019           in: path
18020           description: VPN ID, globally unique within A&AI
18021           required: true
18022           type: string
18023           example: __VPN-ID__
18024         - name: body
18025           in: body
18026           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
18027           required: true
18028           schema:
18029             $ref: "#/definitions/vpn-binding"
18030     patch:
18031       tags:
18032         - Network
18033       summary: update an existing vpn-binding
18034       description: |
18035         Update an existing vpn-binding
18036         #
18037         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18038         The PUT operation will entirely replace an existing object.
18039         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18040         #
18041         Other differences between PUT and PATCH are:
18042         #
18043         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18044         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18045         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18046       operationId: UpdateNetworkVpnBindingsVpnBinding
18047       consumes:
18048         - application/json
18049         - application/xml
18050       produces:
18051         - application/json
18052         - application/xml
18053       responses:
18054         "default":
18055           description: Response codes found in [response codes](https://wiki.onap.org/).
18056       parameters:
18057         - name: vpn-id
18058           in: path
18059           description: VPN ID, globally unique within A&AI
18060           required: true
18061           type: string
18062           example: __VPN-ID__
18063         - name: body
18064           in: body
18065           description: vpn-binding object that needs to be updated.
18066           required: true
18067           schema:
18068             $ref: "#/patchDefinitions/vpn-binding"
18069     delete:
18070       tags:
18071         - Network
18072       summary: delete an existing vpn-binding
18073       description: delete an existing vpn-binding
18074       operationId: deleteNetworkVpnBindingsVpnBinding
18075       consumes:
18076         - application/json
18077         - application/xml
18078       produces:
18079         - application/json
18080         - application/xml
18081       responses:
18082         "default":
18083           description: Response codes found in [response codes](https://wiki.onap.org/).
18084       parameters:
18085         - name: vpn-id
18086           in: path
18087           description: VPN ID, globally unique within A&AI
18088           required: true
18089           type: string
18090           example: __VPN-ID__
18091         - name: resource-version
18092           in: query
18093           description: resource-version for concurrency
18094           required: true
18095           type: string
18096   /network/vpn-bindings:
18097     get:
18098       tags:
18099         - Network
18100       summary: returns vpn-bindings
18101       description: returns vpn-bindings
18102       operationId: getNetworkVpnBindings
18103       produces:
18104         - application/json
18105         - application/xml
18106       responses:
18107         "200":
18108           description: successful operation
18109           schema:
18110               $ref: "#/getDefinitions/vpn-bindings"
18111         "default":
18112           description: Response codes found in [response codes](https://wiki.onap.org/).
18113       parameters:
18114         - name: vpn-id
18115           in: query
18116           description:
18117           required: false
18118           type: string
18119         - name: vpn-name
18120           in: query
18121           description:
18122           required: false
18123           type: string
18124         - name: global-route-target
18125           in: query
18126           description:
18127           required: false
18128           type: string
18129   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
18130     put:
18131       tags:
18132         - Network
18133       summary: see node definition for valid relationships
18134       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
18135       consumes:
18136         - application/json
18137         - application/xml
18138       produces:
18139         - application/json
18140         - application/xml
18141       responses:
18142         "default":
18143           description: Response codes found in [response codes](https://wiki.onap.org/).
18144       parameters:
18145         - name: equipment-name
18146           in: path
18147           required: true
18148           type: string
18149           example: __EQUIPMENT-NAME__
18150         - name: body
18151           in: body
18152           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
18153           required: true
18154           schema:
18155             $ref: "#/definitions/relationship"
18156     delete:
18157       tags:
18158         - Network
18159       summary: delete an existing relationship
18160       description: delete an existing relationship
18161       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
18162       consumes:
18163         - application/json
18164         - application/xml
18165       produces:
18166         - application/json
18167         - application/xml
18168       responses:
18169         "default":
18170           description: Response codes found in [response codes](https://wiki.onap.org/).
18171       parameters:
18172         - name: equipment-name
18173           in: path
18174           required: true
18175           type: string
18176           example: __EQUIPMENT-NAME__
18177   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
18178     put:
18179       tags:
18180         - Network
18181       summary: see node definition for valid relationships
18182       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
18183       consumes:
18184         - application/json
18185         - application/xml
18186       produces:
18187         - application/json
18188         - application/xml
18189       responses:
18190         "default":
18191           description: Response codes found in [response codes](https://wiki.onap.org/).
18192       parameters:
18193         - name: equipment-name
18194           in: path
18195           required: true
18196           type: string
18197           example: __EQUIPMENT-NAME__
18198         - name: interface-name
18199           in: path
18200           description: Name that identifies the physical interface
18201           required: true
18202           type: string
18203           example: __INTERFACE-NAME__
18204         - name: body
18205           in: body
18206           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
18207           required: true
18208           schema:
18209             $ref: "#/definitions/relationship"
18210     delete:
18211       tags:
18212         - Network
18213       summary: delete an existing relationship
18214       description: delete an existing relationship
18215       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
18216       consumes:
18217         - application/json
18218         - application/xml
18219       produces:
18220         - application/json
18221         - application/xml
18222       responses:
18223         "default":
18224           description: Response codes found in [response codes](https://wiki.onap.org/).
18225       parameters:
18226         - name: equipment-name
18227           in: path
18228           required: true
18229           type: string
18230           example: __EQUIPMENT-NAME__
18231         - name: interface-name
18232           in: path
18233           description: Name that identifies the physical interface
18234           required: true
18235           type: string
18236           example: __INTERFACE-NAME__
18237   /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:
18238     put:
18239       tags:
18240         - Network
18241       summary: see node definition for valid relationships
18242       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
18243       consumes:
18244         - application/json
18245         - application/xml
18246       produces:
18247         - application/json
18248         - application/xml
18249       responses:
18250         "default":
18251           description: Response codes found in [response codes](https://wiki.onap.org/).
18252       parameters:
18253         - name: equipment-name
18254           in: path
18255           required: true
18256           type: string
18257           example: __EQUIPMENT-NAME__
18258         - name: interface-name
18259           in: path
18260           description: Name that identifies the physical interface
18261           required: true
18262           type: string
18263           example: __INTERFACE-NAME__
18264         - name: interface-name
18265           in: path
18266           description: Name given to the interface
18267           required: true
18268           type: string
18269           example: __INTERFACE-NAME__
18270         - name: vlan-interface
18271           in: path
18272           description: String that identifies the interface
18273           required: true
18274           type: string
18275           example: __VLAN-INTERFACE__
18276         - name: body
18277           in: body
18278           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
18279           required: true
18280           schema:
18281             $ref: "#/definitions/relationship"
18282     delete:
18283       tags:
18284         - Network
18285       summary: delete an existing relationship
18286       description: delete an existing relationship
18287       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
18288       consumes:
18289         - application/json
18290         - application/xml
18291       produces:
18292         - application/json
18293         - application/xml
18294       responses:
18295         "default":
18296           description: Response codes found in [response codes](https://wiki.onap.org/).
18297       parameters:
18298         - name: equipment-name
18299           in: path
18300           required: true
18301           type: string
18302           example: __EQUIPMENT-NAME__
18303         - name: interface-name
18304           in: path
18305           description: Name that identifies the physical interface
18306           required: true
18307           type: string
18308           example: __INTERFACE-NAME__
18309         - name: interface-name
18310           in: path
18311           description: Name given to the interface
18312           required: true
18313           type: string
18314           example: __INTERFACE-NAME__
18315         - name: vlan-interface
18316           in: path
18317           description: String that identifies the interface
18318           required: true
18319           type: string
18320           example: __VLAN-INTERFACE__
18321   /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:
18322     put:
18323       tags:
18324         - Network
18325       summary: see node definition for valid relationships
18326       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
18327       consumes:
18328         - application/json
18329         - application/xml
18330       produces:
18331         - application/json
18332         - application/xml
18333       responses:
18334         "default":
18335           description: Response codes found in [response codes](https://wiki.onap.org/).
18336       parameters:
18337         - name: equipment-name
18338           in: path
18339           required: true
18340           type: string
18341           example: __EQUIPMENT-NAME__
18342         - name: interface-name
18343           in: path
18344           description: Name that identifies the physical interface
18345           required: true
18346           type: string
18347           example: __INTERFACE-NAME__
18348         - name: interface-name
18349           in: path
18350           description: Name given to the interface
18351           required: true
18352           type: string
18353           example: __INTERFACE-NAME__
18354         - name: vlan-interface
18355           in: path
18356           description: String that identifies the interface
18357           required: true
18358           type: string
18359           example: __VLAN-INTERFACE__
18360         - name: l3-interface-ipv4-address
18361           in: path
18362           description: IP address
18363           required: true
18364           type: string
18365           example: __L3-INTERFACE-IPV4-ADDRESS__
18366         - name: body
18367           in: body
18368           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
18369           required: true
18370           schema:
18371             $ref: "#/definitions/relationship"
18372     delete:
18373       tags:
18374         - Network
18375       summary: delete an existing relationship
18376       description: delete an existing relationship
18377       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
18378       consumes:
18379         - application/json
18380         - application/xml
18381       produces:
18382         - application/json
18383         - application/xml
18384       responses:
18385         "default":
18386           description: Response codes found in [response codes](https://wiki.onap.org/).
18387       parameters:
18388         - name: equipment-name
18389           in: path
18390           required: true
18391           type: string
18392           example: __EQUIPMENT-NAME__
18393         - name: interface-name
18394           in: path
18395           description: Name that identifies the physical interface
18396           required: true
18397           type: string
18398           example: __INTERFACE-NAME__
18399         - name: interface-name
18400           in: path
18401           description: Name given to the interface
18402           required: true
18403           type: string
18404           example: __INTERFACE-NAME__
18405         - name: vlan-interface
18406           in: path
18407           description: String that identifies the interface
18408           required: true
18409           type: string
18410           example: __VLAN-INTERFACE__
18411         - name: l3-interface-ipv4-address
18412           in: path
18413           description: IP address
18414           required: true
18415           type: string
18416           example: __L3-INTERFACE-IPV4-ADDRESS__
18417   /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}:
18418     get:
18419       tags:
18420         - Network
18421       summary: returns l3-interface-ipv4-address-list
18422       description: returns l3-interface-ipv4-address-list
18423       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18424       produces:
18425         - application/json
18426         - application/xml
18427       responses:
18428         "200":
18429           description: successful operation
18430           schema:
18431               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
18432         "default":
18433           description: Response codes found in [response codes](https://wiki.onap.org/).
18434       parameters:
18435         - name: equipment-name
18436           in: path
18437           required: true
18438           type: string
18439           example: __EQUIPMENT-NAME__
18440         - name: interface-name
18441           in: path
18442           description: Name that identifies the physical interface
18443           required: true
18444           type: string
18445           example: __INTERFACE-NAME__
18446         - name: interface-name
18447           in: path
18448           description: Name given to the interface
18449           required: true
18450           type: string
18451           example: __INTERFACE-NAME__
18452         - name: vlan-interface
18453           in: path
18454           description: String that identifies the interface
18455           required: true
18456           type: string
18457           example: __VLAN-INTERFACE__
18458         - name: l3-interface-ipv4-address
18459           in: path
18460           description: IP address
18461           required: true
18462           type: string
18463           example: __L3-INTERFACE-IPV4-ADDRESS__
18464     put:
18465       tags:
18466         - Network
18467       summary: create or update an existing l3-interface-ipv4-address-list
18468       description: |
18469         Create or update an existing l3-interface-ipv4-address-list.
18470         #
18471         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18472       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18473       consumes:
18474         - application/json
18475         - application/xml
18476       produces:
18477         - application/json
18478         - application/xml
18479       responses:
18480         "default":
18481           description: Response codes found in [response codes](https://wiki.onap.org/).
18482       parameters:
18483         - name: equipment-name
18484           in: path
18485           required: true
18486           type: string
18487           example: __EQUIPMENT-NAME__
18488         - name: interface-name
18489           in: path
18490           description: Name that identifies the physical interface
18491           required: true
18492           type: string
18493           example: __INTERFACE-NAME__
18494         - name: interface-name
18495           in: path
18496           description: Name given to the interface
18497           required: true
18498           type: string
18499           example: __INTERFACE-NAME__
18500         - name: vlan-interface
18501           in: path
18502           description: String that identifies the interface
18503           required: true
18504           type: string
18505           example: __VLAN-INTERFACE__
18506         - name: l3-interface-ipv4-address
18507           in: path
18508           description: IP address
18509           required: true
18510           type: string
18511           example: __L3-INTERFACE-IPV4-ADDRESS__
18512         - name: body
18513           in: body
18514           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
18515           required: true
18516           schema:
18517             $ref: "#/definitions/l3-interface-ipv4-address-list"
18518     patch:
18519       tags:
18520         - Network
18521       summary: update an existing l3-interface-ipv4-address-list
18522       description: |
18523         Update an existing l3-interface-ipv4-address-list
18524         #
18525         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18526         The PUT operation will entirely replace an existing object.
18527         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18528         #
18529         Other differences between PUT and PATCH are:
18530         #
18531         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18532         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18533         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18534       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18535       consumes:
18536         - application/json
18537         - application/xml
18538       produces:
18539         - application/json
18540         - application/xml
18541       responses:
18542         "default":
18543           description: Response codes found in [response codes](https://wiki.onap.org/).
18544       parameters:
18545         - name: equipment-name
18546           in: path
18547           required: true
18548           type: string
18549           example: __EQUIPMENT-NAME__
18550         - name: interface-name
18551           in: path
18552           description: Name that identifies the physical interface
18553           required: true
18554           type: string
18555           example: __INTERFACE-NAME__
18556         - name: interface-name
18557           in: path
18558           description: Name given to the interface
18559           required: true
18560           type: string
18561           example: __INTERFACE-NAME__
18562         - name: vlan-interface
18563           in: path
18564           description: String that identifies the interface
18565           required: true
18566           type: string
18567           example: __VLAN-INTERFACE__
18568         - name: l3-interface-ipv4-address
18569           in: path
18570           description: IP address
18571           required: true
18572           type: string
18573           example: __L3-INTERFACE-IPV4-ADDRESS__
18574         - name: body
18575           in: body
18576           description: l3-interface-ipv4-address-list object that needs to be updated.
18577           required: true
18578           schema:
18579             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
18580     delete:
18581       tags:
18582         - Network
18583       summary: delete an existing l3-interface-ipv4-address-list
18584       description: delete an existing l3-interface-ipv4-address-list
18585       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18586       consumes:
18587         - application/json
18588         - application/xml
18589       produces:
18590         - application/json
18591         - application/xml
18592       responses:
18593         "default":
18594           description: Response codes found in [response codes](https://wiki.onap.org/).
18595       parameters:
18596         - name: equipment-name
18597           in: path
18598           required: true
18599           type: string
18600           example: __EQUIPMENT-NAME__
18601         - name: interface-name
18602           in: path
18603           description: Name that identifies the physical interface
18604           required: true
18605           type: string
18606           example: __INTERFACE-NAME__
18607         - name: interface-name
18608           in: path
18609           description: Name given to the interface
18610           required: true
18611           type: string
18612           example: __INTERFACE-NAME__
18613         - name: vlan-interface
18614           in: path
18615           description: String that identifies the interface
18616           required: true
18617           type: string
18618           example: __VLAN-INTERFACE__
18619         - name: l3-interface-ipv4-address
18620           in: path
18621           description: IP address
18622           required: true
18623           type: string
18624           example: __L3-INTERFACE-IPV4-ADDRESS__
18625         - name: resource-version
18626           in: query
18627           description: resource-version for concurrency
18628           required: true
18629           type: string
18630   /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:
18631     put:
18632       tags:
18633         - Network
18634       summary: see node definition for valid relationships
18635       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
18636       consumes:
18637         - application/json
18638         - application/xml
18639       produces:
18640         - application/json
18641         - application/xml
18642       responses:
18643         "default":
18644           description: Response codes found in [response codes](https://wiki.onap.org/).
18645       parameters:
18646         - name: equipment-name
18647           in: path
18648           required: true
18649           type: string
18650           example: __EQUIPMENT-NAME__
18651         - name: interface-name
18652           in: path
18653           description: Name that identifies the physical interface
18654           required: true
18655           type: string
18656           example: __INTERFACE-NAME__
18657         - name: interface-name
18658           in: path
18659           description: Name given to the interface
18660           required: true
18661           type: string
18662           example: __INTERFACE-NAME__
18663         - name: vlan-interface
18664           in: path
18665           description: String that identifies the interface
18666           required: true
18667           type: string
18668           example: __VLAN-INTERFACE__
18669         - name: l3-interface-ipv6-address
18670           in: path
18671           description: IP address
18672           required: true
18673           type: string
18674           example: __L3-INTERFACE-IPV6-ADDRESS__
18675         - name: body
18676           in: body
18677           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
18678           required: true
18679           schema:
18680             $ref: "#/definitions/relationship"
18681     delete:
18682       tags:
18683         - Network
18684       summary: delete an existing relationship
18685       description: delete an existing relationship
18686       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
18687       consumes:
18688         - application/json
18689         - application/xml
18690       produces:
18691         - application/json
18692         - application/xml
18693       responses:
18694         "default":
18695           description: Response codes found in [response codes](https://wiki.onap.org/).
18696       parameters:
18697         - name: equipment-name
18698           in: path
18699           required: true
18700           type: string
18701           example: __EQUIPMENT-NAME__
18702         - name: interface-name
18703           in: path
18704           description: Name that identifies the physical interface
18705           required: true
18706           type: string
18707           example: __INTERFACE-NAME__
18708         - name: interface-name
18709           in: path
18710           description: Name given to the interface
18711           required: true
18712           type: string
18713           example: __INTERFACE-NAME__
18714         - name: vlan-interface
18715           in: path
18716           description: String that identifies the interface
18717           required: true
18718           type: string
18719           example: __VLAN-INTERFACE__
18720         - name: l3-interface-ipv6-address
18721           in: path
18722           description: IP address
18723           required: true
18724           type: string
18725           example: __L3-INTERFACE-IPV6-ADDRESS__
18726   /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}:
18727     get:
18728       tags:
18729         - Network
18730       summary: returns l3-interface-ipv6-address-list
18731       description: returns l3-interface-ipv6-address-list
18732       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18733       produces:
18734         - application/json
18735         - application/xml
18736       responses:
18737         "200":
18738           description: successful operation
18739           schema:
18740               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
18741         "default":
18742           description: Response codes found in [response codes](https://wiki.onap.org/).
18743       parameters:
18744         - name: equipment-name
18745           in: path
18746           required: true
18747           type: string
18748           example: __EQUIPMENT-NAME__
18749         - name: interface-name
18750           in: path
18751           description: Name that identifies the physical interface
18752           required: true
18753           type: string
18754           example: __INTERFACE-NAME__
18755         - name: interface-name
18756           in: path
18757           description: Name given to the interface
18758           required: true
18759           type: string
18760           example: __INTERFACE-NAME__
18761         - name: vlan-interface
18762           in: path
18763           description: String that identifies the interface
18764           required: true
18765           type: string
18766           example: __VLAN-INTERFACE__
18767         - name: l3-interface-ipv6-address
18768           in: path
18769           description: IP address
18770           required: true
18771           type: string
18772           example: __L3-INTERFACE-IPV6-ADDRESS__
18773     put:
18774       tags:
18775         - Network
18776       summary: create or update an existing l3-interface-ipv6-address-list
18777       description: |
18778         Create or update an existing l3-interface-ipv6-address-list.
18779         #
18780         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18781       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18782       consumes:
18783         - application/json
18784         - application/xml
18785       produces:
18786         - application/json
18787         - application/xml
18788       responses:
18789         "default":
18790           description: Response codes found in [response codes](https://wiki.onap.org/).
18791       parameters:
18792         - name: equipment-name
18793           in: path
18794           required: true
18795           type: string
18796           example: __EQUIPMENT-NAME__
18797         - name: interface-name
18798           in: path
18799           description: Name that identifies the physical interface
18800           required: true
18801           type: string
18802           example: __INTERFACE-NAME__
18803         - name: interface-name
18804           in: path
18805           description: Name given to the interface
18806           required: true
18807           type: string
18808           example: __INTERFACE-NAME__
18809         - name: vlan-interface
18810           in: path
18811           description: String that identifies the interface
18812           required: true
18813           type: string
18814           example: __VLAN-INTERFACE__
18815         - name: l3-interface-ipv6-address
18816           in: path
18817           description: IP address
18818           required: true
18819           type: string
18820           example: __L3-INTERFACE-IPV6-ADDRESS__
18821         - name: body
18822           in: body
18823           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
18824           required: true
18825           schema:
18826             $ref: "#/definitions/l3-interface-ipv6-address-list"
18827     patch:
18828       tags:
18829         - Network
18830       summary: update an existing l3-interface-ipv6-address-list
18831       description: |
18832         Update an existing l3-interface-ipv6-address-list
18833         #
18834         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18835         The PUT operation will entirely replace an existing object.
18836         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18837         #
18838         Other differences between PUT and PATCH are:
18839         #
18840         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18841         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18842         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18843       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18844       consumes:
18845         - application/json
18846         - application/xml
18847       produces:
18848         - application/json
18849         - application/xml
18850       responses:
18851         "default":
18852           description: Response codes found in [response codes](https://wiki.onap.org/).
18853       parameters:
18854         - name: equipment-name
18855           in: path
18856           required: true
18857           type: string
18858           example: __EQUIPMENT-NAME__
18859         - name: interface-name
18860           in: path
18861           description: Name that identifies the physical interface
18862           required: true
18863           type: string
18864           example: __INTERFACE-NAME__
18865         - name: interface-name
18866           in: path
18867           description: Name given to the interface
18868           required: true
18869           type: string
18870           example: __INTERFACE-NAME__
18871         - name: vlan-interface
18872           in: path
18873           description: String that identifies the interface
18874           required: true
18875           type: string
18876           example: __VLAN-INTERFACE__
18877         - name: l3-interface-ipv6-address
18878           in: path
18879           description: IP address
18880           required: true
18881           type: string
18882           example: __L3-INTERFACE-IPV6-ADDRESS__
18883         - name: body
18884           in: body
18885           description: l3-interface-ipv6-address-list object that needs to be updated.
18886           required: true
18887           schema:
18888             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
18889     delete:
18890       tags:
18891         - Network
18892       summary: delete an existing l3-interface-ipv6-address-list
18893       description: delete an existing l3-interface-ipv6-address-list
18894       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18895       consumes:
18896         - application/json
18897         - application/xml
18898       produces:
18899         - application/json
18900         - application/xml
18901       responses:
18902         "default":
18903           description: Response codes found in [response codes](https://wiki.onap.org/).
18904       parameters:
18905         - name: equipment-name
18906           in: path
18907           required: true
18908           type: string
18909           example: __EQUIPMENT-NAME__
18910         - name: interface-name
18911           in: path
18912           description: Name that identifies the physical interface
18913           required: true
18914           type: string
18915           example: __INTERFACE-NAME__
18916         - name: interface-name
18917           in: path
18918           description: Name given to the interface
18919           required: true
18920           type: string
18921           example: __INTERFACE-NAME__
18922         - name: vlan-interface
18923           in: path
18924           description: String that identifies the interface
18925           required: true
18926           type: string
18927           example: __VLAN-INTERFACE__
18928         - name: l3-interface-ipv6-address
18929           in: path
18930           description: IP address
18931           required: true
18932           type: string
18933           example: __L3-INTERFACE-IPV6-ADDRESS__
18934         - name: resource-version
18935           in: query
18936           description: resource-version for concurrency
18937           required: true
18938           type: string
18939   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
18940     get:
18941       tags:
18942         - Network
18943       summary: returns vlan
18944       description: returns vlan
18945       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
18946       produces:
18947         - application/json
18948         - application/xml
18949       responses:
18950         "200":
18951           description: successful operation
18952           schema:
18953               $ref: "#/getDefinitions/vlan"
18954         "default":
18955           description: Response codes found in [response codes](https://wiki.onap.org/).
18956       parameters:
18957         - name: equipment-name
18958           in: path
18959           required: true
18960           type: string
18961           example: __EQUIPMENT-NAME__
18962         - name: interface-name
18963           in: path
18964           description: Name that identifies the physical interface
18965           required: true
18966           type: string
18967           example: __INTERFACE-NAME__
18968         - name: interface-name
18969           in: path
18970           description: Name given to the interface
18971           required: true
18972           type: string
18973           example: __INTERFACE-NAME__
18974         - name: vlan-interface
18975           in: path
18976           description: String that identifies the interface
18977           required: true
18978           type: string
18979           example: __VLAN-INTERFACE__
18980     put:
18981       tags:
18982         - Network
18983       summary: create or update an existing vlan
18984       description: |
18985         Create or update an existing vlan.
18986         #
18987         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18988       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
18989       consumes:
18990         - application/json
18991         - application/xml
18992       produces:
18993         - application/json
18994         - application/xml
18995       responses:
18996         "default":
18997           description: Response codes found in [response codes](https://wiki.onap.org/).
18998       parameters:
18999         - name: equipment-name
19000           in: path
19001           required: true
19002           type: string
19003           example: __EQUIPMENT-NAME__
19004         - name: interface-name
19005           in: path
19006           description: Name that identifies the physical interface
19007           required: true
19008           type: string
19009           example: __INTERFACE-NAME__
19010         - name: interface-name
19011           in: path
19012           description: Name given to the interface
19013           required: true
19014           type: string
19015           example: __INTERFACE-NAME__
19016         - name: vlan-interface
19017           in: path
19018           description: String that identifies the interface
19019           required: true
19020           type: string
19021           example: __VLAN-INTERFACE__
19022         - name: body
19023           in: body
19024           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19025           required: true
19026           schema:
19027             $ref: "#/definitions/vlan"
19028     patch:
19029       tags:
19030         - Network
19031       summary: update an existing vlan
19032       description: |
19033         Update an existing vlan
19034         #
19035         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19036         The PUT operation will entirely replace an existing object.
19037         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19038         #
19039         Other differences between PUT and PATCH are:
19040         #
19041         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19042         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19043         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19044       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
19045       consumes:
19046         - application/json
19047         - application/xml
19048       produces:
19049         - application/json
19050         - application/xml
19051       responses:
19052         "default":
19053           description: Response codes found in [response codes](https://wiki.onap.org/).
19054       parameters:
19055         - name: equipment-name
19056           in: path
19057           required: true
19058           type: string
19059           example: __EQUIPMENT-NAME__
19060         - name: interface-name
19061           in: path
19062           description: Name that identifies the physical interface
19063           required: true
19064           type: string
19065           example: __INTERFACE-NAME__
19066         - name: interface-name
19067           in: path
19068           description: Name given to the interface
19069           required: true
19070           type: string
19071           example: __INTERFACE-NAME__
19072         - name: vlan-interface
19073           in: path
19074           description: String that identifies the interface
19075           required: true
19076           type: string
19077           example: __VLAN-INTERFACE__
19078         - name: body
19079           in: body
19080           description: vlan object that needs to be updated.
19081           required: true
19082           schema:
19083             $ref: "#/patchDefinitions/vlan"
19084     delete:
19085       tags:
19086         - Network
19087       summary: delete an existing vlan
19088       description: delete an existing vlan
19089       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
19090       consumes:
19091         - application/json
19092         - application/xml
19093       produces:
19094         - application/json
19095         - application/xml
19096       responses:
19097         "default":
19098           description: Response codes found in [response codes](https://wiki.onap.org/).
19099       parameters:
19100         - name: equipment-name
19101           in: path
19102           required: true
19103           type: string
19104           example: __EQUIPMENT-NAME__
19105         - name: interface-name
19106           in: path
19107           description: Name that identifies the physical interface
19108           required: true
19109           type: string
19110           example: __INTERFACE-NAME__
19111         - name: interface-name
19112           in: path
19113           description: Name given to the interface
19114           required: true
19115           type: string
19116           example: __INTERFACE-NAME__
19117         - name: vlan-interface
19118           in: path
19119           description: String that identifies the interface
19120           required: true
19121           type: string
19122           example: __VLAN-INTERFACE__
19123         - name: resource-version
19124           in: query
19125           description: resource-version for concurrency
19126           required: true
19127           type: string
19128   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
19129     get:
19130       tags:
19131         - Network
19132       summary: returns vlans
19133       description: returns vlans
19134       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
19135       produces:
19136         - application/json
19137         - application/xml
19138       responses:
19139         "200":
19140           description: successful operation
19141           schema:
19142               $ref: "#/getDefinitions/vlans"
19143         "default":
19144           description: Response codes found in [response codes](https://wiki.onap.org/).
19145       parameters:
19146         - name: equipment-name
19147           in: path
19148           required: true
19149           type: string
19150           example: __EQUIPMENT-NAME__
19151         - name: interface-name
19152           in: path
19153           description: Name that identifies the physical interface
19154           required: true
19155           type: string
19156           example: __INTERFACE-NAME__
19157         - name: interface-name
19158           in: path
19159           description: Name given to the interface
19160           required: true
19161           type: string
19162           example: __INTERFACE-NAME__
19163         - name: vlan-interface
19164           in: query
19165           description:
19166           required: false
19167           type: string
19168         - name: vlan-id-inner
19169           in: query
19170           description:
19171           required: false
19172           type: integer
19173           format: int64
19174         - name: vpn-id
19175           in: query
19176           description:
19177           required: false
19178           type: string
19179   /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:
19180     put:
19181       tags:
19182         - Network
19183       summary: see node definition for valid relationships
19184       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
19185       consumes:
19186         - application/json
19187         - application/xml
19188       produces:
19189         - application/json
19190         - application/xml
19191       responses:
19192         "default":
19193           description: Response codes found in [response codes](https://wiki.onap.org/).
19194       parameters:
19195         - name: equipment-name
19196           in: path
19197           required: true
19198           type: string
19199           example: __EQUIPMENT-NAME__
19200         - name: interface-name
19201           in: path
19202           description: Name that identifies the physical interface
19203           required: true
19204           type: string
19205           example: __INTERFACE-NAME__
19206         - name: interface-name
19207           in: path
19208           description: Name given to the interface
19209           required: true
19210           type: string
19211           example: __INTERFACE-NAME__
19212         - name: pci-id
19213           in: path
19214           description: PCI ID used to identify the sriov-vf
19215           required: true
19216           type: string
19217           example: __PCI-ID__
19218         - name: body
19219           in: body
19220           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
19221           required: true
19222           schema:
19223             $ref: "#/definitions/relationship"
19224     delete:
19225       tags:
19226         - Network
19227       summary: delete an existing relationship
19228       description: delete an existing relationship
19229       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
19230       consumes:
19231         - application/json
19232         - application/xml
19233       produces:
19234         - application/json
19235         - application/xml
19236       responses:
19237         "default":
19238           description: Response codes found in [response codes](https://wiki.onap.org/).
19239       parameters:
19240         - name: equipment-name
19241           in: path
19242           required: true
19243           type: string
19244           example: __EQUIPMENT-NAME__
19245         - name: interface-name
19246           in: path
19247           description: Name that identifies the physical interface
19248           required: true
19249           type: string
19250           example: __INTERFACE-NAME__
19251         - name: interface-name
19252           in: path
19253           description: Name given to the interface
19254           required: true
19255           type: string
19256           example: __INTERFACE-NAME__
19257         - name: pci-id
19258           in: path
19259           description: PCI ID used to identify the sriov-vf
19260           required: true
19261           type: string
19262           example: __PCI-ID__
19263   /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}:
19264     get:
19265       tags:
19266         - Network
19267       summary: returns sriov-vf
19268       description: returns sriov-vf
19269       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19270       produces:
19271         - application/json
19272         - application/xml
19273       responses:
19274         "200":
19275           description: successful operation
19276           schema:
19277               $ref: "#/getDefinitions/sriov-vf"
19278         "default":
19279           description: Response codes found in [response codes](https://wiki.onap.org/).
19280       parameters:
19281         - name: equipment-name
19282           in: path
19283           required: true
19284           type: string
19285           example: __EQUIPMENT-NAME__
19286         - name: interface-name
19287           in: path
19288           description: Name that identifies the physical interface
19289           required: true
19290           type: string
19291           example: __INTERFACE-NAME__
19292         - name: interface-name
19293           in: path
19294           description: Name given to the interface
19295           required: true
19296           type: string
19297           example: __INTERFACE-NAME__
19298         - name: pci-id
19299           in: path
19300           description: PCI ID used to identify the sriov-vf
19301           required: true
19302           type: string
19303           example: __PCI-ID__
19304     put:
19305       tags:
19306         - Network
19307       summary: create or update an existing sriov-vf
19308       description: |
19309         Create or update an existing sriov-vf.
19310         #
19311         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19312       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19313       consumes:
19314         - application/json
19315         - application/xml
19316       produces:
19317         - application/json
19318         - application/xml
19319       responses:
19320         "default":
19321           description: Response codes found in [response codes](https://wiki.onap.org/).
19322       parameters:
19323         - name: equipment-name
19324           in: path
19325           required: true
19326           type: string
19327           example: __EQUIPMENT-NAME__
19328         - name: interface-name
19329           in: path
19330           description: Name that identifies the physical interface
19331           required: true
19332           type: string
19333           example: __INTERFACE-NAME__
19334         - name: interface-name
19335           in: path
19336           description: Name given to the interface
19337           required: true
19338           type: string
19339           example: __INTERFACE-NAME__
19340         - name: pci-id
19341           in: path
19342           description: PCI ID used to identify the sriov-vf
19343           required: true
19344           type: string
19345           example: __PCI-ID__
19346         - name: body
19347           in: body
19348           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
19349           required: true
19350           schema:
19351             $ref: "#/definitions/sriov-vf"
19352     patch:
19353       tags:
19354         - Network
19355       summary: update an existing sriov-vf
19356       description: |
19357         Update an existing sriov-vf
19358         #
19359         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19360         The PUT operation will entirely replace an existing object.
19361         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19362         #
19363         Other differences between PUT and PATCH are:
19364         #
19365         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19366         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19367         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19368       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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: equipment-name
19380           in: path
19381           required: true
19382           type: string
19383           example: __EQUIPMENT-NAME__
19384         - name: interface-name
19385           in: path
19386           description: Name that identifies the physical interface
19387           required: true
19388           type: string
19389           example: __INTERFACE-NAME__
19390         - name: interface-name
19391           in: path
19392           description: Name given to the interface
19393           required: true
19394           type: string
19395           example: __INTERFACE-NAME__
19396         - name: pci-id
19397           in: path
19398           description: PCI ID used to identify the sriov-vf
19399           required: true
19400           type: string
19401           example: __PCI-ID__
19402         - name: body
19403           in: body
19404           description: sriov-vf object that needs to be updated.
19405           required: true
19406           schema:
19407             $ref: "#/patchDefinitions/sriov-vf"
19408     delete:
19409       tags:
19410         - Network
19411       summary: delete an existing sriov-vf
19412       description: delete an existing sriov-vf
19413       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19414       consumes:
19415         - application/json
19416         - application/xml
19417       produces:
19418         - application/json
19419         - application/xml
19420       responses:
19421         "default":
19422           description: Response codes found in [response codes](https://wiki.onap.org/).
19423       parameters:
19424         - name: equipment-name
19425           in: path
19426           required: true
19427           type: string
19428           example: __EQUIPMENT-NAME__
19429         - name: interface-name
19430           in: path
19431           description: Name that identifies the physical interface
19432           required: true
19433           type: string
19434           example: __INTERFACE-NAME__
19435         - name: interface-name
19436           in: path
19437           description: Name given to the interface
19438           required: true
19439           type: string
19440           example: __INTERFACE-NAME__
19441         - name: pci-id
19442           in: path
19443           description: PCI ID used to identify the sriov-vf
19444           required: true
19445           type: string
19446           example: __PCI-ID__
19447         - name: resource-version
19448           in: query
19449           description: resource-version for concurrency
19450           required: true
19451           type: string
19452   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
19453     get:
19454       tags:
19455         - Network
19456       summary: returns sriov-vfs
19457       description: returns sriov-vfs
19458       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
19459       produces:
19460         - application/json
19461         - application/xml
19462       responses:
19463         "200":
19464           description: successful operation
19465           schema:
19466               $ref: "#/getDefinitions/sriov-vfs"
19467         "default":
19468           description: Response codes found in [response codes](https://wiki.onap.org/).
19469       parameters:
19470         - name: equipment-name
19471           in: path
19472           required: true
19473           type: string
19474           example: __EQUIPMENT-NAME__
19475         - name: interface-name
19476           in: path
19477           description: Name that identifies the physical interface
19478           required: true
19479           type: string
19480           example: __INTERFACE-NAME__
19481         - name: interface-name
19482           in: path
19483           description: Name given to the interface
19484           required: true
19485           type: string
19486           example: __INTERFACE-NAME__
19487         - name: pci-id
19488           in: query
19489           description:
19490           required: false
19491           type: string
19492         - name: vf-vlan-filter
19493           in: query
19494           description:
19495           required: false
19496           type: string
19497         - name: vf-mac-filter
19498           in: query
19499           description:
19500           required: false
19501           type: string
19502         - name: vf-vlan-strip
19503           in: query
19504           description:
19505           required: false
19506           type: boolean
19507         - name: neutron-network-id
19508           in: query
19509           description:
19510           required: false
19511           type: string
19512   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
19513     put:
19514       tags:
19515         - Network
19516       summary: see node definition for valid relationships
19517       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
19518       consumes:
19519         - application/json
19520         - application/xml
19521       produces:
19522         - application/json
19523         - application/xml
19524       responses:
19525         "default":
19526           description: Response codes found in [response codes](https://wiki.onap.org/).
19527       parameters:
19528         - name: equipment-name
19529           in: path
19530           required: true
19531           type: string
19532           example: __EQUIPMENT-NAME__
19533         - name: interface-name
19534           in: path
19535           description: Name that identifies the physical interface
19536           required: true
19537           type: string
19538           example: __INTERFACE-NAME__
19539         - name: interface-name
19540           in: path
19541           description: Name given to the interface
19542           required: true
19543           type: string
19544           example: __INTERFACE-NAME__
19545         - name: body
19546           in: body
19547           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
19548           required: true
19549           schema:
19550             $ref: "#/definitions/relationship"
19551     delete:
19552       tags:
19553         - Network
19554       summary: delete an existing relationship
19555       description: delete an existing relationship
19556       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
19557       consumes:
19558         - application/json
19559         - application/xml
19560       produces:
19561         - application/json
19562         - application/xml
19563       responses:
19564         "default":
19565           description: Response codes found in [response codes](https://wiki.onap.org/).
19566       parameters:
19567         - name: equipment-name
19568           in: path
19569           required: true
19570           type: string
19571           example: __EQUIPMENT-NAME__
19572         - name: interface-name
19573           in: path
19574           description: Name that identifies the physical interface
19575           required: true
19576           type: string
19577           example: __INTERFACE-NAME__
19578         - name: interface-name
19579           in: path
19580           description: Name given to the interface
19581           required: true
19582           type: string
19583           example: __INTERFACE-NAME__
19584   /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:
19585     put:
19586       tags:
19587         - Network
19588       summary: see node definition for valid relationships
19589       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
19590       consumes:
19591         - application/json
19592         - application/xml
19593       produces:
19594         - application/json
19595         - application/xml
19596       responses:
19597         "default":
19598           description: Response codes found in [response codes](https://wiki.onap.org/).
19599       parameters:
19600         - name: equipment-name
19601           in: path
19602           required: true
19603           type: string
19604           example: __EQUIPMENT-NAME__
19605         - name: interface-name
19606           in: path
19607           description: Name that identifies the physical interface
19608           required: true
19609           type: string
19610           example: __INTERFACE-NAME__
19611         - name: interface-name
19612           in: path
19613           description: Name given to the interface
19614           required: true
19615           type: string
19616           example: __INTERFACE-NAME__
19617         - name: l3-interface-ipv4-address
19618           in: path
19619           description: IP address
19620           required: true
19621           type: string
19622           example: __L3-INTERFACE-IPV4-ADDRESS__
19623         - name: body
19624           in: body
19625           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
19626           required: true
19627           schema:
19628             $ref: "#/definitions/relationship"
19629     delete:
19630       tags:
19631         - Network
19632       summary: delete an existing relationship
19633       description: delete an existing relationship
19634       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
19635       consumes:
19636         - application/json
19637         - application/xml
19638       produces:
19639         - application/json
19640         - application/xml
19641       responses:
19642         "default":
19643           description: Response codes found in [response codes](https://wiki.onap.org/).
19644       parameters:
19645         - name: equipment-name
19646           in: path
19647           required: true
19648           type: string
19649           example: __EQUIPMENT-NAME__
19650         - name: interface-name
19651           in: path
19652           description: Name that identifies the physical interface
19653           required: true
19654           type: string
19655           example: __INTERFACE-NAME__
19656         - name: interface-name
19657           in: path
19658           description: Name given to the interface
19659           required: true
19660           type: string
19661           example: __INTERFACE-NAME__
19662         - name: l3-interface-ipv4-address
19663           in: path
19664           description: IP address
19665           required: true
19666           type: string
19667           example: __L3-INTERFACE-IPV4-ADDRESS__
19668   /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}:
19669     get:
19670       tags:
19671         - Network
19672       summary: returns l3-interface-ipv4-address-list
19673       description: returns l3-interface-ipv4-address-list
19674       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19675       produces:
19676         - application/json
19677         - application/xml
19678       responses:
19679         "200":
19680           description: successful operation
19681           schema:
19682               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19683         "default":
19684           description: Response codes found in [response codes](https://wiki.onap.org/).
19685       parameters:
19686         - name: equipment-name
19687           in: path
19688           required: true
19689           type: string
19690           example: __EQUIPMENT-NAME__
19691         - name: interface-name
19692           in: path
19693           description: Name that identifies the physical interface
19694           required: true
19695           type: string
19696           example: __INTERFACE-NAME__
19697         - name: interface-name
19698           in: path
19699           description: Name given to the interface
19700           required: true
19701           type: string
19702           example: __INTERFACE-NAME__
19703         - name: l3-interface-ipv4-address
19704           in: path
19705           description: IP address
19706           required: true
19707           type: string
19708           example: __L3-INTERFACE-IPV4-ADDRESS__
19709     put:
19710       tags:
19711         - Network
19712       summary: create or update an existing l3-interface-ipv4-address-list
19713       description: |
19714         Create or update an existing l3-interface-ipv4-address-list.
19715         #
19716         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19717       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19718       consumes:
19719         - application/json
19720         - application/xml
19721       produces:
19722         - application/json
19723         - application/xml
19724       responses:
19725         "default":
19726           description: Response codes found in [response codes](https://wiki.onap.org/).
19727       parameters:
19728         - name: equipment-name
19729           in: path
19730           required: true
19731           type: string
19732           example: __EQUIPMENT-NAME__
19733         - name: interface-name
19734           in: path
19735           description: Name that identifies the physical interface
19736           required: true
19737           type: string
19738           example: __INTERFACE-NAME__
19739         - name: interface-name
19740           in: path
19741           description: Name given to the interface
19742           required: true
19743           type: string
19744           example: __INTERFACE-NAME__
19745         - name: l3-interface-ipv4-address
19746           in: path
19747           description: IP address
19748           required: true
19749           type: string
19750           example: __L3-INTERFACE-IPV4-ADDRESS__
19751         - name: body
19752           in: body
19753           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
19754           required: true
19755           schema:
19756             $ref: "#/definitions/l3-interface-ipv4-address-list"
19757     patch:
19758       tags:
19759         - Network
19760       summary: update an existing l3-interface-ipv4-address-list
19761       description: |
19762         Update an existing l3-interface-ipv4-address-list
19763         #
19764         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19765         The PUT operation will entirely replace an existing object.
19766         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19767         #
19768         Other differences between PUT and PATCH are:
19769         #
19770         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19771         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19772         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19773       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19774       consumes:
19775         - application/json
19776         - application/xml
19777       produces:
19778         - application/json
19779         - application/xml
19780       responses:
19781         "default":
19782           description: Response codes found in [response codes](https://wiki.onap.org/).
19783       parameters:
19784         - name: equipment-name
19785           in: path
19786           required: true
19787           type: string
19788           example: __EQUIPMENT-NAME__
19789         - name: interface-name
19790           in: path
19791           description: Name that identifies the physical interface
19792           required: true
19793           type: string
19794           example: __INTERFACE-NAME__
19795         - name: interface-name
19796           in: path
19797           description: Name given to the interface
19798           required: true
19799           type: string
19800           example: __INTERFACE-NAME__
19801         - name: l3-interface-ipv4-address
19802           in: path
19803           description: IP address
19804           required: true
19805           type: string
19806           example: __L3-INTERFACE-IPV4-ADDRESS__
19807         - name: body
19808           in: body
19809           description: l3-interface-ipv4-address-list object that needs to be updated.
19810           required: true
19811           schema:
19812             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
19813     delete:
19814       tags:
19815         - Network
19816       summary: delete an existing l3-interface-ipv4-address-list
19817       description: delete an existing l3-interface-ipv4-address-list
19818       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19819       consumes:
19820         - application/json
19821         - application/xml
19822       produces:
19823         - application/json
19824         - application/xml
19825       responses:
19826         "default":
19827           description: Response codes found in [response codes](https://wiki.onap.org/).
19828       parameters:
19829         - name: equipment-name
19830           in: path
19831           required: true
19832           type: string
19833           example: __EQUIPMENT-NAME__
19834         - name: interface-name
19835           in: path
19836           description: Name that identifies the physical interface
19837           required: true
19838           type: string
19839           example: __INTERFACE-NAME__
19840         - name: interface-name
19841           in: path
19842           description: Name given to the interface
19843           required: true
19844           type: string
19845           example: __INTERFACE-NAME__
19846         - name: l3-interface-ipv4-address
19847           in: path
19848           description: IP address
19849           required: true
19850           type: string
19851           example: __L3-INTERFACE-IPV4-ADDRESS__
19852         - name: resource-version
19853           in: query
19854           description: resource-version for concurrency
19855           required: true
19856           type: string
19857   /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:
19858     put:
19859       tags:
19860         - Network
19861       summary: see node definition for valid relationships
19862       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
19863       consumes:
19864         - application/json
19865         - application/xml
19866       produces:
19867         - application/json
19868         - application/xml
19869       responses:
19870         "default":
19871           description: Response codes found in [response codes](https://wiki.onap.org/).
19872       parameters:
19873         - name: equipment-name
19874           in: path
19875           required: true
19876           type: string
19877           example: __EQUIPMENT-NAME__
19878         - name: interface-name
19879           in: path
19880           description: Name that identifies the physical interface
19881           required: true
19882           type: string
19883           example: __INTERFACE-NAME__
19884         - name: interface-name
19885           in: path
19886           description: Name given to the interface
19887           required: true
19888           type: string
19889           example: __INTERFACE-NAME__
19890         - name: l3-interface-ipv6-address
19891           in: path
19892           description: IP address
19893           required: true
19894           type: string
19895           example: __L3-INTERFACE-IPV6-ADDRESS__
19896         - name: body
19897           in: body
19898           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
19899           required: true
19900           schema:
19901             $ref: "#/definitions/relationship"
19902     delete:
19903       tags:
19904         - Network
19905       summary: delete an existing relationship
19906       description: delete an existing relationship
19907       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
19908       consumes:
19909         - application/json
19910         - application/xml
19911       produces:
19912         - application/json
19913         - application/xml
19914       responses:
19915         "default":
19916           description: Response codes found in [response codes](https://wiki.onap.org/).
19917       parameters:
19918         - name: equipment-name
19919           in: path
19920           required: true
19921           type: string
19922           example: __EQUIPMENT-NAME__
19923         - name: interface-name
19924           in: path
19925           description: Name that identifies the physical interface
19926           required: true
19927           type: string
19928           example: __INTERFACE-NAME__
19929         - name: interface-name
19930           in: path
19931           description: Name given to the interface
19932           required: true
19933           type: string
19934           example: __INTERFACE-NAME__
19935         - name: l3-interface-ipv6-address
19936           in: path
19937           description: IP address
19938           required: true
19939           type: string
19940           example: __L3-INTERFACE-IPV6-ADDRESS__
19941   /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}:
19942     get:
19943       tags:
19944         - Network
19945       summary: returns l3-interface-ipv6-address-list
19946       description: returns l3-interface-ipv6-address-list
19947       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
19948       produces:
19949         - application/json
19950         - application/xml
19951       responses:
19952         "200":
19953           description: successful operation
19954           schema:
19955               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
19956         "default":
19957           description: Response codes found in [response codes](https://wiki.onap.org/).
19958       parameters:
19959         - name: equipment-name
19960           in: path
19961           required: true
19962           type: string
19963           example: __EQUIPMENT-NAME__
19964         - name: interface-name
19965           in: path
19966           description: Name that identifies the physical interface
19967           required: true
19968           type: string
19969           example: __INTERFACE-NAME__
19970         - name: interface-name
19971           in: path
19972           description: Name given to the interface
19973           required: true
19974           type: string
19975           example: __INTERFACE-NAME__
19976         - name: l3-interface-ipv6-address
19977           in: path
19978           description: IP address
19979           required: true
19980           type: string
19981           example: __L3-INTERFACE-IPV6-ADDRESS__
19982     put:
19983       tags:
19984         - Network
19985       summary: create or update an existing l3-interface-ipv6-address-list
19986       description: |
19987         Create or update an existing l3-interface-ipv6-address-list.
19988         #
19989         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19990       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
19991       consumes:
19992         - application/json
19993         - application/xml
19994       produces:
19995         - application/json
19996         - application/xml
19997       responses:
19998         "default":
19999           description: Response codes found in [response codes](https://wiki.onap.org/).
20000       parameters:
20001         - name: equipment-name
20002           in: path
20003           required: true
20004           type: string
20005           example: __EQUIPMENT-NAME__
20006         - name: interface-name
20007           in: path
20008           description: Name that identifies the physical interface
20009           required: true
20010           type: string
20011           example: __INTERFACE-NAME__
20012         - name: interface-name
20013           in: path
20014           description: Name given to the interface
20015           required: true
20016           type: string
20017           example: __INTERFACE-NAME__
20018         - name: l3-interface-ipv6-address
20019           in: path
20020           description: IP address
20021           required: true
20022           type: string
20023           example: __L3-INTERFACE-IPV6-ADDRESS__
20024         - name: body
20025           in: body
20026           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
20027           required: true
20028           schema:
20029             $ref: "#/definitions/l3-interface-ipv6-address-list"
20030     patch:
20031       tags:
20032         - Network
20033       summary: update an existing l3-interface-ipv6-address-list
20034       description: |
20035         Update an existing l3-interface-ipv6-address-list
20036         #
20037         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20038         The PUT operation will entirely replace an existing object.
20039         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20040         #
20041         Other differences between PUT and PATCH are:
20042         #
20043         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20044         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20045         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20046       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
20047       consumes:
20048         - application/json
20049         - application/xml
20050       produces:
20051         - application/json
20052         - application/xml
20053       responses:
20054         "default":
20055           description: Response codes found in [response codes](https://wiki.onap.org/).
20056       parameters:
20057         - name: equipment-name
20058           in: path
20059           required: true
20060           type: string
20061           example: __EQUIPMENT-NAME__
20062         - name: interface-name
20063           in: path
20064           description: Name that identifies the physical interface
20065           required: true
20066           type: string
20067           example: __INTERFACE-NAME__
20068         - name: interface-name
20069           in: path
20070           description: Name given to the interface
20071           required: true
20072           type: string
20073           example: __INTERFACE-NAME__
20074         - name: l3-interface-ipv6-address
20075           in: path
20076           description: IP address
20077           required: true
20078           type: string
20079           example: __L3-INTERFACE-IPV6-ADDRESS__
20080         - name: body
20081           in: body
20082           description: l3-interface-ipv6-address-list object that needs to be updated.
20083           required: true
20084           schema:
20085             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20086     delete:
20087       tags:
20088         - Network
20089       summary: delete an existing l3-interface-ipv6-address-list
20090       description: delete an existing l3-interface-ipv6-address-list
20091       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
20092       consumes:
20093         - application/json
20094         - application/xml
20095       produces:
20096         - application/json
20097         - application/xml
20098       responses:
20099         "default":
20100           description: Response codes found in [response codes](https://wiki.onap.org/).
20101       parameters:
20102         - name: equipment-name
20103           in: path
20104           required: true
20105           type: string
20106           example: __EQUIPMENT-NAME__
20107         - name: interface-name
20108           in: path
20109           description: Name that identifies the physical interface
20110           required: true
20111           type: string
20112           example: __INTERFACE-NAME__
20113         - name: interface-name
20114           in: path
20115           description: Name given to the interface
20116           required: true
20117           type: string
20118           example: __INTERFACE-NAME__
20119         - name: l3-interface-ipv6-address
20120           in: path
20121           description: IP address
20122           required: true
20123           type: string
20124           example: __L3-INTERFACE-IPV6-ADDRESS__
20125         - name: resource-version
20126           in: query
20127           description: resource-version for concurrency
20128           required: true
20129           type: string
20130   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
20131     get:
20132       tags:
20133         - Network
20134       summary: returns l-interface
20135       description: returns l-interface
20136       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20137       produces:
20138         - application/json
20139         - application/xml
20140       responses:
20141         "200":
20142           description: successful operation
20143           schema:
20144               $ref: "#/getDefinitions/l-interface"
20145         "default":
20146           description: Response codes found in [response codes](https://wiki.onap.org/).
20147       parameters:
20148         - name: equipment-name
20149           in: path
20150           required: true
20151           type: string
20152           example: __EQUIPMENT-NAME__
20153         - name: interface-name
20154           in: path
20155           description: Name that identifies the physical interface
20156           required: true
20157           type: string
20158           example: __INTERFACE-NAME__
20159         - name: interface-name
20160           in: path
20161           description: Name given to the interface
20162           required: true
20163           type: string
20164           example: __INTERFACE-NAME__
20165     put:
20166       tags:
20167         - Network
20168       summary: create or update an existing l-interface
20169       description: |
20170         Create or update an existing l-interface.
20171         #
20172         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20173       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20174       consumes:
20175         - application/json
20176         - application/xml
20177       produces:
20178         - application/json
20179         - application/xml
20180       responses:
20181         "default":
20182           description: Response codes found in [response codes](https://wiki.onap.org/).
20183       parameters:
20184         - name: equipment-name
20185           in: path
20186           required: true
20187           type: string
20188           example: __EQUIPMENT-NAME__
20189         - name: interface-name
20190           in: path
20191           description: Name that identifies the physical interface
20192           required: true
20193           type: string
20194           example: __INTERFACE-NAME__
20195         - name: interface-name
20196           in: path
20197           description: Name given to the interface
20198           required: true
20199           type: string
20200           example: __INTERFACE-NAME__
20201         - name: body
20202           in: body
20203           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20204           required: true
20205           schema:
20206             $ref: "#/definitions/l-interface"
20207     patch:
20208       tags:
20209         - Network
20210       summary: update an existing l-interface
20211       description: |
20212         Update an existing l-interface
20213         #
20214         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20215         The PUT operation will entirely replace an existing object.
20216         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20217         #
20218         Other differences between PUT and PATCH are:
20219         #
20220         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20221         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20222         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20223       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20224       consumes:
20225         - application/json
20226         - application/xml
20227       produces:
20228         - application/json
20229         - application/xml
20230       responses:
20231         "default":
20232           description: Response codes found in [response codes](https://wiki.onap.org/).
20233       parameters:
20234         - name: equipment-name
20235           in: path
20236           required: true
20237           type: string
20238           example: __EQUIPMENT-NAME__
20239         - name: interface-name
20240           in: path
20241           description: Name that identifies the physical interface
20242           required: true
20243           type: string
20244           example: __INTERFACE-NAME__
20245         - name: interface-name
20246           in: path
20247           description: Name given to the interface
20248           required: true
20249           type: string
20250           example: __INTERFACE-NAME__
20251         - name: body
20252           in: body
20253           description: l-interface object that needs to be updated.
20254           required: true
20255           schema:
20256             $ref: "#/patchDefinitions/l-interface"
20257     delete:
20258       tags:
20259         - Network
20260       summary: delete an existing l-interface
20261       description: delete an existing l-interface
20262       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20263       consumes:
20264         - application/json
20265         - application/xml
20266       produces:
20267         - application/json
20268         - application/xml
20269       responses:
20270         "default":
20271           description: Response codes found in [response codes](https://wiki.onap.org/).
20272       parameters:
20273         - name: equipment-name
20274           in: path
20275           required: true
20276           type: string
20277           example: __EQUIPMENT-NAME__
20278         - name: interface-name
20279           in: path
20280           description: Name that identifies the physical interface
20281           required: true
20282           type: string
20283           example: __INTERFACE-NAME__
20284         - name: interface-name
20285           in: path
20286           description: Name given to the interface
20287           required: true
20288           type: string
20289           example: __INTERFACE-NAME__
20290         - name: resource-version
20291           in: query
20292           description: resource-version for concurrency
20293           required: true
20294           type: string
20295   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
20296     get:
20297       tags:
20298         - Network
20299       summary: returns l-interfaces
20300       description: returns l-interfaces
20301       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
20302       produces:
20303         - application/json
20304         - application/xml
20305       responses:
20306         "200":
20307           description: successful operation
20308           schema:
20309               $ref: "#/getDefinitions/l-interfaces"
20310         "default":
20311           description: Response codes found in [response codes](https://wiki.onap.org/).
20312       parameters:
20313         - name: equipment-name
20314           in: path
20315           required: true
20316           type: string
20317           example: __EQUIPMENT-NAME__
20318         - name: interface-name
20319           in: path
20320           description: Name that identifies the physical interface
20321           required: true
20322           type: string
20323           example: __INTERFACE-NAME__
20324         - name: interface-name
20325           in: query
20326           description:
20327           required: false
20328           type: string
20329         - name: interface-id
20330           in: query
20331           description:
20332           required: false
20333           type: string
20334         - name: macaddr
20335           in: query
20336           description:
20337           required: false
20338           type: string
20339         - name: network-name
20340           in: query
20341           description:
20342           required: false
20343           type: string
20344   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
20345     get:
20346       tags:
20347         - Network
20348       summary: returns p-interface
20349       description: returns p-interface
20350       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
20351       produces:
20352         - application/json
20353         - application/xml
20354       responses:
20355         "200":
20356           description: successful operation
20357           schema:
20358               $ref: "#/getDefinitions/p-interface"
20359         "default":
20360           description: Response codes found in [response codes](https://wiki.onap.org/).
20361       parameters:
20362         - name: equipment-name
20363           in: path
20364           required: true
20365           type: string
20366           example: __EQUIPMENT-NAME__
20367         - name: interface-name
20368           in: path
20369           description: Name that identifies the physical interface
20370           required: true
20371           type: string
20372           example: __INTERFACE-NAME__
20373     put:
20374       tags:
20375         - Network
20376       summary: create or update an existing p-interface
20377       description: |
20378         Create or update an existing p-interface.
20379         #
20380         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20381       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
20382       consumes:
20383         - application/json
20384         - application/xml
20385       produces:
20386         - application/json
20387         - application/xml
20388       responses:
20389         "default":
20390           description: Response codes found in [response codes](https://wiki.onap.org/).
20391       parameters:
20392         - name: equipment-name
20393           in: path
20394           required: true
20395           type: string
20396           example: __EQUIPMENT-NAME__
20397         - name: interface-name
20398           in: path
20399           description: Name that identifies the physical interface
20400           required: true
20401           type: string
20402           example: __INTERFACE-NAME__
20403         - name: body
20404           in: body
20405           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
20406           required: true
20407           schema:
20408             $ref: "#/definitions/p-interface"
20409     patch:
20410       tags:
20411         - Network
20412       summary: update an existing p-interface
20413       description: |
20414         Update an existing p-interface
20415         #
20416         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20417         The PUT operation will entirely replace an existing object.
20418         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20419         #
20420         Other differences between PUT and PATCH are:
20421         #
20422         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20423         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20424         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20425       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
20426       consumes:
20427         - application/json
20428         - application/xml
20429       produces:
20430         - application/json
20431         - application/xml
20432       responses:
20433         "default":
20434           description: Response codes found in [response codes](https://wiki.onap.org/).
20435       parameters:
20436         - name: equipment-name
20437           in: path
20438           required: true
20439           type: string
20440           example: __EQUIPMENT-NAME__
20441         - name: interface-name
20442           in: path
20443           description: Name that identifies the physical interface
20444           required: true
20445           type: string
20446           example: __INTERFACE-NAME__
20447         - name: body
20448           in: body
20449           description: p-interface object that needs to be updated.
20450           required: true
20451           schema:
20452             $ref: "#/patchDefinitions/p-interface"
20453     delete:
20454       tags:
20455         - Network
20456       summary: delete an existing p-interface
20457       description: delete an existing p-interface
20458       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
20459       consumes:
20460         - application/json
20461         - application/xml
20462       produces:
20463         - application/json
20464         - application/xml
20465       responses:
20466         "default":
20467           description: Response codes found in [response codes](https://wiki.onap.org/).
20468       parameters:
20469         - name: equipment-name
20470           in: path
20471           required: true
20472           type: string
20473           example: __EQUIPMENT-NAME__
20474         - name: interface-name
20475           in: path
20476           description: Name that identifies the physical interface
20477           required: true
20478           type: string
20479           example: __INTERFACE-NAME__
20480         - name: resource-version
20481           in: query
20482           description: resource-version for concurrency
20483           required: true
20484           type: string
20485   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
20486     get:
20487       tags:
20488         - Network
20489       summary: returns p-interfaces
20490       description: returns p-interfaces
20491       operationId: getNetworkVplsPesVplsPePInterfaces
20492       produces:
20493         - application/json
20494         - application/xml
20495       responses:
20496         "200":
20497           description: successful operation
20498           schema:
20499               $ref: "#/getDefinitions/p-interfaces"
20500         "default":
20501           description: Response codes found in [response codes](https://wiki.onap.org/).
20502       parameters:
20503         - name: equipment-name
20504           in: path
20505           required: true
20506           type: string
20507           example: __EQUIPMENT-NAME__
20508         - name: interface-name
20509           in: query
20510           description:
20511           required: false
20512           type: string
20513   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
20514     put:
20515       tags:
20516         - Network
20517       summary: see node definition for valid relationships
20518       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
20519       consumes:
20520         - application/json
20521         - application/xml
20522       produces:
20523         - application/json
20524         - application/xml
20525       responses:
20526         "default":
20527           description: Response codes found in [response codes](https://wiki.onap.org/).
20528       parameters:
20529         - name: equipment-name
20530           in: path
20531           required: true
20532           type: string
20533           example: __EQUIPMENT-NAME__
20534         - name: interface-name
20535           in: path
20536           description: Name that identifies the link aggregate interface
20537           required: true
20538           type: string
20539           example: __INTERFACE-NAME__
20540         - name: body
20541           in: body
20542           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
20543           required: true
20544           schema:
20545             $ref: "#/definitions/relationship"
20546     delete:
20547       tags:
20548         - Network
20549       summary: delete an existing relationship
20550       description: delete an existing relationship
20551       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
20552       consumes:
20553         - application/json
20554         - application/xml
20555       produces:
20556         - application/json
20557         - application/xml
20558       responses:
20559         "default":
20560           description: Response codes found in [response codes](https://wiki.onap.org/).
20561       parameters:
20562         - name: equipment-name
20563           in: path
20564           required: true
20565           type: string
20566           example: __EQUIPMENT-NAME__
20567         - name: interface-name
20568           in: path
20569           description: Name that identifies the link aggregate interface
20570           required: true
20571           type: string
20572           example: __INTERFACE-NAME__
20573   /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:
20574     put:
20575       tags:
20576         - Network
20577       summary: see node definition for valid relationships
20578       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20579       consumes:
20580         - application/json
20581         - application/xml
20582       produces:
20583         - application/json
20584         - application/xml
20585       responses:
20586         "default":
20587           description: Response codes found in [response codes](https://wiki.onap.org/).
20588       parameters:
20589         - name: equipment-name
20590           in: path
20591           required: true
20592           type: string
20593           example: __EQUIPMENT-NAME__
20594         - name: interface-name
20595           in: path
20596           description: Name that identifies the link aggregate interface
20597           required: true
20598           type: string
20599           example: __INTERFACE-NAME__
20600         - name: interface-name
20601           in: path
20602           description: Name given to the interface
20603           required: true
20604           type: string
20605           example: __INTERFACE-NAME__
20606         - name: vlan-interface
20607           in: path
20608           description: String that identifies the interface
20609           required: true
20610           type: string
20611           example: __VLAN-INTERFACE__
20612         - name: body
20613           in: body
20614           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
20615           required: true
20616           schema:
20617             $ref: "#/definitions/relationship"
20618     delete:
20619       tags:
20620         - Network
20621       summary: delete an existing relationship
20622       description: delete an existing relationship
20623       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20624       consumes:
20625         - application/json
20626         - application/xml
20627       produces:
20628         - application/json
20629         - application/xml
20630       responses:
20631         "default":
20632           description: Response codes found in [response codes](https://wiki.onap.org/).
20633       parameters:
20634         - name: equipment-name
20635           in: path
20636           required: true
20637           type: string
20638           example: __EQUIPMENT-NAME__
20639         - name: interface-name
20640           in: path
20641           description: Name that identifies the link aggregate interface
20642           required: true
20643           type: string
20644           example: __INTERFACE-NAME__
20645         - name: interface-name
20646           in: path
20647           description: Name given to the interface
20648           required: true
20649           type: string
20650           example: __INTERFACE-NAME__
20651         - name: vlan-interface
20652           in: path
20653           description: String that identifies the interface
20654           required: true
20655           type: string
20656           example: __VLAN-INTERFACE__
20657   /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:
20658     put:
20659       tags:
20660         - Network
20661       summary: see node definition for valid relationships
20662       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20663       consumes:
20664         - application/json
20665         - application/xml
20666       produces:
20667         - application/json
20668         - application/xml
20669       responses:
20670         "default":
20671           description: Response codes found in [response codes](https://wiki.onap.org/).
20672       parameters:
20673         - name: equipment-name
20674           in: path
20675           required: true
20676           type: string
20677           example: __EQUIPMENT-NAME__
20678         - name: interface-name
20679           in: path
20680           description: Name that identifies the link aggregate interface
20681           required: true
20682           type: string
20683           example: __INTERFACE-NAME__
20684         - name: interface-name
20685           in: path
20686           description: Name given to the interface
20687           required: true
20688           type: string
20689           example: __INTERFACE-NAME__
20690         - name: vlan-interface
20691           in: path
20692           description: String that identifies the interface
20693           required: true
20694           type: string
20695           example: __VLAN-INTERFACE__
20696         - name: l3-interface-ipv4-address
20697           in: path
20698           description: IP address
20699           required: true
20700           type: string
20701           example: __L3-INTERFACE-IPV4-ADDRESS__
20702         - name: body
20703           in: body
20704           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20705           required: true
20706           schema:
20707             $ref: "#/definitions/relationship"
20708     delete:
20709       tags:
20710         - Network
20711       summary: delete an existing relationship
20712       description: delete an existing relationship
20713       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20714       consumes:
20715         - application/json
20716         - application/xml
20717       produces:
20718         - application/json
20719         - application/xml
20720       responses:
20721         "default":
20722           description: Response codes found in [response codes](https://wiki.onap.org/).
20723       parameters:
20724         - name: equipment-name
20725           in: path
20726           required: true
20727           type: string
20728           example: __EQUIPMENT-NAME__
20729         - name: interface-name
20730           in: path
20731           description: Name that identifies the link aggregate interface
20732           required: true
20733           type: string
20734           example: __INTERFACE-NAME__
20735         - name: interface-name
20736           in: path
20737           description: Name given to the interface
20738           required: true
20739           type: string
20740           example: __INTERFACE-NAME__
20741         - name: vlan-interface
20742           in: path
20743           description: String that identifies the interface
20744           required: true
20745           type: string
20746           example: __VLAN-INTERFACE__
20747         - name: l3-interface-ipv4-address
20748           in: path
20749           description: IP address
20750           required: true
20751           type: string
20752           example: __L3-INTERFACE-IPV4-ADDRESS__
20753   /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}:
20754     get:
20755       tags:
20756         - Network
20757       summary: returns l3-interface-ipv4-address-list
20758       description: returns l3-interface-ipv4-address-list
20759       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20760       produces:
20761         - application/json
20762         - application/xml
20763       responses:
20764         "200":
20765           description: successful operation
20766           schema:
20767               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20768         "default":
20769           description: Response codes found in [response codes](https://wiki.onap.org/).
20770       parameters:
20771         - name: equipment-name
20772           in: path
20773           required: true
20774           type: string
20775           example: __EQUIPMENT-NAME__
20776         - name: interface-name
20777           in: path
20778           description: Name that identifies the link aggregate interface
20779           required: true
20780           type: string
20781           example: __INTERFACE-NAME__
20782         - name: interface-name
20783           in: path
20784           description: Name given to the interface
20785           required: true
20786           type: string
20787           example: __INTERFACE-NAME__
20788         - name: vlan-interface
20789           in: path
20790           description: String that identifies the interface
20791           required: true
20792           type: string
20793           example: __VLAN-INTERFACE__
20794         - name: l3-interface-ipv4-address
20795           in: path
20796           description: IP address
20797           required: true
20798           type: string
20799           example: __L3-INTERFACE-IPV4-ADDRESS__
20800     put:
20801       tags:
20802         - Network
20803       summary: create or update an existing l3-interface-ipv4-address-list
20804       description: |
20805         Create or update an existing l3-interface-ipv4-address-list.
20806         #
20807         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20808       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20809       consumes:
20810         - application/json
20811         - application/xml
20812       produces:
20813         - application/json
20814         - application/xml
20815       responses:
20816         "default":
20817           description: Response codes found in [response codes](https://wiki.onap.org/).
20818       parameters:
20819         - name: equipment-name
20820           in: path
20821           required: true
20822           type: string
20823           example: __EQUIPMENT-NAME__
20824         - name: interface-name
20825           in: path
20826           description: Name that identifies the link aggregate interface
20827           required: true
20828           type: string
20829           example: __INTERFACE-NAME__
20830         - name: interface-name
20831           in: path
20832           description: Name given to the interface
20833           required: true
20834           type: string
20835           example: __INTERFACE-NAME__
20836         - name: vlan-interface
20837           in: path
20838           description: String that identifies the interface
20839           required: true
20840           type: string
20841           example: __VLAN-INTERFACE__
20842         - name: l3-interface-ipv4-address
20843           in: path
20844           description: IP address
20845           required: true
20846           type: string
20847           example: __L3-INTERFACE-IPV4-ADDRESS__
20848         - name: body
20849           in: body
20850           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20851           required: true
20852           schema:
20853             $ref: "#/definitions/l3-interface-ipv4-address-list"
20854     patch:
20855       tags:
20856         - Network
20857       summary: update an existing l3-interface-ipv4-address-list
20858       description: |
20859         Update an existing l3-interface-ipv4-address-list
20860         #
20861         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20862         The PUT operation will entirely replace an existing object.
20863         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20864         #
20865         Other differences between PUT and PATCH are:
20866         #
20867         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20868         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20869         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20870       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20871       consumes:
20872         - application/json
20873         - application/xml
20874       produces:
20875         - application/json
20876         - application/xml
20877       responses:
20878         "default":
20879           description: Response codes found in [response codes](https://wiki.onap.org/).
20880       parameters:
20881         - name: equipment-name
20882           in: path
20883           required: true
20884           type: string
20885           example: __EQUIPMENT-NAME__
20886         - name: interface-name
20887           in: path
20888           description: Name that identifies the link aggregate interface
20889           required: true
20890           type: string
20891           example: __INTERFACE-NAME__
20892         - name: interface-name
20893           in: path
20894           description: Name given to the interface
20895           required: true
20896           type: string
20897           example: __INTERFACE-NAME__
20898         - name: vlan-interface
20899           in: path
20900           description: String that identifies the interface
20901           required: true
20902           type: string
20903           example: __VLAN-INTERFACE__
20904         - name: l3-interface-ipv4-address
20905           in: path
20906           description: IP address
20907           required: true
20908           type: string
20909           example: __L3-INTERFACE-IPV4-ADDRESS__
20910         - name: body
20911           in: body
20912           description: l3-interface-ipv4-address-list object that needs to be updated.
20913           required: true
20914           schema:
20915             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20916     delete:
20917       tags:
20918         - Network
20919       summary: delete an existing l3-interface-ipv4-address-list
20920       description: delete an existing l3-interface-ipv4-address-list
20921       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20922       consumes:
20923         - application/json
20924         - application/xml
20925       produces:
20926         - application/json
20927         - application/xml
20928       responses:
20929         "default":
20930           description: Response codes found in [response codes](https://wiki.onap.org/).
20931       parameters:
20932         - name: equipment-name
20933           in: path
20934           required: true
20935           type: string
20936           example: __EQUIPMENT-NAME__
20937         - name: interface-name
20938           in: path
20939           description: Name that identifies the link aggregate interface
20940           required: true
20941           type: string
20942           example: __INTERFACE-NAME__
20943         - name: interface-name
20944           in: path
20945           description: Name given to the interface
20946           required: true
20947           type: string
20948           example: __INTERFACE-NAME__
20949         - name: vlan-interface
20950           in: path
20951           description: String that identifies the interface
20952           required: true
20953           type: string
20954           example: __VLAN-INTERFACE__
20955         - name: l3-interface-ipv4-address
20956           in: path
20957           description: IP address
20958           required: true
20959           type: string
20960           example: __L3-INTERFACE-IPV4-ADDRESS__
20961         - name: resource-version
20962           in: query
20963           description: resource-version for concurrency
20964           required: true
20965           type: string
20966   /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:
20967     put:
20968       tags:
20969         - Network
20970       summary: see node definition for valid relationships
20971       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20972       consumes:
20973         - application/json
20974         - application/xml
20975       produces:
20976         - application/json
20977         - application/xml
20978       responses:
20979         "default":
20980           description: Response codes found in [response codes](https://wiki.onap.org/).
20981       parameters:
20982         - name: equipment-name
20983           in: path
20984           required: true
20985           type: string
20986           example: __EQUIPMENT-NAME__
20987         - name: interface-name
20988           in: path
20989           description: Name that identifies the link aggregate interface
20990           required: true
20991           type: string
20992           example: __INTERFACE-NAME__
20993         - name: interface-name
20994           in: path
20995           description: Name given to the interface
20996           required: true
20997           type: string
20998           example: __INTERFACE-NAME__
20999         - name: vlan-interface
21000           in: path
21001           description: String that identifies the interface
21002           required: true
21003           type: string
21004           example: __VLAN-INTERFACE__
21005         - name: l3-interface-ipv6-address
21006           in: path
21007           description: IP address
21008           required: true
21009           type: string
21010           example: __L3-INTERFACE-IPV6-ADDRESS__
21011         - name: body
21012           in: body
21013           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
21014           required: true
21015           schema:
21016             $ref: "#/definitions/relationship"
21017     delete:
21018       tags:
21019         - Network
21020       summary: delete an existing relationship
21021       description: delete an existing relationship
21022       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
21023       consumes:
21024         - application/json
21025         - application/xml
21026       produces:
21027         - application/json
21028         - application/xml
21029       responses:
21030         "default":
21031           description: Response codes found in [response codes](https://wiki.onap.org/).
21032       parameters:
21033         - name: equipment-name
21034           in: path
21035           required: true
21036           type: string
21037           example: __EQUIPMENT-NAME__
21038         - name: interface-name
21039           in: path
21040           description: Name that identifies the link aggregate interface
21041           required: true
21042           type: string
21043           example: __INTERFACE-NAME__
21044         - name: interface-name
21045           in: path
21046           description: Name given to the interface
21047           required: true
21048           type: string
21049           example: __INTERFACE-NAME__
21050         - name: vlan-interface
21051           in: path
21052           description: String that identifies the interface
21053           required: true
21054           type: string
21055           example: __VLAN-INTERFACE__
21056         - name: l3-interface-ipv6-address
21057           in: path
21058           description: IP address
21059           required: true
21060           type: string
21061           example: __L3-INTERFACE-IPV6-ADDRESS__
21062   /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}:
21063     get:
21064       tags:
21065         - Network
21066       summary: returns l3-interface-ipv6-address-list
21067       description: returns l3-interface-ipv6-address-list
21068       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21069       produces:
21070         - application/json
21071         - application/xml
21072       responses:
21073         "200":
21074           description: successful operation
21075           schema:
21076               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21077         "default":
21078           description: Response codes found in [response codes](https://wiki.onap.org/).
21079       parameters:
21080         - name: equipment-name
21081           in: path
21082           required: true
21083           type: string
21084           example: __EQUIPMENT-NAME__
21085         - name: interface-name
21086           in: path
21087           description: Name that identifies the link aggregate interface
21088           required: true
21089           type: string
21090           example: __INTERFACE-NAME__
21091         - name: interface-name
21092           in: path
21093           description: Name given to the interface
21094           required: true
21095           type: string
21096           example: __INTERFACE-NAME__
21097         - name: vlan-interface
21098           in: path
21099           description: String that identifies the interface
21100           required: true
21101           type: string
21102           example: __VLAN-INTERFACE__
21103         - name: l3-interface-ipv6-address
21104           in: path
21105           description: IP address
21106           required: true
21107           type: string
21108           example: __L3-INTERFACE-IPV6-ADDRESS__
21109     put:
21110       tags:
21111         - Network
21112       summary: create or update an existing l3-interface-ipv6-address-list
21113       description: |
21114         Create or update an existing l3-interface-ipv6-address-list.
21115         #
21116         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21117       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21118       consumes:
21119         - application/json
21120         - application/xml
21121       produces:
21122         - application/json
21123         - application/xml
21124       responses:
21125         "default":
21126           description: Response codes found in [response codes](https://wiki.onap.org/).
21127       parameters:
21128         - name: equipment-name
21129           in: path
21130           required: true
21131           type: string
21132           example: __EQUIPMENT-NAME__
21133         - name: interface-name
21134           in: path
21135           description: Name that identifies the link aggregate interface
21136           required: true
21137           type: string
21138           example: __INTERFACE-NAME__
21139         - name: interface-name
21140           in: path
21141           description: Name given to the interface
21142           required: true
21143           type: string
21144           example: __INTERFACE-NAME__
21145         - name: vlan-interface
21146           in: path
21147           description: String that identifies the interface
21148           required: true
21149           type: string
21150           example: __VLAN-INTERFACE__
21151         - name: l3-interface-ipv6-address
21152           in: path
21153           description: IP address
21154           required: true
21155           type: string
21156           example: __L3-INTERFACE-IPV6-ADDRESS__
21157         - name: body
21158           in: body
21159           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
21160           required: true
21161           schema:
21162             $ref: "#/definitions/l3-interface-ipv6-address-list"
21163     patch:
21164       tags:
21165         - Network
21166       summary: update an existing l3-interface-ipv6-address-list
21167       description: |
21168         Update an existing l3-interface-ipv6-address-list
21169         #
21170         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21171         The PUT operation will entirely replace an existing object.
21172         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21173         #
21174         Other differences between PUT and PATCH are:
21175         #
21176         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21177         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21178         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21179       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21180       consumes:
21181         - application/json
21182         - application/xml
21183       produces:
21184         - application/json
21185         - application/xml
21186       responses:
21187         "default":
21188           description: Response codes found in [response codes](https://wiki.onap.org/).
21189       parameters:
21190         - name: equipment-name
21191           in: path
21192           required: true
21193           type: string
21194           example: __EQUIPMENT-NAME__
21195         - name: interface-name
21196           in: path
21197           description: Name that identifies the link aggregate interface
21198           required: true
21199           type: string
21200           example: __INTERFACE-NAME__
21201         - name: interface-name
21202           in: path
21203           description: Name given to the interface
21204           required: true
21205           type: string
21206           example: __INTERFACE-NAME__
21207         - name: vlan-interface
21208           in: path
21209           description: String that identifies the interface
21210           required: true
21211           type: string
21212           example: __VLAN-INTERFACE__
21213         - name: l3-interface-ipv6-address
21214           in: path
21215           description: IP address
21216           required: true
21217           type: string
21218           example: __L3-INTERFACE-IPV6-ADDRESS__
21219         - name: body
21220           in: body
21221           description: l3-interface-ipv6-address-list object that needs to be updated.
21222           required: true
21223           schema:
21224             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21225     delete:
21226       tags:
21227         - Network
21228       summary: delete an existing l3-interface-ipv6-address-list
21229       description: delete an existing l3-interface-ipv6-address-list
21230       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21231       consumes:
21232         - application/json
21233         - application/xml
21234       produces:
21235         - application/json
21236         - application/xml
21237       responses:
21238         "default":
21239           description: Response codes found in [response codes](https://wiki.onap.org/).
21240       parameters:
21241         - name: equipment-name
21242           in: path
21243           required: true
21244           type: string
21245           example: __EQUIPMENT-NAME__
21246         - name: interface-name
21247           in: path
21248           description: Name that identifies the link aggregate interface
21249           required: true
21250           type: string
21251           example: __INTERFACE-NAME__
21252         - name: interface-name
21253           in: path
21254           description: Name given to the interface
21255           required: true
21256           type: string
21257           example: __INTERFACE-NAME__
21258         - name: vlan-interface
21259           in: path
21260           description: String that identifies the interface
21261           required: true
21262           type: string
21263           example: __VLAN-INTERFACE__
21264         - name: l3-interface-ipv6-address
21265           in: path
21266           description: IP address
21267           required: true
21268           type: string
21269           example: __L3-INTERFACE-IPV6-ADDRESS__
21270         - name: resource-version
21271           in: query
21272           description: resource-version for concurrency
21273           required: true
21274           type: string
21275   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
21276     get:
21277       tags:
21278         - Network
21279       summary: returns vlan
21280       description: returns vlan
21281       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21282       produces:
21283         - application/json
21284         - application/xml
21285       responses:
21286         "200":
21287           description: successful operation
21288           schema:
21289               $ref: "#/getDefinitions/vlan"
21290         "default":
21291           description: Response codes found in [response codes](https://wiki.onap.org/).
21292       parameters:
21293         - name: equipment-name
21294           in: path
21295           required: true
21296           type: string
21297           example: __EQUIPMENT-NAME__
21298         - name: interface-name
21299           in: path
21300           description: Name that identifies the link aggregate interface
21301           required: true
21302           type: string
21303           example: __INTERFACE-NAME__
21304         - name: interface-name
21305           in: path
21306           description: Name given to the interface
21307           required: true
21308           type: string
21309           example: __INTERFACE-NAME__
21310         - name: vlan-interface
21311           in: path
21312           description: String that identifies the interface
21313           required: true
21314           type: string
21315           example: __VLAN-INTERFACE__
21316     put:
21317       tags:
21318         - Network
21319       summary: create or update an existing vlan
21320       description: |
21321         Create or update an existing vlan.
21322         #
21323         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21324       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21325       consumes:
21326         - application/json
21327         - application/xml
21328       produces:
21329         - application/json
21330         - application/xml
21331       responses:
21332         "default":
21333           description: Response codes found in [response codes](https://wiki.onap.org/).
21334       parameters:
21335         - name: equipment-name
21336           in: path
21337           required: true
21338           type: string
21339           example: __EQUIPMENT-NAME__
21340         - name: interface-name
21341           in: path
21342           description: Name that identifies the link aggregate interface
21343           required: true
21344           type: string
21345           example: __INTERFACE-NAME__
21346         - name: interface-name
21347           in: path
21348           description: Name given to the interface
21349           required: true
21350           type: string
21351           example: __INTERFACE-NAME__
21352         - name: vlan-interface
21353           in: path
21354           description: String that identifies the interface
21355           required: true
21356           type: string
21357           example: __VLAN-INTERFACE__
21358         - name: body
21359           in: body
21360           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
21361           required: true
21362           schema:
21363             $ref: "#/definitions/vlan"
21364     patch:
21365       tags:
21366         - Network
21367       summary: update an existing vlan
21368       description: |
21369         Update an existing vlan
21370         #
21371         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21372         The PUT operation will entirely replace an existing object.
21373         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21374         #
21375         Other differences between PUT and PATCH are:
21376         #
21377         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21378         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21379         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21380       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21381       consumes:
21382         - application/json
21383         - application/xml
21384       produces:
21385         - application/json
21386         - application/xml
21387       responses:
21388         "default":
21389           description: Response codes found in [response codes](https://wiki.onap.org/).
21390       parameters:
21391         - name: equipment-name
21392           in: path
21393           required: true
21394           type: string
21395           example: __EQUIPMENT-NAME__
21396         - name: interface-name
21397           in: path
21398           description: Name that identifies the link aggregate interface
21399           required: true
21400           type: string
21401           example: __INTERFACE-NAME__
21402         - name: interface-name
21403           in: path
21404           description: Name given to the interface
21405           required: true
21406           type: string
21407           example: __INTERFACE-NAME__
21408         - name: vlan-interface
21409           in: path
21410           description: String that identifies the interface
21411           required: true
21412           type: string
21413           example: __VLAN-INTERFACE__
21414         - name: body
21415           in: body
21416           description: vlan object that needs to be updated.
21417           required: true
21418           schema:
21419             $ref: "#/patchDefinitions/vlan"
21420     delete:
21421       tags:
21422         - Network
21423       summary: delete an existing vlan
21424       description: delete an existing vlan
21425       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21426       consumes:
21427         - application/json
21428         - application/xml
21429       produces:
21430         - application/json
21431         - application/xml
21432       responses:
21433         "default":
21434           description: Response codes found in [response codes](https://wiki.onap.org/).
21435       parameters:
21436         - name: equipment-name
21437           in: path
21438           required: true
21439           type: string
21440           example: __EQUIPMENT-NAME__
21441         - name: interface-name
21442           in: path
21443           description: Name that identifies the link aggregate interface
21444           required: true
21445           type: string
21446           example: __INTERFACE-NAME__
21447         - name: interface-name
21448           in: path
21449           description: Name given to the interface
21450           required: true
21451           type: string
21452           example: __INTERFACE-NAME__
21453         - name: vlan-interface
21454           in: path
21455           description: String that identifies the interface
21456           required: true
21457           type: string
21458           example: __VLAN-INTERFACE__
21459         - name: resource-version
21460           in: query
21461           description: resource-version for concurrency
21462           required: true
21463           type: string
21464   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
21465     get:
21466       tags:
21467         - Network
21468       summary: returns vlans
21469       description: returns vlans
21470       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
21471       produces:
21472         - application/json
21473         - application/xml
21474       responses:
21475         "200":
21476           description: successful operation
21477           schema:
21478               $ref: "#/getDefinitions/vlans"
21479         "default":
21480           description: Response codes found in [response codes](https://wiki.onap.org/).
21481       parameters:
21482         - name: equipment-name
21483           in: path
21484           required: true
21485           type: string
21486           example: __EQUIPMENT-NAME__
21487         - name: interface-name
21488           in: path
21489           description: Name that identifies the link aggregate interface
21490           required: true
21491           type: string
21492           example: __INTERFACE-NAME__
21493         - name: interface-name
21494           in: path
21495           description: Name given to the interface
21496           required: true
21497           type: string
21498           example: __INTERFACE-NAME__
21499         - name: vlan-interface
21500           in: query
21501           description:
21502           required: false
21503           type: string
21504         - name: vlan-id-inner
21505           in: query
21506           description:
21507           required: false
21508           type: integer
21509           format: int64
21510         - name: vpn-id
21511           in: query
21512           description:
21513           required: false
21514           type: string
21515   /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:
21516     put:
21517       tags:
21518         - Network
21519       summary: see node definition for valid relationships
21520       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21521       consumes:
21522         - application/json
21523         - application/xml
21524       produces:
21525         - application/json
21526         - application/xml
21527       responses:
21528         "default":
21529           description: Response codes found in [response codes](https://wiki.onap.org/).
21530       parameters:
21531         - name: equipment-name
21532           in: path
21533           required: true
21534           type: string
21535           example: __EQUIPMENT-NAME__
21536         - name: interface-name
21537           in: path
21538           description: Name that identifies the link aggregate interface
21539           required: true
21540           type: string
21541           example: __INTERFACE-NAME__
21542         - name: interface-name
21543           in: path
21544           description: Name given to the interface
21545           required: true
21546           type: string
21547           example: __INTERFACE-NAME__
21548         - name: pci-id
21549           in: path
21550           description: PCI ID used to identify the sriov-vf
21551           required: true
21552           type: string
21553           example: __PCI-ID__
21554         - name: body
21555           in: body
21556           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21557           required: true
21558           schema:
21559             $ref: "#/definitions/relationship"
21560     delete:
21561       tags:
21562         - Network
21563       summary: delete an existing relationship
21564       description: delete an existing relationship
21565       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21566       consumes:
21567         - application/json
21568         - application/xml
21569       produces:
21570         - application/json
21571         - application/xml
21572       responses:
21573         "default":
21574           description: Response codes found in [response codes](https://wiki.onap.org/).
21575       parameters:
21576         - name: equipment-name
21577           in: path
21578           required: true
21579           type: string
21580           example: __EQUIPMENT-NAME__
21581         - name: interface-name
21582           in: path
21583           description: Name that identifies the link aggregate interface
21584           required: true
21585           type: string
21586           example: __INTERFACE-NAME__
21587         - name: interface-name
21588           in: path
21589           description: Name given to the interface
21590           required: true
21591           type: string
21592           example: __INTERFACE-NAME__
21593         - name: pci-id
21594           in: path
21595           description: PCI ID used to identify the sriov-vf
21596           required: true
21597           type: string
21598           example: __PCI-ID__
21599   /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}:
21600     get:
21601       tags:
21602         - Network
21603       summary: returns sriov-vf
21604       description: returns sriov-vf
21605       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21606       produces:
21607         - application/json
21608         - application/xml
21609       responses:
21610         "200":
21611           description: successful operation
21612           schema:
21613               $ref: "#/getDefinitions/sriov-vf"
21614         "default":
21615           description: Response codes found in [response codes](https://wiki.onap.org/).
21616       parameters:
21617         - name: equipment-name
21618           in: path
21619           required: true
21620           type: string
21621           example: __EQUIPMENT-NAME__
21622         - name: interface-name
21623           in: path
21624           description: Name that identifies the link aggregate interface
21625           required: true
21626           type: string
21627           example: __INTERFACE-NAME__
21628         - name: interface-name
21629           in: path
21630           description: Name given to the interface
21631           required: true
21632           type: string
21633           example: __INTERFACE-NAME__
21634         - name: pci-id
21635           in: path
21636           description: PCI ID used to identify the sriov-vf
21637           required: true
21638           type: string
21639           example: __PCI-ID__
21640     put:
21641       tags:
21642         - Network
21643       summary: create or update an existing sriov-vf
21644       description: |
21645         Create or update an existing sriov-vf.
21646         #
21647         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21648       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21649       consumes:
21650         - application/json
21651         - application/xml
21652       produces:
21653         - application/json
21654         - application/xml
21655       responses:
21656         "default":
21657           description: Response codes found in [response codes](https://wiki.onap.org/).
21658       parameters:
21659         - name: equipment-name
21660           in: path
21661           required: true
21662           type: string
21663           example: __EQUIPMENT-NAME__
21664         - name: interface-name
21665           in: path
21666           description: Name that identifies the link aggregate interface
21667           required: true
21668           type: string
21669           example: __INTERFACE-NAME__
21670         - name: interface-name
21671           in: path
21672           description: Name given to the interface
21673           required: true
21674           type: string
21675           example: __INTERFACE-NAME__
21676         - name: pci-id
21677           in: path
21678           description: PCI ID used to identify the sriov-vf
21679           required: true
21680           type: string
21681           example: __PCI-ID__
21682         - name: body
21683           in: body
21684           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21685           required: true
21686           schema:
21687             $ref: "#/definitions/sriov-vf"
21688     patch:
21689       tags:
21690         - Network
21691       summary: update an existing sriov-vf
21692       description: |
21693         Update an existing sriov-vf
21694         #
21695         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21696         The PUT operation will entirely replace an existing object.
21697         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21698         #
21699         Other differences between PUT and PATCH are:
21700         #
21701         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21702         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21703         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21704       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21705       consumes:
21706         - application/json
21707         - application/xml
21708       produces:
21709         - application/json
21710         - application/xml
21711       responses:
21712         "default":
21713           description: Response codes found in [response codes](https://wiki.onap.org/).
21714       parameters:
21715         - name: equipment-name
21716           in: path
21717           required: true
21718           type: string
21719           example: __EQUIPMENT-NAME__
21720         - name: interface-name
21721           in: path
21722           description: Name that identifies the link aggregate interface
21723           required: true
21724           type: string
21725           example: __INTERFACE-NAME__
21726         - name: interface-name
21727           in: path
21728           description: Name given to the interface
21729           required: true
21730           type: string
21731           example: __INTERFACE-NAME__
21732         - name: pci-id
21733           in: path
21734           description: PCI ID used to identify the sriov-vf
21735           required: true
21736           type: string
21737           example: __PCI-ID__
21738         - name: body
21739           in: body
21740           description: sriov-vf object that needs to be updated.
21741           required: true
21742           schema:
21743             $ref: "#/patchDefinitions/sriov-vf"
21744     delete:
21745       tags:
21746         - Network
21747       summary: delete an existing sriov-vf
21748       description: delete an existing sriov-vf
21749       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21750       consumes:
21751         - application/json
21752         - application/xml
21753       produces:
21754         - application/json
21755         - application/xml
21756       responses:
21757         "default":
21758           description: Response codes found in [response codes](https://wiki.onap.org/).
21759       parameters:
21760         - name: equipment-name
21761           in: path
21762           required: true
21763           type: string
21764           example: __EQUIPMENT-NAME__
21765         - name: interface-name
21766           in: path
21767           description: Name that identifies the link aggregate interface
21768           required: true
21769           type: string
21770           example: __INTERFACE-NAME__
21771         - name: interface-name
21772           in: path
21773           description: Name given to the interface
21774           required: true
21775           type: string
21776           example: __INTERFACE-NAME__
21777         - name: pci-id
21778           in: path
21779           description: PCI ID used to identify the sriov-vf
21780           required: true
21781           type: string
21782           example: __PCI-ID__
21783         - name: resource-version
21784           in: query
21785           description: resource-version for concurrency
21786           required: true
21787           type: string
21788   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
21789     get:
21790       tags:
21791         - Network
21792       summary: returns sriov-vfs
21793       description: returns sriov-vfs
21794       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
21795       produces:
21796         - application/json
21797         - application/xml
21798       responses:
21799         "200":
21800           description: successful operation
21801           schema:
21802               $ref: "#/getDefinitions/sriov-vfs"
21803         "default":
21804           description: Response codes found in [response codes](https://wiki.onap.org/).
21805       parameters:
21806         - name: equipment-name
21807           in: path
21808           required: true
21809           type: string
21810           example: __EQUIPMENT-NAME__
21811         - name: interface-name
21812           in: path
21813           description: Name that identifies the link aggregate interface
21814           required: true
21815           type: string
21816           example: __INTERFACE-NAME__
21817         - name: interface-name
21818           in: path
21819           description: Name given to the interface
21820           required: true
21821           type: string
21822           example: __INTERFACE-NAME__
21823         - name: pci-id
21824           in: query
21825           description:
21826           required: false
21827           type: string
21828         - name: vf-vlan-filter
21829           in: query
21830           description:
21831           required: false
21832           type: string
21833         - name: vf-mac-filter
21834           in: query
21835           description:
21836           required: false
21837           type: string
21838         - name: vf-vlan-strip
21839           in: query
21840           description:
21841           required: false
21842           type: boolean
21843         - name: neutron-network-id
21844           in: query
21845           description:
21846           required: false
21847           type: string
21848   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
21849     put:
21850       tags:
21851         - Network
21852       summary: see node definition for valid relationships
21853       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
21854       consumes:
21855         - application/json
21856         - application/xml
21857       produces:
21858         - application/json
21859         - application/xml
21860       responses:
21861         "default":
21862           description: Response codes found in [response codes](https://wiki.onap.org/).
21863       parameters:
21864         - name: equipment-name
21865           in: path
21866           required: true
21867           type: string
21868           example: __EQUIPMENT-NAME__
21869         - name: interface-name
21870           in: path
21871           description: Name that identifies the link aggregate interface
21872           required: true
21873           type: string
21874           example: __INTERFACE-NAME__
21875         - name: interface-name
21876           in: path
21877           description: Name given to the interface
21878           required: true
21879           type: string
21880           example: __INTERFACE-NAME__
21881         - name: body
21882           in: body
21883           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
21884           required: true
21885           schema:
21886             $ref: "#/definitions/relationship"
21887     delete:
21888       tags:
21889         - Network
21890       summary: delete an existing relationship
21891       description: delete an existing relationship
21892       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
21893       consumes:
21894         - application/json
21895         - application/xml
21896       produces:
21897         - application/json
21898         - application/xml
21899       responses:
21900         "default":
21901           description: Response codes found in [response codes](https://wiki.onap.org/).
21902       parameters:
21903         - name: equipment-name
21904           in: path
21905           required: true
21906           type: string
21907           example: __EQUIPMENT-NAME__
21908         - name: interface-name
21909           in: path
21910           description: Name that identifies the link aggregate interface
21911           required: true
21912           type: string
21913           example: __INTERFACE-NAME__
21914         - name: interface-name
21915           in: path
21916           description: Name given to the interface
21917           required: true
21918           type: string
21919           example: __INTERFACE-NAME__
21920   /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:
21921     put:
21922       tags:
21923         - Network
21924       summary: see node definition for valid relationships
21925       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21926       consumes:
21927         - application/json
21928         - application/xml
21929       produces:
21930         - application/json
21931         - application/xml
21932       responses:
21933         "default":
21934           description: Response codes found in [response codes](https://wiki.onap.org/).
21935       parameters:
21936         - name: equipment-name
21937           in: path
21938           required: true
21939           type: string
21940           example: __EQUIPMENT-NAME__
21941         - name: interface-name
21942           in: path
21943           description: Name that identifies the link aggregate interface
21944           required: true
21945           type: string
21946           example: __INTERFACE-NAME__
21947         - name: interface-name
21948           in: path
21949           description: Name given to the interface
21950           required: true
21951           type: string
21952           example: __INTERFACE-NAME__
21953         - name: l3-interface-ipv4-address
21954           in: path
21955           description: IP address
21956           required: true
21957           type: string
21958           example: __L3-INTERFACE-IPV4-ADDRESS__
21959         - name: body
21960           in: body
21961           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21962           required: true
21963           schema:
21964             $ref: "#/definitions/relationship"
21965     delete:
21966       tags:
21967         - Network
21968       summary: delete an existing relationship
21969       description: delete an existing relationship
21970       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21971       consumes:
21972         - application/json
21973         - application/xml
21974       produces:
21975         - application/json
21976         - application/xml
21977       responses:
21978         "default":
21979           description: Response codes found in [response codes](https://wiki.onap.org/).
21980       parameters:
21981         - name: equipment-name
21982           in: path
21983           required: true
21984           type: string
21985           example: __EQUIPMENT-NAME__
21986         - name: interface-name
21987           in: path
21988           description: Name that identifies the link aggregate interface
21989           required: true
21990           type: string
21991           example: __INTERFACE-NAME__
21992         - name: interface-name
21993           in: path
21994           description: Name given to the interface
21995           required: true
21996           type: string
21997           example: __INTERFACE-NAME__
21998         - name: l3-interface-ipv4-address
21999           in: path
22000           description: IP address
22001           required: true
22002           type: string
22003           example: __L3-INTERFACE-IPV4-ADDRESS__
22004   /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}:
22005     get:
22006       tags:
22007         - Network
22008       summary: returns l3-interface-ipv4-address-list
22009       description: returns l3-interface-ipv4-address-list
22010       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22011       produces:
22012         - application/json
22013         - application/xml
22014       responses:
22015         "200":
22016           description: successful operation
22017           schema:
22018               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22019         "default":
22020           description: Response codes found in [response codes](https://wiki.onap.org/).
22021       parameters:
22022         - name: equipment-name
22023           in: path
22024           required: true
22025           type: string
22026           example: __EQUIPMENT-NAME__
22027         - name: interface-name
22028           in: path
22029           description: Name that identifies the link aggregate interface
22030           required: true
22031           type: string
22032           example: __INTERFACE-NAME__
22033         - name: interface-name
22034           in: path
22035           description: Name given to the interface
22036           required: true
22037           type: string
22038           example: __INTERFACE-NAME__
22039         - name: l3-interface-ipv4-address
22040           in: path
22041           description: IP address
22042           required: true
22043           type: string
22044           example: __L3-INTERFACE-IPV4-ADDRESS__
22045     put:
22046       tags:
22047         - Network
22048       summary: create or update an existing l3-interface-ipv4-address-list
22049       description: |
22050         Create or update an existing l3-interface-ipv4-address-list.
22051         #
22052         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22053       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22054       consumes:
22055         - application/json
22056         - application/xml
22057       produces:
22058         - application/json
22059         - application/xml
22060       responses:
22061         "default":
22062           description: Response codes found in [response codes](https://wiki.onap.org/).
22063       parameters:
22064         - name: equipment-name
22065           in: path
22066           required: true
22067           type: string
22068           example: __EQUIPMENT-NAME__
22069         - name: interface-name
22070           in: path
22071           description: Name that identifies the link aggregate interface
22072           required: true
22073           type: string
22074           example: __INTERFACE-NAME__
22075         - name: interface-name
22076           in: path
22077           description: Name given to the interface
22078           required: true
22079           type: string
22080           example: __INTERFACE-NAME__
22081         - name: l3-interface-ipv4-address
22082           in: path
22083           description: IP address
22084           required: true
22085           type: string
22086           example: __L3-INTERFACE-IPV4-ADDRESS__
22087         - name: body
22088           in: body
22089           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
22090           required: true
22091           schema:
22092             $ref: "#/definitions/l3-interface-ipv4-address-list"
22093     patch:
22094       tags:
22095         - Network
22096       summary: update an existing l3-interface-ipv4-address-list
22097       description: |
22098         Update an existing l3-interface-ipv4-address-list
22099         #
22100         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22101         The PUT operation will entirely replace an existing object.
22102         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22103         #
22104         Other differences between PUT and PATCH are:
22105         #
22106         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22107         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22108         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22109       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22110       consumes:
22111         - application/json
22112         - application/xml
22113       produces:
22114         - application/json
22115         - application/xml
22116       responses:
22117         "default":
22118           description: Response codes found in [response codes](https://wiki.onap.org/).
22119       parameters:
22120         - name: equipment-name
22121           in: path
22122           required: true
22123           type: string
22124           example: __EQUIPMENT-NAME__
22125         - name: interface-name
22126           in: path
22127           description: Name that identifies the link aggregate interface
22128           required: true
22129           type: string
22130           example: __INTERFACE-NAME__
22131         - name: interface-name
22132           in: path
22133           description: Name given to the interface
22134           required: true
22135           type: string
22136           example: __INTERFACE-NAME__
22137         - name: l3-interface-ipv4-address
22138           in: path
22139           description: IP address
22140           required: true
22141           type: string
22142           example: __L3-INTERFACE-IPV4-ADDRESS__
22143         - name: body
22144           in: body
22145           description: l3-interface-ipv4-address-list object that needs to be updated.
22146           required: true
22147           schema:
22148             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22149     delete:
22150       tags:
22151         - Network
22152       summary: delete an existing l3-interface-ipv4-address-list
22153       description: delete an existing l3-interface-ipv4-address-list
22154       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22155       consumes:
22156         - application/json
22157         - application/xml
22158       produces:
22159         - application/json
22160         - application/xml
22161       responses:
22162         "default":
22163           description: Response codes found in [response codes](https://wiki.onap.org/).
22164       parameters:
22165         - name: equipment-name
22166           in: path
22167           required: true
22168           type: string
22169           example: __EQUIPMENT-NAME__
22170         - name: interface-name
22171           in: path
22172           description: Name that identifies the link aggregate interface
22173           required: true
22174           type: string
22175           example: __INTERFACE-NAME__
22176         - name: interface-name
22177           in: path
22178           description: Name given to the interface
22179           required: true
22180           type: string
22181           example: __INTERFACE-NAME__
22182         - name: l3-interface-ipv4-address
22183           in: path
22184           description: IP address
22185           required: true
22186           type: string
22187           example: __L3-INTERFACE-IPV4-ADDRESS__
22188         - name: resource-version
22189           in: query
22190           description: resource-version for concurrency
22191           required: true
22192           type: string
22193   /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:
22194     put:
22195       tags:
22196         - Network
22197       summary: see node definition for valid relationships
22198       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
22199       consumes:
22200         - application/json
22201         - application/xml
22202       produces:
22203         - application/json
22204         - application/xml
22205       responses:
22206         "default":
22207           description: Response codes found in [response codes](https://wiki.onap.org/).
22208       parameters:
22209         - name: equipment-name
22210           in: path
22211           required: true
22212           type: string
22213           example: __EQUIPMENT-NAME__
22214         - name: interface-name
22215           in: path
22216           description: Name that identifies the link aggregate interface
22217           required: true
22218           type: string
22219           example: __INTERFACE-NAME__
22220         - name: interface-name
22221           in: path
22222           description: Name given to the interface
22223           required: true
22224           type: string
22225           example: __INTERFACE-NAME__
22226         - name: l3-interface-ipv6-address
22227           in: path
22228           description: IP address
22229           required: true
22230           type: string
22231           example: __L3-INTERFACE-IPV6-ADDRESS__
22232         - name: body
22233           in: body
22234           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22235           required: true
22236           schema:
22237             $ref: "#/definitions/relationship"
22238     delete:
22239       tags:
22240         - Network
22241       summary: delete an existing relationship
22242       description: delete an existing relationship
22243       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
22244       consumes:
22245         - application/json
22246         - application/xml
22247       produces:
22248         - application/json
22249         - application/xml
22250       responses:
22251         "default":
22252           description: Response codes found in [response codes](https://wiki.onap.org/).
22253       parameters:
22254         - name: equipment-name
22255           in: path
22256           required: true
22257           type: string
22258           example: __EQUIPMENT-NAME__
22259         - name: interface-name
22260           in: path
22261           description: Name that identifies the link aggregate interface
22262           required: true
22263           type: string
22264           example: __INTERFACE-NAME__
22265         - name: interface-name
22266           in: path
22267           description: Name given to the interface
22268           required: true
22269           type: string
22270           example: __INTERFACE-NAME__
22271         - name: l3-interface-ipv6-address
22272           in: path
22273           description: IP address
22274           required: true
22275           type: string
22276           example: __L3-INTERFACE-IPV6-ADDRESS__
22277   /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}:
22278     get:
22279       tags:
22280         - Network
22281       summary: returns l3-interface-ipv6-address-list
22282       description: returns l3-interface-ipv6-address-list
22283       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22284       produces:
22285         - application/json
22286         - application/xml
22287       responses:
22288         "200":
22289           description: successful operation
22290           schema:
22291               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22292         "default":
22293           description: Response codes found in [response codes](https://wiki.onap.org/).
22294       parameters:
22295         - name: equipment-name
22296           in: path
22297           required: true
22298           type: string
22299           example: __EQUIPMENT-NAME__
22300         - name: interface-name
22301           in: path
22302           description: Name that identifies the link aggregate interface
22303           required: true
22304           type: string
22305           example: __INTERFACE-NAME__
22306         - name: interface-name
22307           in: path
22308           description: Name given to the interface
22309           required: true
22310           type: string
22311           example: __INTERFACE-NAME__
22312         - name: l3-interface-ipv6-address
22313           in: path
22314           description: IP address
22315           required: true
22316           type: string
22317           example: __L3-INTERFACE-IPV6-ADDRESS__
22318     put:
22319       tags:
22320         - Network
22321       summary: create or update an existing l3-interface-ipv6-address-list
22322       description: |
22323         Create or update an existing l3-interface-ipv6-address-list.
22324         #
22325         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22326       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22327       consumes:
22328         - application/json
22329         - application/xml
22330       produces:
22331         - application/json
22332         - application/xml
22333       responses:
22334         "default":
22335           description: Response codes found in [response codes](https://wiki.onap.org/).
22336       parameters:
22337         - name: equipment-name
22338           in: path
22339           required: true
22340           type: string
22341           example: __EQUIPMENT-NAME__
22342         - name: interface-name
22343           in: path
22344           description: Name that identifies the link aggregate interface
22345           required: true
22346           type: string
22347           example: __INTERFACE-NAME__
22348         - name: interface-name
22349           in: path
22350           description: Name given to the interface
22351           required: true
22352           type: string
22353           example: __INTERFACE-NAME__
22354         - name: l3-interface-ipv6-address
22355           in: path
22356           description: IP address
22357           required: true
22358           type: string
22359           example: __L3-INTERFACE-IPV6-ADDRESS__
22360         - name: body
22361           in: body
22362           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22363           required: true
22364           schema:
22365             $ref: "#/definitions/l3-interface-ipv6-address-list"
22366     patch:
22367       tags:
22368         - Network
22369       summary: update an existing l3-interface-ipv6-address-list
22370       description: |
22371         Update an existing l3-interface-ipv6-address-list
22372         #
22373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22374         The PUT operation will entirely replace an existing object.
22375         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22376         #
22377         Other differences between PUT and PATCH are:
22378         #
22379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22382       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22383       consumes:
22384         - application/json
22385         - application/xml
22386       produces:
22387         - application/json
22388         - application/xml
22389       responses:
22390         "default":
22391           description: Response codes found in [response codes](https://wiki.onap.org/).
22392       parameters:
22393         - name: equipment-name
22394           in: path
22395           required: true
22396           type: string
22397           example: __EQUIPMENT-NAME__
22398         - name: interface-name
22399           in: path
22400           description: Name that identifies the link aggregate interface
22401           required: true
22402           type: string
22403           example: __INTERFACE-NAME__
22404         - name: interface-name
22405           in: path
22406           description: Name given to the interface
22407           required: true
22408           type: string
22409           example: __INTERFACE-NAME__
22410         - name: l3-interface-ipv6-address
22411           in: path
22412           description: IP address
22413           required: true
22414           type: string
22415           example: __L3-INTERFACE-IPV6-ADDRESS__
22416         - name: body
22417           in: body
22418           description: l3-interface-ipv6-address-list object that needs to be updated.
22419           required: true
22420           schema:
22421             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22422     delete:
22423       tags:
22424         - Network
22425       summary: delete an existing l3-interface-ipv6-address-list
22426       description: delete an existing l3-interface-ipv6-address-list
22427       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22428       consumes:
22429         - application/json
22430         - application/xml
22431       produces:
22432         - application/json
22433         - application/xml
22434       responses:
22435         "default":
22436           description: Response codes found in [response codes](https://wiki.onap.org/).
22437       parameters:
22438         - name: equipment-name
22439           in: path
22440           required: true
22441           type: string
22442           example: __EQUIPMENT-NAME__
22443         - name: interface-name
22444           in: path
22445           description: Name that identifies the link aggregate interface
22446           required: true
22447           type: string
22448           example: __INTERFACE-NAME__
22449         - name: interface-name
22450           in: path
22451           description: Name given to the interface
22452           required: true
22453           type: string
22454           example: __INTERFACE-NAME__
22455         - name: l3-interface-ipv6-address
22456           in: path
22457           description: IP address
22458           required: true
22459           type: string
22460           example: __L3-INTERFACE-IPV6-ADDRESS__
22461         - name: resource-version
22462           in: query
22463           description: resource-version for concurrency
22464           required: true
22465           type: string
22466   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
22467     get:
22468       tags:
22469         - Network
22470       summary: returns l-interface
22471       description: returns l-interface
22472       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22473       produces:
22474         - application/json
22475         - application/xml
22476       responses:
22477         "200":
22478           description: successful operation
22479           schema:
22480               $ref: "#/getDefinitions/l-interface"
22481         "default":
22482           description: Response codes found in [response codes](https://wiki.onap.org/).
22483       parameters:
22484         - name: equipment-name
22485           in: path
22486           required: true
22487           type: string
22488           example: __EQUIPMENT-NAME__
22489         - name: interface-name
22490           in: path
22491           description: Name that identifies the link aggregate interface
22492           required: true
22493           type: string
22494           example: __INTERFACE-NAME__
22495         - name: interface-name
22496           in: path
22497           description: Name given to the interface
22498           required: true
22499           type: string
22500           example: __INTERFACE-NAME__
22501     put:
22502       tags:
22503         - Network
22504       summary: create or update an existing l-interface
22505       description: |
22506         Create or update an existing l-interface.
22507         #
22508         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22509       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22510       consumes:
22511         - application/json
22512         - application/xml
22513       produces:
22514         - application/json
22515         - application/xml
22516       responses:
22517         "default":
22518           description: Response codes found in [response codes](https://wiki.onap.org/).
22519       parameters:
22520         - name: equipment-name
22521           in: path
22522           required: true
22523           type: string
22524           example: __EQUIPMENT-NAME__
22525         - name: interface-name
22526           in: path
22527           description: Name that identifies the link aggregate interface
22528           required: true
22529           type: string
22530           example: __INTERFACE-NAME__
22531         - name: interface-name
22532           in: path
22533           description: Name given to the interface
22534           required: true
22535           type: string
22536           example: __INTERFACE-NAME__
22537         - name: body
22538           in: body
22539           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
22540           required: true
22541           schema:
22542             $ref: "#/definitions/l-interface"
22543     patch:
22544       tags:
22545         - Network
22546       summary: update an existing l-interface
22547       description: |
22548         Update an existing l-interface
22549         #
22550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22551         The PUT operation will entirely replace an existing object.
22552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22553         #
22554         Other differences between PUT and PATCH are:
22555         #
22556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22559       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22560       consumes:
22561         - application/json
22562         - application/xml
22563       produces:
22564         - application/json
22565         - application/xml
22566       responses:
22567         "default":
22568           description: Response codes found in [response codes](https://wiki.onap.org/).
22569       parameters:
22570         - name: equipment-name
22571           in: path
22572           required: true
22573           type: string
22574           example: __EQUIPMENT-NAME__
22575         - name: interface-name
22576           in: path
22577           description: Name that identifies the link aggregate interface
22578           required: true
22579           type: string
22580           example: __INTERFACE-NAME__
22581         - name: interface-name
22582           in: path
22583           description: Name given to the interface
22584           required: true
22585           type: string
22586           example: __INTERFACE-NAME__
22587         - name: body
22588           in: body
22589           description: l-interface object that needs to be updated.
22590           required: true
22591           schema:
22592             $ref: "#/patchDefinitions/l-interface"
22593     delete:
22594       tags:
22595         - Network
22596       summary: delete an existing l-interface
22597       description: delete an existing l-interface
22598       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22599       consumes:
22600         - application/json
22601         - application/xml
22602       produces:
22603         - application/json
22604         - application/xml
22605       responses:
22606         "default":
22607           description: Response codes found in [response codes](https://wiki.onap.org/).
22608       parameters:
22609         - name: equipment-name
22610           in: path
22611           required: true
22612           type: string
22613           example: __EQUIPMENT-NAME__
22614         - name: interface-name
22615           in: path
22616           description: Name that identifies the link aggregate interface
22617           required: true
22618           type: string
22619           example: __INTERFACE-NAME__
22620         - name: interface-name
22621           in: path
22622           description: Name given to the interface
22623           required: true
22624           type: string
22625           example: __INTERFACE-NAME__
22626         - name: resource-version
22627           in: query
22628           description: resource-version for concurrency
22629           required: true
22630           type: string
22631   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
22632     get:
22633       tags:
22634         - Network
22635       summary: returns l-interfaces
22636       description: returns l-interfaces
22637       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
22638       produces:
22639         - application/json
22640         - application/xml
22641       responses:
22642         "200":
22643           description: successful operation
22644           schema:
22645               $ref: "#/getDefinitions/l-interfaces"
22646         "default":
22647           description: Response codes found in [response codes](https://wiki.onap.org/).
22648       parameters:
22649         - name: equipment-name
22650           in: path
22651           required: true
22652           type: string
22653           example: __EQUIPMENT-NAME__
22654         - name: interface-name
22655           in: path
22656           description: Name that identifies the link aggregate interface
22657           required: true
22658           type: string
22659           example: __INTERFACE-NAME__
22660         - name: interface-name
22661           in: query
22662           description:
22663           required: false
22664           type: string
22665         - name: interface-id
22666           in: query
22667           description:
22668           required: false
22669           type: string
22670         - name: macaddr
22671           in: query
22672           description:
22673           required: false
22674           type: string
22675         - name: network-name
22676           in: query
22677           description:
22678           required: false
22679           type: string
22680   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
22681     get:
22682       tags:
22683         - Network
22684       summary: returns lag-interface
22685       description: returns lag-interface
22686       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
22687       produces:
22688         - application/json
22689         - application/xml
22690       responses:
22691         "200":
22692           description: successful operation
22693           schema:
22694               $ref: "#/getDefinitions/lag-interface"
22695         "default":
22696           description: Response codes found in [response codes](https://wiki.onap.org/).
22697       parameters:
22698         - name: equipment-name
22699           in: path
22700           required: true
22701           type: string
22702           example: __EQUIPMENT-NAME__
22703         - name: interface-name
22704           in: path
22705           description: Name that identifies the link aggregate interface
22706           required: true
22707           type: string
22708           example: __INTERFACE-NAME__
22709     put:
22710       tags:
22711         - Network
22712       summary: create or update an existing lag-interface
22713       description: |
22714         Create or update an existing lag-interface.
22715         #
22716         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22717       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
22718       consumes:
22719         - application/json
22720         - application/xml
22721       produces:
22722         - application/json
22723         - application/xml
22724       responses:
22725         "default":
22726           description: Response codes found in [response codes](https://wiki.onap.org/).
22727       parameters:
22728         - name: equipment-name
22729           in: path
22730           required: true
22731           type: string
22732           example: __EQUIPMENT-NAME__
22733         - name: interface-name
22734           in: path
22735           description: Name that identifies the link aggregate interface
22736           required: true
22737           type: string
22738           example: __INTERFACE-NAME__
22739         - name: body
22740           in: body
22741           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
22742           required: true
22743           schema:
22744             $ref: "#/definitions/lag-interface"
22745     patch:
22746       tags:
22747         - Network
22748       summary: update an existing lag-interface
22749       description: |
22750         Update an existing lag-interface
22751         #
22752         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22753         The PUT operation will entirely replace an existing object.
22754         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22755         #
22756         Other differences between PUT and PATCH are:
22757         #
22758         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22759         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22760         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22761       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
22762       consumes:
22763         - application/json
22764         - application/xml
22765       produces:
22766         - application/json
22767         - application/xml
22768       responses:
22769         "default":
22770           description: Response codes found in [response codes](https://wiki.onap.org/).
22771       parameters:
22772         - name: equipment-name
22773           in: path
22774           required: true
22775           type: string
22776           example: __EQUIPMENT-NAME__
22777         - name: interface-name
22778           in: path
22779           description: Name that identifies the link aggregate interface
22780           required: true
22781           type: string
22782           example: __INTERFACE-NAME__
22783         - name: body
22784           in: body
22785           description: lag-interface object that needs to be updated.
22786           required: true
22787           schema:
22788             $ref: "#/patchDefinitions/lag-interface"
22789     delete:
22790       tags:
22791         - Network
22792       summary: delete an existing lag-interface
22793       description: delete an existing lag-interface
22794       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
22795       consumes:
22796         - application/json
22797         - application/xml
22798       produces:
22799         - application/json
22800         - application/xml
22801       responses:
22802         "default":
22803           description: Response codes found in [response codes](https://wiki.onap.org/).
22804       parameters:
22805         - name: equipment-name
22806           in: path
22807           required: true
22808           type: string
22809           example: __EQUIPMENT-NAME__
22810         - name: interface-name
22811           in: path
22812           description: Name that identifies the link aggregate interface
22813           required: true
22814           type: string
22815           example: __INTERFACE-NAME__
22816         - name: resource-version
22817           in: query
22818           description: resource-version for concurrency
22819           required: true
22820           type: string
22821   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
22822     get:
22823       tags:
22824         - Network
22825       summary: returns lag-interfaces
22826       description: returns lag-interfaces
22827       operationId: getNetworkVplsPesVplsPeLagInterfaces
22828       produces:
22829         - application/json
22830         - application/xml
22831       responses:
22832         "200":
22833           description: successful operation
22834           schema:
22835               $ref: "#/getDefinitions/lag-interfaces"
22836         "default":
22837           description: Response codes found in [response codes](https://wiki.onap.org/).
22838       parameters:
22839         - name: equipment-name
22840           in: path
22841           required: true
22842           type: string
22843           example: __EQUIPMENT-NAME__
22844         - name: interface-name
22845           in: query
22846           description:
22847           required: false
22848           type: string
22849   /network/vpls-pes/vpls-pe/{equipment-name}:
22850     get:
22851       tags:
22852         - Network
22853       summary: returns vpls-pe
22854       description: returns vpls-pe
22855       operationId: getNetworkVplsPesVplsPe
22856       produces:
22857         - application/json
22858         - application/xml
22859       responses:
22860         "200":
22861           description: successful operation
22862           schema:
22863               $ref: "#/getDefinitions/vpls-pe"
22864         "default":
22865           description: Response codes found in [response codes](https://wiki.onap.org/).
22866       parameters:
22867         - name: equipment-name
22868           in: path
22869           required: true
22870           type: string
22871           example: __EQUIPMENT-NAME__
22872     put:
22873       tags:
22874         - Network
22875       summary: create or update an existing vpls-pe
22876       description: |
22877         Create or update an existing vpls-pe.
22878         #
22879         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22880       operationId: createOrUpdateNetworkVplsPesVplsPe
22881       consumes:
22882         - application/json
22883         - application/xml
22884       produces:
22885         - application/json
22886         - application/xml
22887       responses:
22888         "default":
22889           description: Response codes found in [response codes](https://wiki.onap.org/).
22890       parameters:
22891         - name: equipment-name
22892           in: path
22893           required: true
22894           type: string
22895           example: __EQUIPMENT-NAME__
22896         - name: body
22897           in: body
22898           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
22899           required: true
22900           schema:
22901             $ref: "#/definitions/vpls-pe"
22902     patch:
22903       tags:
22904         - Network
22905       summary: update an existing vpls-pe
22906       description: |
22907         Update an existing vpls-pe
22908         #
22909         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22910         The PUT operation will entirely replace an existing object.
22911         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22912         #
22913         Other differences between PUT and PATCH are:
22914         #
22915         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22916         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22917         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22918       operationId: UpdateNetworkVplsPesVplsPe
22919       consumes:
22920         - application/json
22921         - application/xml
22922       produces:
22923         - application/json
22924         - application/xml
22925       responses:
22926         "default":
22927           description: Response codes found in [response codes](https://wiki.onap.org/).
22928       parameters:
22929         - name: equipment-name
22930           in: path
22931           required: true
22932           type: string
22933           example: __EQUIPMENT-NAME__
22934         - name: body
22935           in: body
22936           description: vpls-pe object that needs to be updated.
22937           required: true
22938           schema:
22939             $ref: "#/patchDefinitions/vpls-pe"
22940     delete:
22941       tags:
22942         - Network
22943       summary: delete an existing vpls-pe
22944       description: delete an existing vpls-pe
22945       operationId: deleteNetworkVplsPesVplsPe
22946       consumes:
22947         - application/json
22948         - application/xml
22949       produces:
22950         - application/json
22951         - application/xml
22952       responses:
22953         "default":
22954           description: Response codes found in [response codes](https://wiki.onap.org/).
22955       parameters:
22956         - name: equipment-name
22957           in: path
22958           required: true
22959           type: string
22960           example: __EQUIPMENT-NAME__
22961         - name: resource-version
22962           in: query
22963           description: resource-version for concurrency
22964           required: true
22965           type: string
22966   /network/vpls-pes:
22967     get:
22968       tags:
22969         - Network
22970       summary: returns vpls-pes
22971       description: returns vpls-pes
22972       operationId: getNetworkVplsPes
22973       produces:
22974         - application/json
22975         - application/xml
22976       responses:
22977         "200":
22978           description: successful operation
22979           schema:
22980               $ref: "#/getDefinitions/vpls-pes"
22981         "default":
22982           description: Response codes found in [response codes](https://wiki.onap.org/).
22983       parameters:
22984         - name: equipment-name
22985           in: query
22986           description:
22987           required: false
22988           type: string
22989         - name: prov-status
22990           in: query
22991           description:
22992           required: false
22993           type: string
22994   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
22995     put:
22996       tags:
22997         - Network
22998       summary: see node definition for valid relationships
22999       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
23000       consumes:
23001         - application/json
23002         - application/xml
23003       produces:
23004         - application/json
23005         - application/xml
23006       responses:
23007         "default":
23008           description: Response codes found in [response codes](https://wiki.onap.org/).
23009       parameters:
23010         - name: multicast-configuration-id
23011           in: path
23012           description: Unique id of multicast configuration.
23013           required: true
23014           type: string
23015           example: __MULTICAST-CONFIGURATION-ID__
23016         - name: body
23017           in: body
23018           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
23019           required: true
23020           schema:
23021             $ref: "#/definitions/relationship"
23022     delete:
23023       tags:
23024         - Network
23025       summary: delete an existing relationship
23026       description: delete an existing relationship
23027       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
23028       consumes:
23029         - application/json
23030         - application/xml
23031       produces:
23032         - application/json
23033         - application/xml
23034       responses:
23035         "default":
23036           description: Response codes found in [response codes](https://wiki.onap.org/).
23037       parameters:
23038         - name: multicast-configuration-id
23039           in: path
23040           description: Unique id of multicast configuration.
23041           required: true
23042           type: string
23043           example: __MULTICAST-CONFIGURATION-ID__
23044   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
23045     get:
23046       tags:
23047         - Network
23048       summary: returns multicast-configuration
23049       description: returns multicast-configuration
23050       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
23051       produces:
23052         - application/json
23053         - application/xml
23054       responses:
23055         "200":
23056           description: successful operation
23057           schema:
23058               $ref: "#/getDefinitions/multicast-configuration"
23059         "default":
23060           description: Response codes found in [response codes](https://wiki.onap.org/).
23061       parameters:
23062         - name: multicast-configuration-id
23063           in: path
23064           description: Unique id of multicast configuration.
23065           required: true
23066           type: string
23067           example: __MULTICAST-CONFIGURATION-ID__
23068     put:
23069       tags:
23070         - Network
23071       summary: create or update an existing multicast-configuration
23072       description: |
23073         Create or update an existing multicast-configuration.
23074         #
23075         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23076       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
23077       consumes:
23078         - application/json
23079         - application/xml
23080       produces:
23081         - application/json
23082         - application/xml
23083       responses:
23084         "default":
23085           description: Response codes found in [response codes](https://wiki.onap.org/).
23086       parameters:
23087         - name: multicast-configuration-id
23088           in: path
23089           description: Unique id of multicast configuration.
23090           required: true
23091           type: string
23092           example: __MULTICAST-CONFIGURATION-ID__
23093         - name: body
23094           in: body
23095           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
23096           required: true
23097           schema:
23098             $ref: "#/definitions/multicast-configuration"
23099     patch:
23100       tags:
23101         - Network
23102       summary: update an existing multicast-configuration
23103       description: |
23104         Update an existing multicast-configuration
23105         #
23106         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23107         The PUT operation will entirely replace an existing object.
23108         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23109         #
23110         Other differences between PUT and PATCH are:
23111         #
23112         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23113         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23114         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23115       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
23116       consumes:
23117         - application/json
23118         - application/xml
23119       produces:
23120         - application/json
23121         - application/xml
23122       responses:
23123         "default":
23124           description: Response codes found in [response codes](https://wiki.onap.org/).
23125       parameters:
23126         - name: multicast-configuration-id
23127           in: path
23128           description: Unique id of multicast configuration.
23129           required: true
23130           type: string
23131           example: __MULTICAST-CONFIGURATION-ID__
23132         - name: body
23133           in: body
23134           description: multicast-configuration object that needs to be updated.
23135           required: true
23136           schema:
23137             $ref: "#/patchDefinitions/multicast-configuration"
23138     delete:
23139       tags:
23140         - Network
23141       summary: delete an existing multicast-configuration
23142       description: delete an existing multicast-configuration
23143       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
23144       consumes:
23145         - application/json
23146         - application/xml
23147       produces:
23148         - application/json
23149         - application/xml
23150       responses:
23151         "default":
23152           description: Response codes found in [response codes](https://wiki.onap.org/).
23153       parameters:
23154         - name: multicast-configuration-id
23155           in: path
23156           description: Unique id of multicast configuration.
23157           required: true
23158           type: string
23159           example: __MULTICAST-CONFIGURATION-ID__
23160         - name: resource-version
23161           in: query
23162           description: resource-version for concurrency
23163           required: true
23164           type: string
23165   /network/multicast-configurations:
23166     get:
23167       tags:
23168         - Network
23169       summary: returns multicast-configurations
23170       description: returns multicast-configurations
23171       operationId: getNetworkMulticastConfigurations
23172       produces:
23173         - application/json
23174         - application/xml
23175       responses:
23176         "200":
23177           description: successful operation
23178           schema:
23179               $ref: "#/getDefinitions/multicast-configurations"
23180         "default":
23181           description: Response codes found in [response codes](https://wiki.onap.org/).
23182       parameters:
23183         - name: multicast-configuration-id
23184           in: query
23185           description:
23186           required: false
23187           type: string
23188   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
23189     put:
23190       tags:
23191         - Network
23192       summary: see node definition for valid relationships
23193       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
23194       consumes:
23195         - application/json
23196         - application/xml
23197       produces:
23198         - application/json
23199         - application/xml
23200       responses:
23201         "default":
23202           description: Response codes found in [response codes](https://wiki.onap.org/).
23203       parameters:
23204         - name: vnf-id
23205           in: path
23206           description: Unique id of VNF.  This is unique across the graph.
23207           required: true
23208           type: string
23209           example: __VNF-ID__
23210         - name: interface-id
23211           in: path
23212           description: Unique ID of the interface
23213           required: true
23214           type: string
23215           example: __INTERFACE-ID__
23216         - name: cvlan-tag
23217           in: path
23218           description: See mis-na-virtualization-platform.yang
23219           required: true
23220           type: integer
23221           format: int64
23222           example: __CVLAN-TAG__
23223         - name: body
23224           in: body
23225           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
23226           required: true
23227           schema:
23228             $ref: "#/definitions/relationship"
23229     delete:
23230       tags:
23231         - Network
23232       summary: delete an existing relationship
23233       description: delete an existing relationship
23234       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
23235       consumes:
23236         - application/json
23237         - application/xml
23238       produces:
23239         - application/json
23240         - application/xml
23241       responses:
23242         "default":
23243           description: Response codes found in [response codes](https://wiki.onap.org/).
23244       parameters:
23245         - name: vnf-id
23246           in: path
23247           description: Unique id of VNF.  This is unique across the graph.
23248           required: true
23249           type: string
23250           example: __VNF-ID__
23251         - name: interface-id
23252           in: path
23253           description: Unique ID of the interface
23254           required: true
23255           type: string
23256           example: __INTERFACE-ID__
23257         - name: cvlan-tag
23258           in: path
23259           description: See mis-na-virtualization-platform.yang
23260           required: true
23261           type: integer
23262           format: int64
23263           example: __CVLAN-TAG__
23264   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
23265     get:
23266       tags:
23267         - Network
23268       summary: returns cvlan-tag-entry
23269       description: returns cvlan-tag-entry
23270       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23271       produces:
23272         - application/json
23273         - application/xml
23274       responses:
23275         "200":
23276           description: successful operation
23277           schema:
23278               $ref: "#/getDefinitions/cvlan-tag-entry"
23279         "default":
23280           description: Response codes found in [response codes](https://wiki.onap.org/).
23281       parameters:
23282         - name: vnf-id
23283           in: path
23284           description: Unique id of VNF.  This is unique across the graph.
23285           required: true
23286           type: string
23287           example: __VNF-ID__
23288         - name: interface-id
23289           in: path
23290           description: Unique ID of the interface
23291           required: true
23292           type: string
23293           example: __INTERFACE-ID__
23294         - name: cvlan-tag
23295           in: path
23296           description: See mis-na-virtualization-platform.yang
23297           required: true
23298           type: integer
23299           format: int64
23300           example: __CVLAN-TAG__
23301     put:
23302       tags:
23303         - Network
23304       summary: create or update an existing cvlan-tag-entry
23305       description: |
23306         Create or update an existing cvlan-tag-entry.
23307         #
23308         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23309       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23310       consumes:
23311         - application/json
23312         - application/xml
23313       produces:
23314         - application/json
23315         - application/xml
23316       responses:
23317         "default":
23318           description: Response codes found in [response codes](https://wiki.onap.org/).
23319       parameters:
23320         - name: vnf-id
23321           in: path
23322           description: Unique id of VNF.  This is unique across the graph.
23323           required: true
23324           type: string
23325           example: __VNF-ID__
23326         - name: interface-id
23327           in: path
23328           description: Unique ID of the interface
23329           required: true
23330           type: string
23331           example: __INTERFACE-ID__
23332         - name: cvlan-tag
23333           in: path
23334           description: See mis-na-virtualization-platform.yang
23335           required: true
23336           type: integer
23337           format: int64
23338           example: __CVLAN-TAG__
23339         - name: body
23340           in: body
23341           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
23342           required: true
23343           schema:
23344             $ref: "#/definitions/cvlan-tag-entry"
23345     patch:
23346       tags:
23347         - Network
23348       summary: update an existing cvlan-tag-entry
23349       description: |
23350         Update an existing cvlan-tag-entry
23351         #
23352         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23353         The PUT operation will entirely replace an existing object.
23354         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23355         #
23356         Other differences between PUT and PATCH are:
23357         #
23358         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23359         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23360         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23361       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23362       consumes:
23363         - application/json
23364         - application/xml
23365       produces:
23366         - application/json
23367         - application/xml
23368       responses:
23369         "default":
23370           description: Response codes found in [response codes](https://wiki.onap.org/).
23371       parameters:
23372         - name: vnf-id
23373           in: path
23374           description: Unique id of VNF.  This is unique across the graph.
23375           required: true
23376           type: string
23377           example: __VNF-ID__
23378         - name: interface-id
23379           in: path
23380           description: Unique ID of the interface
23381           required: true
23382           type: string
23383           example: __INTERFACE-ID__
23384         - name: cvlan-tag
23385           in: path
23386           description: See mis-na-virtualization-platform.yang
23387           required: true
23388           type: integer
23389           format: int64
23390           example: __CVLAN-TAG__
23391         - name: body
23392           in: body
23393           description: cvlan-tag-entry object that needs to be updated.
23394           required: true
23395           schema:
23396             $ref: "#/patchDefinitions/cvlan-tag-entry"
23397     delete:
23398       tags:
23399         - Network
23400       summary: delete an existing cvlan-tag-entry
23401       description: delete an existing cvlan-tag-entry
23402       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23403       consumes:
23404         - application/json
23405         - application/xml
23406       produces:
23407         - application/json
23408         - application/xml
23409       responses:
23410         "default":
23411           description: Response codes found in [response codes](https://wiki.onap.org/).
23412       parameters:
23413         - name: vnf-id
23414           in: path
23415           description: Unique id of VNF.  This is unique across the graph.
23416           required: true
23417           type: string
23418           example: __VNF-ID__
23419         - name: interface-id
23420           in: path
23421           description: Unique ID of the interface
23422           required: true
23423           type: string
23424           example: __INTERFACE-ID__
23425         - name: cvlan-tag
23426           in: path
23427           description: See mis-na-virtualization-platform.yang
23428           required: true
23429           type: integer
23430           format: int64
23431           example: __CVLAN-TAG__
23432         - name: resource-version
23433           in: query
23434           description: resource-version for concurrency
23435           required: true
23436           type: string
23437   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
23438     get:
23439       tags:
23440         - Network
23441       summary: returns cvlan-tags
23442       description: returns cvlan-tags
23443       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
23444       produces:
23445         - application/json
23446         - application/xml
23447       responses:
23448         "200":
23449           description: successful operation
23450           schema:
23451               $ref: "#/getDefinitions/cvlan-tags"
23452         "default":
23453           description: Response codes found in [response codes](https://wiki.onap.org/).
23454       parameters:
23455         - name: vnf-id
23456           in: path
23457           description: Unique id of VNF.  This is unique across the graph.
23458           required: true
23459           type: string
23460           example: __VNF-ID__
23461         - name: interface-id
23462           in: path
23463           description: Unique ID of the interface
23464           required: true
23465           type: string
23466           example: __INTERFACE-ID__
23467         - name: cvlan-tag
23468           in: query
23469           description:
23470           required: false
23471           type: integer
23472           format: int64
23473   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
23474     put:
23475       tags:
23476         - Network
23477       summary: see node definition for valid relationships
23478       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
23479       consumes:
23480         - application/json
23481         - application/xml
23482       produces:
23483         - application/json
23484         - application/xml
23485       responses:
23486         "default":
23487           description: Response codes found in [response codes](https://wiki.onap.org/).
23488       parameters:
23489         - name: vnf-id
23490           in: path
23491           description: Unique id of VNF.  This is unique across the graph.
23492           required: true
23493           type: string
23494           example: __VNF-ID__
23495         - name: interface-id
23496           in: path
23497           description: Unique ID of the interface
23498           required: true
23499           type: string
23500           example: __INTERFACE-ID__
23501         - name: body
23502           in: body
23503           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
23504           required: true
23505           schema:
23506             $ref: "#/definitions/relationship"
23507     delete:
23508       tags:
23509         - Network
23510       summary: delete an existing relationship
23511       description: delete an existing relationship
23512       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
23513       consumes:
23514         - application/json
23515         - application/xml
23516       produces:
23517         - application/json
23518         - application/xml
23519       responses:
23520         "default":
23521           description: Response codes found in [response codes](https://wiki.onap.org/).
23522       parameters:
23523         - name: vnf-id
23524           in: path
23525           description: Unique id of VNF.  This is unique across the graph.
23526           required: true
23527           type: string
23528           example: __VNF-ID__
23529         - name: interface-id
23530           in: path
23531           description: Unique ID of the interface
23532           required: true
23533           type: string
23534           example: __INTERFACE-ID__
23535   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
23536     get:
23537       tags:
23538         - Network
23539       summary: returns port-group
23540       description: returns port-group
23541       operationId: getNetworkVcesVcePortGroupsPortGroup
23542       produces:
23543         - application/json
23544         - application/xml
23545       responses:
23546         "200":
23547           description: successful operation
23548           schema:
23549               $ref: "#/getDefinitions/port-group"
23550         "default":
23551           description: Response codes found in [response codes](https://wiki.onap.org/).
23552       parameters:
23553         - name: vnf-id
23554           in: path
23555           description: Unique id of VNF.  This is unique across the graph.
23556           required: true
23557           type: string
23558           example: __VNF-ID__
23559         - name: interface-id
23560           in: path
23561           description: Unique ID of the interface
23562           required: true
23563           type: string
23564           example: __INTERFACE-ID__
23565     put:
23566       tags:
23567         - Network
23568       summary: create or update an existing port-group
23569       description: |
23570         Create or update an existing port-group.
23571         #
23572         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23573       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
23574       consumes:
23575         - application/json
23576         - application/xml
23577       produces:
23578         - application/json
23579         - application/xml
23580       responses:
23581         "default":
23582           description: Response codes found in [response codes](https://wiki.onap.org/).
23583       parameters:
23584         - name: vnf-id
23585           in: path
23586           description: Unique id of VNF.  This is unique across the graph.
23587           required: true
23588           type: string
23589           example: __VNF-ID__
23590         - name: interface-id
23591           in: path
23592           description: Unique ID of the interface
23593           required: true
23594           type: string
23595           example: __INTERFACE-ID__
23596         - name: body
23597           in: body
23598           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
23599           required: true
23600           schema:
23601             $ref: "#/definitions/port-group"
23602     patch:
23603       tags:
23604         - Network
23605       summary: update an existing port-group
23606       description: |
23607         Update an existing port-group
23608         #
23609         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23610         The PUT operation will entirely replace an existing object.
23611         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23612         #
23613         Other differences between PUT and PATCH are:
23614         #
23615         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23616         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23617         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23618       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
23619       consumes:
23620         - application/json
23621         - application/xml
23622       produces:
23623         - application/json
23624         - application/xml
23625       responses:
23626         "default":
23627           description: Response codes found in [response codes](https://wiki.onap.org/).
23628       parameters:
23629         - name: vnf-id
23630           in: path
23631           description: Unique id of VNF.  This is unique across the graph.
23632           required: true
23633           type: string
23634           example: __VNF-ID__
23635         - name: interface-id
23636           in: path
23637           description: Unique ID of the interface
23638           required: true
23639           type: string
23640           example: __INTERFACE-ID__
23641         - name: body
23642           in: body
23643           description: port-group object that needs to be updated.
23644           required: true
23645           schema:
23646             $ref: "#/patchDefinitions/port-group"
23647     delete:
23648       tags:
23649         - Network
23650       summary: delete an existing port-group
23651       description: delete an existing port-group
23652       operationId: deleteNetworkVcesVcePortGroupsPortGroup
23653       consumes:
23654         - application/json
23655         - application/xml
23656       produces:
23657         - application/json
23658         - application/xml
23659       responses:
23660         "default":
23661           description: Response codes found in [response codes](https://wiki.onap.org/).
23662       parameters:
23663         - name: vnf-id
23664           in: path
23665           description: Unique id of VNF.  This is unique across the graph.
23666           required: true
23667           type: string
23668           example: __VNF-ID__
23669         - name: interface-id
23670           in: path
23671           description: Unique ID of the interface
23672           required: true
23673           type: string
23674           example: __INTERFACE-ID__
23675         - name: resource-version
23676           in: query
23677           description: resource-version for concurrency
23678           required: true
23679           type: string
23680   /network/vces/vce/{vnf-id}/port-groups:
23681     get:
23682       tags:
23683         - Network
23684       summary: returns port-groups
23685       description: returns port-groups
23686       operationId: getNetworkVcesVcePortGroups
23687       produces:
23688         - application/json
23689         - application/xml
23690       responses:
23691         "200":
23692           description: successful operation
23693           schema:
23694               $ref: "#/getDefinitions/port-groups"
23695         "default":
23696           description: Response codes found in [response codes](https://wiki.onap.org/).
23697       parameters:
23698         - name: vnf-id
23699           in: path
23700           description: Unique id of VNF.  This is unique across the graph.
23701           required: true
23702           type: string
23703           example: __VNF-ID__
23704         - name: interface-id
23705           in: query
23706           description:
23707           required: false
23708           type: string
23709         - name: port-group-id
23710           in: query
23711           description:
23712           required: false
23713           type: string
23714         - name: switch-name
23715           in: query
23716           description:
23717           required: false
23718           type: string
23719         - name: heat-stack-id
23720           in: query
23721           description:
23722           required: false
23723           type: string
23724   /network/vces/vce/{vnf-id}/relationship-list/relationship:
23725     put:
23726       tags:
23727         - Network
23728       summary: see node definition for valid relationships
23729       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
23730       consumes:
23731         - application/json
23732         - application/xml
23733       produces:
23734         - application/json
23735         - application/xml
23736       responses:
23737         "default":
23738           description: Response codes found in [response codes](https://wiki.onap.org/).
23739       parameters:
23740         - name: vnf-id
23741           in: path
23742           description: Unique id of VNF.  This is unique across the graph.
23743           required: true
23744           type: string
23745           example: __VNF-ID__
23746         - name: body
23747           in: body
23748           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
23749           required: true
23750           schema:
23751             $ref: "#/definitions/relationship"
23752     delete:
23753       tags:
23754         - Network
23755       summary: delete an existing relationship
23756       description: delete an existing relationship
23757       operationId: deleteNetworkVcesVceRelationshipListRelationship
23758       consumes:
23759         - application/json
23760         - application/xml
23761       produces:
23762         - application/json
23763         - application/xml
23764       responses:
23765         "default":
23766           description: Response codes found in [response codes](https://wiki.onap.org/).
23767       parameters:
23768         - name: vnf-id
23769           in: path
23770           description: Unique id of VNF.  This is unique across the graph.
23771           required: true
23772           type: string
23773           example: __VNF-ID__
23774   /network/vces/vce/{vnf-id}:
23775     get:
23776       tags:
23777         - Network
23778       summary: returns vce
23779       description: returns vce
23780       operationId: getNetworkVcesVce
23781       produces:
23782         - application/json
23783         - application/xml
23784       responses:
23785         "200":
23786           description: successful operation
23787           schema:
23788               $ref: "#/getDefinitions/vce"
23789         "default":
23790           description: Response codes found in [response codes](https://wiki.onap.org/).
23791       parameters:
23792         - name: vnf-id
23793           in: path
23794           description: Unique id of VNF.  This is unique across the graph.
23795           required: true
23796           type: string
23797           example: __VNF-ID__
23798     put:
23799       tags:
23800         - Network
23801       summary: create or update an existing vce
23802       description: |
23803         Create or update an existing vce.
23804         #
23805         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23806       operationId: createOrUpdateNetworkVcesVce
23807       consumes:
23808         - application/json
23809         - application/xml
23810       produces:
23811         - application/json
23812         - application/xml
23813       responses:
23814         "default":
23815           description: Response codes found in [response codes](https://wiki.onap.org/).
23816       parameters:
23817         - name: vnf-id
23818           in: path
23819           description: Unique id of VNF.  This is unique across the graph.
23820           required: true
23821           type: string
23822           example: __VNF-ID__
23823         - name: body
23824           in: body
23825           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
23826           required: true
23827           schema:
23828             $ref: "#/definitions/vce"
23829     patch:
23830       tags:
23831         - Network
23832       summary: update an existing vce
23833       description: |
23834         Update an existing vce
23835         #
23836         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23837         The PUT operation will entirely replace an existing object.
23838         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23839         #
23840         Other differences between PUT and PATCH are:
23841         #
23842         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23843         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23844         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23845       operationId: UpdateNetworkVcesVce
23846       consumes:
23847         - application/json
23848         - application/xml
23849       produces:
23850         - application/json
23851         - application/xml
23852       responses:
23853         "default":
23854           description: Response codes found in [response codes](https://wiki.onap.org/).
23855       parameters:
23856         - name: vnf-id
23857           in: path
23858           description: Unique id of VNF.  This is unique across the graph.
23859           required: true
23860           type: string
23861           example: __VNF-ID__
23862         - name: body
23863           in: body
23864           description: vce object that needs to be updated.
23865           required: true
23866           schema:
23867             $ref: "#/patchDefinitions/vce"
23868     delete:
23869       tags:
23870         - Network
23871       summary: delete an existing vce
23872       description: delete an existing vce
23873       operationId: deleteNetworkVcesVce
23874       consumes:
23875         - application/json
23876         - application/xml
23877       produces:
23878         - application/json
23879         - application/xml
23880       responses:
23881         "default":
23882           description: Response codes found in [response codes](https://wiki.onap.org/).
23883       parameters:
23884         - name: vnf-id
23885           in: path
23886           description: Unique id of VNF.  This is unique across the graph.
23887           required: true
23888           type: string
23889           example: __VNF-ID__
23890         - name: resource-version
23891           in: query
23892           description: resource-version for concurrency
23893           required: true
23894           type: string
23895   /network/vces:
23896     get:
23897       tags:
23898         - Network
23899       summary: returns vces
23900       description: returns vces
23901       operationId: getNetworkVces
23902       produces:
23903         - application/json
23904         - application/xml
23905       responses:
23906         "200":
23907           description: successful operation
23908           schema:
23909               $ref: "#/getDefinitions/vces"
23910         "default":
23911           description: Response codes found in [response codes](https://wiki.onap.org/).
23912       parameters:
23913         - name: vnf-id
23914           in: query
23915           description:
23916           required: false
23917           type: string
23918         - name: vnf-name
23919           in: query
23920           description:
23921           required: false
23922           type: string
23923         - name: vnf-name2
23924           in: query
23925           description:
23926           required: false
23927           type: string
23928         - name: vnf-type
23929           in: query
23930           description:
23931           required: false
23932           type: string
23933         - name: service-id
23934           in: query
23935           description:
23936           required: false
23937           type: string
23938         - name: regional-resource-zone
23939           in: query
23940           description:
23941           required: false
23942           type: string
23943         - name: prov-status
23944           in: query
23945           description:
23946           required: false
23947           type: string
23948         - name: heat-stack-id
23949           in: query
23950           description:
23951           required: false
23952           type: string
23953         - name: vpe-id
23954           in: query
23955           description:
23956           required: false
23957           type: string
23958   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
23959     put:
23960       tags:
23961         - Network
23962       summary: see node definition for valid relationships
23963       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
23964       consumes:
23965         - application/json
23966         - application/xml
23967       produces:
23968         - application/json
23969         - application/xml
23970       responses:
23971         "default":
23972           description: Response codes found in [response codes](https://wiki.onap.org/).
23973       parameters:
23974         - name: vnfc-name
23975           in: path
23976           description: Unique ID of vnfc.
23977           required: true
23978           type: string
23979           example: __VNFC-NAME__
23980         - name: body
23981           in: body
23982           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
23983           required: true
23984           schema:
23985             $ref: "#/definitions/relationship"
23986     delete:
23987       tags:
23988         - Network
23989       summary: delete an existing relationship
23990       description: delete an existing relationship
23991       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
23992       consumes:
23993         - application/json
23994         - application/xml
23995       produces:
23996         - application/json
23997         - application/xml
23998       responses:
23999         "default":
24000           description: Response codes found in [response codes](https://wiki.onap.org/).
24001       parameters:
24002         - name: vnfc-name
24003           in: path
24004           description: Unique ID of vnfc.
24005           required: true
24006           type: string
24007           example: __VNFC-NAME__
24008   /network/vnfcs/vnfc/{vnfc-name}:
24009     get:
24010       tags:
24011         - Network
24012       summary: returns vnfc
24013       description: returns vnfc
24014       operationId: getNetworkVnfcsVnfc
24015       produces:
24016         - application/json
24017         - application/xml
24018       responses:
24019         "200":
24020           description: successful operation
24021           schema:
24022               $ref: "#/getDefinitions/vnfc"
24023         "default":
24024           description: Response codes found in [response codes](https://wiki.onap.org/).
24025       parameters:
24026         - name: vnfc-name
24027           in: path
24028           description: Unique ID of vnfc.
24029           required: true
24030           type: string
24031           example: __VNFC-NAME__
24032     put:
24033       tags:
24034         - Network
24035       summary: create or update an existing vnfc
24036       description: |
24037         Create or update an existing vnfc.
24038         #
24039         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24040       operationId: createOrUpdateNetworkVnfcsVnfc
24041       consumes:
24042         - application/json
24043         - application/xml
24044       produces:
24045         - application/json
24046         - application/xml
24047       responses:
24048         "default":
24049           description: Response codes found in [response codes](https://wiki.onap.org/).
24050       parameters:
24051         - name: vnfc-name
24052           in: path
24053           description: Unique ID of vnfc.
24054           required: true
24055           type: string
24056           example: __VNFC-NAME__
24057         - name: body
24058           in: body
24059           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
24060           required: true
24061           schema:
24062             $ref: "#/definitions/vnfc"
24063     patch:
24064       tags:
24065         - Network
24066       summary: update an existing vnfc
24067       description: |
24068         Update an existing vnfc
24069         #
24070         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24071         The PUT operation will entirely replace an existing object.
24072         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24073         #
24074         Other differences between PUT and PATCH are:
24075         #
24076         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24077         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24078         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24079       operationId: UpdateNetworkVnfcsVnfc
24080       consumes:
24081         - application/json
24082         - application/xml
24083       produces:
24084         - application/json
24085         - application/xml
24086       responses:
24087         "default":
24088           description: Response codes found in [response codes](https://wiki.onap.org/).
24089       parameters:
24090         - name: vnfc-name
24091           in: path
24092           description: Unique ID of vnfc.
24093           required: true
24094           type: string
24095           example: __VNFC-NAME__
24096         - name: body
24097           in: body
24098           description: vnfc object that needs to be updated.
24099           required: true
24100           schema:
24101             $ref: "#/patchDefinitions/vnfc"
24102     delete:
24103       tags:
24104         - Network
24105       summary: delete an existing vnfc
24106       description: delete an existing vnfc
24107       operationId: deleteNetworkVnfcsVnfc
24108       consumes:
24109         - application/json
24110         - application/xml
24111       produces:
24112         - application/json
24113         - application/xml
24114       responses:
24115         "default":
24116           description: Response codes found in [response codes](https://wiki.onap.org/).
24117       parameters:
24118         - name: vnfc-name
24119           in: path
24120           description: Unique ID of vnfc.
24121           required: true
24122           type: string
24123           example: __VNFC-NAME__
24124         - name: resource-version
24125           in: query
24126           description: resource-version for concurrency
24127           required: true
24128           type: string
24129   /network/vnfcs:
24130     get:
24131       tags:
24132         - Network
24133       summary: returns vnfcs
24134       description: returns vnfcs
24135       operationId: getNetworkVnfcs
24136       produces:
24137         - application/json
24138         - application/xml
24139       responses:
24140         "200":
24141           description: successful operation
24142           schema:
24143               $ref: "#/getDefinitions/vnfcs"
24144         "default":
24145           description: Response codes found in [response codes](https://wiki.onap.org/).
24146       parameters:
24147         - name: vnfc-name
24148           in: query
24149           description:
24150           required: false
24151           type: string
24152         - name: vnfc-function-code
24153           in: query
24154           description:
24155           required: false
24156           type: string
24157         - name: vnfc-type
24158           in: query
24159           description:
24160           required: false
24161           type: string
24162         - name: prov-status
24163           in: query
24164           description:
24165           required: false
24166           type: string
24167         - name: ipaddress-v4-oam-vip
24168           in: query
24169           description:
24170           required: false
24171           type: string
24172         - name: in-maint
24173           in: query
24174           description:
24175           required: false
24176           type: boolean
24177         - name: is-closed-loop-disabled
24178           in: query
24179           description:
24180           required: false
24181           type: boolean
24182         - name: group-notation
24183           in: query
24184           description:
24185           required: false
24186           type: string
24187   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
24188     put:
24189       tags:
24190         - Network
24191       summary: see node definition for valid relationships
24192       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
24193       consumes:
24194         - application/json
24195         - application/xml
24196       produces:
24197         - application/json
24198         - application/xml
24199       responses:
24200         "default":
24201           description: Response codes found in [response codes](https://wiki.onap.org/).
24202       parameters:
24203         - name: network-id
24204           in: path
24205           description: Network ID, should be uuid. Unique across A&AI.
24206           required: true
24207           type: string
24208           example: __NETWORK-ID__
24209         - name: subnet-id
24210           in: path
24211           description: Subnet ID, should be UUID.
24212           required: true
24213           type: string
24214           example: __SUBNET-ID__
24215         - name: body
24216           in: body
24217           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
24218           required: true
24219           schema:
24220             $ref: "#/definitions/relationship"
24221     delete:
24222       tags:
24223         - Network
24224       summary: delete an existing relationship
24225       description: delete an existing relationship
24226       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
24227       consumes:
24228         - application/json
24229         - application/xml
24230       produces:
24231         - application/json
24232         - application/xml
24233       responses:
24234         "default":
24235           description: Response codes found in [response codes](https://wiki.onap.org/).
24236       parameters:
24237         - name: network-id
24238           in: path
24239           description: Network ID, should be uuid. Unique across A&AI.
24240           required: true
24241           type: string
24242           example: __NETWORK-ID__
24243         - name: subnet-id
24244           in: path
24245           description: Subnet ID, should be UUID.
24246           required: true
24247           type: string
24248           example: __SUBNET-ID__
24249   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
24250     get:
24251       tags:
24252         - Network
24253       summary: returns subnet
24254       description: returns subnet
24255       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
24256       produces:
24257         - application/json
24258         - application/xml
24259       responses:
24260         "200":
24261           description: successful operation
24262           schema:
24263               $ref: "#/getDefinitions/subnet"
24264         "default":
24265           description: Response codes found in [response codes](https://wiki.onap.org/).
24266       parameters:
24267         - name: network-id
24268           in: path
24269           description: Network ID, should be uuid. Unique across A&AI.
24270           required: true
24271           type: string
24272           example: __NETWORK-ID__
24273         - name: subnet-id
24274           in: path
24275           description: Subnet ID, should be UUID.
24276           required: true
24277           type: string
24278           example: __SUBNET-ID__
24279     put:
24280       tags:
24281         - Network
24282       summary: create or update an existing subnet
24283       description: |
24284         Create or update an existing subnet.
24285         #
24286         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24287       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
24288       consumes:
24289         - application/json
24290         - application/xml
24291       produces:
24292         - application/json
24293         - application/xml
24294       responses:
24295         "default":
24296           description: Response codes found in [response codes](https://wiki.onap.org/).
24297       parameters:
24298         - name: network-id
24299           in: path
24300           description: Network ID, should be uuid. Unique across A&AI.
24301           required: true
24302           type: string
24303           example: __NETWORK-ID__
24304         - name: subnet-id
24305           in: path
24306           description: Subnet ID, should be UUID.
24307           required: true
24308           type: string
24309           example: __SUBNET-ID__
24310         - name: body
24311           in: body
24312           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
24313           required: true
24314           schema:
24315             $ref: "#/definitions/subnet"
24316     patch:
24317       tags:
24318         - Network
24319       summary: update an existing subnet
24320       description: |
24321         Update an existing subnet
24322         #
24323         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24324         The PUT operation will entirely replace an existing object.
24325         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24326         #
24327         Other differences between PUT and PATCH are:
24328         #
24329         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24330         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24331         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24332       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
24333       consumes:
24334         - application/json
24335         - application/xml
24336       produces:
24337         - application/json
24338         - application/xml
24339       responses:
24340         "default":
24341           description: Response codes found in [response codes](https://wiki.onap.org/).
24342       parameters:
24343         - name: network-id
24344           in: path
24345           description: Network ID, should be uuid. Unique across A&AI.
24346           required: true
24347           type: string
24348           example: __NETWORK-ID__
24349         - name: subnet-id
24350           in: path
24351           description: Subnet ID, should be UUID.
24352           required: true
24353           type: string
24354           example: __SUBNET-ID__
24355         - name: body
24356           in: body
24357           description: subnet object that needs to be updated.
24358           required: true
24359           schema:
24360             $ref: "#/patchDefinitions/subnet"
24361     delete:
24362       tags:
24363         - Network
24364       summary: delete an existing subnet
24365       description: delete an existing subnet
24366       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
24367       consumes:
24368         - application/json
24369         - application/xml
24370       produces:
24371         - application/json
24372         - application/xml
24373       responses:
24374         "default":
24375           description: Response codes found in [response codes](https://wiki.onap.org/).
24376       parameters:
24377         - name: network-id
24378           in: path
24379           description: Network ID, should be uuid. Unique across A&AI.
24380           required: true
24381           type: string
24382           example: __NETWORK-ID__
24383         - name: subnet-id
24384           in: path
24385           description: Subnet ID, should be UUID.
24386           required: true
24387           type: string
24388           example: __SUBNET-ID__
24389         - name: resource-version
24390           in: query
24391           description: resource-version for concurrency
24392           required: true
24393           type: string
24394   /network/l3-networks/l3-network/{network-id}/subnets:
24395     get:
24396       tags:
24397         - Network
24398       summary: returns subnets
24399       description: returns subnets
24400       operationId: getNetworkL3NetworksL3NetworkSubnets
24401       produces:
24402         - application/json
24403         - application/xml
24404       responses:
24405         "200":
24406           description: successful operation
24407           schema:
24408               $ref: "#/getDefinitions/subnets"
24409         "default":
24410           description: Response codes found in [response codes](https://wiki.onap.org/).
24411       parameters:
24412         - name: network-id
24413           in: path
24414           description: Network ID, should be uuid. Unique across A&AI.
24415           required: true
24416           type: string
24417           example: __NETWORK-ID__
24418         - name: subnet-id
24419           in: query
24420           description:
24421           required: false
24422           type: string
24423         - name: subnet-name
24424           in: query
24425           description:
24426           required: false
24427           type: string
24428   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
24429     put:
24430       tags:
24431         - Network
24432       summary: see node definition for valid relationships
24433       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
24434       consumes:
24435         - application/json
24436         - application/xml
24437       produces:
24438         - application/json
24439         - application/xml
24440       responses:
24441         "default":
24442           description: Response codes found in [response codes](https://wiki.onap.org/).
24443       parameters:
24444         - name: network-id
24445           in: path
24446           description: Network ID, should be uuid. Unique across A&AI.
24447           required: true
24448           type: string
24449           example: __NETWORK-ID__
24450         - name: vlan-id-inner
24451           in: path
24452           description: id.
24453           required: true
24454           type: integer
24455           format: int64
24456           example: __VLAN-ID-INNER__
24457         - name: body
24458           in: body
24459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
24460           required: true
24461           schema:
24462             $ref: "#/definitions/relationship"
24463     delete:
24464       tags:
24465         - Network
24466       summary: delete an existing relationship
24467       description: delete an existing relationship
24468       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
24469       consumes:
24470         - application/json
24471         - application/xml
24472       produces:
24473         - application/json
24474         - application/xml
24475       responses:
24476         "default":
24477           description: Response codes found in [response codes](https://wiki.onap.org/).
24478       parameters:
24479         - name: network-id
24480           in: path
24481           description: Network ID, should be uuid. Unique across A&AI.
24482           required: true
24483           type: string
24484           example: __NETWORK-ID__
24485         - name: vlan-id-inner
24486           in: path
24487           description: id.
24488           required: true
24489           type: integer
24490           format: int64
24491           example: __VLAN-ID-INNER__
24492   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
24493     get:
24494       tags:
24495         - Network
24496       summary: returns ctag-assignment
24497       description: returns ctag-assignment
24498       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24499       produces:
24500         - application/json
24501         - application/xml
24502       responses:
24503         "200":
24504           description: successful operation
24505           schema:
24506               $ref: "#/getDefinitions/ctag-assignment"
24507         "default":
24508           description: Response codes found in [response codes](https://wiki.onap.org/).
24509       parameters:
24510         - name: network-id
24511           in: path
24512           description: Network ID, should be uuid. Unique across A&AI.
24513           required: true
24514           type: string
24515           example: __NETWORK-ID__
24516         - name: vlan-id-inner
24517           in: path
24518           description: id.
24519           required: true
24520           type: integer
24521           format: int64
24522           example: __VLAN-ID-INNER__
24523     put:
24524       tags:
24525         - Network
24526       summary: create or update an existing ctag-assignment
24527       description: |
24528         Create or update an existing ctag-assignment.
24529         #
24530         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24531       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24532       consumes:
24533         - application/json
24534         - application/xml
24535       produces:
24536         - application/json
24537         - application/xml
24538       responses:
24539         "default":
24540           description: Response codes found in [response codes](https://wiki.onap.org/).
24541       parameters:
24542         - name: network-id
24543           in: path
24544           description: Network ID, should be uuid. Unique across A&AI.
24545           required: true
24546           type: string
24547           example: __NETWORK-ID__
24548         - name: vlan-id-inner
24549           in: path
24550           description: id.
24551           required: true
24552           type: integer
24553           format: int64
24554           example: __VLAN-ID-INNER__
24555         - name: body
24556           in: body
24557           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
24558           required: true
24559           schema:
24560             $ref: "#/definitions/ctag-assignment"
24561     patch:
24562       tags:
24563         - Network
24564       summary: update an existing ctag-assignment
24565       description: |
24566         Update an existing ctag-assignment
24567         #
24568         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24569         The PUT operation will entirely replace an existing object.
24570         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24571         #
24572         Other differences between PUT and PATCH are:
24573         #
24574         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24575         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24576         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24577       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24578       consumes:
24579         - application/json
24580         - application/xml
24581       produces:
24582         - application/json
24583         - application/xml
24584       responses:
24585         "default":
24586           description: Response codes found in [response codes](https://wiki.onap.org/).
24587       parameters:
24588         - name: network-id
24589           in: path
24590           description: Network ID, should be uuid. Unique across A&AI.
24591           required: true
24592           type: string
24593           example: __NETWORK-ID__
24594         - name: vlan-id-inner
24595           in: path
24596           description: id.
24597           required: true
24598           type: integer
24599           format: int64
24600           example: __VLAN-ID-INNER__
24601         - name: body
24602           in: body
24603           description: ctag-assignment object that needs to be updated.
24604           required: true
24605           schema:
24606             $ref: "#/patchDefinitions/ctag-assignment"
24607     delete:
24608       tags:
24609         - Network
24610       summary: delete an existing ctag-assignment
24611       description: delete an existing ctag-assignment
24612       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24613       consumes:
24614         - application/json
24615         - application/xml
24616       produces:
24617         - application/json
24618         - application/xml
24619       responses:
24620         "default":
24621           description: Response codes found in [response codes](https://wiki.onap.org/).
24622       parameters:
24623         - name: network-id
24624           in: path
24625           description: Network ID, should be uuid. Unique across A&AI.
24626           required: true
24627           type: string
24628           example: __NETWORK-ID__
24629         - name: vlan-id-inner
24630           in: path
24631           description: id.
24632           required: true
24633           type: integer
24634           format: int64
24635           example: __VLAN-ID-INNER__
24636         - name: resource-version
24637           in: query
24638           description: resource-version for concurrency
24639           required: true
24640           type: string
24641   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
24642     get:
24643       tags:
24644         - Network
24645       summary: returns ctag-assignments
24646       description: returns ctag-assignments
24647       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
24648       produces:
24649         - application/json
24650         - application/xml
24651       responses:
24652         "200":
24653           description: successful operation
24654           schema:
24655               $ref: "#/getDefinitions/ctag-assignments"
24656         "default":
24657           description: Response codes found in [response codes](https://wiki.onap.org/).
24658       parameters:
24659         - name: network-id
24660           in: path
24661           description: Network ID, should be uuid. Unique across A&AI.
24662           required: true
24663           type: string
24664           example: __NETWORK-ID__
24665         - name: vlan-id-inner
24666           in: query
24667           description:
24668           required: false
24669           type: integer
24670           format: int64
24671   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
24672     put:
24673       tags:
24674         - Network
24675       summary: see node definition for valid relationships
24676       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
24677       consumes:
24678         - application/json
24679         - application/xml
24680       produces:
24681         - application/json
24682         - application/xml
24683       responses:
24684         "default":
24685           description: Response codes found in [response codes](https://wiki.onap.org/).
24686       parameters:
24687         - name: network-id
24688           in: path
24689           description: Network ID, should be uuid. Unique across A&AI.
24690           required: true
24691           type: string
24692           example: __NETWORK-ID__
24693         - name: segmentation-id
24694           in: path
24695           description: Route Table Reference id, UUID assigned to this instance.
24696           required: true
24697           type: string
24698           example: __SEGMENTATION-ID__
24699         - name: body
24700           in: body
24701           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
24702           required: true
24703           schema:
24704             $ref: "#/definitions/relationship"
24705     delete:
24706       tags:
24707         - Network
24708       summary: delete an existing relationship
24709       description: delete an existing relationship
24710       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
24711       consumes:
24712         - application/json
24713         - application/xml
24714       produces:
24715         - application/json
24716         - application/xml
24717       responses:
24718         "default":
24719           description: Response codes found in [response codes](https://wiki.onap.org/).
24720       parameters:
24721         - name: network-id
24722           in: path
24723           description: Network ID, should be uuid. Unique across A&AI.
24724           required: true
24725           type: string
24726           example: __NETWORK-ID__
24727         - name: segmentation-id
24728           in: path
24729           description: Route Table Reference id, UUID assigned to this instance.
24730           required: true
24731           type: string
24732           example: __SEGMENTATION-ID__
24733   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
24734     get:
24735       tags:
24736         - Network
24737       summary: returns segmentation-assignment
24738       description: returns segmentation-assignment
24739       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24740       produces:
24741         - application/json
24742         - application/xml
24743       responses:
24744         "200":
24745           description: successful operation
24746           schema:
24747               $ref: "#/getDefinitions/segmentation-assignment"
24748         "default":
24749           description: Response codes found in [response codes](https://wiki.onap.org/).
24750       parameters:
24751         - name: network-id
24752           in: path
24753           description: Network ID, should be uuid. Unique across A&AI.
24754           required: true
24755           type: string
24756           example: __NETWORK-ID__
24757         - name: segmentation-id
24758           in: path
24759           description: Route Table Reference id, UUID assigned to this instance.
24760           required: true
24761           type: string
24762           example: __SEGMENTATION-ID__
24763     put:
24764       tags:
24765         - Network
24766       summary: create or update an existing segmentation-assignment
24767       description: |
24768         Create or update an existing segmentation-assignment.
24769         #
24770         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24771       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24772       consumes:
24773         - application/json
24774         - application/xml
24775       produces:
24776         - application/json
24777         - application/xml
24778       responses:
24779         "default":
24780           description: Response codes found in [response codes](https://wiki.onap.org/).
24781       parameters:
24782         - name: network-id
24783           in: path
24784           description: Network ID, should be uuid. Unique across A&AI.
24785           required: true
24786           type: string
24787           example: __NETWORK-ID__
24788         - name: segmentation-id
24789           in: path
24790           description: Route Table Reference id, UUID assigned to this instance.
24791           required: true
24792           type: string
24793           example: __SEGMENTATION-ID__
24794         - name: body
24795           in: body
24796           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
24797           required: true
24798           schema:
24799             $ref: "#/definitions/segmentation-assignment"
24800     patch:
24801       tags:
24802         - Network
24803       summary: update an existing segmentation-assignment
24804       description: |
24805         Update an existing segmentation-assignment
24806         #
24807         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24808         The PUT operation will entirely replace an existing object.
24809         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24810         #
24811         Other differences between PUT and PATCH are:
24812         #
24813         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24814         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24815         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24816       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24817       consumes:
24818         - application/json
24819         - application/xml
24820       produces:
24821         - application/json
24822         - application/xml
24823       responses:
24824         "default":
24825           description: Response codes found in [response codes](https://wiki.onap.org/).
24826       parameters:
24827         - name: network-id
24828           in: path
24829           description: Network ID, should be uuid. Unique across A&AI.
24830           required: true
24831           type: string
24832           example: __NETWORK-ID__
24833         - name: segmentation-id
24834           in: path
24835           description: Route Table Reference id, UUID assigned to this instance.
24836           required: true
24837           type: string
24838           example: __SEGMENTATION-ID__
24839         - name: body
24840           in: body
24841           description: segmentation-assignment object that needs to be updated.
24842           required: true
24843           schema:
24844             $ref: "#/patchDefinitions/segmentation-assignment"
24845     delete:
24846       tags:
24847         - Network
24848       summary: delete an existing segmentation-assignment
24849       description: delete an existing segmentation-assignment
24850       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24851       consumes:
24852         - application/json
24853         - application/xml
24854       produces:
24855         - application/json
24856         - application/xml
24857       responses:
24858         "default":
24859           description: Response codes found in [response codes](https://wiki.onap.org/).
24860       parameters:
24861         - name: network-id
24862           in: path
24863           description: Network ID, should be uuid. Unique across A&AI.
24864           required: true
24865           type: string
24866           example: __NETWORK-ID__
24867         - name: segmentation-id
24868           in: path
24869           description: Route Table Reference id, UUID assigned to this instance.
24870           required: true
24871           type: string
24872           example: __SEGMENTATION-ID__
24873         - name: resource-version
24874           in: query
24875           description: resource-version for concurrency
24876           required: true
24877           type: string
24878   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
24879     get:
24880       tags:
24881         - Network
24882       summary: returns segmentation-assignments
24883       description: returns segmentation-assignments
24884       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
24885       produces:
24886         - application/json
24887         - application/xml
24888       responses:
24889         "200":
24890           description: successful operation
24891           schema:
24892               $ref: "#/getDefinitions/segmentation-assignments"
24893         "default":
24894           description: Response codes found in [response codes](https://wiki.onap.org/).
24895       parameters:
24896         - name: network-id
24897           in: path
24898           description: Network ID, should be uuid. Unique across A&AI.
24899           required: true
24900           type: string
24901           example: __NETWORK-ID__
24902         - name: segmentation-id
24903           in: query
24904           description:
24905           required: false
24906           type: string
24907   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
24908     put:
24909       tags:
24910         - Network
24911       summary: see node definition for valid relationships
24912       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
24913       consumes:
24914         - application/json
24915         - application/xml
24916       produces:
24917         - application/json
24918         - application/xml
24919       responses:
24920         "default":
24921           description: Response codes found in [response codes](https://wiki.onap.org/).
24922       parameters:
24923         - name: network-id
24924           in: path
24925           description: Network ID, should be uuid. Unique across A&AI.
24926           required: true
24927           type: string
24928           example: __NETWORK-ID__
24929         - name: body
24930           in: body
24931           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
24932           required: true
24933           schema:
24934             $ref: "#/definitions/relationship"
24935     delete:
24936       tags:
24937         - Network
24938       summary: delete an existing relationship
24939       description: delete an existing relationship
24940       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
24941       consumes:
24942         - application/json
24943         - application/xml
24944       produces:
24945         - application/json
24946         - application/xml
24947       responses:
24948         "default":
24949           description: Response codes found in [response codes](https://wiki.onap.org/).
24950       parameters:
24951         - name: network-id
24952           in: path
24953           description: Network ID, should be uuid. Unique across A&AI.
24954           required: true
24955           type: string
24956           example: __NETWORK-ID__
24957   /network/l3-networks/l3-network/{network-id}:
24958     get:
24959       tags:
24960         - Network
24961       summary: returns l3-network
24962       description: returns l3-network
24963       operationId: getNetworkL3NetworksL3Network
24964       produces:
24965         - application/json
24966         - application/xml
24967       responses:
24968         "200":
24969           description: successful operation
24970           schema:
24971               $ref: "#/getDefinitions/l3-network"
24972         "default":
24973           description: Response codes found in [response codes](https://wiki.onap.org/).
24974       parameters:
24975         - name: network-id
24976           in: path
24977           description: Network ID, should be uuid. Unique across A&AI.
24978           required: true
24979           type: string
24980           example: __NETWORK-ID__
24981     put:
24982       tags:
24983         - Network
24984       summary: create or update an existing l3-network
24985       description: |
24986         Create or update an existing l3-network.
24987         #
24988         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24989       operationId: createOrUpdateNetworkL3NetworksL3Network
24990       consumes:
24991         - application/json
24992         - application/xml
24993       produces:
24994         - application/json
24995         - application/xml
24996       responses:
24997         "default":
24998           description: Response codes found in [response codes](https://wiki.onap.org/).
24999       parameters:
25000         - name: network-id
25001           in: path
25002           description: Network ID, should be uuid. Unique across A&AI.
25003           required: true
25004           type: string
25005           example: __NETWORK-ID__
25006         - name: body
25007           in: body
25008           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
25009           required: true
25010           schema:
25011             $ref: "#/definitions/l3-network"
25012     patch:
25013       tags:
25014         - Network
25015       summary: update an existing l3-network
25016       description: |
25017         Update an existing l3-network
25018         #
25019         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25020         The PUT operation will entirely replace an existing object.
25021         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25022         #
25023         Other differences between PUT and PATCH are:
25024         #
25025         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25026         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25027         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25028       operationId: UpdateNetworkL3NetworksL3Network
25029       consumes:
25030         - application/json
25031         - application/xml
25032       produces:
25033         - application/json
25034         - application/xml
25035       responses:
25036         "default":
25037           description: Response codes found in [response codes](https://wiki.onap.org/).
25038       parameters:
25039         - name: network-id
25040           in: path
25041           description: Network ID, should be uuid. Unique across A&AI.
25042           required: true
25043           type: string
25044           example: __NETWORK-ID__
25045         - name: body
25046           in: body
25047           description: l3-network object that needs to be updated.
25048           required: true
25049           schema:
25050             $ref: "#/patchDefinitions/l3-network"
25051     delete:
25052       tags:
25053         - Network
25054       summary: delete an existing l3-network
25055       description: delete an existing l3-network
25056       operationId: deleteNetworkL3NetworksL3Network
25057       consumes:
25058         - application/json
25059         - application/xml
25060       produces:
25061         - application/json
25062         - application/xml
25063       responses:
25064         "default":
25065           description: Response codes found in [response codes](https://wiki.onap.org/).
25066       parameters:
25067         - name: network-id
25068           in: path
25069           description: Network ID, should be uuid. Unique across A&AI.
25070           required: true
25071           type: string
25072           example: __NETWORK-ID__
25073         - name: resource-version
25074           in: query
25075           description: resource-version for concurrency
25076           required: true
25077           type: string
25078   /network/l3-networks:
25079     get:
25080       tags:
25081         - Network
25082       summary: returns l3-networks
25083       description: returns l3-networks
25084       operationId: getNetworkL3Networks
25085       produces:
25086         - application/json
25087         - application/xml
25088       responses:
25089         "200":
25090           description: successful operation
25091           schema:
25092               $ref: "#/getDefinitions/l3-networks"
25093         "default":
25094           description: Response codes found in [response codes](https://wiki.onap.org/).
25095       parameters:
25096         - name: network-id
25097           in: query
25098           description:
25099           required: false
25100           type: string
25101         - name: network-name
25102           in: query
25103           description:
25104           required: false
25105           type: string
25106         - name: service-id
25107           in: query
25108           description:
25109           required: false
25110           type: string
25111         - name: heat-stack-id
25112           in: query
25113           description:
25114           required: false
25115           type: string
25116         - name: contrail-network-fqdn
25117           in: query
25118           description:
25119           required: false
25120           type: string
25121         - name: persona-model-id
25122           in: query
25123           description:
25124           required: false
25125           type: string
25126         - name: persona-model-version
25127           in: query
25128           description:
25129           required: false
25130           type: string
25131         - name: widget-model-id
25132           in: query
25133           description:
25134           required: false
25135           type: string
25136         - name: widget-model-version
25137           in: query
25138           description:
25139           required: false
25140           type: string
25141   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
25142     put:
25143       tags:
25144         - Network
25145       summary: see node definition for valid relationships
25146       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
25147       consumes:
25148         - application/json
25149         - application/xml
25150       produces:
25151         - application/json
25152         - application/xml
25153       responses:
25154         "default":
25155           description: Response codes found in [response codes](https://wiki.onap.org/).
25156       parameters:
25157         - name: network-policy-id
25158           in: path
25159           description: UUID representing unique key to this instance
25160           required: true
25161           type: string
25162           example: __NETWORK-POLICY-ID__
25163         - name: body
25164           in: body
25165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
25166           required: true
25167           schema:
25168             $ref: "#/definitions/relationship"
25169     delete:
25170       tags:
25171         - Network
25172       summary: delete an existing relationship
25173       description: delete an existing relationship
25174       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
25175       consumes:
25176         - application/json
25177         - application/xml
25178       produces:
25179         - application/json
25180         - application/xml
25181       responses:
25182         "default":
25183           description: Response codes found in [response codes](https://wiki.onap.org/).
25184       parameters:
25185         - name: network-policy-id
25186           in: path
25187           description: UUID representing unique key to this instance
25188           required: true
25189           type: string
25190           example: __NETWORK-POLICY-ID__
25191   /network/network-policies/network-policy/{network-policy-id}:
25192     get:
25193       tags:
25194         - Network
25195       summary: returns network-policy
25196       description: returns network-policy
25197       operationId: getNetworkNetworkPoliciesNetworkPolicy
25198       produces:
25199         - application/json
25200         - application/xml
25201       responses:
25202         "200":
25203           description: successful operation
25204           schema:
25205               $ref: "#/getDefinitions/network-policy"
25206         "default":
25207           description: Response codes found in [response codes](https://wiki.onap.org/).
25208       parameters:
25209         - name: network-policy-id
25210           in: path
25211           description: UUID representing unique key to this instance
25212           required: true
25213           type: string
25214           example: __NETWORK-POLICY-ID__
25215     put:
25216       tags:
25217         - Network
25218       summary: create or update an existing network-policy
25219       description: |
25220         Create or update an existing network-policy.
25221         #
25222         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25223       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
25224       consumes:
25225         - application/json
25226         - application/xml
25227       produces:
25228         - application/json
25229         - application/xml
25230       responses:
25231         "default":
25232           description: Response codes found in [response codes](https://wiki.onap.org/).
25233       parameters:
25234         - name: network-policy-id
25235           in: path
25236           description: UUID representing unique key to this instance
25237           required: true
25238           type: string
25239           example: __NETWORK-POLICY-ID__
25240         - name: body
25241           in: body
25242           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
25243           required: true
25244           schema:
25245             $ref: "#/definitions/network-policy"
25246     patch:
25247       tags:
25248         - Network
25249       summary: update an existing network-policy
25250       description: |
25251         Update an existing network-policy
25252         #
25253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25254         The PUT operation will entirely replace an existing object.
25255         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25256         #
25257         Other differences between PUT and PATCH are:
25258         #
25259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25262       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
25263       consumes:
25264         - application/json
25265         - application/xml
25266       produces:
25267         - application/json
25268         - application/xml
25269       responses:
25270         "default":
25271           description: Response codes found in [response codes](https://wiki.onap.org/).
25272       parameters:
25273         - name: network-policy-id
25274           in: path
25275           description: UUID representing unique key to this instance
25276           required: true
25277           type: string
25278           example: __NETWORK-POLICY-ID__
25279         - name: body
25280           in: body
25281           description: network-policy object that needs to be updated.
25282           required: true
25283           schema:
25284             $ref: "#/patchDefinitions/network-policy"
25285     delete:
25286       tags:
25287         - Network
25288       summary: delete an existing network-policy
25289       description: delete an existing network-policy
25290       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
25291       consumes:
25292         - application/json
25293         - application/xml
25294       produces:
25295         - application/json
25296         - application/xml
25297       responses:
25298         "default":
25299           description: Response codes found in [response codes](https://wiki.onap.org/).
25300       parameters:
25301         - name: network-policy-id
25302           in: path
25303           description: UUID representing unique key to this instance
25304           required: true
25305           type: string
25306           example: __NETWORK-POLICY-ID__
25307         - name: resource-version
25308           in: query
25309           description: resource-version for concurrency
25310           required: true
25311           type: string
25312   /network/network-policies:
25313     get:
25314       tags:
25315         - Network
25316       summary: returns network-policies
25317       description: returns network-policies
25318       operationId: getNetworkNetworkPolicies
25319       produces:
25320         - application/json
25321         - application/xml
25322       responses:
25323         "200":
25324           description: successful operation
25325           schema:
25326               $ref: "#/getDefinitions/network-policies"
25327         "default":
25328           description: Response codes found in [response codes](https://wiki.onap.org/).
25329       parameters:
25330         - name: network-policy-id
25331           in: query
25332           description:
25333           required: false
25334           type: string
25335         - name: network-policy-fqdn
25336           in: query
25337           description:
25338           required: false
25339           type: string
25340   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
25341     put:
25342       tags:
25343         - Network
25344       summary: see node definition for valid relationships
25345       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
25346       consumes:
25347         - application/json
25348         - application/xml
25349       produces:
25350         - application/json
25351         - application/xml
25352       responses:
25353         "default":
25354           description: Response codes found in [response codes](https://wiki.onap.org/).
25355       parameters:
25356         - name: vnf-id
25357           in: path
25358           description: Unique id of VNF.  This is unique across the graph.
25359           required: true
25360           type: string
25361           example: __VNF-ID__
25362         - name: body
25363           in: body
25364           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
25365           required: true
25366           schema:
25367             $ref: "#/definitions/relationship"
25368     delete:
25369       tags:
25370         - Network
25371       summary: delete an existing relationship
25372       description: delete an existing relationship
25373       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
25374       consumes:
25375         - application/json
25376         - application/xml
25377       produces:
25378         - application/json
25379         - application/xml
25380       responses:
25381         "default":
25382           description: Response codes found in [response codes](https://wiki.onap.org/).
25383       parameters:
25384         - name: vnf-id
25385           in: path
25386           description: Unique id of VNF.  This is unique across the graph.
25387           required: true
25388           type: string
25389           example: __VNF-ID__
25390   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
25391     put:
25392       tags:
25393         - Network
25394       summary: see node definition for valid relationships
25395       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25396       consumes:
25397         - application/json
25398         - application/xml
25399       produces:
25400         - application/json
25401         - application/xml
25402       responses:
25403         "default":
25404           description: Response codes found in [response codes](https://wiki.onap.org/).
25405       parameters:
25406         - name: vnf-id
25407           in: path
25408           description: Unique id of VNF.  This is unique across the graph.
25409           required: true
25410           type: string
25411           example: __VNF-ID__
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: vlan-interface
25419           in: path
25420           description: String that identifies the interface
25421           required: true
25422           type: string
25423           example: __VLAN-INTERFACE__
25424         - name: body
25425           in: body
25426           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
25427           required: true
25428           schema:
25429             $ref: "#/definitions/relationship"
25430     delete:
25431       tags:
25432         - Network
25433       summary: delete an existing relationship
25434       description: delete an existing relationship
25435       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25436       consumes:
25437         - application/json
25438         - application/xml
25439       produces:
25440         - application/json
25441         - application/xml
25442       responses:
25443         "default":
25444           description: Response codes found in [response codes](https://wiki.onap.org/).
25445       parameters:
25446         - name: vnf-id
25447           in: path
25448           description: Unique id of VNF.  This is unique across the graph.
25449           required: true
25450           type: string
25451           example: __VNF-ID__
25452         - name: interface-name
25453           in: path
25454           description: Name given to the interface
25455           required: true
25456           type: string
25457           example: __INTERFACE-NAME__
25458         - name: vlan-interface
25459           in: path
25460           description: String that identifies the interface
25461           required: true
25462           type: string
25463           example: __VLAN-INTERFACE__
25464   /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:
25465     put:
25466       tags:
25467         - Network
25468       summary: see node definition for valid relationships
25469       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25470       consumes:
25471         - application/json
25472         - application/xml
25473       produces:
25474         - application/json
25475         - application/xml
25476       responses:
25477         "default":
25478           description: Response codes found in [response codes](https://wiki.onap.org/).
25479       parameters:
25480         - name: vnf-id
25481           in: path
25482           description: Unique id of VNF.  This is unique across the graph.
25483           required: true
25484           type: string
25485           example: __VNF-ID__
25486         - name: interface-name
25487           in: path
25488           description: Name given to the interface
25489           required: true
25490           type: string
25491           example: __INTERFACE-NAME__
25492         - name: vlan-interface
25493           in: path
25494           description: String that identifies the interface
25495           required: true
25496           type: string
25497           example: __VLAN-INTERFACE__
25498         - name: l3-interface-ipv4-address
25499           in: path
25500           description: IP address
25501           required: true
25502           type: string
25503           example: __L3-INTERFACE-IPV4-ADDRESS__
25504         - name: body
25505           in: body
25506           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25507           required: true
25508           schema:
25509             $ref: "#/definitions/relationship"
25510     delete:
25511       tags:
25512         - Network
25513       summary: delete an existing relationship
25514       description: delete an existing relationship
25515       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25516       consumes:
25517         - application/json
25518         - application/xml
25519       produces:
25520         - application/json
25521         - application/xml
25522       responses:
25523         "default":
25524           description: Response codes found in [response codes](https://wiki.onap.org/).
25525       parameters:
25526         - name: vnf-id
25527           in: path
25528           description: Unique id of VNF.  This is unique across the graph.
25529           required: true
25530           type: string
25531           example: __VNF-ID__
25532         - name: interface-name
25533           in: path
25534           description: Name given to the interface
25535           required: true
25536           type: string
25537           example: __INTERFACE-NAME__
25538         - name: vlan-interface
25539           in: path
25540           description: String that identifies the interface
25541           required: true
25542           type: string
25543           example: __VLAN-INTERFACE__
25544         - name: l3-interface-ipv4-address
25545           in: path
25546           description: IP address
25547           required: true
25548           type: string
25549           example: __L3-INTERFACE-IPV4-ADDRESS__
25550   /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}:
25551     get:
25552       tags:
25553         - Network
25554       summary: returns l3-interface-ipv4-address-list
25555       description: returns l3-interface-ipv4-address-list
25556       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25557       produces:
25558         - application/json
25559         - application/xml
25560       responses:
25561         "200":
25562           description: successful operation
25563           schema:
25564               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25565         "default":
25566           description: Response codes found in [response codes](https://wiki.onap.org/).
25567       parameters:
25568         - name: vnf-id
25569           in: path
25570           description: Unique id of VNF.  This is unique across the graph.
25571           required: true
25572           type: string
25573           example: __VNF-ID__
25574         - name: interface-name
25575           in: path
25576           description: Name given to the interface
25577           required: true
25578           type: string
25579           example: __INTERFACE-NAME__
25580         - name: vlan-interface
25581           in: path
25582           description: String that identifies the interface
25583           required: true
25584           type: string
25585           example: __VLAN-INTERFACE__
25586         - name: l3-interface-ipv4-address
25587           in: path
25588           description: IP address
25589           required: true
25590           type: string
25591           example: __L3-INTERFACE-IPV4-ADDRESS__
25592     put:
25593       tags:
25594         - Network
25595       summary: create or update an existing l3-interface-ipv4-address-list
25596       description: |
25597         Create or update an existing l3-interface-ipv4-address-list.
25598         #
25599         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25600       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25601       consumes:
25602         - application/json
25603         - application/xml
25604       produces:
25605         - application/json
25606         - application/xml
25607       responses:
25608         "default":
25609           description: Response codes found in [response codes](https://wiki.onap.org/).
25610       parameters:
25611         - name: vnf-id
25612           in: path
25613           description: Unique id of VNF.  This is unique across the graph.
25614           required: true
25615           type: string
25616           example: __VNF-ID__
25617         - name: interface-name
25618           in: path
25619           description: Name given to the interface
25620           required: true
25621           type: string
25622           example: __INTERFACE-NAME__
25623         - name: vlan-interface
25624           in: path
25625           description: String that identifies the interface
25626           required: true
25627           type: string
25628           example: __VLAN-INTERFACE__
25629         - name: l3-interface-ipv4-address
25630           in: path
25631           description: IP address
25632           required: true
25633           type: string
25634           example: __L3-INTERFACE-IPV4-ADDRESS__
25635         - name: body
25636           in: body
25637           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25638           required: true
25639           schema:
25640             $ref: "#/definitions/l3-interface-ipv4-address-list"
25641     patch:
25642       tags:
25643         - Network
25644       summary: update an existing l3-interface-ipv4-address-list
25645       description: |
25646         Update an existing l3-interface-ipv4-address-list
25647         #
25648         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25649         The PUT operation will entirely replace an existing object.
25650         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25651         #
25652         Other differences between PUT and PATCH are:
25653         #
25654         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25655         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25656         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25657       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25658       consumes:
25659         - application/json
25660         - application/xml
25661       produces:
25662         - application/json
25663         - application/xml
25664       responses:
25665         "default":
25666           description: Response codes found in [response codes](https://wiki.onap.org/).
25667       parameters:
25668         - name: vnf-id
25669           in: path
25670           description: Unique id of VNF.  This is unique across the graph.
25671           required: true
25672           type: string
25673           example: __VNF-ID__
25674         - name: interface-name
25675           in: path
25676           description: Name given to the interface
25677           required: true
25678           type: string
25679           example: __INTERFACE-NAME__
25680         - name: vlan-interface
25681           in: path
25682           description: String that identifies the interface
25683           required: true
25684           type: string
25685           example: __VLAN-INTERFACE__
25686         - name: l3-interface-ipv4-address
25687           in: path
25688           description: IP address
25689           required: true
25690           type: string
25691           example: __L3-INTERFACE-IPV4-ADDRESS__
25692         - name: body
25693           in: body
25694           description: l3-interface-ipv4-address-list object that needs to be updated.
25695           required: true
25696           schema:
25697             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25698     delete:
25699       tags:
25700         - Network
25701       summary: delete an existing l3-interface-ipv4-address-list
25702       description: delete an existing l3-interface-ipv4-address-list
25703       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25704       consumes:
25705         - application/json
25706         - application/xml
25707       produces:
25708         - application/json
25709         - application/xml
25710       responses:
25711         "default":
25712           description: Response codes found in [response codes](https://wiki.onap.org/).
25713       parameters:
25714         - name: vnf-id
25715           in: path
25716           description: Unique id of VNF.  This is unique across the graph.
25717           required: true
25718           type: string
25719           example: __VNF-ID__
25720         - name: interface-name
25721           in: path
25722           description: Name given to the interface
25723           required: true
25724           type: string
25725           example: __INTERFACE-NAME__
25726         - name: vlan-interface
25727           in: path
25728           description: String that identifies the interface
25729           required: true
25730           type: string
25731           example: __VLAN-INTERFACE__
25732         - name: l3-interface-ipv4-address
25733           in: path
25734           description: IP address
25735           required: true
25736           type: string
25737           example: __L3-INTERFACE-IPV4-ADDRESS__
25738         - name: resource-version
25739           in: query
25740           description: resource-version for concurrency
25741           required: true
25742           type: string
25743   /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:
25744     put:
25745       tags:
25746         - Network
25747       summary: see node definition for valid relationships
25748       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25749       consumes:
25750         - application/json
25751         - application/xml
25752       produces:
25753         - application/json
25754         - application/xml
25755       responses:
25756         "default":
25757           description: Response codes found in [response codes](https://wiki.onap.org/).
25758       parameters:
25759         - name: vnf-id
25760           in: path
25761           description: Unique id of VNF.  This is unique across the graph.
25762           required: true
25763           type: string
25764           example: __VNF-ID__
25765         - name: interface-name
25766           in: path
25767           description: Name given to the interface
25768           required: true
25769           type: string
25770           example: __INTERFACE-NAME__
25771         - name: vlan-interface
25772           in: path
25773           description: String that identifies the interface
25774           required: true
25775           type: string
25776           example: __VLAN-INTERFACE__
25777         - name: l3-interface-ipv6-address
25778           in: path
25779           description: IP address
25780           required: true
25781           type: string
25782           example: __L3-INTERFACE-IPV6-ADDRESS__
25783         - name: body
25784           in: body
25785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25786           required: true
25787           schema:
25788             $ref: "#/definitions/relationship"
25789     delete:
25790       tags:
25791         - Network
25792       summary: delete an existing relationship
25793       description: delete an existing relationship
25794       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25795       consumes:
25796         - application/json
25797         - application/xml
25798       produces:
25799         - application/json
25800         - application/xml
25801       responses:
25802         "default":
25803           description: Response codes found in [response codes](https://wiki.onap.org/).
25804       parameters:
25805         - name: vnf-id
25806           in: path
25807           description: Unique id of VNF.  This is unique across the graph.
25808           required: true
25809           type: string
25810           example: __VNF-ID__
25811         - name: interface-name
25812           in: path
25813           description: Name given to the interface
25814           required: true
25815           type: string
25816           example: __INTERFACE-NAME__
25817         - name: vlan-interface
25818           in: path
25819           description: String that identifies the interface
25820           required: true
25821           type: string
25822           example: __VLAN-INTERFACE__
25823         - name: l3-interface-ipv6-address
25824           in: path
25825           description: IP address
25826           required: true
25827           type: string
25828           example: __L3-INTERFACE-IPV6-ADDRESS__
25829   /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}:
25830     get:
25831       tags:
25832         - Network
25833       summary: returns l3-interface-ipv6-address-list
25834       description: returns l3-interface-ipv6-address-list
25835       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25836       produces:
25837         - application/json
25838         - application/xml
25839       responses:
25840         "200":
25841           description: successful operation
25842           schema:
25843               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25844         "default":
25845           description: Response codes found in [response codes](https://wiki.onap.org/).
25846       parameters:
25847         - name: vnf-id
25848           in: path
25849           description: Unique id of VNF.  This is unique across the graph.
25850           required: true
25851           type: string
25852           example: __VNF-ID__
25853         - name: interface-name
25854           in: path
25855           description: Name given to the interface
25856           required: true
25857           type: string
25858           example: __INTERFACE-NAME__
25859         - name: vlan-interface
25860           in: path
25861           description: String that identifies the interface
25862           required: true
25863           type: string
25864           example: __VLAN-INTERFACE__
25865         - name: l3-interface-ipv6-address
25866           in: path
25867           description: IP address
25868           required: true
25869           type: string
25870           example: __L3-INTERFACE-IPV6-ADDRESS__
25871     put:
25872       tags:
25873         - Network
25874       summary: create or update an existing l3-interface-ipv6-address-list
25875       description: |
25876         Create or update an existing l3-interface-ipv6-address-list.
25877         #
25878         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25879       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25880       consumes:
25881         - application/json
25882         - application/xml
25883       produces:
25884         - application/json
25885         - application/xml
25886       responses:
25887         "default":
25888           description: Response codes found in [response codes](https://wiki.onap.org/).
25889       parameters:
25890         - name: vnf-id
25891           in: path
25892           description: Unique id of VNF.  This is unique across the graph.
25893           required: true
25894           type: string
25895           example: __VNF-ID__
25896         - name: interface-name
25897           in: path
25898           description: Name given to the interface
25899           required: true
25900           type: string
25901           example: __INTERFACE-NAME__
25902         - name: vlan-interface
25903           in: path
25904           description: String that identifies the interface
25905           required: true
25906           type: string
25907           example: __VLAN-INTERFACE__
25908         - name: l3-interface-ipv6-address
25909           in: path
25910           description: IP address
25911           required: true
25912           type: string
25913           example: __L3-INTERFACE-IPV6-ADDRESS__
25914         - name: body
25915           in: body
25916           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25917           required: true
25918           schema:
25919             $ref: "#/definitions/l3-interface-ipv6-address-list"
25920     patch:
25921       tags:
25922         - Network
25923       summary: update an existing l3-interface-ipv6-address-list
25924       description: |
25925         Update an existing l3-interface-ipv6-address-list
25926         #
25927         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25928         The PUT operation will entirely replace an existing object.
25929         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25930         #
25931         Other differences between PUT and PATCH are:
25932         #
25933         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25934         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25935         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25936       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25937       consumes:
25938         - application/json
25939         - application/xml
25940       produces:
25941         - application/json
25942         - application/xml
25943       responses:
25944         "default":
25945           description: Response codes found in [response codes](https://wiki.onap.org/).
25946       parameters:
25947         - name: vnf-id
25948           in: path
25949           description: Unique id of VNF.  This is unique across the graph.
25950           required: true
25951           type: string
25952           example: __VNF-ID__
25953         - name: interface-name
25954           in: path
25955           description: Name given to the interface
25956           required: true
25957           type: string
25958           example: __INTERFACE-NAME__
25959         - name: vlan-interface
25960           in: path
25961           description: String that identifies the interface
25962           required: true
25963           type: string
25964           example: __VLAN-INTERFACE__
25965         - name: l3-interface-ipv6-address
25966           in: path
25967           description: IP address
25968           required: true
25969           type: string
25970           example: __L3-INTERFACE-IPV6-ADDRESS__
25971         - name: body
25972           in: body
25973           description: l3-interface-ipv6-address-list object that needs to be updated.
25974           required: true
25975           schema:
25976             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25977     delete:
25978       tags:
25979         - Network
25980       summary: delete an existing l3-interface-ipv6-address-list
25981       description: delete an existing l3-interface-ipv6-address-list
25982       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25983       consumes:
25984         - application/json
25985         - application/xml
25986       produces:
25987         - application/json
25988         - application/xml
25989       responses:
25990         "default":
25991           description: Response codes found in [response codes](https://wiki.onap.org/).
25992       parameters:
25993         - name: vnf-id
25994           in: path
25995           description: Unique id of VNF.  This is unique across the graph.
25996           required: true
25997           type: string
25998           example: __VNF-ID__
25999         - name: interface-name
26000           in: path
26001           description: Name given to the interface
26002           required: true
26003           type: string
26004           example: __INTERFACE-NAME__
26005         - name: vlan-interface
26006           in: path
26007           description: String that identifies the interface
26008           required: true
26009           type: string
26010           example: __VLAN-INTERFACE__
26011         - name: l3-interface-ipv6-address
26012           in: path
26013           description: IP address
26014           required: true
26015           type: string
26016           example: __L3-INTERFACE-IPV6-ADDRESS__
26017         - name: resource-version
26018           in: query
26019           description: resource-version for concurrency
26020           required: true
26021           type: string
26022   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
26023     get:
26024       tags:
26025         - Network
26026       summary: returns vlan
26027       description: returns vlan
26028       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26029       produces:
26030         - application/json
26031         - application/xml
26032       responses:
26033         "200":
26034           description: successful operation
26035           schema:
26036               $ref: "#/getDefinitions/vlan"
26037         "default":
26038           description: Response codes found in [response codes](https://wiki.onap.org/).
26039       parameters:
26040         - name: vnf-id
26041           in: path
26042           description: Unique id of VNF.  This is unique across the graph.
26043           required: true
26044           type: string
26045           example: __VNF-ID__
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: vlan-interface
26053           in: path
26054           description: String that identifies the interface
26055           required: true
26056           type: string
26057           example: __VLAN-INTERFACE__
26058     put:
26059       tags:
26060         - Network
26061       summary: create or update an existing vlan
26062       description: |
26063         Create or update an existing vlan.
26064         #
26065         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26066       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26067       consumes:
26068         - application/json
26069         - application/xml
26070       produces:
26071         - application/json
26072         - application/xml
26073       responses:
26074         "default":
26075           description: Response codes found in [response codes](https://wiki.onap.org/).
26076       parameters:
26077         - name: vnf-id
26078           in: path
26079           description: Unique id of VNF.  This is unique across the graph.
26080           required: true
26081           type: string
26082           example: __VNF-ID__
26083         - name: interface-name
26084           in: path
26085           description: Name given to the interface
26086           required: true
26087           type: string
26088           example: __INTERFACE-NAME__
26089         - name: vlan-interface
26090           in: path
26091           description: String that identifies the interface
26092           required: true
26093           type: string
26094           example: __VLAN-INTERFACE__
26095         - name: body
26096           in: body
26097           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
26098           required: true
26099           schema:
26100             $ref: "#/definitions/vlan"
26101     patch:
26102       tags:
26103         - Network
26104       summary: update an existing vlan
26105       description: |
26106         Update an existing vlan
26107         #
26108         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26109         The PUT operation will entirely replace an existing object.
26110         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26111         #
26112         Other differences between PUT and PATCH are:
26113         #
26114         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26115         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26116         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26117       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26118       consumes:
26119         - application/json
26120         - application/xml
26121       produces:
26122         - application/json
26123         - application/xml
26124       responses:
26125         "default":
26126           description: Response codes found in [response codes](https://wiki.onap.org/).
26127       parameters:
26128         - name: vnf-id
26129           in: path
26130           description: Unique id of VNF.  This is unique across the graph.
26131           required: true
26132           type: string
26133           example: __VNF-ID__
26134         - name: interface-name
26135           in: path
26136           description: Name given to the interface
26137           required: true
26138           type: string
26139           example: __INTERFACE-NAME__
26140         - name: vlan-interface
26141           in: path
26142           description: String that identifies the interface
26143           required: true
26144           type: string
26145           example: __VLAN-INTERFACE__
26146         - name: body
26147           in: body
26148           description: vlan object that needs to be updated.
26149           required: true
26150           schema:
26151             $ref: "#/patchDefinitions/vlan"
26152     delete:
26153       tags:
26154         - Network
26155       summary: delete an existing vlan
26156       description: delete an existing vlan
26157       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26158       consumes:
26159         - application/json
26160         - application/xml
26161       produces:
26162         - application/json
26163         - application/xml
26164       responses:
26165         "default":
26166           description: Response codes found in [response codes](https://wiki.onap.org/).
26167       parameters:
26168         - name: vnf-id
26169           in: path
26170           description: Unique id of VNF.  This is unique across the graph.
26171           required: true
26172           type: string
26173           example: __VNF-ID__
26174         - name: interface-name
26175           in: path
26176           description: Name given to the interface
26177           required: true
26178           type: string
26179           example: __INTERFACE-NAME__
26180         - name: vlan-interface
26181           in: path
26182           description: String that identifies the interface
26183           required: true
26184           type: string
26185           example: __VLAN-INTERFACE__
26186         - name: resource-version
26187           in: query
26188           description: resource-version for concurrency
26189           required: true
26190           type: string
26191   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
26192     get:
26193       tags:
26194         - Network
26195       summary: returns vlans
26196       description: returns vlans
26197       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
26198       produces:
26199         - application/json
26200         - application/xml
26201       responses:
26202         "200":
26203           description: successful operation
26204           schema:
26205               $ref: "#/getDefinitions/vlans"
26206         "default":
26207           description: Response codes found in [response codes](https://wiki.onap.org/).
26208       parameters:
26209         - name: vnf-id
26210           in: path
26211           description: Unique id of VNF.  This is unique across the graph.
26212           required: true
26213           type: string
26214           example: __VNF-ID__
26215         - name: interface-name
26216           in: path
26217           description: Name given to the interface
26218           required: true
26219           type: string
26220           example: __INTERFACE-NAME__
26221         - name: vlan-interface
26222           in: query
26223           description:
26224           required: false
26225           type: string
26226         - name: vlan-id-inner
26227           in: query
26228           description:
26229           required: false
26230           type: integer
26231           format: int64
26232         - name: vpn-id
26233           in: query
26234           description:
26235           required: false
26236           type: string
26237   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
26238     put:
26239       tags:
26240         - Network
26241       summary: see node definition for valid relationships
26242       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26243       consumes:
26244         - application/json
26245         - application/xml
26246       produces:
26247         - application/json
26248         - application/xml
26249       responses:
26250         "default":
26251           description: Response codes found in [response codes](https://wiki.onap.org/).
26252       parameters:
26253         - name: vnf-id
26254           in: path
26255           description: Unique id of VNF.  This is unique across the graph.
26256           required: true
26257           type: string
26258           example: __VNF-ID__
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: pci-id
26266           in: path
26267           description: PCI ID used to identify the sriov-vf
26268           required: true
26269           type: string
26270           example: __PCI-ID__
26271         - name: body
26272           in: body
26273           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
26274           required: true
26275           schema:
26276             $ref: "#/definitions/relationship"
26277     delete:
26278       tags:
26279         - Network
26280       summary: delete an existing relationship
26281       description: delete an existing relationship
26282       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26283       consumes:
26284         - application/json
26285         - application/xml
26286       produces:
26287         - application/json
26288         - application/xml
26289       responses:
26290         "default":
26291           description: Response codes found in [response codes](https://wiki.onap.org/).
26292       parameters:
26293         - name: vnf-id
26294           in: path
26295           description: Unique id of VNF.  This is unique across the graph.
26296           required: true
26297           type: string
26298           example: __VNF-ID__
26299         - name: interface-name
26300           in: path
26301           description: Name given to the interface
26302           required: true
26303           type: string
26304           example: __INTERFACE-NAME__
26305         - name: pci-id
26306           in: path
26307           description: PCI ID used to identify the sriov-vf
26308           required: true
26309           type: string
26310           example: __PCI-ID__
26311   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
26312     get:
26313       tags:
26314         - Network
26315       summary: returns sriov-vf
26316       description: returns sriov-vf
26317       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26318       produces:
26319         - application/json
26320         - application/xml
26321       responses:
26322         "200":
26323           description: successful operation
26324           schema:
26325               $ref: "#/getDefinitions/sriov-vf"
26326         "default":
26327           description: Response codes found in [response codes](https://wiki.onap.org/).
26328       parameters:
26329         - name: vnf-id
26330           in: path
26331           description: Unique id of VNF.  This is unique across the graph.
26332           required: true
26333           type: string
26334           example: __VNF-ID__
26335         - name: interface-name
26336           in: path
26337           description: Name given to the interface
26338           required: true
26339           type: string
26340           example: __INTERFACE-NAME__
26341         - name: pci-id
26342           in: path
26343           description: PCI ID used to identify the sriov-vf
26344           required: true
26345           type: string
26346           example: __PCI-ID__
26347     put:
26348       tags:
26349         - Network
26350       summary: create or update an existing sriov-vf
26351       description: |
26352         Create or update an existing sriov-vf.
26353         #
26354         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26355       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26356       consumes:
26357         - application/json
26358         - application/xml
26359       produces:
26360         - application/json
26361         - application/xml
26362       responses:
26363         "default":
26364           description: Response codes found in [response codes](https://wiki.onap.org/).
26365       parameters:
26366         - name: vnf-id
26367           in: path
26368           description: Unique id of VNF.  This is unique across the graph.
26369           required: true
26370           type: string
26371           example: __VNF-ID__
26372         - name: interface-name
26373           in: path
26374           description: Name given to the interface
26375           required: true
26376           type: string
26377           example: __INTERFACE-NAME__
26378         - name: pci-id
26379           in: path
26380           description: PCI ID used to identify the sriov-vf
26381           required: true
26382           type: string
26383           example: __PCI-ID__
26384         - name: body
26385           in: body
26386           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
26387           required: true
26388           schema:
26389             $ref: "#/definitions/sriov-vf"
26390     patch:
26391       tags:
26392         - Network
26393       summary: update an existing sriov-vf
26394       description: |
26395         Update an existing sriov-vf
26396         #
26397         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26398         The PUT operation will entirely replace an existing object.
26399         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26400         #
26401         Other differences between PUT and PATCH are:
26402         #
26403         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26404         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26405         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26406       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26407       consumes:
26408         - application/json
26409         - application/xml
26410       produces:
26411         - application/json
26412         - application/xml
26413       responses:
26414         "default":
26415           description: Response codes found in [response codes](https://wiki.onap.org/).
26416       parameters:
26417         - name: vnf-id
26418           in: path
26419           description: Unique id of VNF.  This is unique across the graph.
26420           required: true
26421           type: string
26422           example: __VNF-ID__
26423         - name: interface-name
26424           in: path
26425           description: Name given to the interface
26426           required: true
26427           type: string
26428           example: __INTERFACE-NAME__
26429         - name: pci-id
26430           in: path
26431           description: PCI ID used to identify the sriov-vf
26432           required: true
26433           type: string
26434           example: __PCI-ID__
26435         - name: body
26436           in: body
26437           description: sriov-vf object that needs to be updated.
26438           required: true
26439           schema:
26440             $ref: "#/patchDefinitions/sriov-vf"
26441     delete:
26442       tags:
26443         - Network
26444       summary: delete an existing sriov-vf
26445       description: delete an existing sriov-vf
26446       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26447       consumes:
26448         - application/json
26449         - application/xml
26450       produces:
26451         - application/json
26452         - application/xml
26453       responses:
26454         "default":
26455           description: Response codes found in [response codes](https://wiki.onap.org/).
26456       parameters:
26457         - name: vnf-id
26458           in: path
26459           description: Unique id of VNF.  This is unique across the graph.
26460           required: true
26461           type: string
26462           example: __VNF-ID__
26463         - name: interface-name
26464           in: path
26465           description: Name given to the interface
26466           required: true
26467           type: string
26468           example: __INTERFACE-NAME__
26469         - name: pci-id
26470           in: path
26471           description: PCI ID used to identify the sriov-vf
26472           required: true
26473           type: string
26474           example: __PCI-ID__
26475         - name: resource-version
26476           in: query
26477           description: resource-version for concurrency
26478           required: true
26479           type: string
26480   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26481     get:
26482       tags:
26483         - Network
26484       summary: returns sriov-vfs
26485       description: returns sriov-vfs
26486       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
26487       produces:
26488         - application/json
26489         - application/xml
26490       responses:
26491         "200":
26492           description: successful operation
26493           schema:
26494               $ref: "#/getDefinitions/sriov-vfs"
26495         "default":
26496           description: Response codes found in [response codes](https://wiki.onap.org/).
26497       parameters:
26498         - name: vnf-id
26499           in: path
26500           description: Unique id of VNF.  This is unique across the graph.
26501           required: true
26502           type: string
26503           example: __VNF-ID__
26504         - name: interface-name
26505           in: path
26506           description: Name given to the interface
26507           required: true
26508           type: string
26509           example: __INTERFACE-NAME__
26510         - name: pci-id
26511           in: query
26512           description:
26513           required: false
26514           type: string
26515         - name: vf-vlan-filter
26516           in: query
26517           description:
26518           required: false
26519           type: string
26520         - name: vf-mac-filter
26521           in: query
26522           description:
26523           required: false
26524           type: string
26525         - name: vf-vlan-strip
26526           in: query
26527           description:
26528           required: false
26529           type: boolean
26530         - name: neutron-network-id
26531           in: query
26532           description:
26533           required: false
26534           type: string
26535   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26536     put:
26537       tags:
26538         - Network
26539       summary: see node definition for valid relationships
26540       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
26541       consumes:
26542         - application/json
26543         - application/xml
26544       produces:
26545         - application/json
26546         - application/xml
26547       responses:
26548         "default":
26549           description: Response codes found in [response codes](https://wiki.onap.org/).
26550       parameters:
26551         - name: vnf-id
26552           in: path
26553           description: Unique id of VNF.  This is unique across the graph.
26554           required: true
26555           type: string
26556           example: __VNF-ID__
26557         - name: interface-name
26558           in: path
26559           description: Name given to the interface
26560           required: true
26561           type: string
26562           example: __INTERFACE-NAME__
26563         - name: body
26564           in: body
26565           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
26566           required: true
26567           schema:
26568             $ref: "#/definitions/relationship"
26569     delete:
26570       tags:
26571         - Network
26572       summary: delete an existing relationship
26573       description: delete an existing relationship
26574       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
26575       consumes:
26576         - application/json
26577         - application/xml
26578       produces:
26579         - application/json
26580         - application/xml
26581       responses:
26582         "default":
26583           description: Response codes found in [response codes](https://wiki.onap.org/).
26584       parameters:
26585         - name: vnf-id
26586           in: path
26587           description: Unique id of VNF.  This is unique across the graph.
26588           required: true
26589           type: string
26590           example: __VNF-ID__
26591         - name: interface-name
26592           in: path
26593           description: Name given to the interface
26594           required: true
26595           type: string
26596           example: __INTERFACE-NAME__
26597   /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:
26598     put:
26599       tags:
26600         - Network
26601       summary: see node definition for valid relationships
26602       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26603       consumes:
26604         - application/json
26605         - application/xml
26606       produces:
26607         - application/json
26608         - application/xml
26609       responses:
26610         "default":
26611           description: Response codes found in [response codes](https://wiki.onap.org/).
26612       parameters:
26613         - name: vnf-id
26614           in: path
26615           description: Unique id of VNF.  This is unique across the graph.
26616           required: true
26617           type: string
26618           example: __VNF-ID__
26619         - name: interface-name
26620           in: path
26621           description: Name given to the interface
26622           required: true
26623           type: string
26624           example: __INTERFACE-NAME__
26625         - name: l3-interface-ipv4-address
26626           in: path
26627           description: IP address
26628           required: true
26629           type: string
26630           example: __L3-INTERFACE-IPV4-ADDRESS__
26631         - name: body
26632           in: body
26633           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26634           required: true
26635           schema:
26636             $ref: "#/definitions/relationship"
26637     delete:
26638       tags:
26639         - Network
26640       summary: delete an existing relationship
26641       description: delete an existing relationship
26642       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26643       consumes:
26644         - application/json
26645         - application/xml
26646       produces:
26647         - application/json
26648         - application/xml
26649       responses:
26650         "default":
26651           description: Response codes found in [response codes](https://wiki.onap.org/).
26652       parameters:
26653         - name: vnf-id
26654           in: path
26655           description: Unique id of VNF.  This is unique across the graph.
26656           required: true
26657           type: string
26658           example: __VNF-ID__
26659         - name: interface-name
26660           in: path
26661           description: Name given to the interface
26662           required: true
26663           type: string
26664           example: __INTERFACE-NAME__
26665         - name: l3-interface-ipv4-address
26666           in: path
26667           description: IP address
26668           required: true
26669           type: string
26670           example: __L3-INTERFACE-IPV4-ADDRESS__
26671   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
26672     get:
26673       tags:
26674         - Network
26675       summary: returns l3-interface-ipv4-address-list
26676       description: returns l3-interface-ipv4-address-list
26677       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26678       produces:
26679         - application/json
26680         - application/xml
26681       responses:
26682         "200":
26683           description: successful operation
26684           schema:
26685               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26686         "default":
26687           description: Response codes found in [response codes](https://wiki.onap.org/).
26688       parameters:
26689         - name: vnf-id
26690           in: path
26691           description: Unique id of VNF.  This is unique across the graph.
26692           required: true
26693           type: string
26694           example: __VNF-ID__
26695         - name: interface-name
26696           in: path
26697           description: Name given to the interface
26698           required: true
26699           type: string
26700           example: __INTERFACE-NAME__
26701         - name: l3-interface-ipv4-address
26702           in: path
26703           description: IP address
26704           required: true
26705           type: string
26706           example: __L3-INTERFACE-IPV4-ADDRESS__
26707     put:
26708       tags:
26709         - Network
26710       summary: create or update an existing l3-interface-ipv4-address-list
26711       description: |
26712         Create or update an existing l3-interface-ipv4-address-list.
26713         #
26714         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26715       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26716       consumes:
26717         - application/json
26718         - application/xml
26719       produces:
26720         - application/json
26721         - application/xml
26722       responses:
26723         "default":
26724           description: Response codes found in [response codes](https://wiki.onap.org/).
26725       parameters:
26726         - name: vnf-id
26727           in: path
26728           description: Unique id of VNF.  This is unique across the graph.
26729           required: true
26730           type: string
26731           example: __VNF-ID__
26732         - name: interface-name
26733           in: path
26734           description: Name given to the interface
26735           required: true
26736           type: string
26737           example: __INTERFACE-NAME__
26738         - name: l3-interface-ipv4-address
26739           in: path
26740           description: IP address
26741           required: true
26742           type: string
26743           example: __L3-INTERFACE-IPV4-ADDRESS__
26744         - name: body
26745           in: body
26746           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26747           required: true
26748           schema:
26749             $ref: "#/definitions/l3-interface-ipv4-address-list"
26750     patch:
26751       tags:
26752         - Network
26753       summary: update an existing l3-interface-ipv4-address-list
26754       description: |
26755         Update an existing l3-interface-ipv4-address-list
26756         #
26757         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26758         The PUT operation will entirely replace an existing object.
26759         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26760         #
26761         Other differences between PUT and PATCH are:
26762         #
26763         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26764         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26765         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26766       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26767       consumes:
26768         - application/json
26769         - application/xml
26770       produces:
26771         - application/json
26772         - application/xml
26773       responses:
26774         "default":
26775           description: Response codes found in [response codes](https://wiki.onap.org/).
26776       parameters:
26777         - name: vnf-id
26778           in: path
26779           description: Unique id of VNF.  This is unique across the graph.
26780           required: true
26781           type: string
26782           example: __VNF-ID__
26783         - name: interface-name
26784           in: path
26785           description: Name given to the interface
26786           required: true
26787           type: string
26788           example: __INTERFACE-NAME__
26789         - name: l3-interface-ipv4-address
26790           in: path
26791           description: IP address
26792           required: true
26793           type: string
26794           example: __L3-INTERFACE-IPV4-ADDRESS__
26795         - name: body
26796           in: body
26797           description: l3-interface-ipv4-address-list object that needs to be updated.
26798           required: true
26799           schema:
26800             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26801     delete:
26802       tags:
26803         - Network
26804       summary: delete an existing l3-interface-ipv4-address-list
26805       description: delete an existing l3-interface-ipv4-address-list
26806       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26807       consumes:
26808         - application/json
26809         - application/xml
26810       produces:
26811         - application/json
26812         - application/xml
26813       responses:
26814         "default":
26815           description: Response codes found in [response codes](https://wiki.onap.org/).
26816       parameters:
26817         - name: vnf-id
26818           in: path
26819           description: Unique id of VNF.  This is unique across the graph.
26820           required: true
26821           type: string
26822           example: __VNF-ID__
26823         - name: interface-name
26824           in: path
26825           description: Name given to the interface
26826           required: true
26827           type: string
26828           example: __INTERFACE-NAME__
26829         - name: l3-interface-ipv4-address
26830           in: path
26831           description: IP address
26832           required: true
26833           type: string
26834           example: __L3-INTERFACE-IPV4-ADDRESS__
26835         - name: resource-version
26836           in: query
26837           description: resource-version for concurrency
26838           required: true
26839           type: string
26840   /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:
26841     put:
26842       tags:
26843         - Network
26844       summary: see node definition for valid relationships
26845       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26846       consumes:
26847         - application/json
26848         - application/xml
26849       produces:
26850         - application/json
26851         - application/xml
26852       responses:
26853         "default":
26854           description: Response codes found in [response codes](https://wiki.onap.org/).
26855       parameters:
26856         - name: vnf-id
26857           in: path
26858           description: Unique id of VNF.  This is unique across the graph.
26859           required: true
26860           type: string
26861           example: __VNF-ID__
26862         - name: interface-name
26863           in: path
26864           description: Name given to the interface
26865           required: true
26866           type: string
26867           example: __INTERFACE-NAME__
26868         - name: l3-interface-ipv6-address
26869           in: path
26870           description: IP address
26871           required: true
26872           type: string
26873           example: __L3-INTERFACE-IPV6-ADDRESS__
26874         - name: body
26875           in: body
26876           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26877           required: true
26878           schema:
26879             $ref: "#/definitions/relationship"
26880     delete:
26881       tags:
26882         - Network
26883       summary: delete an existing relationship
26884       description: delete an existing relationship
26885       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26886       consumes:
26887         - application/json
26888         - application/xml
26889       produces:
26890         - application/json
26891         - application/xml
26892       responses:
26893         "default":
26894           description: Response codes found in [response codes](https://wiki.onap.org/).
26895       parameters:
26896         - name: vnf-id
26897           in: path
26898           description: Unique id of VNF.  This is unique across the graph.
26899           required: true
26900           type: string
26901           example: __VNF-ID__
26902         - name: interface-name
26903           in: path
26904           description: Name given to the interface
26905           required: true
26906           type: string
26907           example: __INTERFACE-NAME__
26908         - name: l3-interface-ipv6-address
26909           in: path
26910           description: IP address
26911           required: true
26912           type: string
26913           example: __L3-INTERFACE-IPV6-ADDRESS__
26914   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
26915     get:
26916       tags:
26917         - Network
26918       summary: returns l3-interface-ipv6-address-list
26919       description: returns l3-interface-ipv6-address-list
26920       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
26921       produces:
26922         - application/json
26923         - application/xml
26924       responses:
26925         "200":
26926           description: successful operation
26927           schema:
26928               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26929         "default":
26930           description: Response codes found in [response codes](https://wiki.onap.org/).
26931       parameters:
26932         - name: vnf-id
26933           in: path
26934           description: Unique id of VNF.  This is unique across the graph.
26935           required: true
26936           type: string
26937           example: __VNF-ID__
26938         - name: interface-name
26939           in: path
26940           description: Name given to the interface
26941           required: true
26942           type: string
26943           example: __INTERFACE-NAME__
26944         - name: l3-interface-ipv6-address
26945           in: path
26946           description: IP address
26947           required: true
26948           type: string
26949           example: __L3-INTERFACE-IPV6-ADDRESS__
26950     put:
26951       tags:
26952         - Network
26953       summary: create or update an existing l3-interface-ipv6-address-list
26954       description: |
26955         Create or update an existing l3-interface-ipv6-address-list.
26956         #
26957         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26958       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
26959       consumes:
26960         - application/json
26961         - application/xml
26962       produces:
26963         - application/json
26964         - application/xml
26965       responses:
26966         "default":
26967           description: Response codes found in [response codes](https://wiki.onap.org/).
26968       parameters:
26969         - name: vnf-id
26970           in: path
26971           description: Unique id of VNF.  This is unique across the graph.
26972           required: true
26973           type: string
26974           example: __VNF-ID__
26975         - name: interface-name
26976           in: path
26977           description: Name given to the interface
26978           required: true
26979           type: string
26980           example: __INTERFACE-NAME__
26981         - name: l3-interface-ipv6-address
26982           in: path
26983           description: IP address
26984           required: true
26985           type: string
26986           example: __L3-INTERFACE-IPV6-ADDRESS__
26987         - name: body
26988           in: body
26989           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26990           required: true
26991           schema:
26992             $ref: "#/definitions/l3-interface-ipv6-address-list"
26993     patch:
26994       tags:
26995         - Network
26996       summary: update an existing l3-interface-ipv6-address-list
26997       description: |
26998         Update an existing l3-interface-ipv6-address-list
26999         #
27000         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27001         The PUT operation will entirely replace an existing object.
27002         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27003         #
27004         Other differences between PUT and PATCH are:
27005         #
27006         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27007         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27008         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27009       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
27010       consumes:
27011         - application/json
27012         - application/xml
27013       produces:
27014         - application/json
27015         - application/xml
27016       responses:
27017         "default":
27018           description: Response codes found in [response codes](https://wiki.onap.org/).
27019       parameters:
27020         - name: vnf-id
27021           in: path
27022           description: Unique id of VNF.  This is unique across the graph.
27023           required: true
27024           type: string
27025           example: __VNF-ID__
27026         - name: interface-name
27027           in: path
27028           description: Name given to the interface
27029           required: true
27030           type: string
27031           example: __INTERFACE-NAME__
27032         - name: l3-interface-ipv6-address
27033           in: path
27034           description: IP address
27035           required: true
27036           type: string
27037           example: __L3-INTERFACE-IPV6-ADDRESS__
27038         - name: body
27039           in: body
27040           description: l3-interface-ipv6-address-list object that needs to be updated.
27041           required: true
27042           schema:
27043             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27044     delete:
27045       tags:
27046         - Network
27047       summary: delete an existing l3-interface-ipv6-address-list
27048       description: delete an existing l3-interface-ipv6-address-list
27049       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
27050       consumes:
27051         - application/json
27052         - application/xml
27053       produces:
27054         - application/json
27055         - application/xml
27056       responses:
27057         "default":
27058           description: Response codes found in [response codes](https://wiki.onap.org/).
27059       parameters:
27060         - name: vnf-id
27061           in: path
27062           description: Unique id of VNF.  This is unique across the graph.
27063           required: true
27064           type: string
27065           example: __VNF-ID__
27066         - name: interface-name
27067           in: path
27068           description: Name given to the interface
27069           required: true
27070           type: string
27071           example: __INTERFACE-NAME__
27072         - name: l3-interface-ipv6-address
27073           in: path
27074           description: IP address
27075           required: true
27076           type: string
27077           example: __L3-INTERFACE-IPV6-ADDRESS__
27078         - name: resource-version
27079           in: query
27080           description: resource-version for concurrency
27081           required: true
27082           type: string
27083   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
27084     get:
27085       tags:
27086         - Network
27087       summary: returns l-interface
27088       description: returns l-interface
27089       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
27090       produces:
27091         - application/json
27092         - application/xml
27093       responses:
27094         "200":
27095           description: successful operation
27096           schema:
27097               $ref: "#/getDefinitions/l-interface"
27098         "default":
27099           description: Response codes found in [response codes](https://wiki.onap.org/).
27100       parameters:
27101         - name: vnf-id
27102           in: path
27103           description: Unique id of VNF.  This is unique across the graph.
27104           required: true
27105           type: string
27106           example: __VNF-ID__
27107         - name: interface-name
27108           in: path
27109           description: Name given to the interface
27110           required: true
27111           type: string
27112           example: __INTERFACE-NAME__
27113     put:
27114       tags:
27115         - Network
27116       summary: create or update an existing l-interface
27117       description: |
27118         Create or update an existing l-interface.
27119         #
27120         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27121       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
27122       consumes:
27123         - application/json
27124         - application/xml
27125       produces:
27126         - application/json
27127         - application/xml
27128       responses:
27129         "default":
27130           description: Response codes found in [response codes](https://wiki.onap.org/).
27131       parameters:
27132         - name: vnf-id
27133           in: path
27134           description: Unique id of VNF.  This is unique across the graph.
27135           required: true
27136           type: string
27137           example: __VNF-ID__
27138         - name: interface-name
27139           in: path
27140           description: Name given to the interface
27141           required: true
27142           type: string
27143           example: __INTERFACE-NAME__
27144         - name: body
27145           in: body
27146           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
27147           required: true
27148           schema:
27149             $ref: "#/definitions/l-interface"
27150     patch:
27151       tags:
27152         - Network
27153       summary: update an existing l-interface
27154       description: |
27155         Update an existing l-interface
27156         #
27157         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27158         The PUT operation will entirely replace an existing object.
27159         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27160         #
27161         Other differences between PUT and PATCH are:
27162         #
27163         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27164         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27165         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27166       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
27167       consumes:
27168         - application/json
27169         - application/xml
27170       produces:
27171         - application/json
27172         - application/xml
27173       responses:
27174         "default":
27175           description: Response codes found in [response codes](https://wiki.onap.org/).
27176       parameters:
27177         - name: vnf-id
27178           in: path
27179           description: Unique id of VNF.  This is unique across the graph.
27180           required: true
27181           type: string
27182           example: __VNF-ID__
27183         - name: interface-name
27184           in: path
27185           description: Name given to the interface
27186           required: true
27187           type: string
27188           example: __INTERFACE-NAME__
27189         - name: body
27190           in: body
27191           description: l-interface object that needs to be updated.
27192           required: true
27193           schema:
27194             $ref: "#/patchDefinitions/l-interface"
27195     delete:
27196       tags:
27197         - Network
27198       summary: delete an existing l-interface
27199       description: delete an existing l-interface
27200       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
27201       consumes:
27202         - application/json
27203         - application/xml
27204       produces:
27205         - application/json
27206         - application/xml
27207       responses:
27208         "default":
27209           description: Response codes found in [response codes](https://wiki.onap.org/).
27210       parameters:
27211         - name: vnf-id
27212           in: path
27213           description: Unique id of VNF.  This is unique across the graph.
27214           required: true
27215           type: string
27216           example: __VNF-ID__
27217         - name: interface-name
27218           in: path
27219           description: Name given to the interface
27220           required: true
27221           type: string
27222           example: __INTERFACE-NAME__
27223         - name: resource-version
27224           in: query
27225           description: resource-version for concurrency
27226           required: true
27227           type: string
27228   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
27229     get:
27230       tags:
27231         - Network
27232       summary: returns l-interfaces
27233       description: returns l-interfaces
27234       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
27235       produces:
27236         - application/json
27237         - application/xml
27238       responses:
27239         "200":
27240           description: successful operation
27241           schema:
27242               $ref: "#/getDefinitions/l-interfaces"
27243         "default":
27244           description: Response codes found in [response codes](https://wiki.onap.org/).
27245       parameters:
27246         - name: vnf-id
27247           in: path
27248           description: Unique id of VNF.  This is unique across the graph.
27249           required: true
27250           type: string
27251           example: __VNF-ID__
27252         - name: interface-name
27253           in: query
27254           description:
27255           required: false
27256           type: string
27257         - name: interface-id
27258           in: query
27259           description:
27260           required: false
27261           type: string
27262         - name: macaddr
27263           in: query
27264           description:
27265           required: false
27266           type: string
27267         - name: network-name
27268           in: query
27269           description:
27270           required: false
27271           type: string
27272   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
27273     put:
27274       tags:
27275         - Network
27276       summary: see node definition for valid relationships
27277       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
27278       consumes:
27279         - application/json
27280         - application/xml
27281       produces:
27282         - application/json
27283         - application/xml
27284       responses:
27285         "default":
27286           description: Response codes found in [response codes](https://wiki.onap.org/).
27287       parameters:
27288         - name: vnf-id
27289           in: path
27290           description: Unique id of VNF.  This is unique across the graph.
27291           required: true
27292           type: string
27293           example: __VNF-ID__
27294         - name: interface-name
27295           in: path
27296           description: Name that identifies the link aggregate interface
27297           required: true
27298           type: string
27299           example: __INTERFACE-NAME__
27300         - name: body
27301           in: body
27302           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
27303           required: true
27304           schema:
27305             $ref: "#/definitions/relationship"
27306     delete:
27307       tags:
27308         - Network
27309       summary: delete an existing relationship
27310       description: delete an existing relationship
27311       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
27312       consumes:
27313         - application/json
27314         - application/xml
27315       produces:
27316         - application/json
27317         - application/xml
27318       responses:
27319         "default":
27320           description: Response codes found in [response codes](https://wiki.onap.org/).
27321       parameters:
27322         - name: vnf-id
27323           in: path
27324           description: Unique id of VNF.  This is unique across the graph.
27325           required: true
27326           type: string
27327           example: __VNF-ID__
27328         - name: interface-name
27329           in: path
27330           description: Name that identifies the link aggregate interface
27331           required: true
27332           type: string
27333           example: __INTERFACE-NAME__
27334   /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:
27335     put:
27336       tags:
27337         - Network
27338       summary: see node definition for valid relationships
27339       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27340       consumes:
27341         - application/json
27342         - application/xml
27343       produces:
27344         - application/json
27345         - application/xml
27346       responses:
27347         "default":
27348           description: Response codes found in [response codes](https://wiki.onap.org/).
27349       parameters:
27350         - name: vnf-id
27351           in: path
27352           description: Unique id of VNF.  This is unique across the graph.
27353           required: true
27354           type: string
27355           example: __VNF-ID__
27356         - name: interface-name
27357           in: path
27358           description: Name that identifies the link aggregate interface
27359           required: true
27360           type: string
27361           example: __INTERFACE-NAME__
27362         - name: interface-name
27363           in: path
27364           description: Name given to the interface
27365           required: true
27366           type: string
27367           example: __INTERFACE-NAME__
27368         - name: vlan-interface
27369           in: path
27370           description: String that identifies the interface
27371           required: true
27372           type: string
27373           example: __VLAN-INTERFACE__
27374         - name: body
27375           in: body
27376           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27377           required: true
27378           schema:
27379             $ref: "#/definitions/relationship"
27380     delete:
27381       tags:
27382         - Network
27383       summary: delete an existing relationship
27384       description: delete an existing relationship
27385       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27386       consumes:
27387         - application/json
27388         - application/xml
27389       produces:
27390         - application/json
27391         - application/xml
27392       responses:
27393         "default":
27394           description: Response codes found in [response codes](https://wiki.onap.org/).
27395       parameters:
27396         - name: vnf-id
27397           in: path
27398           description: Unique id of VNF.  This is unique across the graph.
27399           required: true
27400           type: string
27401           example: __VNF-ID__
27402         - name: interface-name
27403           in: path
27404           description: Name that identifies the link aggregate interface
27405           required: true
27406           type: string
27407           example: __INTERFACE-NAME__
27408         - name: interface-name
27409           in: path
27410           description: Name given to the interface
27411           required: true
27412           type: string
27413           example: __INTERFACE-NAME__
27414         - name: vlan-interface
27415           in: path
27416           description: String that identifies the interface
27417           required: true
27418           type: string
27419           example: __VLAN-INTERFACE__
27420   /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:
27421     put:
27422       tags:
27423         - Network
27424       summary: see node definition for valid relationships
27425       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27426       consumes:
27427         - application/json
27428         - application/xml
27429       produces:
27430         - application/json
27431         - application/xml
27432       responses:
27433         "default":
27434           description: Response codes found in [response codes](https://wiki.onap.org/).
27435       parameters:
27436         - name: vnf-id
27437           in: path
27438           description: Unique id of VNF.  This is unique across the graph.
27439           required: true
27440           type: string
27441           example: __VNF-ID__
27442         - name: interface-name
27443           in: path
27444           description: Name that identifies the link aggregate interface
27445           required: true
27446           type: string
27447           example: __INTERFACE-NAME__
27448         - name: interface-name
27449           in: path
27450           description: Name given to the interface
27451           required: true
27452           type: string
27453           example: __INTERFACE-NAME__
27454         - name: vlan-interface
27455           in: path
27456           description: String that identifies the interface
27457           required: true
27458           type: string
27459           example: __VLAN-INTERFACE__
27460         - name: l3-interface-ipv4-address
27461           in: path
27462           description: IP address
27463           required: true
27464           type: string
27465           example: __L3-INTERFACE-IPV4-ADDRESS__
27466         - name: body
27467           in: body
27468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27469           required: true
27470           schema:
27471             $ref: "#/definitions/relationship"
27472     delete:
27473       tags:
27474         - Network
27475       summary: delete an existing relationship
27476       description: delete an existing relationship
27477       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27478       consumes:
27479         - application/json
27480         - application/xml
27481       produces:
27482         - application/json
27483         - application/xml
27484       responses:
27485         "default":
27486           description: Response codes found in [response codes](https://wiki.onap.org/).
27487       parameters:
27488         - name: vnf-id
27489           in: path
27490           description: Unique id of VNF.  This is unique across the graph.
27491           required: true
27492           type: string
27493           example: __VNF-ID__
27494         - name: interface-name
27495           in: path
27496           description: Name that identifies the link aggregate interface
27497           required: true
27498           type: string
27499           example: __INTERFACE-NAME__
27500         - name: interface-name
27501           in: path
27502           description: Name given to the interface
27503           required: true
27504           type: string
27505           example: __INTERFACE-NAME__
27506         - name: vlan-interface
27507           in: path
27508           description: String that identifies the interface
27509           required: true
27510           type: string
27511           example: __VLAN-INTERFACE__
27512         - name: l3-interface-ipv4-address
27513           in: path
27514           description: IP address
27515           required: true
27516           type: string
27517           example: __L3-INTERFACE-IPV4-ADDRESS__
27518   /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}:
27519     get:
27520       tags:
27521         - Network
27522       summary: returns l3-interface-ipv4-address-list
27523       description: returns l3-interface-ipv4-address-list
27524       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27525       produces:
27526         - application/json
27527         - application/xml
27528       responses:
27529         "200":
27530           description: successful operation
27531           schema:
27532               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27533         "default":
27534           description: Response codes found in [response codes](https://wiki.onap.org/).
27535       parameters:
27536         - name: vnf-id
27537           in: path
27538           description: Unique id of VNF.  This is unique across the graph.
27539           required: true
27540           type: string
27541           example: __VNF-ID__
27542         - name: interface-name
27543           in: path
27544           description: Name that identifies the link aggregate interface
27545           required: true
27546           type: string
27547           example: __INTERFACE-NAME__
27548         - name: interface-name
27549           in: path
27550           description: Name given to the interface
27551           required: true
27552           type: string
27553           example: __INTERFACE-NAME__
27554         - name: vlan-interface
27555           in: path
27556           description: String that identifies the interface
27557           required: true
27558           type: string
27559           example: __VLAN-INTERFACE__
27560         - name: l3-interface-ipv4-address
27561           in: path
27562           description: IP address
27563           required: true
27564           type: string
27565           example: __L3-INTERFACE-IPV4-ADDRESS__
27566     put:
27567       tags:
27568         - Network
27569       summary: create or update an existing l3-interface-ipv4-address-list
27570       description: |
27571         Create or update an existing l3-interface-ipv4-address-list.
27572         #
27573         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27574       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27575       consumes:
27576         - application/json
27577         - application/xml
27578       produces:
27579         - application/json
27580         - application/xml
27581       responses:
27582         "default":
27583           description: Response codes found in [response codes](https://wiki.onap.org/).
27584       parameters:
27585         - name: vnf-id
27586           in: path
27587           description: Unique id of VNF.  This is unique across the graph.
27588           required: true
27589           type: string
27590           example: __VNF-ID__
27591         - name: interface-name
27592           in: path
27593           description: Name that identifies the link aggregate interface
27594           required: true
27595           type: string
27596           example: __INTERFACE-NAME__
27597         - name: interface-name
27598           in: path
27599           description: Name given to the interface
27600           required: true
27601           type: string
27602           example: __INTERFACE-NAME__
27603         - name: vlan-interface
27604           in: path
27605           description: String that identifies the interface
27606           required: true
27607           type: string
27608           example: __VLAN-INTERFACE__
27609         - name: l3-interface-ipv4-address
27610           in: path
27611           description: IP address
27612           required: true
27613           type: string
27614           example: __L3-INTERFACE-IPV4-ADDRESS__
27615         - name: body
27616           in: body
27617           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27618           required: true
27619           schema:
27620             $ref: "#/definitions/l3-interface-ipv4-address-list"
27621     patch:
27622       tags:
27623         - Network
27624       summary: update an existing l3-interface-ipv4-address-list
27625       description: |
27626         Update an existing l3-interface-ipv4-address-list
27627         #
27628         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27629         The PUT operation will entirely replace an existing object.
27630         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27631         #
27632         Other differences between PUT and PATCH are:
27633         #
27634         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27635         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27636         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27637       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27638       consumes:
27639         - application/json
27640         - application/xml
27641       produces:
27642         - application/json
27643         - application/xml
27644       responses:
27645         "default":
27646           description: Response codes found in [response codes](https://wiki.onap.org/).
27647       parameters:
27648         - name: vnf-id
27649           in: path
27650           description: Unique id of VNF.  This is unique across the graph.
27651           required: true
27652           type: string
27653           example: __VNF-ID__
27654         - name: interface-name
27655           in: path
27656           description: Name that identifies the link aggregate interface
27657           required: true
27658           type: string
27659           example: __INTERFACE-NAME__
27660         - name: interface-name
27661           in: path
27662           description: Name given to the interface
27663           required: true
27664           type: string
27665           example: __INTERFACE-NAME__
27666         - name: vlan-interface
27667           in: path
27668           description: String that identifies the interface
27669           required: true
27670           type: string
27671           example: __VLAN-INTERFACE__
27672         - name: l3-interface-ipv4-address
27673           in: path
27674           description: IP address
27675           required: true
27676           type: string
27677           example: __L3-INTERFACE-IPV4-ADDRESS__
27678         - name: body
27679           in: body
27680           description: l3-interface-ipv4-address-list object that needs to be updated.
27681           required: true
27682           schema:
27683             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27684     delete:
27685       tags:
27686         - Network
27687       summary: delete an existing l3-interface-ipv4-address-list
27688       description: delete an existing l3-interface-ipv4-address-list
27689       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27690       consumes:
27691         - application/json
27692         - application/xml
27693       produces:
27694         - application/json
27695         - application/xml
27696       responses:
27697         "default":
27698           description: Response codes found in [response codes](https://wiki.onap.org/).
27699       parameters:
27700         - name: vnf-id
27701           in: path
27702           description: Unique id of VNF.  This is unique across the graph.
27703           required: true
27704           type: string
27705           example: __VNF-ID__
27706         - name: interface-name
27707           in: path
27708           description: Name that identifies the link aggregate interface
27709           required: true
27710           type: string
27711           example: __INTERFACE-NAME__
27712         - name: interface-name
27713           in: path
27714           description: Name given to the interface
27715           required: true
27716           type: string
27717           example: __INTERFACE-NAME__
27718         - name: vlan-interface
27719           in: path
27720           description: String that identifies the interface
27721           required: true
27722           type: string
27723           example: __VLAN-INTERFACE__
27724         - name: l3-interface-ipv4-address
27725           in: path
27726           description: IP address
27727           required: true
27728           type: string
27729           example: __L3-INTERFACE-IPV4-ADDRESS__
27730         - name: resource-version
27731           in: query
27732           description: resource-version for concurrency
27733           required: true
27734           type: string
27735   /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:
27736     put:
27737       tags:
27738         - Network
27739       summary: see node definition for valid relationships
27740       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27741       consumes:
27742         - application/json
27743         - application/xml
27744       produces:
27745         - application/json
27746         - application/xml
27747       responses:
27748         "default":
27749           description: Response codes found in [response codes](https://wiki.onap.org/).
27750       parameters:
27751         - name: vnf-id
27752           in: path
27753           description: Unique id of VNF.  This is unique across the graph.
27754           required: true
27755           type: string
27756           example: __VNF-ID__
27757         - name: interface-name
27758           in: path
27759           description: Name that identifies the link aggregate interface
27760           required: true
27761           type: string
27762           example: __INTERFACE-NAME__
27763         - name: interface-name
27764           in: path
27765           description: Name given to the interface
27766           required: true
27767           type: string
27768           example: __INTERFACE-NAME__
27769         - name: vlan-interface
27770           in: path
27771           description: String that identifies the interface
27772           required: true
27773           type: string
27774           example: __VLAN-INTERFACE__
27775         - name: l3-interface-ipv6-address
27776           in: path
27777           description: IP address
27778           required: true
27779           type: string
27780           example: __L3-INTERFACE-IPV6-ADDRESS__
27781         - name: body
27782           in: body
27783           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27784           required: true
27785           schema:
27786             $ref: "#/definitions/relationship"
27787     delete:
27788       tags:
27789         - Network
27790       summary: delete an existing relationship
27791       description: delete an existing relationship
27792       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27793       consumes:
27794         - application/json
27795         - application/xml
27796       produces:
27797         - application/json
27798         - application/xml
27799       responses:
27800         "default":
27801           description: Response codes found in [response codes](https://wiki.onap.org/).
27802       parameters:
27803         - name: vnf-id
27804           in: path
27805           description: Unique id of VNF.  This is unique across the graph.
27806           required: true
27807           type: string
27808           example: __VNF-ID__
27809         - name: interface-name
27810           in: path
27811           description: Name that identifies the link aggregate interface
27812           required: true
27813           type: string
27814           example: __INTERFACE-NAME__
27815         - name: interface-name
27816           in: path
27817           description: Name given to the interface
27818           required: true
27819           type: string
27820           example: __INTERFACE-NAME__
27821         - name: vlan-interface
27822           in: path
27823           description: String that identifies the interface
27824           required: true
27825           type: string
27826           example: __VLAN-INTERFACE__
27827         - name: l3-interface-ipv6-address
27828           in: path
27829           description: IP address
27830           required: true
27831           type: string
27832           example: __L3-INTERFACE-IPV6-ADDRESS__
27833   /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}:
27834     get:
27835       tags:
27836         - Network
27837       summary: returns l3-interface-ipv6-address-list
27838       description: returns l3-interface-ipv6-address-list
27839       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27840       produces:
27841         - application/json
27842         - application/xml
27843       responses:
27844         "200":
27845           description: successful operation
27846           schema:
27847               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27848         "default":
27849           description: Response codes found in [response codes](https://wiki.onap.org/).
27850       parameters:
27851         - name: vnf-id
27852           in: path
27853           description: Unique id of VNF.  This is unique across the graph.
27854           required: true
27855           type: string
27856           example: __VNF-ID__
27857         - name: interface-name
27858           in: path
27859           description: Name that identifies the link aggregate interface
27860           required: true
27861           type: string
27862           example: __INTERFACE-NAME__
27863         - name: interface-name
27864           in: path
27865           description: Name given to the interface
27866           required: true
27867           type: string
27868           example: __INTERFACE-NAME__
27869         - name: vlan-interface
27870           in: path
27871           description: String that identifies the interface
27872           required: true
27873           type: string
27874           example: __VLAN-INTERFACE__
27875         - name: l3-interface-ipv6-address
27876           in: path
27877           description: IP address
27878           required: true
27879           type: string
27880           example: __L3-INTERFACE-IPV6-ADDRESS__
27881     put:
27882       tags:
27883         - Network
27884       summary: create or update an existing l3-interface-ipv6-address-list
27885       description: |
27886         Create or update an existing l3-interface-ipv6-address-list.
27887         #
27888         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27889       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27890       consumes:
27891         - application/json
27892         - application/xml
27893       produces:
27894         - application/json
27895         - application/xml
27896       responses:
27897         "default":
27898           description: Response codes found in [response codes](https://wiki.onap.org/).
27899       parameters:
27900         - name: vnf-id
27901           in: path
27902           description: Unique id of VNF.  This is unique across the graph.
27903           required: true
27904           type: string
27905           example: __VNF-ID__
27906         - name: interface-name
27907           in: path
27908           description: Name that identifies the link aggregate interface
27909           required: true
27910           type: string
27911           example: __INTERFACE-NAME__
27912         - name: interface-name
27913           in: path
27914           description: Name given to the interface
27915           required: true
27916           type: string
27917           example: __INTERFACE-NAME__
27918         - name: vlan-interface
27919           in: path
27920           description: String that identifies the interface
27921           required: true
27922           type: string
27923           example: __VLAN-INTERFACE__
27924         - name: l3-interface-ipv6-address
27925           in: path
27926           description: IP address
27927           required: true
27928           type: string
27929           example: __L3-INTERFACE-IPV6-ADDRESS__
27930         - name: body
27931           in: body
27932           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27933           required: true
27934           schema:
27935             $ref: "#/definitions/l3-interface-ipv6-address-list"
27936     patch:
27937       tags:
27938         - Network
27939       summary: update an existing l3-interface-ipv6-address-list
27940       description: |
27941         Update an existing l3-interface-ipv6-address-list
27942         #
27943         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27944         The PUT operation will entirely replace an existing object.
27945         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27946         #
27947         Other differences between PUT and PATCH are:
27948         #
27949         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27950         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27951         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27952       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27953       consumes:
27954         - application/json
27955         - application/xml
27956       produces:
27957         - application/json
27958         - application/xml
27959       responses:
27960         "default":
27961           description: Response codes found in [response codes](https://wiki.onap.org/).
27962       parameters:
27963         - name: vnf-id
27964           in: path
27965           description: Unique id of VNF.  This is unique across the graph.
27966           required: true
27967           type: string
27968           example: __VNF-ID__
27969         - name: interface-name
27970           in: path
27971           description: Name that identifies the link aggregate interface
27972           required: true
27973           type: string
27974           example: __INTERFACE-NAME__
27975         - name: interface-name
27976           in: path
27977           description: Name given to the interface
27978           required: true
27979           type: string
27980           example: __INTERFACE-NAME__
27981         - name: vlan-interface
27982           in: path
27983           description: String that identifies the interface
27984           required: true
27985           type: string
27986           example: __VLAN-INTERFACE__
27987         - name: l3-interface-ipv6-address
27988           in: path
27989           description: IP address
27990           required: true
27991           type: string
27992           example: __L3-INTERFACE-IPV6-ADDRESS__
27993         - name: body
27994           in: body
27995           description: l3-interface-ipv6-address-list object that needs to be updated.
27996           required: true
27997           schema:
27998             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27999     delete:
28000       tags:
28001         - Network
28002       summary: delete an existing l3-interface-ipv6-address-list
28003       description: delete an existing l3-interface-ipv6-address-list
28004       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28005       consumes:
28006         - application/json
28007         - application/xml
28008       produces:
28009         - application/json
28010         - application/xml
28011       responses:
28012         "default":
28013           description: Response codes found in [response codes](https://wiki.onap.org/).
28014       parameters:
28015         - name: vnf-id
28016           in: path
28017           description: Unique id of VNF.  This is unique across the graph.
28018           required: true
28019           type: string
28020           example: __VNF-ID__
28021         - name: interface-name
28022           in: path
28023           description: Name that identifies the link aggregate interface
28024           required: true
28025           type: string
28026           example: __INTERFACE-NAME__
28027         - name: interface-name
28028           in: path
28029           description: Name given to the interface
28030           required: true
28031           type: string
28032           example: __INTERFACE-NAME__
28033         - name: vlan-interface
28034           in: path
28035           description: String that identifies the interface
28036           required: true
28037           type: string
28038           example: __VLAN-INTERFACE__
28039         - name: l3-interface-ipv6-address
28040           in: path
28041           description: IP address
28042           required: true
28043           type: string
28044           example: __L3-INTERFACE-IPV6-ADDRESS__
28045         - name: resource-version
28046           in: query
28047           description: resource-version for concurrency
28048           required: true
28049           type: string
28050   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28051     get:
28052       tags:
28053         - Network
28054       summary: returns vlan
28055       description: returns vlan
28056       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28057       produces:
28058         - application/json
28059         - application/xml
28060       responses:
28061         "200":
28062           description: successful operation
28063           schema:
28064               $ref: "#/getDefinitions/vlan"
28065         "default":
28066           description: Response codes found in [response codes](https://wiki.onap.org/).
28067       parameters:
28068         - name: vnf-id
28069           in: path
28070           description: Unique id of VNF.  This is unique across the graph.
28071           required: true
28072           type: string
28073           example: __VNF-ID__
28074         - name: interface-name
28075           in: path
28076           description: Name that identifies the link aggregate interface
28077           required: true
28078           type: string
28079           example: __INTERFACE-NAME__
28080         - name: interface-name
28081           in: path
28082           description: Name given to the interface
28083           required: true
28084           type: string
28085           example: __INTERFACE-NAME__
28086         - name: vlan-interface
28087           in: path
28088           description: String that identifies the interface
28089           required: true
28090           type: string
28091           example: __VLAN-INTERFACE__
28092     put:
28093       tags:
28094         - Network
28095       summary: create or update an existing vlan
28096       description: |
28097         Create or update an existing vlan.
28098         #
28099         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28100       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28101       consumes:
28102         - application/json
28103         - application/xml
28104       produces:
28105         - application/json
28106         - application/xml
28107       responses:
28108         "default":
28109           description: Response codes found in [response codes](https://wiki.onap.org/).
28110       parameters:
28111         - name: vnf-id
28112           in: path
28113           description: Unique id of VNF.  This is unique across the graph.
28114           required: true
28115           type: string
28116           example: __VNF-ID__
28117         - name: interface-name
28118           in: path
28119           description: Name that identifies the link aggregate interface
28120           required: true
28121           type: string
28122           example: __INTERFACE-NAME__
28123         - name: interface-name
28124           in: path
28125           description: Name given to the interface
28126           required: true
28127           type: string
28128           example: __INTERFACE-NAME__
28129         - name: vlan-interface
28130           in: path
28131           description: String that identifies the interface
28132           required: true
28133           type: string
28134           example: __VLAN-INTERFACE__
28135         - name: body
28136           in: body
28137           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
28138           required: true
28139           schema:
28140             $ref: "#/definitions/vlan"
28141     patch:
28142       tags:
28143         - Network
28144       summary: update an existing vlan
28145       description: |
28146         Update an existing vlan
28147         #
28148         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28149         The PUT operation will entirely replace an existing object.
28150         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28151         #
28152         Other differences between PUT and PATCH are:
28153         #
28154         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28155         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28156         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28157       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28158       consumes:
28159         - application/json
28160         - application/xml
28161       produces:
28162         - application/json
28163         - application/xml
28164       responses:
28165         "default":
28166           description: Response codes found in [response codes](https://wiki.onap.org/).
28167       parameters:
28168         - name: vnf-id
28169           in: path
28170           description: Unique id of VNF.  This is unique across the graph.
28171           required: true
28172           type: string
28173           example: __VNF-ID__
28174         - name: interface-name
28175           in: path
28176           description: Name that identifies the link aggregate interface
28177           required: true
28178           type: string
28179           example: __INTERFACE-NAME__
28180         - name: interface-name
28181           in: path
28182           description: Name given to the interface
28183           required: true
28184           type: string
28185           example: __INTERFACE-NAME__
28186         - name: vlan-interface
28187           in: path
28188           description: String that identifies the interface
28189           required: true
28190           type: string
28191           example: __VLAN-INTERFACE__
28192         - name: body
28193           in: body
28194           description: vlan object that needs to be updated.
28195           required: true
28196           schema:
28197             $ref: "#/patchDefinitions/vlan"
28198     delete:
28199       tags:
28200         - Network
28201       summary: delete an existing vlan
28202       description: delete an existing vlan
28203       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28204       consumes:
28205         - application/json
28206         - application/xml
28207       produces:
28208         - application/json
28209         - application/xml
28210       responses:
28211         "default":
28212           description: Response codes found in [response codes](https://wiki.onap.org/).
28213       parameters:
28214         - name: vnf-id
28215           in: path
28216           description: Unique id of VNF.  This is unique across the graph.
28217           required: true
28218           type: string
28219           example: __VNF-ID__
28220         - name: interface-name
28221           in: path
28222           description: Name that identifies the link aggregate interface
28223           required: true
28224           type: string
28225           example: __INTERFACE-NAME__
28226         - name: interface-name
28227           in: path
28228           description: Name given to the interface
28229           required: true
28230           type: string
28231           example: __INTERFACE-NAME__
28232         - name: vlan-interface
28233           in: path
28234           description: String that identifies the interface
28235           required: true
28236           type: string
28237           example: __VLAN-INTERFACE__
28238         - name: resource-version
28239           in: query
28240           description: resource-version for concurrency
28241           required: true
28242           type: string
28243   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
28244     get:
28245       tags:
28246         - Network
28247       summary: returns vlans
28248       description: returns vlans
28249       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
28250       produces:
28251         - application/json
28252         - application/xml
28253       responses:
28254         "200":
28255           description: successful operation
28256           schema:
28257               $ref: "#/getDefinitions/vlans"
28258         "default":
28259           description: Response codes found in [response codes](https://wiki.onap.org/).
28260       parameters:
28261         - name: vnf-id
28262           in: path
28263           description: Unique id of VNF.  This is unique across the graph.
28264           required: true
28265           type: string
28266           example: __VNF-ID__
28267         - name: interface-name
28268           in: path
28269           description: Name that identifies the link aggregate interface
28270           required: true
28271           type: string
28272           example: __INTERFACE-NAME__
28273         - name: interface-name
28274           in: path
28275           description: Name given to the interface
28276           required: true
28277           type: string
28278           example: __INTERFACE-NAME__
28279         - name: vlan-interface
28280           in: query
28281           description:
28282           required: false
28283           type: string
28284         - name: vlan-id-inner
28285           in: query
28286           description:
28287           required: false
28288           type: integer
28289           format: int64
28290         - name: vpn-id
28291           in: query
28292           description:
28293           required: false
28294           type: string
28295   /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:
28296     put:
28297       tags:
28298         - Network
28299       summary: see node definition for valid relationships
28300       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28301       consumes:
28302         - application/json
28303         - application/xml
28304       produces:
28305         - application/json
28306         - application/xml
28307       responses:
28308         "default":
28309           description: Response codes found in [response codes](https://wiki.onap.org/).
28310       parameters:
28311         - name: vnf-id
28312           in: path
28313           description: Unique id of VNF.  This is unique across the graph.
28314           required: true
28315           type: string
28316           example: __VNF-ID__
28317         - name: interface-name
28318           in: path
28319           description: Name that identifies the link aggregate interface
28320           required: true
28321           type: string
28322           example: __INTERFACE-NAME__
28323         - name: interface-name
28324           in: path
28325           description: Name given to the interface
28326           required: true
28327           type: string
28328           example: __INTERFACE-NAME__
28329         - name: pci-id
28330           in: path
28331           description: PCI ID used to identify the sriov-vf
28332           required: true
28333           type: string
28334           example: __PCI-ID__
28335         - name: body
28336           in: body
28337           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28338           required: true
28339           schema:
28340             $ref: "#/definitions/relationship"
28341     delete:
28342       tags:
28343         - Network
28344       summary: delete an existing relationship
28345       description: delete an existing relationship
28346       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28347       consumes:
28348         - application/json
28349         - application/xml
28350       produces:
28351         - application/json
28352         - application/xml
28353       responses:
28354         "default":
28355           description: Response codes found in [response codes](https://wiki.onap.org/).
28356       parameters:
28357         - name: vnf-id
28358           in: path
28359           description: Unique id of VNF.  This is unique across the graph.
28360           required: true
28361           type: string
28362           example: __VNF-ID__
28363         - name: interface-name
28364           in: path
28365           description: Name that identifies the link aggregate interface
28366           required: true
28367           type: string
28368           example: __INTERFACE-NAME__
28369         - name: interface-name
28370           in: path
28371           description: Name given to the interface
28372           required: true
28373           type: string
28374           example: __INTERFACE-NAME__
28375         - name: pci-id
28376           in: path
28377           description: PCI ID used to identify the sriov-vf
28378           required: true
28379           type: string
28380           example: __PCI-ID__
28381   /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}:
28382     get:
28383       tags:
28384         - Network
28385       summary: returns sriov-vf
28386       description: returns sriov-vf
28387       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28388       produces:
28389         - application/json
28390         - application/xml
28391       responses:
28392         "200":
28393           description: successful operation
28394           schema:
28395               $ref: "#/getDefinitions/sriov-vf"
28396         "default":
28397           description: Response codes found in [response codes](https://wiki.onap.org/).
28398       parameters:
28399         - name: vnf-id
28400           in: path
28401           description: Unique id of VNF.  This is unique across the graph.
28402           required: true
28403           type: string
28404           example: __VNF-ID__
28405         - name: interface-name
28406           in: path
28407           description: Name that identifies the link aggregate interface
28408           required: true
28409           type: string
28410           example: __INTERFACE-NAME__
28411         - name: interface-name
28412           in: path
28413           description: Name given to the interface
28414           required: true
28415           type: string
28416           example: __INTERFACE-NAME__
28417         - name: pci-id
28418           in: path
28419           description: PCI ID used to identify the sriov-vf
28420           required: true
28421           type: string
28422           example: __PCI-ID__
28423     put:
28424       tags:
28425         - Network
28426       summary: create or update an existing sriov-vf
28427       description: |
28428         Create or update an existing sriov-vf.
28429         #
28430         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28431       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28432       consumes:
28433         - application/json
28434         - application/xml
28435       produces:
28436         - application/json
28437         - application/xml
28438       responses:
28439         "default":
28440           description: Response codes found in [response codes](https://wiki.onap.org/).
28441       parameters:
28442         - name: vnf-id
28443           in: path
28444           description: Unique id of VNF.  This is unique across the graph.
28445           required: true
28446           type: string
28447           example: __VNF-ID__
28448         - name: interface-name
28449           in: path
28450           description: Name that identifies the link aggregate interface
28451           required: true
28452           type: string
28453           example: __INTERFACE-NAME__
28454         - name: interface-name
28455           in: path
28456           description: Name given to the interface
28457           required: true
28458           type: string
28459           example: __INTERFACE-NAME__
28460         - name: pci-id
28461           in: path
28462           description: PCI ID used to identify the sriov-vf
28463           required: true
28464           type: string
28465           example: __PCI-ID__
28466         - name: body
28467           in: body
28468           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28469           required: true
28470           schema:
28471             $ref: "#/definitions/sriov-vf"
28472     patch:
28473       tags:
28474         - Network
28475       summary: update an existing sriov-vf
28476       description: |
28477         Update an existing sriov-vf
28478         #
28479         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28480         The PUT operation will entirely replace an existing object.
28481         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28482         #
28483         Other differences between PUT and PATCH are:
28484         #
28485         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28486         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28487         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28488       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28489       consumes:
28490         - application/json
28491         - application/xml
28492       produces:
28493         - application/json
28494         - application/xml
28495       responses:
28496         "default":
28497           description: Response codes found in [response codes](https://wiki.onap.org/).
28498       parameters:
28499         - name: vnf-id
28500           in: path
28501           description: Unique id of VNF.  This is unique across the graph.
28502           required: true
28503           type: string
28504           example: __VNF-ID__
28505         - name: interface-name
28506           in: path
28507           description: Name that identifies the link aggregate interface
28508           required: true
28509           type: string
28510           example: __INTERFACE-NAME__
28511         - name: interface-name
28512           in: path
28513           description: Name given to the interface
28514           required: true
28515           type: string
28516           example: __INTERFACE-NAME__
28517         - name: pci-id
28518           in: path
28519           description: PCI ID used to identify the sriov-vf
28520           required: true
28521           type: string
28522           example: __PCI-ID__
28523         - name: body
28524           in: body
28525           description: sriov-vf object that needs to be updated.
28526           required: true
28527           schema:
28528             $ref: "#/patchDefinitions/sriov-vf"
28529     delete:
28530       tags:
28531         - Network
28532       summary: delete an existing sriov-vf
28533       description: delete an existing sriov-vf
28534       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28535       consumes:
28536         - application/json
28537         - application/xml
28538       produces:
28539         - application/json
28540         - application/xml
28541       responses:
28542         "default":
28543           description: Response codes found in [response codes](https://wiki.onap.org/).
28544       parameters:
28545         - name: vnf-id
28546           in: path
28547           description: Unique id of VNF.  This is unique across the graph.
28548           required: true
28549           type: string
28550           example: __VNF-ID__
28551         - name: interface-name
28552           in: path
28553           description: Name that identifies the link aggregate interface
28554           required: true
28555           type: string
28556           example: __INTERFACE-NAME__
28557         - name: interface-name
28558           in: path
28559           description: Name given to the interface
28560           required: true
28561           type: string
28562           example: __INTERFACE-NAME__
28563         - name: pci-id
28564           in: path
28565           description: PCI ID used to identify the sriov-vf
28566           required: true
28567           type: string
28568           example: __PCI-ID__
28569         - name: resource-version
28570           in: query
28571           description: resource-version for concurrency
28572           required: true
28573           type: string
28574   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28575     get:
28576       tags:
28577         - Network
28578       summary: returns sriov-vfs
28579       description: returns sriov-vfs
28580       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
28581       produces:
28582         - application/json
28583         - application/xml
28584       responses:
28585         "200":
28586           description: successful operation
28587           schema:
28588               $ref: "#/getDefinitions/sriov-vfs"
28589         "default":
28590           description: Response codes found in [response codes](https://wiki.onap.org/).
28591       parameters:
28592         - name: vnf-id
28593           in: path
28594           description: Unique id of VNF.  This is unique across the graph.
28595           required: true
28596           type: string
28597           example: __VNF-ID__
28598         - name: interface-name
28599           in: path
28600           description: Name that identifies the link aggregate interface
28601           required: true
28602           type: string
28603           example: __INTERFACE-NAME__
28604         - name: interface-name
28605           in: path
28606           description: Name given to the interface
28607           required: true
28608           type: string
28609           example: __INTERFACE-NAME__
28610         - name: pci-id
28611           in: query
28612           description:
28613           required: false
28614           type: string
28615         - name: vf-vlan-filter
28616           in: query
28617           description:
28618           required: false
28619           type: string
28620         - name: vf-mac-filter
28621           in: query
28622           description:
28623           required: false
28624           type: string
28625         - name: vf-vlan-strip
28626           in: query
28627           description:
28628           required: false
28629           type: boolean
28630         - name: neutron-network-id
28631           in: query
28632           description:
28633           required: false
28634           type: string
28635   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28636     put:
28637       tags:
28638         - Network
28639       summary: see node definition for valid relationships
28640       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28641       consumes:
28642         - application/json
28643         - application/xml
28644       produces:
28645         - application/json
28646         - application/xml
28647       responses:
28648         "default":
28649           description: Response codes found in [response codes](https://wiki.onap.org/).
28650       parameters:
28651         - name: vnf-id
28652           in: path
28653           description: Unique id of VNF.  This is unique across the graph.
28654           required: true
28655           type: string
28656           example: __VNF-ID__
28657         - name: interface-name
28658           in: path
28659           description: Name that identifies the link aggregate interface
28660           required: true
28661           type: string
28662           example: __INTERFACE-NAME__
28663         - name: interface-name
28664           in: path
28665           description: Name given to the interface
28666           required: true
28667           type: string
28668           example: __INTERFACE-NAME__
28669         - name: body
28670           in: body
28671           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
28672           required: true
28673           schema:
28674             $ref: "#/definitions/relationship"
28675     delete:
28676       tags:
28677         - Network
28678       summary: delete an existing relationship
28679       description: delete an existing relationship
28680       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28681       consumes:
28682         - application/json
28683         - application/xml
28684       produces:
28685         - application/json
28686         - application/xml
28687       responses:
28688         "default":
28689           description: Response codes found in [response codes](https://wiki.onap.org/).
28690       parameters:
28691         - name: vnf-id
28692           in: path
28693           description: Unique id of VNF.  This is unique across the graph.
28694           required: true
28695           type: string
28696           example: __VNF-ID__
28697         - name: interface-name
28698           in: path
28699           description: Name that identifies the link aggregate interface
28700           required: true
28701           type: string
28702           example: __INTERFACE-NAME__
28703         - name: interface-name
28704           in: path
28705           description: Name given to the interface
28706           required: true
28707           type: string
28708           example: __INTERFACE-NAME__
28709   /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:
28710     put:
28711       tags:
28712         - Network
28713       summary: see node definition for valid relationships
28714       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28715       consumes:
28716         - application/json
28717         - application/xml
28718       produces:
28719         - application/json
28720         - application/xml
28721       responses:
28722         "default":
28723           description: Response codes found in [response codes](https://wiki.onap.org/).
28724       parameters:
28725         - name: vnf-id
28726           in: path
28727           description: Unique id of VNF.  This is unique across the graph.
28728           required: true
28729           type: string
28730           example: __VNF-ID__
28731         - name: interface-name
28732           in: path
28733           description: Name that identifies the link aggregate interface
28734           required: true
28735           type: string
28736           example: __INTERFACE-NAME__
28737         - name: interface-name
28738           in: path
28739           description: Name given to the interface
28740           required: true
28741           type: string
28742           example: __INTERFACE-NAME__
28743         - name: l3-interface-ipv4-address
28744           in: path
28745           description: IP address
28746           required: true
28747           type: string
28748           example: __L3-INTERFACE-IPV4-ADDRESS__
28749         - name: body
28750           in: body
28751           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28752           required: true
28753           schema:
28754             $ref: "#/definitions/relationship"
28755     delete:
28756       tags:
28757         - Network
28758       summary: delete an existing relationship
28759       description: delete an existing relationship
28760       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28761       consumes:
28762         - application/json
28763         - application/xml
28764       produces:
28765         - application/json
28766         - application/xml
28767       responses:
28768         "default":
28769           description: Response codes found in [response codes](https://wiki.onap.org/).
28770       parameters:
28771         - name: vnf-id
28772           in: path
28773           description: Unique id of VNF.  This is unique across the graph.
28774           required: true
28775           type: string
28776           example: __VNF-ID__
28777         - name: interface-name
28778           in: path
28779           description: Name that identifies the link aggregate interface
28780           required: true
28781           type: string
28782           example: __INTERFACE-NAME__
28783         - name: interface-name
28784           in: path
28785           description: Name given to the interface
28786           required: true
28787           type: string
28788           example: __INTERFACE-NAME__
28789         - name: l3-interface-ipv4-address
28790           in: path
28791           description: IP address
28792           required: true
28793           type: string
28794           example: __L3-INTERFACE-IPV4-ADDRESS__
28795   /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}:
28796     get:
28797       tags:
28798         - Network
28799       summary: returns l3-interface-ipv4-address-list
28800       description: returns l3-interface-ipv4-address-list
28801       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28802       produces:
28803         - application/json
28804         - application/xml
28805       responses:
28806         "200":
28807           description: successful operation
28808           schema:
28809               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28810         "default":
28811           description: Response codes found in [response codes](https://wiki.onap.org/).
28812       parameters:
28813         - name: vnf-id
28814           in: path
28815           description: Unique id of VNF.  This is unique across the graph.
28816           required: true
28817           type: string
28818           example: __VNF-ID__
28819         - name: interface-name
28820           in: path
28821           description: Name that identifies the link aggregate interface
28822           required: true
28823           type: string
28824           example: __INTERFACE-NAME__
28825         - name: interface-name
28826           in: path
28827           description: Name given to the interface
28828           required: true
28829           type: string
28830           example: __INTERFACE-NAME__
28831         - name: l3-interface-ipv4-address
28832           in: path
28833           description: IP address
28834           required: true
28835           type: string
28836           example: __L3-INTERFACE-IPV4-ADDRESS__
28837     put:
28838       tags:
28839         - Network
28840       summary: create or update an existing l3-interface-ipv4-address-list
28841       description: |
28842         Create or update an existing l3-interface-ipv4-address-list.
28843         #
28844         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28845       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28846       consumes:
28847         - application/json
28848         - application/xml
28849       produces:
28850         - application/json
28851         - application/xml
28852       responses:
28853         "default":
28854           description: Response codes found in [response codes](https://wiki.onap.org/).
28855       parameters:
28856         - name: vnf-id
28857           in: path
28858           description: Unique id of VNF.  This is unique across the graph.
28859           required: true
28860           type: string
28861           example: __VNF-ID__
28862         - name: interface-name
28863           in: path
28864           description: Name that identifies the link aggregate interface
28865           required: true
28866           type: string
28867           example: __INTERFACE-NAME__
28868         - name: interface-name
28869           in: path
28870           description: Name given to the interface
28871           required: true
28872           type: string
28873           example: __INTERFACE-NAME__
28874         - name: l3-interface-ipv4-address
28875           in: path
28876           description: IP address
28877           required: true
28878           type: string
28879           example: __L3-INTERFACE-IPV4-ADDRESS__
28880         - name: body
28881           in: body
28882           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28883           required: true
28884           schema:
28885             $ref: "#/definitions/l3-interface-ipv4-address-list"
28886     patch:
28887       tags:
28888         - Network
28889       summary: update an existing l3-interface-ipv4-address-list
28890       description: |
28891         Update an existing l3-interface-ipv4-address-list
28892         #
28893         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28894         The PUT operation will entirely replace an existing object.
28895         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28896         #
28897         Other differences between PUT and PATCH are:
28898         #
28899         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28900         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28901         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28902       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28903       consumes:
28904         - application/json
28905         - application/xml
28906       produces:
28907         - application/json
28908         - application/xml
28909       responses:
28910         "default":
28911           description: Response codes found in [response codes](https://wiki.onap.org/).
28912       parameters:
28913         - name: vnf-id
28914           in: path
28915           description: Unique id of VNF.  This is unique across the graph.
28916           required: true
28917           type: string
28918           example: __VNF-ID__
28919         - name: interface-name
28920           in: path
28921           description: Name that identifies the link aggregate interface
28922           required: true
28923           type: string
28924           example: __INTERFACE-NAME__
28925         - name: interface-name
28926           in: path
28927           description: Name given to the interface
28928           required: true
28929           type: string
28930           example: __INTERFACE-NAME__
28931         - name: l3-interface-ipv4-address
28932           in: path
28933           description: IP address
28934           required: true
28935           type: string
28936           example: __L3-INTERFACE-IPV4-ADDRESS__
28937         - name: body
28938           in: body
28939           description: l3-interface-ipv4-address-list object that needs to be updated.
28940           required: true
28941           schema:
28942             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28943     delete:
28944       tags:
28945         - Network
28946       summary: delete an existing l3-interface-ipv4-address-list
28947       description: delete an existing l3-interface-ipv4-address-list
28948       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28949       consumes:
28950         - application/json
28951         - application/xml
28952       produces:
28953         - application/json
28954         - application/xml
28955       responses:
28956         "default":
28957           description: Response codes found in [response codes](https://wiki.onap.org/).
28958       parameters:
28959         - name: vnf-id
28960           in: path
28961           description: Unique id of VNF.  This is unique across the graph.
28962           required: true
28963           type: string
28964           example: __VNF-ID__
28965         - name: interface-name
28966           in: path
28967           description: Name that identifies the link aggregate interface
28968           required: true
28969           type: string
28970           example: __INTERFACE-NAME__
28971         - name: interface-name
28972           in: path
28973           description: Name given to the interface
28974           required: true
28975           type: string
28976           example: __INTERFACE-NAME__
28977         - name: l3-interface-ipv4-address
28978           in: path
28979           description: IP address
28980           required: true
28981           type: string
28982           example: __L3-INTERFACE-IPV4-ADDRESS__
28983         - name: resource-version
28984           in: query
28985           description: resource-version for concurrency
28986           required: true
28987           type: string
28988   /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:
28989     put:
28990       tags:
28991         - Network
28992       summary: see node definition for valid relationships
28993       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28994       consumes:
28995         - application/json
28996         - application/xml
28997       produces:
28998         - application/json
28999         - application/xml
29000       responses:
29001         "default":
29002           description: Response codes found in [response codes](https://wiki.onap.org/).
29003       parameters:
29004         - name: vnf-id
29005           in: path
29006           description: Unique id of VNF.  This is unique across the graph.
29007           required: true
29008           type: string
29009           example: __VNF-ID__
29010         - name: interface-name
29011           in: path
29012           description: Name that identifies the link aggregate interface
29013           required: true
29014           type: string
29015           example: __INTERFACE-NAME__
29016         - name: interface-name
29017           in: path
29018           description: Name given to the interface
29019           required: true
29020           type: string
29021           example: __INTERFACE-NAME__
29022         - name: l3-interface-ipv6-address
29023           in: path
29024           description: IP address
29025           required: true
29026           type: string
29027           example: __L3-INTERFACE-IPV6-ADDRESS__
29028         - name: body
29029           in: body
29030           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29031           required: true
29032           schema:
29033             $ref: "#/definitions/relationship"
29034     delete:
29035       tags:
29036         - Network
29037       summary: delete an existing relationship
29038       description: delete an existing relationship
29039       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
29040       consumes:
29041         - application/json
29042         - application/xml
29043       produces:
29044         - application/json
29045         - application/xml
29046       responses:
29047         "default":
29048           description: Response codes found in [response codes](https://wiki.onap.org/).
29049       parameters:
29050         - name: vnf-id
29051           in: path
29052           description: Unique id of VNF.  This is unique across the graph.
29053           required: true
29054           type: string
29055           example: __VNF-ID__
29056         - name: interface-name
29057           in: path
29058           description: Name that identifies the link aggregate interface
29059           required: true
29060           type: string
29061           example: __INTERFACE-NAME__
29062         - name: interface-name
29063           in: path
29064           description: Name given to the interface
29065           required: true
29066           type: string
29067           example: __INTERFACE-NAME__
29068         - name: l3-interface-ipv6-address
29069           in: path
29070           description: IP address
29071           required: true
29072           type: string
29073           example: __L3-INTERFACE-IPV6-ADDRESS__
29074   /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}:
29075     get:
29076       tags:
29077         - Network
29078       summary: returns l3-interface-ipv6-address-list
29079       description: returns l3-interface-ipv6-address-list
29080       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29081       produces:
29082         - application/json
29083         - application/xml
29084       responses:
29085         "200":
29086           description: successful operation
29087           schema:
29088               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29089         "default":
29090           description: Response codes found in [response codes](https://wiki.onap.org/).
29091       parameters:
29092         - name: vnf-id
29093           in: path
29094           description: Unique id of VNF.  This is unique across the graph.
29095           required: true
29096           type: string
29097           example: __VNF-ID__
29098         - name: interface-name
29099           in: path
29100           description: Name that identifies the link aggregate interface
29101           required: true
29102           type: string
29103           example: __INTERFACE-NAME__
29104         - name: interface-name
29105           in: path
29106           description: Name given to the interface
29107           required: true
29108           type: string
29109           example: __INTERFACE-NAME__
29110         - name: l3-interface-ipv6-address
29111           in: path
29112           description: IP address
29113           required: true
29114           type: string
29115           example: __L3-INTERFACE-IPV6-ADDRESS__
29116     put:
29117       tags:
29118         - Network
29119       summary: create or update an existing l3-interface-ipv6-address-list
29120       description: |
29121         Create or update an existing l3-interface-ipv6-address-list.
29122         #
29123         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29124       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29125       consumes:
29126         - application/json
29127         - application/xml
29128       produces:
29129         - application/json
29130         - application/xml
29131       responses:
29132         "default":
29133           description: Response codes found in [response codes](https://wiki.onap.org/).
29134       parameters:
29135         - name: vnf-id
29136           in: path
29137           description: Unique id of VNF.  This is unique across the graph.
29138           required: true
29139           type: string
29140           example: __VNF-ID__
29141         - name: interface-name
29142           in: path
29143           description: Name that identifies the link aggregate interface
29144           required: true
29145           type: string
29146           example: __INTERFACE-NAME__
29147         - name: interface-name
29148           in: path
29149           description: Name given to the interface
29150           required: true
29151           type: string
29152           example: __INTERFACE-NAME__
29153         - name: l3-interface-ipv6-address
29154           in: path
29155           description: IP address
29156           required: true
29157           type: string
29158           example: __L3-INTERFACE-IPV6-ADDRESS__
29159         - name: body
29160           in: body
29161           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29162           required: true
29163           schema:
29164             $ref: "#/definitions/l3-interface-ipv6-address-list"
29165     patch:
29166       tags:
29167         - Network
29168       summary: update an existing l3-interface-ipv6-address-list
29169       description: |
29170         Update an existing l3-interface-ipv6-address-list
29171         #
29172         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29173         The PUT operation will entirely replace an existing object.
29174         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29175         #
29176         Other differences between PUT and PATCH are:
29177         #
29178         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29179         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29180         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29181       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29182       consumes:
29183         - application/json
29184         - application/xml
29185       produces:
29186         - application/json
29187         - application/xml
29188       responses:
29189         "default":
29190           description: Response codes found in [response codes](https://wiki.onap.org/).
29191       parameters:
29192         - name: vnf-id
29193           in: path
29194           description: Unique id of VNF.  This is unique across the graph.
29195           required: true
29196           type: string
29197           example: __VNF-ID__
29198         - name: interface-name
29199           in: path
29200           description: Name that identifies the link aggregate interface
29201           required: true
29202           type: string
29203           example: __INTERFACE-NAME__
29204         - name: interface-name
29205           in: path
29206           description: Name given to the interface
29207           required: true
29208           type: string
29209           example: __INTERFACE-NAME__
29210         - name: l3-interface-ipv6-address
29211           in: path
29212           description: IP address
29213           required: true
29214           type: string
29215           example: __L3-INTERFACE-IPV6-ADDRESS__
29216         - name: body
29217           in: body
29218           description: l3-interface-ipv6-address-list object that needs to be updated.
29219           required: true
29220           schema:
29221             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29222     delete:
29223       tags:
29224         - Network
29225       summary: delete an existing l3-interface-ipv6-address-list
29226       description: delete an existing l3-interface-ipv6-address-list
29227       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29228       consumes:
29229         - application/json
29230         - application/xml
29231       produces:
29232         - application/json
29233         - application/xml
29234       responses:
29235         "default":
29236           description: Response codes found in [response codes](https://wiki.onap.org/).
29237       parameters:
29238         - name: vnf-id
29239           in: path
29240           description: Unique id of VNF.  This is unique across the graph.
29241           required: true
29242           type: string
29243           example: __VNF-ID__
29244         - name: interface-name
29245           in: path
29246           description: Name that identifies the link aggregate interface
29247           required: true
29248           type: string
29249           example: __INTERFACE-NAME__
29250         - name: interface-name
29251           in: path
29252           description: Name given to the interface
29253           required: true
29254           type: string
29255           example: __INTERFACE-NAME__
29256         - name: l3-interface-ipv6-address
29257           in: path
29258           description: IP address
29259           required: true
29260           type: string
29261           example: __L3-INTERFACE-IPV6-ADDRESS__
29262         - name: resource-version
29263           in: query
29264           description: resource-version for concurrency
29265           required: true
29266           type: string
29267   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29268     get:
29269       tags:
29270         - Network
29271       summary: returns l-interface
29272       description: returns l-interface
29273       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29274       produces:
29275         - application/json
29276         - application/xml
29277       responses:
29278         "200":
29279           description: successful operation
29280           schema:
29281               $ref: "#/getDefinitions/l-interface"
29282         "default":
29283           description: Response codes found in [response codes](https://wiki.onap.org/).
29284       parameters:
29285         - name: vnf-id
29286           in: path
29287           description: Unique id of VNF.  This is unique across the graph.
29288           required: true
29289           type: string
29290           example: __VNF-ID__
29291         - name: interface-name
29292           in: path
29293           description: Name that identifies the link aggregate interface
29294           required: true
29295           type: string
29296           example: __INTERFACE-NAME__
29297         - name: interface-name
29298           in: path
29299           description: Name given to the interface
29300           required: true
29301           type: string
29302           example: __INTERFACE-NAME__
29303     put:
29304       tags:
29305         - Network
29306       summary: create or update an existing l-interface
29307       description: |
29308         Create or update an existing l-interface.
29309         #
29310         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29311       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29312       consumes:
29313         - application/json
29314         - application/xml
29315       produces:
29316         - application/json
29317         - application/xml
29318       responses:
29319         "default":
29320           description: Response codes found in [response codes](https://wiki.onap.org/).
29321       parameters:
29322         - name: vnf-id
29323           in: path
29324           description: Unique id of VNF.  This is unique across the graph.
29325           required: true
29326           type: string
29327           example: __VNF-ID__
29328         - name: interface-name
29329           in: path
29330           description: Name that identifies the link aggregate interface
29331           required: true
29332           type: string
29333           example: __INTERFACE-NAME__
29334         - name: interface-name
29335           in: path
29336           description: Name given to the interface
29337           required: true
29338           type: string
29339           example: __INTERFACE-NAME__
29340         - name: body
29341           in: body
29342           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
29343           required: true
29344           schema:
29345             $ref: "#/definitions/l-interface"
29346     patch:
29347       tags:
29348         - Network
29349       summary: update an existing l-interface
29350       description: |
29351         Update an existing l-interface
29352         #
29353         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29354         The PUT operation will entirely replace an existing object.
29355         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29356         #
29357         Other differences between PUT and PATCH are:
29358         #
29359         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29360         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29361         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29362       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29363       consumes:
29364         - application/json
29365         - application/xml
29366       produces:
29367         - application/json
29368         - application/xml
29369       responses:
29370         "default":
29371           description: Response codes found in [response codes](https://wiki.onap.org/).
29372       parameters:
29373         - name: vnf-id
29374           in: path
29375           description: Unique id of VNF.  This is unique across the graph.
29376           required: true
29377           type: string
29378           example: __VNF-ID__
29379         - name: interface-name
29380           in: path
29381           description: Name that identifies the link aggregate interface
29382           required: true
29383           type: string
29384           example: __INTERFACE-NAME__
29385         - name: interface-name
29386           in: path
29387           description: Name given to the interface
29388           required: true
29389           type: string
29390           example: __INTERFACE-NAME__
29391         - name: body
29392           in: body
29393           description: l-interface object that needs to be updated.
29394           required: true
29395           schema:
29396             $ref: "#/patchDefinitions/l-interface"
29397     delete:
29398       tags:
29399         - Network
29400       summary: delete an existing l-interface
29401       description: delete an existing l-interface
29402       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29403       consumes:
29404         - application/json
29405         - application/xml
29406       produces:
29407         - application/json
29408         - application/xml
29409       responses:
29410         "default":
29411           description: Response codes found in [response codes](https://wiki.onap.org/).
29412       parameters:
29413         - name: vnf-id
29414           in: path
29415           description: Unique id of VNF.  This is unique across the graph.
29416           required: true
29417           type: string
29418           example: __VNF-ID__
29419         - name: interface-name
29420           in: path
29421           description: Name that identifies the link aggregate interface
29422           required: true
29423           type: string
29424           example: __INTERFACE-NAME__
29425         - name: interface-name
29426           in: path
29427           description: Name given to the interface
29428           required: true
29429           type: string
29430           example: __INTERFACE-NAME__
29431         - name: resource-version
29432           in: query
29433           description: resource-version for concurrency
29434           required: true
29435           type: string
29436   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
29437     get:
29438       tags:
29439         - Network
29440       summary: returns l-interfaces
29441       description: returns l-interfaces
29442       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
29443       produces:
29444         - application/json
29445         - application/xml
29446       responses:
29447         "200":
29448           description: successful operation
29449           schema:
29450               $ref: "#/getDefinitions/l-interfaces"
29451         "default":
29452           description: Response codes found in [response codes](https://wiki.onap.org/).
29453       parameters:
29454         - name: vnf-id
29455           in: path
29456           description: Unique id of VNF.  This is unique across the graph.
29457           required: true
29458           type: string
29459           example: __VNF-ID__
29460         - name: interface-name
29461           in: path
29462           description: Name that identifies the link aggregate interface
29463           required: true
29464           type: string
29465           example: __INTERFACE-NAME__
29466         - name: interface-name
29467           in: query
29468           description:
29469           required: false
29470           type: string
29471         - name: interface-id
29472           in: query
29473           description:
29474           required: false
29475           type: string
29476         - name: macaddr
29477           in: query
29478           description:
29479           required: false
29480           type: string
29481         - name: network-name
29482           in: query
29483           description:
29484           required: false
29485           type: string
29486   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
29487     get:
29488       tags:
29489         - Network
29490       summary: returns lag-interface
29491       description: returns lag-interface
29492       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29493       produces:
29494         - application/json
29495         - application/xml
29496       responses:
29497         "200":
29498           description: successful operation
29499           schema:
29500               $ref: "#/getDefinitions/lag-interface"
29501         "default":
29502           description: Response codes found in [response codes](https://wiki.onap.org/).
29503       parameters:
29504         - name: vnf-id
29505           in: path
29506           description: Unique id of VNF.  This is unique across the graph.
29507           required: true
29508           type: string
29509           example: __VNF-ID__
29510         - name: interface-name
29511           in: path
29512           description: Name that identifies the link aggregate interface
29513           required: true
29514           type: string
29515           example: __INTERFACE-NAME__
29516     put:
29517       tags:
29518         - Network
29519       summary: create or update an existing lag-interface
29520       description: |
29521         Create or update an existing lag-interface.
29522         #
29523         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29524       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29525       consumes:
29526         - application/json
29527         - application/xml
29528       produces:
29529         - application/json
29530         - application/xml
29531       responses:
29532         "default":
29533           description: Response codes found in [response codes](https://wiki.onap.org/).
29534       parameters:
29535         - name: vnf-id
29536           in: path
29537           description: Unique id of VNF.  This is unique across the graph.
29538           required: true
29539           type: string
29540           example: __VNF-ID__
29541         - name: interface-name
29542           in: path
29543           description: Name that identifies the link aggregate interface
29544           required: true
29545           type: string
29546           example: __INTERFACE-NAME__
29547         - name: body
29548           in: body
29549           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29550           required: true
29551           schema:
29552             $ref: "#/definitions/lag-interface"
29553     patch:
29554       tags:
29555         - Network
29556       summary: update an existing lag-interface
29557       description: |
29558         Update an existing lag-interface
29559         #
29560         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29561         The PUT operation will entirely replace an existing object.
29562         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29563         #
29564         Other differences between PUT and PATCH are:
29565         #
29566         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29567         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29568         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29569       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29570       consumes:
29571         - application/json
29572         - application/xml
29573       produces:
29574         - application/json
29575         - application/xml
29576       responses:
29577         "default":
29578           description: Response codes found in [response codes](https://wiki.onap.org/).
29579       parameters:
29580         - name: vnf-id
29581           in: path
29582           description: Unique id of VNF.  This is unique across the graph.
29583           required: true
29584           type: string
29585           example: __VNF-ID__
29586         - name: interface-name
29587           in: path
29588           description: Name that identifies the link aggregate interface
29589           required: true
29590           type: string
29591           example: __INTERFACE-NAME__
29592         - name: body
29593           in: body
29594           description: lag-interface object that needs to be updated.
29595           required: true
29596           schema:
29597             $ref: "#/patchDefinitions/lag-interface"
29598     delete:
29599       tags:
29600         - Network
29601       summary: delete an existing lag-interface
29602       description: delete an existing lag-interface
29603       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29604       consumes:
29605         - application/json
29606         - application/xml
29607       produces:
29608         - application/json
29609         - application/xml
29610       responses:
29611         "default":
29612           description: Response codes found in [response codes](https://wiki.onap.org/).
29613       parameters:
29614         - name: vnf-id
29615           in: path
29616           description: Unique id of VNF.  This is unique across the graph.
29617           required: true
29618           type: string
29619           example: __VNF-ID__
29620         - name: interface-name
29621           in: path
29622           description: Name that identifies the link aggregate interface
29623           required: true
29624           type: string
29625           example: __INTERFACE-NAME__
29626         - name: resource-version
29627           in: query
29628           description: resource-version for concurrency
29629           required: true
29630           type: string
29631   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
29632     get:
29633       tags:
29634         - Network
29635       summary: returns lag-interfaces
29636       description: returns lag-interfaces
29637       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
29638       produces:
29639         - application/json
29640         - application/xml
29641       responses:
29642         "200":
29643           description: successful operation
29644           schema:
29645               $ref: "#/getDefinitions/lag-interfaces"
29646         "default":
29647           description: Response codes found in [response codes](https://wiki.onap.org/).
29648       parameters:
29649         - name: vnf-id
29650           in: path
29651           description: Unique id of VNF.  This is unique across the graph.
29652           required: true
29653           type: string
29654           example: __VNF-ID__
29655         - name: interface-name
29656           in: query
29657           description:
29658           required: false
29659           type: string
29660   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
29661     put:
29662       tags:
29663         - Network
29664       summary: see node definition for valid relationships
29665       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
29666       consumes:
29667         - application/json
29668         - application/xml
29669       produces:
29670         - application/json
29671         - application/xml
29672       responses:
29673         "default":
29674           description: Response codes found in [response codes](https://wiki.onap.org/).
29675       parameters:
29676         - name: vnf-id
29677           in: path
29678           description: Unique id of VNF.  This is unique across the graph.
29679           required: true
29680           type: string
29681           example: __VNF-ID__
29682         - name: vf-module-id
29683           in: path
29684           description: Unique ID of vf-module.
29685           required: true
29686           type: string
29687           example: __VF-MODULE-ID__
29688         - name: body
29689           in: body
29690           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
29691           required: true
29692           schema:
29693             $ref: "#/definitions/relationship"
29694     delete:
29695       tags:
29696         - Network
29697       summary: delete an existing relationship
29698       description: delete an existing relationship
29699       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
29700       consumes:
29701         - application/json
29702         - application/xml
29703       produces:
29704         - application/json
29705         - application/xml
29706       responses:
29707         "default":
29708           description: Response codes found in [response codes](https://wiki.onap.org/).
29709       parameters:
29710         - name: vnf-id
29711           in: path
29712           description: Unique id of VNF.  This is unique across the graph.
29713           required: true
29714           type: string
29715           example: __VNF-ID__
29716         - name: vf-module-id
29717           in: path
29718           description: Unique ID of vf-module.
29719           required: true
29720           type: string
29721           example: __VF-MODULE-ID__
29722   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
29723     get:
29724       tags:
29725         - Network
29726       summary: returns vf-module
29727       description: returns vf-module
29728       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
29729       produces:
29730         - application/json
29731         - application/xml
29732       responses:
29733         "200":
29734           description: successful operation
29735           schema:
29736               $ref: "#/getDefinitions/vf-module"
29737         "default":
29738           description: Response codes found in [response codes](https://wiki.onap.org/).
29739       parameters:
29740         - name: vnf-id
29741           in: path
29742           description: Unique id of VNF.  This is unique across the graph.
29743           required: true
29744           type: string
29745           example: __VNF-ID__
29746         - name: vf-module-id
29747           in: path
29748           description: Unique ID of vf-module.
29749           required: true
29750           type: string
29751           example: __VF-MODULE-ID__
29752     put:
29753       tags:
29754         - Network
29755       summary: create or update an existing vf-module
29756       description: |
29757         Create or update an existing vf-module.
29758         #
29759         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29760       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
29761       consumes:
29762         - application/json
29763         - application/xml
29764       produces:
29765         - application/json
29766         - application/xml
29767       responses:
29768         "default":
29769           description: Response codes found in [response codes](https://wiki.onap.org/).
29770       parameters:
29771         - name: vnf-id
29772           in: path
29773           description: Unique id of VNF.  This is unique across the graph.
29774           required: true
29775           type: string
29776           example: __VNF-ID__
29777         - name: vf-module-id
29778           in: path
29779           description: Unique ID of vf-module.
29780           required: true
29781           type: string
29782           example: __VF-MODULE-ID__
29783         - name: body
29784           in: body
29785           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
29786           required: true
29787           schema:
29788             $ref: "#/definitions/vf-module"
29789     patch:
29790       tags:
29791         - Network
29792       summary: update an existing vf-module
29793       description: |
29794         Update an existing vf-module
29795         #
29796         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29797         The PUT operation will entirely replace an existing object.
29798         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29799         #
29800         Other differences between PUT and PATCH are:
29801         #
29802         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29803         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29804         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29805       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
29806       consumes:
29807         - application/json
29808         - application/xml
29809       produces:
29810         - application/json
29811         - application/xml
29812       responses:
29813         "default":
29814           description: Response codes found in [response codes](https://wiki.onap.org/).
29815       parameters:
29816         - name: vnf-id
29817           in: path
29818           description: Unique id of VNF.  This is unique across the graph.
29819           required: true
29820           type: string
29821           example: __VNF-ID__
29822         - name: vf-module-id
29823           in: path
29824           description: Unique ID of vf-module.
29825           required: true
29826           type: string
29827           example: __VF-MODULE-ID__
29828         - name: body
29829           in: body
29830           description: vf-module object that needs to be updated.
29831           required: true
29832           schema:
29833             $ref: "#/patchDefinitions/vf-module"
29834     delete:
29835       tags:
29836         - Network
29837       summary: delete an existing vf-module
29838       description: delete an existing vf-module
29839       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
29840       consumes:
29841         - application/json
29842         - application/xml
29843       produces:
29844         - application/json
29845         - application/xml
29846       responses:
29847         "default":
29848           description: Response codes found in [response codes](https://wiki.onap.org/).
29849       parameters:
29850         - name: vnf-id
29851           in: path
29852           description: Unique id of VNF.  This is unique across the graph.
29853           required: true
29854           type: string
29855           example: __VNF-ID__
29856         - name: vf-module-id
29857           in: path
29858           description: Unique ID of vf-module.
29859           required: true
29860           type: string
29861           example: __VF-MODULE-ID__
29862         - name: resource-version
29863           in: query
29864           description: resource-version for concurrency
29865           required: true
29866           type: string
29867   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
29868     get:
29869       tags:
29870         - Network
29871       summary: returns vf-modules
29872       description: returns vf-modules
29873       operationId: getNetworkGenericVnfsGenericVnfVfModules
29874       produces:
29875         - application/json
29876         - application/xml
29877       responses:
29878         "200":
29879           description: successful operation
29880           schema:
29881               $ref: "#/getDefinitions/vf-modules"
29882         "default":
29883           description: Response codes found in [response codes](https://wiki.onap.org/).
29884       parameters:
29885         - name: vnf-id
29886           in: path
29887           description: Unique id of VNF.  This is unique across the graph.
29888           required: true
29889           type: string
29890           example: __VNF-ID__
29891         - name: vf-module-id
29892           in: query
29893           description:
29894           required: false
29895           type: string
29896         - name: vf-module-name
29897           in: query
29898           description:
29899           required: false
29900           type: string
29901         - name: heat-stack-id
29902           in: query
29903           description:
29904           required: false
29905           type: string
29906         - name: persona-model-id
29907           in: query
29908           description:
29909           required: false
29910           type: string
29911         - name: persona-model-version
29912           in: query
29913           description:
29914           required: false
29915           type: string
29916         - name: widget-model-id
29917           in: query
29918           description:
29919           required: false
29920           type: string
29921         - name: widget-model-version
29922           in: query
29923           description:
29924           required: false
29925           type: string
29926         - name: contrail-service-instance-fqdn
29927           in: query
29928           description:
29929           required: false
29930           type: string
29931   /network/generic-vnfs/generic-vnf/{vnf-id}:
29932     get:
29933       tags:
29934         - Network
29935       summary: returns generic-vnf
29936       description: returns generic-vnf
29937       operationId: getNetworkGenericVnfsGenericVnf
29938       produces:
29939         - application/json
29940         - application/xml
29941       responses:
29942         "200":
29943           description: successful operation
29944           schema:
29945               $ref: "#/getDefinitions/generic-vnf"
29946         "default":
29947           description: Response codes found in [response codes](https://wiki.onap.org/).
29948       parameters:
29949         - name: vnf-id
29950           in: path
29951           description: Unique id of VNF.  This is unique across the graph.
29952           required: true
29953           type: string
29954           example: __VNF-ID__
29955     put:
29956       tags:
29957         - Network
29958       summary: create or update an existing generic-vnf
29959       description: |
29960         Create or update an existing generic-vnf.
29961         #
29962         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29963       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
29964       consumes:
29965         - application/json
29966         - application/xml
29967       produces:
29968         - application/json
29969         - application/xml
29970       responses:
29971         "default":
29972           description: Response codes found in [response codes](https://wiki.onap.org/).
29973       parameters:
29974         - name: vnf-id
29975           in: path
29976           description: Unique id of VNF.  This is unique across the graph.
29977           required: true
29978           type: string
29979           example: __VNF-ID__
29980         - name: body
29981           in: body
29982           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
29983           required: true
29984           schema:
29985             $ref: "#/definitions/generic-vnf"
29986     patch:
29987       tags:
29988         - Network
29989       summary: update an existing generic-vnf
29990       description: |
29991         Update an existing generic-vnf
29992         #
29993         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29994         The PUT operation will entirely replace an existing object.
29995         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29996         #
29997         Other differences between PUT and PATCH are:
29998         #
29999         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30000         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30001         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30002       operationId: UpdateNetworkGenericVnfsGenericVnf
30003       consumes:
30004         - application/json
30005         - application/xml
30006       produces:
30007         - application/json
30008         - application/xml
30009       responses:
30010         "default":
30011           description: Response codes found in [response codes](https://wiki.onap.org/).
30012       parameters:
30013         - name: vnf-id
30014           in: path
30015           description: Unique id of VNF.  This is unique across the graph.
30016           required: true
30017           type: string
30018           example: __VNF-ID__
30019         - name: body
30020           in: body
30021           description: generic-vnf object that needs to be updated.
30022           required: true
30023           schema:
30024             $ref: "#/patchDefinitions/generic-vnf"
30025     delete:
30026       tags:
30027         - Network
30028       summary: delete an existing generic-vnf
30029       description: delete an existing generic-vnf
30030       operationId: deleteNetworkGenericVnfsGenericVnf
30031       consumes:
30032         - application/json
30033         - application/xml
30034       produces:
30035         - application/json
30036         - application/xml
30037       responses:
30038         "default":
30039           description: Response codes found in [response codes](https://wiki.onap.org/).
30040       parameters:
30041         - name: vnf-id
30042           in: path
30043           description: Unique id of VNF.  This is unique across the graph.
30044           required: true
30045           type: string
30046           example: __VNF-ID__
30047         - name: resource-version
30048           in: query
30049           description: resource-version for concurrency
30050           required: true
30051           type: string
30052   /network/generic-vnfs:
30053     get:
30054       tags:
30055         - Network
30056       summary: returns generic-vnfs
30057       description: returns generic-vnfs
30058       operationId: getNetworkGenericVnfs
30059       produces:
30060         - application/json
30061         - application/xml
30062       responses:
30063         "200":
30064           description: successful operation
30065           schema:
30066               $ref: "#/getDefinitions/generic-vnfs"
30067         "default":
30068           description: Response codes found in [response codes](https://wiki.onap.org/).
30069       parameters:
30070         - name: vnf-id
30071           in: query
30072           description:
30073           required: false
30074           type: string
30075         - name: vnf-name
30076           in: query
30077           description:
30078           required: false
30079           type: string
30080         - name: vnf-name2
30081           in: query
30082           description:
30083           required: false
30084           type: string
30085         - name: vnf-type
30086           in: query
30087           description:
30088           required: false
30089           type: string
30090         - name: service-id
30091           in: query
30092           description:
30093           required: false
30094           type: string
30095         - name: regional-resource-zone
30096           in: query
30097           description:
30098           required: false
30099           type: string
30100         - name: prov-status
30101           in: query
30102           description:
30103           required: false
30104           type: string
30105         - name: heat-stack-id
30106           in: query
30107           description:
30108           required: false
30109           type: string
30110         - name: in-maint
30111           in: query
30112           description:
30113           required: false
30114           type: boolean
30115         - name: is-closed-loop-disabled
30116           in: query
30117           description:
30118           required: false
30119           type: boolean
30120         - name: persona-model-id
30121           in: query
30122           description:
30123           required: false
30124           type: string
30125         - name: persona-model-version
30126           in: query
30127           description:
30128           required: false
30129           type: string
30130         - name: widget-model-id
30131           in: query
30132           description:
30133           required: false
30134           type: string
30135         - name: widget-model-version
30136           in: query
30137           description:
30138           required: false
30139           type: string
30140   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
30141     put:
30142       tags:
30143         - Network
30144       summary: see node definition for valid relationships
30145       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
30146       consumes:
30147         - application/json
30148         - application/xml
30149       produces:
30150         - application/json
30151         - application/xml
30152       responses:
30153         "default":
30154           description: Response codes found in [response codes](https://wiki.onap.org/).
30155       parameters:
30156         - name: link-name
30157           in: path
30158           description: Alphabetical concatenation of lag-interface names
30159           required: true
30160           type: string
30161           example: __LINK-NAME__
30162         - name: body
30163           in: body
30164           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
30165           required: true
30166           schema:
30167             $ref: "#/definitions/relationship"
30168     delete:
30169       tags:
30170         - Network
30171       summary: delete an existing relationship
30172       description: delete an existing relationship
30173       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
30174       consumes:
30175         - application/json
30176         - application/xml
30177       produces:
30178         - application/json
30179         - application/xml
30180       responses:
30181         "default":
30182           description: Response codes found in [response codes](https://wiki.onap.org/).
30183       parameters:
30184         - name: link-name
30185           in: path
30186           description: Alphabetical concatenation of lag-interface names
30187           required: true
30188           type: string
30189           example: __LINK-NAME__
30190   /network/lag-links/lag-link/{link-name}:
30191     get:
30192       tags:
30193         - Network
30194       summary: returns lag-link
30195       description: returns lag-link
30196       operationId: getNetworkLagLinksLagLink
30197       produces:
30198         - application/json
30199         - application/xml
30200       responses:
30201         "200":
30202           description: successful operation
30203           schema:
30204               $ref: "#/getDefinitions/lag-link"
30205         "default":
30206           description: Response codes found in [response codes](https://wiki.onap.org/).
30207       parameters:
30208         - name: link-name
30209           in: path
30210           description: Alphabetical concatenation of lag-interface names
30211           required: true
30212           type: string
30213           example: __LINK-NAME__
30214     put:
30215       tags:
30216         - Network
30217       summary: create or update an existing lag-link
30218       description: |
30219         Create or update an existing lag-link.
30220         #
30221         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30222       operationId: createOrUpdateNetworkLagLinksLagLink
30223       consumes:
30224         - application/json
30225         - application/xml
30226       produces:
30227         - application/json
30228         - application/xml
30229       responses:
30230         "default":
30231           description: Response codes found in [response codes](https://wiki.onap.org/).
30232       parameters:
30233         - name: link-name
30234           in: path
30235           description: Alphabetical concatenation of lag-interface names
30236           required: true
30237           type: string
30238           example: __LINK-NAME__
30239         - name: body
30240           in: body
30241           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
30242           required: true
30243           schema:
30244             $ref: "#/definitions/lag-link"
30245     patch:
30246       tags:
30247         - Network
30248       summary: update an existing lag-link
30249       description: |
30250         Update an existing lag-link
30251         #
30252         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30253         The PUT operation will entirely replace an existing object.
30254         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30255         #
30256         Other differences between PUT and PATCH are:
30257         #
30258         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30259         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30260         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30261       operationId: UpdateNetworkLagLinksLagLink
30262       consumes:
30263         - application/json
30264         - application/xml
30265       produces:
30266         - application/json
30267         - application/xml
30268       responses:
30269         "default":
30270           description: Response codes found in [response codes](https://wiki.onap.org/).
30271       parameters:
30272         - name: link-name
30273           in: path
30274           description: Alphabetical concatenation of lag-interface names
30275           required: true
30276           type: string
30277           example: __LINK-NAME__
30278         - name: body
30279           in: body
30280           description: lag-link object that needs to be updated.
30281           required: true
30282           schema:
30283             $ref: "#/patchDefinitions/lag-link"
30284     delete:
30285       tags:
30286         - Network
30287       summary: delete an existing lag-link
30288       description: delete an existing lag-link
30289       operationId: deleteNetworkLagLinksLagLink
30290       consumes:
30291         - application/json
30292         - application/xml
30293       produces:
30294         - application/json
30295         - application/xml
30296       responses:
30297         "default":
30298           description: Response codes found in [response codes](https://wiki.onap.org/).
30299       parameters:
30300         - name: link-name
30301           in: path
30302           description: Alphabetical concatenation of lag-interface names
30303           required: true
30304           type: string
30305           example: __LINK-NAME__
30306         - name: resource-version
30307           in: query
30308           description: resource-version for concurrency
30309           required: true
30310           type: string
30311   /network/lag-links:
30312     get:
30313       tags:
30314         - Network
30315       summary: returns lag-links
30316       description: returns lag-links
30317       operationId: getNetworkLagLinks
30318       produces:
30319         - application/json
30320         - application/xml
30321       responses:
30322         "200":
30323           description: successful operation
30324           schema:
30325               $ref: "#/getDefinitions/lag-links"
30326         "default":
30327           description: Response codes found in [response codes](https://wiki.onap.org/).
30328       parameters:
30329         - name: link-name
30330           in: query
30331           description:
30332           required: false
30333           type: string
30334   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
30335     put:
30336       tags:
30337         - Network
30338       summary: see node definition for valid relationships
30339       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
30340       consumes:
30341         - application/json
30342         - application/xml
30343       produces:
30344         - application/json
30345         - application/xml
30346       responses:
30347         "default":
30348           description: Response codes found in [response codes](https://wiki.onap.org/).
30349       parameters:
30350         - name: vnf-id2
30351           in: path
30352           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30353           required: true
30354           type: string
30355           example: __VNF-ID2__
30356         - name: body
30357           in: body
30358           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
30359           required: true
30360           schema:
30361             $ref: "#/definitions/relationship"
30362     delete:
30363       tags:
30364         - Network
30365       summary: delete an existing relationship
30366       description: delete an existing relationship
30367       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
30368       consumes:
30369         - application/json
30370         - application/xml
30371       produces:
30372         - application/json
30373         - application/xml
30374       responses:
30375         "default":
30376           description: Response codes found in [response codes](https://wiki.onap.org/).
30377       parameters:
30378         - name: vnf-id2
30379           in: path
30380           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30381           required: true
30382           type: string
30383           example: __VNF-ID2__
30384   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30385     put:
30386       tags:
30387         - Network
30388       summary: see node definition for valid relationships
30389       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30390       consumes:
30391         - application/json
30392         - application/xml
30393       produces:
30394         - application/json
30395         - application/xml
30396       responses:
30397         "default":
30398           description: Response codes found in [response codes](https://wiki.onap.org/).
30399       parameters:
30400         - name: vnf-id2
30401           in: path
30402           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30403           required: true
30404           type: string
30405           example: __VNF-ID2__
30406         - name: interface-name
30407           in: path
30408           description: Name given to the interface
30409           required: true
30410           type: string
30411           example: __INTERFACE-NAME__
30412         - name: vlan-interface
30413           in: path
30414           description: String that identifies the interface
30415           required: true
30416           type: string
30417           example: __VLAN-INTERFACE__
30418         - name: body
30419           in: body
30420           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
30421           required: true
30422           schema:
30423             $ref: "#/definitions/relationship"
30424     delete:
30425       tags:
30426         - Network
30427       summary: delete an existing relationship
30428       description: delete an existing relationship
30429       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30430       consumes:
30431         - application/json
30432         - application/xml
30433       produces:
30434         - application/json
30435         - application/xml
30436       responses:
30437         "default":
30438           description: Response codes found in [response codes](https://wiki.onap.org/).
30439       parameters:
30440         - name: vnf-id2
30441           in: path
30442           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30443           required: true
30444           type: string
30445           example: __VNF-ID2__
30446         - name: interface-name
30447           in: path
30448           description: Name given to the interface
30449           required: true
30450           type: string
30451           example: __INTERFACE-NAME__
30452         - name: vlan-interface
30453           in: path
30454           description: String that identifies the interface
30455           required: true
30456           type: string
30457           example: __VLAN-INTERFACE__
30458   /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:
30459     put:
30460       tags:
30461         - Network
30462       summary: see node definition for valid relationships
30463       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30464       consumes:
30465         - application/json
30466         - application/xml
30467       produces:
30468         - application/json
30469         - application/xml
30470       responses:
30471         "default":
30472           description: Response codes found in [response codes](https://wiki.onap.org/).
30473       parameters:
30474         - name: vnf-id2
30475           in: path
30476           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30477           required: true
30478           type: string
30479           example: __VNF-ID2__
30480         - name: interface-name
30481           in: path
30482           description: Name given to the interface
30483           required: true
30484           type: string
30485           example: __INTERFACE-NAME__
30486         - name: vlan-interface
30487           in: path
30488           description: String that identifies the interface
30489           required: true
30490           type: string
30491           example: __VLAN-INTERFACE__
30492         - name: l3-interface-ipv4-address
30493           in: path
30494           description: IP address
30495           required: true
30496           type: string
30497           example: __L3-INTERFACE-IPV4-ADDRESS__
30498         - name: body
30499           in: body
30500           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30501           required: true
30502           schema:
30503             $ref: "#/definitions/relationship"
30504     delete:
30505       tags:
30506         - Network
30507       summary: delete an existing relationship
30508       description: delete an existing relationship
30509       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30510       consumes:
30511         - application/json
30512         - application/xml
30513       produces:
30514         - application/json
30515         - application/xml
30516       responses:
30517         "default":
30518           description: Response codes found in [response codes](https://wiki.onap.org/).
30519       parameters:
30520         - name: vnf-id2
30521           in: path
30522           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30523           required: true
30524           type: string
30525           example: __VNF-ID2__
30526         - name: interface-name
30527           in: path
30528           description: Name given to the interface
30529           required: true
30530           type: string
30531           example: __INTERFACE-NAME__
30532         - name: vlan-interface
30533           in: path
30534           description: String that identifies the interface
30535           required: true
30536           type: string
30537           example: __VLAN-INTERFACE__
30538         - name: l3-interface-ipv4-address
30539           in: path
30540           description: IP address
30541           required: true
30542           type: string
30543           example: __L3-INTERFACE-IPV4-ADDRESS__
30544   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
30545     get:
30546       tags:
30547         - Network
30548       summary: returns l3-interface-ipv4-address-list
30549       description: returns l3-interface-ipv4-address-list
30550       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30551       produces:
30552         - application/json
30553         - application/xml
30554       responses:
30555         "200":
30556           description: successful operation
30557           schema:
30558               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30559         "default":
30560           description: Response codes found in [response codes](https://wiki.onap.org/).
30561       parameters:
30562         - name: vnf-id2
30563           in: path
30564           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30565           required: true
30566           type: string
30567           example: __VNF-ID2__
30568         - name: interface-name
30569           in: path
30570           description: Name given to the interface
30571           required: true
30572           type: string
30573           example: __INTERFACE-NAME__
30574         - name: vlan-interface
30575           in: path
30576           description: String that identifies the interface
30577           required: true
30578           type: string
30579           example: __VLAN-INTERFACE__
30580         - name: l3-interface-ipv4-address
30581           in: path
30582           description: IP address
30583           required: true
30584           type: string
30585           example: __L3-INTERFACE-IPV4-ADDRESS__
30586     put:
30587       tags:
30588         - Network
30589       summary: create or update an existing l3-interface-ipv4-address-list
30590       description: |
30591         Create or update an existing l3-interface-ipv4-address-list.
30592         #
30593         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30594       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30595       consumes:
30596         - application/json
30597         - application/xml
30598       produces:
30599         - application/json
30600         - application/xml
30601       responses:
30602         "default":
30603           description: Response codes found in [response codes](https://wiki.onap.org/).
30604       parameters:
30605         - name: vnf-id2
30606           in: path
30607           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30608           required: true
30609           type: string
30610           example: __VNF-ID2__
30611         - name: interface-name
30612           in: path
30613           description: Name given to the interface
30614           required: true
30615           type: string
30616           example: __INTERFACE-NAME__
30617         - name: vlan-interface
30618           in: path
30619           description: String that identifies the interface
30620           required: true
30621           type: string
30622           example: __VLAN-INTERFACE__
30623         - name: l3-interface-ipv4-address
30624           in: path
30625           description: IP address
30626           required: true
30627           type: string
30628           example: __L3-INTERFACE-IPV4-ADDRESS__
30629         - name: body
30630           in: body
30631           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30632           required: true
30633           schema:
30634             $ref: "#/definitions/l3-interface-ipv4-address-list"
30635     patch:
30636       tags:
30637         - Network
30638       summary: update an existing l3-interface-ipv4-address-list
30639       description: |
30640         Update an existing l3-interface-ipv4-address-list
30641         #
30642         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30643         The PUT operation will entirely replace an existing object.
30644         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30645         #
30646         Other differences between PUT and PATCH are:
30647         #
30648         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30649         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30650         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30651       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30652       consumes:
30653         - application/json
30654         - application/xml
30655       produces:
30656         - application/json
30657         - application/xml
30658       responses:
30659         "default":
30660           description: Response codes found in [response codes](https://wiki.onap.org/).
30661       parameters:
30662         - name: vnf-id2
30663           in: path
30664           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30665           required: true
30666           type: string
30667           example: __VNF-ID2__
30668         - name: interface-name
30669           in: path
30670           description: Name given to the interface
30671           required: true
30672           type: string
30673           example: __INTERFACE-NAME__
30674         - name: vlan-interface
30675           in: path
30676           description: String that identifies the interface
30677           required: true
30678           type: string
30679           example: __VLAN-INTERFACE__
30680         - name: l3-interface-ipv4-address
30681           in: path
30682           description: IP address
30683           required: true
30684           type: string
30685           example: __L3-INTERFACE-IPV4-ADDRESS__
30686         - name: body
30687           in: body
30688           description: l3-interface-ipv4-address-list object that needs to be updated.
30689           required: true
30690           schema:
30691             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30692     delete:
30693       tags:
30694         - Network
30695       summary: delete an existing l3-interface-ipv4-address-list
30696       description: delete an existing l3-interface-ipv4-address-list
30697       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30698       consumes:
30699         - application/json
30700         - application/xml
30701       produces:
30702         - application/json
30703         - application/xml
30704       responses:
30705         "default":
30706           description: Response codes found in [response codes](https://wiki.onap.org/).
30707       parameters:
30708         - name: vnf-id2
30709           in: path
30710           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30711           required: true
30712           type: string
30713           example: __VNF-ID2__
30714         - name: interface-name
30715           in: path
30716           description: Name given to the interface
30717           required: true
30718           type: string
30719           example: __INTERFACE-NAME__
30720         - name: vlan-interface
30721           in: path
30722           description: String that identifies the interface
30723           required: true
30724           type: string
30725           example: __VLAN-INTERFACE__
30726         - name: l3-interface-ipv4-address
30727           in: path
30728           description: IP address
30729           required: true
30730           type: string
30731           example: __L3-INTERFACE-IPV4-ADDRESS__
30732         - name: resource-version
30733           in: query
30734           description: resource-version for concurrency
30735           required: true
30736           type: string
30737   /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:
30738     put:
30739       tags:
30740         - Network
30741       summary: see node definition for valid relationships
30742       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30743       consumes:
30744         - application/json
30745         - application/xml
30746       produces:
30747         - application/json
30748         - application/xml
30749       responses:
30750         "default":
30751           description: Response codes found in [response codes](https://wiki.onap.org/).
30752       parameters:
30753         - name: vnf-id2
30754           in: path
30755           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30756           required: true
30757           type: string
30758           example: __VNF-ID2__
30759         - name: interface-name
30760           in: path
30761           description: Name given to the interface
30762           required: true
30763           type: string
30764           example: __INTERFACE-NAME__
30765         - name: vlan-interface
30766           in: path
30767           description: String that identifies the interface
30768           required: true
30769           type: string
30770           example: __VLAN-INTERFACE__
30771         - name: l3-interface-ipv6-address
30772           in: path
30773           description: IP address
30774           required: true
30775           type: string
30776           example: __L3-INTERFACE-IPV6-ADDRESS__
30777         - name: body
30778           in: body
30779           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30780           required: true
30781           schema:
30782             $ref: "#/definitions/relationship"
30783     delete:
30784       tags:
30785         - Network
30786       summary: delete an existing relationship
30787       description: delete an existing relationship
30788       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30789       consumes:
30790         - application/json
30791         - application/xml
30792       produces:
30793         - application/json
30794         - application/xml
30795       responses:
30796         "default":
30797           description: Response codes found in [response codes](https://wiki.onap.org/).
30798       parameters:
30799         - name: vnf-id2
30800           in: path
30801           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30802           required: true
30803           type: string
30804           example: __VNF-ID2__
30805         - name: interface-name
30806           in: path
30807           description: Name given to the interface
30808           required: true
30809           type: string
30810           example: __INTERFACE-NAME__
30811         - name: vlan-interface
30812           in: path
30813           description: String that identifies the interface
30814           required: true
30815           type: string
30816           example: __VLAN-INTERFACE__
30817         - name: l3-interface-ipv6-address
30818           in: path
30819           description: IP address
30820           required: true
30821           type: string
30822           example: __L3-INTERFACE-IPV6-ADDRESS__
30823   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
30824     get:
30825       tags:
30826         - Network
30827       summary: returns l3-interface-ipv6-address-list
30828       description: returns l3-interface-ipv6-address-list
30829       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30830       produces:
30831         - application/json
30832         - application/xml
30833       responses:
30834         "200":
30835           description: successful operation
30836           schema:
30837               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30838         "default":
30839           description: Response codes found in [response codes](https://wiki.onap.org/).
30840       parameters:
30841         - name: vnf-id2
30842           in: path
30843           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30844           required: true
30845           type: string
30846           example: __VNF-ID2__
30847         - name: interface-name
30848           in: path
30849           description: Name given to the interface
30850           required: true
30851           type: string
30852           example: __INTERFACE-NAME__
30853         - name: vlan-interface
30854           in: path
30855           description: String that identifies the interface
30856           required: true
30857           type: string
30858           example: __VLAN-INTERFACE__
30859         - name: l3-interface-ipv6-address
30860           in: path
30861           description: IP address
30862           required: true
30863           type: string
30864           example: __L3-INTERFACE-IPV6-ADDRESS__
30865     put:
30866       tags:
30867         - Network
30868       summary: create or update an existing l3-interface-ipv6-address-list
30869       description: |
30870         Create or update an existing l3-interface-ipv6-address-list.
30871         #
30872         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30873       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30874       consumes:
30875         - application/json
30876         - application/xml
30877       produces:
30878         - application/json
30879         - application/xml
30880       responses:
30881         "default":
30882           description: Response codes found in [response codes](https://wiki.onap.org/).
30883       parameters:
30884         - name: vnf-id2
30885           in: path
30886           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30887           required: true
30888           type: string
30889           example: __VNF-ID2__
30890         - name: interface-name
30891           in: path
30892           description: Name given to the interface
30893           required: true
30894           type: string
30895           example: __INTERFACE-NAME__
30896         - name: vlan-interface
30897           in: path
30898           description: String that identifies the interface
30899           required: true
30900           type: string
30901           example: __VLAN-INTERFACE__
30902         - name: l3-interface-ipv6-address
30903           in: path
30904           description: IP address
30905           required: true
30906           type: string
30907           example: __L3-INTERFACE-IPV6-ADDRESS__
30908         - name: body
30909           in: body
30910           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30911           required: true
30912           schema:
30913             $ref: "#/definitions/l3-interface-ipv6-address-list"
30914     patch:
30915       tags:
30916         - Network
30917       summary: update an existing l3-interface-ipv6-address-list
30918       description: |
30919         Update an existing l3-interface-ipv6-address-list
30920         #
30921         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30922         The PUT operation will entirely replace an existing object.
30923         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30924         #
30925         Other differences between PUT and PATCH are:
30926         #
30927         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30928         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30929         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30930       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30931       consumes:
30932         - application/json
30933         - application/xml
30934       produces:
30935         - application/json
30936         - application/xml
30937       responses:
30938         "default":
30939           description: Response codes found in [response codes](https://wiki.onap.org/).
30940       parameters:
30941         - name: vnf-id2
30942           in: path
30943           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30944           required: true
30945           type: string
30946           example: __VNF-ID2__
30947         - name: interface-name
30948           in: path
30949           description: Name given to the interface
30950           required: true
30951           type: string
30952           example: __INTERFACE-NAME__
30953         - name: vlan-interface
30954           in: path
30955           description: String that identifies the interface
30956           required: true
30957           type: string
30958           example: __VLAN-INTERFACE__
30959         - name: l3-interface-ipv6-address
30960           in: path
30961           description: IP address
30962           required: true
30963           type: string
30964           example: __L3-INTERFACE-IPV6-ADDRESS__
30965         - name: body
30966           in: body
30967           description: l3-interface-ipv6-address-list object that needs to be updated.
30968           required: true
30969           schema:
30970             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30971     delete:
30972       tags:
30973         - Network
30974       summary: delete an existing l3-interface-ipv6-address-list
30975       description: delete an existing l3-interface-ipv6-address-list
30976       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30977       consumes:
30978         - application/json
30979         - application/xml
30980       produces:
30981         - application/json
30982         - application/xml
30983       responses:
30984         "default":
30985           description: Response codes found in [response codes](https://wiki.onap.org/).
30986       parameters:
30987         - name: vnf-id2
30988           in: path
30989           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30990           required: true
30991           type: string
30992           example: __VNF-ID2__
30993         - name: interface-name
30994           in: path
30995           description: Name given to the interface
30996           required: true
30997           type: string
30998           example: __INTERFACE-NAME__
30999         - name: vlan-interface
31000           in: path
31001           description: String that identifies the interface
31002           required: true
31003           type: string
31004           example: __VLAN-INTERFACE__
31005         - name: l3-interface-ipv6-address
31006           in: path
31007           description: IP address
31008           required: true
31009           type: string
31010           example: __L3-INTERFACE-IPV6-ADDRESS__
31011         - name: resource-version
31012           in: query
31013           description: resource-version for concurrency
31014           required: true
31015           type: string
31016   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31017     get:
31018       tags:
31019         - Network
31020       summary: returns vlan
31021       description: returns vlan
31022       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31023       produces:
31024         - application/json
31025         - application/xml
31026       responses:
31027         "200":
31028           description: successful operation
31029           schema:
31030               $ref: "#/getDefinitions/vlan"
31031         "default":
31032           description: Response codes found in [response codes](https://wiki.onap.org/).
31033       parameters:
31034         - name: vnf-id2
31035           in: path
31036           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31037           required: true
31038           type: string
31039           example: __VNF-ID2__
31040         - name: interface-name
31041           in: path
31042           description: Name given to the interface
31043           required: true
31044           type: string
31045           example: __INTERFACE-NAME__
31046         - name: vlan-interface
31047           in: path
31048           description: String that identifies the interface
31049           required: true
31050           type: string
31051           example: __VLAN-INTERFACE__
31052     put:
31053       tags:
31054         - Network
31055       summary: create or update an existing vlan
31056       description: |
31057         Create or update an existing vlan.
31058         #
31059         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31060       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31061       consumes:
31062         - application/json
31063         - application/xml
31064       produces:
31065         - application/json
31066         - application/xml
31067       responses:
31068         "default":
31069           description: Response codes found in [response codes](https://wiki.onap.org/).
31070       parameters:
31071         - name: vnf-id2
31072           in: path
31073           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31074           required: true
31075           type: string
31076           example: __VNF-ID2__
31077         - name: interface-name
31078           in: path
31079           description: Name given to the interface
31080           required: true
31081           type: string
31082           example: __INTERFACE-NAME__
31083         - name: vlan-interface
31084           in: path
31085           description: String that identifies the interface
31086           required: true
31087           type: string
31088           example: __VLAN-INTERFACE__
31089         - name: body
31090           in: body
31091           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
31092           required: true
31093           schema:
31094             $ref: "#/definitions/vlan"
31095     patch:
31096       tags:
31097         - Network
31098       summary: update an existing vlan
31099       description: |
31100         Update an existing vlan
31101         #
31102         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31103         The PUT operation will entirely replace an existing object.
31104         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31105         #
31106         Other differences between PUT and PATCH are:
31107         #
31108         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31109         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31110         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31111       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31112       consumes:
31113         - application/json
31114         - application/xml
31115       produces:
31116         - application/json
31117         - application/xml
31118       responses:
31119         "default":
31120           description: Response codes found in [response codes](https://wiki.onap.org/).
31121       parameters:
31122         - name: vnf-id2
31123           in: path
31124           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31125           required: true
31126           type: string
31127           example: __VNF-ID2__
31128         - name: interface-name
31129           in: path
31130           description: Name given to the interface
31131           required: true
31132           type: string
31133           example: __INTERFACE-NAME__
31134         - name: vlan-interface
31135           in: path
31136           description: String that identifies the interface
31137           required: true
31138           type: string
31139           example: __VLAN-INTERFACE__
31140         - name: body
31141           in: body
31142           description: vlan object that needs to be updated.
31143           required: true
31144           schema:
31145             $ref: "#/patchDefinitions/vlan"
31146     delete:
31147       tags:
31148         - Network
31149       summary: delete an existing vlan
31150       description: delete an existing vlan
31151       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31152       consumes:
31153         - application/json
31154         - application/xml
31155       produces:
31156         - application/json
31157         - application/xml
31158       responses:
31159         "default":
31160           description: Response codes found in [response codes](https://wiki.onap.org/).
31161       parameters:
31162         - name: vnf-id2
31163           in: path
31164           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31165           required: true
31166           type: string
31167           example: __VNF-ID2__
31168         - name: interface-name
31169           in: path
31170           description: Name given to the interface
31171           required: true
31172           type: string
31173           example: __INTERFACE-NAME__
31174         - name: vlan-interface
31175           in: path
31176           description: String that identifies the interface
31177           required: true
31178           type: string
31179           example: __VLAN-INTERFACE__
31180         - name: resource-version
31181           in: query
31182           description: resource-version for concurrency
31183           required: true
31184           type: string
31185   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
31186     get:
31187       tags:
31188         - Network
31189       summary: returns vlans
31190       description: returns vlans
31191       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
31192       produces:
31193         - application/json
31194         - application/xml
31195       responses:
31196         "200":
31197           description: successful operation
31198           schema:
31199               $ref: "#/getDefinitions/vlans"
31200         "default":
31201           description: Response codes found in [response codes](https://wiki.onap.org/).
31202       parameters:
31203         - name: vnf-id2
31204           in: path
31205           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31206           required: true
31207           type: string
31208           example: __VNF-ID2__
31209         - name: interface-name
31210           in: path
31211           description: Name given to the interface
31212           required: true
31213           type: string
31214           example: __INTERFACE-NAME__
31215         - name: vlan-interface
31216           in: query
31217           description:
31218           required: false
31219           type: string
31220         - name: vlan-id-inner
31221           in: query
31222           description:
31223           required: false
31224           type: integer
31225           format: int64
31226         - name: vpn-id
31227           in: query
31228           description:
31229           required: false
31230           type: string
31231   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31232     put:
31233       tags:
31234         - Network
31235       summary: see node definition for valid relationships
31236       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31237       consumes:
31238         - application/json
31239         - application/xml
31240       produces:
31241         - application/json
31242         - application/xml
31243       responses:
31244         "default":
31245           description: Response codes found in [response codes](https://wiki.onap.org/).
31246       parameters:
31247         - name: vnf-id2
31248           in: path
31249           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31250           required: true
31251           type: string
31252           example: __VNF-ID2__
31253         - name: interface-name
31254           in: path
31255           description: Name given to the interface
31256           required: true
31257           type: string
31258           example: __INTERFACE-NAME__
31259         - name: pci-id
31260           in: path
31261           description: PCI ID used to identify the sriov-vf
31262           required: true
31263           type: string
31264           example: __PCI-ID__
31265         - name: body
31266           in: body
31267           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
31268           required: true
31269           schema:
31270             $ref: "#/definitions/relationship"
31271     delete:
31272       tags:
31273         - Network
31274       summary: delete an existing relationship
31275       description: delete an existing relationship
31276       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31277       consumes:
31278         - application/json
31279         - application/xml
31280       produces:
31281         - application/json
31282         - application/xml
31283       responses:
31284         "default":
31285           description: Response codes found in [response codes](https://wiki.onap.org/).
31286       parameters:
31287         - name: vnf-id2
31288           in: path
31289           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31290           required: true
31291           type: string
31292           example: __VNF-ID2__
31293         - name: interface-name
31294           in: path
31295           description: Name given to the interface
31296           required: true
31297           type: string
31298           example: __INTERFACE-NAME__
31299         - name: pci-id
31300           in: path
31301           description: PCI ID used to identify the sriov-vf
31302           required: true
31303           type: string
31304           example: __PCI-ID__
31305   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31306     get:
31307       tags:
31308         - Network
31309       summary: returns sriov-vf
31310       description: returns sriov-vf
31311       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31312       produces:
31313         - application/json
31314         - application/xml
31315       responses:
31316         "200":
31317           description: successful operation
31318           schema:
31319               $ref: "#/getDefinitions/sriov-vf"
31320         "default":
31321           description: Response codes found in [response codes](https://wiki.onap.org/).
31322       parameters:
31323         - name: vnf-id2
31324           in: path
31325           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31326           required: true
31327           type: string
31328           example: __VNF-ID2__
31329         - name: interface-name
31330           in: path
31331           description: Name given to the interface
31332           required: true
31333           type: string
31334           example: __INTERFACE-NAME__
31335         - name: pci-id
31336           in: path
31337           description: PCI ID used to identify the sriov-vf
31338           required: true
31339           type: string
31340           example: __PCI-ID__
31341     put:
31342       tags:
31343         - Network
31344       summary: create or update an existing sriov-vf
31345       description: |
31346         Create or update an existing sriov-vf.
31347         #
31348         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31349       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31350       consumes:
31351         - application/json
31352         - application/xml
31353       produces:
31354         - application/json
31355         - application/xml
31356       responses:
31357         "default":
31358           description: Response codes found in [response codes](https://wiki.onap.org/).
31359       parameters:
31360         - name: vnf-id2
31361           in: path
31362           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31363           required: true
31364           type: string
31365           example: __VNF-ID2__
31366         - name: interface-name
31367           in: path
31368           description: Name given to the interface
31369           required: true
31370           type: string
31371           example: __INTERFACE-NAME__
31372         - name: pci-id
31373           in: path
31374           description: PCI ID used to identify the sriov-vf
31375           required: true
31376           type: string
31377           example: __PCI-ID__
31378         - name: body
31379           in: body
31380           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
31381           required: true
31382           schema:
31383             $ref: "#/definitions/sriov-vf"
31384     patch:
31385       tags:
31386         - Network
31387       summary: update an existing sriov-vf
31388       description: |
31389         Update an existing sriov-vf
31390         #
31391         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31392         The PUT operation will entirely replace an existing object.
31393         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31394         #
31395         Other differences between PUT and PATCH are:
31396         #
31397         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31398         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31399         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31400       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31401       consumes:
31402         - application/json
31403         - application/xml
31404       produces:
31405         - application/json
31406         - application/xml
31407       responses:
31408         "default":
31409           description: Response codes found in [response codes](https://wiki.onap.org/).
31410       parameters:
31411         - name: vnf-id2
31412           in: path
31413           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31414           required: true
31415           type: string
31416           example: __VNF-ID2__
31417         - name: interface-name
31418           in: path
31419           description: Name given to the interface
31420           required: true
31421           type: string
31422           example: __INTERFACE-NAME__
31423         - name: pci-id
31424           in: path
31425           description: PCI ID used to identify the sriov-vf
31426           required: true
31427           type: string
31428           example: __PCI-ID__
31429         - name: body
31430           in: body
31431           description: sriov-vf object that needs to be updated.
31432           required: true
31433           schema:
31434             $ref: "#/patchDefinitions/sriov-vf"
31435     delete:
31436       tags:
31437         - Network
31438       summary: delete an existing sriov-vf
31439       description: delete an existing sriov-vf
31440       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31441       consumes:
31442         - application/json
31443         - application/xml
31444       produces:
31445         - application/json
31446         - application/xml
31447       responses:
31448         "default":
31449           description: Response codes found in [response codes](https://wiki.onap.org/).
31450       parameters:
31451         - name: vnf-id2
31452           in: path
31453           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31454           required: true
31455           type: string
31456           example: __VNF-ID2__
31457         - name: interface-name
31458           in: path
31459           description: Name given to the interface
31460           required: true
31461           type: string
31462           example: __INTERFACE-NAME__
31463         - name: pci-id
31464           in: path
31465           description: PCI ID used to identify the sriov-vf
31466           required: true
31467           type: string
31468           example: __PCI-ID__
31469         - name: resource-version
31470           in: query
31471           description: resource-version for concurrency
31472           required: true
31473           type: string
31474   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
31475     get:
31476       tags:
31477         - Network
31478       summary: returns sriov-vfs
31479       description: returns sriov-vfs
31480       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
31481       produces:
31482         - application/json
31483         - application/xml
31484       responses:
31485         "200":
31486           description: successful operation
31487           schema:
31488               $ref: "#/getDefinitions/sriov-vfs"
31489         "default":
31490           description: Response codes found in [response codes](https://wiki.onap.org/).
31491       parameters:
31492         - name: vnf-id2
31493           in: path
31494           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31495           required: true
31496           type: string
31497           example: __VNF-ID2__
31498         - name: interface-name
31499           in: path
31500           description: Name given to the interface
31501           required: true
31502           type: string
31503           example: __INTERFACE-NAME__
31504         - name: pci-id
31505           in: query
31506           description:
31507           required: false
31508           type: string
31509         - name: vf-vlan-filter
31510           in: query
31511           description:
31512           required: false
31513           type: string
31514         - name: vf-mac-filter
31515           in: query
31516           description:
31517           required: false
31518           type: string
31519         - name: vf-vlan-strip
31520           in: query
31521           description:
31522           required: false
31523           type: boolean
31524         - name: neutron-network-id
31525           in: query
31526           description:
31527           required: false
31528           type: string
31529   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
31530     put:
31531       tags:
31532         - Network
31533       summary: see node definition for valid relationships
31534       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
31535       consumes:
31536         - application/json
31537         - application/xml
31538       produces:
31539         - application/json
31540         - application/xml
31541       responses:
31542         "default":
31543           description: Response codes found in [response codes](https://wiki.onap.org/).
31544       parameters:
31545         - name: vnf-id2
31546           in: path
31547           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31548           required: true
31549           type: string
31550           example: __VNF-ID2__
31551         - name: interface-name
31552           in: path
31553           description: Name given to the interface
31554           required: true
31555           type: string
31556           example: __INTERFACE-NAME__
31557         - name: body
31558           in: body
31559           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
31560           required: true
31561           schema:
31562             $ref: "#/definitions/relationship"
31563     delete:
31564       tags:
31565         - Network
31566       summary: delete an existing relationship
31567       description: delete an existing relationship
31568       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
31569       consumes:
31570         - application/json
31571         - application/xml
31572       produces:
31573         - application/json
31574         - application/xml
31575       responses:
31576         "default":
31577           description: Response codes found in [response codes](https://wiki.onap.org/).
31578       parameters:
31579         - name: vnf-id2
31580           in: path
31581           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31582           required: true
31583           type: string
31584           example: __VNF-ID2__
31585         - name: interface-name
31586           in: path
31587           description: Name given to the interface
31588           required: true
31589           type: string
31590           example: __INTERFACE-NAME__
31591   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31592     put:
31593       tags:
31594         - Network
31595       summary: see node definition for valid relationships
31596       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31597       consumes:
31598         - application/json
31599         - application/xml
31600       produces:
31601         - application/json
31602         - application/xml
31603       responses:
31604         "default":
31605           description: Response codes found in [response codes](https://wiki.onap.org/).
31606       parameters:
31607         - name: vnf-id2
31608           in: path
31609           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31610           required: true
31611           type: string
31612           example: __VNF-ID2__
31613         - name: interface-name
31614           in: path
31615           description: Name given to the interface
31616           required: true
31617           type: string
31618           example: __INTERFACE-NAME__
31619         - name: l3-interface-ipv4-address
31620           in: path
31621           description: IP address
31622           required: true
31623           type: string
31624           example: __L3-INTERFACE-IPV4-ADDRESS__
31625         - name: body
31626           in: body
31627           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31628           required: true
31629           schema:
31630             $ref: "#/definitions/relationship"
31631     delete:
31632       tags:
31633         - Network
31634       summary: delete an existing relationship
31635       description: delete an existing relationship
31636       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31637       consumes:
31638         - application/json
31639         - application/xml
31640       produces:
31641         - application/json
31642         - application/xml
31643       responses:
31644         "default":
31645           description: Response codes found in [response codes](https://wiki.onap.org/).
31646       parameters:
31647         - name: vnf-id2
31648           in: path
31649           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31650           required: true
31651           type: string
31652           example: __VNF-ID2__
31653         - name: interface-name
31654           in: path
31655           description: Name given to the interface
31656           required: true
31657           type: string
31658           example: __INTERFACE-NAME__
31659         - name: l3-interface-ipv4-address
31660           in: path
31661           description: IP address
31662           required: true
31663           type: string
31664           example: __L3-INTERFACE-IPV4-ADDRESS__
31665   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31666     get:
31667       tags:
31668         - Network
31669       summary: returns l3-interface-ipv4-address-list
31670       description: returns l3-interface-ipv4-address-list
31671       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31672       produces:
31673         - application/json
31674         - application/xml
31675       responses:
31676         "200":
31677           description: successful operation
31678           schema:
31679               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31680         "default":
31681           description: Response codes found in [response codes](https://wiki.onap.org/).
31682       parameters:
31683         - name: vnf-id2
31684           in: path
31685           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31686           required: true
31687           type: string
31688           example: __VNF-ID2__
31689         - name: interface-name
31690           in: path
31691           description: Name given to the interface
31692           required: true
31693           type: string
31694           example: __INTERFACE-NAME__
31695         - name: l3-interface-ipv4-address
31696           in: path
31697           description: IP address
31698           required: true
31699           type: string
31700           example: __L3-INTERFACE-IPV4-ADDRESS__
31701     put:
31702       tags:
31703         - Network
31704       summary: create or update an existing l3-interface-ipv4-address-list
31705       description: |
31706         Create or update an existing l3-interface-ipv4-address-list.
31707         #
31708         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31709       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31710       consumes:
31711         - application/json
31712         - application/xml
31713       produces:
31714         - application/json
31715         - application/xml
31716       responses:
31717         "default":
31718           description: Response codes found in [response codes](https://wiki.onap.org/).
31719       parameters:
31720         - name: vnf-id2
31721           in: path
31722           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31723           required: true
31724           type: string
31725           example: __VNF-ID2__
31726         - name: interface-name
31727           in: path
31728           description: Name given to the interface
31729           required: true
31730           type: string
31731           example: __INTERFACE-NAME__
31732         - name: l3-interface-ipv4-address
31733           in: path
31734           description: IP address
31735           required: true
31736           type: string
31737           example: __L3-INTERFACE-IPV4-ADDRESS__
31738         - name: body
31739           in: body
31740           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31741           required: true
31742           schema:
31743             $ref: "#/definitions/l3-interface-ipv4-address-list"
31744     patch:
31745       tags:
31746         - Network
31747       summary: update an existing l3-interface-ipv4-address-list
31748       description: |
31749         Update an existing l3-interface-ipv4-address-list
31750         #
31751         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31752         The PUT operation will entirely replace an existing object.
31753         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31754         #
31755         Other differences between PUT and PATCH are:
31756         #
31757         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31758         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31759         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31760       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31761       consumes:
31762         - application/json
31763         - application/xml
31764       produces:
31765         - application/json
31766         - application/xml
31767       responses:
31768         "default":
31769           description: Response codes found in [response codes](https://wiki.onap.org/).
31770       parameters:
31771         - name: vnf-id2
31772           in: path
31773           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31774           required: true
31775           type: string
31776           example: __VNF-ID2__
31777         - name: interface-name
31778           in: path
31779           description: Name given to the interface
31780           required: true
31781           type: string
31782           example: __INTERFACE-NAME__
31783         - name: l3-interface-ipv4-address
31784           in: path
31785           description: IP address
31786           required: true
31787           type: string
31788           example: __L3-INTERFACE-IPV4-ADDRESS__
31789         - name: body
31790           in: body
31791           description: l3-interface-ipv4-address-list object that needs to be updated.
31792           required: true
31793           schema:
31794             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31795     delete:
31796       tags:
31797         - Network
31798       summary: delete an existing l3-interface-ipv4-address-list
31799       description: delete an existing l3-interface-ipv4-address-list
31800       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31801       consumes:
31802         - application/json
31803         - application/xml
31804       produces:
31805         - application/json
31806         - application/xml
31807       responses:
31808         "default":
31809           description: Response codes found in [response codes](https://wiki.onap.org/).
31810       parameters:
31811         - name: vnf-id2
31812           in: path
31813           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31814           required: true
31815           type: string
31816           example: __VNF-ID2__
31817         - name: interface-name
31818           in: path
31819           description: Name given to the interface
31820           required: true
31821           type: string
31822           example: __INTERFACE-NAME__
31823         - name: l3-interface-ipv4-address
31824           in: path
31825           description: IP address
31826           required: true
31827           type: string
31828           example: __L3-INTERFACE-IPV4-ADDRESS__
31829         - name: resource-version
31830           in: query
31831           description: resource-version for concurrency
31832           required: true
31833           type: string
31834   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31835     put:
31836       tags:
31837         - Network
31838       summary: see node definition for valid relationships
31839       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31840       consumes:
31841         - application/json
31842         - application/xml
31843       produces:
31844         - application/json
31845         - application/xml
31846       responses:
31847         "default":
31848           description: Response codes found in [response codes](https://wiki.onap.org/).
31849       parameters:
31850         - name: vnf-id2
31851           in: path
31852           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31853           required: true
31854           type: string
31855           example: __VNF-ID2__
31856         - name: interface-name
31857           in: path
31858           description: Name given to the interface
31859           required: true
31860           type: string
31861           example: __INTERFACE-NAME__
31862         - name: l3-interface-ipv6-address
31863           in: path
31864           description: IP address
31865           required: true
31866           type: string
31867           example: __L3-INTERFACE-IPV6-ADDRESS__
31868         - name: body
31869           in: body
31870           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31871           required: true
31872           schema:
31873             $ref: "#/definitions/relationship"
31874     delete:
31875       tags:
31876         - Network
31877       summary: delete an existing relationship
31878       description: delete an existing relationship
31879       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31880       consumes:
31881         - application/json
31882         - application/xml
31883       produces:
31884         - application/json
31885         - application/xml
31886       responses:
31887         "default":
31888           description: Response codes found in [response codes](https://wiki.onap.org/).
31889       parameters:
31890         - name: vnf-id2
31891           in: path
31892           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31893           required: true
31894           type: string
31895           example: __VNF-ID2__
31896         - name: interface-name
31897           in: path
31898           description: Name given to the interface
31899           required: true
31900           type: string
31901           example: __INTERFACE-NAME__
31902         - name: l3-interface-ipv6-address
31903           in: path
31904           description: IP address
31905           required: true
31906           type: string
31907           example: __L3-INTERFACE-IPV6-ADDRESS__
31908   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31909     get:
31910       tags:
31911         - Network
31912       summary: returns l3-interface-ipv6-address-list
31913       description: returns l3-interface-ipv6-address-list
31914       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31915       produces:
31916         - application/json
31917         - application/xml
31918       responses:
31919         "200":
31920           description: successful operation
31921           schema:
31922               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31923         "default":
31924           description: Response codes found in [response codes](https://wiki.onap.org/).
31925       parameters:
31926         - name: vnf-id2
31927           in: path
31928           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31929           required: true
31930           type: string
31931           example: __VNF-ID2__
31932         - name: interface-name
31933           in: path
31934           description: Name given to the interface
31935           required: true
31936           type: string
31937           example: __INTERFACE-NAME__
31938         - name: l3-interface-ipv6-address
31939           in: path
31940           description: IP address
31941           required: true
31942           type: string
31943           example: __L3-INTERFACE-IPV6-ADDRESS__
31944     put:
31945       tags:
31946         - Network
31947       summary: create or update an existing l3-interface-ipv6-address-list
31948       description: |
31949         Create or update an existing l3-interface-ipv6-address-list.
31950         #
31951         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31952       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31953       consumes:
31954         - application/json
31955         - application/xml
31956       produces:
31957         - application/json
31958         - application/xml
31959       responses:
31960         "default":
31961           description: Response codes found in [response codes](https://wiki.onap.org/).
31962       parameters:
31963         - name: vnf-id2
31964           in: path
31965           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31966           required: true
31967           type: string
31968           example: __VNF-ID2__
31969         - name: interface-name
31970           in: path
31971           description: Name given to the interface
31972           required: true
31973           type: string
31974           example: __INTERFACE-NAME__
31975         - name: l3-interface-ipv6-address
31976           in: path
31977           description: IP address
31978           required: true
31979           type: string
31980           example: __L3-INTERFACE-IPV6-ADDRESS__
31981         - name: body
31982           in: body
31983           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31984           required: true
31985           schema:
31986             $ref: "#/definitions/l3-interface-ipv6-address-list"
31987     patch:
31988       tags:
31989         - Network
31990       summary: update an existing l3-interface-ipv6-address-list
31991       description: |
31992         Update an existing l3-interface-ipv6-address-list
31993         #
31994         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31995         The PUT operation will entirely replace an existing object.
31996         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31997         #
31998         Other differences between PUT and PATCH are:
31999         #
32000         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32001         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32002         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32003       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
32004       consumes:
32005         - application/json
32006         - application/xml
32007       produces:
32008         - application/json
32009         - application/xml
32010       responses:
32011         "default":
32012           description: Response codes found in [response codes](https://wiki.onap.org/).
32013       parameters:
32014         - name: vnf-id2
32015           in: path
32016           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32017           required: true
32018           type: string
32019           example: __VNF-ID2__
32020         - name: interface-name
32021           in: path
32022           description: Name given to the interface
32023           required: true
32024           type: string
32025           example: __INTERFACE-NAME__
32026         - name: l3-interface-ipv6-address
32027           in: path
32028           description: IP address
32029           required: true
32030           type: string
32031           example: __L3-INTERFACE-IPV6-ADDRESS__
32032         - name: body
32033           in: body
32034           description: l3-interface-ipv6-address-list object that needs to be updated.
32035           required: true
32036           schema:
32037             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32038     delete:
32039       tags:
32040         - Network
32041       summary: delete an existing l3-interface-ipv6-address-list
32042       description: delete an existing l3-interface-ipv6-address-list
32043       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
32044       consumes:
32045         - application/json
32046         - application/xml
32047       produces:
32048         - application/json
32049         - application/xml
32050       responses:
32051         "default":
32052           description: Response codes found in [response codes](https://wiki.onap.org/).
32053       parameters:
32054         - name: vnf-id2
32055           in: path
32056           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32057           required: true
32058           type: string
32059           example: __VNF-ID2__
32060         - name: interface-name
32061           in: path
32062           description: Name given to the interface
32063           required: true
32064           type: string
32065           example: __INTERFACE-NAME__
32066         - name: l3-interface-ipv6-address
32067           in: path
32068           description: IP address
32069           required: true
32070           type: string
32071           example: __L3-INTERFACE-IPV6-ADDRESS__
32072         - name: resource-version
32073           in: query
32074           description: resource-version for concurrency
32075           required: true
32076           type: string
32077   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
32078     get:
32079       tags:
32080         - Network
32081       summary: returns l-interface
32082       description: returns l-interface
32083       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
32084       produces:
32085         - application/json
32086         - application/xml
32087       responses:
32088         "200":
32089           description: successful operation
32090           schema:
32091               $ref: "#/getDefinitions/l-interface"
32092         "default":
32093           description: Response codes found in [response codes](https://wiki.onap.org/).
32094       parameters:
32095         - name: vnf-id2
32096           in: path
32097           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32098           required: true
32099           type: string
32100           example: __VNF-ID2__
32101         - name: interface-name
32102           in: path
32103           description: Name given to the interface
32104           required: true
32105           type: string
32106           example: __INTERFACE-NAME__
32107     put:
32108       tags:
32109         - Network
32110       summary: create or update an existing l-interface
32111       description: |
32112         Create or update an existing l-interface.
32113         #
32114         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32115       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
32116       consumes:
32117         - application/json
32118         - application/xml
32119       produces:
32120         - application/json
32121         - application/xml
32122       responses:
32123         "default":
32124           description: Response codes found in [response codes](https://wiki.onap.org/).
32125       parameters:
32126         - name: vnf-id2
32127           in: path
32128           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32129           required: true
32130           type: string
32131           example: __VNF-ID2__
32132         - name: interface-name
32133           in: path
32134           description: Name given to the interface
32135           required: true
32136           type: string
32137           example: __INTERFACE-NAME__
32138         - name: body
32139           in: body
32140           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
32141           required: true
32142           schema:
32143             $ref: "#/definitions/l-interface"
32144     patch:
32145       tags:
32146         - Network
32147       summary: update an existing l-interface
32148       description: |
32149         Update an existing l-interface
32150         #
32151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32152         The PUT operation will entirely replace an existing object.
32153         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32154         #
32155         Other differences between PUT and PATCH are:
32156         #
32157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32160       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
32161       consumes:
32162         - application/json
32163         - application/xml
32164       produces:
32165         - application/json
32166         - application/xml
32167       responses:
32168         "default":
32169           description: Response codes found in [response codes](https://wiki.onap.org/).
32170       parameters:
32171         - name: vnf-id2
32172           in: path
32173           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32174           required: true
32175           type: string
32176           example: __VNF-ID2__
32177         - name: interface-name
32178           in: path
32179           description: Name given to the interface
32180           required: true
32181           type: string
32182           example: __INTERFACE-NAME__
32183         - name: body
32184           in: body
32185           description: l-interface object that needs to be updated.
32186           required: true
32187           schema:
32188             $ref: "#/patchDefinitions/l-interface"
32189     delete:
32190       tags:
32191         - Network
32192       summary: delete an existing l-interface
32193       description: delete an existing l-interface
32194       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
32195       consumes:
32196         - application/json
32197         - application/xml
32198       produces:
32199         - application/json
32200         - application/xml
32201       responses:
32202         "default":
32203           description: Response codes found in [response codes](https://wiki.onap.org/).
32204       parameters:
32205         - name: vnf-id2
32206           in: path
32207           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32208           required: true
32209           type: string
32210           example: __VNF-ID2__
32211         - name: interface-name
32212           in: path
32213           description: Name given to the interface
32214           required: true
32215           type: string
32216           example: __INTERFACE-NAME__
32217         - name: resource-version
32218           in: query
32219           description: resource-version for concurrency
32220           required: true
32221           type: string
32222   /network/newvces/newvce/{vnf-id2}/l-interfaces:
32223     get:
32224       tags:
32225         - Network
32226       summary: returns l-interfaces
32227       description: returns l-interfaces
32228       operationId: getNetworkNewvcesNewvceLInterfaces
32229       produces:
32230         - application/json
32231         - application/xml
32232       responses:
32233         "200":
32234           description: successful operation
32235           schema:
32236               $ref: "#/getDefinitions/l-interfaces"
32237         "default":
32238           description: Response codes found in [response codes](https://wiki.onap.org/).
32239       parameters:
32240         - name: vnf-id2
32241           in: path
32242           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32243           required: true
32244           type: string
32245           example: __VNF-ID2__
32246         - name: interface-name
32247           in: query
32248           description:
32249           required: false
32250           type: string
32251         - name: interface-id
32252           in: query
32253           description:
32254           required: false
32255           type: string
32256         - name: macaddr
32257           in: query
32258           description:
32259           required: false
32260           type: string
32261         - name: network-name
32262           in: query
32263           description:
32264           required: false
32265           type: string
32266   /network/newvces/newvce/{vnf-id2}:
32267     get:
32268       tags:
32269         - Network
32270       summary: returns newvce
32271       description: returns newvce
32272       operationId: getNetworkNewvcesNewvce
32273       produces:
32274         - application/json
32275         - application/xml
32276       responses:
32277         "200":
32278           description: successful operation
32279           schema:
32280               $ref: "#/getDefinitions/newvce"
32281         "default":
32282           description: Response codes found in [response codes](https://wiki.onap.org/).
32283       parameters:
32284         - name: vnf-id2
32285           in: path
32286           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32287           required: true
32288           type: string
32289           example: __VNF-ID2__
32290     put:
32291       tags:
32292         - Network
32293       summary: create or update an existing newvce
32294       description: |
32295         Create or update an existing newvce.
32296         #
32297         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32298       operationId: createOrUpdateNetworkNewvcesNewvce
32299       consumes:
32300         - application/json
32301         - application/xml
32302       produces:
32303         - application/json
32304         - application/xml
32305       responses:
32306         "default":
32307           description: Response codes found in [response codes](https://wiki.onap.org/).
32308       parameters:
32309         - name: vnf-id2
32310           in: path
32311           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32312           required: true
32313           type: string
32314           example: __VNF-ID2__
32315         - name: body
32316           in: body
32317           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
32318           required: true
32319           schema:
32320             $ref: "#/definitions/newvce"
32321     patch:
32322       tags:
32323         - Network
32324       summary: update an existing newvce
32325       description: |
32326         Update an existing newvce
32327         #
32328         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32329         The PUT operation will entirely replace an existing object.
32330         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32331         #
32332         Other differences between PUT and PATCH are:
32333         #
32334         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32335         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32336         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32337       operationId: UpdateNetworkNewvcesNewvce
32338       consumes:
32339         - application/json
32340         - application/xml
32341       produces:
32342         - application/json
32343         - application/xml
32344       responses:
32345         "default":
32346           description: Response codes found in [response codes](https://wiki.onap.org/).
32347       parameters:
32348         - name: vnf-id2
32349           in: path
32350           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32351           required: true
32352           type: string
32353           example: __VNF-ID2__
32354         - name: body
32355           in: body
32356           description: newvce object that needs to be updated.
32357           required: true
32358           schema:
32359             $ref: "#/patchDefinitions/newvce"
32360     delete:
32361       tags:
32362         - Network
32363       summary: delete an existing newvce
32364       description: delete an existing newvce
32365       operationId: deleteNetworkNewvcesNewvce
32366       consumes:
32367         - application/json
32368         - application/xml
32369       produces:
32370         - application/json
32371         - application/xml
32372       responses:
32373         "default":
32374           description: Response codes found in [response codes](https://wiki.onap.org/).
32375       parameters:
32376         - name: vnf-id2
32377           in: path
32378           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32379           required: true
32380           type: string
32381           example: __VNF-ID2__
32382         - name: resource-version
32383           in: query
32384           description: resource-version for concurrency
32385           required: true
32386           type: string
32387   /network/newvces:
32388     get:
32389       tags:
32390         - Network
32391       summary: returns newvces
32392       description: returns newvces
32393       operationId: getNetworkNewvces
32394       produces:
32395         - application/json
32396         - application/xml
32397       responses:
32398         "200":
32399           description: successful operation
32400           schema:
32401               $ref: "#/getDefinitions/newvces"
32402         "default":
32403           description: Response codes found in [response codes](https://wiki.onap.org/).
32404       parameters:
32405         - name: vnf-id2
32406           in: query
32407           description:
32408           required: false
32409           type: string
32410         - name: vnf-name
32411           in: query
32412           description:
32413           required: false
32414           type: string
32415         - name: vnf-name2
32416           in: query
32417           description:
32418           required: false
32419           type: string
32420         - name: vnf-type
32421           in: query
32422           description:
32423           required: false
32424           type: string
32425         - name: prov-status
32426           in: query
32427           description:
32428           required: false
32429           type: string
32430         - name: heat-stack-id
32431           in: query
32432           description:
32433           required: false
32434           type: string
32435   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
32436     put:
32437       tags:
32438         - Network
32439       summary: see node definition for valid relationships
32440       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
32441       consumes:
32442         - application/json
32443         - application/xml
32444       produces:
32445         - application/json
32446         - application/xml
32447       responses:
32448         "default":
32449           description: Response codes found in [response codes](https://wiki.onap.org/).
32450       parameters:
32451         - name: pnf-name
32452           in: path
32453           description: unique name of Physical Network Function.
32454           required: true
32455           type: string
32456           example: __PNF-NAME__
32457         - name: body
32458           in: body
32459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
32460           required: true
32461           schema:
32462             $ref: "#/definitions/relationship"
32463     delete:
32464       tags:
32465         - Network
32466       summary: delete an existing relationship
32467       description: delete an existing relationship
32468       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
32469       consumes:
32470         - application/json
32471         - application/xml
32472       produces:
32473         - application/json
32474         - application/xml
32475       responses:
32476         "default":
32477           description: Response codes found in [response codes](https://wiki.onap.org/).
32478       parameters:
32479         - name: pnf-name
32480           in: path
32481           description: unique name of Physical Network Function.
32482           required: true
32483           type: string
32484           example: __PNF-NAME__
32485   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
32486     put:
32487       tags:
32488         - Network
32489       summary: see node definition for valid relationships
32490       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
32491       consumes:
32492         - application/json
32493         - application/xml
32494       produces:
32495         - application/json
32496         - application/xml
32497       responses:
32498         "default":
32499           description: Response codes found in [response codes](https://wiki.onap.org/).
32500       parameters:
32501         - name: pnf-name
32502           in: path
32503           description: unique name of Physical Network Function.
32504           required: true
32505           type: string
32506           example: __PNF-NAME__
32507         - name: interface-name
32508           in: path
32509           description: Name that identifies the physical interface
32510           required: true
32511           type: string
32512           example: __INTERFACE-NAME__
32513         - name: body
32514           in: body
32515           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
32516           required: true
32517           schema:
32518             $ref: "#/definitions/relationship"
32519     delete:
32520       tags:
32521         - Network
32522       summary: delete an existing relationship
32523       description: delete an existing relationship
32524       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
32525       consumes:
32526         - application/json
32527         - application/xml
32528       produces:
32529         - application/json
32530         - application/xml
32531       responses:
32532         "default":
32533           description: Response codes found in [response codes](https://wiki.onap.org/).
32534       parameters:
32535         - name: pnf-name
32536           in: path
32537           description: unique name of Physical Network Function.
32538           required: true
32539           type: string
32540           example: __PNF-NAME__
32541         - name: interface-name
32542           in: path
32543           description: Name that identifies the physical interface
32544           required: true
32545           type: string
32546           example: __INTERFACE-NAME__
32547   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32548     put:
32549       tags:
32550         - Network
32551       summary: see node definition for valid relationships
32552       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32553       consumes:
32554         - application/json
32555         - application/xml
32556       produces:
32557         - application/json
32558         - application/xml
32559       responses:
32560         "default":
32561           description: Response codes found in [response codes](https://wiki.onap.org/).
32562       parameters:
32563         - name: pnf-name
32564           in: path
32565           description: unique name of Physical Network Function.
32566           required: true
32567           type: string
32568           example: __PNF-NAME__
32569         - name: interface-name
32570           in: path
32571           description: Name that identifies the physical interface
32572           required: true
32573           type: string
32574           example: __INTERFACE-NAME__
32575         - name: interface-name
32576           in: path
32577           description: Name given to the interface
32578           required: true
32579           type: string
32580           example: __INTERFACE-NAME__
32581         - name: vlan-interface
32582           in: path
32583           description: String that identifies the interface
32584           required: true
32585           type: string
32586           example: __VLAN-INTERFACE__
32587         - name: body
32588           in: body
32589           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
32590           required: true
32591           schema:
32592             $ref: "#/definitions/relationship"
32593     delete:
32594       tags:
32595         - Network
32596       summary: delete an existing relationship
32597       description: delete an existing relationship
32598       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32599       consumes:
32600         - application/json
32601         - application/xml
32602       produces:
32603         - application/json
32604         - application/xml
32605       responses:
32606         "default":
32607           description: Response codes found in [response codes](https://wiki.onap.org/).
32608       parameters:
32609         - name: pnf-name
32610           in: path
32611           description: unique name of Physical Network Function.
32612           required: true
32613           type: string
32614           example: __PNF-NAME__
32615         - name: interface-name
32616           in: path
32617           description: Name that identifies the physical interface
32618           required: true
32619           type: string
32620           example: __INTERFACE-NAME__
32621         - name: interface-name
32622           in: path
32623           description: Name given to the interface
32624           required: true
32625           type: string
32626           example: __INTERFACE-NAME__
32627         - name: vlan-interface
32628           in: path
32629           description: String that identifies the interface
32630           required: true
32631           type: string
32632           example: __VLAN-INTERFACE__
32633   /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:
32634     put:
32635       tags:
32636         - Network
32637       summary: see node definition for valid relationships
32638       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32639       consumes:
32640         - application/json
32641         - application/xml
32642       produces:
32643         - application/json
32644         - application/xml
32645       responses:
32646         "default":
32647           description: Response codes found in [response codes](https://wiki.onap.org/).
32648       parameters:
32649         - name: pnf-name
32650           in: path
32651           description: unique name of Physical Network Function.
32652           required: true
32653           type: string
32654           example: __PNF-NAME__
32655         - name: interface-name
32656           in: path
32657           description: Name that identifies the physical interface
32658           required: true
32659           type: string
32660           example: __INTERFACE-NAME__
32661         - name: interface-name
32662           in: path
32663           description: Name given to the interface
32664           required: true
32665           type: string
32666           example: __INTERFACE-NAME__
32667         - name: vlan-interface
32668           in: path
32669           description: String that identifies the interface
32670           required: true
32671           type: string
32672           example: __VLAN-INTERFACE__
32673         - name: l3-interface-ipv4-address
32674           in: path
32675           description: IP address
32676           required: true
32677           type: string
32678           example: __L3-INTERFACE-IPV4-ADDRESS__
32679         - name: body
32680           in: body
32681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32682           required: true
32683           schema:
32684             $ref: "#/definitions/relationship"
32685     delete:
32686       tags:
32687         - Network
32688       summary: delete an existing relationship
32689       description: delete an existing relationship
32690       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32691       consumes:
32692         - application/json
32693         - application/xml
32694       produces:
32695         - application/json
32696         - application/xml
32697       responses:
32698         "default":
32699           description: Response codes found in [response codes](https://wiki.onap.org/).
32700       parameters:
32701         - name: pnf-name
32702           in: path
32703           description: unique name of Physical Network Function.
32704           required: true
32705           type: string
32706           example: __PNF-NAME__
32707         - name: interface-name
32708           in: path
32709           description: Name that identifies the physical interface
32710           required: true
32711           type: string
32712           example: __INTERFACE-NAME__
32713         - name: interface-name
32714           in: path
32715           description: Name given to the interface
32716           required: true
32717           type: string
32718           example: __INTERFACE-NAME__
32719         - name: vlan-interface
32720           in: path
32721           description: String that identifies the interface
32722           required: true
32723           type: string
32724           example: __VLAN-INTERFACE__
32725         - name: l3-interface-ipv4-address
32726           in: path
32727           description: IP address
32728           required: true
32729           type: string
32730           example: __L3-INTERFACE-IPV4-ADDRESS__
32731   /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}:
32732     get:
32733       tags:
32734         - Network
32735       summary: returns l3-interface-ipv4-address-list
32736       description: returns l3-interface-ipv4-address-list
32737       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32738       produces:
32739         - application/json
32740         - application/xml
32741       responses:
32742         "200":
32743           description: successful operation
32744           schema:
32745               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32746         "default":
32747           description: Response codes found in [response codes](https://wiki.onap.org/).
32748       parameters:
32749         - name: pnf-name
32750           in: path
32751           description: unique name of Physical Network Function.
32752           required: true
32753           type: string
32754           example: __PNF-NAME__
32755         - name: interface-name
32756           in: path
32757           description: Name that identifies the physical interface
32758           required: true
32759           type: string
32760           example: __INTERFACE-NAME__
32761         - name: interface-name
32762           in: path
32763           description: Name given to the interface
32764           required: true
32765           type: string
32766           example: __INTERFACE-NAME__
32767         - name: vlan-interface
32768           in: path
32769           description: String that identifies the interface
32770           required: true
32771           type: string
32772           example: __VLAN-INTERFACE__
32773         - name: l3-interface-ipv4-address
32774           in: path
32775           description: IP address
32776           required: true
32777           type: string
32778           example: __L3-INTERFACE-IPV4-ADDRESS__
32779     put:
32780       tags:
32781         - Network
32782       summary: create or update an existing l3-interface-ipv4-address-list
32783       description: |
32784         Create or update an existing l3-interface-ipv4-address-list.
32785         #
32786         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32787       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32788       consumes:
32789         - application/json
32790         - application/xml
32791       produces:
32792         - application/json
32793         - application/xml
32794       responses:
32795         "default":
32796           description: Response codes found in [response codes](https://wiki.onap.org/).
32797       parameters:
32798         - name: pnf-name
32799           in: path
32800           description: unique name of Physical Network Function.
32801           required: true
32802           type: string
32803           example: __PNF-NAME__
32804         - name: interface-name
32805           in: path
32806           description: Name that identifies the physical interface
32807           required: true
32808           type: string
32809           example: __INTERFACE-NAME__
32810         - name: interface-name
32811           in: path
32812           description: Name given to the interface
32813           required: true
32814           type: string
32815           example: __INTERFACE-NAME__
32816         - name: vlan-interface
32817           in: path
32818           description: String that identifies the interface
32819           required: true
32820           type: string
32821           example: __VLAN-INTERFACE__
32822         - name: l3-interface-ipv4-address
32823           in: path
32824           description: IP address
32825           required: true
32826           type: string
32827           example: __L3-INTERFACE-IPV4-ADDRESS__
32828         - name: body
32829           in: body
32830           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32831           required: true
32832           schema:
32833             $ref: "#/definitions/l3-interface-ipv4-address-list"
32834     patch:
32835       tags:
32836         - Network
32837       summary: update an existing l3-interface-ipv4-address-list
32838       description: |
32839         Update an existing l3-interface-ipv4-address-list
32840         #
32841         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32842         The PUT operation will entirely replace an existing object.
32843         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32844         #
32845         Other differences between PUT and PATCH are:
32846         #
32847         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32848         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32849         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32850       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32851       consumes:
32852         - application/json
32853         - application/xml
32854       produces:
32855         - application/json
32856         - application/xml
32857       responses:
32858         "default":
32859           description: Response codes found in [response codes](https://wiki.onap.org/).
32860       parameters:
32861         - name: pnf-name
32862           in: path
32863           description: unique name of Physical Network Function.
32864           required: true
32865           type: string
32866           example: __PNF-NAME__
32867         - name: interface-name
32868           in: path
32869           description: Name that identifies the physical interface
32870           required: true
32871           type: string
32872           example: __INTERFACE-NAME__
32873         - name: interface-name
32874           in: path
32875           description: Name given to the interface
32876           required: true
32877           type: string
32878           example: __INTERFACE-NAME__
32879         - name: vlan-interface
32880           in: path
32881           description: String that identifies the interface
32882           required: true
32883           type: string
32884           example: __VLAN-INTERFACE__
32885         - name: l3-interface-ipv4-address
32886           in: path
32887           description: IP address
32888           required: true
32889           type: string
32890           example: __L3-INTERFACE-IPV4-ADDRESS__
32891         - name: body
32892           in: body
32893           description: l3-interface-ipv4-address-list object that needs to be updated.
32894           required: true
32895           schema:
32896             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32897     delete:
32898       tags:
32899         - Network
32900       summary: delete an existing l3-interface-ipv4-address-list
32901       description: delete an existing l3-interface-ipv4-address-list
32902       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32903       consumes:
32904         - application/json
32905         - application/xml
32906       produces:
32907         - application/json
32908         - application/xml
32909       responses:
32910         "default":
32911           description: Response codes found in [response codes](https://wiki.onap.org/).
32912       parameters:
32913         - name: pnf-name
32914           in: path
32915           description: unique name of Physical Network Function.
32916           required: true
32917           type: string
32918           example: __PNF-NAME__
32919         - name: interface-name
32920           in: path
32921           description: Name that identifies the physical interface
32922           required: true
32923           type: string
32924           example: __INTERFACE-NAME__
32925         - name: interface-name
32926           in: path
32927           description: Name given to the interface
32928           required: true
32929           type: string
32930           example: __INTERFACE-NAME__
32931         - name: vlan-interface
32932           in: path
32933           description: String that identifies the interface
32934           required: true
32935           type: string
32936           example: __VLAN-INTERFACE__
32937         - name: l3-interface-ipv4-address
32938           in: path
32939           description: IP address
32940           required: true
32941           type: string
32942           example: __L3-INTERFACE-IPV4-ADDRESS__
32943         - name: resource-version
32944           in: query
32945           description: resource-version for concurrency
32946           required: true
32947           type: string
32948   /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:
32949     put:
32950       tags:
32951         - Network
32952       summary: see node definition for valid relationships
32953       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32954       consumes:
32955         - application/json
32956         - application/xml
32957       produces:
32958         - application/json
32959         - application/xml
32960       responses:
32961         "default":
32962           description: Response codes found in [response codes](https://wiki.onap.org/).
32963       parameters:
32964         - name: pnf-name
32965           in: path
32966           description: unique name of Physical Network Function.
32967           required: true
32968           type: string
32969           example: __PNF-NAME__
32970         - name: interface-name
32971           in: path
32972           description: Name that identifies the physical interface
32973           required: true
32974           type: string
32975           example: __INTERFACE-NAME__
32976         - name: interface-name
32977           in: path
32978           description: Name given to the interface
32979           required: true
32980           type: string
32981           example: __INTERFACE-NAME__
32982         - name: vlan-interface
32983           in: path
32984           description: String that identifies the interface
32985           required: true
32986           type: string
32987           example: __VLAN-INTERFACE__
32988         - name: l3-interface-ipv6-address
32989           in: path
32990           description: IP address
32991           required: true
32992           type: string
32993           example: __L3-INTERFACE-IPV6-ADDRESS__
32994         - name: body
32995           in: body
32996           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32997           required: true
32998           schema:
32999             $ref: "#/definitions/relationship"
33000     delete:
33001       tags:
33002         - Network
33003       summary: delete an existing relationship
33004       description: delete an existing relationship
33005       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33006       consumes:
33007         - application/json
33008         - application/xml
33009       produces:
33010         - application/json
33011         - application/xml
33012       responses:
33013         "default":
33014           description: Response codes found in [response codes](https://wiki.onap.org/).
33015       parameters:
33016         - name: pnf-name
33017           in: path
33018           description: unique name of Physical Network Function.
33019           required: true
33020           type: string
33021           example: __PNF-NAME__
33022         - name: interface-name
33023           in: path
33024           description: Name that identifies the physical interface
33025           required: true
33026           type: string
33027           example: __INTERFACE-NAME__
33028         - name: interface-name
33029           in: path
33030           description: Name given to the interface
33031           required: true
33032           type: string
33033           example: __INTERFACE-NAME__
33034         - name: vlan-interface
33035           in: path
33036           description: String that identifies the interface
33037           required: true
33038           type: string
33039           example: __VLAN-INTERFACE__
33040         - name: l3-interface-ipv6-address
33041           in: path
33042           description: IP address
33043           required: true
33044           type: string
33045           example: __L3-INTERFACE-IPV6-ADDRESS__
33046   /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}:
33047     get:
33048       tags:
33049         - Network
33050       summary: returns l3-interface-ipv6-address-list
33051       description: returns l3-interface-ipv6-address-list
33052       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33053       produces:
33054         - application/json
33055         - application/xml
33056       responses:
33057         "200":
33058           description: successful operation
33059           schema:
33060               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33061         "default":
33062           description: Response codes found in [response codes](https://wiki.onap.org/).
33063       parameters:
33064         - name: pnf-name
33065           in: path
33066           description: unique name of Physical Network Function.
33067           required: true
33068           type: string
33069           example: __PNF-NAME__
33070         - name: interface-name
33071           in: path
33072           description: Name that identifies the physical interface
33073           required: true
33074           type: string
33075           example: __INTERFACE-NAME__
33076         - name: interface-name
33077           in: path
33078           description: Name given to the interface
33079           required: true
33080           type: string
33081           example: __INTERFACE-NAME__
33082         - name: vlan-interface
33083           in: path
33084           description: String that identifies the interface
33085           required: true
33086           type: string
33087           example: __VLAN-INTERFACE__
33088         - name: l3-interface-ipv6-address
33089           in: path
33090           description: IP address
33091           required: true
33092           type: string
33093           example: __L3-INTERFACE-IPV6-ADDRESS__
33094     put:
33095       tags:
33096         - Network
33097       summary: create or update an existing l3-interface-ipv6-address-list
33098       description: |
33099         Create or update an existing l3-interface-ipv6-address-list.
33100         #
33101         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33102       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33103       consumes:
33104         - application/json
33105         - application/xml
33106       produces:
33107         - application/json
33108         - application/xml
33109       responses:
33110         "default":
33111           description: Response codes found in [response codes](https://wiki.onap.org/).
33112       parameters:
33113         - name: pnf-name
33114           in: path
33115           description: unique name of Physical Network Function.
33116           required: true
33117           type: string
33118           example: __PNF-NAME__
33119         - name: interface-name
33120           in: path
33121           description: Name that identifies the physical interface
33122           required: true
33123           type: string
33124           example: __INTERFACE-NAME__
33125         - name: interface-name
33126           in: path
33127           description: Name given to the interface
33128           required: true
33129           type: string
33130           example: __INTERFACE-NAME__
33131         - name: vlan-interface
33132           in: path
33133           description: String that identifies the interface
33134           required: true
33135           type: string
33136           example: __VLAN-INTERFACE__
33137         - name: l3-interface-ipv6-address
33138           in: path
33139           description: IP address
33140           required: true
33141           type: string
33142           example: __L3-INTERFACE-IPV6-ADDRESS__
33143         - name: body
33144           in: body
33145           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33146           required: true
33147           schema:
33148             $ref: "#/definitions/l3-interface-ipv6-address-list"
33149     patch:
33150       tags:
33151         - Network
33152       summary: update an existing l3-interface-ipv6-address-list
33153       description: |
33154         Update an existing l3-interface-ipv6-address-list
33155         #
33156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33157         The PUT operation will entirely replace an existing object.
33158         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33159         #
33160         Other differences between PUT and PATCH are:
33161         #
33162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33165       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33166       consumes:
33167         - application/json
33168         - application/xml
33169       produces:
33170         - application/json
33171         - application/xml
33172       responses:
33173         "default":
33174           description: Response codes found in [response codes](https://wiki.onap.org/).
33175       parameters:
33176         - name: pnf-name
33177           in: path
33178           description: unique name of Physical Network Function.
33179           required: true
33180           type: string
33181           example: __PNF-NAME__
33182         - name: interface-name
33183           in: path
33184           description: Name that identifies the physical interface
33185           required: true
33186           type: string
33187           example: __INTERFACE-NAME__
33188         - name: interface-name
33189           in: path
33190           description: Name given to the interface
33191           required: true
33192           type: string
33193           example: __INTERFACE-NAME__
33194         - name: vlan-interface
33195           in: path
33196           description: String that identifies the interface
33197           required: true
33198           type: string
33199           example: __VLAN-INTERFACE__
33200         - name: l3-interface-ipv6-address
33201           in: path
33202           description: IP address
33203           required: true
33204           type: string
33205           example: __L3-INTERFACE-IPV6-ADDRESS__
33206         - name: body
33207           in: body
33208           description: l3-interface-ipv6-address-list object that needs to be updated.
33209           required: true
33210           schema:
33211             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33212     delete:
33213       tags:
33214         - Network
33215       summary: delete an existing l3-interface-ipv6-address-list
33216       description: delete an existing l3-interface-ipv6-address-list
33217       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33218       consumes:
33219         - application/json
33220         - application/xml
33221       produces:
33222         - application/json
33223         - application/xml
33224       responses:
33225         "default":
33226           description: Response codes found in [response codes](https://wiki.onap.org/).
33227       parameters:
33228         - name: pnf-name
33229           in: path
33230           description: unique name of Physical Network Function.
33231           required: true
33232           type: string
33233           example: __PNF-NAME__
33234         - name: interface-name
33235           in: path
33236           description: Name that identifies the physical interface
33237           required: true
33238           type: string
33239           example: __INTERFACE-NAME__
33240         - name: interface-name
33241           in: path
33242           description: Name given to the interface
33243           required: true
33244           type: string
33245           example: __INTERFACE-NAME__
33246         - name: vlan-interface
33247           in: path
33248           description: String that identifies the interface
33249           required: true
33250           type: string
33251           example: __VLAN-INTERFACE__
33252         - name: l3-interface-ipv6-address
33253           in: path
33254           description: IP address
33255           required: true
33256           type: string
33257           example: __L3-INTERFACE-IPV6-ADDRESS__
33258         - name: resource-version
33259           in: query
33260           description: resource-version for concurrency
33261           required: true
33262           type: string
33263   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33264     get:
33265       tags:
33266         - Network
33267       summary: returns vlan
33268       description: returns vlan
33269       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33270       produces:
33271         - application/json
33272         - application/xml
33273       responses:
33274         "200":
33275           description: successful operation
33276           schema:
33277               $ref: "#/getDefinitions/vlan"
33278         "default":
33279           description: Response codes found in [response codes](https://wiki.onap.org/).
33280       parameters:
33281         - name: pnf-name
33282           in: path
33283           description: unique name of Physical Network Function.
33284           required: true
33285           type: string
33286           example: __PNF-NAME__
33287         - name: interface-name
33288           in: path
33289           description: Name that identifies the physical interface
33290           required: true
33291           type: string
33292           example: __INTERFACE-NAME__
33293         - name: interface-name
33294           in: path
33295           description: Name given to the interface
33296           required: true
33297           type: string
33298           example: __INTERFACE-NAME__
33299         - name: vlan-interface
33300           in: path
33301           description: String that identifies the interface
33302           required: true
33303           type: string
33304           example: __VLAN-INTERFACE__
33305     put:
33306       tags:
33307         - Network
33308       summary: create or update an existing vlan
33309       description: |
33310         Create or update an existing vlan.
33311         #
33312         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33313       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33314       consumes:
33315         - application/json
33316         - application/xml
33317       produces:
33318         - application/json
33319         - application/xml
33320       responses:
33321         "default":
33322           description: Response codes found in [response codes](https://wiki.onap.org/).
33323       parameters:
33324         - name: pnf-name
33325           in: path
33326           description: unique name of Physical Network Function.
33327           required: true
33328           type: string
33329           example: __PNF-NAME__
33330         - name: interface-name
33331           in: path
33332           description: Name that identifies the physical interface
33333           required: true
33334           type: string
33335           example: __INTERFACE-NAME__
33336         - name: interface-name
33337           in: path
33338           description: Name given to the interface
33339           required: true
33340           type: string
33341           example: __INTERFACE-NAME__
33342         - name: vlan-interface
33343           in: path
33344           description: String that identifies the interface
33345           required: true
33346           type: string
33347           example: __VLAN-INTERFACE__
33348         - name: body
33349           in: body
33350           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
33351           required: true
33352           schema:
33353             $ref: "#/definitions/vlan"
33354     patch:
33355       tags:
33356         - Network
33357       summary: update an existing vlan
33358       description: |
33359         Update an existing vlan
33360         #
33361         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33362         The PUT operation will entirely replace an existing object.
33363         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33364         #
33365         Other differences between PUT and PATCH are:
33366         #
33367         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33368         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33369         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33370       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33371       consumes:
33372         - application/json
33373         - application/xml
33374       produces:
33375         - application/json
33376         - application/xml
33377       responses:
33378         "default":
33379           description: Response codes found in [response codes](https://wiki.onap.org/).
33380       parameters:
33381         - name: pnf-name
33382           in: path
33383           description: unique name of Physical Network Function.
33384           required: true
33385           type: string
33386           example: __PNF-NAME__
33387         - name: interface-name
33388           in: path
33389           description: Name that identifies the physical interface
33390           required: true
33391           type: string
33392           example: __INTERFACE-NAME__
33393         - name: interface-name
33394           in: path
33395           description: Name given to the interface
33396           required: true
33397           type: string
33398           example: __INTERFACE-NAME__
33399         - name: vlan-interface
33400           in: path
33401           description: String that identifies the interface
33402           required: true
33403           type: string
33404           example: __VLAN-INTERFACE__
33405         - name: body
33406           in: body
33407           description: vlan object that needs to be updated.
33408           required: true
33409           schema:
33410             $ref: "#/patchDefinitions/vlan"
33411     delete:
33412       tags:
33413         - Network
33414       summary: delete an existing vlan
33415       description: delete an existing vlan
33416       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33417       consumes:
33418         - application/json
33419         - application/xml
33420       produces:
33421         - application/json
33422         - application/xml
33423       responses:
33424         "default":
33425           description: Response codes found in [response codes](https://wiki.onap.org/).
33426       parameters:
33427         - name: pnf-name
33428           in: path
33429           description: unique name of Physical Network Function.
33430           required: true
33431           type: string
33432           example: __PNF-NAME__
33433         - name: interface-name
33434           in: path
33435           description: Name that identifies the physical interface
33436           required: true
33437           type: string
33438           example: __INTERFACE-NAME__
33439         - name: interface-name
33440           in: path
33441           description: Name given to the interface
33442           required: true
33443           type: string
33444           example: __INTERFACE-NAME__
33445         - name: vlan-interface
33446           in: path
33447           description: String that identifies the interface
33448           required: true
33449           type: string
33450           example: __VLAN-INTERFACE__
33451         - name: resource-version
33452           in: query
33453           description: resource-version for concurrency
33454           required: true
33455           type: string
33456   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
33457     get:
33458       tags:
33459         - Network
33460       summary: returns vlans
33461       description: returns vlans
33462       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
33463       produces:
33464         - application/json
33465         - application/xml
33466       responses:
33467         "200":
33468           description: successful operation
33469           schema:
33470               $ref: "#/getDefinitions/vlans"
33471         "default":
33472           description: Response codes found in [response codes](https://wiki.onap.org/).
33473       parameters:
33474         - name: pnf-name
33475           in: path
33476           description: unique name of Physical Network Function.
33477           required: true
33478           type: string
33479           example: __PNF-NAME__
33480         - name: interface-name
33481           in: path
33482           description: Name that identifies the physical interface
33483           required: true
33484           type: string
33485           example: __INTERFACE-NAME__
33486         - name: interface-name
33487           in: path
33488           description: Name given to the interface
33489           required: true
33490           type: string
33491           example: __INTERFACE-NAME__
33492         - name: vlan-interface
33493           in: query
33494           description:
33495           required: false
33496           type: string
33497         - name: vlan-id-inner
33498           in: query
33499           description:
33500           required: false
33501           type: integer
33502           format: int64
33503         - name: vpn-id
33504           in: query
33505           description:
33506           required: false
33507           type: string
33508   /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:
33509     put:
33510       tags:
33511         - Network
33512       summary: see node definition for valid relationships
33513       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33514       consumes:
33515         - application/json
33516         - application/xml
33517       produces:
33518         - application/json
33519         - application/xml
33520       responses:
33521         "default":
33522           description: Response codes found in [response codes](https://wiki.onap.org/).
33523       parameters:
33524         - name: pnf-name
33525           in: path
33526           description: unique name of Physical Network Function.
33527           required: true
33528           type: string
33529           example: __PNF-NAME__
33530         - name: interface-name
33531           in: path
33532           description: Name that identifies the physical interface
33533           required: true
33534           type: string
33535           example: __INTERFACE-NAME__
33536         - name: interface-name
33537           in: path
33538           description: Name given to the interface
33539           required: true
33540           type: string
33541           example: __INTERFACE-NAME__
33542         - name: pci-id
33543           in: path
33544           description: PCI ID used to identify the sriov-vf
33545           required: true
33546           type: string
33547           example: __PCI-ID__
33548         - name: body
33549           in: body
33550           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33551           required: true
33552           schema:
33553             $ref: "#/definitions/relationship"
33554     delete:
33555       tags:
33556         - Network
33557       summary: delete an existing relationship
33558       description: delete an existing relationship
33559       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33560       consumes:
33561         - application/json
33562         - application/xml
33563       produces:
33564         - application/json
33565         - application/xml
33566       responses:
33567         "default":
33568           description: Response codes found in [response codes](https://wiki.onap.org/).
33569       parameters:
33570         - name: pnf-name
33571           in: path
33572           description: unique name of Physical Network Function.
33573           required: true
33574           type: string
33575           example: __PNF-NAME__
33576         - name: interface-name
33577           in: path
33578           description: Name that identifies the physical interface
33579           required: true
33580           type: string
33581           example: __INTERFACE-NAME__
33582         - name: interface-name
33583           in: path
33584           description: Name given to the interface
33585           required: true
33586           type: string
33587           example: __INTERFACE-NAME__
33588         - name: pci-id
33589           in: path
33590           description: PCI ID used to identify the sriov-vf
33591           required: true
33592           type: string
33593           example: __PCI-ID__
33594   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33595     get:
33596       tags:
33597         - Network
33598       summary: returns sriov-vf
33599       description: returns sriov-vf
33600       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33601       produces:
33602         - application/json
33603         - application/xml
33604       responses:
33605         "200":
33606           description: successful operation
33607           schema:
33608               $ref: "#/getDefinitions/sriov-vf"
33609         "default":
33610           description: Response codes found in [response codes](https://wiki.onap.org/).
33611       parameters:
33612         - name: pnf-name
33613           in: path
33614           description: unique name of Physical Network Function.
33615           required: true
33616           type: string
33617           example: __PNF-NAME__
33618         - name: interface-name
33619           in: path
33620           description: Name that identifies the physical interface
33621           required: true
33622           type: string
33623           example: __INTERFACE-NAME__
33624         - name: interface-name
33625           in: path
33626           description: Name given to the interface
33627           required: true
33628           type: string
33629           example: __INTERFACE-NAME__
33630         - name: pci-id
33631           in: path
33632           description: PCI ID used to identify the sriov-vf
33633           required: true
33634           type: string
33635           example: __PCI-ID__
33636     put:
33637       tags:
33638         - Network
33639       summary: create or update an existing sriov-vf
33640       description: |
33641         Create or update an existing sriov-vf.
33642         #
33643         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33644       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33645       consumes:
33646         - application/json
33647         - application/xml
33648       produces:
33649         - application/json
33650         - application/xml
33651       responses:
33652         "default":
33653           description: Response codes found in [response codes](https://wiki.onap.org/).
33654       parameters:
33655         - name: pnf-name
33656           in: path
33657           description: unique name of Physical Network Function.
33658           required: true
33659           type: string
33660           example: __PNF-NAME__
33661         - name: interface-name
33662           in: path
33663           description: Name that identifies the physical interface
33664           required: true
33665           type: string
33666           example: __INTERFACE-NAME__
33667         - name: interface-name
33668           in: path
33669           description: Name given to the interface
33670           required: true
33671           type: string
33672           example: __INTERFACE-NAME__
33673         - name: pci-id
33674           in: path
33675           description: PCI ID used to identify the sriov-vf
33676           required: true
33677           type: string
33678           example: __PCI-ID__
33679         - name: body
33680           in: body
33681           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33682           required: true
33683           schema:
33684             $ref: "#/definitions/sriov-vf"
33685     patch:
33686       tags:
33687         - Network
33688       summary: update an existing sriov-vf
33689       description: |
33690         Update an existing sriov-vf
33691         #
33692         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33693         The PUT operation will entirely replace an existing object.
33694         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33695         #
33696         Other differences between PUT and PATCH are:
33697         #
33698         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33699         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33700         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33701       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33702       consumes:
33703         - application/json
33704         - application/xml
33705       produces:
33706         - application/json
33707         - application/xml
33708       responses:
33709         "default":
33710           description: Response codes found in [response codes](https://wiki.onap.org/).
33711       parameters:
33712         - name: pnf-name
33713           in: path
33714           description: unique name of Physical Network Function.
33715           required: true
33716           type: string
33717           example: __PNF-NAME__
33718         - name: interface-name
33719           in: path
33720           description: Name that identifies the physical interface
33721           required: true
33722           type: string
33723           example: __INTERFACE-NAME__
33724         - name: interface-name
33725           in: path
33726           description: Name given to the interface
33727           required: true
33728           type: string
33729           example: __INTERFACE-NAME__
33730         - name: pci-id
33731           in: path
33732           description: PCI ID used to identify the sriov-vf
33733           required: true
33734           type: string
33735           example: __PCI-ID__
33736         - name: body
33737           in: body
33738           description: sriov-vf object that needs to be updated.
33739           required: true
33740           schema:
33741             $ref: "#/patchDefinitions/sriov-vf"
33742     delete:
33743       tags:
33744         - Network
33745       summary: delete an existing sriov-vf
33746       description: delete an existing sriov-vf
33747       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33748       consumes:
33749         - application/json
33750         - application/xml
33751       produces:
33752         - application/json
33753         - application/xml
33754       responses:
33755         "default":
33756           description: Response codes found in [response codes](https://wiki.onap.org/).
33757       parameters:
33758         - name: pnf-name
33759           in: path
33760           description: unique name of Physical Network Function.
33761           required: true
33762           type: string
33763           example: __PNF-NAME__
33764         - name: interface-name
33765           in: path
33766           description: Name that identifies the physical interface
33767           required: true
33768           type: string
33769           example: __INTERFACE-NAME__
33770         - name: interface-name
33771           in: path
33772           description: Name given to the interface
33773           required: true
33774           type: string
33775           example: __INTERFACE-NAME__
33776         - name: pci-id
33777           in: path
33778           description: PCI ID used to identify the sriov-vf
33779           required: true
33780           type: string
33781           example: __PCI-ID__
33782         - name: resource-version
33783           in: query
33784           description: resource-version for concurrency
33785           required: true
33786           type: string
33787   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33788     get:
33789       tags:
33790         - Network
33791       summary: returns sriov-vfs
33792       description: returns sriov-vfs
33793       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
33794       produces:
33795         - application/json
33796         - application/xml
33797       responses:
33798         "200":
33799           description: successful operation
33800           schema:
33801               $ref: "#/getDefinitions/sriov-vfs"
33802         "default":
33803           description: Response codes found in [response codes](https://wiki.onap.org/).
33804       parameters:
33805         - name: pnf-name
33806           in: path
33807           description: unique name of Physical Network Function.
33808           required: true
33809           type: string
33810           example: __PNF-NAME__
33811         - name: interface-name
33812           in: path
33813           description: Name that identifies the physical interface
33814           required: true
33815           type: string
33816           example: __INTERFACE-NAME__
33817         - name: interface-name
33818           in: path
33819           description: Name given to the interface
33820           required: true
33821           type: string
33822           example: __INTERFACE-NAME__
33823         - name: pci-id
33824           in: query
33825           description:
33826           required: false
33827           type: string
33828         - name: vf-vlan-filter
33829           in: query
33830           description:
33831           required: false
33832           type: string
33833         - name: vf-mac-filter
33834           in: query
33835           description:
33836           required: false
33837           type: string
33838         - name: vf-vlan-strip
33839           in: query
33840           description:
33841           required: false
33842           type: boolean
33843         - name: neutron-network-id
33844           in: query
33845           description:
33846           required: false
33847           type: string
33848   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33849     put:
33850       tags:
33851         - Network
33852       summary: see node definition for valid relationships
33853       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
33854       consumes:
33855         - application/json
33856         - application/xml
33857       produces:
33858         - application/json
33859         - application/xml
33860       responses:
33861         "default":
33862           description: Response codes found in [response codes](https://wiki.onap.org/).
33863       parameters:
33864         - name: pnf-name
33865           in: path
33866           description: unique name of Physical Network Function.
33867           required: true
33868           type: string
33869           example: __PNF-NAME__
33870         - name: interface-name
33871           in: path
33872           description: Name that identifies the physical interface
33873           required: true
33874           type: string
33875           example: __INTERFACE-NAME__
33876         - name: interface-name
33877           in: path
33878           description: Name given to the interface
33879           required: true
33880           type: string
33881           example: __INTERFACE-NAME__
33882         - name: body
33883           in: body
33884           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
33885           required: true
33886           schema:
33887             $ref: "#/definitions/relationship"
33888     delete:
33889       tags:
33890         - Network
33891       summary: delete an existing relationship
33892       description: delete an existing relationship
33893       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
33894       consumes:
33895         - application/json
33896         - application/xml
33897       produces:
33898         - application/json
33899         - application/xml
33900       responses:
33901         "default":
33902           description: Response codes found in [response codes](https://wiki.onap.org/).
33903       parameters:
33904         - name: pnf-name
33905           in: path
33906           description: unique name of Physical Network Function.
33907           required: true
33908           type: string
33909           example: __PNF-NAME__
33910         - name: interface-name
33911           in: path
33912           description: Name that identifies the physical interface
33913           required: true
33914           type: string
33915           example: __INTERFACE-NAME__
33916         - name: interface-name
33917           in: path
33918           description: Name given to the interface
33919           required: true
33920           type: string
33921           example: __INTERFACE-NAME__
33922   /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:
33923     put:
33924       tags:
33925         - Network
33926       summary: see node definition for valid relationships
33927       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33928       consumes:
33929         - application/json
33930         - application/xml
33931       produces:
33932         - application/json
33933         - application/xml
33934       responses:
33935         "default":
33936           description: Response codes found in [response codes](https://wiki.onap.org/).
33937       parameters:
33938         - name: pnf-name
33939           in: path
33940           description: unique name of Physical Network Function.
33941           required: true
33942           type: string
33943           example: __PNF-NAME__
33944         - name: interface-name
33945           in: path
33946           description: Name that identifies the physical interface
33947           required: true
33948           type: string
33949           example: __INTERFACE-NAME__
33950         - name: interface-name
33951           in: path
33952           description: Name given to the interface
33953           required: true
33954           type: string
33955           example: __INTERFACE-NAME__
33956         - name: l3-interface-ipv4-address
33957           in: path
33958           description: IP address
33959           required: true
33960           type: string
33961           example: __L3-INTERFACE-IPV4-ADDRESS__
33962         - name: body
33963           in: body
33964           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33965           required: true
33966           schema:
33967             $ref: "#/definitions/relationship"
33968     delete:
33969       tags:
33970         - Network
33971       summary: delete an existing relationship
33972       description: delete an existing relationship
33973       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33974       consumes:
33975         - application/json
33976         - application/xml
33977       produces:
33978         - application/json
33979         - application/xml
33980       responses:
33981         "default":
33982           description: Response codes found in [response codes](https://wiki.onap.org/).
33983       parameters:
33984         - name: pnf-name
33985           in: path
33986           description: unique name of Physical Network Function.
33987           required: true
33988           type: string
33989           example: __PNF-NAME__
33990         - name: interface-name
33991           in: path
33992           description: Name that identifies the physical interface
33993           required: true
33994           type: string
33995           example: __INTERFACE-NAME__
33996         - name: interface-name
33997           in: path
33998           description: Name given to the interface
33999           required: true
34000           type: string
34001           example: __INTERFACE-NAME__
34002         - name: l3-interface-ipv4-address
34003           in: path
34004           description: IP address
34005           required: true
34006           type: string
34007           example: __L3-INTERFACE-IPV4-ADDRESS__
34008   /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}:
34009     get:
34010       tags:
34011         - Network
34012       summary: returns l3-interface-ipv4-address-list
34013       description: returns l3-interface-ipv4-address-list
34014       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34015       produces:
34016         - application/json
34017         - application/xml
34018       responses:
34019         "200":
34020           description: successful operation
34021           schema:
34022               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34023         "default":
34024           description: Response codes found in [response codes](https://wiki.onap.org/).
34025       parameters:
34026         - name: pnf-name
34027           in: path
34028           description: unique name of Physical Network Function.
34029           required: true
34030           type: string
34031           example: __PNF-NAME__
34032         - name: interface-name
34033           in: path
34034           description: Name that identifies the physical interface
34035           required: true
34036           type: string
34037           example: __INTERFACE-NAME__
34038         - name: interface-name
34039           in: path
34040           description: Name given to the interface
34041           required: true
34042           type: string
34043           example: __INTERFACE-NAME__
34044         - name: l3-interface-ipv4-address
34045           in: path
34046           description: IP address
34047           required: true
34048           type: string
34049           example: __L3-INTERFACE-IPV4-ADDRESS__
34050     put:
34051       tags:
34052         - Network
34053       summary: create or update an existing l3-interface-ipv4-address-list
34054       description: |
34055         Create or update an existing l3-interface-ipv4-address-list.
34056         #
34057         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34058       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34059       consumes:
34060         - application/json
34061         - application/xml
34062       produces:
34063         - application/json
34064         - application/xml
34065       responses:
34066         "default":
34067           description: Response codes found in [response codes](https://wiki.onap.org/).
34068       parameters:
34069         - name: pnf-name
34070           in: path
34071           description: unique name of Physical Network Function.
34072           required: true
34073           type: string
34074           example: __PNF-NAME__
34075         - name: interface-name
34076           in: path
34077           description: Name that identifies the physical interface
34078           required: true
34079           type: string
34080           example: __INTERFACE-NAME__
34081         - name: interface-name
34082           in: path
34083           description: Name given to the interface
34084           required: true
34085           type: string
34086           example: __INTERFACE-NAME__
34087         - name: l3-interface-ipv4-address
34088           in: path
34089           description: IP address
34090           required: true
34091           type: string
34092           example: __L3-INTERFACE-IPV4-ADDRESS__
34093         - name: body
34094           in: body
34095           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34096           required: true
34097           schema:
34098             $ref: "#/definitions/l3-interface-ipv4-address-list"
34099     patch:
34100       tags:
34101         - Network
34102       summary: update an existing l3-interface-ipv4-address-list
34103       description: |
34104         Update an existing l3-interface-ipv4-address-list
34105         #
34106         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34107         The PUT operation will entirely replace an existing object.
34108         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34109         #
34110         Other differences between PUT and PATCH are:
34111         #
34112         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34113         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34114         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34115       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34116       consumes:
34117         - application/json
34118         - application/xml
34119       produces:
34120         - application/json
34121         - application/xml
34122       responses:
34123         "default":
34124           description: Response codes found in [response codes](https://wiki.onap.org/).
34125       parameters:
34126         - name: pnf-name
34127           in: path
34128           description: unique name of Physical Network Function.
34129           required: true
34130           type: string
34131           example: __PNF-NAME__
34132         - name: interface-name
34133           in: path
34134           description: Name that identifies the physical interface
34135           required: true
34136           type: string
34137           example: __INTERFACE-NAME__
34138         - name: interface-name
34139           in: path
34140           description: Name given to the interface
34141           required: true
34142           type: string
34143           example: __INTERFACE-NAME__
34144         - name: l3-interface-ipv4-address
34145           in: path
34146           description: IP address
34147           required: true
34148           type: string
34149           example: __L3-INTERFACE-IPV4-ADDRESS__
34150         - name: body
34151           in: body
34152           description: l3-interface-ipv4-address-list object that needs to be updated.
34153           required: true
34154           schema:
34155             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34156     delete:
34157       tags:
34158         - Network
34159       summary: delete an existing l3-interface-ipv4-address-list
34160       description: delete an existing l3-interface-ipv4-address-list
34161       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34162       consumes:
34163         - application/json
34164         - application/xml
34165       produces:
34166         - application/json
34167         - application/xml
34168       responses:
34169         "default":
34170           description: Response codes found in [response codes](https://wiki.onap.org/).
34171       parameters:
34172         - name: pnf-name
34173           in: path
34174           description: unique name of Physical Network Function.
34175           required: true
34176           type: string
34177           example: __PNF-NAME__
34178         - name: interface-name
34179           in: path
34180           description: Name that identifies the physical interface
34181           required: true
34182           type: string
34183           example: __INTERFACE-NAME__
34184         - name: interface-name
34185           in: path
34186           description: Name given to the interface
34187           required: true
34188           type: string
34189           example: __INTERFACE-NAME__
34190         - name: l3-interface-ipv4-address
34191           in: path
34192           description: IP address
34193           required: true
34194           type: string
34195           example: __L3-INTERFACE-IPV4-ADDRESS__
34196         - name: resource-version
34197           in: query
34198           description: resource-version for concurrency
34199           required: true
34200           type: string
34201   /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:
34202     put:
34203       tags:
34204         - Network
34205       summary: see node definition for valid relationships
34206       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34207       consumes:
34208         - application/json
34209         - application/xml
34210       produces:
34211         - application/json
34212         - application/xml
34213       responses:
34214         "default":
34215           description: Response codes found in [response codes](https://wiki.onap.org/).
34216       parameters:
34217         - name: pnf-name
34218           in: path
34219           description: unique name of Physical Network Function.
34220           required: true
34221           type: string
34222           example: __PNF-NAME__
34223         - name: interface-name
34224           in: path
34225           description: Name that identifies the physical interface
34226           required: true
34227           type: string
34228           example: __INTERFACE-NAME__
34229         - name: interface-name
34230           in: path
34231           description: Name given to the interface
34232           required: true
34233           type: string
34234           example: __INTERFACE-NAME__
34235         - name: l3-interface-ipv6-address
34236           in: path
34237           description: IP address
34238           required: true
34239           type: string
34240           example: __L3-INTERFACE-IPV6-ADDRESS__
34241         - name: body
34242           in: body
34243           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34244           required: true
34245           schema:
34246             $ref: "#/definitions/relationship"
34247     delete:
34248       tags:
34249         - Network
34250       summary: delete an existing relationship
34251       description: delete an existing relationship
34252       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34253       consumes:
34254         - application/json
34255         - application/xml
34256       produces:
34257         - application/json
34258         - application/xml
34259       responses:
34260         "default":
34261           description: Response codes found in [response codes](https://wiki.onap.org/).
34262       parameters:
34263         - name: pnf-name
34264           in: path
34265           description: unique name of Physical Network Function.
34266           required: true
34267           type: string
34268           example: __PNF-NAME__
34269         - name: interface-name
34270           in: path
34271           description: Name that identifies the physical interface
34272           required: true
34273           type: string
34274           example: __INTERFACE-NAME__
34275         - name: interface-name
34276           in: path
34277           description: Name given to the interface
34278           required: true
34279           type: string
34280           example: __INTERFACE-NAME__
34281         - name: l3-interface-ipv6-address
34282           in: path
34283           description: IP address
34284           required: true
34285           type: string
34286           example: __L3-INTERFACE-IPV6-ADDRESS__
34287   /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}:
34288     get:
34289       tags:
34290         - Network
34291       summary: returns l3-interface-ipv6-address-list
34292       description: returns l3-interface-ipv6-address-list
34293       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34294       produces:
34295         - application/json
34296         - application/xml
34297       responses:
34298         "200":
34299           description: successful operation
34300           schema:
34301               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34302         "default":
34303           description: Response codes found in [response codes](https://wiki.onap.org/).
34304       parameters:
34305         - name: pnf-name
34306           in: path
34307           description: unique name of Physical Network Function.
34308           required: true
34309           type: string
34310           example: __PNF-NAME__
34311         - name: interface-name
34312           in: path
34313           description: Name that identifies the physical interface
34314           required: true
34315           type: string
34316           example: __INTERFACE-NAME__
34317         - name: interface-name
34318           in: path
34319           description: Name given to the interface
34320           required: true
34321           type: string
34322           example: __INTERFACE-NAME__
34323         - name: l3-interface-ipv6-address
34324           in: path
34325           description: IP address
34326           required: true
34327           type: string
34328           example: __L3-INTERFACE-IPV6-ADDRESS__
34329     put:
34330       tags:
34331         - Network
34332       summary: create or update an existing l3-interface-ipv6-address-list
34333       description: |
34334         Create or update an existing l3-interface-ipv6-address-list.
34335         #
34336         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34337       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34338       consumes:
34339         - application/json
34340         - application/xml
34341       produces:
34342         - application/json
34343         - application/xml
34344       responses:
34345         "default":
34346           description: Response codes found in [response codes](https://wiki.onap.org/).
34347       parameters:
34348         - name: pnf-name
34349           in: path
34350           description: unique name of Physical Network Function.
34351           required: true
34352           type: string
34353           example: __PNF-NAME__
34354         - name: interface-name
34355           in: path
34356           description: Name that identifies the physical interface
34357           required: true
34358           type: string
34359           example: __INTERFACE-NAME__
34360         - name: interface-name
34361           in: path
34362           description: Name given to the interface
34363           required: true
34364           type: string
34365           example: __INTERFACE-NAME__
34366         - name: l3-interface-ipv6-address
34367           in: path
34368           description: IP address
34369           required: true
34370           type: string
34371           example: __L3-INTERFACE-IPV6-ADDRESS__
34372         - name: body
34373           in: body
34374           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34375           required: true
34376           schema:
34377             $ref: "#/definitions/l3-interface-ipv6-address-list"
34378     patch:
34379       tags:
34380         - Network
34381       summary: update an existing l3-interface-ipv6-address-list
34382       description: |
34383         Update an existing l3-interface-ipv6-address-list
34384         #
34385         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34386         The PUT operation will entirely replace an existing object.
34387         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34388         #
34389         Other differences between PUT and PATCH are:
34390         #
34391         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34392         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34393         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34394       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34395       consumes:
34396         - application/json
34397         - application/xml
34398       produces:
34399         - application/json
34400         - application/xml
34401       responses:
34402         "default":
34403           description: Response codes found in [response codes](https://wiki.onap.org/).
34404       parameters:
34405         - name: pnf-name
34406           in: path
34407           description: unique name of Physical Network Function.
34408           required: true
34409           type: string
34410           example: __PNF-NAME__
34411         - name: interface-name
34412           in: path
34413           description: Name that identifies the physical interface
34414           required: true
34415           type: string
34416           example: __INTERFACE-NAME__
34417         - name: interface-name
34418           in: path
34419           description: Name given to the interface
34420           required: true
34421           type: string
34422           example: __INTERFACE-NAME__
34423         - name: l3-interface-ipv6-address
34424           in: path
34425           description: IP address
34426           required: true
34427           type: string
34428           example: __L3-INTERFACE-IPV6-ADDRESS__
34429         - name: body
34430           in: body
34431           description: l3-interface-ipv6-address-list object that needs to be updated.
34432           required: true
34433           schema:
34434             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34435     delete:
34436       tags:
34437         - Network
34438       summary: delete an existing l3-interface-ipv6-address-list
34439       description: delete an existing l3-interface-ipv6-address-list
34440       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34441       consumes:
34442         - application/json
34443         - application/xml
34444       produces:
34445         - application/json
34446         - application/xml
34447       responses:
34448         "default":
34449           description: Response codes found in [response codes](https://wiki.onap.org/).
34450       parameters:
34451         - name: pnf-name
34452           in: path
34453           description: unique name of Physical Network Function.
34454           required: true
34455           type: string
34456           example: __PNF-NAME__
34457         - name: interface-name
34458           in: path
34459           description: Name that identifies the physical interface
34460           required: true
34461           type: string
34462           example: __INTERFACE-NAME__
34463         - name: interface-name
34464           in: path
34465           description: Name given to the interface
34466           required: true
34467           type: string
34468           example: __INTERFACE-NAME__
34469         - name: l3-interface-ipv6-address
34470           in: path
34471           description: IP address
34472           required: true
34473           type: string
34474           example: __L3-INTERFACE-IPV6-ADDRESS__
34475         - name: resource-version
34476           in: query
34477           description: resource-version for concurrency
34478           required: true
34479           type: string
34480   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
34481     get:
34482       tags:
34483         - Network
34484       summary: returns l-interface
34485       description: returns l-interface
34486       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34487       produces:
34488         - application/json
34489         - application/xml
34490       responses:
34491         "200":
34492           description: successful operation
34493           schema:
34494               $ref: "#/getDefinitions/l-interface"
34495         "default":
34496           description: Response codes found in [response codes](https://wiki.onap.org/).
34497       parameters:
34498         - name: pnf-name
34499           in: path
34500           description: unique name of Physical Network Function.
34501           required: true
34502           type: string
34503           example: __PNF-NAME__
34504         - name: interface-name
34505           in: path
34506           description: Name that identifies the physical interface
34507           required: true
34508           type: string
34509           example: __INTERFACE-NAME__
34510         - name: interface-name
34511           in: path
34512           description: Name given to the interface
34513           required: true
34514           type: string
34515           example: __INTERFACE-NAME__
34516     put:
34517       tags:
34518         - Network
34519       summary: create or update an existing l-interface
34520       description: |
34521         Create or update an existing l-interface.
34522         #
34523         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34524       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34525       consumes:
34526         - application/json
34527         - application/xml
34528       produces:
34529         - application/json
34530         - application/xml
34531       responses:
34532         "default":
34533           description: Response codes found in [response codes](https://wiki.onap.org/).
34534       parameters:
34535         - name: pnf-name
34536           in: path
34537           description: unique name of Physical Network Function.
34538           required: true
34539           type: string
34540           example: __PNF-NAME__
34541         - name: interface-name
34542           in: path
34543           description: Name that identifies the physical interface
34544           required: true
34545           type: string
34546           example: __INTERFACE-NAME__
34547         - name: interface-name
34548           in: path
34549           description: Name given to the interface
34550           required: true
34551           type: string
34552           example: __INTERFACE-NAME__
34553         - name: body
34554           in: body
34555           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
34556           required: true
34557           schema:
34558             $ref: "#/definitions/l-interface"
34559     patch:
34560       tags:
34561         - Network
34562       summary: update an existing l-interface
34563       description: |
34564         Update an existing l-interface
34565         #
34566         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34567         The PUT operation will entirely replace an existing object.
34568         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34569         #
34570         Other differences between PUT and PATCH are:
34571         #
34572         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34573         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34574         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34575       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34576       consumes:
34577         - application/json
34578         - application/xml
34579       produces:
34580         - application/json
34581         - application/xml
34582       responses:
34583         "default":
34584           description: Response codes found in [response codes](https://wiki.onap.org/).
34585       parameters:
34586         - name: pnf-name
34587           in: path
34588           description: unique name of Physical Network Function.
34589           required: true
34590           type: string
34591           example: __PNF-NAME__
34592         - name: interface-name
34593           in: path
34594           description: Name that identifies the physical interface
34595           required: true
34596           type: string
34597           example: __INTERFACE-NAME__
34598         - name: interface-name
34599           in: path
34600           description: Name given to the interface
34601           required: true
34602           type: string
34603           example: __INTERFACE-NAME__
34604         - name: body
34605           in: body
34606           description: l-interface object that needs to be updated.
34607           required: true
34608           schema:
34609             $ref: "#/patchDefinitions/l-interface"
34610     delete:
34611       tags:
34612         - Network
34613       summary: delete an existing l-interface
34614       description: delete an existing l-interface
34615       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34616       consumes:
34617         - application/json
34618         - application/xml
34619       produces:
34620         - application/json
34621         - application/xml
34622       responses:
34623         "default":
34624           description: Response codes found in [response codes](https://wiki.onap.org/).
34625       parameters:
34626         - name: pnf-name
34627           in: path
34628           description: unique name of Physical Network Function.
34629           required: true
34630           type: string
34631           example: __PNF-NAME__
34632         - name: interface-name
34633           in: path
34634           description: Name that identifies the physical interface
34635           required: true
34636           type: string
34637           example: __INTERFACE-NAME__
34638         - name: interface-name
34639           in: path
34640           description: Name given to the interface
34641           required: true
34642           type: string
34643           example: __INTERFACE-NAME__
34644         - name: resource-version
34645           in: query
34646           description: resource-version for concurrency
34647           required: true
34648           type: string
34649   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
34650     get:
34651       tags:
34652         - Network
34653       summary: returns l-interfaces
34654       description: returns l-interfaces
34655       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
34656       produces:
34657         - application/json
34658         - application/xml
34659       responses:
34660         "200":
34661           description: successful operation
34662           schema:
34663               $ref: "#/getDefinitions/l-interfaces"
34664         "default":
34665           description: Response codes found in [response codes](https://wiki.onap.org/).
34666       parameters:
34667         - name: pnf-name
34668           in: path
34669           description: unique name of Physical Network Function.
34670           required: true
34671           type: string
34672           example: __PNF-NAME__
34673         - name: interface-name
34674           in: path
34675           description: Name that identifies the physical interface
34676           required: true
34677           type: string
34678           example: __INTERFACE-NAME__
34679         - name: interface-name
34680           in: query
34681           description:
34682           required: false
34683           type: string
34684         - name: interface-id
34685           in: query
34686           description:
34687           required: false
34688           type: string
34689         - name: macaddr
34690           in: query
34691           description:
34692           required: false
34693           type: string
34694         - name: network-name
34695           in: query
34696           description:
34697           required: false
34698           type: string
34699   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
34700     get:
34701       tags:
34702         - Network
34703       summary: returns p-interface
34704       description: returns p-interface
34705       operationId: getNetworkPnfsPnfPInterfacesPInterface
34706       produces:
34707         - application/json
34708         - application/xml
34709       responses:
34710         "200":
34711           description: successful operation
34712           schema:
34713               $ref: "#/getDefinitions/p-interface"
34714         "default":
34715           description: Response codes found in [response codes](https://wiki.onap.org/).
34716       parameters:
34717         - name: pnf-name
34718           in: path
34719           description: unique name of Physical Network Function.
34720           required: true
34721           type: string
34722           example: __PNF-NAME__
34723         - name: interface-name
34724           in: path
34725           description: Name that identifies the physical interface
34726           required: true
34727           type: string
34728           example: __INTERFACE-NAME__
34729     put:
34730       tags:
34731         - Network
34732       summary: create or update an existing p-interface
34733       description: |
34734         Create or update an existing p-interface.
34735         #
34736         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34737       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
34738       consumes:
34739         - application/json
34740         - application/xml
34741       produces:
34742         - application/json
34743         - application/xml
34744       responses:
34745         "default":
34746           description: Response codes found in [response codes](https://wiki.onap.org/).
34747       parameters:
34748         - name: pnf-name
34749           in: path
34750           description: unique name of Physical Network Function.
34751           required: true
34752           type: string
34753           example: __PNF-NAME__
34754         - name: interface-name
34755           in: path
34756           description: Name that identifies the physical interface
34757           required: true
34758           type: string
34759           example: __INTERFACE-NAME__
34760         - name: body
34761           in: body
34762           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
34763           required: true
34764           schema:
34765             $ref: "#/definitions/p-interface"
34766     patch:
34767       tags:
34768         - Network
34769       summary: update an existing p-interface
34770       description: |
34771         Update an existing p-interface
34772         #
34773         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34774         The PUT operation will entirely replace an existing object.
34775         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34776         #
34777         Other differences between PUT and PATCH are:
34778         #
34779         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34780         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34781         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34782       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
34783       consumes:
34784         - application/json
34785         - application/xml
34786       produces:
34787         - application/json
34788         - application/xml
34789       responses:
34790         "default":
34791           description: Response codes found in [response codes](https://wiki.onap.org/).
34792       parameters:
34793         - name: pnf-name
34794           in: path
34795           description: unique name of Physical Network Function.
34796           required: true
34797           type: string
34798           example: __PNF-NAME__
34799         - name: interface-name
34800           in: path
34801           description: Name that identifies the physical interface
34802           required: true
34803           type: string
34804           example: __INTERFACE-NAME__
34805         - name: body
34806           in: body
34807           description: p-interface object that needs to be updated.
34808           required: true
34809           schema:
34810             $ref: "#/patchDefinitions/p-interface"
34811     delete:
34812       tags:
34813         - Network
34814       summary: delete an existing p-interface
34815       description: delete an existing p-interface
34816       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
34817       consumes:
34818         - application/json
34819         - application/xml
34820       produces:
34821         - application/json
34822         - application/xml
34823       responses:
34824         "default":
34825           description: Response codes found in [response codes](https://wiki.onap.org/).
34826       parameters:
34827         - name: pnf-name
34828           in: path
34829           description: unique name of Physical Network Function.
34830           required: true
34831           type: string
34832           example: __PNF-NAME__
34833         - name: interface-name
34834           in: path
34835           description: Name that identifies the physical interface
34836           required: true
34837           type: string
34838           example: __INTERFACE-NAME__
34839         - name: resource-version
34840           in: query
34841           description: resource-version for concurrency
34842           required: true
34843           type: string
34844   /network/pnfs/pnf/{pnf-name}/p-interfaces:
34845     get:
34846       tags:
34847         - Network
34848       summary: returns p-interfaces
34849       description: returns p-interfaces
34850       operationId: getNetworkPnfsPnfPInterfaces
34851       produces:
34852         - application/json
34853         - application/xml
34854       responses:
34855         "200":
34856           description: successful operation
34857           schema:
34858               $ref: "#/getDefinitions/p-interfaces"
34859         "default":
34860           description: Response codes found in [response codes](https://wiki.onap.org/).
34861       parameters:
34862         - name: pnf-name
34863           in: path
34864           description: unique name of Physical Network Function.
34865           required: true
34866           type: string
34867           example: __PNF-NAME__
34868         - name: interface-name
34869           in: query
34870           description:
34871           required: false
34872           type: string
34873   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
34874     put:
34875       tags:
34876         - Network
34877       summary: see node definition for valid relationships
34878       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
34879       consumes:
34880         - application/json
34881         - application/xml
34882       produces:
34883         - application/json
34884         - application/xml
34885       responses:
34886         "default":
34887           description: Response codes found in [response codes](https://wiki.onap.org/).
34888       parameters:
34889         - name: pnf-name
34890           in: path
34891           description: unique name of Physical Network Function.
34892           required: true
34893           type: string
34894           example: __PNF-NAME__
34895         - name: interface-name
34896           in: path
34897           description: Name that identifies the link aggregate interface
34898           required: true
34899           type: string
34900           example: __INTERFACE-NAME__
34901         - name: body
34902           in: body
34903           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
34904           required: true
34905           schema:
34906             $ref: "#/definitions/relationship"
34907     delete:
34908       tags:
34909         - Network
34910       summary: delete an existing relationship
34911       description: delete an existing relationship
34912       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
34913       consumes:
34914         - application/json
34915         - application/xml
34916       produces:
34917         - application/json
34918         - application/xml
34919       responses:
34920         "default":
34921           description: Response codes found in [response codes](https://wiki.onap.org/).
34922       parameters:
34923         - name: pnf-name
34924           in: path
34925           description: unique name of Physical Network Function.
34926           required: true
34927           type: string
34928           example: __PNF-NAME__
34929         - name: interface-name
34930           in: path
34931           description: Name that identifies the link aggregate interface
34932           required: true
34933           type: string
34934           example: __INTERFACE-NAME__
34935   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34936     put:
34937       tags:
34938         - Network
34939       summary: see node definition for valid relationships
34940       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34941       consumes:
34942         - application/json
34943         - application/xml
34944       produces:
34945         - application/json
34946         - application/xml
34947       responses:
34948         "default":
34949           description: Response codes found in [response codes](https://wiki.onap.org/).
34950       parameters:
34951         - name: pnf-name
34952           in: path
34953           description: unique name of Physical Network Function.
34954           required: true
34955           type: string
34956           example: __PNF-NAME__
34957         - name: interface-name
34958           in: path
34959           description: Name that identifies the link aggregate interface
34960           required: true
34961           type: string
34962           example: __INTERFACE-NAME__
34963         - name: interface-name
34964           in: path
34965           description: Name given to the interface
34966           required: true
34967           type: string
34968           example: __INTERFACE-NAME__
34969         - name: vlan-interface
34970           in: path
34971           description: String that identifies the interface
34972           required: true
34973           type: string
34974           example: __VLAN-INTERFACE__
34975         - name: body
34976           in: body
34977           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34978           required: true
34979           schema:
34980             $ref: "#/definitions/relationship"
34981     delete:
34982       tags:
34983         - Network
34984       summary: delete an existing relationship
34985       description: delete an existing relationship
34986       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34987       consumes:
34988         - application/json
34989         - application/xml
34990       produces:
34991         - application/json
34992         - application/xml
34993       responses:
34994         "default":
34995           description: Response codes found in [response codes](https://wiki.onap.org/).
34996       parameters:
34997         - name: pnf-name
34998           in: path
34999           description: unique name of Physical Network Function.
35000           required: true
35001           type: string
35002           example: __PNF-NAME__
35003         - name: interface-name
35004           in: path
35005           description: Name that identifies the link aggregate interface
35006           required: true
35007           type: string
35008           example: __INTERFACE-NAME__
35009         - name: interface-name
35010           in: path
35011           description: Name given to the interface
35012           required: true
35013           type: string
35014           example: __INTERFACE-NAME__
35015         - name: vlan-interface
35016           in: path
35017           description: String that identifies the interface
35018           required: true
35019           type: string
35020           example: __VLAN-INTERFACE__
35021   /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:
35022     put:
35023       tags:
35024         - Network
35025       summary: see node definition for valid relationships
35026       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35027       consumes:
35028         - application/json
35029         - application/xml
35030       produces:
35031         - application/json
35032         - application/xml
35033       responses:
35034         "default":
35035           description: Response codes found in [response codes](https://wiki.onap.org/).
35036       parameters:
35037         - name: pnf-name
35038           in: path
35039           description: unique name of Physical Network Function.
35040           required: true
35041           type: string
35042           example: __PNF-NAME__
35043         - name: interface-name
35044           in: path
35045           description: Name that identifies the link aggregate interface
35046           required: true
35047           type: string
35048           example: __INTERFACE-NAME__
35049         - name: interface-name
35050           in: path
35051           description: Name given to the interface
35052           required: true
35053           type: string
35054           example: __INTERFACE-NAME__
35055         - name: vlan-interface
35056           in: path
35057           description: String that identifies the interface
35058           required: true
35059           type: string
35060           example: __VLAN-INTERFACE__
35061         - name: l3-interface-ipv4-address
35062           in: path
35063           description: IP address
35064           required: true
35065           type: string
35066           example: __L3-INTERFACE-IPV4-ADDRESS__
35067         - name: body
35068           in: body
35069           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35070           required: true
35071           schema:
35072             $ref: "#/definitions/relationship"
35073     delete:
35074       tags:
35075         - Network
35076       summary: delete an existing relationship
35077       description: delete an existing relationship
35078       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35079       consumes:
35080         - application/json
35081         - application/xml
35082       produces:
35083         - application/json
35084         - application/xml
35085       responses:
35086         "default":
35087           description: Response codes found in [response codes](https://wiki.onap.org/).
35088       parameters:
35089         - name: pnf-name
35090           in: path
35091           description: unique name of Physical Network Function.
35092           required: true
35093           type: string
35094           example: __PNF-NAME__
35095         - name: interface-name
35096           in: path
35097           description: Name that identifies the link aggregate interface
35098           required: true
35099           type: string
35100           example: __INTERFACE-NAME__
35101         - name: interface-name
35102           in: path
35103           description: Name given to the interface
35104           required: true
35105           type: string
35106           example: __INTERFACE-NAME__
35107         - name: vlan-interface
35108           in: path
35109           description: String that identifies the interface
35110           required: true
35111           type: string
35112           example: __VLAN-INTERFACE__
35113         - name: l3-interface-ipv4-address
35114           in: path
35115           description: IP address
35116           required: true
35117           type: string
35118           example: __L3-INTERFACE-IPV4-ADDRESS__
35119   /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}:
35120     get:
35121       tags:
35122         - Network
35123       summary: returns l3-interface-ipv4-address-list
35124       description: returns l3-interface-ipv4-address-list
35125       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35126       produces:
35127         - application/json
35128         - application/xml
35129       responses:
35130         "200":
35131           description: successful operation
35132           schema:
35133               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35134         "default":
35135           description: Response codes found in [response codes](https://wiki.onap.org/).
35136       parameters:
35137         - name: pnf-name
35138           in: path
35139           description: unique name of Physical Network Function.
35140           required: true
35141           type: string
35142           example: __PNF-NAME__
35143         - name: interface-name
35144           in: path
35145           description: Name that identifies the link aggregate interface
35146           required: true
35147           type: string
35148           example: __INTERFACE-NAME__
35149         - name: interface-name
35150           in: path
35151           description: Name given to the interface
35152           required: true
35153           type: string
35154           example: __INTERFACE-NAME__
35155         - name: vlan-interface
35156           in: path
35157           description: String that identifies the interface
35158           required: true
35159           type: string
35160           example: __VLAN-INTERFACE__
35161         - name: l3-interface-ipv4-address
35162           in: path
35163           description: IP address
35164           required: true
35165           type: string
35166           example: __L3-INTERFACE-IPV4-ADDRESS__
35167     put:
35168       tags:
35169         - Network
35170       summary: create or update an existing l3-interface-ipv4-address-list
35171       description: |
35172         Create or update an existing l3-interface-ipv4-address-list.
35173         #
35174         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35175       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35176       consumes:
35177         - application/json
35178         - application/xml
35179       produces:
35180         - application/json
35181         - application/xml
35182       responses:
35183         "default":
35184           description: Response codes found in [response codes](https://wiki.onap.org/).
35185       parameters:
35186         - name: pnf-name
35187           in: path
35188           description: unique name of Physical Network Function.
35189           required: true
35190           type: string
35191           example: __PNF-NAME__
35192         - name: interface-name
35193           in: path
35194           description: Name that identifies the link aggregate interface
35195           required: true
35196           type: string
35197           example: __INTERFACE-NAME__
35198         - name: interface-name
35199           in: path
35200           description: Name given to the interface
35201           required: true
35202           type: string
35203           example: __INTERFACE-NAME__
35204         - name: vlan-interface
35205           in: path
35206           description: String that identifies the interface
35207           required: true
35208           type: string
35209           example: __VLAN-INTERFACE__
35210         - name: l3-interface-ipv4-address
35211           in: path
35212           description: IP address
35213           required: true
35214           type: string
35215           example: __L3-INTERFACE-IPV4-ADDRESS__
35216         - name: body
35217           in: body
35218           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35219           required: true
35220           schema:
35221             $ref: "#/definitions/l3-interface-ipv4-address-list"
35222     patch:
35223       tags:
35224         - Network
35225       summary: update an existing l3-interface-ipv4-address-list
35226       description: |
35227         Update an existing l3-interface-ipv4-address-list
35228         #
35229         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35230         The PUT operation will entirely replace an existing object.
35231         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35232         #
35233         Other differences between PUT and PATCH are:
35234         #
35235         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35236         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35237         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35238       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35239       consumes:
35240         - application/json
35241         - application/xml
35242       produces:
35243         - application/json
35244         - application/xml
35245       responses:
35246         "default":
35247           description: Response codes found in [response codes](https://wiki.onap.org/).
35248       parameters:
35249         - name: pnf-name
35250           in: path
35251           description: unique name of Physical Network Function.
35252           required: true
35253           type: string
35254           example: __PNF-NAME__
35255         - name: interface-name
35256           in: path
35257           description: Name that identifies the link aggregate interface
35258           required: true
35259           type: string
35260           example: __INTERFACE-NAME__
35261         - name: interface-name
35262           in: path
35263           description: Name given to the interface
35264           required: true
35265           type: string
35266           example: __INTERFACE-NAME__
35267         - name: vlan-interface
35268           in: path
35269           description: String that identifies the interface
35270           required: true
35271           type: string
35272           example: __VLAN-INTERFACE__
35273         - name: l3-interface-ipv4-address
35274           in: path
35275           description: IP address
35276           required: true
35277           type: string
35278           example: __L3-INTERFACE-IPV4-ADDRESS__
35279         - name: body
35280           in: body
35281           description: l3-interface-ipv4-address-list object that needs to be updated.
35282           required: true
35283           schema:
35284             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35285     delete:
35286       tags:
35287         - Network
35288       summary: delete an existing l3-interface-ipv4-address-list
35289       description: delete an existing l3-interface-ipv4-address-list
35290       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35291       consumes:
35292         - application/json
35293         - application/xml
35294       produces:
35295         - application/json
35296         - application/xml
35297       responses:
35298         "default":
35299           description: Response codes found in [response codes](https://wiki.onap.org/).
35300       parameters:
35301         - name: pnf-name
35302           in: path
35303           description: unique name of Physical Network Function.
35304           required: true
35305           type: string
35306           example: __PNF-NAME__
35307         - name: interface-name
35308           in: path
35309           description: Name that identifies the link aggregate interface
35310           required: true
35311           type: string
35312           example: __INTERFACE-NAME__
35313         - name: interface-name
35314           in: path
35315           description: Name given to the interface
35316           required: true
35317           type: string
35318           example: __INTERFACE-NAME__
35319         - name: vlan-interface
35320           in: path
35321           description: String that identifies the interface
35322           required: true
35323           type: string
35324           example: __VLAN-INTERFACE__
35325         - name: l3-interface-ipv4-address
35326           in: path
35327           description: IP address
35328           required: true
35329           type: string
35330           example: __L3-INTERFACE-IPV4-ADDRESS__
35331         - name: resource-version
35332           in: query
35333           description: resource-version for concurrency
35334           required: true
35335           type: string
35336   /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:
35337     put:
35338       tags:
35339         - Network
35340       summary: see node definition for valid relationships
35341       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35342       consumes:
35343         - application/json
35344         - application/xml
35345       produces:
35346         - application/json
35347         - application/xml
35348       responses:
35349         "default":
35350           description: Response codes found in [response codes](https://wiki.onap.org/).
35351       parameters:
35352         - name: pnf-name
35353           in: path
35354           description: unique name of Physical Network Function.
35355           required: true
35356           type: string
35357           example: __PNF-NAME__
35358         - name: interface-name
35359           in: path
35360           description: Name that identifies the link aggregate interface
35361           required: true
35362           type: string
35363           example: __INTERFACE-NAME__
35364         - name: interface-name
35365           in: path
35366           description: Name given to the interface
35367           required: true
35368           type: string
35369           example: __INTERFACE-NAME__
35370         - name: vlan-interface
35371           in: path
35372           description: String that identifies the interface
35373           required: true
35374           type: string
35375           example: __VLAN-INTERFACE__
35376         - name: l3-interface-ipv6-address
35377           in: path
35378           description: IP address
35379           required: true
35380           type: string
35381           example: __L3-INTERFACE-IPV6-ADDRESS__
35382         - name: body
35383           in: body
35384           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35385           required: true
35386           schema:
35387             $ref: "#/definitions/relationship"
35388     delete:
35389       tags:
35390         - Network
35391       summary: delete an existing relationship
35392       description: delete an existing relationship
35393       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35394       consumes:
35395         - application/json
35396         - application/xml
35397       produces:
35398         - application/json
35399         - application/xml
35400       responses:
35401         "default":
35402           description: Response codes found in [response codes](https://wiki.onap.org/).
35403       parameters:
35404         - name: pnf-name
35405           in: path
35406           description: unique name of Physical Network Function.
35407           required: true
35408           type: string
35409           example: __PNF-NAME__
35410         - name: interface-name
35411           in: path
35412           description: Name that identifies the link aggregate interface
35413           required: true
35414           type: string
35415           example: __INTERFACE-NAME__
35416         - name: interface-name
35417           in: path
35418           description: Name given to the interface
35419           required: true
35420           type: string
35421           example: __INTERFACE-NAME__
35422         - name: vlan-interface
35423           in: path
35424           description: String that identifies the interface
35425           required: true
35426           type: string
35427           example: __VLAN-INTERFACE__
35428         - name: l3-interface-ipv6-address
35429           in: path
35430           description: IP address
35431           required: true
35432           type: string
35433           example: __L3-INTERFACE-IPV6-ADDRESS__
35434   /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}:
35435     get:
35436       tags:
35437         - Network
35438       summary: returns l3-interface-ipv6-address-list
35439       description: returns l3-interface-ipv6-address-list
35440       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35441       produces:
35442         - application/json
35443         - application/xml
35444       responses:
35445         "200":
35446           description: successful operation
35447           schema:
35448               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35449         "default":
35450           description: Response codes found in [response codes](https://wiki.onap.org/).
35451       parameters:
35452         - name: pnf-name
35453           in: path
35454           description: unique name of Physical Network Function.
35455           required: true
35456           type: string
35457           example: __PNF-NAME__
35458         - name: interface-name
35459           in: path
35460           description: Name that identifies the link aggregate interface
35461           required: true
35462           type: string
35463           example: __INTERFACE-NAME__
35464         - name: interface-name
35465           in: path
35466           description: Name given to the interface
35467           required: true
35468           type: string
35469           example: __INTERFACE-NAME__
35470         - name: vlan-interface
35471           in: path
35472           description: String that identifies the interface
35473           required: true
35474           type: string
35475           example: __VLAN-INTERFACE__
35476         - name: l3-interface-ipv6-address
35477           in: path
35478           description: IP address
35479           required: true
35480           type: string
35481           example: __L3-INTERFACE-IPV6-ADDRESS__
35482     put:
35483       tags:
35484         - Network
35485       summary: create or update an existing l3-interface-ipv6-address-list
35486       description: |
35487         Create or update an existing l3-interface-ipv6-address-list.
35488         #
35489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35490       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35491       consumes:
35492         - application/json
35493         - application/xml
35494       produces:
35495         - application/json
35496         - application/xml
35497       responses:
35498         "default":
35499           description: Response codes found in [response codes](https://wiki.onap.org/).
35500       parameters:
35501         - name: pnf-name
35502           in: path
35503           description: unique name of Physical Network Function.
35504           required: true
35505           type: string
35506           example: __PNF-NAME__
35507         - name: interface-name
35508           in: path
35509           description: Name that identifies the link aggregate interface
35510           required: true
35511           type: string
35512           example: __INTERFACE-NAME__
35513         - name: interface-name
35514           in: path
35515           description: Name given to the interface
35516           required: true
35517           type: string
35518           example: __INTERFACE-NAME__
35519         - name: vlan-interface
35520           in: path
35521           description: String that identifies the interface
35522           required: true
35523           type: string
35524           example: __VLAN-INTERFACE__
35525         - name: l3-interface-ipv6-address
35526           in: path
35527           description: IP address
35528           required: true
35529           type: string
35530           example: __L3-INTERFACE-IPV6-ADDRESS__
35531         - name: body
35532           in: body
35533           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35534           required: true
35535           schema:
35536             $ref: "#/definitions/l3-interface-ipv6-address-list"
35537     patch:
35538       tags:
35539         - Network
35540       summary: update an existing l3-interface-ipv6-address-list
35541       description: |
35542         Update an existing l3-interface-ipv6-address-list
35543         #
35544         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35545         The PUT operation will entirely replace an existing object.
35546         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35547         #
35548         Other differences between PUT and PATCH are:
35549         #
35550         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35551         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35552         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35553       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35554       consumes:
35555         - application/json
35556         - application/xml
35557       produces:
35558         - application/json
35559         - application/xml
35560       responses:
35561         "default":
35562           description: Response codes found in [response codes](https://wiki.onap.org/).
35563       parameters:
35564         - name: pnf-name
35565           in: path
35566           description: unique name of Physical Network Function.
35567           required: true
35568           type: string
35569           example: __PNF-NAME__
35570         - name: interface-name
35571           in: path
35572           description: Name that identifies the link aggregate interface
35573           required: true
35574           type: string
35575           example: __INTERFACE-NAME__
35576         - name: interface-name
35577           in: path
35578           description: Name given to the interface
35579           required: true
35580           type: string
35581           example: __INTERFACE-NAME__
35582         - name: vlan-interface
35583           in: path
35584           description: String that identifies the interface
35585           required: true
35586           type: string
35587           example: __VLAN-INTERFACE__
35588         - name: l3-interface-ipv6-address
35589           in: path
35590           description: IP address
35591           required: true
35592           type: string
35593           example: __L3-INTERFACE-IPV6-ADDRESS__
35594         - name: body
35595           in: body
35596           description: l3-interface-ipv6-address-list object that needs to be updated.
35597           required: true
35598           schema:
35599             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35600     delete:
35601       tags:
35602         - Network
35603       summary: delete an existing l3-interface-ipv6-address-list
35604       description: delete an existing l3-interface-ipv6-address-list
35605       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35606       consumes:
35607         - application/json
35608         - application/xml
35609       produces:
35610         - application/json
35611         - application/xml
35612       responses:
35613         "default":
35614           description: Response codes found in [response codes](https://wiki.onap.org/).
35615       parameters:
35616         - name: pnf-name
35617           in: path
35618           description: unique name of Physical Network Function.
35619           required: true
35620           type: string
35621           example: __PNF-NAME__
35622         - name: interface-name
35623           in: path
35624           description: Name that identifies the link aggregate interface
35625           required: true
35626           type: string
35627           example: __INTERFACE-NAME__
35628         - name: interface-name
35629           in: path
35630           description: Name given to the interface
35631           required: true
35632           type: string
35633           example: __INTERFACE-NAME__
35634         - name: vlan-interface
35635           in: path
35636           description: String that identifies the interface
35637           required: true
35638           type: string
35639           example: __VLAN-INTERFACE__
35640         - name: l3-interface-ipv6-address
35641           in: path
35642           description: IP address
35643           required: true
35644           type: string
35645           example: __L3-INTERFACE-IPV6-ADDRESS__
35646         - name: resource-version
35647           in: query
35648           description: resource-version for concurrency
35649           required: true
35650           type: string
35651   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35652     get:
35653       tags:
35654         - Network
35655       summary: returns vlan
35656       description: returns vlan
35657       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35658       produces:
35659         - application/json
35660         - application/xml
35661       responses:
35662         "200":
35663           description: successful operation
35664           schema:
35665               $ref: "#/getDefinitions/vlan"
35666         "default":
35667           description: Response codes found in [response codes](https://wiki.onap.org/).
35668       parameters:
35669         - name: pnf-name
35670           in: path
35671           description: unique name of Physical Network Function.
35672           required: true
35673           type: string
35674           example: __PNF-NAME__
35675         - name: interface-name
35676           in: path
35677           description: Name that identifies the link aggregate interface
35678           required: true
35679           type: string
35680           example: __INTERFACE-NAME__
35681         - name: interface-name
35682           in: path
35683           description: Name given to the interface
35684           required: true
35685           type: string
35686           example: __INTERFACE-NAME__
35687         - name: vlan-interface
35688           in: path
35689           description: String that identifies the interface
35690           required: true
35691           type: string
35692           example: __VLAN-INTERFACE__
35693     put:
35694       tags:
35695         - Network
35696       summary: create or update an existing vlan
35697       description: |
35698         Create or update an existing vlan.
35699         #
35700         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35701       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35702       consumes:
35703         - application/json
35704         - application/xml
35705       produces:
35706         - application/json
35707         - application/xml
35708       responses:
35709         "default":
35710           description: Response codes found in [response codes](https://wiki.onap.org/).
35711       parameters:
35712         - name: pnf-name
35713           in: path
35714           description: unique name of Physical Network Function.
35715           required: true
35716           type: string
35717           example: __PNF-NAME__
35718         - name: interface-name
35719           in: path
35720           description: Name that identifies the link aggregate interface
35721           required: true
35722           type: string
35723           example: __INTERFACE-NAME__
35724         - name: interface-name
35725           in: path
35726           description: Name given to the interface
35727           required: true
35728           type: string
35729           example: __INTERFACE-NAME__
35730         - name: vlan-interface
35731           in: path
35732           description: String that identifies the interface
35733           required: true
35734           type: string
35735           example: __VLAN-INTERFACE__
35736         - name: body
35737           in: body
35738           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
35739           required: true
35740           schema:
35741             $ref: "#/definitions/vlan"
35742     patch:
35743       tags:
35744         - Network
35745       summary: update an existing vlan
35746       description: |
35747         Update an existing vlan
35748         #
35749         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35750         The PUT operation will entirely replace an existing object.
35751         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35752         #
35753         Other differences between PUT and PATCH are:
35754         #
35755         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35756         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35757         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35758       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35759       consumes:
35760         - application/json
35761         - application/xml
35762       produces:
35763         - application/json
35764         - application/xml
35765       responses:
35766         "default":
35767           description: Response codes found in [response codes](https://wiki.onap.org/).
35768       parameters:
35769         - name: pnf-name
35770           in: path
35771           description: unique name of Physical Network Function.
35772           required: true
35773           type: string
35774           example: __PNF-NAME__
35775         - name: interface-name
35776           in: path
35777           description: Name that identifies the link aggregate interface
35778           required: true
35779           type: string
35780           example: __INTERFACE-NAME__
35781         - name: interface-name
35782           in: path
35783           description: Name given to the interface
35784           required: true
35785           type: string
35786           example: __INTERFACE-NAME__
35787         - name: vlan-interface
35788           in: path
35789           description: String that identifies the interface
35790           required: true
35791           type: string
35792           example: __VLAN-INTERFACE__
35793         - name: body
35794           in: body
35795           description: vlan object that needs to be updated.
35796           required: true
35797           schema:
35798             $ref: "#/patchDefinitions/vlan"
35799     delete:
35800       tags:
35801         - Network
35802       summary: delete an existing vlan
35803       description: delete an existing vlan
35804       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35805       consumes:
35806         - application/json
35807         - application/xml
35808       produces:
35809         - application/json
35810         - application/xml
35811       responses:
35812         "default":
35813           description: Response codes found in [response codes](https://wiki.onap.org/).
35814       parameters:
35815         - name: pnf-name
35816           in: path
35817           description: unique name of Physical Network Function.
35818           required: true
35819           type: string
35820           example: __PNF-NAME__
35821         - name: interface-name
35822           in: path
35823           description: Name that identifies the link aggregate interface
35824           required: true
35825           type: string
35826           example: __INTERFACE-NAME__
35827         - name: interface-name
35828           in: path
35829           description: Name given to the interface
35830           required: true
35831           type: string
35832           example: __INTERFACE-NAME__
35833         - name: vlan-interface
35834           in: path
35835           description: String that identifies the interface
35836           required: true
35837           type: string
35838           example: __VLAN-INTERFACE__
35839         - name: resource-version
35840           in: query
35841           description: resource-version for concurrency
35842           required: true
35843           type: string
35844   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35845     get:
35846       tags:
35847         - Network
35848       summary: returns vlans
35849       description: returns vlans
35850       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
35851       produces:
35852         - application/json
35853         - application/xml
35854       responses:
35855         "200":
35856           description: successful operation
35857           schema:
35858               $ref: "#/getDefinitions/vlans"
35859         "default":
35860           description: Response codes found in [response codes](https://wiki.onap.org/).
35861       parameters:
35862         - name: pnf-name
35863           in: path
35864           description: unique name of Physical Network Function.
35865           required: true
35866           type: string
35867           example: __PNF-NAME__
35868         - name: interface-name
35869           in: path
35870           description: Name that identifies the link aggregate interface
35871           required: true
35872           type: string
35873           example: __INTERFACE-NAME__
35874         - name: interface-name
35875           in: path
35876           description: Name given to the interface
35877           required: true
35878           type: string
35879           example: __INTERFACE-NAME__
35880         - name: vlan-interface
35881           in: query
35882           description:
35883           required: false
35884           type: string
35885         - name: vlan-id-inner
35886           in: query
35887           description:
35888           required: false
35889           type: integer
35890           format: int64
35891         - name: vpn-id
35892           in: query
35893           description:
35894           required: false
35895           type: string
35896   /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:
35897     put:
35898       tags:
35899         - Network
35900       summary: see node definition for valid relationships
35901       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35902       consumes:
35903         - application/json
35904         - application/xml
35905       produces:
35906         - application/json
35907         - application/xml
35908       responses:
35909         "default":
35910           description: Response codes found in [response codes](https://wiki.onap.org/).
35911       parameters:
35912         - name: pnf-name
35913           in: path
35914           description: unique name of Physical Network Function.
35915           required: true
35916           type: string
35917           example: __PNF-NAME__
35918         - name: interface-name
35919           in: path
35920           description: Name that identifies the link aggregate interface
35921           required: true
35922           type: string
35923           example: __INTERFACE-NAME__
35924         - name: interface-name
35925           in: path
35926           description: Name given to the interface
35927           required: true
35928           type: string
35929           example: __INTERFACE-NAME__
35930         - name: pci-id
35931           in: path
35932           description: PCI ID used to identify the sriov-vf
35933           required: true
35934           type: string
35935           example: __PCI-ID__
35936         - name: body
35937           in: body
35938           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35939           required: true
35940           schema:
35941             $ref: "#/definitions/relationship"
35942     delete:
35943       tags:
35944         - Network
35945       summary: delete an existing relationship
35946       description: delete an existing relationship
35947       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35948       consumes:
35949         - application/json
35950         - application/xml
35951       produces:
35952         - application/json
35953         - application/xml
35954       responses:
35955         "default":
35956           description: Response codes found in [response codes](https://wiki.onap.org/).
35957       parameters:
35958         - name: pnf-name
35959           in: path
35960           description: unique name of Physical Network Function.
35961           required: true
35962           type: string
35963           example: __PNF-NAME__
35964         - name: interface-name
35965           in: path
35966           description: Name that identifies the link aggregate interface
35967           required: true
35968           type: string
35969           example: __INTERFACE-NAME__
35970         - name: interface-name
35971           in: path
35972           description: Name given to the interface
35973           required: true
35974           type: string
35975           example: __INTERFACE-NAME__
35976         - name: pci-id
35977           in: path
35978           description: PCI ID used to identify the sriov-vf
35979           required: true
35980           type: string
35981           example: __PCI-ID__
35982   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35983     get:
35984       tags:
35985         - Network
35986       summary: returns sriov-vf
35987       description: returns sriov-vf
35988       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35989       produces:
35990         - application/json
35991         - application/xml
35992       responses:
35993         "200":
35994           description: successful operation
35995           schema:
35996               $ref: "#/getDefinitions/sriov-vf"
35997         "default":
35998           description: Response codes found in [response codes](https://wiki.onap.org/).
35999       parameters:
36000         - name: pnf-name
36001           in: path
36002           description: unique name of Physical Network Function.
36003           required: true
36004           type: string
36005           example: __PNF-NAME__
36006         - name: interface-name
36007           in: path
36008           description: Name that identifies the link aggregate interface
36009           required: true
36010           type: string
36011           example: __INTERFACE-NAME__
36012         - name: interface-name
36013           in: path
36014           description: Name given to the interface
36015           required: true
36016           type: string
36017           example: __INTERFACE-NAME__
36018         - name: pci-id
36019           in: path
36020           description: PCI ID used to identify the sriov-vf
36021           required: true
36022           type: string
36023           example: __PCI-ID__
36024     put:
36025       tags:
36026         - Network
36027       summary: create or update an existing sriov-vf
36028       description: |
36029         Create or update an existing sriov-vf.
36030         #
36031         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36032       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36033       consumes:
36034         - application/json
36035         - application/xml
36036       produces:
36037         - application/json
36038         - application/xml
36039       responses:
36040         "default":
36041           description: Response codes found in [response codes](https://wiki.onap.org/).
36042       parameters:
36043         - name: pnf-name
36044           in: path
36045           description: unique name of Physical Network Function.
36046           required: true
36047           type: string
36048           example: __PNF-NAME__
36049         - name: interface-name
36050           in: path
36051           description: Name that identifies the link aggregate interface
36052           required: true
36053           type: string
36054           example: __INTERFACE-NAME__
36055         - name: interface-name
36056           in: path
36057           description: Name given to the interface
36058           required: true
36059           type: string
36060           example: __INTERFACE-NAME__
36061         - name: pci-id
36062           in: path
36063           description: PCI ID used to identify the sriov-vf
36064           required: true
36065           type: string
36066           example: __PCI-ID__
36067         - name: body
36068           in: body
36069           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36070           required: true
36071           schema:
36072             $ref: "#/definitions/sriov-vf"
36073     patch:
36074       tags:
36075         - Network
36076       summary: update an existing sriov-vf
36077       description: |
36078         Update an existing sriov-vf
36079         #
36080         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36081         The PUT operation will entirely replace an existing object.
36082         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36083         #
36084         Other differences between PUT and PATCH are:
36085         #
36086         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36087         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36088         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36089       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36090       consumes:
36091         - application/json
36092         - application/xml
36093       produces:
36094         - application/json
36095         - application/xml
36096       responses:
36097         "default":
36098           description: Response codes found in [response codes](https://wiki.onap.org/).
36099       parameters:
36100         - name: pnf-name
36101           in: path
36102           description: unique name of Physical Network Function.
36103           required: true
36104           type: string
36105           example: __PNF-NAME__
36106         - name: interface-name
36107           in: path
36108           description: Name that identifies the link aggregate interface
36109           required: true
36110           type: string
36111           example: __INTERFACE-NAME__
36112         - name: interface-name
36113           in: path
36114           description: Name given to the interface
36115           required: true
36116           type: string
36117           example: __INTERFACE-NAME__
36118         - name: pci-id
36119           in: path
36120           description: PCI ID used to identify the sriov-vf
36121           required: true
36122           type: string
36123           example: __PCI-ID__
36124         - name: body
36125           in: body
36126           description: sriov-vf object that needs to be updated.
36127           required: true
36128           schema:
36129             $ref: "#/patchDefinitions/sriov-vf"
36130     delete:
36131       tags:
36132         - Network
36133       summary: delete an existing sriov-vf
36134       description: delete an existing sriov-vf
36135       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36136       consumes:
36137         - application/json
36138         - application/xml
36139       produces:
36140         - application/json
36141         - application/xml
36142       responses:
36143         "default":
36144           description: Response codes found in [response codes](https://wiki.onap.org/).
36145       parameters:
36146         - name: pnf-name
36147           in: path
36148           description: unique name of Physical Network Function.
36149           required: true
36150           type: string
36151           example: __PNF-NAME__
36152         - name: interface-name
36153           in: path
36154           description: Name that identifies the link aggregate interface
36155           required: true
36156           type: string
36157           example: __INTERFACE-NAME__
36158         - name: interface-name
36159           in: path
36160           description: Name given to the interface
36161           required: true
36162           type: string
36163           example: __INTERFACE-NAME__
36164         - name: pci-id
36165           in: path
36166           description: PCI ID used to identify the sriov-vf
36167           required: true
36168           type: string
36169           example: __PCI-ID__
36170         - name: resource-version
36171           in: query
36172           description: resource-version for concurrency
36173           required: true
36174           type: string
36175   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36176     get:
36177       tags:
36178         - Network
36179       summary: returns sriov-vfs
36180       description: returns sriov-vfs
36181       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
36182       produces:
36183         - application/json
36184         - application/xml
36185       responses:
36186         "200":
36187           description: successful operation
36188           schema:
36189               $ref: "#/getDefinitions/sriov-vfs"
36190         "default":
36191           description: Response codes found in [response codes](https://wiki.onap.org/).
36192       parameters:
36193         - name: pnf-name
36194           in: path
36195           description: unique name of Physical Network Function.
36196           required: true
36197           type: string
36198           example: __PNF-NAME__
36199         - name: interface-name
36200           in: path
36201           description: Name that identifies the link aggregate interface
36202           required: true
36203           type: string
36204           example: __INTERFACE-NAME__
36205         - name: interface-name
36206           in: path
36207           description: Name given to the interface
36208           required: true
36209           type: string
36210           example: __INTERFACE-NAME__
36211         - name: pci-id
36212           in: query
36213           description:
36214           required: false
36215           type: string
36216         - name: vf-vlan-filter
36217           in: query
36218           description:
36219           required: false
36220           type: string
36221         - name: vf-mac-filter
36222           in: query
36223           description:
36224           required: false
36225           type: string
36226         - name: vf-vlan-strip
36227           in: query
36228           description:
36229           required: false
36230           type: boolean
36231         - name: neutron-network-id
36232           in: query
36233           description:
36234           required: false
36235           type: string
36236   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36237     put:
36238       tags:
36239         - Network
36240       summary: see node definition for valid relationships
36241       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
36242       consumes:
36243         - application/json
36244         - application/xml
36245       produces:
36246         - application/json
36247         - application/xml
36248       responses:
36249         "default":
36250           description: Response codes found in [response codes](https://wiki.onap.org/).
36251       parameters:
36252         - name: pnf-name
36253           in: path
36254           description: unique name of Physical Network Function.
36255           required: true
36256           type: string
36257           example: __PNF-NAME__
36258         - name: interface-name
36259           in: path
36260           description: Name that identifies the link aggregate interface
36261           required: true
36262           type: string
36263           example: __INTERFACE-NAME__
36264         - name: interface-name
36265           in: path
36266           description: Name given to the interface
36267           required: true
36268           type: string
36269           example: __INTERFACE-NAME__
36270         - name: body
36271           in: body
36272           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36273           required: true
36274           schema:
36275             $ref: "#/definitions/relationship"
36276     delete:
36277       tags:
36278         - Network
36279       summary: delete an existing relationship
36280       description: delete an existing relationship
36281       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
36282       consumes:
36283         - application/json
36284         - application/xml
36285       produces:
36286         - application/json
36287         - application/xml
36288       responses:
36289         "default":
36290           description: Response codes found in [response codes](https://wiki.onap.org/).
36291       parameters:
36292         - name: pnf-name
36293           in: path
36294           description: unique name of Physical Network Function.
36295           required: true
36296           type: string
36297           example: __PNF-NAME__
36298         - name: interface-name
36299           in: path
36300           description: Name that identifies the link aggregate interface
36301           required: true
36302           type: string
36303           example: __INTERFACE-NAME__
36304         - name: interface-name
36305           in: path
36306           description: Name given to the interface
36307           required: true
36308           type: string
36309           example: __INTERFACE-NAME__
36310   /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:
36311     put:
36312       tags:
36313         - Network
36314       summary: see node definition for valid relationships
36315       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36316       consumes:
36317         - application/json
36318         - application/xml
36319       produces:
36320         - application/json
36321         - application/xml
36322       responses:
36323         "default":
36324           description: Response codes found in [response codes](https://wiki.onap.org/).
36325       parameters:
36326         - name: pnf-name
36327           in: path
36328           description: unique name of Physical Network Function.
36329           required: true
36330           type: string
36331           example: __PNF-NAME__
36332         - name: interface-name
36333           in: path
36334           description: Name that identifies the link aggregate interface
36335           required: true
36336           type: string
36337           example: __INTERFACE-NAME__
36338         - name: interface-name
36339           in: path
36340           description: Name given to the interface
36341           required: true
36342           type: string
36343           example: __INTERFACE-NAME__
36344         - name: l3-interface-ipv4-address
36345           in: path
36346           description: IP address
36347           required: true
36348           type: string
36349           example: __L3-INTERFACE-IPV4-ADDRESS__
36350         - name: body
36351           in: body
36352           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36353           required: true
36354           schema:
36355             $ref: "#/definitions/relationship"
36356     delete:
36357       tags:
36358         - Network
36359       summary: delete an existing relationship
36360       description: delete an existing relationship
36361       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36362       consumes:
36363         - application/json
36364         - application/xml
36365       produces:
36366         - application/json
36367         - application/xml
36368       responses:
36369         "default":
36370           description: Response codes found in [response codes](https://wiki.onap.org/).
36371       parameters:
36372         - name: pnf-name
36373           in: path
36374           description: unique name of Physical Network Function.
36375           required: true
36376           type: string
36377           example: __PNF-NAME__
36378         - name: interface-name
36379           in: path
36380           description: Name that identifies the link aggregate interface
36381           required: true
36382           type: string
36383           example: __INTERFACE-NAME__
36384         - name: interface-name
36385           in: path
36386           description: Name given to the interface
36387           required: true
36388           type: string
36389           example: __INTERFACE-NAME__
36390         - name: l3-interface-ipv4-address
36391           in: path
36392           description: IP address
36393           required: true
36394           type: string
36395           example: __L3-INTERFACE-IPV4-ADDRESS__
36396   /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}:
36397     get:
36398       tags:
36399         - Network
36400       summary: returns l3-interface-ipv4-address-list
36401       description: returns l3-interface-ipv4-address-list
36402       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36403       produces:
36404         - application/json
36405         - application/xml
36406       responses:
36407         "200":
36408           description: successful operation
36409           schema:
36410               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36411         "default":
36412           description: Response codes found in [response codes](https://wiki.onap.org/).
36413       parameters:
36414         - name: pnf-name
36415           in: path
36416           description: unique name of Physical Network Function.
36417           required: true
36418           type: string
36419           example: __PNF-NAME__
36420         - name: interface-name
36421           in: path
36422           description: Name that identifies the link aggregate interface
36423           required: true
36424           type: string
36425           example: __INTERFACE-NAME__
36426         - name: interface-name
36427           in: path
36428           description: Name given to the interface
36429           required: true
36430           type: string
36431           example: __INTERFACE-NAME__
36432         - name: l3-interface-ipv4-address
36433           in: path
36434           description: IP address
36435           required: true
36436           type: string
36437           example: __L3-INTERFACE-IPV4-ADDRESS__
36438     put:
36439       tags:
36440         - Network
36441       summary: create or update an existing l3-interface-ipv4-address-list
36442       description: |
36443         Create or update an existing l3-interface-ipv4-address-list.
36444         #
36445         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36446       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36447       consumes:
36448         - application/json
36449         - application/xml
36450       produces:
36451         - application/json
36452         - application/xml
36453       responses:
36454         "default":
36455           description: Response codes found in [response codes](https://wiki.onap.org/).
36456       parameters:
36457         - name: pnf-name
36458           in: path
36459           description: unique name of Physical Network Function.
36460           required: true
36461           type: string
36462           example: __PNF-NAME__
36463         - name: interface-name
36464           in: path
36465           description: Name that identifies the link aggregate interface
36466           required: true
36467           type: string
36468           example: __INTERFACE-NAME__
36469         - name: interface-name
36470           in: path
36471           description: Name given to the interface
36472           required: true
36473           type: string
36474           example: __INTERFACE-NAME__
36475         - name: l3-interface-ipv4-address
36476           in: path
36477           description: IP address
36478           required: true
36479           type: string
36480           example: __L3-INTERFACE-IPV4-ADDRESS__
36481         - name: body
36482           in: body
36483           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36484           required: true
36485           schema:
36486             $ref: "#/definitions/l3-interface-ipv4-address-list"
36487     patch:
36488       tags:
36489         - Network
36490       summary: update an existing l3-interface-ipv4-address-list
36491       description: |
36492         Update an existing l3-interface-ipv4-address-list
36493         #
36494         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36495         The PUT operation will entirely replace an existing object.
36496         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36497         #
36498         Other differences between PUT and PATCH are:
36499         #
36500         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36501         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36502         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36503       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36504       consumes:
36505         - application/json
36506         - application/xml
36507       produces:
36508         - application/json
36509         - application/xml
36510       responses:
36511         "default":
36512           description: Response codes found in [response codes](https://wiki.onap.org/).
36513       parameters:
36514         - name: pnf-name
36515           in: path
36516           description: unique name of Physical Network Function.
36517           required: true
36518           type: string
36519           example: __PNF-NAME__
36520         - name: interface-name
36521           in: path
36522           description: Name that identifies the link aggregate interface
36523           required: true
36524           type: string
36525           example: __INTERFACE-NAME__
36526         - name: interface-name
36527           in: path
36528           description: Name given to the interface
36529           required: true
36530           type: string
36531           example: __INTERFACE-NAME__
36532         - name: l3-interface-ipv4-address
36533           in: path
36534           description: IP address
36535           required: true
36536           type: string
36537           example: __L3-INTERFACE-IPV4-ADDRESS__
36538         - name: body
36539           in: body
36540           description: l3-interface-ipv4-address-list object that needs to be updated.
36541           required: true
36542           schema:
36543             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36544     delete:
36545       tags:
36546         - Network
36547       summary: delete an existing l3-interface-ipv4-address-list
36548       description: delete an existing l3-interface-ipv4-address-list
36549       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36550       consumes:
36551         - application/json
36552         - application/xml
36553       produces:
36554         - application/json
36555         - application/xml
36556       responses:
36557         "default":
36558           description: Response codes found in [response codes](https://wiki.onap.org/).
36559       parameters:
36560         - name: pnf-name
36561           in: path
36562           description: unique name of Physical Network Function.
36563           required: true
36564           type: string
36565           example: __PNF-NAME__
36566         - name: interface-name
36567           in: path
36568           description: Name that identifies the link aggregate interface
36569           required: true
36570           type: string
36571           example: __INTERFACE-NAME__
36572         - name: interface-name
36573           in: path
36574           description: Name given to the interface
36575           required: true
36576           type: string
36577           example: __INTERFACE-NAME__
36578         - name: l3-interface-ipv4-address
36579           in: path
36580           description: IP address
36581           required: true
36582           type: string
36583           example: __L3-INTERFACE-IPV4-ADDRESS__
36584         - name: resource-version
36585           in: query
36586           description: resource-version for concurrency
36587           required: true
36588           type: string
36589   /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:
36590     put:
36591       tags:
36592         - Network
36593       summary: see node definition for valid relationships
36594       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36595       consumes:
36596         - application/json
36597         - application/xml
36598       produces:
36599         - application/json
36600         - application/xml
36601       responses:
36602         "default":
36603           description: Response codes found in [response codes](https://wiki.onap.org/).
36604       parameters:
36605         - name: pnf-name
36606           in: path
36607           description: unique name of Physical Network Function.
36608           required: true
36609           type: string
36610           example: __PNF-NAME__
36611         - name: interface-name
36612           in: path
36613           description: Name that identifies the link aggregate interface
36614           required: true
36615           type: string
36616           example: __INTERFACE-NAME__
36617         - name: interface-name
36618           in: path
36619           description: Name given to the interface
36620           required: true
36621           type: string
36622           example: __INTERFACE-NAME__
36623         - name: l3-interface-ipv6-address
36624           in: path
36625           description: IP address
36626           required: true
36627           type: string
36628           example: __L3-INTERFACE-IPV6-ADDRESS__
36629         - name: body
36630           in: body
36631           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36632           required: true
36633           schema:
36634             $ref: "#/definitions/relationship"
36635     delete:
36636       tags:
36637         - Network
36638       summary: delete an existing relationship
36639       description: delete an existing relationship
36640       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36641       consumes:
36642         - application/json
36643         - application/xml
36644       produces:
36645         - application/json
36646         - application/xml
36647       responses:
36648         "default":
36649           description: Response codes found in [response codes](https://wiki.onap.org/).
36650       parameters:
36651         - name: pnf-name
36652           in: path
36653           description: unique name of Physical Network Function.
36654           required: true
36655           type: string
36656           example: __PNF-NAME__
36657         - name: interface-name
36658           in: path
36659           description: Name that identifies the link aggregate interface
36660           required: true
36661           type: string
36662           example: __INTERFACE-NAME__
36663         - name: interface-name
36664           in: path
36665           description: Name given to the interface
36666           required: true
36667           type: string
36668           example: __INTERFACE-NAME__
36669         - name: l3-interface-ipv6-address
36670           in: path
36671           description: IP address
36672           required: true
36673           type: string
36674           example: __L3-INTERFACE-IPV6-ADDRESS__
36675   /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}:
36676     get:
36677       tags:
36678         - Network
36679       summary: returns l3-interface-ipv6-address-list
36680       description: returns l3-interface-ipv6-address-list
36681       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36682       produces:
36683         - application/json
36684         - application/xml
36685       responses:
36686         "200":
36687           description: successful operation
36688           schema:
36689               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36690         "default":
36691           description: Response codes found in [response codes](https://wiki.onap.org/).
36692       parameters:
36693         - name: pnf-name
36694           in: path
36695           description: unique name of Physical Network Function.
36696           required: true
36697           type: string
36698           example: __PNF-NAME__
36699         - name: interface-name
36700           in: path
36701           description: Name that identifies the link aggregate interface
36702           required: true
36703           type: string
36704           example: __INTERFACE-NAME__
36705         - name: interface-name
36706           in: path
36707           description: Name given to the interface
36708           required: true
36709           type: string
36710           example: __INTERFACE-NAME__
36711         - name: l3-interface-ipv6-address
36712           in: path
36713           description: IP address
36714           required: true
36715           type: string
36716           example: __L3-INTERFACE-IPV6-ADDRESS__
36717     put:
36718       tags:
36719         - Network
36720       summary: create or update an existing l3-interface-ipv6-address-list
36721       description: |
36722         Create or update an existing l3-interface-ipv6-address-list.
36723         #
36724         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36725       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36726       consumes:
36727         - application/json
36728         - application/xml
36729       produces:
36730         - application/json
36731         - application/xml
36732       responses:
36733         "default":
36734           description: Response codes found in [response codes](https://wiki.onap.org/).
36735       parameters:
36736         - name: pnf-name
36737           in: path
36738           description: unique name of Physical Network Function.
36739           required: true
36740           type: string
36741           example: __PNF-NAME__
36742         - name: interface-name
36743           in: path
36744           description: Name that identifies the link aggregate interface
36745           required: true
36746           type: string
36747           example: __INTERFACE-NAME__
36748         - name: interface-name
36749           in: path
36750           description: Name given to the interface
36751           required: true
36752           type: string
36753           example: __INTERFACE-NAME__
36754         - name: l3-interface-ipv6-address
36755           in: path
36756           description: IP address
36757           required: true
36758           type: string
36759           example: __L3-INTERFACE-IPV6-ADDRESS__
36760         - name: body
36761           in: body
36762           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36763           required: true
36764           schema:
36765             $ref: "#/definitions/l3-interface-ipv6-address-list"
36766     patch:
36767       tags:
36768         - Network
36769       summary: update an existing l3-interface-ipv6-address-list
36770       description: |
36771         Update an existing l3-interface-ipv6-address-list
36772         #
36773         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36774         The PUT operation will entirely replace an existing object.
36775         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36776         #
36777         Other differences between PUT and PATCH are:
36778         #
36779         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36780         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36781         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36782       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36783       consumes:
36784         - application/json
36785         - application/xml
36786       produces:
36787         - application/json
36788         - application/xml
36789       responses:
36790         "default":
36791           description: Response codes found in [response codes](https://wiki.onap.org/).
36792       parameters:
36793         - name: pnf-name
36794           in: path
36795           description: unique name of Physical Network Function.
36796           required: true
36797           type: string
36798           example: __PNF-NAME__
36799         - name: interface-name
36800           in: path
36801           description: Name that identifies the link aggregate interface
36802           required: true
36803           type: string
36804           example: __INTERFACE-NAME__
36805         - name: interface-name
36806           in: path
36807           description: Name given to the interface
36808           required: true
36809           type: string
36810           example: __INTERFACE-NAME__
36811         - name: l3-interface-ipv6-address
36812           in: path
36813           description: IP address
36814           required: true
36815           type: string
36816           example: __L3-INTERFACE-IPV6-ADDRESS__
36817         - name: body
36818           in: body
36819           description: l3-interface-ipv6-address-list object that needs to be updated.
36820           required: true
36821           schema:
36822             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36823     delete:
36824       tags:
36825         - Network
36826       summary: delete an existing l3-interface-ipv6-address-list
36827       description: delete an existing l3-interface-ipv6-address-list
36828       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36829       consumes:
36830         - application/json
36831         - application/xml
36832       produces:
36833         - application/json
36834         - application/xml
36835       responses:
36836         "default":
36837           description: Response codes found in [response codes](https://wiki.onap.org/).
36838       parameters:
36839         - name: pnf-name
36840           in: path
36841           description: unique name of Physical Network Function.
36842           required: true
36843           type: string
36844           example: __PNF-NAME__
36845         - name: interface-name
36846           in: path
36847           description: Name that identifies the link aggregate interface
36848           required: true
36849           type: string
36850           example: __INTERFACE-NAME__
36851         - name: interface-name
36852           in: path
36853           description: Name given to the interface
36854           required: true
36855           type: string
36856           example: __INTERFACE-NAME__
36857         - name: l3-interface-ipv6-address
36858           in: path
36859           description: IP address
36860           required: true
36861           type: string
36862           example: __L3-INTERFACE-IPV6-ADDRESS__
36863         - name: resource-version
36864           in: query
36865           description: resource-version for concurrency
36866           required: true
36867           type: string
36868   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36869     get:
36870       tags:
36871         - Network
36872       summary: returns l-interface
36873       description: returns l-interface
36874       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36875       produces:
36876         - application/json
36877         - application/xml
36878       responses:
36879         "200":
36880           description: successful operation
36881           schema:
36882               $ref: "#/getDefinitions/l-interface"
36883         "default":
36884           description: Response codes found in [response codes](https://wiki.onap.org/).
36885       parameters:
36886         - name: pnf-name
36887           in: path
36888           description: unique name of Physical Network Function.
36889           required: true
36890           type: string
36891           example: __PNF-NAME__
36892         - name: interface-name
36893           in: path
36894           description: Name that identifies the link aggregate interface
36895           required: true
36896           type: string
36897           example: __INTERFACE-NAME__
36898         - name: interface-name
36899           in: path
36900           description: Name given to the interface
36901           required: true
36902           type: string
36903           example: __INTERFACE-NAME__
36904     put:
36905       tags:
36906         - Network
36907       summary: create or update an existing l-interface
36908       description: |
36909         Create or update an existing l-interface.
36910         #
36911         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36912       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36913       consumes:
36914         - application/json
36915         - application/xml
36916       produces:
36917         - application/json
36918         - application/xml
36919       responses:
36920         "default":
36921           description: Response codes found in [response codes](https://wiki.onap.org/).
36922       parameters:
36923         - name: pnf-name
36924           in: path
36925           description: unique name of Physical Network Function.
36926           required: true
36927           type: string
36928           example: __PNF-NAME__
36929         - name: interface-name
36930           in: path
36931           description: Name that identifies the link aggregate interface
36932           required: true
36933           type: string
36934           example: __INTERFACE-NAME__
36935         - name: interface-name
36936           in: path
36937           description: Name given to the interface
36938           required: true
36939           type: string
36940           example: __INTERFACE-NAME__
36941         - name: body
36942           in: body
36943           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36944           required: true
36945           schema:
36946             $ref: "#/definitions/l-interface"
36947     patch:
36948       tags:
36949         - Network
36950       summary: update an existing l-interface
36951       description: |
36952         Update an existing l-interface
36953         #
36954         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36955         The PUT operation will entirely replace an existing object.
36956         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36957         #
36958         Other differences between PUT and PATCH are:
36959         #
36960         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36961         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36962         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36963       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36964       consumes:
36965         - application/json
36966         - application/xml
36967       produces:
36968         - application/json
36969         - application/xml
36970       responses:
36971         "default":
36972           description: Response codes found in [response codes](https://wiki.onap.org/).
36973       parameters:
36974         - name: pnf-name
36975           in: path
36976           description: unique name of Physical Network Function.
36977           required: true
36978           type: string
36979           example: __PNF-NAME__
36980         - name: interface-name
36981           in: path
36982           description: Name that identifies the link aggregate interface
36983           required: true
36984           type: string
36985           example: __INTERFACE-NAME__
36986         - name: interface-name
36987           in: path
36988           description: Name given to the interface
36989           required: true
36990           type: string
36991           example: __INTERFACE-NAME__
36992         - name: body
36993           in: body
36994           description: l-interface object that needs to be updated.
36995           required: true
36996           schema:
36997             $ref: "#/patchDefinitions/l-interface"
36998     delete:
36999       tags:
37000         - Network
37001       summary: delete an existing l-interface
37002       description: delete an existing l-interface
37003       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
37004       consumes:
37005         - application/json
37006         - application/xml
37007       produces:
37008         - application/json
37009         - application/xml
37010       responses:
37011         "default":
37012           description: Response codes found in [response codes](https://wiki.onap.org/).
37013       parameters:
37014         - name: pnf-name
37015           in: path
37016           description: unique name of Physical Network Function.
37017           required: true
37018           type: string
37019           example: __PNF-NAME__
37020         - name: interface-name
37021           in: path
37022           description: Name that identifies the link aggregate interface
37023           required: true
37024           type: string
37025           example: __INTERFACE-NAME__
37026         - name: interface-name
37027           in: path
37028           description: Name given to the interface
37029           required: true
37030           type: string
37031           example: __INTERFACE-NAME__
37032         - name: resource-version
37033           in: query
37034           description: resource-version for concurrency
37035           required: true
37036           type: string
37037   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
37038     get:
37039       tags:
37040         - Network
37041       summary: returns l-interfaces
37042       description: returns l-interfaces
37043       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
37044       produces:
37045         - application/json
37046         - application/xml
37047       responses:
37048         "200":
37049           description: successful operation
37050           schema:
37051               $ref: "#/getDefinitions/l-interfaces"
37052         "default":
37053           description: Response codes found in [response codes](https://wiki.onap.org/).
37054       parameters:
37055         - name: pnf-name
37056           in: path
37057           description: unique name of Physical Network Function.
37058           required: true
37059           type: string
37060           example: __PNF-NAME__
37061         - name: interface-name
37062           in: path
37063           description: Name that identifies the link aggregate interface
37064           required: true
37065           type: string
37066           example: __INTERFACE-NAME__
37067         - name: interface-name
37068           in: query
37069           description:
37070           required: false
37071           type: string
37072         - name: interface-id
37073           in: query
37074           description:
37075           required: false
37076           type: string
37077         - name: macaddr
37078           in: query
37079           description:
37080           required: false
37081           type: string
37082         - name: network-name
37083           in: query
37084           description:
37085           required: false
37086           type: string
37087   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
37088     get:
37089       tags:
37090         - Network
37091       summary: returns lag-interface
37092       description: returns lag-interface
37093       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
37094       produces:
37095         - application/json
37096         - application/xml
37097       responses:
37098         "200":
37099           description: successful operation
37100           schema:
37101               $ref: "#/getDefinitions/lag-interface"
37102         "default":
37103           description: Response codes found in [response codes](https://wiki.onap.org/).
37104       parameters:
37105         - name: pnf-name
37106           in: path
37107           description: unique name of Physical Network Function.
37108           required: true
37109           type: string
37110           example: __PNF-NAME__
37111         - name: interface-name
37112           in: path
37113           description: Name that identifies the link aggregate interface
37114           required: true
37115           type: string
37116           example: __INTERFACE-NAME__
37117     put:
37118       tags:
37119         - Network
37120       summary: create or update an existing lag-interface
37121       description: |
37122         Create or update an existing lag-interface.
37123         #
37124         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37125       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
37126       consumes:
37127         - application/json
37128         - application/xml
37129       produces:
37130         - application/json
37131         - application/xml
37132       responses:
37133         "default":
37134           description: Response codes found in [response codes](https://wiki.onap.org/).
37135       parameters:
37136         - name: pnf-name
37137           in: path
37138           description: unique name of Physical Network Function.
37139           required: true
37140           type: string
37141           example: __PNF-NAME__
37142         - name: interface-name
37143           in: path
37144           description: Name that identifies the link aggregate interface
37145           required: true
37146           type: string
37147           example: __INTERFACE-NAME__
37148         - name: body
37149           in: body
37150           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
37151           required: true
37152           schema:
37153             $ref: "#/definitions/lag-interface"
37154     patch:
37155       tags:
37156         - Network
37157       summary: update an existing lag-interface
37158       description: |
37159         Update an existing lag-interface
37160         #
37161         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37162         The PUT operation will entirely replace an existing object.
37163         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37164         #
37165         Other differences between PUT and PATCH are:
37166         #
37167         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37168         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37169         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37170       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
37171       consumes:
37172         - application/json
37173         - application/xml
37174       produces:
37175         - application/json
37176         - application/xml
37177       responses:
37178         "default":
37179           description: Response codes found in [response codes](https://wiki.onap.org/).
37180       parameters:
37181         - name: pnf-name
37182           in: path
37183           description: unique name of Physical Network Function.
37184           required: true
37185           type: string
37186           example: __PNF-NAME__
37187         - name: interface-name
37188           in: path
37189           description: Name that identifies the link aggregate interface
37190           required: true
37191           type: string
37192           example: __INTERFACE-NAME__
37193         - name: body
37194           in: body
37195           description: lag-interface object that needs to be updated.
37196           required: true
37197           schema:
37198             $ref: "#/patchDefinitions/lag-interface"
37199     delete:
37200       tags:
37201         - Network
37202       summary: delete an existing lag-interface
37203       description: delete an existing lag-interface
37204       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
37205       consumes:
37206         - application/json
37207         - application/xml
37208       produces:
37209         - application/json
37210         - application/xml
37211       responses:
37212         "default":
37213           description: Response codes found in [response codes](https://wiki.onap.org/).
37214       parameters:
37215         - name: pnf-name
37216           in: path
37217           description: unique name of Physical Network Function.
37218           required: true
37219           type: string
37220           example: __PNF-NAME__
37221         - name: interface-name
37222           in: path
37223           description: Name that identifies the link aggregate interface
37224           required: true
37225           type: string
37226           example: __INTERFACE-NAME__
37227         - name: resource-version
37228           in: query
37229           description: resource-version for concurrency
37230           required: true
37231           type: string
37232   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
37233     get:
37234       tags:
37235         - Network
37236       summary: returns lag-interfaces
37237       description: returns lag-interfaces
37238       operationId: getNetworkPnfsPnfLagInterfaces
37239       produces:
37240         - application/json
37241         - application/xml
37242       responses:
37243         "200":
37244           description: successful operation
37245           schema:
37246               $ref: "#/getDefinitions/lag-interfaces"
37247         "default":
37248           description: Response codes found in [response codes](https://wiki.onap.org/).
37249       parameters:
37250         - name: pnf-name
37251           in: path
37252           description: unique name of Physical Network Function.
37253           required: true
37254           type: string
37255           example: __PNF-NAME__
37256         - name: interface-name
37257           in: query
37258           description:
37259           required: false
37260           type: string
37261   /network/pnfs/pnf/{pnf-name}:
37262     get:
37263       tags:
37264         - Network
37265       summary: returns pnf
37266       description: returns pnf
37267       operationId: getNetworkPnfsPnf
37268       produces:
37269         - application/json
37270         - application/xml
37271       responses:
37272         "200":
37273           description: successful operation
37274           schema:
37275               $ref: "#/getDefinitions/pnf"
37276         "default":
37277           description: Response codes found in [response codes](https://wiki.onap.org/).
37278       parameters:
37279         - name: pnf-name
37280           in: path
37281           description: unique name of Physical Network Function.
37282           required: true
37283           type: string
37284           example: __PNF-NAME__
37285     put:
37286       tags:
37287         - Network
37288       summary: create or update an existing pnf
37289       description: |
37290         Create or update an existing pnf.
37291         #
37292         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37293       operationId: createOrUpdateNetworkPnfsPnf
37294       consumes:
37295         - application/json
37296         - application/xml
37297       produces:
37298         - application/json
37299         - application/xml
37300       responses:
37301         "default":
37302           description: Response codes found in [response codes](https://wiki.onap.org/).
37303       parameters:
37304         - name: pnf-name
37305           in: path
37306           description: unique name of Physical Network Function.
37307           required: true
37308           type: string
37309           example: __PNF-NAME__
37310         - name: body
37311           in: body
37312           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
37313           required: true
37314           schema:
37315             $ref: "#/definitions/pnf"
37316     patch:
37317       tags:
37318         - Network
37319       summary: update an existing pnf
37320       description: |
37321         Update an existing pnf
37322         #
37323         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37324         The PUT operation will entirely replace an existing object.
37325         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37326         #
37327         Other differences between PUT and PATCH are:
37328         #
37329         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37330         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37331         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37332       operationId: UpdateNetworkPnfsPnf
37333       consumes:
37334         - application/json
37335         - application/xml
37336       produces:
37337         - application/json
37338         - application/xml
37339       responses:
37340         "default":
37341           description: Response codes found in [response codes](https://wiki.onap.org/).
37342       parameters:
37343         - name: pnf-name
37344           in: path
37345           description: unique name of Physical Network Function.
37346           required: true
37347           type: string
37348           example: __PNF-NAME__
37349         - name: body
37350           in: body
37351           description: pnf object that needs to be updated.
37352           required: true
37353           schema:
37354             $ref: "#/patchDefinitions/pnf"
37355     delete:
37356       tags:
37357         - Network
37358       summary: delete an existing pnf
37359       description: delete an existing pnf
37360       operationId: deleteNetworkPnfsPnf
37361       consumes:
37362         - application/json
37363         - application/xml
37364       produces:
37365         - application/json
37366         - application/xml
37367       responses:
37368         "default":
37369           description: Response codes found in [response codes](https://wiki.onap.org/).
37370       parameters:
37371         - name: pnf-name
37372           in: path
37373           description: unique name of Physical Network Function.
37374           required: true
37375           type: string
37376           example: __PNF-NAME__
37377         - name: resource-version
37378           in: query
37379           description: resource-version for concurrency
37380           required: true
37381           type: string
37382   /network/pnfs:
37383     get:
37384       tags:
37385         - Network
37386       summary: returns pnfs
37387       description: returns pnfs
37388       operationId: getNetworkPnfs
37389       produces:
37390         - application/json
37391         - application/xml
37392       responses:
37393         "200":
37394           description: successful operation
37395           schema:
37396               $ref: "#/getDefinitions/pnfs"
37397         "default":
37398           description: Response codes found in [response codes](https://wiki.onap.org/).
37399       parameters:
37400         - name: pnf-name
37401           in: query
37402           description:
37403           required: false
37404           type: string
37405         - name: orchestration-status
37406           in: query
37407           description:
37408           required: false
37409           type: string
37410   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
37411     put:
37412       tags:
37413         - Network
37414       summary: see node definition for valid relationships
37415       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
37416       consumes:
37417         - application/json
37418         - application/xml
37419       produces:
37420         - application/json
37421         - application/xml
37422       responses:
37423         "default":
37424           description: Response codes found in [response codes](https://wiki.onap.org/).
37425       parameters:
37426         - name: link-name
37427           in: path
37428           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37429           required: true
37430           type: string
37431           example: __LINK-NAME__
37432         - name: body
37433           in: body
37434           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
37435           required: true
37436           schema:
37437             $ref: "#/definitions/relationship"
37438     delete:
37439       tags:
37440         - Network
37441       summary: delete an existing relationship
37442       description: delete an existing relationship
37443       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
37444       consumes:
37445         - application/json
37446         - application/xml
37447       produces:
37448         - application/json
37449         - application/xml
37450       responses:
37451         "default":
37452           description: Response codes found in [response codes](https://wiki.onap.org/).
37453       parameters:
37454         - name: link-name
37455           in: path
37456           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37457           required: true
37458           type: string
37459           example: __LINK-NAME__
37460   /network/physical-links/physical-link/{link-name}:
37461     get:
37462       tags:
37463         - Network
37464       summary: returns physical-link
37465       description: returns physical-link
37466       operationId: getNetworkPhysicalLinksPhysicalLink
37467       produces:
37468         - application/json
37469         - application/xml
37470       responses:
37471         "200":
37472           description: successful operation
37473           schema:
37474               $ref: "#/getDefinitions/physical-link"
37475         "default":
37476           description: Response codes found in [response codes](https://wiki.onap.org/).
37477       parameters:
37478         - name: link-name
37479           in: path
37480           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37481           required: true
37482           type: string
37483           example: __LINK-NAME__
37484     put:
37485       tags:
37486         - Network
37487       summary: create or update an existing physical-link
37488       description: |
37489         Create or update an existing physical-link.
37490         #
37491         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37492       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
37493       consumes:
37494         - application/json
37495         - application/xml
37496       produces:
37497         - application/json
37498         - application/xml
37499       responses:
37500         "default":
37501           description: Response codes found in [response codes](https://wiki.onap.org/).
37502       parameters:
37503         - name: link-name
37504           in: path
37505           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37506           required: true
37507           type: string
37508           example: __LINK-NAME__
37509         - name: body
37510           in: body
37511           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
37512           required: true
37513           schema:
37514             $ref: "#/definitions/physical-link"
37515     patch:
37516       tags:
37517         - Network
37518       summary: update an existing physical-link
37519       description: |
37520         Update an existing physical-link
37521         #
37522         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37523         The PUT operation will entirely replace an existing object.
37524         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37525         #
37526         Other differences between PUT and PATCH are:
37527         #
37528         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37529         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37530         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37531       operationId: UpdateNetworkPhysicalLinksPhysicalLink
37532       consumes:
37533         - application/json
37534         - application/xml
37535       produces:
37536         - application/json
37537         - application/xml
37538       responses:
37539         "default":
37540           description: Response codes found in [response codes](https://wiki.onap.org/).
37541       parameters:
37542         - name: link-name
37543           in: path
37544           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37545           required: true
37546           type: string
37547           example: __LINK-NAME__
37548         - name: body
37549           in: body
37550           description: physical-link object that needs to be updated.
37551           required: true
37552           schema:
37553             $ref: "#/patchDefinitions/physical-link"
37554     delete:
37555       tags:
37556         - Network
37557       summary: delete an existing physical-link
37558       description: delete an existing physical-link
37559       operationId: deleteNetworkPhysicalLinksPhysicalLink
37560       consumes:
37561         - application/json
37562         - application/xml
37563       produces:
37564         - application/json
37565         - application/xml
37566       responses:
37567         "default":
37568           description: Response codes found in [response codes](https://wiki.onap.org/).
37569       parameters:
37570         - name: link-name
37571           in: path
37572           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37573           required: true
37574           type: string
37575           example: __LINK-NAME__
37576         - name: resource-version
37577           in: query
37578           description: resource-version for concurrency
37579           required: true
37580           type: string
37581   /network/physical-links:
37582     get:
37583       tags:
37584         - Network
37585       summary: returns physical-links
37586       description: returns physical-links
37587       operationId: getNetworkPhysicalLinks
37588       produces:
37589         - application/json
37590         - application/xml
37591       responses:
37592         "200":
37593           description: successful operation
37594           schema:
37595               $ref: "#/getDefinitions/physical-links"
37596         "default":
37597           description: Response codes found in [response codes](https://wiki.onap.org/).
37598       parameters:
37599         - name: link-name
37600           in: query
37601           description:
37602           required: false
37603           type: string
37604         - name: circuit-id
37605           in: query
37606           description:
37607           required: false
37608           type: string
37609   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
37610     put:
37611       tags:
37612         - Network
37613       summary: see node definition for valid relationships
37614       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
37615       consumes:
37616         - application/json
37617         - application/xml
37618       produces:
37619         - application/json
37620         - application/xml
37621       responses:
37622         "default":
37623           description: Response codes found in [response codes](https://wiki.onap.org/).
37624       parameters:
37625         - name: ipsec-configuration-id
37626           in: path
37627           description: UUID of this configuration
37628           required: true
37629           type: string
37630           example: __IPSEC-CONFIGURATION-ID__
37631         - name: body
37632           in: body
37633           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
37634           required: true
37635           schema:
37636             $ref: "#/definitions/relationship"
37637     delete:
37638       tags:
37639         - Network
37640       summary: delete an existing relationship
37641       description: delete an existing relationship
37642       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
37643       consumes:
37644         - application/json
37645         - application/xml
37646       produces:
37647         - application/json
37648         - application/xml
37649       responses:
37650         "default":
37651           description: Response codes found in [response codes](https://wiki.onap.org/).
37652       parameters:
37653         - name: ipsec-configuration-id
37654           in: path
37655           description: UUID of this configuration
37656           required: true
37657           type: string
37658           example: __IPSEC-CONFIGURATION-ID__
37659   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
37660     put:
37661       tags:
37662         - Network
37663       summary: see node definition for valid relationships
37664       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
37665       consumes:
37666         - application/json
37667         - application/xml
37668       produces:
37669         - application/json
37670         - application/xml
37671       responses:
37672         "default":
37673           description: Response codes found in [response codes](https://wiki.onap.org/).
37674       parameters:
37675         - name: ipsec-configuration-id
37676           in: path
37677           description: UUID of this configuration
37678           required: true
37679           type: string
37680           example: __IPSEC-CONFIGURATION-ID__
37681         - name: vig-address-type
37682           in: path
37683           description: indicates whether the VIG is for AVPN or INTERNET
37684           required: true
37685           type: string
37686           example: __VIG-ADDRESS-TYPE__
37687         - name: body
37688           in: body
37689           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
37690           required: true
37691           schema:
37692             $ref: "#/definitions/relationship"
37693     delete:
37694       tags:
37695         - Network
37696       summary: delete an existing relationship
37697       description: delete an existing relationship
37698       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
37699       consumes:
37700         - application/json
37701         - application/xml
37702       produces:
37703         - application/json
37704         - application/xml
37705       responses:
37706         "default":
37707           description: Response codes found in [response codes](https://wiki.onap.org/).
37708       parameters:
37709         - name: ipsec-configuration-id
37710           in: path
37711           description: UUID of this configuration
37712           required: true
37713           type: string
37714           example: __IPSEC-CONFIGURATION-ID__
37715         - name: vig-address-type
37716           in: path
37717           description: indicates whether the VIG is for AVPN or INTERNET
37718           required: true
37719           type: string
37720           example: __VIG-ADDRESS-TYPE__
37721   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
37722     get:
37723       tags:
37724         - Network
37725       summary: returns vig-server
37726       description: returns vig-server
37727       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37728       produces:
37729         - application/json
37730         - application/xml
37731       responses:
37732         "200":
37733           description: successful operation
37734           schema:
37735               $ref: "#/getDefinitions/vig-server"
37736         "default":
37737           description: Response codes found in [response codes](https://wiki.onap.org/).
37738       parameters:
37739         - name: ipsec-configuration-id
37740           in: path
37741           description: UUID of this configuration
37742           required: true
37743           type: string
37744           example: __IPSEC-CONFIGURATION-ID__
37745         - name: vig-address-type
37746           in: path
37747           description: indicates whether the VIG is for AVPN or INTERNET
37748           required: true
37749           type: string
37750           example: __VIG-ADDRESS-TYPE__
37751     put:
37752       tags:
37753         - Network
37754       summary: create or update an existing vig-server
37755       description: |
37756         Create or update an existing vig-server.
37757         #
37758         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37759       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37760       consumes:
37761         - application/json
37762         - application/xml
37763       produces:
37764         - application/json
37765         - application/xml
37766       responses:
37767         "default":
37768           description: Response codes found in [response codes](https://wiki.onap.org/).
37769       parameters:
37770         - name: ipsec-configuration-id
37771           in: path
37772           description: UUID of this configuration
37773           required: true
37774           type: string
37775           example: __IPSEC-CONFIGURATION-ID__
37776         - name: vig-address-type
37777           in: path
37778           description: indicates whether the VIG is for AVPN or INTERNET
37779           required: true
37780           type: string
37781           example: __VIG-ADDRESS-TYPE__
37782         - name: body
37783           in: body
37784           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
37785           required: true
37786           schema:
37787             $ref: "#/definitions/vig-server"
37788     patch:
37789       tags:
37790         - Network
37791       summary: update an existing vig-server
37792       description: |
37793         Update an existing vig-server
37794         #
37795         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37796         The PUT operation will entirely replace an existing object.
37797         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37798         #
37799         Other differences between PUT and PATCH are:
37800         #
37801         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37802         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37803         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37804       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37805       consumes:
37806         - application/json
37807         - application/xml
37808       produces:
37809         - application/json
37810         - application/xml
37811       responses:
37812         "default":
37813           description: Response codes found in [response codes](https://wiki.onap.org/).
37814       parameters:
37815         - name: ipsec-configuration-id
37816           in: path
37817           description: UUID of this configuration
37818           required: true
37819           type: string
37820           example: __IPSEC-CONFIGURATION-ID__
37821         - name: vig-address-type
37822           in: path
37823           description: indicates whether the VIG is for AVPN or INTERNET
37824           required: true
37825           type: string
37826           example: __VIG-ADDRESS-TYPE__
37827         - name: body
37828           in: body
37829           description: vig-server object that needs to be updated.
37830           required: true
37831           schema:
37832             $ref: "#/patchDefinitions/vig-server"
37833     delete:
37834       tags:
37835         - Network
37836       summary: delete an existing vig-server
37837       description: delete an existing vig-server
37838       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37839       consumes:
37840         - application/json
37841         - application/xml
37842       produces:
37843         - application/json
37844         - application/xml
37845       responses:
37846         "default":
37847           description: Response codes found in [response codes](https://wiki.onap.org/).
37848       parameters:
37849         - name: ipsec-configuration-id
37850           in: path
37851           description: UUID of this configuration
37852           required: true
37853           type: string
37854           example: __IPSEC-CONFIGURATION-ID__
37855         - name: vig-address-type
37856           in: path
37857           description: indicates whether the VIG is for AVPN or INTERNET
37858           required: true
37859           type: string
37860           example: __VIG-ADDRESS-TYPE__
37861         - name: resource-version
37862           in: query
37863           description: resource-version for concurrency
37864           required: true
37865           type: string
37866   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
37867     get:
37868       tags:
37869         - Network
37870       summary: returns vig-servers
37871       description: returns vig-servers
37872       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
37873       produces:
37874         - application/json
37875         - application/xml
37876       responses:
37877         "200":
37878           description: successful operation
37879           schema:
37880               $ref: "#/getDefinitions/vig-servers"
37881         "default":
37882           description: Response codes found in [response codes](https://wiki.onap.org/).
37883       parameters:
37884         - name: ipsec-configuration-id
37885           in: path
37886           description: UUID of this configuration
37887           required: true
37888           type: string
37889           example: __IPSEC-CONFIGURATION-ID__
37890         - name: vig-address-type
37891           in: query
37892           description:
37893           required: false
37894           type: string
37895   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
37896     get:
37897       tags:
37898         - Network
37899       summary: returns ipsec-configuration
37900       description: returns ipsec-configuration
37901       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
37902       produces:
37903         - application/json
37904         - application/xml
37905       responses:
37906         "200":
37907           description: successful operation
37908           schema:
37909               $ref: "#/getDefinitions/ipsec-configuration"
37910         "default":
37911           description: Response codes found in [response codes](https://wiki.onap.org/).
37912       parameters:
37913         - name: ipsec-configuration-id
37914           in: path
37915           description: UUID of this configuration
37916           required: true
37917           type: string
37918           example: __IPSEC-CONFIGURATION-ID__
37919     put:
37920       tags:
37921         - Network
37922       summary: create or update an existing ipsec-configuration
37923       description: |
37924         Create or update an existing ipsec-configuration.
37925         #
37926         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37927       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
37928       consumes:
37929         - application/json
37930         - application/xml
37931       produces:
37932         - application/json
37933         - application/xml
37934       responses:
37935         "default":
37936           description: Response codes found in [response codes](https://wiki.onap.org/).
37937       parameters:
37938         - name: ipsec-configuration-id
37939           in: path
37940           description: UUID of this configuration
37941           required: true
37942           type: string
37943           example: __IPSEC-CONFIGURATION-ID__
37944         - name: body
37945           in: body
37946           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
37947           required: true
37948           schema:
37949             $ref: "#/definitions/ipsec-configuration"
37950     patch:
37951       tags:
37952         - Network
37953       summary: update an existing ipsec-configuration
37954       description: |
37955         Update an existing ipsec-configuration
37956         #
37957         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37958         The PUT operation will entirely replace an existing object.
37959         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37960         #
37961         Other differences between PUT and PATCH are:
37962         #
37963         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37964         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37965         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37966       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
37967       consumes:
37968         - application/json
37969         - application/xml
37970       produces:
37971         - application/json
37972         - application/xml
37973       responses:
37974         "default":
37975           description: Response codes found in [response codes](https://wiki.onap.org/).
37976       parameters:
37977         - name: ipsec-configuration-id
37978           in: path
37979           description: UUID of this configuration
37980           required: true
37981           type: string
37982           example: __IPSEC-CONFIGURATION-ID__
37983         - name: body
37984           in: body
37985           description: ipsec-configuration object that needs to be updated.
37986           required: true
37987           schema:
37988             $ref: "#/patchDefinitions/ipsec-configuration"
37989     delete:
37990       tags:
37991         - Network
37992       summary: delete an existing ipsec-configuration
37993       description: delete an existing ipsec-configuration
37994       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
37995       consumes:
37996         - application/json
37997         - application/xml
37998       produces:
37999         - application/json
38000         - application/xml
38001       responses:
38002         "default":
38003           description: Response codes found in [response codes](https://wiki.onap.org/).
38004       parameters:
38005         - name: ipsec-configuration-id
38006           in: path
38007           description: UUID of this configuration
38008           required: true
38009           type: string
38010           example: __IPSEC-CONFIGURATION-ID__
38011         - name: resource-version
38012           in: query
38013           description: resource-version for concurrency
38014           required: true
38015           type: string
38016   /network/ipsec-configurations:
38017     get:
38018       tags:
38019         - Network
38020       summary: returns ipsec-configurations
38021       description: returns ipsec-configurations
38022       operationId: getNetworkIpsecConfigurations
38023       produces:
38024         - application/json
38025         - application/xml
38026       responses:
38027         "200":
38028           description: successful operation
38029           schema:
38030               $ref: "#/getDefinitions/ipsec-configurations"
38031         "default":
38032           description: Response codes found in [response codes](https://wiki.onap.org/).
38033       parameters:
38034         - name: ipsec-configuration-id
38035           in: query
38036           description:
38037           required: false
38038           type: string
38039   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
38040     put:
38041       tags:
38042         - Network
38043       summary: see node definition for valid relationships
38044       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
38045       consumes:
38046         - application/json
38047         - application/xml
38048       produces:
38049         - application/json
38050         - application/xml
38051       responses:
38052         "default":
38053           description: Response codes found in [response codes](https://wiki.onap.org/).
38054       parameters:
38055         - name: route-table-reference-id
38056           in: path
38057           description: Route Table Reference id, UUID assigned to this instance.
38058           required: true
38059           type: string
38060           example: __ROUTE-TABLE-REFERENCE-ID__
38061         - name: body
38062           in: body
38063           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
38064           required: true
38065           schema:
38066             $ref: "#/definitions/relationship"
38067     delete:
38068       tags:
38069         - Network
38070       summary: delete an existing relationship
38071       description: delete an existing relationship
38072       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
38073       consumes:
38074         - application/json
38075         - application/xml
38076       produces:
38077         - application/json
38078         - application/xml
38079       responses:
38080         "default":
38081           description: Response codes found in [response codes](https://wiki.onap.org/).
38082       parameters:
38083         - name: route-table-reference-id
38084           in: path
38085           description: Route Table Reference id, UUID assigned to this instance.
38086           required: true
38087           type: string
38088           example: __ROUTE-TABLE-REFERENCE-ID__
38089   /network/route-table-references/route-table-reference/{route-table-reference-id}:
38090     get:
38091       tags:
38092         - Network
38093       summary: returns route-table-reference
38094       description: returns route-table-reference
38095       operationId: getNetworkRouteTableReferencesRouteTableReference
38096       produces:
38097         - application/json
38098         - application/xml
38099       responses:
38100         "200":
38101           description: successful operation
38102           schema:
38103               $ref: "#/getDefinitions/route-table-reference"
38104         "default":
38105           description: Response codes found in [response codes](https://wiki.onap.org/).
38106       parameters:
38107         - name: route-table-reference-id
38108           in: path
38109           description: Route Table Reference id, UUID assigned to this instance.
38110           required: true
38111           type: string
38112           example: __ROUTE-TABLE-REFERENCE-ID__
38113     put:
38114       tags:
38115         - Network
38116       summary: create or update an existing route-table-reference
38117       description: |
38118         Create or update an existing route-table-reference.
38119         #
38120         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38121       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
38122       consumes:
38123         - application/json
38124         - application/xml
38125       produces:
38126         - application/json
38127         - application/xml
38128       responses:
38129         "default":
38130           description: Response codes found in [response codes](https://wiki.onap.org/).
38131       parameters:
38132         - name: route-table-reference-id
38133           in: path
38134           description: Route Table Reference id, UUID assigned to this instance.
38135           required: true
38136           type: string
38137           example: __ROUTE-TABLE-REFERENCE-ID__
38138         - name: body
38139           in: body
38140           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
38141           required: true
38142           schema:
38143             $ref: "#/definitions/route-table-reference"
38144     patch:
38145       tags:
38146         - Network
38147       summary: update an existing route-table-reference
38148       description: |
38149         Update an existing route-table-reference
38150         #
38151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38152         The PUT operation will entirely replace an existing object.
38153         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38154         #
38155         Other differences between PUT and PATCH are:
38156         #
38157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38160       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
38161       consumes:
38162         - application/json
38163         - application/xml
38164       produces:
38165         - application/json
38166         - application/xml
38167       responses:
38168         "default":
38169           description: Response codes found in [response codes](https://wiki.onap.org/).
38170       parameters:
38171         - name: route-table-reference-id
38172           in: path
38173           description: Route Table Reference id, UUID assigned to this instance.
38174           required: true
38175           type: string
38176           example: __ROUTE-TABLE-REFERENCE-ID__
38177         - name: body
38178           in: body
38179           description: route-table-reference object that needs to be updated.
38180           required: true
38181           schema:
38182             $ref: "#/patchDefinitions/route-table-reference"
38183     delete:
38184       tags:
38185         - Network
38186       summary: delete an existing route-table-reference
38187       description: delete an existing route-table-reference
38188       operationId: deleteNetworkRouteTableReferencesRouteTableReference
38189       consumes:
38190         - application/json
38191         - application/xml
38192       produces:
38193         - application/json
38194         - application/xml
38195       responses:
38196         "default":
38197           description: Response codes found in [response codes](https://wiki.onap.org/).
38198       parameters:
38199         - name: route-table-reference-id
38200           in: path
38201           description: Route Table Reference id, UUID assigned to this instance.
38202           required: true
38203           type: string
38204           example: __ROUTE-TABLE-REFERENCE-ID__
38205         - name: resource-version
38206           in: query
38207           description: resource-version for concurrency
38208           required: true
38209           type: string
38210   /network/route-table-references:
38211     get:
38212       tags:
38213         - Network
38214       summary: returns route-table-references
38215       description: returns route-table-references
38216       operationId: getNetworkRouteTableReferences
38217       produces:
38218         - application/json
38219         - application/xml
38220       responses:
38221         "200":
38222           description: successful operation
38223           schema:
38224               $ref: "#/getDefinitions/route-table-references"
38225         "default":
38226           description: Response codes found in [response codes](https://wiki.onap.org/).
38227       parameters:
38228         - name: route-table-reference-id
38229           in: query
38230           description:
38231           required: false
38232           type: string
38233         - name: route-table-reference-fqdn
38234           in: query
38235           description:
38236           required: false
38237           type: string
38238 definitions:
38239   action:
38240     properties:
38241       action-type:
38242         type: string
38243       action-data:
38244         type: array
38245         items:
38246           $ref: "#/definitions/action-data"
38247   action-data:
38248     properties:
38249       property-name:
38250         type: string
38251       property-value:
38252         type: string
38253   actions:
38254     description: |
38255       APIs that are more action related than REST (e.g., notify, update).
38256     properties:
38257       update:
38258         type: object
38259         $ref: "#/definitions/update"
38260       notify:
38261         type: object
38262         $ref: "#/definitions/notify"
38263   allotted-resource:
38264     description: |
38265       Represents a slice or partial piece of a resource that gets separately allotted
38266       ###### Related Nodes
38267       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
38268       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
38269       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
38270       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
38271       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
38272       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
38273       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
38274
38275       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
38276       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
38277     required:
38278     - id
38279     properties:
38280       id:
38281         type: string
38282         description: Allotted Resource id UUID assigned to this instance.
38283       description:
38284         type: string
38285         description: The descriptive information assigned to this allotted resource instance
38286       selflink:
38287         type: string
38288         description: Link back to more information in the controller
38289       persona-model-id:
38290         type: string
38291         description: the ASDC model id for this resource or service model.
38292       persona-model-version:
38293         type: string
38294         description: the ASDC model version for this resource or service model.
38295       model-version-id:
38296         type: string
38297         description: the ASDC model version for this resource or service model.
38298       persona-model-customization-id:
38299         type: string
38300         description: captures the id of all the configuration used to customize the resource for the service.
38301       resource-version:
38302         type: string
38303         description: Concurrency value
38304       tunnel-xconnects:
38305         type: array
38306         items:
38307           $ref: "#/definitions/tunnel-xconnect"
38308       relationship-list:
38309         type: array
38310         items:
38311           $ref: "#/definitions/relationship"
38312   allotted-resources:
38313     description: |
38314       This object is used to store slices of services being offered
38315     properties:
38316       allotted-resource:
38317         type: array
38318         items:
38319           $ref: "#/definitions/allotted-resource"
38320   availability-zone:
38321     description: |
38322       Availability zone, a collection of compute hosts/pservers
38323       ###### Related Nodes
38324       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
38325       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
38326       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
38327       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
38328       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
38329       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
38330       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
38331       - FROM vce( vce Uses availability-zone, MANY2MANY)
38332
38333       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
38334       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
38335
38336     required:
38337     - availability-zone-name
38338     - hypervisor-type
38339     properties:
38340       availability-zone-name:
38341         type: string
38342         description: Name of the availability zone.  Unique across a cloud region
38343       hypervisor-type:
38344         type: string
38345         description: Type of hypervisor.  Source of truth should define valid values.
38346       operational-state:
38347         type: string
38348         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
38349       resource-version:
38350         type: string
38351         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38352       relationship-list:
38353         type: array
38354         items:
38355           $ref: "#/definitions/relationship"
38356   availability-zones:
38357     description: |
38358       Collection of availability zones
38359     properties:
38360       availability-zone:
38361         type: array
38362         items:
38363           $ref: "#/definitions/availability-zone"
38364   az-and-dvs-switches:
38365     properties:
38366       dvs-switches:
38367         type: object
38368         $ref: "#/definitions/dvs-switches"
38369       availability-zone:
38370         type: object
38371         $ref: "#/definitions/availability-zone"
38372   business:
38373     description: |
38374       Namespace for business related constructs
38375     properties:
38376       connectors:
38377         type: array
38378         items:
38379           $ref: "#/definitions/connector"
38380       customers:
38381         type: array
38382         items:
38383           $ref: "#/definitions/customer"
38384   class-of-service:
38385     description: |
38386       ###### Related Nodes
38387       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
38388
38389       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
38390     required:
38391     - cos
38392     properties:
38393       cos:
38394         type: string
38395         description: unique identifier of probe
38396       probe-id:
38397         type: string
38398         description: identifier of probe
38399       probe-type:
38400         type: string
38401         description: type of probe
38402       resource-version:
38403         type: string
38404         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38405       relationship-list:
38406         type: array
38407         items:
38408           $ref: "#/definitions/relationship"
38409   classes-of-service:
38410     description: |
38411       class-of-service of probe
38412     properties:
38413       class-of-service:
38414         type: array
38415         items:
38416           $ref: "#/definitions/class-of-service"
38417   cloud-infrastructure:
38418     description: |
38419       Namespace for cloud infrastructure.
38420     properties:
38421       complexes:
38422         type: array
38423         items:
38424           $ref: "#/definitions/complex"
38425       cloud-regions:
38426         type: array
38427         items:
38428           $ref: "#/definitions/cloud-region"
38429       network-profiles:
38430         type: array
38431         items:
38432           $ref: "#/definitions/network-profile"
38433       pservers:
38434         type: array
38435         items:
38436           $ref: "#/definitions/pserver"
38437       virtual-data-centers:
38438         type: array
38439         items:
38440           $ref: "#/definitions/virtual-data-center"
38441   cloud-region:
38442     description: |
38443       cloud-region designates an installation of a cloud cluster or region or instantiation.
38444       ###### Related Nodes
38445       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
38446       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
38447       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
38448       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
38449       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
38450       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
38451       - FROM image( image BelongsTo cloud-region, MANY2ONE)
38452       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
38453       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
38454       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
38455       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
38456       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
38457
38458       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
38459       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
38460
38461     required:
38462     - cloud-owner
38463     - cloud-region-id
38464     properties:
38465       cloud-owner:
38466         type: string
38467         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
38468       cloud-region-id:
38469         type: string
38470         description: Identifier used by the vendor for the region. Second part of composite key
38471       cloud-type:
38472         type: string
38473         description: Type of the cloud (e.g., openstack)
38474       owner-defined-type:
38475         type: string
38476         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
38477       cloud-region-version:
38478         type: string
38479         description: Software version employed at the site
38480       identity-url:
38481         type: string
38482         description: URL of the keystone identity service
38483       cloud-zone:
38484         type: string
38485         description: Zone where the cloud is homed
38486       complex-name:
38487         type: string
38488         description: complex name for cloud-region instance
38489       resource-version:
38490         type: string
38491         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38492       volume-groups:
38493         type: array
38494         items:
38495           $ref: "#/definitions/volume-group"
38496       tenants:
38497         type: array
38498         items:
38499           $ref: "#/definitions/tenant"
38500       flavors:
38501         type: array
38502         items:
38503           $ref: "#/definitions/flavor"
38504       group-assignments:
38505         type: array
38506         items:
38507           $ref: "#/definitions/group-assignment"
38508       snapshots:
38509         type: array
38510         items:
38511           $ref: "#/definitions/snapshot"
38512       images:
38513         type: array
38514         items:
38515           $ref: "#/definitions/image"
38516       dvs-switches:
38517         type: array
38518         items:
38519           $ref: "#/definitions/dvs-switch"
38520       oam-networks:
38521         type: array
38522         items:
38523           $ref: "#/definitions/oam-network"
38524       availability-zones:
38525         type: array
38526         items:
38527           $ref: "#/definitions/availability-zone"
38528       relationship-list:
38529         type: array
38530         items:
38531           $ref: "#/definitions/relationship"
38532   cloud-regions:
38533     properties:
38534       cloud-region:
38535         type: array
38536         items:
38537           $ref: "#/definitions/cloud-region"
38538   complex:
38539     description: |
38540       Collection of physical locations that can house cloud-regions.
38541       ###### Related Nodes
38542       - TO l3-network( complex Uses l3-network, MANY2MANY)
38543       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
38544       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
38545       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
38546       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
38547       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
38548       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
38549       - FROM vce( vce LocatedIn complex, MANY2MANY)
38550       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
38551       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
38552
38553       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
38554       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
38555
38556     required:
38557     - physical-location-id
38558     - physical-location-type
38559     - street1
38560     - city
38561     - postal-code
38562     - country
38563     - region
38564     properties:
38565       physical-location-id:
38566         type: string
38567         description: Unique identifier for physical location, e.g., CLLI
38568       data-center-code:
38569         type: string
38570         description: Data center code which can be an alternate way to identify a complex
38571       complex-name:
38572         type: string
38573         description: Gamma complex name for LCP instance.
38574       identity-url:
38575         type: string
38576         description: URL of the keystone identity service
38577       resource-version:
38578         type: string
38579         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38580       physical-location-type:
38581         type: string
38582         description: Type, e.g., central office, data center.
38583       street1:
38584         type: string
38585       street2:
38586         type: string
38587       city:
38588         type: string
38589       state:
38590         type: string
38591       postal-code:
38592         type: string
38593       country:
38594         type: string
38595       region:
38596         type: string
38597       latitude:
38598         type: string
38599       longitude:
38600         type: string
38601       elevation:
38602         type: string
38603       lata:
38604         type: string
38605       ctag-pools:
38606         type: array
38607         items:
38608           $ref: "#/definitions/ctag-pool"
38609       relationship-list:
38610         type: array
38611         items:
38612           $ref: "#/definitions/relationship"
38613   complexes:
38614     description: |
38615       Collection of physical locations that can house cloud-regions.
38616     properties:
38617       complex:
38618         type: array
38619         items:
38620           $ref: "#/definitions/complex"
38621   configuration:
38622     description: |
38623       Port Mirror Configuration.
38624       ###### Related Nodes
38625       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
38626       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
38627       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
38628       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
38629       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
38630
38631       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
38632       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
38633       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
38634     required:
38635     - configuration-id
38636     - configuration-type
38637     - configuration-sub-type
38638     - orchestration-status
38639     - operational-status
38640     - configuration-selflink
38641     - model-customization-id
38642     properties:
38643       configuration-id:
38644         type: string
38645         description: UUID assigned to configuration.
38646       management-option:
38647         type: string
38648         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
38649       configuration-name:
38650         type: string
38651         description: Name of the configuration.
38652       configuration-type:
38653         type: string
38654         description: port-mirroring-configuration.
38655       configuration-sub-type:
38656         type: string
38657         description: vprobe, pprobe.
38658       model-invariant-id:
38659         type: string
38660         description: the ASDC model id for this resource or service model.
38661       model-version-id:
38662         type: string
38663         description: the ASDC model version for this resource or service model.
38664       orchestration-status:
38665         type: string
38666         description: Orchestration status of the configuration.
38667       operational-status:
38668         type: string
38669         description: Indicator for whether the resource is considered operational.
38670       configuration-selflink:
38671         type: string
38672         description: URL to endpoint where AAI can get more details from SDN-GC.
38673       model-customization-id:
38674         type: string
38675         description: id of  the configuration used to customize the resource
38676       resource-version:
38677         type: string
38678         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38679       relationship-list:
38680         type: array
38681         items:
38682           $ref: "#/definitions/relationship"
38683       metadata:
38684         type: array
38685         items:
38686           $ref: "#/definitions/metadatum"
38687   configurations:
38688     description: |
38689       Collection of configurations
38690     properties:
38691       configuration:
38692         type: array
38693         items:
38694           $ref: "#/definitions/configuration"
38695   connector:
38696     description: |
38697       Collection of resource instances used to connect a variety of disparate inventory widgets
38698       ###### Related Nodes
38699       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
38700       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
38701       - FROM service-instance( service-instance Uses connector, MANY2MANY)
38702
38703       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
38704     required:
38705     - resource-instance-id
38706     properties:
38707       resource-instance-id:
38708         type: string
38709         description: Unique id of resource instance.
38710       resource-version:
38711         type: string
38712         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38713       persona-model-id:
38714         type: string
38715         description: the ASDC model id for this resource or service model.
38716       persona-model-version:
38717         type: string
38718         description: the ASDC model version for this resource or service model.
38719       model-version-id:
38720         type: string
38721         description: the ASDC model version for this resource or service model.
38722       widget-model-id:
38723         type: string
38724         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38725       widget-model-version:
38726         type: string
38727         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38728       relationship-list:
38729         type: array
38730         items:
38731           $ref: "#/definitions/relationship"
38732       metadata:
38733         type: array
38734         items:
38735           $ref: "#/definitions/metadatum"
38736   connectors:
38737     description: |
38738       Collection of resource instances used to connect a variety of disparate inventory widgets
38739     properties:
38740       connector:
38741         type: array
38742         items:
38743           $ref: "#/definitions/connector"
38744   constrained-element-set:
38745     description: |
38746       This is how we would capture constraints defining allowed sets of elements.
38747       ###### Related Nodes
38748       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
38749       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
38750       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
38751
38752       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
38753       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
38754     required:
38755     - constrained-element-set-uuid
38756     - constraint-type
38757     - check-type
38758     properties:
38759       constrained-element-set-uuid:
38760         type: string
38761       constraint-type:
38762         type: string
38763       check-type:
38764         type: string
38765       resource-version:
38766         type: string
38767       element-choice-sets:
38768         type: array
38769         items:
38770           $ref: "#/definitions/element-choice-set"
38771       relationship-list:
38772         type: array
38773         items:
38774           $ref: "#/definitions/relationship"
38775   constrained-element-sets:
38776     properties:
38777       constrained-element-set:
38778         type: array
38779         items:
38780           $ref: "#/definitions/constrained-element-set"
38781   ctag-assignment:
38782     description: |
38783       ###### Related Nodes
38784       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
38785
38786       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
38787     required:
38788     - vlan-id-inner
38789     properties:
38790       vlan-id-inner:
38791         type: integer
38792         format: int64
38793         description: id.
38794       resource-version:
38795         type: string
38796         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38797       relationship-list:
38798         type: array
38799         items:
38800           $ref: "#/definitions/relationship"
38801   ctag-assignments:
38802     properties:
38803       ctag-assignment:
38804         type: array
38805         items:
38806           $ref: "#/definitions/ctag-assignment"
38807   ctag-pool:
38808     description: |
38809       A collection of C tags (vlan tags) grouped for a specific purpose.
38810       ###### Related Nodes
38811       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
38812       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
38813       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
38814
38815       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
38816     required:
38817     - target-pe
38818     - availability-zone-name
38819     - ctag-pool-purpose
38820     properties:
38821       target-pe:
38822         type: string
38823         description: The Target provider edge router
38824       availability-zone-name:
38825         type: string
38826         description: Name of the availability zone
38827       ctag-pool-purpose:
38828         type: string
38829         description: Describes what the intended purpose of this pool is.
38830       ctag-values:
38831         type: string
38832         description: Comma separated list of ctags
38833       resource-version:
38834         type: string
38835         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38836       relationship-list:
38837         type: array
38838         items:
38839           $ref: "#/definitions/relationship"
38840   ctag-pools:
38841     properties:
38842       ctag-pool:
38843         type: array
38844         items:
38845           $ref: "#/definitions/ctag-pool"
38846   customer:
38847     description: |
38848       customer identifiers to provide linkage back to BSS information.
38849       ###### Related Nodes
38850       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
38851
38852       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
38853     required:
38854     - global-customer-id
38855     - subscriber-name
38856     - subscriber-type
38857     properties:
38858       global-customer-id:
38859         type: string
38860         description: Global customer id used across ECOMP to uniquely identify customer.
38861       subscriber-name:
38862         type: string
38863         description: Subscriber name, an alternate way to retrieve a customer.
38864       subscriber-type:
38865         type: string
38866         description: Subscriber type, a way to provide VID with only the INFRA customers.
38867       resource-version:
38868         type: string
38869         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38870       service-subscriptions:
38871         type: array
38872         items:
38873           $ref: "#/definitions/service-subscription"
38874       relationship-list:
38875         type: array
38876         items:
38877           $ref: "#/definitions/relationship"
38878   customers:
38879     description: |
38880       Collection of customer identifiers to provide linkage back to BSS information.
38881     properties:
38882       customer:
38883         type: array
38884         items:
38885           $ref: "#/definitions/customer"
38886   cvlan-tag-entry:
38887     required:
38888     - cvlan-tag
38889     properties:
38890       cvlan-tag:
38891         type: integer
38892         format: int64
38893         description: See mis-na-virtualization-platform.yang
38894       resource-version:
38895         type: string
38896         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38897       relationship-list:
38898         type: array
38899         items:
38900           $ref: "#/definitions/relationship"
38901   cvlan-tags:
38902     properties:
38903       cvlan-tag-entry:
38904         type: array
38905         items:
38906           $ref: "#/definitions/cvlan-tag-entry"
38907   dvs-switch:
38908     description: |
38909       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.
38910       ###### Related Nodes
38911       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
38912       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
38913
38914     required:
38915     - switch-name
38916     - vcenter-url
38917     properties:
38918       switch-name:
38919         type: string
38920         description: DVS switch name
38921       vcenter-url:
38922         type: string
38923         description: URL used to reach the vcenter
38924       resource-version:
38925         type: string
38926         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
38927       relationship-list:
38928         type: array
38929         items:
38930           $ref: "#/definitions/relationship"
38931   dvs-switches:
38932     description: |
38933       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
38934     properties:
38935       dvs-switch:
38936         type: array
38937         items:
38938           $ref: "#/definitions/dvs-switch"
38939   edge-prop-names:
38940     description: |
38941       Internal map to define the properties of an edge and interpret the map EdgeRules
38942     properties:
38943       edgeLabel:
38944         type: string
38945       direction:
38946         type: string
38947       multiplicityRule:
38948         type: string
38949       isParent:
38950         type: boolean
38951       usesResource:
38952         type: boolean
38953       hasDelTarget:
38954         type: boolean
38955       SVC-INFRA:
38956         type: boolean
38957       SVC-INFRA-REV:
38958         type: boolean
38959   edge-tag-query-request:
38960     properties:
38961       edge-tag:
38962         type: string
38963       result-detail:
38964         type: string
38965       start-node-type:
38966         type: string
38967       start-node-filter:
38968         type: array
38969         items:
38970           $ref: "#/definitions/start-node-filter"
38971       include-node-filter:
38972         type: array
38973         items:
38974           $ref: "#/definitions/include-node-filter"
38975       secondary-filter:
38976         type: array
38977         items:
38978           $ref: "#/definitions/secondary-filter"
38979   edge-tag-query-result:
38980     properties:
38981       tagged-inventory-item-list:
38982         type: array
38983         items:
38984           $ref: "#/definitions/tagged-inventory-item-list"
38985   element-choice-set:
38986     description: |
38987       This is how we would capture constraints defining allowed sets of elements.
38988       ###### Related Nodes
38989       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
38990       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
38991
38992       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
38993       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
38994     required:
38995     - element-choice-set-uuid
38996     - element-choice-set-name
38997     properties:
38998       element-choice-set-uuid:
38999         type: string
39000       element-choice-set-name:
39001         type: string
39002       cardinality:
39003         type: string
39004       resource-version:
39005         type: string
39006       model-elements:
39007         type: array
39008         items:
39009           $ref: "#/definitions/model-element"
39010       relationship-list:
39011         type: array
39012         items:
39013           $ref: "#/definitions/relationship"
39014   element-choice-sets:
39015     properties:
39016       element-choice-set:
39017         type: array
39018         items:
39019           $ref: "#/definitions/element-choice-set"
39020   entitlement:
39021     description: |
39022       Metadata for entitlement group.
39023       ###### Related Nodes
39024       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
39025       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
39026
39027       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
39028     required:
39029     - group-uuid
39030     - resource-uuid
39031     properties:
39032       group-uuid:
39033         type: string
39034         description: Unique ID for the entitlement group the resource comes from, should be uuid.
39035       resource-uuid:
39036         type: string
39037         description: Unique ID of an entitlement resource.
39038       resource-version:
39039         type: string
39040         description: Concurrency value
39041       relationship-list:
39042         type: array
39043         items:
39044           $ref: "#/definitions/relationship"
39045   entitlements:
39046     description: |
39047       Entitlements, keyed by group-uuid and resource-uuid, related to license management
39048     properties:
39049       entitlement:
39050         type: array
39051         items:
39052           $ref: "#/definitions/entitlement"
39053   esr-ems:
39054     description: |
39055       Persist EMS address information used by EMS driver.
39056       ###### Related Nodes
39057       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
39058
39059       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
39060     required:
39061     - ems-id
39062     properties:
39063       ems-id:
39064         type: string
39065         description: Unique ID of EMS.
39066       resource-version:
39067         type: string
39068         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39069       esr-system-info-list:
39070         type: object
39071         $ref: "#/definitions/esr-system-info-list"
39072       relationship-list:
39073         type: object
39074         $ref: "#/definitions/relationship-list"
39075   esr-ems-list:
39076     properties:
39077       esr-ems:
39078         type: array
39079         items:
39080           $ref: "#/definitions/esr-ems"
39081   esr-system-info:
39082     description: |
39083       Persist common address information of external systems.
39084       ###### Related Nodes
39085       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
39086       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
39087       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
39088       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
39089
39090       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
39091     required:
39092     - esr-system-info-id
39093     - user-name
39094     - password
39095     - system-type
39096     properties:
39097       esr-system-info-id:
39098         type: string
39099         description: Unique ID of esr system info.
39100       system-name:
39101         type: string
39102         description: name of external system.
39103       type:
39104         type: string
39105         description: type of external systems.
39106       vendor:
39107         type: string
39108         description: vendor of external systems.
39109       version:
39110         type: string
39111         description: version of external systems.
39112       service-url:
39113         type: string
39114         description: url used to access external systems.
39115       user-name:
39116         type: string
39117         description: username used to access external systems.
39118       password:
39119         type: string
39120         description: password used to access external systems.
39121       system-type:
39122         type: string
39123         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
39124       protocol:
39125         type: string
39126         description: protocol of third party SDNC, for example netconf/snmp.
39127       ssl-cacert:
39128         type: string
39129         description: ca file content if enabled ssl on auth-url.
39130       ssl-insecure:
39131         type: boolean
39132         description: Whether to verify VIM's certificate.
39133       ip-address:
39134         type: string
39135         description: service IP of ftp server.
39136       port:
39137         type: string
39138         description: service port of ftp server.
39139       cloud-domain:
39140         type: string
39141         description: domain info for authentication.
39142       default-tenant:
39143         type: string
39144         description: default tenant of VIM.
39145       passive:
39146         type: boolean
39147         description: ftp passive mode or not.
39148       remote-path:
39149         type: string
39150         description: resource or performance data file path.
39151       system-status:
39152         type: string
39153         description: the status of external system.
39154       resource-version:
39155         type: string
39156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39157       relationship-list:
39158         type: array
39159         items:
39160           $ref: "#/definitions/relationship"
39161   esr-system-info-list:
39162     description: |
39163       Collection of persistent block-level external system auth info.
39164     properties:
39165       esr-system-info:
39166         type: array
39167         items:
39168           $ref: "#/definitions/esr-system-info"
39169   esr-thirdparty-sdnc:
39170     description: |
39171       Persist SDNC address information used by ONAP SDNC.
39172       ###### Related Nodes
39173       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
39174       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
39175
39176       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
39177     required:
39178     - thirdparty-sdnc-id
39179     properties:
39180       thirdparty-sdnc-id:
39181         type: string
39182         description: Unique ID of SDNC.
39183       location:
39184         type: string
39185         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
39186       product-name:
39187         type: string
39188         description: password used to access SDNC server.
39189       resource-version:
39190         type: string
39191         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39192       esr-system-info-list:
39193         type: object
39194         $ref: "#/definitions/esr-system-info-list"
39195       relationship-list:
39196         type: object
39197         $ref: "#/definitions/relationship-list"
39198   esr-thirdparty-sdnc-list:
39199     properties:
39200       esr-thirdparty-sdnc:
39201         type: array
39202         items:
39203           $ref: "#/definitions/esr-thirdparty-sdnc"
39204   esr-vnfm:
39205     description: |
39206       Persist VNFM address information used by VF-C.
39207       ###### Related Nodes
39208       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
39209
39210       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
39211     required:
39212     - vnfm-id
39213     properties:
39214       vnfm-id:
39215         type: string
39216         description: Unique ID of VNFM.
39217       vim-id:
39218         type: string
39219         description: indecate the VIM to deploy VNF.
39220       certificate-url:
39221         type: string
39222         description: certificate url of VNFM.
39223       resource-version:
39224         type: string
39225         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39226       esr-system-info-list:
39227         type: object
39228         $ref: "#/definitions/esr-system-info-list"
39229       relationship-list:
39230         type: object
39231         $ref: "#/definitions/relationship-list"
39232   esr-vnfm-list:
39233     properties:
39234       esr-vnfm:
39235         type: array
39236         items:
39237           $ref: "#/definitions/esr-vnfm"
39238   evc:
39239     description: |
39240       evc object is an optional child object of the Configuration object.
39241       ###### Related Nodes
39242       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
39243
39244       -(4) IF this TO node is deleted, this EVC is DELETED also
39245     required:
39246     - evc-id
39247     properties:
39248       evc-id:
39249         type: string
39250         description: Unique/key field for the evc object
39251       forwarding-path-topology:
39252         type: string
39253         description: Point-to-Point, Multi-Point
39254       cir-value:
39255         type: string
39256         description: Commited Information Rate
39257       cir-units:
39258         type: string
39259         description: CIR units
39260       connection-diversity-group-id:
39261         type: string
39262         description: Diversity Group ID
39263       service-hours:
39264         type: string
39265         description: formerly Performance Group
39266       esp-evc-circuit-id:
39267         type: string
39268         description: EVC Circuit ID of ESP EVC
39269       esp-evc-cir-value:
39270         type: string
39271         description: Committed Information Rate (For ESP)
39272       esp-evc-cir-units:
39273         type: string
39274         description: CIR units (For ESP)
39275       esp-itu-code:
39276         type: string
39277         description: Identifies ESP
39278       collector-pop-clli:
39279         type: string
39280         description: Collector POP CLLI (from the hostname of the access pnf)
39281       inter-connect-type-ingress:
39282         type: string
39283         description: Interconnect type on ingress side of EVC.
39284       tagmode-access-ingress:
39285         type: string
39286         description: tagode for collector side of EVC
39287       tagmode-access-egress:
39288         type: string
39289         description: tagMode for network side of EVC
39290       relationship-list:
39291         type: array
39292         items:
39293           $ref: "#/definitions/relationship"
39294       resource-version:
39295         type: string
39296         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39297   evcs:
39298     properties:
39299       evc:
39300         type: array
39301         items:
39302           $ref: "#/definitions/evc"
39303   external-system:
39304     description: |
39305       Namespace for external system.
39306     properties:
39307       esr-ems-list:
39308         type: object
39309         $ref: "#/definitions/esr-ems-list"
39310       esr-vnfm-list:
39311         type: object
39312         $ref: "#/definitions/esr-vnfm-list"
39313       esr-thirdparty-sdnc-list:
39314         type: object
39315         $ref: "#/definitions/esr-thirdparty-sdnc-list"
39316   extra-properties:
39317     description: |
39318       Extra properties for inventory item for response list
39319   extra-property:
39320     properties:
39321       property-name:
39322         type: string
39323   flavor:
39324     description: |
39325       Openstack flavor.
39326       ###### Related Nodes
39327       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
39328       - FROM vserver( vserver Uses flavor, MANY2ONE)
39329
39330       -FLAVOR cannot be deleted if related to VSERVER
39331
39332     required:
39333     - flavor-id
39334     - flavor-name
39335     - flavor-selflink
39336     properties:
39337       flavor-id:
39338         type: string
39339         description: Flavor id, expected to be unique across cloud-region.
39340       flavor-name:
39341         type: string
39342         description: Flavor name
39343       flavor-vcpus:
39344         type: integer
39345         format: int32
39346         description: Number of CPUs
39347       flavor-ram:
39348         type: integer
39349         format: int32
39350         description: Amount of memory
39351       flavor-disk:
39352         type: integer
39353         format: int32
39354         description: Disk space
39355       flavor-ephemeral:
39356         type: integer
39357         format: int32
39358         description: Amount of ephemeral disk space
39359       flavor-swap:
39360         type: string
39361         description: amount of swap space allocation
39362       flavor-is-public:
39363         type: boolean
39364         description: whether flavor is available to all users or private to the tenant it was created in.
39365       flavor-selflink:
39366         type: string
39367         description: URL to endpoint where AAI can get more details
39368       flavor-disabled:
39369         type: boolean
39370         description: Boolean as to whether this flavor is no longer enabled
39371       resource-version:
39372         type: string
39373         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39374       relationship-list:
39375         type: array
39376         items:
39377           $ref: "#/definitions/relationship"
39378   flavors:
39379     description: |
39380       Collection of openstack flavors.
39381     properties:
39382       flavor:
39383         type: array
39384         items:
39385           $ref: "#/definitions/flavor"
39386   forwarder:
39387     description: |
39388       Entity describing a sequenced segment of forwarding path
39389       ###### Related Nodes
39390       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
39391       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
39392       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
39393       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
39394       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
39395
39396       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
39397       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
39398     required:
39399     - sequence
39400     properties:
39401       sequence:
39402         type: integer
39403         format: int32
39404         description: Unique ID of this segmentation
39405       forwarder-role:
39406         type: string
39407         description: ingress, intermediate, egress
39408       relationship-list:
39409         type: array
39410         items:
39411           $ref: "#/definitions/relationship"
39412       resource-version:
39413         type: string
39414         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39415   forwarder-evc:
39416     description: |
39417       forwarder object is an optional child object of the Configuration object.
39418       ###### Related Nodes
39419       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
39420
39421       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
39422     required:
39423     - forwarder-evc-id
39424     properties:
39425       forwarder-evc-id:
39426         type: string
39427         description: Key for forwarder-evc object
39428       circuit-id:
39429         type: string
39430         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
39431       ivlan:
39432         type: string
39433         description: Internal VLAN.
39434       svlan:
39435         type: string
39436         description: SVLAN value for ingress of egress forwarder.
39437       cvlan:
39438         type: string
39439         description: CVLAN value for ingress of egress forwarder.
39440       relationship-list:
39441         type: array
39442         items:
39443           $ref: "#/definitions/relationship"
39444       resource-version:
39445         type: string
39446         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39447   forwarder-evcs:
39448     properties:
39449       forwarder-evc:
39450         type: array
39451         items:
39452           $ref: "#/definitions/forwarder-evc"
39453   forwarders:
39454     properties:
39455       forwarder:
39456         type: array
39457         items:
39458           $ref: "#/definitions/forwarder"
39459   forwarding-path:
39460     description: |
39461       Entity that describes the sequenced forwarding path between interfaces of services or resources
39462       ###### Related Nodes
39463       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
39464       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
39465       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
39466
39467       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
39468       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
39469       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
39470     required:
39471     - forwarding-path-id
39472     - forwarding-path-name
39473     properties:
39474       forwarding-path-id:
39475         type: string
39476         description: Unique ID of this FP
39477       forwarding-path-name:
39478         type: string
39479         description: Name of the FP
39480       relationship-list:
39481         type: array
39482         items:
39483           $ref: "#/definitions/relationship"
39484       resource-version:
39485         type: string
39486         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39487       selflink:
39488         type: string
39489         description: the self link for this FP
39490       forwarders:
39491         type: array
39492         items:
39493           $ref: "#/definitions/forwarder"
39494   forwarding-paths:
39495     properties:
39496       forwarding-path:
39497         type: array
39498         items:
39499           $ref: "#/definitions/forwarding-path"
39500   generic-vnf:
39501     description: |
39502       General purpose VNF
39503       ###### Related Nodes
39504       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
39505       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
39506       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
39507       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
39508       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
39509       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
39510       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
39511       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
39512       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
39513       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
39514       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
39515       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
39516       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
39517       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
39518       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
39519       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
39520       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
39521
39522       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
39523     required:
39524     - vnf-id
39525     - vnf-name
39526     - vnf-type
39527     - in-maint
39528     - is-closed-loop-disabled
39529     properties:
39530       vnf-id:
39531         type: string
39532         description: Unique id of VNF.  This is unique across the graph.
39533       vnf-name:
39534         type: string
39535         description: Name of VNF.
39536       vnf-name2:
39537         type: string
39538         description: Alternate name of VNF.
39539       vnf-type:
39540         type: string
39541         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
39542       service-id:
39543         type: string
39544         description: Unique identifier of service from ASDC
39545       regional-resource-zone:
39546         type: string
39547         description: Regional way of organizing pservers, source of truth should define values
39548       prov-status:
39549         type: string
39550         description: Trigger for operational monitoring of this resource by Service Assurance systems.
39551       operational-state:
39552         type: string
39553         description: Indicator for whether the resource is considered operational
39554       license-key:
39555         type: string
39556         description: License key
39557       equipment-role:
39558         type: string
39559         description: Client should send valid enumerated value
39560       orchestration-status:
39561         type: string
39562         description: Orchestration status of this VNF, used by MSO.
39563       heat-stack-id:
39564         type: string
39565         description: Heat stack id corresponding to this instance, managed by MSO
39566       mso-catalog-key:
39567         type: string
39568         description: Corresponds to the SDN-C catalog id used to configure this VCE
39569       management-option:
39570         type: string
39571         description: identifier of managed by company or customer
39572       ipv4-oam-address:
39573         type: string
39574         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
39575       ipv4-loopback0-address:
39576         type: string
39577         description: v4 Loopback0 address
39578       nm-lan-v6-address:
39579         type: string
39580         description: v6 Loopback address
39581       management-v6-address:
39582         type: string
39583         description: v6 management address
39584       vcpu:
39585         type: integer
39586         format: int64
39587         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
39588       vcpu-units:
39589         type: string
39590         description: units associated with vcpu, used for VNFs with no vservers/flavors
39591       vmemory:
39592         type: integer
39593         format: int64
39594         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
39595       vmemory-units:
39596         type: string
39597         description: units associated with vmemory, used for VNFs with no vservers/flavors
39598       vdisk:
39599         type: integer
39600         format: int64
39601         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
39602       vdisk-units:
39603         type: string
39604         description: units associated with vdisk, used for VNFs with no vservers/flavors
39605       in-maint:
39606         type: boolean
39607         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
39608       is-closed-loop-disabled:
39609         type: boolean
39610         description: used to indicate whether closed loop function is enabled on this node
39611       resource-version:
39612         type: string
39613         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39614       summary-status:
39615         type: string
39616         description: details regarding the generic-vnf operation
39617       encrypted-access-flag:
39618         type: boolean
39619         description: indicates whether generic-vnf access uses SSH
39620       persona-model-id:
39621         type: string
39622         description: the ASDC model id for this resource or service model.
39623       persona-model-version:
39624         type: string
39625         description: the ASDC model version for this resource or service model.
39626       model-version-id:
39627         type: string
39628         description: the ASDC model version for this resource or service model.
39629       widget-model-id:
39630         type: string
39631         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39632       widget-model-version:
39633         type: string
39634         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39635       as-number:
39636         type: string
39637         description: as-number of the VNF
39638       regional-resource-subzone:
39639         type: string
39640         description: represents sub zone of the rr plane
39641       relationship-list:
39642         type: array
39643         items:
39644           $ref: "#/definitions/relationship"
39645       l-interfaces:
39646         type: array
39647         items:
39648           $ref: "#/definitions/l-interface"
39649       lag-interfaces:
39650         type: array
39651         items:
39652           $ref: "#/definitions/lag-interface"
39653       vf-modules:
39654         type: array
39655         items:
39656           $ref: "#/definitions/vf-module"
39657   generic-vnfs:
39658     description: |
39659       Collection of VNFs
39660     properties:
39661       generic-vnf:
39662         type: array
39663         items:
39664           $ref: "#/definitions/generic-vnf"
39665   group-assignment:
39666     description: |
39667       Openstack group-assignment used to store exclusivity groups (EG).
39668       ###### Related Nodes
39669       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
39670       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
39671       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
39672
39673     required:
39674     - group-id
39675     - group-type
39676     - group-name
39677     properties:
39678       group-id:
39679         type: string
39680         description: Group id, expected to be unique across cloud-region.
39681       group-type:
39682         type: string
39683         description: Group type - the type of group this instance refers to
39684       group-name:
39685         type: string
39686         description: Group name - name assigned to the group
39687       group-description:
39688         type: string
39689         description: Group description - description of the group
39690       resource-version:
39691         type: string
39692         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39693       relationship-list:
39694         type: array
39695         items:
39696           $ref: "#/definitions/relationship"
39697   group-assignments:
39698     description: |
39699       Collection of openstack group assignments
39700     properties:
39701       group-assignment:
39702         type: array
39703         items:
39704           $ref: "#/definitions/group-assignment"
39705   host-route:
39706     description: |
39707       ###### Related Nodes
39708       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
39709
39710       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
39711     required:
39712     - host-route-id
39713     - route-prefix
39714     - next-hop
39715     properties:
39716       host-route-id:
39717         type: string
39718         description: host-route id
39719       route-prefix:
39720         type: string
39721         description: subnet prefix
39722       next-hop:
39723         type: string
39724         description: Could be ip-address, hostname, or service-instance
39725       next-hop-type:
39726         type: string
39727         description: Should be ip-address, hostname, or service-instance to match next-hop
39728       resource-version:
39729         type: string
39730         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39731       relationship-list:
39732         type: array
39733         items:
39734           $ref: "#/definitions/relationship"
39735   host-routes:
39736     properties:
39737       host-route:
39738         type: array
39739         items:
39740           $ref: "#/definitions/host-route"
39741   hpa-capabilities:
39742     description: |
39743       Collection of HPA Capabilities
39744     properties:
39745       hpa-capability:
39746         type: array
39747         items:
39748           $ref: "#/definitions/hpa-capability"
39749   hpa-capability:
39750     description: |
39751       Represents a HPA capability
39752       ###### Related Nodes
39753       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
39754       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
39755       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
39756
39757       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
39758     required:
39759     - hpa-capability-id
39760     - hpa-feature
39761     properties:
39762       hpa-capability-id:
39763         type: string
39764         description: UUID to uniquely identify a HPA capability
39765       hpa-feature:
39766         type: string
39767         description: Name of the HPACapability
39768       hpa-version:
39769         type: string
39770         description: HPA schema version
39771       architecture:
39772         type: string
39773         description: Hardware architecture
39774       resource-version:
39775         type: string
39776         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39777       relationship-list:
39778         type: array
39779         items:
39780           $ref: "#/definitions/relationship"
39781       hpa-feature-attributes:
39782         type: array
39783         items:
39784           $ref: "#/definitions/hpa-feature-attributes"
39785   hpa-feature-attributes:
39786     description: |
39787       HPA Capability Feature attributes
39788       ###### Related Nodes
39789       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
39790
39791       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
39792     required:
39793     - hpa-attribute-key
39794     properties:
39795       hpa-attribute-key:
39796         type: string
39797         description: name of the specific HPA attribute
39798       hpa-attribute-value:
39799         type: string
39800         description: JSON string specifying the value, unit and type of the specific HPA attribute
39801       resource-version:
39802         type: string
39803         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39804       relationship-list:
39805         type: array
39806         items:
39807           $ref: "#/definitions/relationship"
39808   image:
39809     description: |
39810       Openstack image.
39811       ###### Related Nodes
39812       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
39813       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
39814       - FROM vserver( vserver Uses image, MANY2ONE)
39815
39816       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
39817       -IMAGE cannot be deleted if related to VSERVER
39818
39819     required:
39820     - image-id
39821     - image-name
39822     - image-os-distro
39823     - image-os-version
39824     - image-selflink
39825     properties:
39826       image-id:
39827         type: string
39828         description: Image id, expected to be unique across cloud region
39829       image-name:
39830         type: string
39831         description: Image name
39832       image-architecture:
39833         type: string
39834         description: Operating system architecture.
39835       image-os-distro:
39836         type: string
39837         description: The common name of the operating system distribution in lowercase
39838       image-os-version:
39839         type: string
39840         description: The operating system version as specified by the distributor.
39841       application:
39842         type: string
39843         description: The application that the image instantiates.
39844       application-vendor:
39845         type: string
39846         description: The vendor of the application.
39847       application-version:
39848         type: string
39849         description: The version of the application.
39850       image-selflink:
39851         type: string
39852         description: URL to endpoint where AAI can get more details
39853       resource-version:
39854         type: string
39855         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
39856       relationship-list:
39857         type: array
39858         items:
39859           $ref: "#/definitions/relationship"
39860       metadata:
39861         type: array
39862         items:
39863           $ref: "#/definitions/metadatum"
39864   images:
39865     description: |
39866       Collectio of Openstack images.
39867     properties:
39868       image:
39869         type: array
39870         items:
39871           $ref: "#/definitions/image"
39872   include-node-filter:
39873     properties:
39874       include-node-type:
39875         type: string
39876   instance-filter:
39877     description: |
39878       InstanceFilter for performing a named-query or model query
39879   instance-filters:
39880     description: |
39881       InstanceFilters for performing a named-query or model query
39882     properties:
39883       instance-filter:
39884         type: array
39885         items:
39886           $ref: "#/definitions/instance-filter"
39887   instance-group:
39888     description: |
39889       General mechanism for grouping instances
39890       ###### Related Nodes
39891       - TO model( instance-group Targets model, MANY2MANY)
39892       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
39893       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
39894       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
39895       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
39896
39897     required:
39898     - id
39899     - description
39900     - type
39901     properties:
39902       id:
39903         type: string
39904         description: Instance Group ID, UUID assigned to this instance.
39905       description:
39906         type: string
39907         description: Descriptive text to help identify the usage of this instance-group
39908       type:
39909         type: string
39910         description: Only valid value today is lower case ha for high availability
39911       sub-type:
39912         type: string
39913         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
39914       resource-version:
39915         type: string
39916         description: Concurrency value
39917       relationship-list:
39918         type: array
39919         items:
39920           $ref: "#/definitions/relationship"
39921   instance-groups:
39922     description: |
39923       Collection of openstack route table references
39924     properties:
39925       instance-group:
39926         type: array
39927         items:
39928           $ref: "#/definitions/instance-group"
39929   inventory:
39930     properties:
39931       search:
39932         type: object
39933         $ref: "#/definitions/search"
39934       actions:
39935         type: object
39936         $ref: "#/definitions/actions"
39937       cloud-infrastructure:
39938         type: object
39939         $ref: "#/definitions/cloud-infrastructure"
39940       business:
39941         type: object
39942         $ref: "#/definitions/business"
39943       service-design-and-creation:
39944         type: object
39945         $ref: "#/definitions/service-design-and-creation"
39946       network:
39947         type: object
39948         $ref: "#/definitions/network"
39949   inventory-item:
39950     properties:
39951       inventory-item-type:
39952         type: string
39953       inventory-item-link:
39954         type: string
39955       inventory-item-data:
39956         type: array
39957         items:
39958           $ref: "#/definitions/inventory-item-data"
39959       tagged-inventory-item-list:
39960         type: array
39961         items:
39962           $ref: "#/definitions/tagged-inventory-item-list"
39963   inventory-item-data:
39964     properties:
39965       property-name:
39966         type: string
39967       property-value:
39968         type: string
39969   inventory-response-item:
39970     description: |
39971       Inventory item for response list
39972     properties:
39973       model-name:
39974         type: string
39975       extra-properties:
39976         type: object
39977         $ref: "#/definitions/extra-properties"
39978       inventory-response-items:
39979         type: object
39980         $ref: "#/definitions/inventory-response-items"
39981   inventory-response-items:
39982     description: |
39983       Container for inventory items in response list
39984     properties:
39985       inventory-response-item:
39986         type: array
39987         items:
39988           $ref: "#/definitions/inventory-response-item"
39989   ipsec-configuration:
39990     description: |
39991       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
39992       ###### Related Nodes
39993       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
39994       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
39995
39996       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
39997     required:
39998     - ipsec-configuration-id
39999     properties:
40000       ipsec-configuration-id:
40001         type: string
40002         description: UUID of this configuration
40003       requested-vig-address-type:
40004         type: string
40005         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
40006       requested-encryption-strength:
40007         type: string
40008         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
40009       requested-dmz-type:
40010         type: string
40011         description: can offer a shared DMZ or a DMZ specific to a customer
40012       shared-dmz-network-address:
40013         type: string
40014         description: Network address of shared DMZ
40015       requested-customer-name:
40016         type: string
40017         description: If the DMZ is a custom DMZ, this field will indicate the customer information
40018       ike-version:
40019         type: string
40020         description: can be 1 or 2
40021       ikev1-authentication:
40022         type: string
40023         description: Contains values like md5, sha1, sha256, sha384
40024       ikev1-encryption:
40025         type: string
40026         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
40027       ikev1-dh-group:
40028         type: string
40029         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
40030       ikev1-am-group-id:
40031         type: string
40032         description: Group name defined in VIG for clients using aggressive mode
40033       ikev1-am-password:
40034         type: string
40035         description: pre-shared key for the above group name
40036       ikev1-sa-lifetime:
40037         type: string
40038         description: Lifetime for IKEv1 SA
40039       ipsec-authentication:
40040         type: string
40041         description: md5, sha1, sha256, sha384
40042       ipsec-encryption:
40043         type: string
40044         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
40045       ipsec-sa-lifetime:
40046         type: string
40047         description: Life time for IPSec SA
40048       ipsec-pfs:
40049         type: string
40050         description: enable PFS or not
40051       xauth-userid:
40052         type: string
40053         description: user ID for xAuth, sm-user, ,nmteHostName
40054       xauth-user-password:
40055         type: string
40056         description: Encrypted using the Juniper $9$ algorithm
40057       dpd-interval:
40058         type: string
40059         description: The time between DPD probe
40060       dpd-frequency:
40061         type: string
40062         description: Maximum number of DPD before claiming the tunnel is down
40063       resource-version:
40064         type: string
40065         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40066       relationship-list:
40067         type: array
40068         items:
40069           $ref: "#/definitions/relationship"
40070       vig-servers:
40071         type: array
40072         items:
40073           $ref: "#/definitions/vig-server"
40074   ipsec-configurations:
40075     properties:
40076       ipsec-configuration:
40077         type: array
40078         items:
40079           $ref: "#/definitions/ipsec-configuration"
40080   key-data:
40081     properties:
40082       key-name:
40083         type: string
40084       key-value:
40085         type: string
40086   l-interface:
40087     description: |
40088       Logical interfaces, e.g., a vnic.
40089       ###### Related Nodes
40090       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
40091       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
40092       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
40093       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
40094       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
40095       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
40096       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
40097       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
40098       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
40099       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
40100
40101       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
40102       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
40103       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
40104     required:
40105     - interface-name
40106     properties:
40107       interface-name:
40108         type: string
40109         description: Name given to the interface
40110       interface-role:
40111         type: string
40112         description: E.g., CUSTOMER, UPLINK, etc.
40113       v6-wan-link-ip:
40114         type: string
40115         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
40116       selflink:
40117         type: string
40118         description: URL to endpoint where AAI can get more details
40119       interface-id:
40120         type: string
40121         description: ID of interface
40122       macaddr:
40123         type: string
40124         description: MAC address for the interface
40125       network-name:
40126         type: string
40127         description: Name of the network
40128       management-option:
40129         type: string
40130         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
40131       resource-version:
40132         type: string
40133         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40134       vlans:
40135         type: array
40136         items:
40137           $ref: "#/definitions/vlan"
40138       sriov-vfs:
40139         type: array
40140         items:
40141           $ref: "#/definitions/sriov-vf"
40142       relationship-list:
40143         type: array
40144         items:
40145           $ref: "#/definitions/relationship"
40146       l3-interface-ipv4-address-list:
40147         type: array
40148         items:
40149           $ref: "#/definitions/l3-interface-ipv4-address-list"
40150       l3-interface-ipv6-address-list:
40151         type: array
40152         items:
40153           $ref: "#/definitions/l3-interface-ipv6-address-list"
40154   l-interfaces:
40155     description: |
40156       Collection of logical interfaces.
40157     properties:
40158       l-interface:
40159         type: array
40160         items:
40161           $ref: "#/definitions/l-interface"
40162   l3-interface-ipv4-address-list:
40163     description: |
40164       IPv4 Address Range
40165       ###### Related Nodes
40166       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
40167       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
40168       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
40169       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
40170
40171       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
40172     required:
40173     - l3-interface-ipv4-address
40174     properties:
40175       l3-interface-ipv4-address:
40176         type: string
40177         description: IP address
40178       l3-interface-ipv4-prefix-length:
40179         type: integer
40180         format: int64
40181         description: Prefix length, 32 for single address
40182       vlan-id-inner:
40183         type: integer
40184         format: int64
40185         description: Inner VLAN tag
40186       vlan-id-outer:
40187         type: integer
40188         format: int64
40189         description: Outer VLAN tag
40190       is-floating:
40191         type: boolean
40192         description: Indicator of fixed or floating address
40193       resource-version:
40194         type: string
40195         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40196       neutron-network-id:
40197         type: string
40198         description: Neutron network id of the interface that address belongs to
40199       neutron-subnet-id:
40200         type: string
40201         description: Neutron id of subnet that address belongs to
40202       relationship-list:
40203         type: array
40204         items:
40205           $ref: "#/definitions/relationship"
40206   l3-interface-ipv6-address-list:
40207     description: |
40208       IPv6 Address Range
40209       ###### Related Nodes
40210       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
40211       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
40212       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
40213       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
40214
40215       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
40216     required:
40217     - l3-interface-ipv6-address
40218     properties:
40219       l3-interface-ipv6-address:
40220         type: string
40221         description: IP address
40222       l3-interface-ipv6-prefix-length:
40223         type: integer
40224         format: int64
40225         description: Prefix length, 128 for single address
40226       vlan-id-inner:
40227         type: integer
40228         format: int64
40229         description: Inner VLAN tag
40230       vlan-id-outer:
40231         type: integer
40232         format: int64
40233         description: Outer VLAN tag
40234       is-floating:
40235         type: boolean
40236         description: Indicator of fixed or floating address
40237       resource-version:
40238         type: string
40239         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40240       neutron-network-id:
40241         type: string
40242         description: Neutron network id of the interface that address belongs to
40243       neutron-subnet-id:
40244         type: string
40245         description: Neutron id of subnet that address belongs to
40246       relationship-list:
40247         type: array
40248         items:
40249           $ref: "#/definitions/relationship"
40250   l3-network:
40251     description: |
40252       Generic network definition
40253       ###### Related Nodes
40254       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
40255       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
40256       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
40257       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
40258       - FROM complex( complex Uses l3-network, MANY2MANY)
40259       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
40260       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
40261       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
40262       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
40263       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
40264       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
40265       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
40266       - FROM tenant( tenant Uses l3-network, MANY2MANY)
40267       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
40268
40269       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
40270     required:
40271     - network-id
40272     - network-name
40273     - is-bound-to-vpn
40274     - is-provider-network
40275     - is-shared-network
40276     - is-external-network
40277     properties:
40278       network-id:
40279         type: string
40280         description: Network ID, should be uuid. Unique across A&AI.
40281       network-name:
40282         type: string
40283         description: Name of the network, governed by some naming convention..
40284       network-type:
40285         type: string
40286         description: Type of the network - who defines these values?
40287       network-role:
40288         type: string
40289         description: Role the network plans - who defines these values?
40290       network-technology:
40291         type: string
40292         description: Network technology - who defines these values?
40293       neutron-network-id:
40294         type: string
40295         description: Neutron network id of this Interface
40296       is-bound-to-vpn:
40297         type: boolean
40298         description: Set to true if bound to VPN
40299       service-id:
40300         type: string
40301         description: Unique identifier of service from ASDC
40302       network-role-instance:
40303         type: integer
40304         format: int64
40305         description: network role instance
40306       resource-version:
40307         type: string
40308         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40309       orchestration-status:
40310         type: string
40311         description: Orchestration status of this VNF, mastered by MSO
40312       heat-stack-id:
40313         type: string
40314         description: Heat stack id corresponding to this instance, managed by MSO
40315       mso-catalog-key:
40316         type: string
40317         description: Corresponds to the SDN-C catalog id used to configure this VCE
40318       contrail-network-fqdn:
40319         type: string
40320         description: Contrail FQDN for the network
40321       persona-model-id:
40322         type: string
40323         description: the ASDC model id for this resource or service model.
40324       persona-model-version:
40325         type: string
40326         description: the ASDC model version for this resource or service model.
40327       model-version-id:
40328         type: string
40329         description: the ASDC model version for this resource or service model.
40330       widget-model-id:
40331         type: string
40332         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40333       widget-model-version:
40334         type: string
40335         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40336       physical-network-name:
40337         type: string
40338         description: Name associated with the physical network.
40339       is-provider-network:
40340         type: boolean
40341         description: boolean indicatating whether or not network is a provider network.
40342       is-shared-network:
40343         type: boolean
40344         description: boolean indicatating whether or not network is a shared network.
40345       is-external-network:
40346         type: boolean
40347         description: boolean indicatating whether or not network is an external network.
40348       subnets:
40349         type: array
40350         items:
40351           $ref: "#/definitions/subnet"
40352       ctag-assignments:
40353         type: array
40354         items:
40355           $ref: "#/definitions/ctag-assignment"
40356       segmentation-assignments:
40357         type: array
40358         items:
40359           $ref: "#/definitions/segmentation-assignment"
40360       relationship-list:
40361         type: array
40362         items:
40363           $ref: "#/definitions/relationship"
40364         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
40365   l3-networks:
40366     properties:
40367       l3-network:
40368         type: array
40369         items:
40370           $ref: "#/definitions/l3-network"
40371   lag-interface:
40372     description: |
40373       Link aggregate interface
40374       ###### Related Nodes
40375       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
40376       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
40377       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
40378       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
40379       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
40380       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
40381       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
40382
40383       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
40384       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
40385       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
40386     required:
40387     - interface-name
40388     properties:
40389       interface-name:
40390         type: string
40391         description: Name that identifies the link aggregate interface
40392       resource-version:
40393         type: string
40394         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40395       speed-value:
40396         type: string
40397         description: Captures the numeric part of the speed
40398       speed-units:
40399         type: string
40400         description: Captures the units corresponding to the speed
40401       relationship-list:
40402         type: array
40403         items:
40404           $ref: "#/definitions/relationship"
40405       l-interfaces:
40406         type: array
40407         items:
40408           $ref: "#/definitions/l-interface"
40409   lag-interfaces:
40410     description: |
40411       Collection of link aggregate interfaces.
40412     properties:
40413       lag-interface:
40414         type: array
40415         items:
40416           $ref: "#/definitions/lag-interface"
40417   lag-link:
40418     description: |
40419       LAG links can connect lag-interfaces
40420       ###### Related Nodes
40421       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
40422       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
40423
40424       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
40425     required:
40426     - link-name
40427     properties:
40428       link-name:
40429         type: string
40430         description: Alphabetical concatenation of lag-interface names
40431       resource-version:
40432         type: string
40433         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40434       relationship-list:
40435         type: array
40436         items:
40437           $ref: "#/definitions/relationship"
40438   lag-links:
40439     description: |
40440       Collection of link aggregation connections
40441     properties:
40442       lag-link:
40443         type: array
40444         items:
40445           $ref: "#/definitions/lag-link"
40446   license:
40447     description: |
40448       Metadata for license group.
40449       ###### Related Nodes
40450       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
40451       - TO vce( license BelongsTo vce, MANY2ONE)(4)
40452
40453       -(4) IF this TO node is deleted, this LICENSE is DELETED also
40454     required:
40455     - group-uuid
40456     - resource-uuid
40457     properties:
40458       group-uuid:
40459         type: string
40460         description: Unique ID for the license group the resource belongs to, should be uuid.
40461       resource-uuid:
40462         type: string
40463         description: Unique ID of a license resource.
40464       resource-version:
40465         type: string
40466         description: Concurrency value
40467       relationship-list:
40468         type: array
40469         items:
40470           $ref: "#/definitions/relationship"
40471   licenses:
40472     description: |
40473       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
40474     properties:
40475       license:
40476         type: array
40477         items:
40478           $ref: "#/definitions/license"
40479   line-of-business:
40480     description: |
40481       describes a line-of-business
40482       ###### Related Nodes
40483       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
40484
40485     required:
40486     - line-of-business-name
40487     properties:
40488       line-of-business-name:
40489         type: string
40490         description: Name of the line-of-business (product)
40491       resource-version:
40492         type: string
40493         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40494       relationship-list:
40495         type: array
40496         items:
40497           $ref: "#/definitions/relationship"
40498   lines-of-business:
40499     description: |
40500       Collection of lines-of-business
40501     properties:
40502       line-of-business:
40503         type: array
40504         items:
40505           $ref: "#/definitions/line-of-business"
40506   logical-link:
40507     description: |
40508       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
40509       ###### Related Nodes
40510       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
40511       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
40512       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
40513       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
40514       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
40515       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
40516       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
40517       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
40518       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
40519       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
40520       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
40521
40522       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
40523     required:
40524     - link-name
40525     - link-type
40526     properties:
40527       link-name:
40528         type: string
40529         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
40530       link-type:
40531         type: string
40532         description: Type of logical link, e.g., evc
40533       speed-value:
40534         type: string
40535         description: Captures the numeric part of the speed
40536       speed-units:
40537         type: string
40538         description: Captures the units corresponding to the speed
40539       ip-version:
40540         type: string
40541         description: v4, v6, or ds for dual stack
40542       routing-protocol:
40543         type: string
40544         description: For example, static or BGP
40545       resource-version:
40546         type: string
40547         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40548       persona-model-id:
40549         type: string
40550         description: the ASDC model id for this resource or service model.
40551       persona-model-version:
40552         type: string
40553         description: the ASDC model version for this resource or service model.
40554       model-version-id:
40555         type: string
40556         description: the ASDC model version for this resource or service model.
40557       widget-model-id:
40558         type: string
40559         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40560       widget-model-version:
40561         type: string
40562         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40563       operational-status:
40564         type: string
40565         description: Indication of operational status of the logical link.
40566       link-role:
40567         type: string
40568         description: Indication of the network use of the logical link.
40569       link-name2:
40570         type: string
40571         description: Alias or alternate name (CLCI or D1 name).
40572       link-id:
40573         type: string
40574         description: UUID of the logical-link, SDNC generates this.
40575       relationship-list:
40576         type: array
40577         items:
40578           $ref: "#/definitions/relationship"
40579   logical-links:
40580     description: |
40581       Collection of logical connections
40582     properties:
40583       logical-link:
40584         type: array
40585         items:
40586           $ref: "#/definitions/logical-link"
40587   metadata:
40588     description: |
40589       Collection of metadatum (key/value pairs)
40590     properties:
40591       metadatum:
40592         type: array
40593         items:
40594           $ref: "#/definitions/metadatum"
40595   metadatum:
40596     description: |
40597       Key/value pairs
40598       ###### Related Nodes
40599       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
40600       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
40601       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
40602       - TO model( metadatum BelongsTo model, MANY2ONE)(4)
40603
40604       -(4) IF this TO node is deleted, this METADATUM is DELETED also
40605     required:
40606     - metaname
40607     - metaval
40608     properties:
40609       metaname:
40610         type: string
40611       metaval:
40612         type: string
40613       resource-version:
40614         type: string
40615         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40616   model:
40617     description: |
40618       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
40619       ###### Related Nodes
40620       - TO model( model-element isA model, MANY2ONE)
40621       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
40622       - FROM named-query( named-query AppliesTo model, ONE2MANY)
40623       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
40624       - FROM model-element( model-element isA model, MANY2ONE)
40625       - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
40626
40627       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
40628       -(2) IF this MODEL node is deleted, this TO node is DELETED also
40629       -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
40630
40631     required:
40632     - model-name-version-id
40633     - model-type
40634     - model-name
40635     - model-id
40636     - model-version
40637     properties:
40638       model-name-version-id:
40639         type: string
40640         description: Unique identifier corresponding to one version of a model in ASDC
40641       model-type:
40642         type: string
40643         description: Type of the model, e.g., service, resource, widget, etc.
40644       model-name:
40645         type: string
40646         description: Name of the model, which can change from version to version.
40647       model-id:
40648         type: string
40649         description: Invariant unique ID which does not change from version to version
40650       model-version:
40651         type: string
40652         description: Version
40653       model-description:
40654         type: string
40655         description: Description
40656       resource-version:
40657         type: string
40658         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40659       model-elements:
40660         type: array
40661         items:
40662           $ref: "#/definitions/model-element"
40663       metadata:
40664         type: array
40665         items:
40666           $ref: "#/definitions/metadatum"
40667       relationship-list:
40668         type: array
40669         items:
40670           $ref: "#/definitions/relationship"
40671   model-and-named-query-search:
40672     description: |
40673       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
40674     properties:
40675       query-parameters:
40676         type: object
40677         $ref: "#/definitions/query-parameters"
40678       instance-filters:
40679         type: object
40680         $ref: "#/definitions/instance-filters"
40681       top-node-type:
40682         type: string
40683   model-constraint:
40684     description: |
40685       This is how we would capture constraints defining allowed sets of elements.
40686       ###### Related Nodes
40687       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
40688       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
40689
40690       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
40691       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
40692     required:
40693     - model-constraint-uuid
40694     - constrained-element-set-uuid-to-replace
40695     properties:
40696       model-constraint-uuid:
40697         type: string
40698       constrained-element-set-uuid-to-replace:
40699         type: string
40700       constrained-element-sets:
40701         type: array
40702         items:
40703           $ref: "#/definitions/constrained-element-set"
40704   model-constraints:
40705     properties:
40706       model-constraint:
40707         type: array
40708         items:
40709           $ref: "#/definitions/model-constraint"
40710   model-element:
40711     description: |
40712       Defines how other models combine to make up a higher-level model.
40713       ###### Related Nodes
40714       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
40715       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
40716       - TO model( model-element isA model, MANY2ONE)
40717       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
40718       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
40719       - FROM model (PARENT of model-element, model startsWith model-element)(3)
40720       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
40721
40722       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
40723       -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
40724       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
40725     required:
40726     - model-element-uuid
40727     - new-data-del-flag
40728     - cardinality
40729     properties:
40730       model-element-uuid:
40731         type: string
40732       new-data-del-flag:
40733         type: string
40734         description: Indicates whether this element was created as part of instantiation from this model
40735       cardinality:
40736         type: string
40737         description: How many of this type of element are required/allowed
40738       linkage-points:
40739         type: string
40740       resource-version:
40741         type: string
40742         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40743       model-elements:
40744         type: array
40745         items:
40746           $ref: "#/definitions/model-element"
40747         description: Defines how other models combine to make up a higher-level model
40748       model-constraints:
40749         type: array
40750         items:
40751           $ref: "#/definitions/model-constraint"
40752         description: Describes new constraints on this model element that are not part of that model's definition
40753       relationship-list:
40754         type: array
40755         items:
40756           $ref: "#/definitions/relationship"
40757   model-elements:
40758     properties:
40759       model-element:
40760         type: array
40761         items:
40762           $ref: "#/definitions/model-element"
40763   model-ver:
40764     description: |
40765       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
40766       ###### Related Nodes
40767       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
40768       - FROM model-element( model-element IsA model-ver, MANY2ONE)
40769       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
40770       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
40771
40772       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
40773       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
40774       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
40775
40776     required:
40777     - model-version-id
40778     - model-name
40779     - model-version
40780     properties:
40781       model-version-id:
40782         type: string
40783         description: Unique identifier corresponding to one version of a model in ASDC
40784       model-name:
40785         type: string
40786         description: Name of the model, which can change from version to version.
40787       model-version:
40788         type: string
40789         description: Version
40790       model-description:
40791         type: string
40792         description: Description
40793       resource-version:
40794         type: string
40795         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40796       model-elements:
40797         type: array
40798         items:
40799           $ref: "#/definitions/model-element"
40800       metadata:
40801         type: array
40802         items:
40803           $ref: "#/definitions/metadatum"
40804       relationship-list:
40805         type: array
40806         items:
40807           $ref: "#/definitions/relationship"
40808   model-vers:
40809     properties:
40810       model-ver:
40811         type: array
40812         items:
40813           $ref: "#/definitions/model-ver"
40814   models:
40815     description: |
40816       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
40817     properties:
40818       model:
40819         type: array
40820         items:
40821           $ref: "#/definitions/model"
40822   multicast-configuration:
40823     description: |
40824       ###### Related Nodes
40825       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
40826
40827     required:
40828     - multicast-configuration-id
40829     - multicast-protocol
40830     - rp-type
40831     properties:
40832       multicast-configuration-id:
40833         type: string
40834         description: Unique id of multicast configuration.
40835       multicast-protocol:
40836         type: string
40837         description: protocol of multicast configuration
40838       rp-type:
40839         type: string
40840         description: rp type of multicast configuration
40841       resource-version:
40842         type: string
40843         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
40844       relationship-list:
40845         type: array
40846         items:
40847           $ref: "#/definitions/relationship"
40848   multicast-configurations:
40849     description: |
40850       multicast configuration of generic-vnf ip-address
40851     properties:
40852       multicast-configuration:
40853         type: array
40854         items:
40855           $ref: "#/definitions/multicast-configuration"
40856   named-queries:
40857     properties:
40858       named-query:
40859         type: array
40860         items:
40861           $ref: "#/definitions/named-query"
40862   named-query:
40863     description: |
40864       TBD
40865       ###### Related Nodes
40866       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
40867       - TO model( named-query AppliesTo model, ONE2MANY)
40868       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
40869
40870       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
40871     required:
40872     - named-query-uuid
40873     - named-query-name
40874     - named-query-version
40875     properties:
40876       named-query-uuid:
40877         type: string
40878       named-query-name:
40879         type: string
40880       named-query-version:
40881         type: string
40882       required-input-param:
40883         type: string
40884       description:
40885         type: string
40886       resource-version:
40887         type: string
40888       named-query-elements:
40889         type: array
40890         items:
40891           $ref: "#/definitions/named-query-element"
40892       relationship-list:
40893         type: array
40894         items:
40895           $ref: "#/definitions/relationship"
40896   named-query-element:
40897     description: |
40898       TBD
40899       ###### Related Nodes
40900       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
40901       - TO model( named-query-element IsA model, MANY2ONE)
40902       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
40903       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
40904       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
40905       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
40906
40907       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
40908       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
40909     required:
40910     - named-query-element-uuid
40911     properties:
40912       named-query-element-uuid:
40913         type: string
40914       property-collect-list:
40915         type: string
40916       resource-version:
40917         type: string
40918       property-limit-desc:
40919         type: string
40920       do-not-output:
40921         type: string
40922       named-query-elements:
40923         type: array
40924         items:
40925           $ref: "#/definitions/named-query-element"
40926       related-lookups:
40927         type: array
40928         items:
40929           $ref: "#/definitions/related-lookup"
40930       property-constraints:
40931         type: array
40932         items:
40933           $ref: "#/definitions/property-constraint"
40934       relationship-list:
40935         type: array
40936         items:
40937           $ref: "#/definitions/relationship"
40938   named-query-elements:
40939     properties:
40940       named-query-element:
40941         type: array
40942         items:
40943           $ref: "#/definitions/named-query-element"
40944   network:
40945     description: |
40946       Namespace for network inventory resources.
40947     properties:
40948       logical-links:
40949         type: array
40950         items:
40951           $ref: "#/definitions/logical-link"
40952       site-pair-sets:
40953         type: array
40954         items:
40955           $ref: "#/definitions/site-pair-set"
40956       vpn-bindings:
40957         type: array
40958         items:
40959           $ref: "#/definitions/vpn-binding"
40960       vpls-pes:
40961         type: array
40962         items:
40963           $ref: "#/definitions/vpls-pe"
40964       multicast-configurations:
40965         type: array
40966         items:
40967           $ref: "#/definitions/multicast-configuration"
40968       vces:
40969         type: array
40970         items:
40971           $ref: "#/definitions/vce"
40972       vnfcs:
40973         type: array
40974         items:
40975           $ref: "#/definitions/vnfc"
40976       l3-networks:
40977         type: array
40978         items:
40979           $ref: "#/definitions/l3-network"
40980       network-policies:
40981         type: array
40982         items:
40983           $ref: "#/definitions/network-policy"
40984       generic-vnfs:
40985         type: array
40986         items:
40987           $ref: "#/definitions/generic-vnf"
40988       lag-links:
40989         type: array
40990         items:
40991           $ref: "#/definitions/lag-link"
40992       newvces:
40993         type: array
40994         items:
40995           $ref: "#/definitions/newvce"
40996       pnfs:
40997         type: array
40998         items:
40999           $ref: "#/definitions/pnf"
41000       physical-links:
41001         type: array
41002         items:
41003           $ref: "#/definitions/physical-link"
41004       ipsec-configurations:
41005         type: array
41006         items:
41007           $ref: "#/definitions/ipsec-configuration"
41008       route-table-references:
41009         type: array
41010         items:
41011           $ref: "#/definitions/route-table-reference"
41012   network-policies:
41013     properties:
41014       network-policy:
41015         type: array
41016         items:
41017           $ref: "#/definitions/network-policy"
41018   network-policy:
41019     description: |
41020       ###### Related Nodes
41021       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
41022
41023     required:
41024     - network-policy-id
41025     properties:
41026       network-policy-id:
41027         type: string
41028         description: UUID representing unique key to this instance
41029       network-policy-fqdn:
41030         type: string
41031         description: Contrail FQDN for the policy
41032       heat-stack-id:
41033         type: string
41034         description: ID for the openStack Heat instance
41035       resource-version:
41036         type: string
41037         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41038       relationship-list:
41039         type: array
41040         items:
41041           $ref: "#/definitions/relationship"
41042   network-profile:
41043     description: |
41044       Network profile populated by SDN-GP for SNMP
41045       ###### Related Nodes
41046       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
41047
41048     required:
41049     - nm-profile-name
41050     properties:
41051       nm-profile-name:
41052         type: string
41053         description: Unique name of network profile.
41054       community-string:
41055         type: string
41056         description: Encrypted SNMP community string
41057       resource-version:
41058         type: string
41059         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41060       relationship-list:
41061         type: array
41062         items:
41063           $ref: "#/definitions/relationship"
41064   network-profiles:
41065     description: |
41066       Collection of network profiles
41067     properties:
41068       network-profile:
41069         type: array
41070         items:
41071           $ref: "#/definitions/network-profile"
41072   newvce:
41073     description: |
41074       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
41075       ###### Related Nodes
41076       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
41077
41078       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
41079     required:
41080     - vnf-id2
41081     - vnf-name
41082     - vnf-type
41083     properties:
41084       vnf-id2:
41085         type: string
41086         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41087       vnf-name:
41088         type: string
41089         description: Name of VNF.
41090       vnf-name2:
41091         type: string
41092         description: Alternate name of VNF.
41093       vnf-type:
41094         type: string
41095         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
41096       prov-status:
41097         type: string
41098         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41099       operational-state:
41100         type: string
41101         description: Indicator for whether the resource is considered operational
41102       license-key:
41103         type: string
41104         description: License key
41105       ipv4-oam-address:
41106         type: string
41107         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).
41108       equipment-role:
41109         type: string
41110         description: Client should send valid enumerated value.
41111       resource-version:
41112         type: string
41113         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41114       ipv4-loopback0-address:
41115         type: string
41116         description: v4 Loopback0 address
41117       orchestration-status:
41118         type: string
41119         description: Orchestration status of this VNF, mastered by MSO.
41120       heat-stack-id:
41121         type: string
41122         description: Heat stack id corresponding to this instance, managed by MSO
41123       mso-catalog-key:
41124         type: string
41125         description: Corresponds to the SDN-C catalog id used to configure this VCE
41126       relationship-list:
41127         type: array
41128         items:
41129           $ref: "#/definitions/relationship"
41130       l-interfaces:
41131         type: array
41132         items:
41133           $ref: "#/definitions/l-interface"
41134   newvces:
41135     description: |
41136       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
41137     properties:
41138       newvce:
41139         type: array
41140         items:
41141           $ref: "#/definitions/newvce"
41142   nodes:
41143     properties:
41144       inventory-item-data:
41145         type: array
41146         items:
41147           $ref: "#/definitions/inventory-item-data"
41148   notification-event:
41149     properties:
41150       cambria.partition:
41151         type: string
41152       notification-event-header:
41153         type: object
41154         $ref: "#/definitions/notification-event-header"
41155   notification-event-header:
41156     properties:
41157       id:
41158         type: string
41159       timestamp:
41160         type: string
41161       source-name:
41162         type: string
41163       domain:
41164         type: string
41165       sequence-number:
41166         type: string
41167       severity:
41168         type: string
41169       event-type:
41170         type: string
41171       version:
41172         type: string
41173       action:
41174         type: string
41175       entity-type:
41176         type: string
41177       top-entity-type:
41178         type: string
41179       entity-link:
41180         type: string
41181       status:
41182         type: string
41183   notify:
41184     required:
41185     - event-id
41186     properties:
41187       event-id:
41188         type: string
41189       node-type:
41190         type: string
41191       event-trigger:
41192         type: string
41193       key-data:
41194         type: array
41195         items:
41196           $ref: "#/definitions/key-data"
41197       selflink:
41198         type: string
41199   oam-network:
41200     description: |
41201       OAM network, to be deprecated shortly.  Do not use for new purposes.
41202       ###### Related Nodes
41203       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
41204       - TO complex( oam-network AppliesTo complex, MANY2MANY)
41205       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
41206
41207     required:
41208     - network-uuid
41209     - network-name
41210     - cvlan-tag
41211     properties:
41212       network-uuid:
41213         type: string
41214         description: UUID of the network. Unique across a cloud-region
41215       network-name:
41216         type: string
41217         description: Name of the network.
41218       cvlan-tag:
41219         type: integer
41220         format: int64
41221         description: cvlan-id
41222       ipv4-oam-gateway-address:
41223         type: string
41224         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
41225       ipv4-oam-gateway-address-prefix-length:
41226         type: integer
41227         format: int32
41228         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
41229       resource-version:
41230         type: string
41231         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41232       relationship-list:
41233         type: array
41234         items:
41235           $ref: "#/definitions/relationship"
41236   oam-networks:
41237     description: |
41238       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
41239     properties:
41240       oam-network:
41241         type: array
41242         items:
41243           $ref: "#/definitions/oam-network"
41244   operational-environment:
41245     description: |
41246       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
41247       ###### Related Nodes
41248       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
41249       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
41250
41251     required:
41252     - operational-environment-id
41253     - operational-environment-name
41254     - operational-environment-type
41255     - operational-environment-status
41256     - tenant-context
41257     - workload-context
41258     properties:
41259       operational-environment-id:
41260         type: string
41261         description: UUID of an operational environment
41262       operational-environment-name:
41263         type: string
41264         description: Operational Environment name
41265       operational-environment-type:
41266         type: string
41267         description: Operational Environment Type.
41268       operational-environment-status:
41269         type: string
41270         description: Status
41271       tenant-context:
41272         type: string
41273         description: Tenant Context.
41274       workload-context:
41275         type: string
41276         description: Workload Context.
41277       resource-version:
41278         type: string
41279         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41280       relationship-list:
41281         type: array
41282         items:
41283           $ref: "#/definitions/relationship"
41284   operational-environments:
41285     description: |
41286       a logical partition of the cloud which allows to have multiple environments in the production AIC.
41287     properties:
41288       operational-environment:
41289         type: array
41290         items:
41291           $ref: "#/definitions/operational-environment"
41292   overloaded-model:
41293     description: |
41294       Allows for legacy POST of old-style and new-style models
41295     required:
41296     - model-invariant-id
41297     - model-name-version-id
41298     - model-type
41299     - model-name
41300     - model-id
41301     - model-version
41302     properties:
41303       model-invariant-id:
41304         type: string
41305         description: Unique identifier corresponding to the main definition of a model in ASDC
41306       model-name-version-id:
41307         type: string
41308         description: Unique identifier corresponding to one version of a model in ASDC
41309       model-type:
41310         type: string
41311         description: Type of the model, e.g., service, resource, widget, etc.
41312       model-name:
41313         type: string
41314         description: Name of the model, which can change from version to version.
41315       model-id:
41316         type: string
41317         description: Invariant unique ID which does not change from version to version
41318       model-version:
41319         type: string
41320         description: Version
41321       model-description:
41322         type: string
41323         description: Description
41324       resource-version:
41325         type: string
41326         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41327       model-vers:
41328         type: object
41329         $ref: "#/definitions/model-vers"
41330       relationship-list:
41331         type: object
41332         $ref: "#/definitions/relationship-list"
41333   owning-entities:
41334     description: |
41335       Collection of owning-entities
41336     properties:
41337       owning-entity:
41338         type: array
41339         items:
41340           $ref: "#/definitions/owning-entity"
41341   owning-entity:
41342     description: |
41343       describes an owning-entity
41344       ###### Related Nodes
41345       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
41346
41347     required:
41348     - owning-entity-id
41349     - owning-entity-name
41350     properties:
41351       owning-entity-id:
41352         type: string
41353         description: UUID of an owning entity
41354       owning-entity-name:
41355         type: string
41356         description: Owning entity name
41357       resource-version:
41358         type: string
41359         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41360       relationship-list:
41361         type: array
41362         items:
41363           $ref: "#/definitions/relationship"
41364   p-interface:
41365     description: |
41366       Physical interface (e.g., nic)
41367       ###### Related Nodes
41368       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
41369       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
41370       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
41371       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
41372       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
41373       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
41374       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
41375
41376       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
41377       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
41378       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
41379     required:
41380     - interface-name
41381     properties:
41382       interface-name:
41383         type: string
41384         description: Name that identifies the physical interface
41385       speed-value:
41386         type: string
41387         description: Captures the numeric part of the speed
41388       speed-units:
41389         type: string
41390         description: Captures the units corresponding to the speed
41391       port-description:
41392         type: string
41393         description: Nature of the services and connectivity on this port.
41394       equipment-identifier:
41395         type: string
41396         description: CLEI or other specification for p-interface hardware.
41397       interface-role:
41398         type: string
41399         description: Role specification for p-interface hardware.
41400       interface-type:
41401         type: string
41402         description: Indicates the physical properties of the interface.
41403       resource-version:
41404         type: string
41405         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41406       relationship-list:
41407         type: array
41408         items:
41409           $ref: "#/definitions/relationship"
41410       l-interfaces:
41411         type: array
41412         items:
41413           $ref: "#/definitions/l-interface"
41414   p-interfaces:
41415     description: |
41416       Collection of physical interfaces.
41417     properties:
41418       p-interface:
41419         type: array
41420         items:
41421           $ref: "#/definitions/p-interface"
41422   physical-link:
41423     description: |
41424       Collection of physical connections, typically between p-interfaces
41425       ###### Related Nodes
41426       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
41427
41428       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
41429     required:
41430     - link-name
41431     properties:
41432       link-name:
41433         type: string
41434         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
41435       speed-value:
41436         type: string
41437         description: Captures the numeric part of the speed
41438       speed-units:
41439         type: string
41440         description: Captures the units corresponding to the speed
41441       circuit-id:
41442         type: string
41443         description: Circuit it
41444       dual-mode:
41445         type: string
41446         description: Dual access mode (e.g., primary, secondary
41447       management-option:
41448         type: string
41449         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
41450       service-provider-name:
41451         type: string
41452         description: Name of the service Provider on this link.
41453       resource-version:
41454         type: string
41455         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41456       relationship-list:
41457         type: array
41458         items:
41459           $ref: "#/definitions/relationship"
41460   physical-links:
41461     description: |
41462       Collection of physical connections, typically between p-interfaces
41463     properties:
41464       physical-link:
41465         type: array
41466         items:
41467           $ref: "#/definitions/physical-link"
41468   platform:
41469     description: |
41470       describes a platform
41471       ###### Related Nodes
41472       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
41473
41474     required:
41475     - platform-name
41476     properties:
41477       platform-name:
41478         type: string
41479         description: Name of the platform
41480       resource-version:
41481         type: string
41482         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41483       relationship-list:
41484         type: array
41485         items:
41486           $ref: "#/definitions/relationship"
41487   platforms:
41488     description: |
41489       Collection of platforms
41490     properties:
41491       platform:
41492         type: array
41493         items:
41494           $ref: "#/definitions/platform"
41495   pnf:
41496     description: |
41497       PNF represents a physical network function. typically equipment used in the D1 world.
41498       ###### Related Nodes
41499       - TO complex( pnf LocatedIn complex, MANY2ONE)
41500       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
41501       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
41502       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
41503
41504       -(1) IF this PNF node is deleted, this FROM node is DELETED also
41505     required:
41506     - pnf-name
41507     - in-maint
41508     properties:
41509       pnf-name:
41510         type: string
41511         description: unique name of Physical Network Function.
41512       pnf-name2:
41513         type: string
41514         description: name of Physical Network Function.
41515       pnf-name2-source:
41516         type: string
41517         description: source of name2
41518       pnf-id:
41519         type: string
41520         description: id of pnf
41521       equip-type:
41522         type: string
41523         description: Equipment type.  Source of truth should define valid values.
41524       equip-vendor:
41525         type: string
41526         description: Equipment vendor.  Source of truth should define valid values.
41527       equip-model:
41528         type: string
41529         description: Equipment model.  Source of truth should define valid values.
41530       management-option:
41531         type: string
41532         description: identifier of managed by company or customer
41533       ipaddress-v4-oam:
41534         type: string
41535         description: ipv4-oam-address with new naming convention for IP addresses
41536       sw-version:
41537         type: string
41538         description: sw-version is the version of SW for the hosted application on the PNF.
41539       orchestration-status:
41540         type: string
41541         description: orchestration-status is the status of orchestration on the PNF.
41542       in-maint:
41543         type: boolean
41544         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
41545       frame-id:
41546         type: string
41547         description: ID of the physical frame (relay rack) where pnf is installed.
41548       resource-version:
41549         type: string
41550         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41551       relationship-list:
41552         type: array
41553         items:
41554           $ref: "#/definitions/relationship"
41555       p-interfaces:
41556         type: array
41557         items:
41558           $ref: "#/definitions/p-interface"
41559       lag-interfaces:
41560         type: array
41561         items:
41562           $ref: "#/definitions/lag-interface"
41563   pnfs:
41564     description: |
41565       Collection of Physical Network Functions.
41566     properties:
41567       pnf:
41568         type: array
41569         items:
41570           $ref: "#/definitions/pnf"
41571   port-group:
41572     description: |
41573       Used to capture the network interfaces of this VCE
41574       ###### Related Nodes
41575       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
41576       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
41577
41578       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
41579       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
41580     required:
41581     - interface-id
41582     - orchestration-status
41583     properties:
41584       interface-id:
41585         type: string
41586         description: Unique ID of the interface
41587       neutron-network-id:
41588         type: string
41589         description: Neutron network id of this Interface
41590       neutron-network-name:
41591         type: string
41592         description: Neutron network name of this Interface
41593       interface-role:
41594         type: string
41595         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41596       resource-version:
41597         type: string
41598         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41599       port-group-id:
41600         type: string
41601         description: Unique ID for port group in vmware
41602       port-group-name:
41603         type: string
41604         description: Likely to duplicate value of neutron network name
41605       switch-name:
41606         type: string
41607         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
41608       orchestration-status:
41609         type: string
41610         description: Orchestration status of this VNF, mastered by MSO
41611       heat-stack-id:
41612         type: string
41613         description: Heat stack id corresponding to this instance, managed by MSO
41614       mso-catalog-key:
41615         type: string
41616         description: Corresponds to the SDN-C catalog id used to configure this VCE
41617       cvlan-tags:
41618         type: array
41619         items:
41620           $ref: "#/definitions/cvlan-tag-entry"
41621       relationship-list:
41622         type: array
41623         items:
41624           $ref: "#/definitions/relationship"
41625   port-groups:
41626     properties:
41627       port-group:
41628         type: array
41629         items:
41630           $ref: "#/definitions/port-group"
41631   project:
41632     description: |
41633       describes the project
41634       ###### Related Nodes
41635       - TO service-instance( project Uses service-instance, ONE2MANY)
41636
41637     required:
41638     - project-name
41639     properties:
41640       project-name:
41641         type: string
41642         description: Name of the project deploying a service
41643       resource-version:
41644         type: string
41645         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41646       relationship-list:
41647         type: array
41648         items:
41649           $ref: "#/definitions/relationship"
41650   projects:
41651     description: |
41652       Collection of projects
41653     properties:
41654       project:
41655         type: array
41656         items:
41657           $ref: "#/definitions/project"
41658   properties:
41659     description: |
41660       Property holder for query properties or instance properties
41661     properties:
41662       property-name:
41663         type: string
41664       property-value:
41665         type: string
41666   property-constraint:
41667     description: |
41668       TBD
41669       ###### Related Nodes
41670       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
41671
41672       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
41673     required:
41674     - property-constraint-uuid
41675     - constraint-type
41676     - property-name
41677     - property-value
41678     properties:
41679       property-constraint-uuid:
41680         type: string
41681       constraint-type:
41682         type: string
41683       property-name:
41684         type: string
41685       property-value:
41686         type: string
41687       resource-version:
41688         type: string
41689   property-constraints:
41690     properties:
41691       property-constraint:
41692         type: array
41693         items:
41694           $ref: "#/definitions/property-constraint"
41695   pserver:
41696     description: |
41697       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
41698       ###### Related Nodes
41699       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
41700       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
41701       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
41702       - TO complex( pserver LocatedIn complex, MANY2ONE)
41703       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
41704       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
41705       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
41706       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
41707       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
41708
41709       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
41710       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
41711
41712     required:
41713     - hostname
41714     - in-maint
41715     properties:
41716       hostname:
41717         type: string
41718         description: Value from executing hostname on the compute node.
41719       ptnii-equip-name:
41720         type: string
41721         description: PTNII name
41722       number-of-cpus:
41723         type: integer
41724         format: int32
41725         description: Number of cpus
41726       disk-in-gigabytes:
41727         type: integer
41728         format: int32
41729         description: Disk size, in GBs
41730       ram-in-megabytes:
41731         type: integer
41732         format: int32
41733         description: RAM size, in MBs
41734       equip-type:
41735         type: string
41736         description: Equipment type.  Source of truth should define valid values.
41737       equip-vendor:
41738         type: string
41739         description: Equipment vendor.  Source of truth should define valid values.
41740       equip-model:
41741         type: string
41742         description: Equipment model.  Source of truth should define valid values.
41743       fqdn:
41744         type: string
41745         description: Fully-qualified domain name
41746       pserver-selflink:
41747         type: string
41748         description: URL to endpoint where AAI can get more details
41749       ipv4-oam-address:
41750         type: string
41751         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
41752       serial-number:
41753         type: string
41754         description: Serial number, may be queried
41755       pserver-id:
41756         type: string
41757         description: ID of Pserver
41758       internet-topology:
41759         type: string
41760         description: internet topology of Pserver
41761       in-maint:
41762         type: boolean
41763         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
41764       resource-version:
41765         type: string
41766         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41767       pserver-name2:
41768         type: string
41769         description: alternative pserver name
41770       purpose:
41771         type: string
41772         description: purpose of pserver
41773       relationship-list:
41774         type: array
41775         items:
41776           $ref: "#/definitions/relationship"
41777       p-interfaces:
41778         type: array
41779         items:
41780           $ref: "#/definitions/p-interface"
41781       lag-interfaces:
41782         type: array
41783         items:
41784           $ref: "#/definitions/lag-interface"
41785   pservers:
41786     description: |
41787       Collection of compute hosts.
41788     properties:
41789       pserver:
41790         type: array
41791         items:
41792           $ref: "#/definitions/pserver"
41793   query-parameters:
41794     description: |
41795       QueryParameters for performing a named-query or model query
41796     properties:
41797       named-query:
41798         type: object
41799         $ref: "#/definitions/named-query"
41800       model:
41801         type: object
41802         $ref: "#/definitions/model"
41803   related-lookup:
41804     description: |
41805       TBD
41806       ###### Related Nodes
41807       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
41808
41809       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
41810     required:
41811     - related-lookup-uuid
41812     - source-node-type
41813     - source-node-property
41814     - target-node-type
41815     - target-node-property
41816     properties:
41817       related-lookup-uuid:
41818         type: string
41819       source-node-type:
41820         type: string
41821       source-node-property:
41822         type: string
41823       target-node-type:
41824         type: string
41825       target-node-property:
41826         type: string
41827       property-collect-list:
41828         type: string
41829       resource-version:
41830         type: string
41831       relationship-list:
41832         type: array
41833         items:
41834           $ref: "#/definitions/relationship"
41835   related-lookups:
41836     properties:
41837       related-lookup:
41838         type: array
41839         items:
41840           $ref: "#/definitions/related-lookup"
41841   related-to-property:
41842     properties:
41843       property-key:
41844         type: string
41845         description: Key part of a key/value pair
41846       property-value:
41847         type: string
41848         description: Value part of a key/value pair
41849   relationship:
41850     properties:
41851       related-to:
41852         type: string
41853         description: A keyword provided by A&AI to indicate type of node.
41854       related-link:
41855         type: string
41856         description: URL to the object in A&AI.
41857       relationship-data:
41858         type: array
41859         items:
41860           $ref: "#/definitions/relationship-data"
41861   relationship-data:
41862     required:
41863     - relationship-key
41864     - relationship-value
41865     properties:
41866       relationship-key:
41867         type: string
41868         description: A keyword provided by A&AI to indicate an attribute.
41869       relationship-value:
41870         type: string
41871         description: Value of the attribute.
41872   relationship-list:
41873     properties:
41874       relationship:
41875         type: array
41876         items:
41877           $ref: "#/definitions/relationship"
41878   reserved-prop-names:
41879     description: |
41880       Internal map to define some reserved properties of a vertex
41881     properties:
41882       last-mod-source-of-truth:
41883         type: string
41884       aai-node-type:
41885         type: string
41886       aai-created-ts:
41887         type: integer
41888         format: int64
41889       aai-unique-key:
41890         type: string
41891       aai-last-mod-ts:
41892         type: integer
41893         format: int64
41894       source-of-truth:
41895         type: string
41896   response-list:
41897     description: |
41898       Response container for the results of a named-query or model query
41899     properties:
41900       inventory-response-items:
41901         type: object
41902         $ref: "#/definitions/inventory-response-items"
41903   result-data:
41904     properties:
41905       resource-type:
41906         type: string
41907         description: The specific type of node in the A&AI graph
41908       resource-link:
41909         type: string
41910         description: The URL to the specific resource
41911   route-table-reference:
41912     description: |
41913       Openstack route table reference.
41914       ###### Related Nodes
41915       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
41916
41917     required:
41918     - route-table-reference-id
41919     - route-table-reference-fqdn
41920     properties:
41921       route-table-reference-id:
41922         type: string
41923         description: Route Table Reference id, UUID assigned to this instance.
41924       route-table-reference-fqdn:
41925         type: string
41926         description: FQDN entry in the route table.
41927       resource-version:
41928         type: string
41929         description: Concurrency value
41930       relationship-list:
41931         type: array
41932         items:
41933           $ref: "#/definitions/relationship"
41934   route-table-references:
41935     description: |
41936       Collection of openstack route table references
41937     properties:
41938       route-table-reference:
41939         type: array
41940         items:
41941           $ref: "#/definitions/route-table-reference"
41942   route-target:
41943     description: |
41944       Route target information
41945       ###### Related Nodes
41946       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
41947
41948       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
41949     required:
41950     - global-route-target
41951     - route-target-role
41952     properties:
41953       global-route-target:
41954         type: string
41955         description: Number used to identify an RT, globally unique in the network
41956       route-target-role:
41957         type: string
41958         description: Role assigned to this route target
41959       resource-version:
41960         type: string
41961         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41962       relationship-list:
41963         type: array
41964         items:
41965           $ref: "#/definitions/relationship"
41966   route-targets:
41967     description: |
41968       Collection of route target information
41969     properties:
41970       route-target:
41971         type: array
41972         items:
41973           $ref: "#/definitions/route-target"
41974   routing-instance:
41975     description: |
41976       ###### Related Nodes
41977       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
41978       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
41979
41980       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
41981       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
41982     required:
41983     - routing-instance-id
41984     properties:
41985       routing-instance-id:
41986         type: string
41987         description: Unique id of routing instance
41988       rpm-owner:
41989         type: string
41990         description: rpm owner
41991       resource-version:
41992         type: string
41993         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41994       site-pairs:
41995         type: array
41996         items:
41997           $ref: "#/definitions/site-pair"
41998       relationship-list:
41999         type: array
42000         items:
42001           $ref: "#/definitions/relationship"
42002   routing-instances:
42003     description: |
42004       set of probes related to generic-vnf routing instance
42005     properties:
42006       routing-instance:
42007         type: array
42008         items:
42009           $ref: "#/definitions/routing-instance"
42010   sdn-zone-response:
42011     properties:
42012       oam-networks:
42013         type: object
42014         $ref: "#/definitions/oam-networks"
42015       az-and-dvs-switches:
42016         type: array
42017         items:
42018           $ref: "#/definitions/az-and-dvs-switches"
42019   search:
42020     properties:
42021       edge-tag-query-result:
42022         type: object
42023         $ref: "#/definitions/edge-tag-query-result"
42024       edge-tag-query-request:
42025         type: object
42026         $ref: "#/definitions/edge-tag-query-request"
42027       search-results:
42028         type: object
42029         $ref: "#/definitions/search-results"
42030       sdn-zone-response:
42031         type: object
42032         $ref: "#/definitions/sdn-zone-response"
42033   search-results:
42034     properties:
42035       result-data:
42036         type: array
42037         items:
42038           $ref: "#/definitions/result-data"
42039   secondary-filt:
42040     description: |
42041       SecondaryFilt for performing a named-query or model query
42042   secondary-filter:
42043     properties:
42044       property-name:
42045         type: string
42046       filter-type:
42047         type: string
42048       property-value:
42049         type: string
42050   secondary-filts:
42051     description: |
42052       SecondaryFilts for performing a named-query or model query
42053     properties:
42054       secondary-filt:
42055         type: array
42056         items:
42057           $ref: "#/definitions/secondary-filt"
42058   segmentation-assignment:
42059     description: |
42060       Openstack segmentation assignment.
42061       ###### Related Nodes
42062       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
42063
42064       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
42065     required:
42066     - segmentation-id
42067     properties:
42068       segmentation-id:
42069         type: string
42070         description: Route Table Reference id, UUID assigned to this instance.
42071       resource-version:
42072         type: string
42073         description: Concurrency value
42074       relationship-list:
42075         type: array
42076         items:
42077           $ref: "#/definitions/relationship"
42078   segmentation-assignments:
42079     description: |
42080       Collection of openstack segmentation assignments
42081     properties:
42082       segmentation-assignment:
42083         type: array
42084         items:
42085           $ref: "#/definitions/segmentation-assignment"
42086   service:
42087     description: |
42088       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
42089     required:
42090     - service-id
42091     - service-description
42092     properties:
42093       service-id:
42094         type: string
42095         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
42096       service-description:
42097         type: string
42098         description: Description of the service
42099       service-selflink:
42100         type: string
42101         description: URL to endpoint where AAI can get more details
42102       resource-version:
42103         type: string
42104         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42105       service-version:
42106         type: string
42107         description: service version
42108       relationship-list:
42109         type: array
42110         items:
42111           $ref: "#/definitions/relationship"
42112   service-capabilities:
42113     description: |
42114       Collection of service capabilities.
42115     properties:
42116       service-capability:
42117         type: array
42118         items:
42119           $ref: "#/definitions/service-capability"
42120   service-capability:
42121     description: |
42122       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
42123       ###### Related Nodes
42124       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
42125       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
42126
42127       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
42128
42129     required:
42130     - service-type
42131     - vnf-type
42132     properties:
42133       service-type:
42134         type: string
42135         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
42136       vnf-type:
42137         type: string
42138         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
42139       resource-version:
42140         type: string
42141         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42142       relationship-list:
42143         type: array
42144         items:
42145           $ref: "#/definitions/relationship"
42146   service-design-and-creation:
42147     description: |
42148       Namespace for objects managed by ASDC
42149     properties:
42150       vnf-images:
42151         type: array
42152         items:
42153           $ref: "#/definitions/vnf-image"
42154       services:
42155         type: array
42156         items:
42157           $ref: "#/definitions/service"
42158       service-capabilities:
42159         type: array
42160         items:
42161           $ref: "#/definitions/service-capability"
42162       models:
42163         type: array
42164         items:
42165           $ref: "#/definitions/model"
42166       named-queries:
42167         type: array
42168         items:
42169           $ref: "#/definitions/named-query"
42170   service-instance:
42171     description: |
42172       Instance of a service
42173       ###### Related Nodes
42174       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
42175       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
42176       - TO connector( service-instance Uses connector, MANY2MANY)
42177       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
42178       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
42179       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
42180       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
42181       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
42182       - TO vce( service-instance ComposedOf vce, ONE2MANY)
42183       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
42184       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
42185
42186       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
42187       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
42188       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
42189     required:
42190     - service-instance-id
42191     properties:
42192       service-instance-id:
42193         type: string
42194         description: Uniquely identifies this instance of a service
42195       service-instance-name:
42196         type: string
42197         description: This field will store a name assigned to the service-instance.
42198       persona-model-id:
42199         type: string
42200         description: the ASDC model id for this resource or service model.
42201       persona-model-version:
42202         type: string
42203         description: the ASDC model version for this resource or service model.
42204       model-version-id:
42205         type: string
42206         description: the ASDC model version for this resource or service model.
42207       widget-model-id:
42208         type: string
42209         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42210       widget-model-version:
42211         type: string
42212         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42213       bandwidth-total:
42214         type: string
42215         description: Indicates the total bandwidth to be used for this service.
42216       bandwidth-up-wan1:
42217         type: string
42218         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
42219       bandwidth-down-wan1:
42220         type: string
42221         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
42222       bandwidth-up-wan2:
42223         type: string
42224         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
42225       bandwidth-down-wan2:
42226         type: string
42227         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
42228       vhn-portal-url:
42229         type: string
42230         description: URL customers will use to access the vHN Portal.
42231       service-instance-location-id:
42232         type: string
42233         description: An identifier that customers assign to the location where this service is being used.
42234       resource-version:
42235         type: string
42236         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42237       relationship-list:
42238         type: array
42239         items:
42240           $ref: "#/definitions/relationship"
42241       metadata:
42242         type: array
42243         items:
42244           $ref: "#/definitions/metadatum"
42245   service-instances:
42246     description: |
42247       Collection of service instances
42248     properties:
42249       service-instance:
42250         type: array
42251         items:
42252           $ref: "#/definitions/service-instance"
42253   service-subscription:
42254     description: |
42255       Object that group service instances.
42256       ###### Related Nodes
42257       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
42258       - TO tenant( service-subscription Uses tenant, MANY2MANY)
42259       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
42260
42261       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
42262       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
42263     required:
42264     - service-type
42265     properties:
42266       service-type:
42267         type: string
42268         description: Value defined by orchestration to identify this service across ECOMP.
42269       temp-ub-sub-account-id:
42270         type: string
42271         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
42272       resource-version:
42273         type: string
42274         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42275       service-instances:
42276         type: array
42277         items:
42278           $ref: "#/definitions/service-instance"
42279       relationship-list:
42280         type: array
42281         items:
42282           $ref: "#/definitions/relationship"
42283   service-subscriptions:
42284     description: |
42285       Collection of objects that group service instances.
42286     properties:
42287       service-subscription:
42288         type: array
42289         items:
42290           $ref: "#/definitions/service-subscription"
42291   services:
42292     description: |
42293       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
42294     properties:
42295       service:
42296         type: array
42297         items:
42298           $ref: "#/definitions/service"
42299   site-pair:
42300     description: |
42301       ###### Related Nodes
42302       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
42303       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
42304
42305       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
42306       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
42307     required:
42308     - site-pair-id
42309     properties:
42310       site-pair-id:
42311         type: string
42312         description: unique identifier of probe
42313       source-ip:
42314         type: string
42315         description: Prefix address
42316       destination-ip:
42317         type: string
42318         description: Prefix address
42319       ip-version:
42320         type: string
42321         description: ip version, v4, v6
42322       destination-hostname:
42323         type: string
42324         description: Hostname of the destination equipment to which SLAs are measured against.
42325       destination-equip-type:
42326         type: string
42327         description: The type of destinatination equipment. Could be Router, etc.
42328       resource-version:
42329         type: string
42330         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42331       classes-of-service:
42332         type: array
42333         items:
42334           $ref: "#/definitions/class-of-service"
42335       relationship-list:
42336         type: array
42337         items:
42338           $ref: "#/definitions/relationship"
42339   site-pair-set:
42340     description: |
42341       Set of instances for probes used to measure service level agreements
42342       ###### Related Nodes
42343       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42344       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
42345
42346       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
42347     required:
42348     - site-pair-set-id
42349     properties:
42350       site-pair-set-id:
42351         type: string
42352         description: Unique id of site pair set.
42353       resource-version:
42354         type: string
42355         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42356       routing-instances:
42357         type: array
42358         items:
42359           $ref: "#/definitions/routing-instance"
42360       relationship-list:
42361         type: array
42362         items:
42363           $ref: "#/definitions/relationship"
42364   site-pair-sets:
42365     description: |
42366       Collection of sets of instances for probes related to generic-vnf
42367     properties:
42368       site-pair-set:
42369         type: array
42370         items:
42371           $ref: "#/definitions/site-pair-set"
42372   site-pairs:
42373     description: |
42374       probe within a set
42375     properties:
42376       site-pair:
42377         type: array
42378         items:
42379           $ref: "#/definitions/site-pair"
42380   snapshot:
42381     description: |
42382       Openstack snapshot
42383       ###### Related Nodes
42384       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
42385       - FROM vserver( vserver Uses snapshot, ONE2ONE)
42386
42387     required:
42388     - snapshot-id
42389     properties:
42390       snapshot-id:
42391         type: string
42392         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
42393       snapshot-name:
42394         type: string
42395         description: Snapshot name
42396       snapshot-architecture:
42397         type: string
42398         description: Operating system architecture
42399       snapshot-os-distro:
42400         type: string
42401         description: The common name of the operating system distribution in lowercase
42402       snapshot-os-version:
42403         type: string
42404         description: The operating system version as specified by the distributor.
42405       application:
42406         type: string
42407         description: The application that the image instantiates.
42408       application-vendor:
42409         type: string
42410         description: The vendor of the application.
42411       application-version:
42412         type: string
42413         description: The version of the application.
42414       snapshot-selflink:
42415         type: string
42416         description: URL to endpoint where AAI can get more details
42417       prev-snapshot-id:
42418         type: string
42419         description: This field contains the UUID of the previous snapshot (if any).
42420       resource-version:
42421         type: string
42422         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42423       relationship-list:
42424         type: array
42425         items:
42426           $ref: "#/definitions/relationship"
42427   snapshots:
42428     description: |
42429       Collection of openstack snapshots
42430     properties:
42431       snapshot:
42432         type: array
42433         items:
42434           $ref: "#/definitions/snapshot"
42435   sriov-pf:
42436     description: |
42437       SR-IOV Physical Function
42438       ###### Related Nodes
42439       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
42440       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
42441
42442       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
42443     required:
42444     - pf-pci-id
42445     properties:
42446       pf-pci-id:
42447         type: string
42448         description: Identifier for the sriov-pf
42449       resource-version:
42450         type: string
42451         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42452       relationship-list:
42453         type: array
42454         items:
42455           $ref: "#/definitions/relationship"
42456   sriov-pfs:
42457     description: |
42458       Collection of SR-IOV Physical Functions.
42459     properties:
42460       sriov-pf:
42461         type: array
42462         items:
42463           $ref: "#/definitions/sriov-pf"
42464   sriov-vf:
42465     description: |
42466       SR-IOV Virtual Function (not to be confused with virtual network function)
42467       ###### Related Nodes
42468       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
42469
42470       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
42471     required:
42472     - pci-id
42473     properties:
42474       pci-id:
42475         type: string
42476         description: PCI ID used to identify the sriov-vf
42477       vf-vlan-filter:
42478         type: string
42479         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
42480       vf-mac-filter:
42481         type: string
42482         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
42483       vf-vlan-strip:
42484         type: boolean
42485         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
42486       vf-vlan-anti-spoof-check:
42487         type: boolean
42488         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.
42489       vf-mac-anti-spoof-check:
42490         type: boolean
42491         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.
42492       vf-mirrors:
42493         type: string
42494         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
42495       vf-broadcast-allow:
42496         type: boolean
42497         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
42498       vf-unknown-multicast-allow:
42499         type: boolean
42500         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
42501       vf-unknown-unicast-allow:
42502         type: boolean
42503         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
42504       vf-insert-stag:
42505         type: boolean
42506         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
42507       vf-link-status:
42508         type: string
42509         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
42510       resource-version:
42511         type: string
42512         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42513       neutron-network-id:
42514         type: string
42515         description: Neutron network id of the interface
42516       relationship-list:
42517         type: array
42518         items:
42519           $ref: "#/definitions/relationship"
42520   sriov-vfs:
42521     description: |
42522       Collection of SR-IOV Virtual Functions.
42523     properties:
42524       sriov-vf:
42525         type: array
42526         items:
42527           $ref: "#/definitions/sriov-vf"
42528   start-node-filter:
42529     properties:
42530       property-name:
42531         type: string
42532       property-value:
42533         type: string
42534   subnet:
42535     description: |
42536       ###### Related Nodes
42537       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
42538       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
42539       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
42540
42541       -(4) IF this TO node is deleted, this SUBNET is DELETED also
42542       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
42543
42544     required:
42545     - subnet-id
42546     - dhcp-enabled
42547     properties:
42548       subnet-id:
42549         type: string
42550         description: Subnet ID, should be UUID.
42551       subnet-name:
42552         type: string
42553         description: Name associated with the subnet.
42554       neutron-subnet-id:
42555         type: string
42556         description: Neutron id of this subnet
42557       gateway-address:
42558         type: string
42559         description: gateway ip address
42560       network-start-address:
42561         type: string
42562         description: network start address
42563       cidr-mask:
42564         type: string
42565         description: cidr mask
42566       ip-version:
42567         type: string
42568         description: ip version
42569       orchestration-status:
42570         type: string
42571         description: Orchestration status of this VNF, mastered by MSO
42572       dhcp-enabled:
42573         type: boolean
42574         description: dhcp enabled
42575       dhcp-start:
42576         type: string
42577         description: the start address reserved for use by dhcp
42578       dhcp-end:
42579         type: string
42580         description: the last address reserved for use by dhcp
42581       resource-version:
42582         type: string
42583         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42584       relationship-list:
42585         type: array
42586         items:
42587           $ref: "#/definitions/relationship"
42588   subnets:
42589     properties:
42590       subnet:
42591         type: array
42592         items:
42593           $ref: "#/definitions/subnet"
42594   tagged-inventory-item-list:
42595     properties:
42596       inventory-item:
42597         type: array
42598         items:
42599           $ref: "#/definitions/inventory-item"
42600   tenant:
42601     description: |
42602       Openstack tenant
42603       ###### Related Nodes
42604       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
42605       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
42606       - TO l3-network( tenant Uses l3-network, MANY2MANY)
42607       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
42608       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
42609       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
42610
42611       -TENANT cannot be deleted if related to VSERVER
42612
42613     required:
42614     - tenant-id
42615     - tenant-name
42616     properties:
42617       tenant-id:
42618         type: string
42619         description: Unique id relative to the cloud-region.
42620       tenant-name:
42621         type: string
42622         description: Readable name of tenant
42623       resource-version:
42624         type: string
42625         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42626       vservers:
42627         type: array
42628         items:
42629           $ref: "#/definitions/vserver"
42630       relationship-list:
42631         type: array
42632         items:
42633           $ref: "#/definitions/relationship"
42634   tenants:
42635     description: |
42636       Collection of openstack tenants.
42637     properties:
42638       tenant:
42639         type: array
42640         items:
42641           $ref: "#/definitions/tenant"
42642   tunnel-xconnect:
42643     description: |
42644       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
42645       ###### Related Nodes
42646       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
42647
42648       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
42649     required:
42650     - id
42651     - bandwidth-up-wan1
42652     - bandwidth-down-wan1
42653     - bandwidth-up-wan2
42654     - bandwidth-down-wan2
42655     properties:
42656       id:
42657         type: string
42658         description: Allotted Resource id UUID assigned to this instance.
42659       bandwidth-up-wan1:
42660         type: string
42661         description: The WAN uplink bandwidth for WAN1
42662       bandwidth-down-wan1:
42663         type: string
42664         description: The WAN downlink bandwidth for WAN1
42665       bandwidth-up-wan2:
42666         type: string
42667         description: The WAN uplink bandwidth for WAN2
42668       bandwidth-down-wan2:
42669         type: string
42670         description: The WAN downlink bandwidth for WAN2
42671       resource-version:
42672         type: string
42673         description: Concurrency value
42674       relationship-list:
42675         type: array
42676         items:
42677           $ref: "#/definitions/relationship"
42678   tunnel-xconnects:
42679     description: |
42680       This object is used to store the specific tunnel cross connect aspects of an allotted resource
42681     properties:
42682       tunnel-xconnect:
42683         type: array
42684         items:
42685           $ref: "#/definitions/tunnel-xconnect"
42686   update:
42687     description: |
42688       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
42689     required:
42690     - update-node-type
42691     properties:
42692       update-node-type:
42693         type: string
42694       update-node-key:
42695         type: array
42696         items:
42697           $ref: "#/definitions/update-node-key"
42698       update-node-uri:
42699         type: string
42700       action:
42701         type: array
42702         items:
42703           $ref: "#/definitions/action"
42704   update-node-key:
42705     properties:
42706       key-name:
42707         type: string
42708       key-value:
42709         type: string
42710   vce:
42711     description: |
42712       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
42713       ###### Related Nodes
42714       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
42715       - TO complex( vce LocatedIn complex, MANY2MANY)
42716       - TO vserver( vce HostedOn vserver, ONE2MANY)
42717       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
42718       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
42719
42720       -(1) IF this VCE node is deleted, this FROM node is DELETED also
42721     required:
42722     - vnf-id
42723     - vnf-name
42724     - vnf-type
42725     properties:
42726       vnf-id:
42727         type: string
42728         description: Unique id of VNF.  This is unique across the graph.
42729       vnf-name:
42730         type: string
42731         description: Name of VNF.
42732       vnf-name2:
42733         type: string
42734         description: Alternate name of VNF.
42735       vnf-type:
42736         type: string
42737         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
42738       service-id:
42739         type: string
42740         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
42741       regional-resource-zone:
42742         type: string
42743         description: Regional way of organizing pservers, source of truth should define values
42744       prov-status:
42745         type: string
42746         description: Trigger for operational monitoring of this resource by Service Assurance systems.
42747       operational-state:
42748         type: string
42749         description: Indicator for whether the resource is considered operational
42750       license-key:
42751         type: string
42752         description: License key
42753       equipment-role:
42754         type: string
42755         description: Network role being played by this VNF
42756       orchestration-status:
42757         type: string
42758         description: Orchestration status of this VNF, mastered by MSO
42759       heat-stack-id:
42760         type: string
42761         description: Heat stack id corresponding to this instance, managed by MSO
42762       mso-catalog-key:
42763         type: string
42764         description: Corresponds to the SDN-C catalog id used to configure this VCE
42765       vpe-id:
42766         type: string
42767         description: Unique ID of VPE connected to this VCE.
42768       v6-vce-wan-address:
42769         type: string
42770         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
42771       ipv4-oam-address:
42772         type: string
42773         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
42774       resource-version:
42775         type: string
42776         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42777       ipv4-loopback0-address:
42778         type: string
42779         description: Loopback0 address
42780       entitlement-resource-uuid:
42781         type: string
42782         description: Entitlement resource uuid
42783       port-groups:
42784         type: array
42785         items:
42786           $ref: "#/definitions/port-group"
42787       relationship-list:
42788         type: array
42789         items:
42790           $ref: "#/definitions/relationship"
42791   vces:
42792     description: |
42793       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
42794     properties:
42795       vce:
42796         type: array
42797         items:
42798           $ref: "#/definitions/vce"
42799   vf-module:
42800     description: |
42801       a deployment unit of VNFCs
42802       ###### Related Nodes
42803       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
42804       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
42805       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
42806       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
42807       - TO vserver( vf-module Uses vserver, ONE2MANY)
42808
42809       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
42810       -VF-MODULE cannot be deleted if related to VNFC
42811
42812     required:
42813     - vf-module-id
42814     - is-base-vf-module
42815     properties:
42816       vf-module-id:
42817         type: string
42818         description: Unique ID of vf-module.
42819       vf-module-name:
42820         type: string
42821         description: Name of vf-module
42822       heat-stack-id:
42823         type: string
42824         description: Heat stack id corresponding to this instance.
42825       orchestration-status:
42826         type: string
42827         description: orchestration status of this vf-module, mastered by MSO
42828       is-base-vf-module:
42829         type: boolean
42830         description: used to indicate whether or not this object is base vf module
42831       resource-version:
42832         type: string
42833         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42834       persona-model-id:
42835         type: string
42836         description: the ASDC model id for this resource or service model.
42837       persona-model-version:
42838         type: string
42839         description: the ASDC model version for this resource or service model.
42840       model-version-id:
42841         type: string
42842         description: the ASDC model version for this resource or service model.
42843       widget-model-id:
42844         type: string
42845         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42846       widget-model-version:
42847         type: string
42848         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42849       contrail-service-instance-fqdn:
42850         type: string
42851         description: the Contrail unique ID for a service-instance
42852       relationship-list:
42853         type: array
42854         items:
42855           $ref: "#/definitions/relationship"
42856   vf-modules:
42857     description: |
42858       Collection of vf-modules, a deployment unit of VNFCs
42859     properties:
42860       vf-module:
42861         type: array
42862         items:
42863           $ref: "#/definitions/vf-module"
42864   vig-server:
42865     description: |
42866       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
42867       ###### Related Nodes
42868       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
42869
42870       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
42871     required:
42872     - vig-address-type
42873     properties:
42874       vig-address-type:
42875         type: string
42876         description: indicates whether the VIG is for AVPN or INTERNET
42877       ipaddress-v4-vig:
42878         type: string
42879         description: v4 IP of the vig server
42880       ipaddress-v6-vig:
42881         type: string
42882         description: v6 IP of the vig server
42883       resource-version:
42884         type: string
42885         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42886       relationship-list:
42887         type: array
42888         items:
42889           $ref: "#/definitions/relationship"
42890   vig-servers:
42891     properties:
42892       vig-server:
42893         type: array
42894         items:
42895           $ref: "#/definitions/vig-server"
42896   vip-ipv4-address-list:
42897     description: |
42898       IPv4 Address Range
42899       ###### Related Nodes
42900       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
42901       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
42902       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
42903       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
42904
42905     required:
42906     - vip-ipv4-address
42907     properties:
42908       vip-ipv4-address:
42909         type: string
42910         description: IP address
42911       vip-ipv4-prefix-length:
42912         type: integer
42913         format: int64
42914         description: Prefix length, 32 for single address
42915       vlan-id-inner:
42916         type: integer
42917         format: int64
42918         description: Inner VLAN tag
42919       vlan-id-outer:
42920         type: integer
42921         format: int64
42922         description: Outer VLAN tag
42923       is-floating:
42924         type: boolean
42925         description: Indicator of fixed or floating address
42926       resource-version:
42927         type: string
42928         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42929       neutron-network-id:
42930         type: string
42931         description: Neutron network id of the interface that address belongs to
42932       neutron-subnet-id:
42933         type: string
42934         description: Neutron id of subnet that address belongs to
42935       relationship-list:
42936         type: array
42937         items:
42938           $ref: "#/definitions/relationship"
42939   vip-ipv6-address-list:
42940     description: |
42941       IPv6 Address Range
42942       ###### Related Nodes
42943       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
42944       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
42945       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
42946       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
42947
42948     required:
42949     - vip-ipv6-address
42950     properties:
42951       vip-ipv6-address:
42952         type: string
42953         description: IP address
42954       vip-ipv6-prefix-length:
42955         type: integer
42956         format: int64
42957         description: Prefix length, 128 for single address
42958       vlan-id-inner:
42959         type: integer
42960         format: int64
42961         description: Inner VLAN tag
42962       vlan-id-outer:
42963         type: integer
42964         format: int64
42965         description: Outer VLAN tag
42966       is-floating:
42967         type: boolean
42968         description: Indicator of fixed or floating address
42969       resource-version:
42970         type: string
42971         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42972       neutron-network-id:
42973         type: string
42974         description: Neutron network id of the interface that address belongs to
42975       neutron-subnet-id:
42976         type: string
42977         description: Neutron id of subnet that address belongs to
42978       relationship-list:
42979         type: array
42980         items:
42981           $ref: "#/definitions/relationship"
42982   virtual-data-center:
42983     description: |
42984       Virtual organization of cloud infrastructure elements in a data center context
42985       ###### Related Nodes
42986       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
42987       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42988       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
42989
42990     required:
42991     - vdc-id
42992     - vdc-name
42993     properties:
42994       vdc-id:
42995         type: string
42996         description: Unique ID of the vdc
42997       vdc-name:
42998         type: string
42999         description: Name of the virtual data center
43000       resource-version:
43001         type: string
43002         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43003       relationship-list:
43004         type: array
43005         items:
43006           $ref: "#/definitions/relationship"
43007   virtual-data-centers:
43008     description: |
43009       Virtual organization of cloud infrastructure elements in a data center context
43010     properties:
43011       virtual-data-center:
43012         type: array
43013         items:
43014           $ref: "#/definitions/virtual-data-center"
43015   vlan:
43016     description: |
43017       Definition of vlan
43018       ###### Related Nodes
43019       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
43020       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
43021       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
43022       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
43023       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
43024       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
43025
43026       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
43027       -(2) IF this VLAN node is deleted, this TO node is DELETED also
43028       -(4) IF this TO node is deleted, this VLAN is DELETED also
43029     required:
43030     - vlan-interface
43031     properties:
43032       vlan-interface:
43033         type: string
43034         description: String that identifies the interface
43035       vlan-id-inner:
43036         type: integer
43037         format: int64
43038         description: Inner VLAN tag
43039       vlan-id-outer:
43040         type: integer
43041         format: int64
43042         description: Outer VLAN tag
43043       resource-version:
43044         type: string
43045         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43046       speed-value:
43047         type: string
43048         description: Captures the numeric part of the speed
43049       speed-units:
43050         type: string
43051         description: Captures the units corresponding to the speed
43052       vlan-description:
43053         type: string
43054         description: Used to describe (the service associated with) the vlan
43055       backdoor-connection:
43056         type: string
43057         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
43058       vpn-id:
43059         type: string
43060         description: This indicates the customers VPN ID associated with this vlan
43061       relationship-list:
43062         type: array
43063         items:
43064           $ref: "#/definitions/relationship"
43065       l3-interface-ipv4-address-list:
43066         type: array
43067         items:
43068           $ref: "#/definitions/l3-interface-ipv4-address-list"
43069       l3-interface-ipv6-address-list:
43070         type: array
43071         items:
43072           $ref: "#/definitions/l3-interface-ipv6-address-list"
43073   vlans:
43074     properties:
43075       vlan:
43076         type: array
43077         items:
43078           $ref: "#/definitions/vlan"
43079   vnf:
43080     description: |
43081       Abstract vnf class
43082     required:
43083     - vnf-id
43084     properties:
43085       vnf-id:
43086         type: string
43087         description: Unique id of VNF.  This is unique across the graph.
43088   vnf-image:
43089     description: |
43090       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
43091       ###### Related Nodes
43092       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
43093
43094       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
43095
43096     required:
43097     - vnf-image-uuid
43098     - application
43099     - application-vendor
43100     properties:
43101       vnf-image-uuid:
43102         type: string
43103         description: Unique ID of this asset
43104       application:
43105         type: string
43106         description: The application that the image instantiates.
43107       application-vendor:
43108         type: string
43109         description: The vendor of the application.
43110       application-version:
43111         type: string
43112         description: The version of the application.
43113       selflink:
43114         type: string
43115         description: URL to endpoint where AAI can get more details
43116       resource-version:
43117         type: string
43118         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43119       relationship-list:
43120         type: array
43121         items:
43122           $ref: "#/definitions/relationship"
43123   vnf-images:
43124     description: |
43125       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
43126     properties:
43127       vnf-image:
43128         type: array
43129         items:
43130           $ref: "#/definitions/vnf-image"
43131   vnfc:
43132     description: |
43133       ###### Related Nodes
43134       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
43135       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
43136       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
43137
43138       -(4) IF this TO node is deleted, this VNFC is DELETED also
43139     required:
43140     - vnfc-name
43141     - vnfc-function-code
43142     - vnfc-type
43143     - in-maint
43144     - is-closed-loop-disabled
43145     properties:
43146       vnfc-name:
43147         type: string
43148         description: Unique ID of vnfc.
43149       vnfc-function-code:
43150         type: string
43151         description: function code
43152       vnfc-type:
43153         type: string
43154         description: type
43155       prov-status:
43156         type: string
43157         description: prov status of this vnfc
43158       orchestration-status:
43159         type: string
43160         description: Orchestration status of this VNF, mastered by APP-C
43161       ipaddress-v4-oam-vip:
43162         type: string
43163         description: Oam V4 vip address of this vnfc
43164       in-maint:
43165         type: boolean
43166         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43167       is-closed-loop-disabled:
43168         type: boolean
43169         description: used to indicate whether closed loop function is enabled on this node
43170       group-notation:
43171         type: string
43172         description: Group notation of VNFC
43173       resource-version:
43174         type: string
43175         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43176       relationship-list:
43177         type: array
43178         items:
43179           $ref: "#/definitions/relationship"
43180   vnfcs:
43181     description: |
43182       virtual network components associated with a vserver from application controller.
43183     properties:
43184       vnfc:
43185         type: array
43186         items:
43187           $ref: "#/definitions/vnfc"
43188   volume:
43189     description: |
43190       Ephemeral Block storage volume.
43191       ###### Related Nodes
43192       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
43193
43194       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
43195     required:
43196     - volume-id
43197     - volume-selflink
43198     properties:
43199       volume-id:
43200         type: string
43201         description: Unique ID of block storage volume relative to the vserver.
43202       volume-selflink:
43203         type: string
43204         description: URL to endpoint where AAI can get more details
43205       resource-version:
43206         type: string
43207         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43208       relationship-list:
43209         type: array
43210         items:
43211           $ref: "#/definitions/relationship"
43212   volume-group:
43213     description: |
43214       Persistent block-level storage.
43215       ###### Related Nodes
43216       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
43217       - TO complex( volume-group LocatedIn complex, MANY2ONE)
43218       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
43219       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
43220       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
43221
43222     required:
43223     - volume-group-id
43224     - volume-group-name
43225     - vnf-type
43226     properties:
43227       volume-group-id:
43228         type: string
43229         description: Unique ID of volume-group.
43230       volume-group-name:
43231         type: string
43232         description: Name of the volume group.
43233       heat-stack-id:
43234         type: string
43235         description: Heat stack id corresponding to this volume-group
43236       vnf-type:
43237         type: string
43238         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
43239       orchestration-status:
43240         type: string
43241         description: Orchestration status of this volume-group
43242       resource-version:
43243         type: string
43244         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43245       relationship-list:
43246         type: array
43247         items:
43248           $ref: "#/definitions/relationship"
43249   volume-groups:
43250     description: |
43251       Collection of persistent block-level storage.
43252     properties:
43253       volume-group:
43254         type: array
43255         items:
43256           $ref: "#/definitions/volume-group"
43257   volumes:
43258     description: |
43259       Collection of ephemeral Block storage volumes.
43260     properties:
43261       volume:
43262         type: array
43263         items:
43264           $ref: "#/definitions/volume"
43265   vpls-pe:
43266     description: |
43267       VPLS Provider Edge routers.
43268       ###### Related Nodes
43269       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
43270       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
43271       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
43272       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
43273
43274       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
43275     required:
43276     - equipment-name
43277     properties:
43278       equipment-name:
43279         type: string
43280       prov-status:
43281         type: string
43282         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43283       ipv4-oam-address:
43284         type: string
43285         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).
43286       equipment-role:
43287         type: string
43288         description: Client should send valid enumerated value, e.g., VPLS-PE.
43289       vlan-id-outer:
43290         type: integer
43291         format: int64
43292         description: Temporary location for stag to get to VCE
43293       resource-version:
43294         type: string
43295         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43296       relationship-list:
43297         type: array
43298         items:
43299           $ref: "#/definitions/relationship"
43300       p-interfaces:
43301         type: array
43302         items:
43303           $ref: "#/definitions/p-interface"
43304       lag-interfaces:
43305         type: array
43306         items:
43307           $ref: "#/definitions/lag-interface"
43308   vpls-pes:
43309     description: |
43310       Collection of VPLS Provider Edge routers
43311     properties:
43312       vpls-pe:
43313         type: array
43314         items:
43315           $ref: "#/definitions/vpls-pe"
43316   vpn-binding:
43317     description: |
43318       VPN binding
43319       ###### Related Nodes
43320       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
43321
43322       -VPN-BINDING cannot be deleted if related to L3-NETWORK
43323
43324     required:
43325     - vpn-id
43326     - vpn-name
43327     - global-route-target
43328     properties:
43329       vpn-id:
43330         type: string
43331         description: VPN ID, globally unique within A&AI
43332       vpn-name:
43333         type: string
43334         description: VPN Name
43335       global-route-target:
43336         type: string
43337         description: Number used to identify a VPN, globally unique in the network
43338       vpn-platform:
43339         type: string
43340         description: the platform associated with the VPN example AVPN, Mobility
43341       resource-version:
43342         type: string
43343         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43344       relationship-list:
43345         type: array
43346         items:
43347           $ref: "#/definitions/relationship"
43348         description: l3-networks relate to vpn-bindings
43349   vpn-bindings:
43350     properties:
43351       vpn-binding:
43352         type: array
43353         items:
43354           $ref: "#/definitions/vpn-binding"
43355   vserver:
43356     description: |
43357       Virtual Servers, aka virtual machine or VM.
43358       ###### Related Nodes
43359       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
43360       - TO flavor( vserver Uses flavor, MANY2ONE)
43361       - TO image( vserver Uses image, MANY2ONE)
43362       - TO pserver( vserver HostedOn pserver, MANY2ONE)
43363       - TO snapshot( vserver Uses snapshot, ONE2ONE)
43364       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
43365       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
43366       - FROM vce( vce HostedOn vserver, ONE2MANY)
43367       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
43368       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
43369       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
43370
43371       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
43372       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
43373     required:
43374     - vserver-id
43375     - vserver-name
43376     - vserver-selflink
43377     - in-maint
43378     - is-closed-loop-disabled
43379     properties:
43380       vserver-id:
43381         type: string
43382         description: Unique identifier for this vserver relative to its tenant
43383       vserver-name:
43384         type: string
43385         description: Name of vserver
43386       vserver-name2:
43387         type: string
43388         description: Alternative name of vserver
43389       prov-status:
43390         type: string
43391         description: Trigger for operational monitoring of this resource by Service Assurance systems.
43392       vserver-selflink:
43393         type: string
43394         description: URL to endpoint where AAI can get more details
43395       in-maint:
43396         type: boolean
43397         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
43398       is-closed-loop-disabled:
43399         type: boolean
43400         description: Used to indicate whether closed loop function is enabled on this node
43401       resource-version:
43402         type: string
43403         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43404       volumes:
43405         type: array
43406         items:
43407           $ref: "#/definitions/volume"
43408       relationship-list:
43409         type: array
43410         items:
43411           $ref: "#/definitions/relationship"
43412       l-interfaces:
43413         type: array
43414         items:
43415           $ref: "#/definitions/l-interface"
43416   vservers:
43417     description: |
43418       Collection of virtual Servers, aka virtual machines or VMs.
43419     properties:
43420       vserver:
43421         type: array
43422         items:
43423           $ref: "#/definitions/vserver"
43424   zone:
43425     description: |
43426       A zone is a grouping of assets in a location homing to the same connections into the CBB
43427       ###### Related Nodes
43428       - TO complex( zone LocatedIn complex, MANY2ONE)
43429       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
43430       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
43431       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
43432
43433     required:
43434     - zone-id
43435     - zone-name
43436     - design-type
43437     - zone-context
43438     properties:
43439       zone-id:
43440         type: string
43441         description: Code assigned by AIC to the zone
43442       zone-name:
43443         type: string
43444         description: English name associated with the zone
43445       design-type:
43446         type: string
43447         description: Design of zone [Medium/Large?]
43448       zone-context:
43449         type: string
43450         description: Context of zone [production/test]
43451       status:
43452         type: string
43453         description: Status of a zone.
43454       resource-version:
43455         type: string
43456         description: Concurrency value
43457       relationship-list:
43458         type: array
43459         items:
43460           $ref: "#/definitions/relationship"
43461   zones:
43462     description: |
43463       Collection of zones
43464     properties:
43465       zone:
43466         type: array
43467         items:
43468           $ref: "#/definitions/zone"
43469 patchDefinitions:
43470   action:
43471     properties:
43472       action-type:
43473         type: string
43474       action-data:
43475         type: array
43476         items:
43477           $ref: "#/patchDefinitions/action-data"
43478   action-data:
43479     properties:
43480       property-name:
43481         type: string
43482       property-value:
43483         type: string
43484   actions:
43485     description: |
43486       APIs that are more action related than REST (e.g., notify, update).
43487     properties:
43488       update:
43489         type: object
43490         $ref: "#/patchDefinitions/update"
43491       notify:
43492         type: object
43493         $ref: "#/patchDefinitions/notify"
43494   allotted-resource:
43495     description: |
43496       Represents a slice or partial piece of a resource that gets separately allotted
43497       ###### Related Nodes
43498       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
43499       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
43500       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
43501       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
43502       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
43503       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
43504       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
43505
43506       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
43507       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
43508     required:
43509     - id
43510     properties:
43511       id:
43512         type: string
43513         description: Allotted Resource id UUID assigned to this instance.
43514       description:
43515         type: string
43516         description: The descriptive information assigned to this allotted resource instance
43517       selflink:
43518         type: string
43519         description: Link back to more information in the controller
43520       persona-model-id:
43521         type: string
43522         description: the ASDC model id for this resource or service model.
43523       persona-model-version:
43524         type: string
43525         description: the ASDC model version for this resource or service model.
43526       model-version-id:
43527         type: string
43528         description: the ASDC model version for this resource or service model.
43529       persona-model-customization-id:
43530         type: string
43531         description: captures the id of all the configuration used to customize the resource for the service.
43532   allotted-resources:
43533     description: |
43534       This object is used to store slices of services being offered
43535     properties:
43536       allotted-resource:
43537         type: array
43538         items:
43539           $ref: "#/patchDefinitions/allotted-resource"
43540   availability-zone:
43541     description: |
43542       Availability zone, a collection of compute hosts/pservers
43543       ###### Related Nodes
43544       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
43545       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
43546       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
43547       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
43548       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
43549       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
43550       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
43551       - FROM vce( vce Uses availability-zone, MANY2MANY)
43552
43553       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
43554       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
43555
43556     required:
43557     - availability-zone-name
43558     - hypervisor-type
43559     properties:
43560       availability-zone-name:
43561         type: string
43562         description: Name of the availability zone.  Unique across a cloud region
43563       hypervisor-type:
43564         type: string
43565         description: Type of hypervisor.  Source of truth should define valid values.
43566       operational-state:
43567         type: string
43568         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
43569   availability-zones:
43570     description: |
43571       Collection of availability zones
43572     properties:
43573       availability-zone:
43574         type: array
43575         items:
43576           $ref: "#/patchDefinitions/availability-zone"
43577   az-and-dvs-switches:
43578     properties:
43579       dvs-switches:
43580         type: object
43581         $ref: "#/patchDefinitions/dvs-switches"
43582       availability-zone:
43583         type: object
43584         $ref: "#/patchDefinitions/availability-zone"
43585   business:
43586     description: |
43587       Namespace for business related constructs
43588     properties:
43589       connectors:
43590         type: array
43591         items:
43592           $ref: "#/patchDefinitions/connector"
43593       customers:
43594         type: array
43595         items:
43596           $ref: "#/patchDefinitions/customer"
43597   class-of-service:
43598     description: |
43599       ###### Related Nodes
43600       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
43601
43602       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
43603     required:
43604     - cos
43605     properties:
43606       cos:
43607         type: string
43608         description: unique identifier of probe
43609       probe-id:
43610         type: string
43611         description: identifier of probe
43612       probe-type:
43613         type: string
43614         description: type of probe
43615   classes-of-service:
43616     description: |
43617       class-of-service of probe
43618     properties:
43619       class-of-service:
43620         type: array
43621         items:
43622           $ref: "#/patchDefinitions/class-of-service"
43623   cloud-infrastructure:
43624     description: |
43625       Namespace for cloud infrastructure.
43626     properties:
43627       complexes:
43628         type: array
43629         items:
43630           $ref: "#/patchDefinitions/complex"
43631       cloud-regions:
43632         type: array
43633         items:
43634           $ref: "#/patchDefinitions/cloud-region"
43635       network-profiles:
43636         type: array
43637         items:
43638           $ref: "#/patchDefinitions/network-profile"
43639       pservers:
43640         type: array
43641         items:
43642           $ref: "#/patchDefinitions/pserver"
43643       virtual-data-centers:
43644         type: array
43645         items:
43646           $ref: "#/patchDefinitions/virtual-data-center"
43647   cloud-region:
43648     description: |
43649       cloud-region designates an installation of a cloud cluster or region or instantiation.
43650       ###### Related Nodes
43651       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
43652       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
43653       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
43654       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
43655       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
43656       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
43657       - FROM image( image BelongsTo cloud-region, MANY2ONE)
43658       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
43659       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
43660       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
43661       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
43662       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
43663
43664       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
43665       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
43666
43667     required:
43668     - cloud-owner
43669     - cloud-region-id
43670     properties:
43671       cloud-owner:
43672         type: string
43673         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
43674       cloud-region-id:
43675         type: string
43676         description: Identifier used by the vendor for the region. Second part of composite key
43677       cloud-type:
43678         type: string
43679         description: Type of the cloud (e.g., openstack)
43680       owner-defined-type:
43681         type: string
43682         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
43683       cloud-region-version:
43684         type: string
43685         description: Software version employed at the site
43686       identity-url:
43687         type: string
43688         description: URL of the keystone identity service
43689       cloud-zone:
43690         type: string
43691         description: Zone where the cloud is homed
43692       complex-name:
43693         type: string
43694         description: complex name for cloud-region instance
43695   cloud-regions:
43696     properties:
43697       cloud-region:
43698         type: array
43699         items:
43700           $ref: "#/patchDefinitions/cloud-region"
43701   complex:
43702     description: |
43703       Collection of physical locations that can house cloud-regions.
43704       ###### Related Nodes
43705       - TO l3-network( complex Uses l3-network, MANY2MANY)
43706       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
43707       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
43708       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
43709       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
43710       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
43711       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
43712       - FROM vce( vce LocatedIn complex, MANY2MANY)
43713       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
43714       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
43715
43716       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
43717       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
43718
43719     required:
43720     - physical-location-id
43721     - physical-location-type
43722     - street1
43723     - city
43724     - postal-code
43725     - country
43726     - region
43727     properties:
43728       physical-location-id:
43729         type: string
43730         description: Unique identifier for physical location, e.g., CLLI
43731       data-center-code:
43732         type: string
43733         description: Data center code which can be an alternate way to identify a complex
43734       complex-name:
43735         type: string
43736         description: Gamma complex name for LCP instance.
43737       identity-url:
43738         type: string
43739         description: URL of the keystone identity service
43740   complexes:
43741     description: |
43742       Collection of physical locations that can house cloud-regions.
43743     properties:
43744       complex:
43745         type: array
43746         items:
43747           $ref: "#/patchDefinitions/complex"
43748   configuration:
43749     description: |
43750       Port Mirror Configuration.
43751       ###### Related Nodes
43752       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
43753       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
43754       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
43755       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
43756       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
43757
43758       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
43759       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
43760       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
43761     required:
43762     - configuration-id
43763     - configuration-type
43764     - configuration-sub-type
43765     - orchestration-status
43766     - operational-status
43767     - configuration-selflink
43768     - model-customization-id
43769     properties:
43770       configuration-id:
43771         type: string
43772         description: UUID assigned to configuration.
43773       management-option:
43774         type: string
43775         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
43776       configuration-name:
43777         type: string
43778         description: Name of the configuration.
43779       configuration-type:
43780         type: string
43781         description: port-mirroring-configuration.
43782       configuration-sub-type:
43783         type: string
43784         description: vprobe, pprobe.
43785       model-invariant-id:
43786         type: string
43787         description: the ASDC model id for this resource or service model.
43788       model-version-id:
43789         type: string
43790         description: the ASDC model version for this resource or service model.
43791       orchestration-status:
43792         type: string
43793         description: Orchestration status of the configuration.
43794       operational-status:
43795         type: string
43796         description: Indicator for whether the resource is considered operational.
43797       configuration-selflink:
43798         type: string
43799         description: URL to endpoint where AAI can get more details from SDN-GC.
43800       model-customization-id:
43801         type: string
43802         description: id of  the configuration used to customize the resource
43803   configurations:
43804     description: |
43805       Collection of configurations
43806     properties:
43807       configuration:
43808         type: array
43809         items:
43810           $ref: "#/patchDefinitions/configuration"
43811   connector:
43812     description: |
43813       Collection of resource instances used to connect a variety of disparate inventory widgets
43814       ###### Related Nodes
43815       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
43816       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
43817       - FROM service-instance( service-instance Uses connector, MANY2MANY)
43818
43819       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
43820     required:
43821     - resource-instance-id
43822     properties:
43823       resource-instance-id:
43824         type: string
43825         description: Unique id of resource instance.
43826   connectors:
43827     description: |
43828       Collection of resource instances used to connect a variety of disparate inventory widgets
43829     properties:
43830       connector:
43831         type: array
43832         items:
43833           $ref: "#/patchDefinitions/connector"
43834   constrained-element-set:
43835     description: |
43836       This is how we would capture constraints defining allowed sets of elements.
43837       ###### Related Nodes
43838       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
43839       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
43840       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
43841
43842       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
43843       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
43844     required:
43845     - constrained-element-set-uuid
43846     - constraint-type
43847     - check-type
43848     properties:
43849       constrained-element-set-uuid:
43850         type: string
43851       constraint-type:
43852         type: string
43853       check-type:
43854         type: string
43855   constrained-element-sets:
43856     properties:
43857       constrained-element-set:
43858         type: array
43859         items:
43860           $ref: "#/patchDefinitions/constrained-element-set"
43861   ctag-assignment:
43862     description: |
43863       ###### Related Nodes
43864       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
43865
43866       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
43867     required:
43868     - vlan-id-inner
43869     properties:
43870       vlan-id-inner:
43871         type: integer
43872         format: int64
43873         description: id.
43874   ctag-assignments:
43875     properties:
43876       ctag-assignment:
43877         type: array
43878         items:
43879           $ref: "#/patchDefinitions/ctag-assignment"
43880   ctag-pool:
43881     description: |
43882       A collection of C tags (vlan tags) grouped for a specific purpose.
43883       ###### Related Nodes
43884       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
43885       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
43886       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
43887
43888       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
43889     required:
43890     - target-pe
43891     - availability-zone-name
43892     - ctag-pool-purpose
43893     properties:
43894       target-pe:
43895         type: string
43896         description: The Target provider edge router
43897       availability-zone-name:
43898         type: string
43899         description: Name of the availability zone
43900       ctag-pool-purpose:
43901         type: string
43902         description: Describes what the intended purpose of this pool is.
43903       ctag-values:
43904         type: string
43905         description: Comma separated list of ctags
43906   ctag-pools:
43907     properties:
43908       ctag-pool:
43909         type: array
43910         items:
43911           $ref: "#/patchDefinitions/ctag-pool"
43912   customer:
43913     description: |
43914       customer identifiers to provide linkage back to BSS information.
43915       ###### Related Nodes
43916       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
43917
43918       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
43919     required:
43920     - global-customer-id
43921     - subscriber-name
43922     - subscriber-type
43923     properties:
43924       global-customer-id:
43925         type: string
43926         description: Global customer id used across ECOMP to uniquely identify customer.
43927       subscriber-name:
43928         type: string
43929         description: Subscriber name, an alternate way to retrieve a customer.
43930       subscriber-type:
43931         type: string
43932         description: Subscriber type, a way to provide VID with only the INFRA customers.
43933   customers:
43934     description: |
43935       Collection of customer identifiers to provide linkage back to BSS information.
43936     properties:
43937       customer:
43938         type: array
43939         items:
43940           $ref: "#/patchDefinitions/customer"
43941   cvlan-tag-entry:
43942     required:
43943     - cvlan-tag
43944     properties:
43945       cvlan-tag:
43946         type: integer
43947         format: int64
43948         description: See mis-na-virtualization-platform.yang
43949   cvlan-tags:
43950     properties:
43951       cvlan-tag-entry:
43952         type: array
43953         items:
43954           $ref: "#/patchDefinitions/cvlan-tag-entry"
43955   dvs-switch:
43956     description: |
43957       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.
43958       ###### Related Nodes
43959       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
43960       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
43961
43962     required:
43963     - switch-name
43964     - vcenter-url
43965     properties:
43966       switch-name:
43967         type: string
43968         description: DVS switch name
43969       vcenter-url:
43970         type: string
43971         description: URL used to reach the vcenter
43972   dvs-switches:
43973     description: |
43974       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
43975     properties:
43976       dvs-switch:
43977         type: array
43978         items:
43979           $ref: "#/patchDefinitions/dvs-switch"
43980   edge-prop-names:
43981     description: |
43982       Internal map to define the properties of an edge and interpret the map EdgeRules
43983     properties:
43984       edgeLabel:
43985         type: string
43986       direction:
43987         type: string
43988       multiplicityRule:
43989         type: string
43990       isParent:
43991         type: boolean
43992       usesResource:
43993         type: boolean
43994       hasDelTarget:
43995         type: boolean
43996       SVC-INFRA:
43997         type: boolean
43998       SVC-INFRA-REV:
43999         type: boolean
44000   edge-tag-query-request:
44001     properties:
44002       edge-tag:
44003         type: string
44004       result-detail:
44005         type: string
44006       start-node-type:
44007         type: string
44008       start-node-filter:
44009         type: array
44010         items:
44011           $ref: "#/patchDefinitions/start-node-filter"
44012       include-node-filter:
44013         type: array
44014         items:
44015           $ref: "#/patchDefinitions/include-node-filter"
44016       secondary-filter:
44017         type: array
44018         items:
44019           $ref: "#/patchDefinitions/secondary-filter"
44020   edge-tag-query-result:
44021     properties:
44022       tagged-inventory-item-list:
44023         type: array
44024         items:
44025           $ref: "#/patchDefinitions/tagged-inventory-item-list"
44026   element-choice-set:
44027     description: |
44028       This is how we would capture constraints defining allowed sets of elements.
44029       ###### Related Nodes
44030       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
44031       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
44032
44033       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
44034       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
44035     required:
44036     - element-choice-set-uuid
44037     - element-choice-set-name
44038     properties:
44039       element-choice-set-uuid:
44040         type: string
44041       element-choice-set-name:
44042         type: string
44043       cardinality:
44044         type: string
44045   element-choice-sets:
44046     properties:
44047       element-choice-set:
44048         type: array
44049         items:
44050           $ref: "#/patchDefinitions/element-choice-set"
44051   entitlement:
44052     description: |
44053       Metadata for entitlement group.
44054       ###### Related Nodes
44055       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
44056       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
44057
44058       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
44059     required:
44060     - group-uuid
44061     - resource-uuid
44062     properties:
44063       group-uuid:
44064         type: string
44065         description: Unique ID for the entitlement group the resource comes from, should be uuid.
44066       resource-uuid:
44067         type: string
44068         description: Unique ID of an entitlement resource.
44069   entitlements:
44070     description: |
44071       Entitlements, keyed by group-uuid and resource-uuid, related to license management
44072     properties:
44073       entitlement:
44074         type: array
44075         items:
44076           $ref: "#/patchDefinitions/entitlement"
44077   esr-ems:
44078     description: |
44079       Persist EMS address information used by EMS driver.
44080       ###### Related Nodes
44081       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
44082
44083       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
44084     required:
44085     - ems-id
44086     properties:
44087       ems-id:
44088         type: string
44089         description: Unique ID of EMS.
44090   esr-ems-list:
44091     properties:
44092       esr-ems:
44093         type: array
44094         items:
44095           $ref: "#/patchDefinitions/esr-ems"
44096   esr-system-info:
44097     description: |
44098       Persist common address information of external systems.
44099       ###### Related Nodes
44100       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
44101       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
44102       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
44103       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
44104
44105       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
44106     required:
44107     - esr-system-info-id
44108     - user-name
44109     - password
44110     - system-type
44111     properties:
44112       esr-system-info-id:
44113         type: string
44114         description: Unique ID of esr system info.
44115       system-name:
44116         type: string
44117         description: name of external system.
44118       type:
44119         type: string
44120         description: type of external systems.
44121       vendor:
44122         type: string
44123         description: vendor of external systems.
44124       version:
44125         type: string
44126         description: version of external systems.
44127       service-url:
44128         type: string
44129         description: url used to access external systems.
44130       user-name:
44131         type: string
44132         description: username used to access external systems.
44133       password:
44134         type: string
44135         description: password used to access external systems.
44136       system-type:
44137         type: string
44138         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
44139       protocol:
44140         type: string
44141         description: protocol of third party SDNC, for example netconf/snmp.
44142       ssl-cacert:
44143         type: string
44144         description: ca file content if enabled ssl on auth-url.
44145       ssl-insecure:
44146         type: boolean
44147         description: Whether to verify VIM's certificate.
44148       ip-address:
44149         type: string
44150         description: service IP of ftp server.
44151       port:
44152         type: string
44153         description: service port of ftp server.
44154       cloud-domain:
44155         type: string
44156         description: domain info for authentication.
44157       default-tenant:
44158         type: string
44159         description: default tenant of VIM.
44160       passive:
44161         type: boolean
44162         description: ftp passive mode or not.
44163       remote-path:
44164         type: string
44165         description: resource or performance data file path.
44166       system-status:
44167         type: string
44168         description: the status of external system.
44169   esr-system-info-list:
44170     description: |
44171       Collection of persistent block-level external system auth info.
44172     properties:
44173       esr-system-info:
44174         type: array
44175         items:
44176           $ref: "#/patchDefinitions/esr-system-info"
44177   esr-thirdparty-sdnc:
44178     description: |
44179       Persist SDNC address information used by ONAP SDNC.
44180       ###### Related Nodes
44181       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
44182       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
44183
44184       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
44185     required:
44186     - thirdparty-sdnc-id
44187     properties:
44188       thirdparty-sdnc-id:
44189         type: string
44190         description: Unique ID of SDNC.
44191       location:
44192         type: string
44193         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
44194       product-name:
44195         type: string
44196         description: password used to access SDNC server.
44197   esr-thirdparty-sdnc-list:
44198     properties:
44199       esr-thirdparty-sdnc:
44200         type: array
44201         items:
44202           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
44203   esr-vnfm:
44204     description: |
44205       Persist VNFM address information used by VF-C.
44206       ###### Related Nodes
44207       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
44208
44209       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
44210     required:
44211     - vnfm-id
44212     properties:
44213       vnfm-id:
44214         type: string
44215         description: Unique ID of VNFM.
44216       vim-id:
44217         type: string
44218         description: indecate the VIM to deploy VNF.
44219       certificate-url:
44220         type: string
44221         description: certificate url of VNFM.
44222   esr-vnfm-list:
44223     properties:
44224       esr-vnfm:
44225         type: array
44226         items:
44227           $ref: "#/patchDefinitions/esr-vnfm"
44228   evc:
44229     description: |
44230       evc object is an optional child object of the Configuration object.
44231       ###### Related Nodes
44232       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
44233
44234       -(4) IF this TO node is deleted, this EVC is DELETED also
44235     required:
44236     - evc-id
44237     properties:
44238       evc-id:
44239         type: string
44240         description: Unique/key field for the evc object
44241       forwarding-path-topology:
44242         type: string
44243         description: Point-to-Point, Multi-Point
44244       cir-value:
44245         type: string
44246         description: Commited Information Rate
44247       cir-units:
44248         type: string
44249         description: CIR units
44250       connection-diversity-group-id:
44251         type: string
44252         description: Diversity Group ID
44253       service-hours:
44254         type: string
44255         description: formerly Performance Group
44256       esp-evc-circuit-id:
44257         type: string
44258         description: EVC Circuit ID of ESP EVC
44259       esp-evc-cir-value:
44260         type: string
44261         description: Committed Information Rate (For ESP)
44262       esp-evc-cir-units:
44263         type: string
44264         description: CIR units (For ESP)
44265       esp-itu-code:
44266         type: string
44267         description: Identifies ESP
44268       collector-pop-clli:
44269         type: string
44270         description: Collector POP CLLI (from the hostname of the access pnf)
44271       inter-connect-type-ingress:
44272         type: string
44273         description: Interconnect type on ingress side of EVC.
44274       tagmode-access-ingress:
44275         type: string
44276         description: tagode for collector side of EVC
44277       tagmode-access-egress:
44278         type: string
44279         description: tagMode for network side of EVC
44280   evcs:
44281     properties:
44282       evc:
44283         type: array
44284         items:
44285           $ref: "#/patchDefinitions/evc"
44286   external-system:
44287     description: |
44288       Namespace for external system.
44289     properties:
44290       esr-ems-list:
44291         type: object
44292         $ref: "#/patchDefinitions/esr-ems-list"
44293       esr-vnfm-list:
44294         type: object
44295         $ref: "#/patchDefinitions/esr-vnfm-list"
44296       esr-thirdparty-sdnc-list:
44297         type: object
44298         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
44299   extra-properties:
44300     description: |
44301       Extra properties for inventory item for response list
44302   extra-property:
44303     properties:
44304       property-name:
44305         type: string
44306   flavor:
44307     description: |
44308       Openstack flavor.
44309       ###### Related Nodes
44310       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
44311       - FROM vserver( vserver Uses flavor, MANY2ONE)
44312
44313       -FLAVOR cannot be deleted if related to VSERVER
44314
44315     required:
44316     - flavor-id
44317     - flavor-name
44318     - flavor-selflink
44319     properties:
44320       flavor-id:
44321         type: string
44322         description: Flavor id, expected to be unique across cloud-region.
44323       flavor-name:
44324         type: string
44325         description: Flavor name
44326       flavor-vcpus:
44327         type: integer
44328         format: int32
44329         description: Number of CPUs
44330       flavor-ram:
44331         type: integer
44332         format: int32
44333         description: Amount of memory
44334       flavor-disk:
44335         type: integer
44336         format: int32
44337         description: Disk space
44338       flavor-ephemeral:
44339         type: integer
44340         format: int32
44341         description: Amount of ephemeral disk space
44342       flavor-swap:
44343         type: string
44344         description: amount of swap space allocation
44345       flavor-is-public:
44346         type: boolean
44347         description: whether flavor is available to all users or private to the tenant it was created in.
44348       flavor-selflink:
44349         type: string
44350         description: URL to endpoint where AAI can get more details
44351       flavor-disabled:
44352         type: boolean
44353         description: Boolean as to whether this flavor is no longer enabled
44354   flavors:
44355     description: |
44356       Collection of openstack flavors.
44357     properties:
44358       flavor:
44359         type: array
44360         items:
44361           $ref: "#/patchDefinitions/flavor"
44362   forwarder:
44363     description: |
44364       Entity describing a sequenced segment of forwarding path
44365       ###### Related Nodes
44366       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
44367       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
44368       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
44369       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
44370       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
44371
44372       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
44373       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
44374     required:
44375     - sequence
44376     properties:
44377       sequence:
44378         type: integer
44379         format: int32
44380         description: Unique ID of this segmentation
44381       forwarder-role:
44382         type: string
44383         description: ingress, intermediate, egress
44384   forwarder-evc:
44385     description: |
44386       forwarder object is an optional child object of the Configuration object.
44387       ###### Related Nodes
44388       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
44389
44390       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
44391     required:
44392     - forwarder-evc-id
44393     properties:
44394       forwarder-evc-id:
44395         type: string
44396         description: Key for forwarder-evc object
44397       circuit-id:
44398         type: string
44399         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
44400       ivlan:
44401         type: string
44402         description: Internal VLAN.
44403       svlan:
44404         type: string
44405         description: SVLAN value for ingress of egress forwarder.
44406       cvlan:
44407         type: string
44408         description: CVLAN value for ingress of egress forwarder.
44409   forwarder-evcs:
44410     properties:
44411       forwarder-evc:
44412         type: array
44413         items:
44414           $ref: "#/patchDefinitions/forwarder-evc"
44415   forwarders:
44416     properties:
44417       forwarder:
44418         type: array
44419         items:
44420           $ref: "#/patchDefinitions/forwarder"
44421   forwarding-path:
44422     description: |
44423       Entity that describes the sequenced forwarding path between interfaces of services or resources
44424       ###### Related Nodes
44425       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
44426       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
44427       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
44428
44429       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
44430       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
44431       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
44432     required:
44433     - forwarding-path-id
44434     - forwarding-path-name
44435     properties:
44436       forwarding-path-id:
44437         type: string
44438         description: Unique ID of this FP
44439       forwarding-path-name:
44440         type: string
44441         description: Name of the FP
44442   forwarding-paths:
44443     properties:
44444       forwarding-path:
44445         type: array
44446         items:
44447           $ref: "#/patchDefinitions/forwarding-path"
44448   generic-vnf:
44449     description: |
44450       General purpose VNF
44451       ###### Related Nodes
44452       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
44453       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
44454       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
44455       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
44456       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
44457       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
44458       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
44459       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
44460       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
44461       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
44462       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
44463       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
44464       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
44465       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
44466       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
44467       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
44468       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
44469
44470       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
44471     required:
44472     - vnf-id
44473     - vnf-name
44474     - vnf-type
44475     - in-maint
44476     - is-closed-loop-disabled
44477     properties:
44478       vnf-id:
44479         type: string
44480         description: Unique id of VNF.  This is unique across the graph.
44481       vnf-name:
44482         type: string
44483         description: Name of VNF.
44484       vnf-name2:
44485         type: string
44486         description: Alternate name of VNF.
44487       vnf-type:
44488         type: string
44489         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
44490       service-id:
44491         type: string
44492         description: Unique identifier of service from ASDC
44493       regional-resource-zone:
44494         type: string
44495         description: Regional way of organizing pservers, source of truth should define values
44496       prov-status:
44497         type: string
44498         description: Trigger for operational monitoring of this resource by Service Assurance systems.
44499       operational-state:
44500         type: string
44501         description: Indicator for whether the resource is considered operational
44502       license-key:
44503         type: string
44504         description: License key
44505       equipment-role:
44506         type: string
44507         description: Client should send valid enumerated value
44508       orchestration-status:
44509         type: string
44510         description: Orchestration status of this VNF, used by MSO.
44511       heat-stack-id:
44512         type: string
44513         description: Heat stack id corresponding to this instance, managed by MSO
44514       mso-catalog-key:
44515         type: string
44516         description: Corresponds to the SDN-C catalog id used to configure this VCE
44517       management-option:
44518         type: string
44519         description: identifier of managed by company or customer
44520       ipv4-oam-address:
44521         type: string
44522         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
44523       ipv4-loopback0-address:
44524         type: string
44525         description: v4 Loopback0 address
44526       nm-lan-v6-address:
44527         type: string
44528         description: v6 Loopback address
44529       management-v6-address:
44530         type: string
44531         description: v6 management address
44532       vcpu:
44533         type: integer
44534         format: int64
44535         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
44536       vcpu-units:
44537         type: string
44538         description: units associated with vcpu, used for VNFs with no vservers/flavors
44539       vmemory:
44540         type: integer
44541         format: int64
44542         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
44543       vmemory-units:
44544         type: string
44545         description: units associated with vmemory, used for VNFs with no vservers/flavors
44546       vdisk:
44547         type: integer
44548         format: int64
44549         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
44550       vdisk-units:
44551         type: string
44552         description: units associated with vdisk, used for VNFs with no vservers/flavors
44553       in-maint:
44554         type: boolean
44555         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
44556       is-closed-loop-disabled:
44557         type: boolean
44558         description: used to indicate whether closed loop function is enabled on this node
44559   generic-vnfs:
44560     description: |
44561       Collection of VNFs
44562     properties:
44563       generic-vnf:
44564         type: array
44565         items:
44566           $ref: "#/patchDefinitions/generic-vnf"
44567   group-assignment:
44568     description: |
44569       Openstack group-assignment used to store exclusivity groups (EG).
44570       ###### Related Nodes
44571       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
44572       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
44573       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
44574
44575     required:
44576     - group-id
44577     - group-type
44578     - group-name
44579     properties:
44580       group-id:
44581         type: string
44582         description: Group id, expected to be unique across cloud-region.
44583       group-type:
44584         type: string
44585         description: Group type - the type of group this instance refers to
44586       group-name:
44587         type: string
44588         description: Group name - name assigned to the group
44589       group-description:
44590         type: string
44591         description: Group description - description of the group
44592   group-assignments:
44593     description: |
44594       Collection of openstack group assignments
44595     properties:
44596       group-assignment:
44597         type: array
44598         items:
44599           $ref: "#/patchDefinitions/group-assignment"
44600   host-route:
44601     description: |
44602       ###### Related Nodes
44603       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
44604
44605       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
44606     required:
44607     - host-route-id
44608     - route-prefix
44609     - next-hop
44610     properties:
44611       host-route-id:
44612         type: string
44613         description: host-route id
44614       route-prefix:
44615         type: string
44616         description: subnet prefix
44617       next-hop:
44618         type: string
44619         description: Could be ip-address, hostname, or service-instance
44620       next-hop-type:
44621         type: string
44622         description: Should be ip-address, hostname, or service-instance to match next-hop
44623   host-routes:
44624     properties:
44625       host-route:
44626         type: array
44627         items:
44628           $ref: "#/patchDefinitions/host-route"
44629   hpa-capabilities:
44630     description: |
44631       Collection of HPA Capabilities
44632     properties:
44633       hpa-capability:
44634         type: array
44635         items:
44636           $ref: "#/patchDefinitions/hpa-capability"
44637   hpa-capability:
44638     description: |
44639       Represents a HPA capability
44640       ###### Related Nodes
44641       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
44642       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
44643       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
44644
44645       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
44646     required:
44647     - hpa-capability-id
44648     - hpa-feature
44649     properties:
44650       hpa-capability-id:
44651         type: string
44652         description: UUID to uniquely identify a HPA capability
44653       hpa-feature:
44654         type: string
44655         description: Name of the HPACapability
44656       hpa-version:
44657         type: string
44658         description: HPA schema version
44659       architecture:
44660         type: string
44661         description: Hardware architecture
44662   hpa-feature-attributes:
44663     description: |
44664       HPA Capability Feature attributes
44665       ###### Related Nodes
44666       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
44667
44668       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
44669     required:
44670     - hpa-attribute-key
44671     properties:
44672       hpa-attribute-key:
44673         type: string
44674         description: name of the specific HPA attribute
44675       hpa-attribute-value:
44676         type: string
44677         description: JSON string specifying the value, unit and type of the specific HPA attribute
44678   image:
44679     description: |
44680       Openstack image.
44681       ###### Related Nodes
44682       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
44683       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
44684       - FROM vserver( vserver Uses image, MANY2ONE)
44685
44686       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
44687       -IMAGE cannot be deleted if related to VSERVER
44688
44689     required:
44690     - image-id
44691     - image-name
44692     - image-os-distro
44693     - image-os-version
44694     - image-selflink
44695     properties:
44696       image-id:
44697         type: string
44698         description: Image id, expected to be unique across cloud region
44699       image-name:
44700         type: string
44701         description: Image name
44702       image-architecture:
44703         type: string
44704         description: Operating system architecture.
44705       image-os-distro:
44706         type: string
44707         description: The common name of the operating system distribution in lowercase
44708       image-os-version:
44709         type: string
44710         description: The operating system version as specified by the distributor.
44711       application:
44712         type: string
44713         description: The application that the image instantiates.
44714       application-vendor:
44715         type: string
44716         description: The vendor of the application.
44717       application-version:
44718         type: string
44719         description: The version of the application.
44720       image-selflink:
44721         type: string
44722         description: URL to endpoint where AAI can get more details
44723   images:
44724     description: |
44725       Collectio of Openstack images.
44726     properties:
44727       image:
44728         type: array
44729         items:
44730           $ref: "#/patchDefinitions/image"
44731   include-node-filter:
44732     properties:
44733       include-node-type:
44734         type: string
44735   instance-filter:
44736     description: |
44737       InstanceFilter for performing a named-query or model query
44738   instance-filters:
44739     description: |
44740       InstanceFilters for performing a named-query or model query
44741     properties:
44742       instance-filter:
44743         type: array
44744         items:
44745           $ref: "#/patchDefinitions/instance-filter"
44746   instance-group:
44747     description: |
44748       General mechanism for grouping instances
44749       ###### Related Nodes
44750       - TO model( instance-group Targets model, MANY2MANY)
44751       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
44752       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
44753       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
44754       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
44755
44756     required:
44757     - id
44758     - description
44759     - type
44760     properties:
44761       id:
44762         type: string
44763         description: Instance Group ID, UUID assigned to this instance.
44764       description:
44765         type: string
44766         description: Descriptive text to help identify the usage of this instance-group
44767       type:
44768         type: string
44769         description: Only valid value today is lower case ha for high availability
44770       sub-type:
44771         type: string
44772         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
44773   instance-groups:
44774     description: |
44775       Collection of openstack route table references
44776     properties:
44777       instance-group:
44778         type: array
44779         items:
44780           $ref: "#/patchDefinitions/instance-group"
44781   inventory:
44782     properties:
44783       search:
44784         type: object
44785         $ref: "#/patchDefinitions/search"
44786       actions:
44787         type: object
44788         $ref: "#/patchDefinitions/actions"
44789       cloud-infrastructure:
44790         type: object
44791         $ref: "#/patchDefinitions/cloud-infrastructure"
44792       business:
44793         type: object
44794         $ref: "#/patchDefinitions/business"
44795       service-design-and-creation:
44796         type: object
44797         $ref: "#/patchDefinitions/service-design-and-creation"
44798       network:
44799         type: object
44800         $ref: "#/patchDefinitions/network"
44801   inventory-item:
44802     properties:
44803       inventory-item-type:
44804         type: string
44805       inventory-item-link:
44806         type: string
44807       inventory-item-data:
44808         type: array
44809         items:
44810           $ref: "#/patchDefinitions/inventory-item-data"
44811       tagged-inventory-item-list:
44812         type: array
44813         items:
44814           $ref: "#/patchDefinitions/tagged-inventory-item-list"
44815   inventory-item-data:
44816     properties:
44817       property-name:
44818         type: string
44819       property-value:
44820         type: string
44821   inventory-response-item:
44822     description: |
44823       Inventory item for response list
44824     properties:
44825       model-name:
44826         type: string
44827       extra-properties:
44828         type: object
44829         $ref: "#/patchDefinitions/extra-properties"
44830       inventory-response-items:
44831         type: object
44832         $ref: "#/patchDefinitions/inventory-response-items"
44833   inventory-response-items:
44834     description: |
44835       Container for inventory items in response list
44836     properties:
44837       inventory-response-item:
44838         type: array
44839         items:
44840           $ref: "#/patchDefinitions/inventory-response-item"
44841   ipsec-configuration:
44842     description: |
44843       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
44844       ###### Related Nodes
44845       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
44846       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
44847
44848       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
44849     required:
44850     - ipsec-configuration-id
44851     properties:
44852       ipsec-configuration-id:
44853         type: string
44854         description: UUID of this configuration
44855       requested-vig-address-type:
44856         type: string
44857         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
44858       requested-encryption-strength:
44859         type: string
44860         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
44861       requested-dmz-type:
44862         type: string
44863         description: can offer a shared DMZ or a DMZ specific to a customer
44864       shared-dmz-network-address:
44865         type: string
44866         description: Network address of shared DMZ
44867       requested-customer-name:
44868         type: string
44869         description: If the DMZ is a custom DMZ, this field will indicate the customer information
44870       ike-version:
44871         type: string
44872         description: can be 1 or 2
44873       ikev1-authentication:
44874         type: string
44875         description: Contains values like md5, sha1, sha256, sha384
44876       ikev1-encryption:
44877         type: string
44878         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
44879       ikev1-dh-group:
44880         type: string
44881         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
44882       ikev1-am-group-id:
44883         type: string
44884         description: Group name defined in VIG for clients using aggressive mode
44885       ikev1-am-password:
44886         type: string
44887         description: pre-shared key for the above group name
44888       ikev1-sa-lifetime:
44889         type: string
44890         description: Lifetime for IKEv1 SA
44891       ipsec-authentication:
44892         type: string
44893         description: md5, sha1, sha256, sha384
44894       ipsec-encryption:
44895         type: string
44896         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
44897       ipsec-sa-lifetime:
44898         type: string
44899         description: Life time for IPSec SA
44900       ipsec-pfs:
44901         type: string
44902         description: enable PFS or not
44903       xauth-userid:
44904         type: string
44905         description: user ID for xAuth, sm-user, ,nmteHostName
44906       xauth-user-password:
44907         type: string
44908         description: Encrypted using the Juniper $9$ algorithm
44909       dpd-interval:
44910         type: string
44911         description: The time between DPD probe
44912       dpd-frequency:
44913         type: string
44914         description: Maximum number of DPD before claiming the tunnel is down
44915   ipsec-configurations:
44916     properties:
44917       ipsec-configuration:
44918         type: array
44919         items:
44920           $ref: "#/patchDefinitions/ipsec-configuration"
44921   key-data:
44922     properties:
44923       key-name:
44924         type: string
44925       key-value:
44926         type: string
44927   l-interface:
44928     description: |
44929       Logical interfaces, e.g., a vnic.
44930       ###### Related Nodes
44931       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
44932       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
44933       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
44934       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
44935       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
44936       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
44937       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
44938       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
44939       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
44940       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
44941
44942       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
44943       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
44944       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
44945     required:
44946     - interface-name
44947     properties:
44948       interface-name:
44949         type: string
44950         description: Name given to the interface
44951       interface-role:
44952         type: string
44953         description: E.g., CUSTOMER, UPLINK, etc.
44954       v6-wan-link-ip:
44955         type: string
44956         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
44957       selflink:
44958         type: string
44959         description: URL to endpoint where AAI can get more details
44960       interface-id:
44961         type: string
44962         description: ID of interface
44963       macaddr:
44964         type: string
44965         description: MAC address for the interface
44966       network-name:
44967         type: string
44968         description: Name of the network
44969       management-option:
44970         type: string
44971         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
44972   l-interfaces:
44973     description: |
44974       Collection of logical interfaces.
44975     properties:
44976       l-interface:
44977         type: array
44978         items:
44979           $ref: "#/patchDefinitions/l-interface"
44980   l3-interface-ipv4-address-list:
44981     description: |
44982       IPv4 Address Range
44983       ###### Related Nodes
44984       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
44985       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
44986       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
44987       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
44988
44989       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
44990     required:
44991     - l3-interface-ipv4-address
44992     properties:
44993       l3-interface-ipv4-address:
44994         type: string
44995         description: IP address
44996       l3-interface-ipv4-prefix-length:
44997         type: integer
44998         format: int64
44999         description: Prefix length, 32 for single address
45000       vlan-id-inner:
45001         type: integer
45002         format: int64
45003         description: Inner VLAN tag
45004       vlan-id-outer:
45005         type: integer
45006         format: int64
45007         description: Outer VLAN tag
45008       is-floating:
45009         type: boolean
45010         description: Indicator of fixed or floating address
45011   l3-interface-ipv6-address-list:
45012     description: |
45013       IPv6 Address Range
45014       ###### Related Nodes
45015       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
45016       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45017       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
45018       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
45019
45020       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
45021     required:
45022     - l3-interface-ipv6-address
45023     properties:
45024       l3-interface-ipv6-address:
45025         type: string
45026         description: IP address
45027       l3-interface-ipv6-prefix-length:
45028         type: integer
45029         format: int64
45030         description: Prefix length, 128 for single address
45031       vlan-id-inner:
45032         type: integer
45033         format: int64
45034         description: Inner VLAN tag
45035       vlan-id-outer:
45036         type: integer
45037         format: int64
45038         description: Outer VLAN tag
45039       is-floating:
45040         type: boolean
45041         description: Indicator of fixed or floating address
45042   l3-network:
45043     description: |
45044       Generic network definition
45045       ###### Related Nodes
45046       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
45047       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
45048       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
45049       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
45050       - FROM complex( complex Uses l3-network, MANY2MANY)
45051       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
45052       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
45053       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
45054       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
45055       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
45056       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
45057       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
45058       - FROM tenant( tenant Uses l3-network, MANY2MANY)
45059       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
45060
45061       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
45062     required:
45063     - network-id
45064     - network-name
45065     - is-bound-to-vpn
45066     - is-provider-network
45067     - is-shared-network
45068     - is-external-network
45069     properties:
45070       network-id:
45071         type: string
45072         description: Network ID, should be uuid. Unique across A&AI.
45073       network-name:
45074         type: string
45075         description: Name of the network, governed by some naming convention..
45076       network-type:
45077         type: string
45078         description: Type of the network - who defines these values?
45079       network-role:
45080         type: string
45081         description: Role the network plans - who defines these values?
45082       network-technology:
45083         type: string
45084         description: Network technology - who defines these values?
45085       neutron-network-id:
45086         type: string
45087         description: Neutron network id of this Interface
45088       is-bound-to-vpn:
45089         type: boolean
45090         description: Set to true if bound to VPN
45091       service-id:
45092         type: string
45093         description: Unique identifier of service from ASDC
45094       network-role-instance:
45095         type: integer
45096         format: int64
45097         description: network role instance
45098   l3-networks:
45099     properties:
45100       l3-network:
45101         type: array
45102         items:
45103           $ref: "#/patchDefinitions/l3-network"
45104   lag-interface:
45105     description: |
45106       Link aggregate interface
45107       ###### Related Nodes
45108       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
45109       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
45110       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
45111       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
45112       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
45113       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
45114       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
45115
45116       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
45117       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
45118       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
45119     required:
45120     - interface-name
45121     properties:
45122       interface-name:
45123         type: string
45124         description: Name that identifies the link aggregate interface
45125   lag-interfaces:
45126     description: |
45127       Collection of link aggregate interfaces.
45128     properties:
45129       lag-interface:
45130         type: array
45131         items:
45132           $ref: "#/patchDefinitions/lag-interface"
45133   lag-link:
45134     description: |
45135       LAG links can connect lag-interfaces
45136       ###### Related Nodes
45137       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
45138       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
45139
45140       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
45141     required:
45142     - link-name
45143     properties:
45144       link-name:
45145         type: string
45146         description: Alphabetical concatenation of lag-interface names
45147   lag-links:
45148     description: |
45149       Collection of link aggregation connections
45150     properties:
45151       lag-link:
45152         type: array
45153         items:
45154           $ref: "#/patchDefinitions/lag-link"
45155   license:
45156     description: |
45157       Metadata for license group.
45158       ###### Related Nodes
45159       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
45160       - TO vce( license BelongsTo vce, MANY2ONE)(4)
45161
45162       -(4) IF this TO node is deleted, this LICENSE is DELETED also
45163     required:
45164     - group-uuid
45165     - resource-uuid
45166     properties:
45167       group-uuid:
45168         type: string
45169         description: Unique ID for the license group the resource belongs to, should be uuid.
45170       resource-uuid:
45171         type: string
45172         description: Unique ID of a license resource.
45173   licenses:
45174     description: |
45175       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
45176     properties:
45177       license:
45178         type: array
45179         items:
45180           $ref: "#/patchDefinitions/license"
45181   line-of-business:
45182     description: |
45183       describes a line-of-business
45184       ###### Related Nodes
45185       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
45186
45187     required:
45188     - line-of-business-name
45189     properties:
45190       line-of-business-name:
45191         type: string
45192         description: Name of the line-of-business (product)
45193   lines-of-business:
45194     description: |
45195       Collection of lines-of-business
45196     properties:
45197       line-of-business:
45198         type: array
45199         items:
45200           $ref: "#/patchDefinitions/line-of-business"
45201   logical-link:
45202     description: |
45203       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
45204       ###### Related Nodes
45205       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
45206       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
45207       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
45208       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
45209       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
45210       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
45211       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
45212       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
45213       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
45214       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
45215       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
45216
45217       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
45218     required:
45219     - link-name
45220     - link-type
45221     properties:
45222       link-name:
45223         type: string
45224         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
45225       link-type:
45226         type: string
45227         description: Type of logical link, e.g., evc
45228       speed-value:
45229         type: string
45230         description: Captures the numeric part of the speed
45231       speed-units:
45232         type: string
45233         description: Captures the units corresponding to the speed
45234       ip-version:
45235         type: string
45236         description: v4, v6, or ds for dual stack
45237       routing-protocol:
45238         type: string
45239         description: For example, static or BGP
45240   logical-links:
45241     description: |
45242       Collection of logical connections
45243     properties:
45244       logical-link:
45245         type: array
45246         items:
45247           $ref: "#/patchDefinitions/logical-link"
45248   metadata:
45249     description: |
45250       Collection of metadatum (key/value pairs)
45251     properties:
45252       metadatum:
45253         type: array
45254         items:
45255           $ref: "#/patchDefinitions/metadatum"
45256   metadatum:
45257     description: |
45258       Key/value pairs
45259       ###### Related Nodes
45260       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
45261       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
45262       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
45263       - TO model( metadatum BelongsTo model, MANY2ONE)(4)
45264
45265       -(4) IF this TO node is deleted, this METADATUM is DELETED also
45266     required:
45267     - metaname
45268     - metaval
45269     properties:
45270       metaname:
45271         type: string
45272       metaval:
45273         type: string
45274   model:
45275     description: |
45276       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
45277       ###### Related Nodes
45278       - TO model( model-element isA model, MANY2ONE)
45279       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
45280       - FROM named-query( named-query AppliesTo model, ONE2MANY)
45281       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
45282       - FROM model-element( model-element isA model, MANY2ONE)
45283       - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
45284
45285       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
45286       -(2) IF this MODEL node is deleted, this TO node is DELETED also
45287       -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
45288
45289     required:
45290     - model-name-version-id
45291     - model-type
45292     - model-name
45293     - model-id
45294     - model-version
45295     properties:
45296       model-name-version-id:
45297         type: string
45298         description: Unique identifier corresponding to one version of a model in ASDC
45299       model-type:
45300         type: string
45301         description: Type of the model, e.g., service, resource, widget, etc.
45302       model-name:
45303         type: string
45304         description: Name of the model, which can change from version to version.
45305       model-id:
45306         type: string
45307         description: Invariant unique ID which does not change from version to version
45308       model-version:
45309         type: string
45310         description: Version
45311       model-description:
45312         type: string
45313         description: Description
45314   model-and-named-query-search:
45315     description: |
45316       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
45317     properties:
45318       query-parameters:
45319         type: object
45320         $ref: "#/patchDefinitions/query-parameters"
45321       instance-filters:
45322         type: object
45323         $ref: "#/patchDefinitions/instance-filters"
45324       top-node-type:
45325         type: string
45326   model-constraint:
45327     description: |
45328       This is how we would capture constraints defining allowed sets of elements.
45329       ###### Related Nodes
45330       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
45331       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
45332
45333       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
45334       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
45335     required:
45336     - model-constraint-uuid
45337     - constrained-element-set-uuid-to-replace
45338     properties:
45339       model-constraint-uuid:
45340         type: string
45341       constrained-element-set-uuid-to-replace:
45342         type: string
45343       constrained-element-sets:
45344         type: array
45345         items:
45346           $ref: "#/patchDefinitions/constrained-element-set"
45347   model-constraints:
45348     properties:
45349       model-constraint:
45350         type: array
45351         items:
45352           $ref: "#/patchDefinitions/model-constraint"
45353   model-element:
45354     description: |
45355       Defines how other models combine to make up a higher-level model.
45356       ###### Related Nodes
45357       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
45358       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
45359       - TO model( model-element isA model, MANY2ONE)
45360       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
45361       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
45362       - FROM model (PARENT of model-element, model startsWith model-element)(3)
45363       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
45364
45365       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
45366       -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
45367       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
45368     required:
45369     - model-element-uuid
45370     - new-data-del-flag
45371     - cardinality
45372     properties:
45373       model-element-uuid:
45374         type: string
45375       new-data-del-flag:
45376         type: string
45377         description: Indicates whether this element was created as part of instantiation from this model
45378       cardinality:
45379         type: string
45380         description: How many of this type of element are required/allowed
45381       linkage-points:
45382         type: string
45383   model-elements:
45384     properties:
45385       model-element:
45386         type: array
45387         items:
45388           $ref: "#/patchDefinitions/model-element"
45389   model-ver:
45390     description: |
45391       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
45392       ###### Related Nodes
45393       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
45394       - FROM model-element( model-element IsA model-ver, MANY2ONE)
45395       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
45396       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
45397
45398       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
45399       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
45400       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
45401
45402     required:
45403     - model-version-id
45404     - model-name
45405     - model-version
45406     properties:
45407       model-version-id:
45408         type: string
45409         description: Unique identifier corresponding to one version of a model in ASDC
45410       model-name:
45411         type: string
45412         description: Name of the model, which can change from version to version.
45413       model-version:
45414         type: string
45415         description: Version
45416       model-description:
45417         type: string
45418         description: Description
45419   model-vers:
45420     properties:
45421       model-ver:
45422         type: array
45423         items:
45424           $ref: "#/patchDefinitions/model-ver"
45425   models:
45426     description: |
45427       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
45428     properties:
45429       model:
45430         type: array
45431         items:
45432           $ref: "#/patchDefinitions/model"
45433   multicast-configuration:
45434     description: |
45435       ###### Related Nodes
45436       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
45437
45438     required:
45439     - multicast-configuration-id
45440     - multicast-protocol
45441     - rp-type
45442     properties:
45443       multicast-configuration-id:
45444         type: string
45445         description: Unique id of multicast configuration.
45446       multicast-protocol:
45447         type: string
45448         description: protocol of multicast configuration
45449       rp-type:
45450         type: string
45451         description: rp type of multicast configuration
45452   multicast-configurations:
45453     description: |
45454       multicast configuration of generic-vnf ip-address
45455     properties:
45456       multicast-configuration:
45457         type: array
45458         items:
45459           $ref: "#/patchDefinitions/multicast-configuration"
45460   named-queries:
45461     properties:
45462       named-query:
45463         type: array
45464         items:
45465           $ref: "#/patchDefinitions/named-query"
45466   named-query:
45467     description: |
45468       TBD
45469       ###### Related Nodes
45470       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
45471       - TO model( named-query AppliesTo model, ONE2MANY)
45472       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
45473
45474       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
45475     required:
45476     - named-query-uuid
45477     - named-query-name
45478     - named-query-version
45479     properties:
45480       named-query-uuid:
45481         type: string
45482       named-query-name:
45483         type: string
45484       named-query-version:
45485         type: string
45486       required-input-param:
45487         type: string
45488       description:
45489         type: string
45490   named-query-element:
45491     description: |
45492       TBD
45493       ###### Related Nodes
45494       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
45495       - TO model( named-query-element IsA model, MANY2ONE)
45496       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
45497       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
45498       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
45499       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
45500
45501       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
45502       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
45503     required:
45504     - named-query-element-uuid
45505     properties:
45506       named-query-element-uuid:
45507         type: string
45508       property-collect-list:
45509         type: string
45510   named-query-elements:
45511     properties:
45512       named-query-element:
45513         type: array
45514         items:
45515           $ref: "#/patchDefinitions/named-query-element"
45516   network:
45517     description: |
45518       Namespace for network inventory resources.
45519     properties:
45520       logical-links:
45521         type: array
45522         items:
45523           $ref: "#/patchDefinitions/logical-link"
45524       site-pair-sets:
45525         type: array
45526         items:
45527           $ref: "#/patchDefinitions/site-pair-set"
45528       vpn-bindings:
45529         type: array
45530         items:
45531           $ref: "#/patchDefinitions/vpn-binding"
45532       vpls-pes:
45533         type: array
45534         items:
45535           $ref: "#/patchDefinitions/vpls-pe"
45536       multicast-configurations:
45537         type: array
45538         items:
45539           $ref: "#/patchDefinitions/multicast-configuration"
45540       vces:
45541         type: array
45542         items:
45543           $ref: "#/patchDefinitions/vce"
45544       vnfcs:
45545         type: array
45546         items:
45547           $ref: "#/patchDefinitions/vnfc"
45548       l3-networks:
45549         type: array
45550         items:
45551           $ref: "#/patchDefinitions/l3-network"
45552       network-policies:
45553         type: array
45554         items:
45555           $ref: "#/patchDefinitions/network-policy"
45556       generic-vnfs:
45557         type: array
45558         items:
45559           $ref: "#/patchDefinitions/generic-vnf"
45560       lag-links:
45561         type: array
45562         items:
45563           $ref: "#/patchDefinitions/lag-link"
45564       newvces:
45565         type: array
45566         items:
45567           $ref: "#/patchDefinitions/newvce"
45568       pnfs:
45569         type: array
45570         items:
45571           $ref: "#/patchDefinitions/pnf"
45572       physical-links:
45573         type: array
45574         items:
45575           $ref: "#/patchDefinitions/physical-link"
45576       ipsec-configurations:
45577         type: array
45578         items:
45579           $ref: "#/patchDefinitions/ipsec-configuration"
45580       route-table-references:
45581         type: array
45582         items:
45583           $ref: "#/patchDefinitions/route-table-reference"
45584   network-policies:
45585     properties:
45586       network-policy:
45587         type: array
45588         items:
45589           $ref: "#/patchDefinitions/network-policy"
45590   network-policy:
45591     description: |
45592       ###### Related Nodes
45593       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
45594
45595     required:
45596     - network-policy-id
45597     properties:
45598       network-policy-id:
45599         type: string
45600         description: UUID representing unique key to this instance
45601       network-policy-fqdn:
45602         type: string
45603         description: Contrail FQDN for the policy
45604       heat-stack-id:
45605         type: string
45606         description: ID for the openStack Heat instance
45607   network-profile:
45608     description: |
45609       Network profile populated by SDN-GP for SNMP
45610       ###### Related Nodes
45611       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
45612
45613     required:
45614     - nm-profile-name
45615     properties:
45616       nm-profile-name:
45617         type: string
45618         description: Unique name of network profile.
45619       community-string:
45620         type: string
45621         description: Encrypted SNMP community string
45622   network-profiles:
45623     description: |
45624       Collection of network profiles
45625     properties:
45626       network-profile:
45627         type: array
45628         items:
45629           $ref: "#/patchDefinitions/network-profile"
45630   newvce:
45631     description: |
45632       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
45633       ###### Related Nodes
45634       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
45635
45636       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
45637     required:
45638     - vnf-id2
45639     - vnf-name
45640     - vnf-type
45641     properties:
45642       vnf-id2:
45643         type: string
45644         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45645       vnf-name:
45646         type: string
45647         description: Name of VNF.
45648       vnf-name2:
45649         type: string
45650         description: Alternate name of VNF.
45651       vnf-type:
45652         type: string
45653         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
45654       prov-status:
45655         type: string
45656         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45657       operational-state:
45658         type: string
45659         description: Indicator for whether the resource is considered operational
45660       license-key:
45661         type: string
45662         description: License key
45663       ipv4-oam-address:
45664         type: string
45665         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).
45666       equipment-role:
45667         type: string
45668         description: Client should send valid enumerated value.
45669   newvces:
45670     description: |
45671       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
45672     properties:
45673       newvce:
45674         type: array
45675         items:
45676           $ref: "#/patchDefinitions/newvce"
45677   nodes:
45678     properties:
45679       inventory-item-data:
45680         type: array
45681         items:
45682           $ref: "#/patchDefinitions/inventory-item-data"
45683   notification-event:
45684     properties:
45685       cambria.partition:
45686         type: string
45687       notification-event-header:
45688         type: object
45689         $ref: "#/patchDefinitions/notification-event-header"
45690   notification-event-header:
45691     properties:
45692       id:
45693         type: string
45694       timestamp:
45695         type: string
45696       source-name:
45697         type: string
45698       domain:
45699         type: string
45700       sequence-number:
45701         type: string
45702       severity:
45703         type: string
45704       event-type:
45705         type: string
45706       version:
45707         type: string
45708       action:
45709         type: string
45710       entity-type:
45711         type: string
45712       top-entity-type:
45713         type: string
45714       entity-link:
45715         type: string
45716       status:
45717         type: string
45718   notify:
45719     required:
45720     - event-id
45721     properties:
45722       event-id:
45723         type: string
45724       node-type:
45725         type: string
45726       event-trigger:
45727         type: string
45728       key-data:
45729         type: array
45730         items:
45731           $ref: "#/patchDefinitions/key-data"
45732       selflink:
45733         type: string
45734   oam-network:
45735     description: |
45736       OAM network, to be deprecated shortly.  Do not use for new purposes.
45737       ###### Related Nodes
45738       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
45739       - TO complex( oam-network AppliesTo complex, MANY2MANY)
45740       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
45741
45742     required:
45743     - network-uuid
45744     - network-name
45745     - cvlan-tag
45746     properties:
45747       network-uuid:
45748         type: string
45749         description: UUID of the network. Unique across a cloud-region
45750       network-name:
45751         type: string
45752         description: Name of the network.
45753       cvlan-tag:
45754         type: integer
45755         format: int64
45756         description: cvlan-id
45757       ipv4-oam-gateway-address:
45758         type: string
45759         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
45760       ipv4-oam-gateway-address-prefix-length:
45761         type: integer
45762         format: int32
45763         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
45764   oam-networks:
45765     description: |
45766       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
45767     properties:
45768       oam-network:
45769         type: array
45770         items:
45771           $ref: "#/patchDefinitions/oam-network"
45772   operational-environment:
45773     description: |
45774       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
45775       ###### Related Nodes
45776       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
45777       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
45778
45779     required:
45780     - operational-environment-id
45781     - operational-environment-name
45782     - operational-environment-type
45783     - operational-environment-status
45784     - tenant-context
45785     - workload-context
45786     properties:
45787       operational-environment-id:
45788         type: string
45789         description: UUID of an operational environment
45790       operational-environment-name:
45791         type: string
45792         description: Operational Environment name
45793       operational-environment-type:
45794         type: string
45795         description: Operational Environment Type.
45796       operational-environment-status:
45797         type: string
45798         description: Status
45799       tenant-context:
45800         type: string
45801         description: Tenant Context.
45802       workload-context:
45803         type: string
45804         description: Workload Context.
45805   operational-environments:
45806     description: |
45807       a logical partition of the cloud which allows to have multiple environments in the production AIC.
45808     properties:
45809       operational-environment:
45810         type: array
45811         items:
45812           $ref: "#/patchDefinitions/operational-environment"
45813   overloaded-model:
45814     description: |
45815       Allows for legacy POST of old-style and new-style models
45816     required:
45817     - model-invariant-id
45818     - model-name-version-id
45819     - model-type
45820     - model-name
45821     - model-id
45822     - model-version
45823     properties:
45824       model-invariant-id:
45825         type: string
45826         description: Unique identifier corresponding to the main definition of a model in ASDC
45827       model-name-version-id:
45828         type: string
45829         description: Unique identifier corresponding to one version of a model in ASDC
45830       model-type:
45831         type: string
45832         description: Type of the model, e.g., service, resource, widget, etc.
45833       model-name:
45834         type: string
45835         description: Name of the model, which can change from version to version.
45836       model-id:
45837         type: string
45838         description: Invariant unique ID which does not change from version to version
45839       model-version:
45840         type: string
45841         description: Version
45842       model-description:
45843         type: string
45844         description: Description
45845   owning-entities:
45846     description: |
45847       Collection of owning-entities
45848     properties:
45849       owning-entity:
45850         type: array
45851         items:
45852           $ref: "#/patchDefinitions/owning-entity"
45853   owning-entity:
45854     description: |
45855       describes an owning-entity
45856       ###### Related Nodes
45857       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
45858
45859     required:
45860     - owning-entity-id
45861     - owning-entity-name
45862     properties:
45863       owning-entity-id:
45864         type: string
45865         description: UUID of an owning entity
45866       owning-entity-name:
45867         type: string
45868         description: Owning entity name
45869   p-interface:
45870     description: |
45871       Physical interface (e.g., nic)
45872       ###### Related Nodes
45873       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
45874       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
45875       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
45876       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
45877       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
45878       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
45879       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
45880
45881       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
45882       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
45883       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
45884     required:
45885     - interface-name
45886     properties:
45887       interface-name:
45888         type: string
45889         description: Name that identifies the physical interface
45890       speed-value:
45891         type: string
45892         description: Captures the numeric part of the speed
45893       speed-units:
45894         type: string
45895         description: Captures the units corresponding to the speed
45896       port-description:
45897         type: string
45898         description: Nature of the services and connectivity on this port.
45899       equipment-identifier:
45900         type: string
45901         description: CLEI or other specification for p-interface hardware.
45902       interface-role:
45903         type: string
45904         description: Role specification for p-interface hardware.
45905       interface-type:
45906         type: string
45907         description: Indicates the physical properties of the interface.
45908   p-interfaces:
45909     description: |
45910       Collection of physical interfaces.
45911     properties:
45912       p-interface:
45913         type: array
45914         items:
45915           $ref: "#/patchDefinitions/p-interface"
45916   physical-link:
45917     description: |
45918       Collection of physical connections, typically between p-interfaces
45919       ###### Related Nodes
45920       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
45921
45922       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
45923     required:
45924     - link-name
45925     properties:
45926       link-name:
45927         type: string
45928         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
45929       speed-value:
45930         type: string
45931         description: Captures the numeric part of the speed
45932       speed-units:
45933         type: string
45934         description: Captures the units corresponding to the speed
45935       circuit-id:
45936         type: string
45937         description: Circuit it
45938       dual-mode:
45939         type: string
45940         description: Dual access mode (e.g., primary, secondary
45941       management-option:
45942         type: string
45943         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
45944       service-provider-name:
45945         type: string
45946         description: Name of the service Provider on this link.
45947   physical-links:
45948     description: |
45949       Collection of physical connections, typically between p-interfaces
45950     properties:
45951       physical-link:
45952         type: array
45953         items:
45954           $ref: "#/patchDefinitions/physical-link"
45955   platform:
45956     description: |
45957       describes a platform
45958       ###### Related Nodes
45959       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
45960
45961     required:
45962     - platform-name
45963     properties:
45964       platform-name:
45965         type: string
45966         description: Name of the platform
45967   platforms:
45968     description: |
45969       Collection of platforms
45970     properties:
45971       platform:
45972         type: array
45973         items:
45974           $ref: "#/patchDefinitions/platform"
45975   pnf:
45976     description: |
45977       PNF represents a physical network function. typically equipment used in the D1 world.
45978       ###### Related Nodes
45979       - TO complex( pnf LocatedIn complex, MANY2ONE)
45980       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
45981       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
45982       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
45983
45984       -(1) IF this PNF node is deleted, this FROM node is DELETED also
45985     required:
45986     - pnf-name
45987     - in-maint
45988     properties:
45989       pnf-name:
45990         type: string
45991         description: unique name of Physical Network Function.
45992       pnf-name2:
45993         type: string
45994         description: name of Physical Network Function.
45995       pnf-name2-source:
45996         type: string
45997         description: source of name2
45998       pnf-id:
45999         type: string
46000         description: id of pnf
46001       equip-type:
46002         type: string
46003         description: Equipment type.  Source of truth should define valid values.
46004       equip-vendor:
46005         type: string
46006         description: Equipment vendor.  Source of truth should define valid values.
46007       equip-model:
46008         type: string
46009         description: Equipment model.  Source of truth should define valid values.
46010       management-option:
46011         type: string
46012         description: identifier of managed by company or customer
46013       ipaddress-v4-oam:
46014         type: string
46015         description: ipv4-oam-address with new naming convention for IP addresses
46016       sw-version:
46017         type: string
46018         description: sw-version is the version of SW for the hosted application on the PNF.
46019       orchestration-status:
46020         type: string
46021         description: orchestration-status is the status of orchestration on the PNF.
46022       in-maint:
46023         type: boolean
46024         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
46025       frame-id:
46026         type: string
46027         description: ID of the physical frame (relay rack) where pnf is installed.
46028   pnfs:
46029     description: |
46030       Collection of Physical Network Functions.
46031     properties:
46032       pnf:
46033         type: array
46034         items:
46035           $ref: "#/patchDefinitions/pnf"
46036   port-group:
46037     description: |
46038       Used to capture the network interfaces of this VCE
46039       ###### Related Nodes
46040       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
46041       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
46042
46043       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
46044       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
46045     required:
46046     - interface-id
46047     - orchestration-status
46048     properties:
46049       interface-id:
46050         type: string
46051         description: Unique ID of the interface
46052       neutron-network-id:
46053         type: string
46054         description: Neutron network id of this Interface
46055       neutron-network-name:
46056         type: string
46057         description: Neutron network name of this Interface
46058       interface-role:
46059         type: string
46060         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46061   port-groups:
46062     properties:
46063       port-group:
46064         type: array
46065         items:
46066           $ref: "#/patchDefinitions/port-group"
46067   project:
46068     description: |
46069       describes the project
46070       ###### Related Nodes
46071       - TO service-instance( project Uses service-instance, ONE2MANY)
46072
46073     required:
46074     - project-name
46075     properties:
46076       project-name:
46077         type: string
46078         description: Name of the project deploying a service
46079   projects:
46080     description: |
46081       Collection of projects
46082     properties:
46083       project:
46084         type: array
46085         items:
46086           $ref: "#/patchDefinitions/project"
46087   properties:
46088     description: |
46089       Property holder for query properties or instance properties
46090     properties:
46091       property-name:
46092         type: string
46093       property-value:
46094         type: string
46095   property-constraint:
46096     description: |
46097       TBD
46098       ###### Related Nodes
46099       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
46100
46101       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
46102     required:
46103     - property-constraint-uuid
46104     - constraint-type
46105     - property-name
46106     - property-value
46107     properties:
46108       property-constraint-uuid:
46109         type: string
46110       constraint-type:
46111         type: string
46112       property-name:
46113         type: string
46114       property-value:
46115         type: string
46116   property-constraints:
46117     properties:
46118       property-constraint:
46119         type: array
46120         items:
46121           $ref: "#/patchDefinitions/property-constraint"
46122   pserver:
46123     description: |
46124       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
46125       ###### Related Nodes
46126       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
46127       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
46128       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
46129       - TO complex( pserver LocatedIn complex, MANY2ONE)
46130       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
46131       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
46132       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
46133       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
46134       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
46135
46136       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
46137       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
46138
46139     required:
46140     - hostname
46141     - in-maint
46142     properties:
46143       hostname:
46144         type: string
46145         description: Value from executing hostname on the compute node.
46146       ptnii-equip-name:
46147         type: string
46148         description: PTNII name
46149       number-of-cpus:
46150         type: integer
46151         format: int32
46152         description: Number of cpus
46153       disk-in-gigabytes:
46154         type: integer
46155         format: int32
46156         description: Disk size, in GBs
46157       ram-in-megabytes:
46158         type: integer
46159         format: int32
46160         description: RAM size, in MBs
46161       equip-type:
46162         type: string
46163         description: Equipment type.  Source of truth should define valid values.
46164       equip-vendor:
46165         type: string
46166         description: Equipment vendor.  Source of truth should define valid values.
46167       equip-model:
46168         type: string
46169         description: Equipment model.  Source of truth should define valid values.
46170       fqdn:
46171         type: string
46172         description: Fully-qualified domain name
46173       pserver-selflink:
46174         type: string
46175         description: URL to endpoint where AAI can get more details
46176       ipv4-oam-address:
46177         type: string
46178         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
46179       serial-number:
46180         type: string
46181         description: Serial number, may be queried
46182       pserver-id:
46183         type: string
46184         description: ID of Pserver
46185       internet-topology:
46186         type: string
46187         description: internet topology of Pserver
46188       in-maint:
46189         type: boolean
46190         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
46191   pservers:
46192     description: |
46193       Collection of compute hosts.
46194     properties:
46195       pserver:
46196         type: array
46197         items:
46198           $ref: "#/patchDefinitions/pserver"
46199   query-parameters:
46200     description: |
46201       QueryParameters for performing a named-query or model query
46202     properties:
46203       named-query:
46204         type: object
46205         $ref: "#/patchDefinitions/named-query"
46206       model:
46207         type: object
46208         $ref: "#/patchDefinitions/model"
46209   related-lookup:
46210     description: |
46211       TBD
46212       ###### Related Nodes
46213       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
46214
46215       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
46216     required:
46217     - related-lookup-uuid
46218     - source-node-type
46219     - source-node-property
46220     - target-node-type
46221     - target-node-property
46222     properties:
46223       related-lookup-uuid:
46224         type: string
46225       source-node-type:
46226         type: string
46227       source-node-property:
46228         type: string
46229       target-node-type:
46230         type: string
46231       target-node-property:
46232         type: string
46233       property-collect-list:
46234         type: string
46235   related-lookups:
46236     properties:
46237       related-lookup:
46238         type: array
46239         items:
46240           $ref: "#/patchDefinitions/related-lookup"
46241   related-to-property:
46242     properties:
46243       property-key:
46244         type: string
46245         description: Key part of a key/value pair
46246       property-value:
46247         type: string
46248         description: Value part of a key/value pair
46249   relationship:
46250     properties:
46251       related-to:
46252         type: string
46253         description: A keyword provided by A&AI to indicate type of node.
46254       related-link:
46255         type: string
46256         description: URL to the object in A&AI.
46257       relationship-data:
46258         type: array
46259         items:
46260           $ref: "#/patchDefinitions/relationship-data"
46261       related-to-property:
46262         type: array
46263         items:
46264           $ref: "#/patchDefinitions/related-to-property"
46265   relationship-data:
46266     required:
46267     - relationship-key
46268     - relationship-value
46269     properties:
46270       relationship-key:
46271         type: string
46272         description: A keyword provided by A&AI to indicate an attribute.
46273       relationship-value:
46274         type: string
46275         description: Value of the attribute.
46276   reserved-prop-names:
46277     description: |
46278       Internal map to define some reserved properties of a vertex
46279     properties:
46280       last-mod-source-of-truth:
46281         type: string
46282       aai-node-type:
46283         type: string
46284       aai-created-ts:
46285         type: integer
46286         format: int64
46287       aai-unique-key:
46288         type: string
46289       aai-last-mod-ts:
46290         type: integer
46291         format: int64
46292       source-of-truth:
46293         type: string
46294   response-list:
46295     description: |
46296       Response container for the results of a named-query or model query
46297     properties:
46298       inventory-response-items:
46299         type: object
46300         $ref: "#/patchDefinitions/inventory-response-items"
46301   result-data:
46302     properties:
46303       resource-type:
46304         type: string
46305         description: The specific type of node in the A&AI graph
46306       resource-link:
46307         type: string
46308         description: The URL to the specific resource
46309   route-table-reference:
46310     description: |
46311       Openstack route table reference.
46312       ###### Related Nodes
46313       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
46314
46315     required:
46316     - route-table-reference-id
46317     - route-table-reference-fqdn
46318     properties:
46319       route-table-reference-id:
46320         type: string
46321         description: Route Table Reference id, UUID assigned to this instance.
46322       route-table-reference-fqdn:
46323         type: string
46324         description: FQDN entry in the route table.
46325   route-table-references:
46326     description: |
46327       Collection of openstack route table references
46328     properties:
46329       route-table-reference:
46330         type: array
46331         items:
46332           $ref: "#/patchDefinitions/route-table-reference"
46333   route-target:
46334     description: |
46335       Route target information
46336       ###### Related Nodes
46337       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
46338
46339       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
46340     required:
46341     - global-route-target
46342     - route-target-role
46343     properties:
46344       global-route-target:
46345         type: string
46346         description: Number used to identify an RT, globally unique in the network
46347       route-target-role:
46348         type: string
46349         description: Role assigned to this route target
46350   route-targets:
46351     description: |
46352       Collection of route target information
46353     properties:
46354       route-target:
46355         type: array
46356         items:
46357           $ref: "#/patchDefinitions/route-target"
46358   routing-instance:
46359     description: |
46360       ###### Related Nodes
46361       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
46362       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
46363
46364       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
46365       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
46366     required:
46367     - routing-instance-id
46368     properties:
46369       routing-instance-id:
46370         type: string
46371         description: Unique id of routing instance
46372       rpm-owner:
46373         type: string
46374         description: rpm owner
46375   routing-instances:
46376     description: |
46377       set of probes related to generic-vnf routing instance
46378     properties:
46379       routing-instance:
46380         type: array
46381         items:
46382           $ref: "#/patchDefinitions/routing-instance"
46383   sdn-zone-response:
46384     properties:
46385       oam-networks:
46386         type: object
46387         $ref: "#/patchDefinitions/oam-networks"
46388       az-and-dvs-switches:
46389         type: array
46390         items:
46391           $ref: "#/patchDefinitions/az-and-dvs-switches"
46392   search:
46393     properties:
46394       edge-tag-query-result:
46395         type: object
46396         $ref: "#/patchDefinitions/edge-tag-query-result"
46397       edge-tag-query-request:
46398         type: object
46399         $ref: "#/patchDefinitions/edge-tag-query-request"
46400       search-results:
46401         type: object
46402         $ref: "#/patchDefinitions/search-results"
46403       sdn-zone-response:
46404         type: object
46405         $ref: "#/patchDefinitions/sdn-zone-response"
46406   search-results:
46407     properties:
46408       result-data:
46409         type: array
46410         items:
46411           $ref: "#/patchDefinitions/result-data"
46412   secondary-filt:
46413     description: |
46414       SecondaryFilt for performing a named-query or model query
46415   secondary-filter:
46416     properties:
46417       property-name:
46418         type: string
46419       filter-type:
46420         type: string
46421       property-value:
46422         type: string
46423   secondary-filts:
46424     description: |
46425       SecondaryFilts for performing a named-query or model query
46426     properties:
46427       secondary-filt:
46428         type: array
46429         items:
46430           $ref: "#/patchDefinitions/secondary-filt"
46431   segmentation-assignment:
46432     description: |
46433       Openstack segmentation assignment.
46434       ###### Related Nodes
46435       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
46436
46437       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
46438     required:
46439     - segmentation-id
46440     properties:
46441       segmentation-id:
46442         type: string
46443         description: Route Table Reference id, UUID assigned to this instance.
46444   segmentation-assignments:
46445     description: |
46446       Collection of openstack segmentation assignments
46447     properties:
46448       segmentation-assignment:
46449         type: array
46450         items:
46451           $ref: "#/patchDefinitions/segmentation-assignment"
46452   service:
46453     description: |
46454       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
46455     required:
46456     - service-id
46457     - service-description
46458     properties:
46459       service-id:
46460         type: string
46461         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
46462       service-description:
46463         type: string
46464         description: Description of the service
46465       service-selflink:
46466         type: string
46467         description: URL to endpoint where AAI can get more details
46468   service-capabilities:
46469     description: |
46470       Collection of service capabilities.
46471     properties:
46472       service-capability:
46473         type: array
46474         items:
46475           $ref: "#/patchDefinitions/service-capability"
46476   service-capability:
46477     description: |
46478       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
46479       ###### Related Nodes
46480       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
46481       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
46482
46483       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
46484
46485     required:
46486     - service-type
46487     - vnf-type
46488     properties:
46489       service-type:
46490         type: string
46491         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
46492       vnf-type:
46493         type: string
46494         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
46495   service-design-and-creation:
46496     description: |
46497       Namespace for objects managed by ASDC
46498     properties:
46499       vnf-images:
46500         type: array
46501         items:
46502           $ref: "#/patchDefinitions/vnf-image"
46503       services:
46504         type: array
46505         items:
46506           $ref: "#/patchDefinitions/service"
46507       service-capabilities:
46508         type: array
46509         items:
46510           $ref: "#/patchDefinitions/service-capability"
46511       models:
46512         type: array
46513         items:
46514           $ref: "#/patchDefinitions/model"
46515       named-queries:
46516         type: array
46517         items:
46518           $ref: "#/patchDefinitions/named-query"
46519   service-instance:
46520     description: |
46521       Instance of a service
46522       ###### Related Nodes
46523       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
46524       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
46525       - TO connector( service-instance Uses connector, MANY2MANY)
46526       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
46527       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
46528       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
46529       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
46530       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
46531       - TO vce( service-instance ComposedOf vce, ONE2MANY)
46532       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
46533       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
46534
46535       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
46536       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
46537       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
46538     required:
46539     - service-instance-id
46540     properties:
46541       service-instance-id:
46542         type: string
46543         description: Uniquely identifies this instance of a service
46544       service-instance-name:
46545         type: string
46546         description: This field will store a name assigned to the service-instance.
46547       persona-model-id:
46548         type: string
46549         description: the ASDC model id for this resource or service model.
46550       persona-model-version:
46551         type: string
46552         description: the ASDC model version for this resource or service model.
46553       model-version-id:
46554         type: string
46555         description: the ASDC model version for this resource or service model.
46556       widget-model-id:
46557         type: string
46558         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46559       widget-model-version:
46560         type: string
46561         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46562       bandwidth-total:
46563         type: string
46564         description: Indicates the total bandwidth to be used for this service.
46565       bandwidth-up-wan1:
46566         type: string
46567         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
46568       bandwidth-down-wan1:
46569         type: string
46570         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
46571       bandwidth-up-wan2:
46572         type: string
46573         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
46574       bandwidth-down-wan2:
46575         type: string
46576         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
46577       vhn-portal-url:
46578         type: string
46579         description: URL customers will use to access the vHN Portal.
46580       service-instance-location-id:
46581         type: string
46582         description: An identifier that customers assign to the location where this service is being used.
46583   service-instances:
46584     description: |
46585       Collection of service instances
46586     properties:
46587       service-instance:
46588         type: array
46589         items:
46590           $ref: "#/patchDefinitions/service-instance"
46591   service-subscription:
46592     description: |
46593       Object that group service instances.
46594       ###### Related Nodes
46595       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
46596       - TO tenant( service-subscription Uses tenant, MANY2MANY)
46597       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
46598
46599       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
46600       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
46601     required:
46602     - service-type
46603     properties:
46604       service-type:
46605         type: string
46606         description: Value defined by orchestration to identify this service across ECOMP.
46607       temp-ub-sub-account-id:
46608         type: string
46609         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
46610   service-subscriptions:
46611     description: |
46612       Collection of objects that group service instances.
46613     properties:
46614       service-subscription:
46615         type: array
46616         items:
46617           $ref: "#/patchDefinitions/service-subscription"
46618   services:
46619     description: |
46620       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
46621     properties:
46622       service:
46623         type: array
46624         items:
46625           $ref: "#/patchDefinitions/service"
46626   site-pair:
46627     description: |
46628       ###### Related Nodes
46629       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
46630       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
46631
46632       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
46633       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
46634     required:
46635     - site-pair-id
46636     properties:
46637       site-pair-id:
46638         type: string
46639         description: unique identifier of probe
46640       source-ip:
46641         type: string
46642         description: Prefix address
46643       destination-ip:
46644         type: string
46645         description: Prefix address
46646       ip-version:
46647         type: string
46648         description: ip version, v4, v6
46649       destination-hostname:
46650         type: string
46651         description: Hostname of the destination equipment to which SLAs are measured against.
46652       destination-equip-type:
46653         type: string
46654         description: The type of destinatination equipment. Could be Router, etc.
46655   site-pair-set:
46656     description: |
46657       Set of instances for probes used to measure service level agreements
46658       ###### Related Nodes
46659       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
46660       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
46661
46662       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
46663     required:
46664     - site-pair-set-id
46665     properties:
46666       site-pair-set-id:
46667         type: string
46668         description: Unique id of site pair set.
46669   site-pair-sets:
46670     description: |
46671       Collection of sets of instances for probes related to generic-vnf
46672     properties:
46673       site-pair-set:
46674         type: array
46675         items:
46676           $ref: "#/patchDefinitions/site-pair-set"
46677   site-pairs:
46678     description: |
46679       probe within a set
46680     properties:
46681       site-pair:
46682         type: array
46683         items:
46684           $ref: "#/patchDefinitions/site-pair"
46685   snapshot:
46686     description: |
46687       Openstack snapshot
46688       ###### Related Nodes
46689       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
46690       - FROM vserver( vserver Uses snapshot, ONE2ONE)
46691
46692     required:
46693     - snapshot-id
46694     properties:
46695       snapshot-id:
46696         type: string
46697         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
46698       snapshot-name:
46699         type: string
46700         description: Snapshot name
46701       snapshot-architecture:
46702         type: string
46703         description: Operating system architecture
46704       snapshot-os-distro:
46705         type: string
46706         description: The common name of the operating system distribution in lowercase
46707       snapshot-os-version:
46708         type: string
46709         description: The operating system version as specified by the distributor.
46710       application:
46711         type: string
46712         description: The application that the image instantiates.
46713       application-vendor:
46714         type: string
46715         description: The vendor of the application.
46716       application-version:
46717         type: string
46718         description: The version of the application.
46719       snapshot-selflink:
46720         type: string
46721         description: URL to endpoint where AAI can get more details
46722       prev-snapshot-id:
46723         type: string
46724         description: This field contains the UUID of the previous snapshot (if any).
46725   snapshots:
46726     description: |
46727       Collection of openstack snapshots
46728     properties:
46729       snapshot:
46730         type: array
46731         items:
46732           $ref: "#/patchDefinitions/snapshot"
46733   sriov-pf:
46734     description: |
46735       SR-IOV Physical Function
46736       ###### Related Nodes
46737       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
46738       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
46739
46740       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
46741     required:
46742     - pf-pci-id
46743     properties:
46744       pf-pci-id:
46745         type: string
46746         description: Identifier for the sriov-pf
46747   sriov-pfs:
46748     description: |
46749       Collection of SR-IOV Physical Functions.
46750     properties:
46751       sriov-pf:
46752         type: array
46753         items:
46754           $ref: "#/patchDefinitions/sriov-pf"
46755   sriov-vf:
46756     description: |
46757       SR-IOV Virtual Function (not to be confused with virtual network function)
46758       ###### Related Nodes
46759       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
46760
46761       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
46762     required:
46763     - pci-id
46764     properties:
46765       pci-id:
46766         type: string
46767         description: PCI ID used to identify the sriov-vf
46768       vf-vlan-filter:
46769         type: string
46770         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
46771       vf-mac-filter:
46772         type: string
46773         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
46774       vf-vlan-strip:
46775         type: boolean
46776         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
46777       vf-vlan-anti-spoof-check:
46778         type: boolean
46779         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.
46780       vf-mac-anti-spoof-check:
46781         type: boolean
46782         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.
46783       vf-mirrors:
46784         type: string
46785         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
46786       vf-broadcast-allow:
46787         type: boolean
46788         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
46789       vf-unknown-multicast-allow:
46790         type: boolean
46791         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
46792       vf-unknown-unicast-allow:
46793         type: boolean
46794         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
46795       vf-insert-stag:
46796         type: boolean
46797         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
46798       vf-link-status:
46799         type: string
46800         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
46801   sriov-vfs:
46802     description: |
46803       Collection of SR-IOV Virtual Functions.
46804     properties:
46805       sriov-vf:
46806         type: array
46807         items:
46808           $ref: "#/patchDefinitions/sriov-vf"
46809   start-node-filter:
46810     properties:
46811       property-name:
46812         type: string
46813       property-value:
46814         type: string
46815   subnet:
46816     description: |
46817       ###### Related Nodes
46818       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
46819       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
46820       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
46821
46822       -(4) IF this TO node is deleted, this SUBNET is DELETED also
46823       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
46824
46825     required:
46826     - subnet-id
46827     - dhcp-enabled
46828     properties:
46829       subnet-id:
46830         type: string
46831         description: Subnet ID, should be UUID.
46832       subnet-name:
46833         type: string
46834         description: Name associated with the subnet.
46835       neutron-subnet-id:
46836         type: string
46837         description: Neutron id of this subnet
46838       gateway-address:
46839         type: string
46840         description: gateway ip address
46841       network-start-address:
46842         type: string
46843         description: network start address
46844       cidr-mask:
46845         type: string
46846         description: cidr mask
46847       ip-version:
46848         type: string
46849         description: ip version
46850       orchestration-status:
46851         type: string
46852         description: Orchestration status of this VNF, mastered by MSO
46853       dhcp-enabled:
46854         type: boolean
46855         description: dhcp enabled
46856       dhcp-start:
46857         type: string
46858         description: the start address reserved for use by dhcp
46859       dhcp-end:
46860         type: string
46861         description: the last address reserved for use by dhcp
46862   subnets:
46863     properties:
46864       subnet:
46865         type: array
46866         items:
46867           $ref: "#/patchDefinitions/subnet"
46868   tagged-inventory-item-list:
46869     properties:
46870       inventory-item:
46871         type: array
46872         items:
46873           $ref: "#/patchDefinitions/inventory-item"
46874   tenant:
46875     description: |
46876       Openstack tenant
46877       ###### Related Nodes
46878       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
46879       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
46880       - TO l3-network( tenant Uses l3-network, MANY2MANY)
46881       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
46882       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
46883       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
46884
46885       -TENANT cannot be deleted if related to VSERVER
46886
46887     required:
46888     - tenant-id
46889     - tenant-name
46890     properties:
46891       tenant-id:
46892         type: string
46893         description: Unique id relative to the cloud-region.
46894       tenant-name:
46895         type: string
46896         description: Readable name of tenant
46897   tenants:
46898     description: |
46899       Collection of openstack tenants.
46900     properties:
46901       tenant:
46902         type: array
46903         items:
46904           $ref: "#/patchDefinitions/tenant"
46905   tunnel-xconnect:
46906     description: |
46907       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
46908       ###### Related Nodes
46909       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
46910
46911       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
46912     required:
46913     - id
46914     - bandwidth-up-wan1
46915     - bandwidth-down-wan1
46916     - bandwidth-up-wan2
46917     - bandwidth-down-wan2
46918     properties:
46919       id:
46920         type: string
46921         description: Allotted Resource id UUID assigned to this instance.
46922       bandwidth-up-wan1:
46923         type: string
46924         description: The WAN uplink bandwidth for WAN1
46925       bandwidth-down-wan1:
46926         type: string
46927         description: The WAN downlink bandwidth for WAN1
46928       bandwidth-up-wan2:
46929         type: string
46930         description: The WAN uplink bandwidth for WAN2
46931       bandwidth-down-wan2:
46932         type: string
46933         description: The WAN downlink bandwidth for WAN2
46934   tunnel-xconnects:
46935     description: |
46936       This object is used to store the specific tunnel cross connect aspects of an allotted resource
46937     properties:
46938       tunnel-xconnect:
46939         type: array
46940         items:
46941           $ref: "#/patchDefinitions/tunnel-xconnect"
46942   update:
46943     description: |
46944       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
46945     required:
46946     - update-node-type
46947     properties:
46948       update-node-type:
46949         type: string
46950       update-node-key:
46951         type: array
46952         items:
46953           $ref: "#/patchDefinitions/update-node-key"
46954       update-node-uri:
46955         type: string
46956       action:
46957         type: array
46958         items:
46959           $ref: "#/patchDefinitions/action"
46960   update-node-key:
46961     properties:
46962       key-name:
46963         type: string
46964       key-value:
46965         type: string
46966   vce:
46967     description: |
46968       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
46969       ###### Related Nodes
46970       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
46971       - TO complex( vce LocatedIn complex, MANY2MANY)
46972       - TO vserver( vce HostedOn vserver, ONE2MANY)
46973       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
46974       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
46975
46976       -(1) IF this VCE node is deleted, this FROM node is DELETED also
46977     required:
46978     - vnf-id
46979     - vnf-name
46980     - vnf-type
46981     properties:
46982       vnf-id:
46983         type: string
46984         description: Unique id of VNF.  This is unique across the graph.
46985       vnf-name:
46986         type: string
46987         description: Name of VNF.
46988       vnf-name2:
46989         type: string
46990         description: Alternate name of VNF.
46991       vnf-type:
46992         type: string
46993         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
46994       service-id:
46995         type: string
46996         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
46997       regional-resource-zone:
46998         type: string
46999         description: Regional way of organizing pservers, source of truth should define values
47000       prov-status:
47001         type: string
47002         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47003       operational-state:
47004         type: string
47005         description: Indicator for whether the resource is considered operational
47006       license-key:
47007         type: string
47008         description: License key
47009       equipment-role:
47010         type: string
47011         description: Network role being played by this VNF
47012       orchestration-status:
47013         type: string
47014         description: Orchestration status of this VNF, mastered by MSO
47015       heat-stack-id:
47016         type: string
47017         description: Heat stack id corresponding to this instance, managed by MSO
47018       mso-catalog-key:
47019         type: string
47020         description: Corresponds to the SDN-C catalog id used to configure this VCE
47021       vpe-id:
47022         type: string
47023         description: Unique ID of VPE connected to this VCE.
47024       v6-vce-wan-address:
47025         type: string
47026         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
47027       ipv4-oam-address:
47028         type: string
47029         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
47030   vces:
47031     description: |
47032       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
47033     properties:
47034       vce:
47035         type: array
47036         items:
47037           $ref: "#/patchDefinitions/vce"
47038   vf-module:
47039     description: |
47040       a deployment unit of VNFCs
47041       ###### Related Nodes
47042       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
47043       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
47044       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
47045       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
47046       - TO vserver( vf-module Uses vserver, ONE2MANY)
47047
47048       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
47049       -VF-MODULE cannot be deleted if related to VNFC
47050
47051     required:
47052     - vf-module-id
47053     - is-base-vf-module
47054     properties:
47055       vf-module-id:
47056         type: string
47057         description: Unique ID of vf-module.
47058       vf-module-name:
47059         type: string
47060         description: Name of vf-module
47061       heat-stack-id:
47062         type: string
47063         description: Heat stack id corresponding to this instance.
47064       orchestration-status:
47065         type: string
47066         description: orchestration status of this vf-module, mastered by MSO
47067       is-base-vf-module:
47068         type: boolean
47069         description: used to indicate whether or not this object is base vf module
47070   vf-modules:
47071     description: |
47072       Collection of vf-modules, a deployment unit of VNFCs
47073     properties:
47074       vf-module:
47075         type: array
47076         items:
47077           $ref: "#/patchDefinitions/vf-module"
47078   vig-server:
47079     description: |
47080       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
47081       ###### Related Nodes
47082       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
47083
47084       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
47085     required:
47086     - vig-address-type
47087     properties:
47088       vig-address-type:
47089         type: string
47090         description: indicates whether the VIG is for AVPN or INTERNET
47091       ipaddress-v4-vig:
47092         type: string
47093         description: v4 IP of the vig server
47094       ipaddress-v6-vig:
47095         type: string
47096         description: v6 IP of the vig server
47097   vig-servers:
47098     properties:
47099       vig-server:
47100         type: array
47101         items:
47102           $ref: "#/patchDefinitions/vig-server"
47103   vip-ipv4-address-list:
47104     description: |
47105       IPv4 Address Range
47106       ###### Related Nodes
47107       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47108       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
47109       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
47110       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
47111
47112     required:
47113     - vip-ipv4-address
47114     properties:
47115       vip-ipv4-address:
47116         type: string
47117         description: IP address
47118       vip-ipv4-prefix-length:
47119         type: integer
47120         format: int64
47121         description: Prefix length, 32 for single address
47122       vlan-id-inner:
47123         type: integer
47124         format: int64
47125         description: Inner VLAN tag
47126       vlan-id-outer:
47127         type: integer
47128         format: int64
47129         description: Outer VLAN tag
47130       is-floating:
47131         type: boolean
47132         description: Indicator of fixed or floating address
47133   vip-ipv6-address-list:
47134     description: |
47135       IPv6 Address Range
47136       ###### Related Nodes
47137       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47138       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
47139       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
47140       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
47141
47142     required:
47143     - vip-ipv6-address
47144     properties:
47145       vip-ipv6-address:
47146         type: string
47147         description: IP address
47148       vip-ipv6-prefix-length:
47149         type: integer
47150         format: int64
47151         description: Prefix length, 128 for single address
47152       vlan-id-inner:
47153         type: integer
47154         format: int64
47155         description: Inner VLAN tag
47156       vlan-id-outer:
47157         type: integer
47158         format: int64
47159         description: Outer VLAN tag
47160       is-floating:
47161         type: boolean
47162         description: Indicator of fixed or floating address
47163   virtual-data-center:
47164     description: |
47165       Virtual organization of cloud infrastructure elements in a data center context
47166       ###### Related Nodes
47167       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
47168       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47169       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
47170
47171     required:
47172     - vdc-id
47173     - vdc-name
47174     properties:
47175       vdc-id:
47176         type: string
47177         description: Unique ID of the vdc
47178       vdc-name:
47179         type: string
47180         description: Name of the virtual data center
47181   virtual-data-centers:
47182     description: |
47183       Virtual organization of cloud infrastructure elements in a data center context
47184     properties:
47185       virtual-data-center:
47186         type: array
47187         items:
47188           $ref: "#/patchDefinitions/virtual-data-center"
47189   vlan:
47190     description: |
47191       Definition of vlan
47192       ###### Related Nodes
47193       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
47194       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
47195       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
47196       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
47197       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
47198       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
47199
47200       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
47201       -(2) IF this VLAN node is deleted, this TO node is DELETED also
47202       -(4) IF this TO node is deleted, this VLAN is DELETED also
47203     required:
47204     - vlan-interface
47205     properties:
47206       vlan-interface:
47207         type: string
47208         description: String that identifies the interface
47209       vlan-id-inner:
47210         type: integer
47211         format: int64
47212         description: Inner VLAN tag
47213       vlan-id-outer:
47214         type: integer
47215         format: int64
47216         description: Outer VLAN tag
47217   vlans:
47218     properties:
47219       vlan:
47220         type: array
47221         items:
47222           $ref: "#/patchDefinitions/vlan"
47223   vnf:
47224     description: |
47225       Abstract vnf class
47226     required:
47227     - vnf-id
47228     properties:
47229       vnf-id:
47230         type: string
47231         description: Unique id of VNF.  This is unique across the graph.
47232   vnf-image:
47233     description: |
47234       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
47235       ###### Related Nodes
47236       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
47237
47238       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
47239
47240     required:
47241     - vnf-image-uuid
47242     - application
47243     - application-vendor
47244     properties:
47245       vnf-image-uuid:
47246         type: string
47247         description: Unique ID of this asset
47248       application:
47249         type: string
47250         description: The application that the image instantiates.
47251       application-vendor:
47252         type: string
47253         description: The vendor of the application.
47254       application-version:
47255         type: string
47256         description: The version of the application.
47257       selflink:
47258         type: string
47259         description: URL to endpoint where AAI can get more details
47260   vnf-images:
47261     description: |
47262       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
47263     properties:
47264       vnf-image:
47265         type: array
47266         items:
47267           $ref: "#/patchDefinitions/vnf-image"
47268   vnfc:
47269     description: |
47270       ###### Related Nodes
47271       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
47272       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
47273       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
47274
47275       -(4) IF this TO node is deleted, this VNFC is DELETED also
47276     required:
47277     - vnfc-name
47278     - vnfc-function-code
47279     - vnfc-type
47280     - in-maint
47281     - is-closed-loop-disabled
47282     properties:
47283       vnfc-name:
47284         type: string
47285         description: Unique ID of vnfc.
47286       vnfc-function-code:
47287         type: string
47288         description: function code
47289       vnfc-type:
47290         type: string
47291         description: type
47292       prov-status:
47293         type: string
47294         description: prov status of this vnfc
47295       orchestration-status:
47296         type: string
47297         description: Orchestration status of this VNF, mastered by APP-C
47298       ipaddress-v4-oam-vip:
47299         type: string
47300         description: Oam V4 vip address of this vnfc
47301       in-maint:
47302         type: boolean
47303         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
47304       is-closed-loop-disabled:
47305         type: boolean
47306         description: used to indicate whether closed loop function is enabled on this node
47307       group-notation:
47308         type: string
47309         description: Group notation of VNFC
47310   vnfcs:
47311     description: |
47312       virtual network components associated with a vserver from application controller.
47313     properties:
47314       vnfc:
47315         type: array
47316         items:
47317           $ref: "#/patchDefinitions/vnfc"
47318   volume:
47319     description: |
47320       Ephemeral Block storage volume.
47321       ###### Related Nodes
47322       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
47323
47324       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
47325     required:
47326     - volume-id
47327     - volume-selflink
47328     properties:
47329       volume-id:
47330         type: string
47331         description: Unique ID of block storage volume relative to the vserver.
47332       volume-selflink:
47333         type: string
47334         description: URL to endpoint where AAI can get more details
47335   volume-group:
47336     description: |
47337       Persistent block-level storage.
47338       ###### Related Nodes
47339       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
47340       - TO complex( volume-group LocatedIn complex, MANY2ONE)
47341       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
47342       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
47343       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
47344
47345     required:
47346     - volume-group-id
47347     - volume-group-name
47348     - vnf-type
47349     properties:
47350       volume-group-id:
47351         type: string
47352         description: Unique ID of volume-group.
47353       volume-group-name:
47354         type: string
47355         description: Name of the volume group.
47356       heat-stack-id:
47357         type: string
47358         description: Heat stack id corresponding to this volume-group
47359       vnf-type:
47360         type: string
47361         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
47362       orchestration-status:
47363         type: string
47364         description: Orchestration status of this volume-group
47365   volume-groups:
47366     description: |
47367       Collection of persistent block-level storage.
47368     properties:
47369       volume-group:
47370         type: array
47371         items:
47372           $ref: "#/patchDefinitions/volume-group"
47373   volumes:
47374     description: |
47375       Collection of ephemeral Block storage volumes.
47376     properties:
47377       volume:
47378         type: array
47379         items:
47380           $ref: "#/patchDefinitions/volume"
47381   vpls-pe:
47382     description: |
47383       VPLS Provider Edge routers.
47384       ###### Related Nodes
47385       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
47386       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
47387       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
47388       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
47389
47390       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
47391     required:
47392     - equipment-name
47393     properties:
47394       equipment-name:
47395         type: string
47396       prov-status:
47397         type: string
47398         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47399       ipv4-oam-address:
47400         type: string
47401         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).
47402       equipment-role:
47403         type: string
47404         description: Client should send valid enumerated value, e.g., VPLS-PE.
47405       vlan-id-outer:
47406         type: integer
47407         format: int64
47408         description: Temporary location for stag to get to VCE
47409   vpls-pes:
47410     description: |
47411       Collection of VPLS Provider Edge routers
47412     properties:
47413       vpls-pe:
47414         type: array
47415         items:
47416           $ref: "#/patchDefinitions/vpls-pe"
47417   vpn-binding:
47418     description: |
47419       VPN binding
47420       ###### Related Nodes
47421       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
47422
47423       -VPN-BINDING cannot be deleted if related to L3-NETWORK
47424
47425     required:
47426     - vpn-id
47427     - vpn-name
47428     - global-route-target
47429     properties:
47430       vpn-id:
47431         type: string
47432         description: VPN ID, globally unique within A&AI
47433       vpn-name:
47434         type: string
47435         description: VPN Name
47436       global-route-target:
47437         type: string
47438         description: Number used to identify a VPN, globally unique in the network
47439       vpn-platform:
47440         type: string
47441         description: the platform associated with the VPN example AVPN, Mobility
47442   vpn-bindings:
47443     properties:
47444       vpn-binding:
47445         type: array
47446         items:
47447           $ref: "#/patchDefinitions/vpn-binding"
47448   vserver:
47449     description: |
47450       Virtual Servers, aka virtual machine or VM.
47451       ###### Related Nodes
47452       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
47453       - TO flavor( vserver Uses flavor, MANY2ONE)
47454       - TO image( vserver Uses image, MANY2ONE)
47455       - TO pserver( vserver HostedOn pserver, MANY2ONE)
47456       - TO snapshot( vserver Uses snapshot, ONE2ONE)
47457       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
47458       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
47459       - FROM vce( vce HostedOn vserver, ONE2MANY)
47460       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
47461       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
47462       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
47463
47464       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
47465       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
47466     required:
47467     - vserver-id
47468     - vserver-name
47469     - vserver-selflink
47470     - in-maint
47471     - is-closed-loop-disabled
47472     properties:
47473       vserver-id:
47474         type: string
47475         description: Unique identifier for this vserver relative to its tenant
47476       vserver-name:
47477         type: string
47478         description: Name of vserver
47479       vserver-name2:
47480         type: string
47481         description: Alternative name of vserver
47482       prov-status:
47483         type: string
47484         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47485       vserver-selflink:
47486         type: string
47487         description: URL to endpoint where AAI can get more details
47488       in-maint:
47489         type: boolean
47490         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
47491       is-closed-loop-disabled:
47492         type: boolean
47493         description: Used to indicate whether closed loop function is enabled on this node
47494   vservers:
47495     description: |
47496       Collection of virtual Servers, aka virtual machines or VMs.
47497     properties:
47498       vserver:
47499         type: array
47500         items:
47501           $ref: "#/patchDefinitions/vserver"
47502   zone:
47503     description: |
47504       A zone is a grouping of assets in a location homing to the same connections into the CBB
47505       ###### Related Nodes
47506       - TO complex( zone LocatedIn complex, MANY2ONE)
47507       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
47508       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
47509       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
47510
47511     required:
47512     - zone-id
47513     - zone-name
47514     - design-type
47515     - zone-context
47516     properties:
47517       zone-id:
47518         type: string
47519         description: Code assigned by AIC to the zone
47520       zone-name:
47521         type: string
47522         description: English name associated with the zone
47523       design-type:
47524         type: string
47525         description: Design of zone [Medium/Large?]
47526       zone-context:
47527         type: string
47528         description: Context of zone [production/test]
47529       status:
47530         type: string
47531         description: Status of a zone.
47532   zones:
47533     description: |
47534       Collection of zones
47535     properties:
47536       zone:
47537         type: array
47538         items:
47539           $ref: "#/patchDefinitions/zone"
47540 getDefinitions:
47541   action:
47542     properties:
47543       action-type:
47544         type: string
47545       action-data:
47546         type: array
47547         items:
47548           $ref: "#/getDefinitions/action-data"
47549   action-data:
47550     properties:
47551       property-name:
47552         type: string
47553       property-value:
47554         type: string
47555   actions:
47556     description: |
47557       APIs that are more action related than REST (e.g., notify, update).
47558     properties:
47559       update:
47560         type: object
47561         $ref: "#/getDefinitions/update"
47562       notify:
47563         type: object
47564         $ref: "#/getDefinitions/notify"
47565   allotted-resource:
47566     description: |
47567       Represents a slice or partial piece of a resource that gets separately allotted
47568       ###### Related Nodes
47569       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
47570       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
47571       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
47572       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
47573       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
47574       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
47575       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
47576
47577       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
47578       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
47579     required:
47580     - id
47581     properties:
47582       id:
47583         type: string
47584         description: Allotted Resource id UUID assigned to this instance.
47585       description:
47586         type: string
47587         description: The descriptive information assigned to this allotted resource instance
47588       selflink:
47589         type: string
47590         description: Link back to more information in the controller
47591       persona-model-id:
47592         type: string
47593         description: the ASDC model id for this resource or service model.
47594       persona-model-version:
47595         type: string
47596         description: the ASDC model version for this resource or service model.
47597       model-version-id:
47598         type: string
47599         description: the ASDC model version for this resource or service model.
47600       persona-model-customization-id:
47601         type: string
47602         description: captures the id of all the configuration used to customize the resource for the service.
47603       resource-version:
47604         type: string
47605         description: Concurrency value
47606       tunnel-xconnects:
47607         type: array
47608         items:
47609           $ref: "#/getDefinitions/tunnel-xconnect"
47610       relationship-list:
47611         type: array
47612         items:
47613           $ref: "#/getDefinitions/relationship"
47614   allotted-resources:
47615     description: |
47616       This object is used to store slices of services being offered
47617     properties:
47618       allotted-resource:
47619         type: array
47620         items:
47621           $ref: "#/getDefinitions/allotted-resource"
47622   availability-zone:
47623     description: |
47624       Availability zone, a collection of compute hosts/pservers
47625       ###### Related Nodes
47626       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
47627       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
47628       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
47629       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
47630       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
47631       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
47632       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
47633       - FROM vce( vce Uses availability-zone, MANY2MANY)
47634
47635       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
47636       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47637
47638     required:
47639     - availability-zone-name
47640     - hypervisor-type
47641     properties:
47642       availability-zone-name:
47643         type: string
47644         description: Name of the availability zone.  Unique across a cloud region
47645       hypervisor-type:
47646         type: string
47647         description: Type of hypervisor.  Source of truth should define valid values.
47648       operational-state:
47649         type: string
47650         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
47651       resource-version:
47652         type: string
47653         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47654       relationship-list:
47655         type: array
47656         items:
47657           $ref: "#/getDefinitions/relationship"
47658   availability-zones:
47659     description: |
47660       Collection of availability zones
47661     properties:
47662       availability-zone:
47663         type: array
47664         items:
47665           $ref: "#/getDefinitions/availability-zone"
47666   az-and-dvs-switches:
47667     properties:
47668       dvs-switches:
47669         type: object
47670         $ref: "#/getDefinitions/dvs-switches"
47671       availability-zone:
47672         type: object
47673         $ref: "#/getDefinitions/availability-zone"
47674   business:
47675     description: |
47676       Namespace for business related constructs
47677     properties:
47678       connectors:
47679         type: array
47680         items:
47681           $ref: "#/getDefinitions/connector"
47682       customers:
47683         type: array
47684         items:
47685           $ref: "#/getDefinitions/customer"
47686   class-of-service:
47687     description: |
47688       ###### Related Nodes
47689       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
47690
47691       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
47692     required:
47693     - cos
47694     properties:
47695       cos:
47696         type: string
47697         description: unique identifier of probe
47698       probe-id:
47699         type: string
47700         description: identifier of probe
47701       probe-type:
47702         type: string
47703         description: type of probe
47704       resource-version:
47705         type: string
47706         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47707       relationship-list:
47708         type: array
47709         items:
47710           $ref: "#/getDefinitions/relationship"
47711   classes-of-service:
47712     description: |
47713       class-of-service of probe
47714     properties:
47715       class-of-service:
47716         type: array
47717         items:
47718           $ref: "#/getDefinitions/class-of-service"
47719   cloud-infrastructure:
47720     description: |
47721       Namespace for cloud infrastructure.
47722     properties:
47723       complexes:
47724         type: array
47725         items:
47726           $ref: "#/getDefinitions/complex"
47727       cloud-regions:
47728         type: array
47729         items:
47730           $ref: "#/getDefinitions/cloud-region"
47731       network-profiles:
47732         type: array
47733         items:
47734           $ref: "#/getDefinitions/network-profile"
47735       pservers:
47736         type: array
47737         items:
47738           $ref: "#/getDefinitions/pserver"
47739       virtual-data-centers:
47740         type: array
47741         items:
47742           $ref: "#/getDefinitions/virtual-data-center"
47743   cloud-region:
47744     description: |
47745       cloud-region designates an installation of a cloud cluster or region or instantiation.
47746       ###### Related Nodes
47747       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
47748       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
47749       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
47750       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
47751       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
47752       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
47753       - FROM image( image BelongsTo cloud-region, MANY2ONE)
47754       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47755       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47756       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47757       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47758       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47759
47760       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47761       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
47762
47763     required:
47764     - cloud-owner
47765     - cloud-region-id
47766     properties:
47767       cloud-owner:
47768         type: string
47769         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47770       cloud-region-id:
47771         type: string
47772         description: Identifier used by the vendor for the region. Second part of composite key
47773       cloud-type:
47774         type: string
47775         description: Type of the cloud (e.g., openstack)
47776       owner-defined-type:
47777         type: string
47778         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
47779       cloud-region-version:
47780         type: string
47781         description: Software version employed at the site
47782       identity-url:
47783         type: string
47784         description: URL of the keystone identity service
47785       cloud-zone:
47786         type: string
47787         description: Zone where the cloud is homed
47788       complex-name:
47789         type: string
47790         description: complex name for cloud-region instance
47791       resource-version:
47792         type: string
47793         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47794       volume-groups:
47795         type: array
47796         items:
47797           $ref: "#/getDefinitions/volume-group"
47798       tenants:
47799         type: array
47800         items:
47801           $ref: "#/getDefinitions/tenant"
47802       flavors:
47803         type: array
47804         items:
47805           $ref: "#/getDefinitions/flavor"
47806       group-assignments:
47807         type: array
47808         items:
47809           $ref: "#/getDefinitions/group-assignment"
47810       snapshots:
47811         type: array
47812         items:
47813           $ref: "#/getDefinitions/snapshot"
47814       images:
47815         type: array
47816         items:
47817           $ref: "#/getDefinitions/image"
47818       dvs-switches:
47819         type: array
47820         items:
47821           $ref: "#/getDefinitions/dvs-switch"
47822       oam-networks:
47823         type: array
47824         items:
47825           $ref: "#/getDefinitions/oam-network"
47826       availability-zones:
47827         type: array
47828         items:
47829           $ref: "#/getDefinitions/availability-zone"
47830       relationship-list:
47831         type: array
47832         items:
47833           $ref: "#/getDefinitions/relationship"
47834   cloud-regions:
47835     properties:
47836       cloud-region:
47837         type: array
47838         items:
47839           $ref: "#/getDefinitions/cloud-region"
47840   complex:
47841     description: |
47842       Collection of physical locations that can house cloud-regions.
47843       ###### Related Nodes
47844       - TO l3-network( complex Uses l3-network, MANY2MANY)
47845       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47846       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47847       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47848       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47849       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47850       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47851       - FROM vce( vce LocatedIn complex, MANY2MANY)
47852       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47853       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47854
47855       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47856       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
47857
47858     required:
47859     - physical-location-id
47860     - physical-location-type
47861     - street1
47862     - city
47863     - postal-code
47864     - country
47865     - region
47866     properties:
47867       physical-location-id:
47868         type: string
47869         description: Unique identifier for physical location, e.g., CLLI
47870       data-center-code:
47871         type: string
47872         description: Data center code which can be an alternate way to identify a complex
47873       complex-name:
47874         type: string
47875         description: Gamma complex name for LCP instance.
47876       identity-url:
47877         type: string
47878         description: URL of the keystone identity service
47879       resource-version:
47880         type: string
47881         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47882       physical-location-type:
47883         type: string
47884         description: Type, e.g., central office, data center.
47885       street1:
47886         type: string
47887       street2:
47888         type: string
47889       city:
47890         type: string
47891       state:
47892         type: string
47893       postal-code:
47894         type: string
47895       country:
47896         type: string
47897       region:
47898         type: string
47899       latitude:
47900         type: string
47901       longitude:
47902         type: string
47903       elevation:
47904         type: string
47905       lata:
47906         type: string
47907       ctag-pools:
47908         type: array
47909         items:
47910           $ref: "#/getDefinitions/ctag-pool"
47911       relationship-list:
47912         type: array
47913         items:
47914           $ref: "#/getDefinitions/relationship"
47915   complexes:
47916     description: |
47917       Collection of physical locations that can house cloud-regions.
47918     properties:
47919       complex:
47920         type: array
47921         items:
47922           $ref: "#/getDefinitions/complex"
47923   configuration:
47924     description: |
47925       Port Mirror Configuration.
47926       ###### Related Nodes
47927       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47928       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47929       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47930       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47931       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47932
47933       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47934       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47935       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47936     required:
47937     - configuration-id
47938     - configuration-type
47939     - configuration-sub-type
47940     - orchestration-status
47941     - operational-status
47942     - configuration-selflink
47943     - model-customization-id
47944     properties:
47945       configuration-id:
47946         type: string
47947         description: UUID assigned to configuration.
47948       management-option:
47949         type: string
47950         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47951       configuration-name:
47952         type: string
47953         description: Name of the configuration.
47954       configuration-type:
47955         type: string
47956         description: port-mirroring-configuration.
47957       configuration-sub-type:
47958         type: string
47959         description: vprobe, pprobe.
47960       model-invariant-id:
47961         type: string
47962         description: the ASDC model id for this resource or service model.
47963       model-version-id:
47964         type: string
47965         description: the ASDC model version for this resource or service model.
47966       orchestration-status:
47967         type: string
47968         description: Orchestration status of the configuration.
47969       operational-status:
47970         type: string
47971         description: Indicator for whether the resource is considered operational.
47972       configuration-selflink:
47973         type: string
47974         description: URL to endpoint where AAI can get more details from SDN-GC.
47975       model-customization-id:
47976         type: string
47977         description: id of  the configuration used to customize the resource
47978       resource-version:
47979         type: string
47980         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47981       relationship-list:
47982         type: array
47983         items:
47984           $ref: "#/getDefinitions/relationship"
47985       metadata:
47986         type: array
47987         items:
47988           $ref: "#/getDefinitions/metadatum"
47989   configurations:
47990     description: |
47991       Collection of configurations
47992     properties:
47993       configuration:
47994         type: array
47995         items:
47996           $ref: "#/getDefinitions/configuration"
47997   connector:
47998     description: |
47999       Collection of resource instances used to connect a variety of disparate inventory widgets
48000       ###### Related Nodes
48001       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
48002       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
48003       - FROM service-instance( service-instance Uses connector, MANY2MANY)
48004
48005       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
48006     required:
48007     - resource-instance-id
48008     properties:
48009       resource-instance-id:
48010         type: string
48011         description: Unique id of resource instance.
48012       resource-version:
48013         type: string
48014         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48015       persona-model-id:
48016         type: string
48017         description: the ASDC model id for this resource or service model.
48018       persona-model-version:
48019         type: string
48020         description: the ASDC model version for this resource or service model.
48021       model-version-id:
48022         type: string
48023         description: the ASDC model version for this resource or service model.
48024       widget-model-id:
48025         type: string
48026         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48027       widget-model-version:
48028         type: string
48029         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48030       relationship-list:
48031         type: array
48032         items:
48033           $ref: "#/getDefinitions/relationship"
48034       metadata:
48035         type: array
48036         items:
48037           $ref: "#/getDefinitions/metadatum"
48038   connectors:
48039     description: |
48040       Collection of resource instances used to connect a variety of disparate inventory widgets
48041     properties:
48042       connector:
48043         type: array
48044         items:
48045           $ref: "#/getDefinitions/connector"
48046   constrained-element-set:
48047     description: |
48048       This is how we would capture constraints defining allowed sets of elements.
48049       ###### Related Nodes
48050       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
48051       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
48052       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
48053
48054       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
48055       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
48056     required:
48057     - constrained-element-set-uuid
48058     - constraint-type
48059     - check-type
48060     properties:
48061       constrained-element-set-uuid:
48062         type: string
48063       constraint-type:
48064         type: string
48065       check-type:
48066         type: string
48067       resource-version:
48068         type: string
48069       element-choice-sets:
48070         type: array
48071         items:
48072           $ref: "#/getDefinitions/element-choice-set"
48073       relationship-list:
48074         type: array
48075         items:
48076           $ref: "#/getDefinitions/relationship"
48077   constrained-element-sets:
48078     properties:
48079       constrained-element-set:
48080         type: array
48081         items:
48082           $ref: "#/getDefinitions/constrained-element-set"
48083   ctag-assignment:
48084     description: |
48085       ###### Related Nodes
48086       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
48087
48088       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
48089     required:
48090     - vlan-id-inner
48091     properties:
48092       vlan-id-inner:
48093         type: integer
48094         format: int64
48095         description: id.
48096       resource-version:
48097         type: string
48098         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48099       relationship-list:
48100         type: array
48101         items:
48102           $ref: "#/getDefinitions/relationship"
48103   ctag-assignments:
48104     properties:
48105       ctag-assignment:
48106         type: array
48107         items:
48108           $ref: "#/getDefinitions/ctag-assignment"
48109   ctag-pool:
48110     description: |
48111       A collection of C tags (vlan tags) grouped for a specific purpose.
48112       ###### Related Nodes
48113       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
48114       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
48115       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
48116
48117       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
48118     required:
48119     - target-pe
48120     - availability-zone-name
48121     - ctag-pool-purpose
48122     properties:
48123       target-pe:
48124         type: string
48125         description: The Target provider edge router
48126       availability-zone-name:
48127         type: string
48128         description: Name of the availability zone
48129       ctag-pool-purpose:
48130         type: string
48131         description: Describes what the intended purpose of this pool is.
48132       ctag-values:
48133         type: string
48134         description: Comma separated list of ctags
48135       resource-version:
48136         type: string
48137         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48138       relationship-list:
48139         type: array
48140         items:
48141           $ref: "#/getDefinitions/relationship"
48142   ctag-pools:
48143     properties:
48144       ctag-pool:
48145         type: array
48146         items:
48147           $ref: "#/getDefinitions/ctag-pool"
48148   customer:
48149     description: |
48150       customer identifiers to provide linkage back to BSS information.
48151       ###### Related Nodes
48152       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
48153
48154       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
48155     required:
48156     - global-customer-id
48157     - subscriber-name
48158     - subscriber-type
48159     properties:
48160       global-customer-id:
48161         type: string
48162         description: Global customer id used across ECOMP to uniquely identify customer.
48163       subscriber-name:
48164         type: string
48165         description: Subscriber name, an alternate way to retrieve a customer.
48166       subscriber-type:
48167         type: string
48168         description: Subscriber type, a way to provide VID with only the INFRA customers.
48169       resource-version:
48170         type: string
48171         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48172       service-subscriptions:
48173         type: array
48174         items:
48175           $ref: "#/getDefinitions/service-subscription"
48176       relationship-list:
48177         type: array
48178         items:
48179           $ref: "#/getDefinitions/relationship"
48180   customers:
48181     description: |
48182       Collection of customer identifiers to provide linkage back to BSS information.
48183     properties:
48184       customer:
48185         type: array
48186         items:
48187           $ref: "#/getDefinitions/customer"
48188   cvlan-tag-entry:
48189     required:
48190     - cvlan-tag
48191     properties:
48192       cvlan-tag:
48193         type: integer
48194         format: int64
48195         description: See mis-na-virtualization-platform.yang
48196       resource-version:
48197         type: string
48198         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48199       relationship-list:
48200         type: array
48201         items:
48202           $ref: "#/getDefinitions/relationship"
48203   cvlan-tags:
48204     properties:
48205       cvlan-tag-entry:
48206         type: array
48207         items:
48208           $ref: "#/getDefinitions/cvlan-tag-entry"
48209   dvs-switch:
48210     description: |
48211       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.
48212       ###### Related Nodes
48213       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
48214       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
48215
48216     required:
48217     - switch-name
48218     - vcenter-url
48219     properties:
48220       switch-name:
48221         type: string
48222         description: DVS switch name
48223       vcenter-url:
48224         type: string
48225         description: URL used to reach the vcenter
48226       resource-version:
48227         type: string
48228         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48229       relationship-list:
48230         type: array
48231         items:
48232           $ref: "#/getDefinitions/relationship"
48233   dvs-switches:
48234     description: |
48235       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
48236     properties:
48237       dvs-switch:
48238         type: array
48239         items:
48240           $ref: "#/getDefinitions/dvs-switch"
48241   edge-prop-names:
48242     description: |
48243       Internal map to define the properties of an edge and interpret the map EdgeRules
48244     properties:
48245       edgeLabel:
48246         type: string
48247       direction:
48248         type: string
48249       multiplicityRule:
48250         type: string
48251       isParent:
48252         type: boolean
48253       usesResource:
48254         type: boolean
48255       hasDelTarget:
48256         type: boolean
48257       SVC-INFRA:
48258         type: boolean
48259       SVC-INFRA-REV:
48260         type: boolean
48261   edge-tag-query-request:
48262     properties:
48263       edge-tag:
48264         type: string
48265       result-detail:
48266         type: string
48267       start-node-type:
48268         type: string
48269       start-node-filter:
48270         type: array
48271         items:
48272           $ref: "#/getDefinitions/start-node-filter"
48273       include-node-filter:
48274         type: array
48275         items:
48276           $ref: "#/getDefinitions/include-node-filter"
48277       secondary-filter:
48278         type: array
48279         items:
48280           $ref: "#/getDefinitions/secondary-filter"
48281   edge-tag-query-result:
48282     properties:
48283       tagged-inventory-item-list:
48284         type: array
48285         items:
48286           $ref: "#/getDefinitions/tagged-inventory-item-list"
48287   element-choice-set:
48288     description: |
48289       This is how we would capture constraints defining allowed sets of elements.
48290       ###### Related Nodes
48291       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
48292       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
48293
48294       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
48295       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
48296     required:
48297     - element-choice-set-uuid
48298     - element-choice-set-name
48299     properties:
48300       element-choice-set-uuid:
48301         type: string
48302       element-choice-set-name:
48303         type: string
48304       cardinality:
48305         type: string
48306       resource-version:
48307         type: string
48308       model-elements:
48309         type: array
48310         items:
48311           $ref: "#/getDefinitions/model-element"
48312       relationship-list:
48313         type: array
48314         items:
48315           $ref: "#/getDefinitions/relationship"
48316   element-choice-sets:
48317     properties:
48318       element-choice-set:
48319         type: array
48320         items:
48321           $ref: "#/getDefinitions/element-choice-set"
48322   entitlement:
48323     description: |
48324       Metadata for entitlement group.
48325       ###### Related Nodes
48326       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
48327       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
48328
48329       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
48330     required:
48331     - group-uuid
48332     - resource-uuid
48333     properties:
48334       group-uuid:
48335         type: string
48336         description: Unique ID for the entitlement group the resource comes from, should be uuid.
48337       resource-uuid:
48338         type: string
48339         description: Unique ID of an entitlement resource.
48340       resource-version:
48341         type: string
48342         description: Concurrency value
48343       relationship-list:
48344         type: array
48345         items:
48346           $ref: "#/getDefinitions/relationship"
48347   entitlements:
48348     description: |
48349       Entitlements, keyed by group-uuid and resource-uuid, related to license management
48350     properties:
48351       entitlement:
48352         type: array
48353         items:
48354           $ref: "#/getDefinitions/entitlement"
48355   esr-ems:
48356     description: |
48357       Persist EMS address information used by EMS driver.
48358       ###### Related Nodes
48359       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
48360
48361       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
48362     required:
48363     - ems-id
48364     properties:
48365       ems-id:
48366         type: string
48367         description: Unique ID of EMS.
48368       resource-version:
48369         type: string
48370         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48371       esr-system-info-list:
48372         type: object
48373         $ref: "#/getDefinitions/esr-system-info-list"
48374       relationship-list:
48375         type: object
48376         $ref: "#/getDefinitions/relationship-list"
48377   esr-ems-list:
48378     properties:
48379       esr-ems:
48380         type: array
48381         items:
48382           $ref: "#/getDefinitions/esr-ems"
48383   esr-system-info:
48384     description: |
48385       Persist common address information of external systems.
48386       ###### Related Nodes
48387       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
48388       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
48389       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
48390       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
48391
48392       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
48393     required:
48394     - esr-system-info-id
48395     - user-name
48396     - password
48397     - system-type
48398     properties:
48399       esr-system-info-id:
48400         type: string
48401         description: Unique ID of esr system info.
48402       system-name:
48403         type: string
48404         description: name of external system.
48405       type:
48406         type: string
48407         description: type of external systems.
48408       vendor:
48409         type: string
48410         description: vendor of external systems.
48411       version:
48412         type: string
48413         description: version of external systems.
48414       service-url:
48415         type: string
48416         description: url used to access external systems.
48417       user-name:
48418         type: string
48419         description: username used to access external systems.
48420       password:
48421         type: string
48422         description: password used to access external systems.
48423       system-type:
48424         type: string
48425         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48426       protocol:
48427         type: string
48428         description: protocol of third party SDNC, for example netconf/snmp.
48429       ssl-cacert:
48430         type: string
48431         description: ca file content if enabled ssl on auth-url.
48432       ssl-insecure:
48433         type: boolean
48434         description: Whether to verify VIM's certificate.
48435       ip-address:
48436         type: string
48437         description: service IP of ftp server.
48438       port:
48439         type: string
48440         description: service port of ftp server.
48441       cloud-domain:
48442         type: string
48443         description: domain info for authentication.
48444       default-tenant:
48445         type: string
48446         description: default tenant of VIM.
48447       passive:
48448         type: boolean
48449         description: ftp passive mode or not.
48450       remote-path:
48451         type: string
48452         description: resource or performance data file path.
48453       system-status:
48454         type: string
48455         description: the status of external system.
48456       resource-version:
48457         type: string
48458         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48459       relationship-list:
48460         type: array
48461         items:
48462           $ref: "#/getDefinitions/relationship"
48463   esr-system-info-list:
48464     description: |
48465       Collection of persistent block-level external system auth info.
48466     properties:
48467       esr-system-info:
48468         type: array
48469         items:
48470           $ref: "#/getDefinitions/esr-system-info"
48471   esr-thirdparty-sdnc:
48472     description: |
48473       Persist SDNC address information used by ONAP SDNC.
48474       ###### Related Nodes
48475       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
48476       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
48477
48478       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
48479     required:
48480     - thirdparty-sdnc-id
48481     properties:
48482       thirdparty-sdnc-id:
48483         type: string
48484         description: Unique ID of SDNC.
48485       location:
48486         type: string
48487         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48488       product-name:
48489         type: string
48490         description: password used to access SDNC server.
48491       resource-version:
48492         type: string
48493         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48494       esr-system-info-list:
48495         type: object
48496         $ref: "#/getDefinitions/esr-system-info-list"
48497       relationship-list:
48498         type: object
48499         $ref: "#/getDefinitions/relationship-list"
48500   esr-thirdparty-sdnc-list:
48501     properties:
48502       esr-thirdparty-sdnc:
48503         type: array
48504         items:
48505           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
48506   esr-vnfm:
48507     description: |
48508       Persist VNFM address information used by VF-C.
48509       ###### Related Nodes
48510       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
48511
48512       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
48513     required:
48514     - vnfm-id
48515     properties:
48516       vnfm-id:
48517         type: string
48518         description: Unique ID of VNFM.
48519       vim-id:
48520         type: string
48521         description: indecate the VIM to deploy VNF.
48522       certificate-url:
48523         type: string
48524         description: certificate url of VNFM.
48525       resource-version:
48526         type: string
48527         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48528       esr-system-info-list:
48529         type: object
48530         $ref: "#/getDefinitions/esr-system-info-list"
48531       relationship-list:
48532         type: object
48533         $ref: "#/getDefinitions/relationship-list"
48534   esr-vnfm-list:
48535     properties:
48536       esr-vnfm:
48537         type: array
48538         items:
48539           $ref: "#/getDefinitions/esr-vnfm"
48540   evc:
48541     description: |
48542       evc object is an optional child object of the Configuration object.
48543       ###### Related Nodes
48544       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
48545
48546       -(4) IF this TO node is deleted, this EVC is DELETED also
48547     required:
48548     - evc-id
48549     properties:
48550       evc-id:
48551         type: string
48552         description: Unique/key field for the evc object
48553       forwarding-path-topology:
48554         type: string
48555         description: Point-to-Point, Multi-Point
48556       cir-value:
48557         type: string
48558         description: Commited Information Rate
48559       cir-units:
48560         type: string
48561         description: CIR units
48562       connection-diversity-group-id:
48563         type: string
48564         description: Diversity Group ID
48565       service-hours:
48566         type: string
48567         description: formerly Performance Group
48568       esp-evc-circuit-id:
48569         type: string
48570         description: EVC Circuit ID of ESP EVC
48571       esp-evc-cir-value:
48572         type: string
48573         description: Committed Information Rate (For ESP)
48574       esp-evc-cir-units:
48575         type: string
48576         description: CIR units (For ESP)
48577       esp-itu-code:
48578         type: string
48579         description: Identifies ESP
48580       collector-pop-clli:
48581         type: string
48582         description: Collector POP CLLI (from the hostname of the access pnf)
48583       inter-connect-type-ingress:
48584         type: string
48585         description: Interconnect type on ingress side of EVC.
48586       tagmode-access-ingress:
48587         type: string
48588         description: tagode for collector side of EVC
48589       tagmode-access-egress:
48590         type: string
48591         description: tagMode for network side of EVC
48592       relationship-list:
48593         type: array
48594         items:
48595           $ref: "#/getDefinitions/relationship"
48596       resource-version:
48597         type: string
48598         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48599   evcs:
48600     properties:
48601       evc:
48602         type: array
48603         items:
48604           $ref: "#/getDefinitions/evc"
48605   external-system:
48606     description: |
48607       Namespace for external system.
48608     properties:
48609       esr-ems-list:
48610         type: object
48611         $ref: "#/getDefinitions/esr-ems-list"
48612       esr-vnfm-list:
48613         type: object
48614         $ref: "#/getDefinitions/esr-vnfm-list"
48615       esr-thirdparty-sdnc-list:
48616         type: object
48617         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
48618   extra-properties:
48619     description: |
48620       Extra properties for inventory item for response list
48621   extra-property:
48622     properties:
48623       property-name:
48624         type: string
48625   flavor:
48626     description: |
48627       Openstack flavor.
48628       ###### Related Nodes
48629       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
48630       - FROM vserver( vserver Uses flavor, MANY2ONE)
48631
48632       -FLAVOR cannot be deleted if related to VSERVER
48633
48634     required:
48635     - flavor-id
48636     - flavor-name
48637     - flavor-selflink
48638     properties:
48639       flavor-id:
48640         type: string
48641         description: Flavor id, expected to be unique across cloud-region.
48642       flavor-name:
48643         type: string
48644         description: Flavor name
48645       flavor-vcpus:
48646         type: integer
48647         format: int32
48648         description: Number of CPUs
48649       flavor-ram:
48650         type: integer
48651         format: int32
48652         description: Amount of memory
48653       flavor-disk:
48654         type: integer
48655         format: int32
48656         description: Disk space
48657       flavor-ephemeral:
48658         type: integer
48659         format: int32
48660         description: Amount of ephemeral disk space
48661       flavor-swap:
48662         type: string
48663         description: amount of swap space allocation
48664       flavor-is-public:
48665         type: boolean
48666         description: whether flavor is available to all users or private to the tenant it was created in.
48667       flavor-selflink:
48668         type: string
48669         description: URL to endpoint where AAI can get more details
48670       flavor-disabled:
48671         type: boolean
48672         description: Boolean as to whether this flavor is no longer enabled
48673       resource-version:
48674         type: string
48675         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48676       relationship-list:
48677         type: array
48678         items:
48679           $ref: "#/getDefinitions/relationship"
48680   flavors:
48681     description: |
48682       Collection of openstack flavors.
48683     properties:
48684       flavor:
48685         type: array
48686         items:
48687           $ref: "#/getDefinitions/flavor"
48688   forwarder:
48689     description: |
48690       Entity describing a sequenced segment of forwarding path
48691       ###### Related Nodes
48692       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48693       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48694       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48695       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48696       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48697
48698       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48699       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48700     required:
48701     - sequence
48702     properties:
48703       sequence:
48704         type: integer
48705         format: int32
48706         description: Unique ID of this segmentation
48707       forwarder-role:
48708         type: string
48709         description: ingress, intermediate, egress
48710       relationship-list:
48711         type: array
48712         items:
48713           $ref: "#/getDefinitions/relationship"
48714       resource-version:
48715         type: string
48716         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48717   forwarder-evc:
48718     description: |
48719       forwarder object is an optional child object of the Configuration object.
48720       ###### Related Nodes
48721       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48722
48723       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48724     required:
48725     - forwarder-evc-id
48726     properties:
48727       forwarder-evc-id:
48728         type: string
48729         description: Key for forwarder-evc object
48730       circuit-id:
48731         type: string
48732         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48733       ivlan:
48734         type: string
48735         description: Internal VLAN.
48736       svlan:
48737         type: string
48738         description: SVLAN value for ingress of egress forwarder.
48739       cvlan:
48740         type: string
48741         description: CVLAN value for ingress of egress forwarder.
48742       relationship-list:
48743         type: array
48744         items:
48745           $ref: "#/getDefinitions/relationship"
48746       resource-version:
48747         type: string
48748         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48749   forwarder-evcs:
48750     properties:
48751       forwarder-evc:
48752         type: array
48753         items:
48754           $ref: "#/getDefinitions/forwarder-evc"
48755   forwarders:
48756     properties:
48757       forwarder:
48758         type: array
48759         items:
48760           $ref: "#/getDefinitions/forwarder"
48761   forwarding-path:
48762     description: |
48763       Entity that describes the sequenced forwarding path between interfaces of services or resources
48764       ###### Related Nodes
48765       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48766       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48767       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48768
48769       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48770       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48771       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48772     required:
48773     - forwarding-path-id
48774     - forwarding-path-name
48775     properties:
48776       forwarding-path-id:
48777         type: string
48778         description: Unique ID of this FP
48779       forwarding-path-name:
48780         type: string
48781         description: Name of the FP
48782       relationship-list:
48783         type: array
48784         items:
48785           $ref: "#/getDefinitions/relationship"
48786       resource-version:
48787         type: string
48788         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48789       selflink:
48790         type: string
48791         description: the self link for this FP
48792       forwarders:
48793         type: array
48794         items:
48795           $ref: "#/getDefinitions/forwarder"
48796   forwarding-paths:
48797     properties:
48798       forwarding-path:
48799         type: array
48800         items:
48801           $ref: "#/getDefinitions/forwarding-path"
48802   generic-vnf:
48803     description: |
48804       General purpose VNF
48805       ###### Related Nodes
48806       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48807       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48808       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48809       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48810       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48811       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48812       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48813       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48814       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48815       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48816       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48817       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48818       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48819       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48820       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48821       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48822       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48823
48824       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48825     required:
48826     - vnf-id
48827     - vnf-name
48828     - vnf-type
48829     - in-maint
48830     - is-closed-loop-disabled
48831     properties:
48832       vnf-id:
48833         type: string
48834         description: Unique id of VNF.  This is unique across the graph.
48835       vnf-name:
48836         type: string
48837         description: Name of VNF.
48838       vnf-name2:
48839         type: string
48840         description: Alternate name of VNF.
48841       vnf-type:
48842         type: string
48843         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
48844       service-id:
48845         type: string
48846         description: Unique identifier of service from ASDC
48847       regional-resource-zone:
48848         type: string
48849         description: Regional way of organizing pservers, source of truth should define values
48850       prov-status:
48851         type: string
48852         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48853       operational-state:
48854         type: string
48855         description: Indicator for whether the resource is considered operational
48856       license-key:
48857         type: string
48858         description: License key
48859       equipment-role:
48860         type: string
48861         description: Client should send valid enumerated value
48862       orchestration-status:
48863         type: string
48864         description: Orchestration status of this VNF, used by MSO.
48865       heat-stack-id:
48866         type: string
48867         description: Heat stack id corresponding to this instance, managed by MSO
48868       mso-catalog-key:
48869         type: string
48870         description: Corresponds to the SDN-C catalog id used to configure this VCE
48871       management-option:
48872         type: string
48873         description: identifier of managed by company or customer
48874       ipv4-oam-address:
48875         type: string
48876         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48877       ipv4-loopback0-address:
48878         type: string
48879         description: v4 Loopback0 address
48880       nm-lan-v6-address:
48881         type: string
48882         description: v6 Loopback address
48883       management-v6-address:
48884         type: string
48885         description: v6 management address
48886       vcpu:
48887         type: integer
48888         format: int64
48889         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
48890       vcpu-units:
48891         type: string
48892         description: units associated with vcpu, used for VNFs with no vservers/flavors
48893       vmemory:
48894         type: integer
48895         format: int64
48896         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
48897       vmemory-units:
48898         type: string
48899         description: units associated with vmemory, used for VNFs with no vservers/flavors
48900       vdisk:
48901         type: integer
48902         format: int64
48903         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
48904       vdisk-units:
48905         type: string
48906         description: units associated with vdisk, used for VNFs with no vservers/flavors
48907       in-maint:
48908         type: boolean
48909         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48910       is-closed-loop-disabled:
48911         type: boolean
48912         description: used to indicate whether closed loop function is enabled on this node
48913       resource-version:
48914         type: string
48915         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48916       summary-status:
48917         type: string
48918         description: details regarding the generic-vnf operation
48919       encrypted-access-flag:
48920         type: boolean
48921         description: indicates whether generic-vnf access uses SSH
48922       persona-model-id:
48923         type: string
48924         description: the ASDC model id for this resource or service model.
48925       persona-model-version:
48926         type: string
48927         description: the ASDC model version for this resource or service model.
48928       model-version-id:
48929         type: string
48930         description: the ASDC model version for this resource or service model.
48931       widget-model-id:
48932         type: string
48933         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48934       widget-model-version:
48935         type: string
48936         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48937       as-number:
48938         type: string
48939         description: as-number of the VNF
48940       regional-resource-subzone:
48941         type: string
48942         description: represents sub zone of the rr plane
48943       relationship-list:
48944         type: array
48945         items:
48946           $ref: "#/getDefinitions/relationship"
48947       l-interfaces:
48948         type: array
48949         items:
48950           $ref: "#/getDefinitions/l-interface"
48951       lag-interfaces:
48952         type: array
48953         items:
48954           $ref: "#/getDefinitions/lag-interface"
48955       vf-modules:
48956         type: array
48957         items:
48958           $ref: "#/getDefinitions/vf-module"
48959   generic-vnfs:
48960     description: |
48961       Collection of VNFs
48962     properties:
48963       generic-vnf:
48964         type: array
48965         items:
48966           $ref: "#/getDefinitions/generic-vnf"
48967   group-assignment:
48968     description: |
48969       Openstack group-assignment used to store exclusivity groups (EG).
48970       ###### Related Nodes
48971       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48972       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48973       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48974
48975     required:
48976     - group-id
48977     - group-type
48978     - group-name
48979     properties:
48980       group-id:
48981         type: string
48982         description: Group id, expected to be unique across cloud-region.
48983       group-type:
48984         type: string
48985         description: Group type - the type of group this instance refers to
48986       group-name:
48987         type: string
48988         description: Group name - name assigned to the group
48989       group-description:
48990         type: string
48991         description: Group description - description of the group
48992       resource-version:
48993         type: string
48994         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48995       relationship-list:
48996         type: array
48997         items:
48998           $ref: "#/getDefinitions/relationship"
48999   group-assignments:
49000     description: |
49001       Collection of openstack group assignments
49002     properties:
49003       group-assignment:
49004         type: array
49005         items:
49006           $ref: "#/getDefinitions/group-assignment"
49007   host-route:
49008     description: |
49009       ###### Related Nodes
49010       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
49011
49012       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
49013     required:
49014     - host-route-id
49015     - route-prefix
49016     - next-hop
49017     properties:
49018       host-route-id:
49019         type: string
49020         description: host-route id
49021       route-prefix:
49022         type: string
49023         description: subnet prefix
49024       next-hop:
49025         type: string
49026         description: Could be ip-address, hostname, or service-instance
49027       next-hop-type:
49028         type: string
49029         description: Should be ip-address, hostname, or service-instance to match next-hop
49030       resource-version:
49031         type: string
49032         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49033       relationship-list:
49034         type: array
49035         items:
49036           $ref: "#/getDefinitions/relationship"
49037   host-routes:
49038     properties:
49039       host-route:
49040         type: array
49041         items:
49042           $ref: "#/getDefinitions/host-route"
49043   hpa-capabilities:
49044     description: |
49045       Collection of HPA Capabilities
49046     properties:
49047       hpa-capability:
49048         type: array
49049         items:
49050           $ref: "#/getDefinitions/hpa-capability"
49051   hpa-capability:
49052     description: |
49053       Represents a HPA capability
49054       ###### Related Nodes
49055       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
49056       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
49057       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
49058
49059       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
49060     required:
49061     - hpa-capability-id
49062     - hpa-feature
49063     properties:
49064       hpa-capability-id:
49065         type: string
49066         description: UUID to uniquely identify a HPA capability
49067       hpa-feature:
49068         type: string
49069         description: Name of the HPACapability
49070       hpa-version:
49071         type: string
49072         description: HPA schema version
49073       architecture:
49074         type: string
49075         description: Hardware architecture
49076       resource-version:
49077         type: string
49078         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49079       relationship-list:
49080         type: array
49081         items:
49082           $ref: "#/getDefinitions/relationship"
49083       hpa-feature-attributes:
49084         type: array
49085         items:
49086           $ref: "#/getDefinitions/hpa-feature-attributes"
49087   hpa-feature-attributes:
49088     description: |
49089       HPA Capability Feature attributes
49090       ###### Related Nodes
49091       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
49092
49093       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
49094     required:
49095     - hpa-attribute-key
49096     properties:
49097       hpa-attribute-key:
49098         type: string
49099         description: name of the specific HPA attribute
49100       hpa-attribute-value:
49101         type: string
49102         description: JSON string specifying the value, unit and type of the specific HPA attribute
49103       resource-version:
49104         type: string
49105         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49106       relationship-list:
49107         type: array
49108         items:
49109           $ref: "#/getDefinitions/relationship"
49110   image:
49111     description: |
49112       Openstack image.
49113       ###### Related Nodes
49114       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
49115       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
49116       - FROM vserver( vserver Uses image, MANY2ONE)
49117
49118       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
49119       -IMAGE cannot be deleted if related to VSERVER
49120
49121     required:
49122     - image-id
49123     - image-name
49124     - image-os-distro
49125     - image-os-version
49126     - image-selflink
49127     properties:
49128       image-id:
49129         type: string
49130         description: Image id, expected to be unique across cloud region
49131       image-name:
49132         type: string
49133         description: Image name
49134       image-architecture:
49135         type: string
49136         description: Operating system architecture.
49137       image-os-distro:
49138         type: string
49139         description: The common name of the operating system distribution in lowercase
49140       image-os-version:
49141         type: string
49142         description: The operating system version as specified by the distributor.
49143       application:
49144         type: string
49145         description: The application that the image instantiates.
49146       application-vendor:
49147         type: string
49148         description: The vendor of the application.
49149       application-version:
49150         type: string
49151         description: The version of the application.
49152       image-selflink:
49153         type: string
49154         description: URL to endpoint where AAI can get more details
49155       resource-version:
49156         type: string
49157         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49158       relationship-list:
49159         type: array
49160         items:
49161           $ref: "#/getDefinitions/relationship"
49162       metadata:
49163         type: array
49164         items:
49165           $ref: "#/getDefinitions/metadatum"
49166   images:
49167     description: |
49168       Collectio of Openstack images.
49169     properties:
49170       image:
49171         type: array
49172         items:
49173           $ref: "#/getDefinitions/image"
49174   include-node-filter:
49175     properties:
49176       include-node-type:
49177         type: string
49178   instance-filter:
49179     description: |
49180       InstanceFilter for performing a named-query or model query
49181   instance-filters:
49182     description: |
49183       InstanceFilters for performing a named-query or model query
49184     properties:
49185       instance-filter:
49186         type: array
49187         items:
49188           $ref: "#/getDefinitions/instance-filter"
49189   instance-group:
49190     description: |
49191       General mechanism for grouping instances
49192       ###### Related Nodes
49193       - TO model( instance-group Targets model, MANY2MANY)
49194       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
49195       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
49196       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
49197       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
49198
49199     required:
49200     - id
49201     - description
49202     - type
49203     properties:
49204       id:
49205         type: string
49206         description: Instance Group ID, UUID assigned to this instance.
49207       description:
49208         type: string
49209         description: Descriptive text to help identify the usage of this instance-group
49210       type:
49211         type: string
49212         description: Only valid value today is lower case ha for high availability
49213       sub-type:
49214         type: string
49215         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49216       resource-version:
49217         type: string
49218         description: Concurrency value
49219       relationship-list:
49220         type: array
49221         items:
49222           $ref: "#/getDefinitions/relationship"
49223   instance-groups:
49224     description: |
49225       Collection of openstack route table references
49226     properties:
49227       instance-group:
49228         type: array
49229         items:
49230           $ref: "#/getDefinitions/instance-group"
49231   inventory:
49232     properties:
49233       search:
49234         type: object
49235         $ref: "#/getDefinitions/search"
49236       actions:
49237         type: object
49238         $ref: "#/getDefinitions/actions"
49239       cloud-infrastructure:
49240         type: object
49241         $ref: "#/getDefinitions/cloud-infrastructure"
49242       business:
49243         type: object
49244         $ref: "#/getDefinitions/business"
49245       service-design-and-creation:
49246         type: object
49247         $ref: "#/getDefinitions/service-design-and-creation"
49248       network:
49249         type: object
49250         $ref: "#/getDefinitions/network"
49251   inventory-item:
49252     properties:
49253       inventory-item-type:
49254         type: string
49255       inventory-item-link:
49256         type: string
49257       inventory-item-data:
49258         type: array
49259         items:
49260           $ref: "#/getDefinitions/inventory-item-data"
49261       tagged-inventory-item-list:
49262         type: array
49263         items:
49264           $ref: "#/getDefinitions/tagged-inventory-item-list"
49265   inventory-item-data:
49266     properties:
49267       property-name:
49268         type: string
49269       property-value:
49270         type: string
49271   inventory-response-item:
49272     description: |
49273       Inventory item for response list
49274     properties:
49275       model-name:
49276         type: string
49277       extra-properties:
49278         type: object
49279         $ref: "#/getDefinitions/extra-properties"
49280       inventory-response-items:
49281         type: object
49282         $ref: "#/getDefinitions/inventory-response-items"
49283   inventory-response-items:
49284     description: |
49285       Container for inventory items in response list
49286     properties:
49287       inventory-response-item:
49288         type: array
49289         items:
49290           $ref: "#/getDefinitions/inventory-response-item"
49291   ipsec-configuration:
49292     description: |
49293       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
49294       ###### Related Nodes
49295       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
49296       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
49297
49298       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
49299     required:
49300     - ipsec-configuration-id
49301     properties:
49302       ipsec-configuration-id:
49303         type: string
49304         description: UUID of this configuration
49305       requested-vig-address-type:
49306         type: string
49307         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49308       requested-encryption-strength:
49309         type: string
49310         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49311       requested-dmz-type:
49312         type: string
49313         description: can offer a shared DMZ or a DMZ specific to a customer
49314       shared-dmz-network-address:
49315         type: string
49316         description: Network address of shared DMZ
49317       requested-customer-name:
49318         type: string
49319         description: If the DMZ is a custom DMZ, this field will indicate the customer information
49320       ike-version:
49321         type: string
49322         description: can be 1 or 2
49323       ikev1-authentication:
49324         type: string
49325         description: Contains values like md5, sha1, sha256, sha384
49326       ikev1-encryption:
49327         type: string
49328         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49329       ikev1-dh-group:
49330         type: string
49331         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49332       ikev1-am-group-id:
49333         type: string
49334         description: Group name defined in VIG for clients using aggressive mode
49335       ikev1-am-password:
49336         type: string
49337         description: pre-shared key for the above group name
49338       ikev1-sa-lifetime:
49339         type: string
49340         description: Lifetime for IKEv1 SA
49341       ipsec-authentication:
49342         type: string
49343         description: md5, sha1, sha256, sha384
49344       ipsec-encryption:
49345         type: string
49346         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49347       ipsec-sa-lifetime:
49348         type: string
49349         description: Life time for IPSec SA
49350       ipsec-pfs:
49351         type: string
49352         description: enable PFS or not
49353       xauth-userid:
49354         type: string
49355         description: user ID for xAuth, sm-user, ,nmteHostName
49356       xauth-user-password:
49357         type: string
49358         description: Encrypted using the Juniper $9$ algorithm
49359       dpd-interval:
49360         type: string
49361         description: The time between DPD probe
49362       dpd-frequency:
49363         type: string
49364         description: Maximum number of DPD before claiming the tunnel is down
49365       resource-version:
49366         type: string
49367         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49368       relationship-list:
49369         type: array
49370         items:
49371           $ref: "#/getDefinitions/relationship"
49372       vig-servers:
49373         type: array
49374         items:
49375           $ref: "#/getDefinitions/vig-server"
49376   ipsec-configurations:
49377     properties:
49378       ipsec-configuration:
49379         type: array
49380         items:
49381           $ref: "#/getDefinitions/ipsec-configuration"
49382   key-data:
49383     properties:
49384       key-name:
49385         type: string
49386       key-value:
49387         type: string
49388   l-interface:
49389     description: |
49390       Logical interfaces, e.g., a vnic.
49391       ###### Related Nodes
49392       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
49393       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
49394       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
49395       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
49396       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
49397       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
49398       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
49399       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
49400       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
49401       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
49402
49403       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
49404       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
49405       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
49406     required:
49407     - interface-name
49408     properties:
49409       interface-name:
49410         type: string
49411         description: Name given to the interface
49412       interface-role:
49413         type: string
49414         description: E.g., CUSTOMER, UPLINK, etc.
49415       v6-wan-link-ip:
49416         type: string
49417         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49418       selflink:
49419         type: string
49420         description: URL to endpoint where AAI can get more details
49421       interface-id:
49422         type: string
49423         description: ID of interface
49424       macaddr:
49425         type: string
49426         description: MAC address for the interface
49427       network-name:
49428         type: string
49429         description: Name of the network
49430       management-option:
49431         type: string
49432         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49433       resource-version:
49434         type: string
49435         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49436       vlans:
49437         type: array
49438         items:
49439           $ref: "#/getDefinitions/vlan"
49440       sriov-vfs:
49441         type: array
49442         items:
49443           $ref: "#/getDefinitions/sriov-vf"
49444       relationship-list:
49445         type: array
49446         items:
49447           $ref: "#/getDefinitions/relationship"
49448       l3-interface-ipv4-address-list:
49449         type: array
49450         items:
49451           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49452       l3-interface-ipv6-address-list:
49453         type: array
49454         items:
49455           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
49456   l-interfaces:
49457     description: |
49458       Collection of logical interfaces.
49459     properties:
49460       l-interface:
49461         type: array
49462         items:
49463           $ref: "#/getDefinitions/l-interface"
49464   l3-interface-ipv4-address-list:
49465     description: |
49466       IPv4 Address Range
49467       ###### Related Nodes
49468       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49469       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49470       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
49471       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
49472
49473       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
49474     required:
49475     - l3-interface-ipv4-address
49476     properties:
49477       l3-interface-ipv4-address:
49478         type: string
49479         description: IP address
49480       l3-interface-ipv4-prefix-length:
49481         type: integer
49482         format: int64
49483         description: Prefix length, 32 for single address
49484       vlan-id-inner:
49485         type: integer
49486         format: int64
49487         description: Inner VLAN tag
49488       vlan-id-outer:
49489         type: integer
49490         format: int64
49491         description: Outer VLAN tag
49492       is-floating:
49493         type: boolean
49494         description: Indicator of fixed or floating address
49495       resource-version:
49496         type: string
49497         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49498       neutron-network-id:
49499         type: string
49500         description: Neutron network id of the interface that address belongs to
49501       neutron-subnet-id:
49502         type: string
49503         description: Neutron id of subnet that address belongs to
49504       relationship-list:
49505         type: array
49506         items:
49507           $ref: "#/getDefinitions/relationship"
49508   l3-interface-ipv6-address-list:
49509     description: |
49510       IPv6 Address Range
49511       ###### Related Nodes
49512       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49513       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49514       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
49515       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
49516
49517       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
49518     required:
49519     - l3-interface-ipv6-address
49520     properties:
49521       l3-interface-ipv6-address:
49522         type: string
49523         description: IP address
49524       l3-interface-ipv6-prefix-length:
49525         type: integer
49526         format: int64
49527         description: Prefix length, 128 for single address
49528       vlan-id-inner:
49529         type: integer
49530         format: int64
49531         description: Inner VLAN tag
49532       vlan-id-outer:
49533         type: integer
49534         format: int64
49535         description: Outer VLAN tag
49536       is-floating:
49537         type: boolean
49538         description: Indicator of fixed or floating address
49539       resource-version:
49540         type: string
49541         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49542       neutron-network-id:
49543         type: string
49544         description: Neutron network id of the interface that address belongs to
49545       neutron-subnet-id:
49546         type: string
49547         description: Neutron id of subnet that address belongs to
49548       relationship-list:
49549         type: array
49550         items:
49551           $ref: "#/getDefinitions/relationship"
49552   l3-network:
49553     description: |
49554       Generic network definition
49555       ###### Related Nodes
49556       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49557       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49558       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49559       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49560       - FROM complex( complex Uses l3-network, MANY2MANY)
49561       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49562       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49563       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49564       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49565       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49566       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49567       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49568       - FROM tenant( tenant Uses l3-network, MANY2MANY)
49569       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49570
49571       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49572     required:
49573     - network-id
49574     - network-name
49575     - is-bound-to-vpn
49576     - is-provider-network
49577     - is-shared-network
49578     - is-external-network
49579     properties:
49580       network-id:
49581         type: string
49582         description: Network ID, should be uuid. Unique across A&AI.
49583       network-name:
49584         type: string
49585         description: Name of the network, governed by some naming convention..
49586       network-type:
49587         type: string
49588         description: Type of the network - who defines these values?
49589       network-role:
49590         type: string
49591         description: Role the network plans - who defines these values?
49592       network-technology:
49593         type: string
49594         description: Network technology - who defines these values?
49595       neutron-network-id:
49596         type: string
49597         description: Neutron network id of this Interface
49598       is-bound-to-vpn:
49599         type: boolean
49600         description: Set to true if bound to VPN
49601       service-id:
49602         type: string
49603         description: Unique identifier of service from ASDC
49604       network-role-instance:
49605         type: integer
49606         format: int64
49607         description: network role instance
49608       resource-version:
49609         type: string
49610         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49611       orchestration-status:
49612         type: string
49613         description: Orchestration status of this VNF, mastered by MSO
49614       heat-stack-id:
49615         type: string
49616         description: Heat stack id corresponding to this instance, managed by MSO
49617       mso-catalog-key:
49618         type: string
49619         description: Corresponds to the SDN-C catalog id used to configure this VCE
49620       contrail-network-fqdn:
49621         type: string
49622         description: Contrail FQDN for the network
49623       persona-model-id:
49624         type: string
49625         description: the ASDC model id for this resource or service model.
49626       persona-model-version:
49627         type: string
49628         description: the ASDC model version for this resource or service model.
49629       model-version-id:
49630         type: string
49631         description: the ASDC model version for this resource or service model.
49632       widget-model-id:
49633         type: string
49634         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49635       widget-model-version:
49636         type: string
49637         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49638       physical-network-name:
49639         type: string
49640         description: Name associated with the physical network.
49641       is-provider-network:
49642         type: boolean
49643         description: boolean indicatating whether or not network is a provider network.
49644       is-shared-network:
49645         type: boolean
49646         description: boolean indicatating whether or not network is a shared network.
49647       is-external-network:
49648         type: boolean
49649         description: boolean indicatating whether or not network is an external network.
49650       subnets:
49651         type: array
49652         items:
49653           $ref: "#/getDefinitions/subnet"
49654       ctag-assignments:
49655         type: array
49656         items:
49657           $ref: "#/getDefinitions/ctag-assignment"
49658       segmentation-assignments:
49659         type: array
49660         items:
49661           $ref: "#/getDefinitions/segmentation-assignment"
49662       relationship-list:
49663         type: array
49664         items:
49665           $ref: "#/getDefinitions/relationship"
49666         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49667   l3-networks:
49668     properties:
49669       l3-network:
49670         type: array
49671         items:
49672           $ref: "#/getDefinitions/l3-network"
49673   lag-interface:
49674     description: |
49675       Link aggregate interface
49676       ###### Related Nodes
49677       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49678       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49679       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49680       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49681       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49682       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49683       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49684
49685       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49686       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49687       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49688     required:
49689     - interface-name
49690     properties:
49691       interface-name:
49692         type: string
49693         description: Name that identifies the link aggregate interface
49694       resource-version:
49695         type: string
49696         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49697       speed-value:
49698         type: string
49699         description: Captures the numeric part of the speed
49700       speed-units:
49701         type: string
49702         description: Captures the units corresponding to the speed
49703       relationship-list:
49704         type: array
49705         items:
49706           $ref: "#/getDefinitions/relationship"
49707       l-interfaces:
49708         type: array
49709         items:
49710           $ref: "#/getDefinitions/l-interface"
49711   lag-interfaces:
49712     description: |
49713       Collection of link aggregate interfaces.
49714     properties:
49715       lag-interface:
49716         type: array
49717         items:
49718           $ref: "#/getDefinitions/lag-interface"
49719   lag-link:
49720     description: |
49721       LAG links can connect lag-interfaces
49722       ###### Related Nodes
49723       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49724       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49725
49726       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49727     required:
49728     - link-name
49729     properties:
49730       link-name:
49731         type: string
49732         description: Alphabetical concatenation of lag-interface names
49733       resource-version:
49734         type: string
49735         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49736       relationship-list:
49737         type: array
49738         items:
49739           $ref: "#/getDefinitions/relationship"
49740   lag-links:
49741     description: |
49742       Collection of link aggregation connections
49743     properties:
49744       lag-link:
49745         type: array
49746         items:
49747           $ref: "#/getDefinitions/lag-link"
49748   license:
49749     description: |
49750       Metadata for license group.
49751       ###### Related Nodes
49752       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49753       - TO vce( license BelongsTo vce, MANY2ONE)(4)
49754
49755       -(4) IF this TO node is deleted, this LICENSE is DELETED also
49756     required:
49757     - group-uuid
49758     - resource-uuid
49759     properties:
49760       group-uuid:
49761         type: string
49762         description: Unique ID for the license group the resource belongs to, should be uuid.
49763       resource-uuid:
49764         type: string
49765         description: Unique ID of a license resource.
49766       resource-version:
49767         type: string
49768         description: Concurrency value
49769       relationship-list:
49770         type: array
49771         items:
49772           $ref: "#/getDefinitions/relationship"
49773   licenses:
49774     description: |
49775       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49776     properties:
49777       license:
49778         type: array
49779         items:
49780           $ref: "#/getDefinitions/license"
49781   line-of-business:
49782     description: |
49783       describes a line-of-business
49784       ###### Related Nodes
49785       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49786
49787     required:
49788     - line-of-business-name
49789     properties:
49790       line-of-business-name:
49791         type: string
49792         description: Name of the line-of-business (product)
49793       resource-version:
49794         type: string
49795         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49796       relationship-list:
49797         type: array
49798         items:
49799           $ref: "#/getDefinitions/relationship"
49800   lines-of-business:
49801     description: |
49802       Collection of lines-of-business
49803     properties:
49804       line-of-business:
49805         type: array
49806         items:
49807           $ref: "#/getDefinitions/line-of-business"
49808   logical-link:
49809     description: |
49810       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49811       ###### Related Nodes
49812       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49813       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49814       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
49815       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49816       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49817       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49818       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49819       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49820       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49821       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49822       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
49823
49824       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49825     required:
49826     - link-name
49827     - link-type
49828     properties:
49829       link-name:
49830         type: string
49831         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49832       link-type:
49833         type: string
49834         description: Type of logical link, e.g., evc
49835       speed-value:
49836         type: string
49837         description: Captures the numeric part of the speed
49838       speed-units:
49839         type: string
49840         description: Captures the units corresponding to the speed
49841       ip-version:
49842         type: string
49843         description: v4, v6, or ds for dual stack
49844       routing-protocol:
49845         type: string
49846         description: For example, static or BGP
49847       resource-version:
49848         type: string
49849         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49850       persona-model-id:
49851         type: string
49852         description: the ASDC model id for this resource or service model.
49853       persona-model-version:
49854         type: string
49855         description: the ASDC model version for this resource or service model.
49856       model-version-id:
49857         type: string
49858         description: the ASDC model version for this resource or service model.
49859       widget-model-id:
49860         type: string
49861         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49862       widget-model-version:
49863         type: string
49864         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49865       operational-status:
49866         type: string
49867         description: Indication of operational status of the logical link.
49868       link-role:
49869         type: string
49870         description: Indication of the network use of the logical link.
49871       link-name2:
49872         type: string
49873         description: Alias or alternate name (CLCI or D1 name).
49874       link-id:
49875         type: string
49876         description: UUID of the logical-link, SDNC generates this.
49877       relationship-list:
49878         type: array
49879         items:
49880           $ref: "#/getDefinitions/relationship"
49881   logical-links:
49882     description: |
49883       Collection of logical connections
49884     properties:
49885       logical-link:
49886         type: array
49887         items:
49888           $ref: "#/getDefinitions/logical-link"
49889   metadata:
49890     description: |
49891       Collection of metadatum (key/value pairs)
49892     properties:
49893       metadatum:
49894         type: array
49895         items:
49896           $ref: "#/getDefinitions/metadatum"
49897   metadatum:
49898     description: |
49899       Key/value pairs
49900       ###### Related Nodes
49901       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49902       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49903       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49904       - TO model( metadatum BelongsTo model, MANY2ONE)(4)
49905
49906       -(4) IF this TO node is deleted, this METADATUM is DELETED also
49907     required:
49908     - metaname
49909     - metaval
49910     properties:
49911       metaname:
49912         type: string
49913       metaval:
49914         type: string
49915       resource-version:
49916         type: string
49917         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49918   model:
49919     description: |
49920       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
49921       ###### Related Nodes
49922       - TO model( model-element isA model, MANY2ONE)
49923       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
49924       - FROM named-query( named-query AppliesTo model, ONE2MANY)
49925       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49926       - FROM model-element( model-element isA model, MANY2ONE)
49927       - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
49928
49929       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49930       -(2) IF this MODEL node is deleted, this TO node is DELETED also
49931       -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
49932
49933     required:
49934     - model-name-version-id
49935     - model-type
49936     - model-name
49937     - model-id
49938     - model-version
49939     properties:
49940       model-name-version-id:
49941         type: string
49942         description: Unique identifier corresponding to one version of a model in ASDC
49943       model-type:
49944         type: string
49945         description: Type of the model, e.g., service, resource, widget, etc.
49946       model-name:
49947         type: string
49948         description: Name of the model, which can change from version to version.
49949       model-id:
49950         type: string
49951         description: Invariant unique ID which does not change from version to version
49952       model-version:
49953         type: string
49954         description: Version
49955       model-description:
49956         type: string
49957         description: Description
49958       resource-version:
49959         type: string
49960         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49961       model-elements:
49962         type: array
49963         items:
49964           $ref: "#/getDefinitions/model-element"
49965       metadata:
49966         type: array
49967         items:
49968           $ref: "#/getDefinitions/metadatum"
49969       relationship-list:
49970         type: array
49971         items:
49972           $ref: "#/getDefinitions/relationship"
49973   model-and-named-query-search:
49974     description: |
49975       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49976     properties:
49977       query-parameters:
49978         type: object
49979         $ref: "#/getDefinitions/query-parameters"
49980       instance-filters:
49981         type: object
49982         $ref: "#/getDefinitions/instance-filters"
49983       top-node-type:
49984         type: string
49985   model-constraint:
49986     description: |
49987       This is how we would capture constraints defining allowed sets of elements.
49988       ###### Related Nodes
49989       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49990       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49991
49992       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49993       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49994     required:
49995     - model-constraint-uuid
49996     - constrained-element-set-uuid-to-replace
49997     properties:
49998       model-constraint-uuid:
49999         type: string
50000       constrained-element-set-uuid-to-replace:
50001         type: string
50002       constrained-element-sets:
50003         type: array
50004         items:
50005           $ref: "#/getDefinitions/constrained-element-set"
50006   model-constraints:
50007     properties:
50008       model-constraint:
50009         type: array
50010         items:
50011           $ref: "#/getDefinitions/model-constraint"
50012   model-element:
50013     description: |
50014       Defines how other models combine to make up a higher-level model.
50015       ###### Related Nodes
50016       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
50017       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
50018       - TO model( model-element isA model, MANY2ONE)
50019       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
50020       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
50021       - FROM model (PARENT of model-element, model startsWith model-element)(3)
50022       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
50023
50024       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
50025       -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
50026       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
50027     required:
50028     - model-element-uuid
50029     - new-data-del-flag
50030     - cardinality
50031     properties:
50032       model-element-uuid:
50033         type: string
50034       new-data-del-flag:
50035         type: string
50036         description: Indicates whether this element was created as part of instantiation from this model
50037       cardinality:
50038         type: string
50039         description: How many of this type of element are required/allowed
50040       linkage-points:
50041         type: string
50042       resource-version:
50043         type: string
50044         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50045       model-elements:
50046         type: array
50047         items:
50048           $ref: "#/getDefinitions/model-element"
50049         description: Defines how other models combine to make up a higher-level model
50050       model-constraints:
50051         type: array
50052         items:
50053           $ref: "#/getDefinitions/model-constraint"
50054         description: Describes new constraints on this model element that are not part of that model's definition
50055       relationship-list:
50056         type: array
50057         items:
50058           $ref: "#/getDefinitions/relationship"
50059   model-elements:
50060     properties:
50061       model-element:
50062         type: array
50063         items:
50064           $ref: "#/getDefinitions/model-element"
50065   model-ver:
50066     description: |
50067       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50068       ###### Related Nodes
50069       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
50070       - FROM model-element( model-element IsA model-ver, MANY2ONE)
50071       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
50072       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
50073
50074       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
50075       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
50076       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
50077
50078     required:
50079     - model-version-id
50080     - model-name
50081     - model-version
50082     properties:
50083       model-version-id:
50084         type: string
50085         description: Unique identifier corresponding to one version of a model in ASDC
50086       model-name:
50087         type: string
50088         description: Name of the model, which can change from version to version.
50089       model-version:
50090         type: string
50091         description: Version
50092       model-description:
50093         type: string
50094         description: Description
50095       resource-version:
50096         type: string
50097         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50098       model-elements:
50099         type: array
50100         items:
50101           $ref: "#/getDefinitions/model-element"
50102       metadata:
50103         type: array
50104         items:
50105           $ref: "#/getDefinitions/metadatum"
50106       relationship-list:
50107         type: array
50108         items:
50109           $ref: "#/getDefinitions/relationship"
50110   model-vers:
50111     properties:
50112       model-ver:
50113         type: array
50114         items:
50115           $ref: "#/getDefinitions/model-ver"
50116   models:
50117     description: |
50118       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50119     properties:
50120       model:
50121         type: array
50122         items:
50123           $ref: "#/getDefinitions/model"
50124   multicast-configuration:
50125     description: |
50126       ###### Related Nodes
50127       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
50128
50129     required:
50130     - multicast-configuration-id
50131     - multicast-protocol
50132     - rp-type
50133     properties:
50134       multicast-configuration-id:
50135         type: string
50136         description: Unique id of multicast configuration.
50137       multicast-protocol:
50138         type: string
50139         description: protocol of multicast configuration
50140       rp-type:
50141         type: string
50142         description: rp type of multicast configuration
50143       resource-version:
50144         type: string
50145         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50146       relationship-list:
50147         type: array
50148         items:
50149           $ref: "#/getDefinitions/relationship"
50150   multicast-configurations:
50151     description: |
50152       multicast configuration of generic-vnf ip-address
50153     properties:
50154       multicast-configuration:
50155         type: array
50156         items:
50157           $ref: "#/getDefinitions/multicast-configuration"
50158   named-queries:
50159     properties:
50160       named-query:
50161         type: array
50162         items:
50163           $ref: "#/getDefinitions/named-query"
50164   named-query:
50165     description: |
50166       TBD
50167       ###### Related Nodes
50168       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
50169       - TO model( named-query AppliesTo model, ONE2MANY)
50170       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
50171
50172       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
50173     required:
50174     - named-query-uuid
50175     - named-query-name
50176     - named-query-version
50177     properties:
50178       named-query-uuid:
50179         type: string
50180       named-query-name:
50181         type: string
50182       named-query-version:
50183         type: string
50184       required-input-param:
50185         type: string
50186       description:
50187         type: string
50188       resource-version:
50189         type: string
50190       named-query-elements:
50191         type: array
50192         items:
50193           $ref: "#/getDefinitions/named-query-element"
50194       relationship-list:
50195         type: array
50196         items:
50197           $ref: "#/getDefinitions/relationship"
50198   named-query-element:
50199     description: |
50200       TBD
50201       ###### Related Nodes
50202       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
50203       - TO model( named-query-element IsA model, MANY2ONE)
50204       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50205       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
50206       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
50207       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50208
50209       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
50210       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
50211     required:
50212     - named-query-element-uuid
50213     properties:
50214       named-query-element-uuid:
50215         type: string
50216       property-collect-list:
50217         type: string
50218       resource-version:
50219         type: string
50220       property-limit-desc:
50221         type: string
50222       do-not-output:
50223         type: string
50224       named-query-elements:
50225         type: array
50226         items:
50227           $ref: "#/getDefinitions/named-query-element"
50228       related-lookups:
50229         type: array
50230         items:
50231           $ref: "#/getDefinitions/related-lookup"
50232       property-constraints:
50233         type: array
50234         items:
50235           $ref: "#/getDefinitions/property-constraint"
50236       relationship-list:
50237         type: array
50238         items:
50239           $ref: "#/getDefinitions/relationship"
50240   named-query-elements:
50241     properties:
50242       named-query-element:
50243         type: array
50244         items:
50245           $ref: "#/getDefinitions/named-query-element"
50246   network:
50247     description: |
50248       Namespace for network inventory resources.
50249     properties:
50250       logical-links:
50251         type: array
50252         items:
50253           $ref: "#/getDefinitions/logical-link"
50254       site-pair-sets:
50255         type: array
50256         items:
50257           $ref: "#/getDefinitions/site-pair-set"
50258       vpn-bindings:
50259         type: array
50260         items:
50261           $ref: "#/getDefinitions/vpn-binding"
50262       vpls-pes:
50263         type: array
50264         items:
50265           $ref: "#/getDefinitions/vpls-pe"
50266       multicast-configurations:
50267         type: array
50268         items:
50269           $ref: "#/getDefinitions/multicast-configuration"
50270       vces:
50271         type: array
50272         items:
50273           $ref: "#/getDefinitions/vce"
50274       vnfcs:
50275         type: array
50276         items:
50277           $ref: "#/getDefinitions/vnfc"
50278       l3-networks:
50279         type: array
50280         items:
50281           $ref: "#/getDefinitions/l3-network"
50282       network-policies:
50283         type: array
50284         items:
50285           $ref: "#/getDefinitions/network-policy"
50286       generic-vnfs:
50287         type: array
50288         items:
50289           $ref: "#/getDefinitions/generic-vnf"
50290       lag-links:
50291         type: array
50292         items:
50293           $ref: "#/getDefinitions/lag-link"
50294       newvces:
50295         type: array
50296         items:
50297           $ref: "#/getDefinitions/newvce"
50298       pnfs:
50299         type: array
50300         items:
50301           $ref: "#/getDefinitions/pnf"
50302       physical-links:
50303         type: array
50304         items:
50305           $ref: "#/getDefinitions/physical-link"
50306       ipsec-configurations:
50307         type: array
50308         items:
50309           $ref: "#/getDefinitions/ipsec-configuration"
50310       route-table-references:
50311         type: array
50312         items:
50313           $ref: "#/getDefinitions/route-table-reference"
50314   network-policies:
50315     properties:
50316       network-policy:
50317         type: array
50318         items:
50319           $ref: "#/getDefinitions/network-policy"
50320   network-policy:
50321     description: |
50322       ###### Related Nodes
50323       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
50324
50325     required:
50326     - network-policy-id
50327     properties:
50328       network-policy-id:
50329         type: string
50330         description: UUID representing unique key to this instance
50331       network-policy-fqdn:
50332         type: string
50333         description: Contrail FQDN for the policy
50334       heat-stack-id:
50335         type: string
50336         description: ID for the openStack Heat instance
50337       resource-version:
50338         type: string
50339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50340       relationship-list:
50341         type: array
50342         items:
50343           $ref: "#/getDefinitions/relationship"
50344   network-profile:
50345     description: |
50346       Network profile populated by SDN-GP for SNMP
50347       ###### Related Nodes
50348       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
50349
50350     required:
50351     - nm-profile-name
50352     properties:
50353       nm-profile-name:
50354         type: string
50355         description: Unique name of network profile.
50356       community-string:
50357         type: string
50358         description: Encrypted SNMP community string
50359       resource-version:
50360         type: string
50361         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50362       relationship-list:
50363         type: array
50364         items:
50365           $ref: "#/getDefinitions/relationship"
50366   network-profiles:
50367     description: |
50368       Collection of network profiles
50369     properties:
50370       network-profile:
50371         type: array
50372         items:
50373           $ref: "#/getDefinitions/network-profile"
50374   newvce:
50375     description: |
50376       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50377       ###### Related Nodes
50378       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
50379
50380       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
50381     required:
50382     - vnf-id2
50383     - vnf-name
50384     - vnf-type
50385     properties:
50386       vnf-id2:
50387         type: string
50388         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50389       vnf-name:
50390         type: string
50391         description: Name of VNF.
50392       vnf-name2:
50393         type: string
50394         description: Alternate name of VNF.
50395       vnf-type:
50396         type: string
50397         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
50398       prov-status:
50399         type: string
50400         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50401       operational-state:
50402         type: string
50403         description: Indicator for whether the resource is considered operational
50404       license-key:
50405         type: string
50406         description: License key
50407       ipv4-oam-address:
50408         type: string
50409         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).
50410       equipment-role:
50411         type: string
50412         description: Client should send valid enumerated value.
50413       resource-version:
50414         type: string
50415         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50416       ipv4-loopback0-address:
50417         type: string
50418         description: v4 Loopback0 address
50419       orchestration-status:
50420         type: string
50421         description: Orchestration status of this VNF, mastered by MSO.
50422       heat-stack-id:
50423         type: string
50424         description: Heat stack id corresponding to this instance, managed by MSO
50425       mso-catalog-key:
50426         type: string
50427         description: Corresponds to the SDN-C catalog id used to configure this VCE
50428       relationship-list:
50429         type: array
50430         items:
50431           $ref: "#/getDefinitions/relationship"
50432       l-interfaces:
50433         type: array
50434         items:
50435           $ref: "#/getDefinitions/l-interface"
50436   newvces:
50437     description: |
50438       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50439     properties:
50440       newvce:
50441         type: array
50442         items:
50443           $ref: "#/getDefinitions/newvce"
50444   nodes:
50445     properties:
50446       inventory-item-data:
50447         type: array
50448         items:
50449           $ref: "#/getDefinitions/inventory-item-data"
50450   notification-event:
50451     properties:
50452       cambria.partition:
50453         type: string
50454       notification-event-header:
50455         type: object
50456         $ref: "#/getDefinitions/notification-event-header"
50457   notification-event-header:
50458     properties:
50459       id:
50460         type: string
50461       timestamp:
50462         type: string
50463       source-name:
50464         type: string
50465       domain:
50466         type: string
50467       sequence-number:
50468         type: string
50469       severity:
50470         type: string
50471       event-type:
50472         type: string
50473       version:
50474         type: string
50475       action:
50476         type: string
50477       entity-type:
50478         type: string
50479       top-entity-type:
50480         type: string
50481       entity-link:
50482         type: string
50483       status:
50484         type: string
50485   notify:
50486     required:
50487     - event-id
50488     properties:
50489       event-id:
50490         type: string
50491       node-type:
50492         type: string
50493       event-trigger:
50494         type: string
50495       key-data:
50496         type: array
50497         items:
50498           $ref: "#/getDefinitions/key-data"
50499       selflink:
50500         type: string
50501   oam-network:
50502     description: |
50503       OAM network, to be deprecated shortly.  Do not use for new purposes.
50504       ###### Related Nodes
50505       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50506       - TO complex( oam-network AppliesTo complex, MANY2MANY)
50507       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50508
50509     required:
50510     - network-uuid
50511     - network-name
50512     - cvlan-tag
50513     properties:
50514       network-uuid:
50515         type: string
50516         description: UUID of the network. Unique across a cloud-region
50517       network-name:
50518         type: string
50519         description: Name of the network.
50520       cvlan-tag:
50521         type: integer
50522         format: int64
50523         description: cvlan-id
50524       ipv4-oam-gateway-address:
50525         type: string
50526         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50527       ipv4-oam-gateway-address-prefix-length:
50528         type: integer
50529         format: int32
50530         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50531       resource-version:
50532         type: string
50533         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50534       relationship-list:
50535         type: array
50536         items:
50537           $ref: "#/getDefinitions/relationship"
50538   oam-networks:
50539     description: |
50540       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
50541     properties:
50542       oam-network:
50543         type: array
50544         items:
50545           $ref: "#/getDefinitions/oam-network"
50546   operational-environment:
50547     description: |
50548       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50549       ###### Related Nodes
50550       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50551       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50552
50553     required:
50554     - operational-environment-id
50555     - operational-environment-name
50556     - operational-environment-type
50557     - operational-environment-status
50558     - tenant-context
50559     - workload-context
50560     properties:
50561       operational-environment-id:
50562         type: string
50563         description: UUID of an operational environment
50564       operational-environment-name:
50565         type: string
50566         description: Operational Environment name
50567       operational-environment-type:
50568         type: string
50569         description: Operational Environment Type.
50570       operational-environment-status:
50571         type: string
50572         description: Status
50573       tenant-context:
50574         type: string
50575         description: Tenant Context.
50576       workload-context:
50577         type: string
50578         description: Workload Context.
50579       resource-version:
50580         type: string
50581         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50582       relationship-list:
50583         type: array
50584         items:
50585           $ref: "#/getDefinitions/relationship"
50586   operational-environments:
50587     description: |
50588       a logical partition of the cloud which allows to have multiple environments in the production AIC.
50589     properties:
50590       operational-environment:
50591         type: array
50592         items:
50593           $ref: "#/getDefinitions/operational-environment"
50594   overloaded-model:
50595     description: |
50596       Allows for legacy POST of old-style and new-style models
50597     required:
50598     - model-invariant-id
50599     - model-name-version-id
50600     - model-type
50601     - model-name
50602     - model-id
50603     - model-version
50604     properties:
50605       model-invariant-id:
50606         type: string
50607         description: Unique identifier corresponding to the main definition of a model in ASDC
50608       model-name-version-id:
50609         type: string
50610         description: Unique identifier corresponding to one version of a model in ASDC
50611       model-type:
50612         type: string
50613         description: Type of the model, e.g., service, resource, widget, etc.
50614       model-name:
50615         type: string
50616         description: Name of the model, which can change from version to version.
50617       model-id:
50618         type: string
50619         description: Invariant unique ID which does not change from version to version
50620       model-version:
50621         type: string
50622         description: Version
50623       model-description:
50624         type: string
50625         description: Description
50626       resource-version:
50627         type: string
50628         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50629       model-vers:
50630         type: object
50631         $ref: "#/getDefinitions/model-vers"
50632       relationship-list:
50633         type: object
50634         $ref: "#/getDefinitions/relationship-list"
50635   owning-entities:
50636     description: |
50637       Collection of owning-entities
50638     properties:
50639       owning-entity:
50640         type: array
50641         items:
50642           $ref: "#/getDefinitions/owning-entity"
50643   owning-entity:
50644     description: |
50645       describes an owning-entity
50646       ###### Related Nodes
50647       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50648
50649     required:
50650     - owning-entity-id
50651     - owning-entity-name
50652     properties:
50653       owning-entity-id:
50654         type: string
50655         description: UUID of an owning entity
50656       owning-entity-name:
50657         type: string
50658         description: Owning entity name
50659       resource-version:
50660         type: string
50661         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50662       relationship-list:
50663         type: array
50664         items:
50665           $ref: "#/getDefinitions/relationship"
50666   p-interface:
50667     description: |
50668       Physical interface (e.g., nic)
50669       ###### Related Nodes
50670       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50671       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50672       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50673       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50674       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50675       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50676       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50677
50678       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50679       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50680       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50681     required:
50682     - interface-name
50683     properties:
50684       interface-name:
50685         type: string
50686         description: Name that identifies the physical interface
50687       speed-value:
50688         type: string
50689         description: Captures the numeric part of the speed
50690       speed-units:
50691         type: string
50692         description: Captures the units corresponding to the speed
50693       port-description:
50694         type: string
50695         description: Nature of the services and connectivity on this port.
50696       equipment-identifier:
50697         type: string
50698         description: CLEI or other specification for p-interface hardware.
50699       interface-role:
50700         type: string
50701         description: Role specification for p-interface hardware.
50702       interface-type:
50703         type: string
50704         description: Indicates the physical properties of the interface.
50705       resource-version:
50706         type: string
50707         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50708       relationship-list:
50709         type: array
50710         items:
50711           $ref: "#/getDefinitions/relationship"
50712       l-interfaces:
50713         type: array
50714         items:
50715           $ref: "#/getDefinitions/l-interface"
50716   p-interfaces:
50717     description: |
50718       Collection of physical interfaces.
50719     properties:
50720       p-interface:
50721         type: array
50722         items:
50723           $ref: "#/getDefinitions/p-interface"
50724   physical-link:
50725     description: |
50726       Collection of physical connections, typically between p-interfaces
50727       ###### Related Nodes
50728       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50729
50730       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50731     required:
50732     - link-name
50733     properties:
50734       link-name:
50735         type: string
50736         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50737       speed-value:
50738         type: string
50739         description: Captures the numeric part of the speed
50740       speed-units:
50741         type: string
50742         description: Captures the units corresponding to the speed
50743       circuit-id:
50744         type: string
50745         description: Circuit it
50746       dual-mode:
50747         type: string
50748         description: Dual access mode (e.g., primary, secondary
50749       management-option:
50750         type: string
50751         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50752       service-provider-name:
50753         type: string
50754         description: Name of the service Provider on this link.
50755       resource-version:
50756         type: string
50757         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50758       relationship-list:
50759         type: array
50760         items:
50761           $ref: "#/getDefinitions/relationship"
50762   physical-links:
50763     description: |
50764       Collection of physical connections, typically between p-interfaces
50765     properties:
50766       physical-link:
50767         type: array
50768         items:
50769           $ref: "#/getDefinitions/physical-link"
50770   platform:
50771     description: |
50772       describes a platform
50773       ###### Related Nodes
50774       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50775
50776     required:
50777     - platform-name
50778     properties:
50779       platform-name:
50780         type: string
50781         description: Name of the platform
50782       resource-version:
50783         type: string
50784         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50785       relationship-list:
50786         type: array
50787         items:
50788           $ref: "#/getDefinitions/relationship"
50789   platforms:
50790     description: |
50791       Collection of platforms
50792     properties:
50793       platform:
50794         type: array
50795         items:
50796           $ref: "#/getDefinitions/platform"
50797   pnf:
50798     description: |
50799       PNF represents a physical network function. typically equipment used in the D1 world.
50800       ###### Related Nodes
50801       - TO complex( pnf LocatedIn complex, MANY2ONE)
50802       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50803       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50804       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50805
50806       -(1) IF this PNF node is deleted, this FROM node is DELETED also
50807     required:
50808     - pnf-name
50809     - in-maint
50810     properties:
50811       pnf-name:
50812         type: string
50813         description: unique name of Physical Network Function.
50814       pnf-name2:
50815         type: string
50816         description: name of Physical Network Function.
50817       pnf-name2-source:
50818         type: string
50819         description: source of name2
50820       pnf-id:
50821         type: string
50822         description: id of pnf
50823       equip-type:
50824         type: string
50825         description: Equipment type.  Source of truth should define valid values.
50826       equip-vendor:
50827         type: string
50828         description: Equipment vendor.  Source of truth should define valid values.
50829       equip-model:
50830         type: string
50831         description: Equipment model.  Source of truth should define valid values.
50832       management-option:
50833         type: string
50834         description: identifier of managed by company or customer
50835       ipaddress-v4-oam:
50836         type: string
50837         description: ipv4-oam-address with new naming convention for IP addresses
50838       sw-version:
50839         type: string
50840         description: sw-version is the version of SW for the hosted application on the PNF.
50841       orchestration-status:
50842         type: string
50843         description: orchestration-status is the status of orchestration on the PNF.
50844       in-maint:
50845         type: boolean
50846         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50847       frame-id:
50848         type: string
50849         description: ID of the physical frame (relay rack) where pnf is installed.
50850       resource-version:
50851         type: string
50852         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50853       relationship-list:
50854         type: array
50855         items:
50856           $ref: "#/getDefinitions/relationship"
50857       p-interfaces:
50858         type: array
50859         items:
50860           $ref: "#/getDefinitions/p-interface"
50861       lag-interfaces:
50862         type: array
50863         items:
50864           $ref: "#/getDefinitions/lag-interface"
50865   pnfs:
50866     description: |
50867       Collection of Physical Network Functions.
50868     properties:
50869       pnf:
50870         type: array
50871         items:
50872           $ref: "#/getDefinitions/pnf"
50873   port-group:
50874     description: |
50875       Used to capture the network interfaces of this VCE
50876       ###### Related Nodes
50877       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50878       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50879
50880       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50881       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50882     required:
50883     - interface-id
50884     - orchestration-status
50885     properties:
50886       interface-id:
50887         type: string
50888         description: Unique ID of the interface
50889       neutron-network-id:
50890         type: string
50891         description: Neutron network id of this Interface
50892       neutron-network-name:
50893         type: string
50894         description: Neutron network name of this Interface
50895       interface-role:
50896         type: string
50897         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50898       resource-version:
50899         type: string
50900         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50901       port-group-id:
50902         type: string
50903         description: Unique ID for port group in vmware
50904       port-group-name:
50905         type: string
50906         description: Likely to duplicate value of neutron network name
50907       switch-name:
50908         type: string
50909         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50910       orchestration-status:
50911         type: string
50912         description: Orchestration status of this VNF, mastered by MSO
50913       heat-stack-id:
50914         type: string
50915         description: Heat stack id corresponding to this instance, managed by MSO
50916       mso-catalog-key:
50917         type: string
50918         description: Corresponds to the SDN-C catalog id used to configure this VCE
50919       cvlan-tags:
50920         type: array
50921         items:
50922           $ref: "#/getDefinitions/cvlan-tag-entry"
50923       relationship-list:
50924         type: array
50925         items:
50926           $ref: "#/getDefinitions/relationship"
50927   port-groups:
50928     properties:
50929       port-group:
50930         type: array
50931         items:
50932           $ref: "#/getDefinitions/port-group"
50933   project:
50934     description: |
50935       describes the project
50936       ###### Related Nodes
50937       - TO service-instance( project Uses service-instance, ONE2MANY)
50938
50939     required:
50940     - project-name
50941     properties:
50942       project-name:
50943         type: string
50944         description: Name of the project deploying a service
50945       resource-version:
50946         type: string
50947         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50948       relationship-list:
50949         type: array
50950         items:
50951           $ref: "#/getDefinitions/relationship"
50952   projects:
50953     description: |
50954       Collection of projects
50955     properties:
50956       project:
50957         type: array
50958         items:
50959           $ref: "#/getDefinitions/project"
50960   properties:
50961     description: |
50962       Property holder for query properties or instance properties
50963     properties:
50964       property-name:
50965         type: string
50966       property-value:
50967         type: string
50968   property-constraint:
50969     description: |
50970       TBD
50971       ###### Related Nodes
50972       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50973
50974       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50975     required:
50976     - property-constraint-uuid
50977     - constraint-type
50978     - property-name
50979     - property-value
50980     properties:
50981       property-constraint-uuid:
50982         type: string
50983       constraint-type:
50984         type: string
50985       property-name:
50986         type: string
50987       property-value:
50988         type: string
50989       resource-version:
50990         type: string
50991   property-constraints:
50992     properties:
50993       property-constraint:
50994         type: array
50995         items:
50996           $ref: "#/getDefinitions/property-constraint"
50997   pserver:
50998     description: |
50999       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51000       ###### Related Nodes
51001       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
51002       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
51003       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
51004       - TO complex( pserver LocatedIn complex, MANY2ONE)
51005       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
51006       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
51007       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
51008       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
51009       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
51010
51011       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
51012       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
51013
51014     required:
51015     - hostname
51016     - in-maint
51017     properties:
51018       hostname:
51019         type: string
51020         description: Value from executing hostname on the compute node.
51021       ptnii-equip-name:
51022         type: string
51023         description: PTNII name
51024       number-of-cpus:
51025         type: integer
51026         format: int32
51027         description: Number of cpus
51028       disk-in-gigabytes:
51029         type: integer
51030         format: int32
51031         description: Disk size, in GBs
51032       ram-in-megabytes:
51033         type: integer
51034         format: int32
51035         description: RAM size, in MBs
51036       equip-type:
51037         type: string
51038         description: Equipment type.  Source of truth should define valid values.
51039       equip-vendor:
51040         type: string
51041         description: Equipment vendor.  Source of truth should define valid values.
51042       equip-model:
51043         type: string
51044         description: Equipment model.  Source of truth should define valid values.
51045       fqdn:
51046         type: string
51047         description: Fully-qualified domain name
51048       pserver-selflink:
51049         type: string
51050         description: URL to endpoint where AAI can get more details
51051       ipv4-oam-address:
51052         type: string
51053         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51054       serial-number:
51055         type: string
51056         description: Serial number, may be queried
51057       pserver-id:
51058         type: string
51059         description: ID of Pserver
51060       internet-topology:
51061         type: string
51062         description: internet topology of Pserver
51063       in-maint:
51064         type: boolean
51065         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
51066       resource-version:
51067         type: string
51068         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51069       pserver-name2:
51070         type: string
51071         description: alternative pserver name
51072       purpose:
51073         type: string
51074         description: purpose of pserver
51075       relationship-list:
51076         type: array
51077         items:
51078           $ref: "#/getDefinitions/relationship"
51079       p-interfaces:
51080         type: array
51081         items:
51082           $ref: "#/getDefinitions/p-interface"
51083       lag-interfaces:
51084         type: array
51085         items:
51086           $ref: "#/getDefinitions/lag-interface"
51087   pservers:
51088     description: |
51089       Collection of compute hosts.
51090     properties:
51091       pserver:
51092         type: array
51093         items:
51094           $ref: "#/getDefinitions/pserver"
51095   query-parameters:
51096     description: |
51097       QueryParameters for performing a named-query or model query
51098     properties:
51099       named-query:
51100         type: object
51101         $ref: "#/getDefinitions/named-query"
51102       model:
51103         type: object
51104         $ref: "#/getDefinitions/model"
51105   related-lookup:
51106     description: |
51107       TBD
51108       ###### Related Nodes
51109       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
51110
51111       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
51112     required:
51113     - related-lookup-uuid
51114     - source-node-type
51115     - source-node-property
51116     - target-node-type
51117     - target-node-property
51118     properties:
51119       related-lookup-uuid:
51120         type: string
51121       source-node-type:
51122         type: string
51123       source-node-property:
51124         type: string
51125       target-node-type:
51126         type: string
51127       target-node-property:
51128         type: string
51129       property-collect-list:
51130         type: string
51131       resource-version:
51132         type: string
51133       relationship-list:
51134         type: array
51135         items:
51136           $ref: "#/getDefinitions/relationship"
51137   related-lookups:
51138     properties:
51139       related-lookup:
51140         type: array
51141         items:
51142           $ref: "#/getDefinitions/related-lookup"
51143   related-to-property:
51144     properties:
51145       property-key:
51146         type: string
51147         description: Key part of a key/value pair
51148       property-value:
51149         type: string
51150         description: Value part of a key/value pair
51151   relationship:
51152     properties:
51153       related-to:
51154         type: string
51155         description: A keyword provided by A&AI to indicate type of node.
51156       related-link:
51157         type: string
51158         description: URL to the object in A&AI.
51159       relationship-data:
51160         type: array
51161         items:
51162           $ref: "#/getDefinitions/relationship-data"
51163       related-to-property:
51164         type: array
51165         items:
51166           $ref: "#/getDefinitions/related-to-property"
51167   relationship-data:
51168     required:
51169     - relationship-key
51170     - relationship-value
51171     properties:
51172       relationship-key:
51173         type: string
51174         description: A keyword provided by A&AI to indicate an attribute.
51175       relationship-value:
51176         type: string
51177         description: Value of the attribute.
51178   relationship-list:
51179     properties:
51180       relationship:
51181         type: array
51182         items:
51183           $ref: "#/getDefinitions/relationship"
51184   reserved-prop-names:
51185     description: |
51186       Internal map to define some reserved properties of a vertex
51187     properties:
51188       last-mod-source-of-truth:
51189         type: string
51190       aai-node-type:
51191         type: string
51192       aai-created-ts:
51193         type: integer
51194         format: int64
51195       aai-unique-key:
51196         type: string
51197       aai-last-mod-ts:
51198         type: integer
51199         format: int64
51200       source-of-truth:
51201         type: string
51202   response-list:
51203     description: |
51204       Response container for the results of a named-query or model query
51205     properties:
51206       inventory-response-items:
51207         type: object
51208         $ref: "#/getDefinitions/inventory-response-items"
51209   result-data:
51210     properties:
51211       resource-type:
51212         type: string
51213         description: The specific type of node in the A&AI graph
51214       resource-link:
51215         type: string
51216         description: The URL to the specific resource
51217   route-table-reference:
51218     description: |
51219       Openstack route table reference.
51220       ###### Related Nodes
51221       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
51222
51223     required:
51224     - route-table-reference-id
51225     - route-table-reference-fqdn
51226     properties:
51227       route-table-reference-id:
51228         type: string
51229         description: Route Table Reference id, UUID assigned to this instance.
51230       route-table-reference-fqdn:
51231         type: string
51232         description: FQDN entry in the route table.
51233       resource-version:
51234         type: string
51235         description: Concurrency value
51236       relationship-list:
51237         type: array
51238         items:
51239           $ref: "#/getDefinitions/relationship"
51240   route-table-references:
51241     description: |
51242       Collection of openstack route table references
51243     properties:
51244       route-table-reference:
51245         type: array
51246         items:
51247           $ref: "#/getDefinitions/route-table-reference"
51248   route-target:
51249     description: |
51250       Route target information
51251       ###### Related Nodes
51252       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
51253
51254       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
51255     required:
51256     - global-route-target
51257     - route-target-role
51258     properties:
51259       global-route-target:
51260         type: string
51261         description: Number used to identify an RT, globally unique in the network
51262       route-target-role:
51263         type: string
51264         description: Role assigned to this route target
51265       resource-version:
51266         type: string
51267         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51268       relationship-list:
51269         type: array
51270         items:
51271           $ref: "#/getDefinitions/relationship"
51272   route-targets:
51273     description: |
51274       Collection of route target information
51275     properties:
51276       route-target:
51277         type: array
51278         items:
51279           $ref: "#/getDefinitions/route-target"
51280   routing-instance:
51281     description: |
51282       ###### Related Nodes
51283       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
51284       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
51285
51286       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
51287       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
51288     required:
51289     - routing-instance-id
51290     properties:
51291       routing-instance-id:
51292         type: string
51293         description: Unique id of routing instance
51294       rpm-owner:
51295         type: string
51296         description: rpm owner
51297       resource-version:
51298         type: string
51299         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51300       site-pairs:
51301         type: array
51302         items:
51303           $ref: "#/getDefinitions/site-pair"
51304       relationship-list:
51305         type: array
51306         items:
51307           $ref: "#/getDefinitions/relationship"
51308   routing-instances:
51309     description: |
51310       set of probes related to generic-vnf routing instance
51311     properties:
51312       routing-instance:
51313         type: array
51314         items:
51315           $ref: "#/getDefinitions/routing-instance"
51316   sdn-zone-response:
51317     properties:
51318       oam-networks:
51319         type: object
51320         $ref: "#/getDefinitions/oam-networks"
51321       az-and-dvs-switches:
51322         type: array
51323         items:
51324           $ref: "#/getDefinitions/az-and-dvs-switches"
51325   search:
51326     properties:
51327       edge-tag-query-result:
51328         type: object
51329         $ref: "#/getDefinitions/edge-tag-query-result"
51330       edge-tag-query-request:
51331         type: object
51332         $ref: "#/getDefinitions/edge-tag-query-request"
51333       search-results:
51334         type: object
51335         $ref: "#/getDefinitions/search-results"
51336       sdn-zone-response:
51337         type: object
51338         $ref: "#/getDefinitions/sdn-zone-response"
51339   search-results:
51340     properties:
51341       result-data:
51342         type: array
51343         items:
51344           $ref: "#/getDefinitions/result-data"
51345   secondary-filt:
51346     description: |
51347       SecondaryFilt for performing a named-query or model query
51348   secondary-filter:
51349     properties:
51350       property-name:
51351         type: string
51352       filter-type:
51353         type: string
51354       property-value:
51355         type: string
51356   secondary-filts:
51357     description: |
51358       SecondaryFilts for performing a named-query or model query
51359     properties:
51360       secondary-filt:
51361         type: array
51362         items:
51363           $ref: "#/getDefinitions/secondary-filt"
51364   segmentation-assignment:
51365     description: |
51366       Openstack segmentation assignment.
51367       ###### Related Nodes
51368       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
51369
51370       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
51371     required:
51372     - segmentation-id
51373     properties:
51374       segmentation-id:
51375         type: string
51376         description: Route Table Reference id, UUID assigned to this instance.
51377       resource-version:
51378         type: string
51379         description: Concurrency value
51380       relationship-list:
51381         type: array
51382         items:
51383           $ref: "#/getDefinitions/relationship"
51384   segmentation-assignments:
51385     description: |
51386       Collection of openstack segmentation assignments
51387     properties:
51388       segmentation-assignment:
51389         type: array
51390         items:
51391           $ref: "#/getDefinitions/segmentation-assignment"
51392   service:
51393     description: |
51394       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
51395     required:
51396     - service-id
51397     - service-description
51398     properties:
51399       service-id:
51400         type: string
51401         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51402       service-description:
51403         type: string
51404         description: Description of the service
51405       service-selflink:
51406         type: string
51407         description: URL to endpoint where AAI can get more details
51408       resource-version:
51409         type: string
51410         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51411       service-version:
51412         type: string
51413         description: service version
51414       relationship-list:
51415         type: array
51416         items:
51417           $ref: "#/getDefinitions/relationship"
51418   service-capabilities:
51419     description: |
51420       Collection of service capabilities.
51421     properties:
51422       service-capability:
51423         type: array
51424         items:
51425           $ref: "#/getDefinitions/service-capability"
51426   service-capability:
51427     description: |
51428       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
51429       ###### Related Nodes
51430       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51431       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51432
51433       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51434
51435     required:
51436     - service-type
51437     - vnf-type
51438     properties:
51439       service-type:
51440         type: string
51441         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51442       vnf-type:
51443         type: string
51444         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
51445       resource-version:
51446         type: string
51447         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51448       relationship-list:
51449         type: array
51450         items:
51451           $ref: "#/getDefinitions/relationship"
51452   service-design-and-creation:
51453     description: |
51454       Namespace for objects managed by ASDC
51455     properties:
51456       vnf-images:
51457         type: array
51458         items:
51459           $ref: "#/getDefinitions/vnf-image"
51460       services:
51461         type: array
51462         items:
51463           $ref: "#/getDefinitions/service"
51464       service-capabilities:
51465         type: array
51466         items:
51467           $ref: "#/getDefinitions/service-capability"
51468       models:
51469         type: array
51470         items:
51471           $ref: "#/getDefinitions/model"
51472       named-queries:
51473         type: array
51474         items:
51475           $ref: "#/getDefinitions/named-query"
51476   service-instance:
51477     description: |
51478       Instance of a service
51479       ###### Related Nodes
51480       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51481       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51482       - TO connector( service-instance Uses connector, MANY2MANY)
51483       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51484       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51485       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51486       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51487       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51488       - TO vce( service-instance ComposedOf vce, ONE2MANY)
51489       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51490       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51491
51492       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51493       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51494       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51495     required:
51496     - service-instance-id
51497     properties:
51498       service-instance-id:
51499         type: string
51500         description: Uniquely identifies this instance of a service
51501       service-instance-name:
51502         type: string
51503         description: This field will store a name assigned to the service-instance.
51504       persona-model-id:
51505         type: string
51506         description: the ASDC model id for this resource or service model.
51507       persona-model-version:
51508         type: string
51509         description: the ASDC model version for this resource or service model.
51510       model-version-id:
51511         type: string
51512         description: the ASDC model version for this resource or service model.
51513       widget-model-id:
51514         type: string
51515         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51516       widget-model-version:
51517         type: string
51518         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51519       bandwidth-total:
51520         type: string
51521         description: Indicates the total bandwidth to be used for this service.
51522       bandwidth-up-wan1:
51523         type: string
51524         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51525       bandwidth-down-wan1:
51526         type: string
51527         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51528       bandwidth-up-wan2:
51529         type: string
51530         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51531       bandwidth-down-wan2:
51532         type: string
51533         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51534       vhn-portal-url:
51535         type: string
51536         description: URL customers will use to access the vHN Portal.
51537       service-instance-location-id:
51538         type: string
51539         description: An identifier that customers assign to the location where this service is being used.
51540       resource-version:
51541         type: string
51542         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51543       relationship-list:
51544         type: array
51545         items:
51546           $ref: "#/getDefinitions/relationship"
51547       metadata:
51548         type: array
51549         items:
51550           $ref: "#/getDefinitions/metadatum"
51551   service-instances:
51552     description: |
51553       Collection of service instances
51554     properties:
51555       service-instance:
51556         type: array
51557         items:
51558           $ref: "#/getDefinitions/service-instance"
51559   service-subscription:
51560     description: |
51561       Object that group service instances.
51562       ###### Related Nodes
51563       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51564       - TO tenant( service-subscription Uses tenant, MANY2MANY)
51565       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51566
51567       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51568       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51569     required:
51570     - service-type
51571     properties:
51572       service-type:
51573         type: string
51574         description: Value defined by orchestration to identify this service across ECOMP.
51575       temp-ub-sub-account-id:
51576         type: string
51577         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51578       resource-version:
51579         type: string
51580         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51581       service-instances:
51582         type: array
51583         items:
51584           $ref: "#/getDefinitions/service-instance"
51585       relationship-list:
51586         type: array
51587         items:
51588           $ref: "#/getDefinitions/relationship"
51589   service-subscriptions:
51590     description: |
51591       Collection of objects that group service instances.
51592     properties:
51593       service-subscription:
51594         type: array
51595         items:
51596           $ref: "#/getDefinitions/service-subscription"
51597   services:
51598     description: |
51599       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
51600     properties:
51601       service:
51602         type: array
51603         items:
51604           $ref: "#/getDefinitions/service"
51605   site-pair:
51606     description: |
51607       ###### Related Nodes
51608       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51609       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51610
51611       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51612       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51613     required:
51614     - site-pair-id
51615     properties:
51616       site-pair-id:
51617         type: string
51618         description: unique identifier of probe
51619       source-ip:
51620         type: string
51621         description: Prefix address
51622       destination-ip:
51623         type: string
51624         description: Prefix address
51625       ip-version:
51626         type: string
51627         description: ip version, v4, v6
51628       destination-hostname:
51629         type: string
51630         description: Hostname of the destination equipment to which SLAs are measured against.
51631       destination-equip-type:
51632         type: string
51633         description: The type of destinatination equipment. Could be Router, etc.
51634       resource-version:
51635         type: string
51636         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51637       classes-of-service:
51638         type: array
51639         items:
51640           $ref: "#/getDefinitions/class-of-service"
51641       relationship-list:
51642         type: array
51643         items:
51644           $ref: "#/getDefinitions/relationship"
51645   site-pair-set:
51646     description: |
51647       Set of instances for probes used to measure service level agreements
51648       ###### Related Nodes
51649       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51650       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51651
51652       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51653     required:
51654     - site-pair-set-id
51655     properties:
51656       site-pair-set-id:
51657         type: string
51658         description: Unique id of site pair set.
51659       resource-version:
51660         type: string
51661         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51662       routing-instances:
51663         type: array
51664         items:
51665           $ref: "#/getDefinitions/routing-instance"
51666       relationship-list:
51667         type: array
51668         items:
51669           $ref: "#/getDefinitions/relationship"
51670   site-pair-sets:
51671     description: |
51672       Collection of sets of instances for probes related to generic-vnf
51673     properties:
51674       site-pair-set:
51675         type: array
51676         items:
51677           $ref: "#/getDefinitions/site-pair-set"
51678   site-pairs:
51679     description: |
51680       probe within a set
51681     properties:
51682       site-pair:
51683         type: array
51684         items:
51685           $ref: "#/getDefinitions/site-pair"
51686   snapshot:
51687     description: |
51688       Openstack snapshot
51689       ###### Related Nodes
51690       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51691       - FROM vserver( vserver Uses snapshot, ONE2ONE)
51692
51693     required:
51694     - snapshot-id
51695     properties:
51696       snapshot-id:
51697         type: string
51698         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51699       snapshot-name:
51700         type: string
51701         description: Snapshot name
51702       snapshot-architecture:
51703         type: string
51704         description: Operating system architecture
51705       snapshot-os-distro:
51706         type: string
51707         description: The common name of the operating system distribution in lowercase
51708       snapshot-os-version:
51709         type: string
51710         description: The operating system version as specified by the distributor.
51711       application:
51712         type: string
51713         description: The application that the image instantiates.
51714       application-vendor:
51715         type: string
51716         description: The vendor of the application.
51717       application-version:
51718         type: string
51719         description: The version of the application.
51720       snapshot-selflink:
51721         type: string
51722         description: URL to endpoint where AAI can get more details
51723       prev-snapshot-id:
51724         type: string
51725         description: This field contains the UUID of the previous snapshot (if any).
51726       resource-version:
51727         type: string
51728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51729       relationship-list:
51730         type: array
51731         items:
51732           $ref: "#/getDefinitions/relationship"
51733   snapshots:
51734     description: |
51735       Collection of openstack snapshots
51736     properties:
51737       snapshot:
51738         type: array
51739         items:
51740           $ref: "#/getDefinitions/snapshot"
51741   sriov-pf:
51742     description: |
51743       SR-IOV Physical Function
51744       ###### Related Nodes
51745       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51746       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51747
51748       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51749     required:
51750     - pf-pci-id
51751     properties:
51752       pf-pci-id:
51753         type: string
51754         description: Identifier for the sriov-pf
51755       resource-version:
51756         type: string
51757         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51758       relationship-list:
51759         type: array
51760         items:
51761           $ref: "#/getDefinitions/relationship"
51762   sriov-pfs:
51763     description: |
51764       Collection of SR-IOV Physical Functions.
51765     properties:
51766       sriov-pf:
51767         type: array
51768         items:
51769           $ref: "#/getDefinitions/sriov-pf"
51770   sriov-vf:
51771     description: |
51772       SR-IOV Virtual Function (not to be confused with virtual network function)
51773       ###### Related Nodes
51774       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51775
51776       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51777     required:
51778     - pci-id
51779     properties:
51780       pci-id:
51781         type: string
51782         description: PCI ID used to identify the sriov-vf
51783       vf-vlan-filter:
51784         type: string
51785         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51786       vf-mac-filter:
51787         type: string
51788         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51789       vf-vlan-strip:
51790         type: boolean
51791         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51792       vf-vlan-anti-spoof-check:
51793         type: boolean
51794         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.
51795       vf-mac-anti-spoof-check:
51796         type: boolean
51797         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.
51798       vf-mirrors:
51799         type: string
51800         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51801       vf-broadcast-allow:
51802         type: boolean
51803         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51804       vf-unknown-multicast-allow:
51805         type: boolean
51806         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51807       vf-unknown-unicast-allow:
51808         type: boolean
51809         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51810       vf-insert-stag:
51811         type: boolean
51812         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51813       vf-link-status:
51814         type: string
51815         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
51816       resource-version:
51817         type: string
51818         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51819       neutron-network-id:
51820         type: string
51821         description: Neutron network id of the interface
51822       relationship-list:
51823         type: array
51824         items:
51825           $ref: "#/getDefinitions/relationship"
51826   sriov-vfs:
51827     description: |
51828       Collection of SR-IOV Virtual Functions.
51829     properties:
51830       sriov-vf:
51831         type: array
51832         items:
51833           $ref: "#/getDefinitions/sriov-vf"
51834   start-node-filter:
51835     properties:
51836       property-name:
51837         type: string
51838       property-value:
51839         type: string
51840   subnet:
51841     description: |
51842       ###### Related Nodes
51843       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51844       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51845       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51846
51847       -(4) IF this TO node is deleted, this SUBNET is DELETED also
51848       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51849
51850     required:
51851     - subnet-id
51852     - dhcp-enabled
51853     properties:
51854       subnet-id:
51855         type: string
51856         description: Subnet ID, should be UUID.
51857       subnet-name:
51858         type: string
51859         description: Name associated with the subnet.
51860       neutron-subnet-id:
51861         type: string
51862         description: Neutron id of this subnet
51863       gateway-address:
51864         type: string
51865         description: gateway ip address
51866       network-start-address:
51867         type: string
51868         description: network start address
51869       cidr-mask:
51870         type: string
51871         description: cidr mask
51872       ip-version:
51873         type: string
51874         description: ip version
51875       orchestration-status:
51876         type: string
51877         description: Orchestration status of this VNF, mastered by MSO
51878       dhcp-enabled:
51879         type: boolean
51880         description: dhcp enabled
51881       dhcp-start:
51882         type: string
51883         description: the start address reserved for use by dhcp
51884       dhcp-end:
51885         type: string
51886         description: the last address reserved for use by dhcp
51887       resource-version:
51888         type: string
51889         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51890       relationship-list:
51891         type: array
51892         items:
51893           $ref: "#/getDefinitions/relationship"
51894   subnets:
51895     properties:
51896       subnet:
51897         type: array
51898         items:
51899           $ref: "#/getDefinitions/subnet"
51900   tagged-inventory-item-list:
51901     properties:
51902       inventory-item:
51903         type: array
51904         items:
51905           $ref: "#/getDefinitions/inventory-item"
51906   tenant:
51907     description: |
51908       Openstack tenant
51909       ###### Related Nodes
51910       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51911       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51912       - TO l3-network( tenant Uses l3-network, MANY2MANY)
51913       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51914       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51915       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51916
51917       -TENANT cannot be deleted if related to VSERVER
51918
51919     required:
51920     - tenant-id
51921     - tenant-name
51922     properties:
51923       tenant-id:
51924         type: string
51925         description: Unique id relative to the cloud-region.
51926       tenant-name:
51927         type: string
51928         description: Readable name of tenant
51929       resource-version:
51930         type: string
51931         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51932       vservers:
51933         type: array
51934         items:
51935           $ref: "#/getDefinitions/vserver"
51936       relationship-list:
51937         type: array
51938         items:
51939           $ref: "#/getDefinitions/relationship"
51940   tenants:
51941     description: |
51942       Collection of openstack tenants.
51943     properties:
51944       tenant:
51945         type: array
51946         items:
51947           $ref: "#/getDefinitions/tenant"
51948   tunnel-xconnect:
51949     description: |
51950       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51951       ###### Related Nodes
51952       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51953
51954       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51955     required:
51956     - id
51957     - bandwidth-up-wan1
51958     - bandwidth-down-wan1
51959     - bandwidth-up-wan2
51960     - bandwidth-down-wan2
51961     properties:
51962       id:
51963         type: string
51964         description: Allotted Resource id UUID assigned to this instance.
51965       bandwidth-up-wan1:
51966         type: string
51967         description: The WAN uplink bandwidth for WAN1
51968       bandwidth-down-wan1:
51969         type: string
51970         description: The WAN downlink bandwidth for WAN1
51971       bandwidth-up-wan2:
51972         type: string
51973         description: The WAN uplink bandwidth for WAN2
51974       bandwidth-down-wan2:
51975         type: string
51976         description: The WAN downlink bandwidth for WAN2
51977       resource-version:
51978         type: string
51979         description: Concurrency value
51980       relationship-list:
51981         type: array
51982         items:
51983           $ref: "#/getDefinitions/relationship"
51984   tunnel-xconnects:
51985     description: |
51986       This object is used to store the specific tunnel cross connect aspects of an allotted resource
51987     properties:
51988       tunnel-xconnect:
51989         type: array
51990         items:
51991           $ref: "#/getDefinitions/tunnel-xconnect"
51992   update:
51993     description: |
51994       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
51995     required:
51996     - update-node-type
51997     properties:
51998       update-node-type:
51999         type: string
52000       update-node-key:
52001         type: array
52002         items:
52003           $ref: "#/getDefinitions/update-node-key"
52004       update-node-uri:
52005         type: string
52006       action:
52007         type: array
52008         items:
52009           $ref: "#/getDefinitions/action"
52010   update-node-key:
52011     properties:
52012       key-name:
52013         type: string
52014       key-value:
52015         type: string
52016   vce:
52017     description: |
52018       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
52019       ###### Related Nodes
52020       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
52021       - TO complex( vce LocatedIn complex, MANY2MANY)
52022       - TO vserver( vce HostedOn vserver, ONE2MANY)
52023       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
52024       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
52025
52026       -(1) IF this VCE node is deleted, this FROM node is DELETED also
52027     required:
52028     - vnf-id
52029     - vnf-name
52030     - vnf-type
52031     properties:
52032       vnf-id:
52033         type: string
52034         description: Unique id of VNF.  This is unique across the graph.
52035       vnf-name:
52036         type: string
52037         description: Name of VNF.
52038       vnf-name2:
52039         type: string
52040         description: Alternate name of VNF.
52041       vnf-type:
52042         type: string
52043         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
52044       service-id:
52045         type: string
52046         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
52047       regional-resource-zone:
52048         type: string
52049         description: Regional way of organizing pservers, source of truth should define values
52050       prov-status:
52051         type: string
52052         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52053       operational-state:
52054         type: string
52055         description: Indicator for whether the resource is considered operational
52056       license-key:
52057         type: string
52058         description: License key
52059       equipment-role:
52060         type: string
52061         description: Network role being played by this VNF
52062       orchestration-status:
52063         type: string
52064         description: Orchestration status of this VNF, mastered by MSO
52065       heat-stack-id:
52066         type: string
52067         description: Heat stack id corresponding to this instance, managed by MSO
52068       mso-catalog-key:
52069         type: string
52070         description: Corresponds to the SDN-C catalog id used to configure this VCE
52071       vpe-id:
52072         type: string
52073         description: Unique ID of VPE connected to this VCE.
52074       v6-vce-wan-address:
52075         type: string
52076         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
52077       ipv4-oam-address:
52078         type: string
52079         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52080       resource-version:
52081         type: string
52082         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52083       ipv4-loopback0-address:
52084         type: string
52085         description: Loopback0 address
52086       entitlement-resource-uuid:
52087         type: string
52088         description: Entitlement resource uuid
52089       port-groups:
52090         type: array
52091         items:
52092           $ref: "#/getDefinitions/port-group"
52093       relationship-list:
52094         type: array
52095         items:
52096           $ref: "#/getDefinitions/relationship"
52097   vces:
52098     description: |
52099       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
52100     properties:
52101       vce:
52102         type: array
52103         items:
52104           $ref: "#/getDefinitions/vce"
52105   vf-module:
52106     description: |
52107       a deployment unit of VNFCs
52108       ###### Related Nodes
52109       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
52110       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
52111       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
52112       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
52113       - TO vserver( vf-module Uses vserver, ONE2MANY)
52114
52115       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
52116       -VF-MODULE cannot be deleted if related to VNFC
52117
52118     required:
52119     - vf-module-id
52120     - is-base-vf-module
52121     properties:
52122       vf-module-id:
52123         type: string
52124         description: Unique ID of vf-module.
52125       vf-module-name:
52126         type: string
52127         description: Name of vf-module
52128       heat-stack-id:
52129         type: string
52130         description: Heat stack id corresponding to this instance.
52131       orchestration-status:
52132         type: string
52133         description: orchestration status of this vf-module, mastered by MSO
52134       is-base-vf-module:
52135         type: boolean
52136         description: used to indicate whether or not this object is base vf module
52137       resource-version:
52138         type: string
52139         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52140       persona-model-id:
52141         type: string
52142         description: the ASDC model id for this resource or service model.
52143       persona-model-version:
52144         type: string
52145         description: the ASDC model version for this resource or service model.
52146       model-version-id:
52147         type: string
52148         description: the ASDC model version for this resource or service model.
52149       widget-model-id:
52150         type: string
52151         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52152       widget-model-version:
52153         type: string
52154         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52155       contrail-service-instance-fqdn:
52156         type: string
52157         description: the Contrail unique ID for a service-instance
52158       relationship-list:
52159         type: array
52160         items:
52161           $ref: "#/getDefinitions/relationship"
52162   vf-modules:
52163     description: |
52164       Collection of vf-modules, a deployment unit of VNFCs
52165     properties:
52166       vf-module:
52167         type: array
52168         items:
52169           $ref: "#/getDefinitions/vf-module"
52170   vig-server:
52171     description: |
52172       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52173       ###### Related Nodes
52174       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
52175
52176       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
52177     required:
52178     - vig-address-type
52179     properties:
52180       vig-address-type:
52181         type: string
52182         description: indicates whether the VIG is for AVPN or INTERNET
52183       ipaddress-v4-vig:
52184         type: string
52185         description: v4 IP of the vig server
52186       ipaddress-v6-vig:
52187         type: string
52188         description: v6 IP of the vig server
52189       resource-version:
52190         type: string
52191         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52192       relationship-list:
52193         type: array
52194         items:
52195           $ref: "#/getDefinitions/relationship"
52196   vig-servers:
52197     properties:
52198       vig-server:
52199         type: array
52200         items:
52201           $ref: "#/getDefinitions/vig-server"
52202   vip-ipv4-address-list:
52203     description: |
52204       IPv4 Address Range
52205       ###### Related Nodes
52206       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52207       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
52208       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
52209       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52210
52211     required:
52212     - vip-ipv4-address
52213     properties:
52214       vip-ipv4-address:
52215         type: string
52216         description: IP address
52217       vip-ipv4-prefix-length:
52218         type: integer
52219         format: int64
52220         description: Prefix length, 32 for single address
52221       vlan-id-inner:
52222         type: integer
52223         format: int64
52224         description: Inner VLAN tag
52225       vlan-id-outer:
52226         type: integer
52227         format: int64
52228         description: Outer VLAN tag
52229       is-floating:
52230         type: boolean
52231         description: Indicator of fixed or floating address
52232       resource-version:
52233         type: string
52234         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52235       neutron-network-id:
52236         type: string
52237         description: Neutron network id of the interface that address belongs to
52238       neutron-subnet-id:
52239         type: string
52240         description: Neutron id of subnet that address belongs to
52241       relationship-list:
52242         type: array
52243         items:
52244           $ref: "#/getDefinitions/relationship"
52245   vip-ipv6-address-list:
52246     description: |
52247       IPv6 Address Range
52248       ###### Related Nodes
52249       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52250       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
52251       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
52252       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52253
52254     required:
52255     - vip-ipv6-address
52256     properties:
52257       vip-ipv6-address:
52258         type: string
52259         description: IP address
52260       vip-ipv6-prefix-length:
52261         type: integer
52262         format: int64
52263         description: Prefix length, 128 for single address
52264       vlan-id-inner:
52265         type: integer
52266         format: int64
52267         description: Inner VLAN tag
52268       vlan-id-outer:
52269         type: integer
52270         format: int64
52271         description: Outer VLAN tag
52272       is-floating:
52273         type: boolean
52274         description: Indicator of fixed or floating address
52275       resource-version:
52276         type: string
52277         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52278       neutron-network-id:
52279         type: string
52280         description: Neutron network id of the interface that address belongs to
52281       neutron-subnet-id:
52282         type: string
52283         description: Neutron id of subnet that address belongs to
52284       relationship-list:
52285         type: array
52286         items:
52287           $ref: "#/getDefinitions/relationship"
52288   virtual-data-center:
52289     description: |
52290       Virtual organization of cloud infrastructure elements in a data center context
52291       ###### Related Nodes
52292       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
52293       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52294       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
52295
52296     required:
52297     - vdc-id
52298     - vdc-name
52299     properties:
52300       vdc-id:
52301         type: string
52302         description: Unique ID of the vdc
52303       vdc-name:
52304         type: string
52305         description: Name of the virtual data center
52306       resource-version:
52307         type: string
52308         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52309       relationship-list:
52310         type: array
52311         items:
52312           $ref: "#/getDefinitions/relationship"
52313   virtual-data-centers:
52314     description: |
52315       Virtual organization of cloud infrastructure elements in a data center context
52316     properties:
52317       virtual-data-center:
52318         type: array
52319         items:
52320           $ref: "#/getDefinitions/virtual-data-center"
52321   vlan:
52322     description: |
52323       Definition of vlan
52324       ###### Related Nodes
52325       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52326       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52327       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52328       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52329       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52330       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52331
52332       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52333       -(2) IF this VLAN node is deleted, this TO node is DELETED also
52334       -(4) IF this TO node is deleted, this VLAN is DELETED also
52335     required:
52336     - vlan-interface
52337     properties:
52338       vlan-interface:
52339         type: string
52340         description: String that identifies the interface
52341       vlan-id-inner:
52342         type: integer
52343         format: int64
52344         description: Inner VLAN tag
52345       vlan-id-outer:
52346         type: integer
52347         format: int64
52348         description: Outer VLAN tag
52349       resource-version:
52350         type: string
52351         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52352       speed-value:
52353         type: string
52354         description: Captures the numeric part of the speed
52355       speed-units:
52356         type: string
52357         description: Captures the units corresponding to the speed
52358       vlan-description:
52359         type: string
52360         description: Used to describe (the service associated with) the vlan
52361       backdoor-connection:
52362         type: string
52363         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52364       vpn-id:
52365         type: string
52366         description: This indicates the customers VPN ID associated with this vlan
52367       relationship-list:
52368         type: array
52369         items:
52370           $ref: "#/getDefinitions/relationship"
52371       l3-interface-ipv4-address-list:
52372         type: array
52373         items:
52374           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52375       l3-interface-ipv6-address-list:
52376         type: array
52377         items:
52378           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52379   vlans:
52380     properties:
52381       vlan:
52382         type: array
52383         items:
52384           $ref: "#/getDefinitions/vlan"
52385   vnf:
52386     description: |
52387       Abstract vnf class
52388     required:
52389     - vnf-id
52390     properties:
52391       vnf-id:
52392         type: string
52393         description: Unique id of VNF.  This is unique across the graph.
52394   vnf-image:
52395     description: |
52396       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52397       ###### Related Nodes
52398       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52399
52400       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52401
52402     required:
52403     - vnf-image-uuid
52404     - application
52405     - application-vendor
52406     properties:
52407       vnf-image-uuid:
52408         type: string
52409         description: Unique ID of this asset
52410       application:
52411         type: string
52412         description: The application that the image instantiates.
52413       application-vendor:
52414         type: string
52415         description: The vendor of the application.
52416       application-version:
52417         type: string
52418         description: The version of the application.
52419       selflink:
52420         type: string
52421         description: URL to endpoint where AAI can get more details
52422       resource-version:
52423         type: string
52424         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52425       relationship-list:
52426         type: array
52427         items:
52428           $ref: "#/getDefinitions/relationship"
52429   vnf-images:
52430     description: |
52431       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52432     properties:
52433       vnf-image:
52434         type: array
52435         items:
52436           $ref: "#/getDefinitions/vnf-image"
52437   vnfc:
52438     description: |
52439       ###### Related Nodes
52440       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52441       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52442       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52443
52444       -(4) IF this TO node is deleted, this VNFC is DELETED also
52445     required:
52446     - vnfc-name
52447     - vnfc-function-code
52448     - vnfc-type
52449     - in-maint
52450     - is-closed-loop-disabled
52451     properties:
52452       vnfc-name:
52453         type: string
52454         description: Unique ID of vnfc.
52455       vnfc-function-code:
52456         type: string
52457         description: function code
52458       vnfc-type:
52459         type: string
52460         description: type
52461       prov-status:
52462         type: string
52463         description: prov status of this vnfc
52464       orchestration-status:
52465         type: string
52466         description: Orchestration status of this VNF, mastered by APP-C
52467       ipaddress-v4-oam-vip:
52468         type: string
52469         description: Oam V4 vip address of this vnfc
52470       in-maint:
52471         type: boolean
52472         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52473       is-closed-loop-disabled:
52474         type: boolean
52475         description: used to indicate whether closed loop function is enabled on this node
52476       group-notation:
52477         type: string
52478         description: Group notation of VNFC
52479       resource-version:
52480         type: string
52481         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52482       relationship-list:
52483         type: array
52484         items:
52485           $ref: "#/getDefinitions/relationship"
52486   vnfcs:
52487     description: |
52488       virtual network components associated with a vserver from application controller.
52489     properties:
52490       vnfc:
52491         type: array
52492         items:
52493           $ref: "#/getDefinitions/vnfc"
52494   volume:
52495     description: |
52496       Ephemeral Block storage volume.
52497       ###### Related Nodes
52498       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52499
52500       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52501     required:
52502     - volume-id
52503     - volume-selflink
52504     properties:
52505       volume-id:
52506         type: string
52507         description: Unique ID of block storage volume relative to the vserver.
52508       volume-selflink:
52509         type: string
52510         description: URL to endpoint where AAI can get more details
52511       resource-version:
52512         type: string
52513         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52514       relationship-list:
52515         type: array
52516         items:
52517           $ref: "#/getDefinitions/relationship"
52518   volume-group:
52519     description: |
52520       Persistent block-level storage.
52521       ###### Related Nodes
52522       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52523       - TO complex( volume-group LocatedIn complex, MANY2ONE)
52524       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52525       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52526       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52527
52528     required:
52529     - volume-group-id
52530     - volume-group-name
52531     - vnf-type
52532     properties:
52533       volume-group-id:
52534         type: string
52535         description: Unique ID of volume-group.
52536       volume-group-name:
52537         type: string
52538         description: Name of the volume group.
52539       heat-stack-id:
52540         type: string
52541         description: Heat stack id corresponding to this volume-group
52542       vnf-type:
52543         type: string
52544         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
52545       orchestration-status:
52546         type: string
52547         description: Orchestration status of this volume-group
52548       resource-version:
52549         type: string
52550         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52551       relationship-list:
52552         type: array
52553         items:
52554           $ref: "#/getDefinitions/relationship"
52555   volume-groups:
52556     description: |
52557       Collection of persistent block-level storage.
52558     properties:
52559       volume-group:
52560         type: array
52561         items:
52562           $ref: "#/getDefinitions/volume-group"
52563   volumes:
52564     description: |
52565       Collection of ephemeral Block storage volumes.
52566     properties:
52567       volume:
52568         type: array
52569         items:
52570           $ref: "#/getDefinitions/volume"
52571   vpls-pe:
52572     description: |
52573       VPLS Provider Edge routers.
52574       ###### Related Nodes
52575       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52576       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52577       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52578       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52579
52580       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52581     required:
52582     - equipment-name
52583     properties:
52584       equipment-name:
52585         type: string
52586       prov-status:
52587         type: string
52588         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52589       ipv4-oam-address:
52590         type: string
52591         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).
52592       equipment-role:
52593         type: string
52594         description: Client should send valid enumerated value, e.g., VPLS-PE.
52595       vlan-id-outer:
52596         type: integer
52597         format: int64
52598         description: Temporary location for stag to get to VCE
52599       resource-version:
52600         type: string
52601         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52602       relationship-list:
52603         type: array
52604         items:
52605           $ref: "#/getDefinitions/relationship"
52606       p-interfaces:
52607         type: array
52608         items:
52609           $ref: "#/getDefinitions/p-interface"
52610       lag-interfaces:
52611         type: array
52612         items:
52613           $ref: "#/getDefinitions/lag-interface"
52614   vpls-pes:
52615     description: |
52616       Collection of VPLS Provider Edge routers
52617     properties:
52618       vpls-pe:
52619         type: array
52620         items:
52621           $ref: "#/getDefinitions/vpls-pe"
52622   vpn-binding:
52623     description: |
52624       VPN binding
52625       ###### Related Nodes
52626       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52627
52628       -VPN-BINDING cannot be deleted if related to L3-NETWORK
52629
52630     required:
52631     - vpn-id
52632     - vpn-name
52633     - global-route-target
52634     properties:
52635       vpn-id:
52636         type: string
52637         description: VPN ID, globally unique within A&AI
52638       vpn-name:
52639         type: string
52640         description: VPN Name
52641       global-route-target:
52642         type: string
52643         description: Number used to identify a VPN, globally unique in the network
52644       vpn-platform:
52645         type: string
52646         description: the platform associated with the VPN example AVPN, Mobility
52647       resource-version:
52648         type: string
52649         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52650       relationship-list:
52651         type: array
52652         items:
52653           $ref: "#/getDefinitions/relationship"
52654         description: l3-networks relate to vpn-bindings
52655   vpn-bindings:
52656     properties:
52657       vpn-binding:
52658         type: array
52659         items:
52660           $ref: "#/getDefinitions/vpn-binding"
52661   vserver:
52662     description: |
52663       Virtual Servers, aka virtual machine or VM.
52664       ###### Related Nodes
52665       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52666       - TO flavor( vserver Uses flavor, MANY2ONE)
52667       - TO image( vserver Uses image, MANY2ONE)
52668       - TO pserver( vserver HostedOn pserver, MANY2ONE)
52669       - TO snapshot( vserver Uses snapshot, ONE2ONE)
52670       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52671       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52672       - FROM vce( vce HostedOn vserver, ONE2MANY)
52673       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52674       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52675       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52676
52677       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52678       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52679     required:
52680     - vserver-id
52681     - vserver-name
52682     - vserver-selflink
52683     - in-maint
52684     - is-closed-loop-disabled
52685     properties:
52686       vserver-id:
52687         type: string
52688         description: Unique identifier for this vserver relative to its tenant
52689       vserver-name:
52690         type: string
52691         description: Name of vserver
52692       vserver-name2:
52693         type: string
52694         description: Alternative name of vserver
52695       prov-status:
52696         type: string
52697         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52698       vserver-selflink:
52699         type: string
52700         description: URL to endpoint where AAI can get more details
52701       in-maint:
52702         type: boolean
52703         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
52704       is-closed-loop-disabled:
52705         type: boolean
52706         description: Used to indicate whether closed loop function is enabled on this node
52707       resource-version:
52708         type: string
52709         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52710       volumes:
52711         type: array
52712         items:
52713           $ref: "#/getDefinitions/volume"
52714       relationship-list:
52715         type: array
52716         items:
52717           $ref: "#/getDefinitions/relationship"
52718       l-interfaces:
52719         type: array
52720         items:
52721           $ref: "#/getDefinitions/l-interface"
52722   vservers:
52723     description: |
52724       Collection of virtual Servers, aka virtual machines or VMs.
52725     properties:
52726       vserver:
52727         type: array
52728         items:
52729           $ref: "#/getDefinitions/vserver"
52730   zone:
52731     description: |
52732       A zone is a grouping of assets in a location homing to the same connections into the CBB
52733       ###### Related Nodes
52734       - TO complex( zone LocatedIn complex, MANY2ONE)
52735       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52736       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52737       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52738
52739     required:
52740     - zone-id
52741     - zone-name
52742     - design-type
52743     - zone-context
52744     properties:
52745       zone-id:
52746         type: string
52747         description: Code assigned by AIC to the zone
52748       zone-name:
52749         type: string
52750         description: English name associated with the zone
52751       design-type:
52752         type: string
52753         description: Design of zone [Medium/Large?]
52754       zone-context:
52755         type: string
52756         description: Context of zone [production/test]
52757       status:
52758         type: string
52759         description: Status of a zone.
52760       resource-version:
52761         type: string
52762         description: Concurrency value
52763       relationship-list:
52764         type: array
52765         items:
52766           $ref: "#/getDefinitions/relationship"
52767   zones:
52768     description: |
52769       Collection of zones
52770     properties:
52771       zone:
52772         type: array
52773         items:
52774           $ref: "#/getDefinitions/zone"