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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v10.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v10"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v10
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144     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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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         - name: prov-status
9620           in: query
9621           description:
9622           required: false
9623           type: string
9624   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9625     put:
9626       tags:
9627         - CloudInfrastructure
9628       summary: see node definition for valid relationships
9629       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9630       consumes:
9631         - application/json
9632         - application/xml
9633       produces:
9634         - application/json
9635         - application/xml
9636       responses:
9637         "default":
9638           description: Response codes found in [response codes](https://wiki.onap.org/).
9639       parameters:
9640         - name: hostname
9641           in: path
9642           description: Value from executing hostname on the compute node.
9643           required: true
9644           type: string
9645           example: __HOSTNAME__
9646         - name: interface-name
9647           in: path
9648           description: Name that identifies the link aggregate interface
9649           required: true
9650           type: string
9651           example: __INTERFACE-NAME__
9652         - name: body
9653           in: body
9654           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9655           required: true
9656           schema:
9657             $ref: "#/definitions/relationship"
9658     delete:
9659       tags:
9660         - CloudInfrastructure
9661       summary: delete an existing relationship
9662       description: delete an existing relationship
9663       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9664       consumes:
9665         - application/json
9666         - application/xml
9667       produces:
9668         - application/json
9669         - application/xml
9670       responses:
9671         "default":
9672           description: Response codes found in [response codes](https://wiki.onap.org/).
9673       parameters:
9674         - name: hostname
9675           in: path
9676           description: Value from executing hostname on the compute node.
9677           required: true
9678           type: string
9679           example: __HOSTNAME__
9680         - name: interface-name
9681           in: path
9682           description: Name that identifies the link aggregate interface
9683           required: true
9684           type: string
9685           example: __INTERFACE-NAME__
9686   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9687     put:
9688       tags:
9689         - CloudInfrastructure
9690       summary: see node definition for valid relationships
9691       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9692       consumes:
9693         - application/json
9694         - application/xml
9695       produces:
9696         - application/json
9697         - application/xml
9698       responses:
9699         "default":
9700           description: Response codes found in [response codes](https://wiki.onap.org/).
9701       parameters:
9702         - name: hostname
9703           in: path
9704           description: Value from executing hostname on the compute node.
9705           required: true
9706           type: string
9707           example: __HOSTNAME__
9708         - name: interface-name
9709           in: path
9710           description: Name that identifies the link aggregate interface
9711           required: true
9712           type: string
9713           example: __INTERFACE-NAME__
9714         - name: interface-name
9715           in: path
9716           description: Name given to the interface
9717           required: true
9718           type: string
9719           example: __INTERFACE-NAME__
9720         - name: vlan-interface
9721           in: path
9722           description: String that identifies the interface
9723           required: true
9724           type: string
9725           example: __VLAN-INTERFACE__
9726         - name: body
9727           in: body
9728           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9729           required: true
9730           schema:
9731             $ref: "#/definitions/relationship"
9732     delete:
9733       tags:
9734         - CloudInfrastructure
9735       summary: delete an existing relationship
9736       description: delete an existing relationship
9737       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9738       consumes:
9739         - application/json
9740         - application/xml
9741       produces:
9742         - application/json
9743         - application/xml
9744       responses:
9745         "default":
9746           description: Response codes found in [response codes](https://wiki.onap.org/).
9747       parameters:
9748         - name: hostname
9749           in: path
9750           description: Value from executing hostname on the compute node.
9751           required: true
9752           type: string
9753           example: __HOSTNAME__
9754         - name: interface-name
9755           in: path
9756           description: Name that identifies the link aggregate interface
9757           required: true
9758           type: string
9759           example: __INTERFACE-NAME__
9760         - name: interface-name
9761           in: path
9762           description: Name given to the interface
9763           required: true
9764           type: string
9765           example: __INTERFACE-NAME__
9766         - name: vlan-interface
9767           in: path
9768           description: String that identifies the interface
9769           required: true
9770           type: string
9771           example: __VLAN-INTERFACE__
9772   /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:
9773     put:
9774       tags:
9775         - CloudInfrastructure
9776       summary: see node definition for valid relationships
9777       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9778       consumes:
9779         - application/json
9780         - application/xml
9781       produces:
9782         - application/json
9783         - application/xml
9784       responses:
9785         "default":
9786           description: Response codes found in [response codes](https://wiki.onap.org/).
9787       parameters:
9788         - name: hostname
9789           in: path
9790           description: Value from executing hostname on the compute node.
9791           required: true
9792           type: string
9793           example: __HOSTNAME__
9794         - name: interface-name
9795           in: path
9796           description: Name that identifies the link aggregate interface
9797           required: true
9798           type: string
9799           example: __INTERFACE-NAME__
9800         - name: interface-name
9801           in: path
9802           description: Name given to the interface
9803           required: true
9804           type: string
9805           example: __INTERFACE-NAME__
9806         - name: vlan-interface
9807           in: path
9808           description: String that identifies the interface
9809           required: true
9810           type: string
9811           example: __VLAN-INTERFACE__
9812         - name: l3-interface-ipv4-address
9813           in: path
9814           description: IP address
9815           required: true
9816           type: string
9817           example: __L3-INTERFACE-IPV4-ADDRESS__
9818         - name: body
9819           in: body
9820           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9821           required: true
9822           schema:
9823             $ref: "#/definitions/relationship"
9824     delete:
9825       tags:
9826         - CloudInfrastructure
9827       summary: delete an existing relationship
9828       description: delete an existing relationship
9829       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9830       consumes:
9831         - application/json
9832         - application/xml
9833       produces:
9834         - application/json
9835         - application/xml
9836       responses:
9837         "default":
9838           description: Response codes found in [response codes](https://wiki.onap.org/).
9839       parameters:
9840         - name: hostname
9841           in: path
9842           description: Value from executing hostname on the compute node.
9843           required: true
9844           type: string
9845           example: __HOSTNAME__
9846         - name: interface-name
9847           in: path
9848           description: Name that identifies the link aggregate interface
9849           required: true
9850           type: string
9851           example: __INTERFACE-NAME__
9852         - name: interface-name
9853           in: path
9854           description: Name given to the interface
9855           required: true
9856           type: string
9857           example: __INTERFACE-NAME__
9858         - name: vlan-interface
9859           in: path
9860           description: String that identifies the interface
9861           required: true
9862           type: string
9863           example: __VLAN-INTERFACE__
9864         - name: l3-interface-ipv4-address
9865           in: path
9866           description: IP address
9867           required: true
9868           type: string
9869           example: __L3-INTERFACE-IPV4-ADDRESS__
9870   /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}:
9871     get:
9872       tags:
9873         - CloudInfrastructure
9874       summary: returns l3-interface-ipv4-address-list
9875       description: returns l3-interface-ipv4-address-list
9876       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9877       produces:
9878         - application/json
9879         - application/xml
9880       responses:
9881         "200":
9882           description: successful operation
9883           schema:
9884               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9885         "default":
9886           description: Response codes found in [response codes](https://wiki.onap.org/).
9887       parameters:
9888         - name: hostname
9889           in: path
9890           description: Value from executing hostname on the compute node.
9891           required: true
9892           type: string
9893           example: __HOSTNAME__
9894         - name: interface-name
9895           in: path
9896           description: Name that identifies the link aggregate interface
9897           required: true
9898           type: string
9899           example: __INTERFACE-NAME__
9900         - name: interface-name
9901           in: path
9902           description: Name given to the interface
9903           required: true
9904           type: string
9905           example: __INTERFACE-NAME__
9906         - name: vlan-interface
9907           in: path
9908           description: String that identifies the interface
9909           required: true
9910           type: string
9911           example: __VLAN-INTERFACE__
9912         - name: l3-interface-ipv4-address
9913           in: path
9914           description: IP address
9915           required: true
9916           type: string
9917           example: __L3-INTERFACE-IPV4-ADDRESS__
9918     put:
9919       tags:
9920         - CloudInfrastructure
9921       summary: create or update an existing l3-interface-ipv4-address-list
9922       description: |
9923         Create or update an existing l3-interface-ipv4-address-list.
9924         #
9925         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9926       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9927       consumes:
9928         - application/json
9929         - application/xml
9930       produces:
9931         - application/json
9932         - application/xml
9933       responses:
9934         "default":
9935           description: Response codes found in [response codes](https://wiki.onap.org/).
9936       parameters:
9937         - name: hostname
9938           in: path
9939           description: Value from executing hostname on the compute node.
9940           required: true
9941           type: string
9942           example: __HOSTNAME__
9943         - name: interface-name
9944           in: path
9945           description: Name that identifies the link aggregate interface
9946           required: true
9947           type: string
9948           example: __INTERFACE-NAME__
9949         - name: interface-name
9950           in: path
9951           description: Name given to the interface
9952           required: true
9953           type: string
9954           example: __INTERFACE-NAME__
9955         - name: vlan-interface
9956           in: path
9957           description: String that identifies the interface
9958           required: true
9959           type: string
9960           example: __VLAN-INTERFACE__
9961         - name: l3-interface-ipv4-address
9962           in: path
9963           description: IP address
9964           required: true
9965           type: string
9966           example: __L3-INTERFACE-IPV4-ADDRESS__
9967         - name: body
9968           in: body
9969           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9970           required: true
9971           schema:
9972             $ref: "#/definitions/l3-interface-ipv4-address-list"
9973     patch:
9974       tags:
9975         - CloudInfrastructure
9976       summary: update an existing l3-interface-ipv4-address-list
9977       description: |
9978         Update an existing l3-interface-ipv4-address-list
9979         #
9980         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9981         The PUT operation will entirely replace an existing object.
9982         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9983         #
9984         Other differences between PUT and PATCH are:
9985         #
9986         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9987         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9988         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9989       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9990       consumes:
9991         - application/json
9992         - application/xml
9993       produces:
9994         - application/json
9995         - application/xml
9996       responses:
9997         "default":
9998           description: Response codes found in [response codes](https://wiki.onap.org/).
9999       parameters:
10000         - name: hostname
10001           in: path
10002           description: Value from executing hostname on the compute node.
10003           required: true
10004           type: string
10005           example: __HOSTNAME__
10006         - name: interface-name
10007           in: path
10008           description: Name that identifies the link aggregate interface
10009           required: true
10010           type: string
10011           example: __INTERFACE-NAME__
10012         - name: interface-name
10013           in: path
10014           description: Name given to the interface
10015           required: true
10016           type: string
10017           example: __INTERFACE-NAME__
10018         - name: vlan-interface
10019           in: path
10020           description: String that identifies the interface
10021           required: true
10022           type: string
10023           example: __VLAN-INTERFACE__
10024         - name: l3-interface-ipv4-address
10025           in: path
10026           description: IP address
10027           required: true
10028           type: string
10029           example: __L3-INTERFACE-IPV4-ADDRESS__
10030         - name: body
10031           in: body
10032           description: l3-interface-ipv4-address-list object that needs to be updated.
10033           required: true
10034           schema:
10035             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10036     delete:
10037       tags:
10038         - CloudInfrastructure
10039       summary: delete an existing l3-interface-ipv4-address-list
10040       description: delete an existing l3-interface-ipv4-address-list
10041       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10042       consumes:
10043         - application/json
10044         - application/xml
10045       produces:
10046         - application/json
10047         - application/xml
10048       responses:
10049         "default":
10050           description: Response codes found in [response codes](https://wiki.onap.org/).
10051       parameters:
10052         - name: hostname
10053           in: path
10054           description: Value from executing hostname on the compute node.
10055           required: true
10056           type: string
10057           example: __HOSTNAME__
10058         - name: interface-name
10059           in: path
10060           description: Name that identifies the link aggregate interface
10061           required: true
10062           type: string
10063           example: __INTERFACE-NAME__
10064         - name: interface-name
10065           in: path
10066           description: Name given to the interface
10067           required: true
10068           type: string
10069           example: __INTERFACE-NAME__
10070         - name: vlan-interface
10071           in: path
10072           description: String that identifies the interface
10073           required: true
10074           type: string
10075           example: __VLAN-INTERFACE__
10076         - name: l3-interface-ipv4-address
10077           in: path
10078           description: IP address
10079           required: true
10080           type: string
10081           example: __L3-INTERFACE-IPV4-ADDRESS__
10082         - name: resource-version
10083           in: query
10084           description: resource-version for concurrency
10085           required: true
10086           type: string
10087   /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:
10088     put:
10089       tags:
10090         - CloudInfrastructure
10091       summary: see node definition for valid relationships
10092       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10093       consumes:
10094         - application/json
10095         - application/xml
10096       produces:
10097         - application/json
10098         - application/xml
10099       responses:
10100         "default":
10101           description: Response codes found in [response codes](https://wiki.onap.org/).
10102       parameters:
10103         - name: hostname
10104           in: path
10105           description: Value from executing hostname on the compute node.
10106           required: true
10107           type: string
10108           example: __HOSTNAME__
10109         - name: interface-name
10110           in: path
10111           description: Name that identifies the link aggregate interface
10112           required: true
10113           type: string
10114           example: __INTERFACE-NAME__
10115         - name: interface-name
10116           in: path
10117           description: Name given to the interface
10118           required: true
10119           type: string
10120           example: __INTERFACE-NAME__
10121         - name: vlan-interface
10122           in: path
10123           description: String that identifies the interface
10124           required: true
10125           type: string
10126           example: __VLAN-INTERFACE__
10127         - name: l3-interface-ipv6-address
10128           in: path
10129           description: IP address
10130           required: true
10131           type: string
10132           example: __L3-INTERFACE-IPV6-ADDRESS__
10133         - name: body
10134           in: body
10135           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10136           required: true
10137           schema:
10138             $ref: "#/definitions/relationship"
10139     delete:
10140       tags:
10141         - CloudInfrastructure
10142       summary: delete an existing relationship
10143       description: delete an existing relationship
10144       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10145       consumes:
10146         - application/json
10147         - application/xml
10148       produces:
10149         - application/json
10150         - application/xml
10151       responses:
10152         "default":
10153           description: Response codes found in [response codes](https://wiki.onap.org/).
10154       parameters:
10155         - name: hostname
10156           in: path
10157           description: Value from executing hostname on the compute node.
10158           required: true
10159           type: string
10160           example: __HOSTNAME__
10161         - name: interface-name
10162           in: path
10163           description: Name that identifies the link aggregate interface
10164           required: true
10165           type: string
10166           example: __INTERFACE-NAME__
10167         - name: interface-name
10168           in: path
10169           description: Name given to the interface
10170           required: true
10171           type: string
10172           example: __INTERFACE-NAME__
10173         - name: vlan-interface
10174           in: path
10175           description: String that identifies the interface
10176           required: true
10177           type: string
10178           example: __VLAN-INTERFACE__
10179         - name: l3-interface-ipv6-address
10180           in: path
10181           description: IP address
10182           required: true
10183           type: string
10184           example: __L3-INTERFACE-IPV6-ADDRESS__
10185   /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}:
10186     get:
10187       tags:
10188         - CloudInfrastructure
10189       summary: returns l3-interface-ipv6-address-list
10190       description: returns l3-interface-ipv6-address-list
10191       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10192       produces:
10193         - application/json
10194         - application/xml
10195       responses:
10196         "200":
10197           description: successful operation
10198           schema:
10199               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10200         "default":
10201           description: Response codes found in [response codes](https://wiki.onap.org/).
10202       parameters:
10203         - name: hostname
10204           in: path
10205           description: Value from executing hostname on the compute node.
10206           required: true
10207           type: string
10208           example: __HOSTNAME__
10209         - name: interface-name
10210           in: path
10211           description: Name that identifies the link aggregate interface
10212           required: true
10213           type: string
10214           example: __INTERFACE-NAME__
10215         - name: interface-name
10216           in: path
10217           description: Name given to the interface
10218           required: true
10219           type: string
10220           example: __INTERFACE-NAME__
10221         - name: vlan-interface
10222           in: path
10223           description: String that identifies the interface
10224           required: true
10225           type: string
10226           example: __VLAN-INTERFACE__
10227         - name: l3-interface-ipv6-address
10228           in: path
10229           description: IP address
10230           required: true
10231           type: string
10232           example: __L3-INTERFACE-IPV6-ADDRESS__
10233     put:
10234       tags:
10235         - CloudInfrastructure
10236       summary: create or update an existing l3-interface-ipv6-address-list
10237       description: |
10238         Create or update an existing l3-interface-ipv6-address-list.
10239         #
10240         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10241       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10242       consumes:
10243         - application/json
10244         - application/xml
10245       produces:
10246         - application/json
10247         - application/xml
10248       responses:
10249         "default":
10250           description: Response codes found in [response codes](https://wiki.onap.org/).
10251       parameters:
10252         - name: hostname
10253           in: path
10254           description: Value from executing hostname on the compute node.
10255           required: true
10256           type: string
10257           example: __HOSTNAME__
10258         - name: interface-name
10259           in: path
10260           description: Name that identifies the link aggregate interface
10261           required: true
10262           type: string
10263           example: __INTERFACE-NAME__
10264         - name: interface-name
10265           in: path
10266           description: Name given to the interface
10267           required: true
10268           type: string
10269           example: __INTERFACE-NAME__
10270         - name: vlan-interface
10271           in: path
10272           description: String that identifies the interface
10273           required: true
10274           type: string
10275           example: __VLAN-INTERFACE__
10276         - name: l3-interface-ipv6-address
10277           in: path
10278           description: IP address
10279           required: true
10280           type: string
10281           example: __L3-INTERFACE-IPV6-ADDRESS__
10282         - name: body
10283           in: body
10284           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10285           required: true
10286           schema:
10287             $ref: "#/definitions/l3-interface-ipv6-address-list"
10288     patch:
10289       tags:
10290         - CloudInfrastructure
10291       summary: update an existing l3-interface-ipv6-address-list
10292       description: |
10293         Update an existing l3-interface-ipv6-address-list
10294         #
10295         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10296         The PUT operation will entirely replace an existing object.
10297         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10298         #
10299         Other differences between PUT and PATCH are:
10300         #
10301         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10302         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10303         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10304       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10305       consumes:
10306         - application/json
10307         - application/xml
10308       produces:
10309         - application/json
10310         - application/xml
10311       responses:
10312         "default":
10313           description: Response codes found in [response codes](https://wiki.onap.org/).
10314       parameters:
10315         - name: hostname
10316           in: path
10317           description: Value from executing hostname on the compute node.
10318           required: true
10319           type: string
10320           example: __HOSTNAME__
10321         - name: interface-name
10322           in: path
10323           description: Name that identifies the link aggregate interface
10324           required: true
10325           type: string
10326           example: __INTERFACE-NAME__
10327         - name: interface-name
10328           in: path
10329           description: Name given to the interface
10330           required: true
10331           type: string
10332           example: __INTERFACE-NAME__
10333         - name: vlan-interface
10334           in: path
10335           description: String that identifies the interface
10336           required: true
10337           type: string
10338           example: __VLAN-INTERFACE__
10339         - name: l3-interface-ipv6-address
10340           in: path
10341           description: IP address
10342           required: true
10343           type: string
10344           example: __L3-INTERFACE-IPV6-ADDRESS__
10345         - name: body
10346           in: body
10347           description: l3-interface-ipv6-address-list object that needs to be updated.
10348           required: true
10349           schema:
10350             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10351     delete:
10352       tags:
10353         - CloudInfrastructure
10354       summary: delete an existing l3-interface-ipv6-address-list
10355       description: delete an existing l3-interface-ipv6-address-list
10356       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10357       consumes:
10358         - application/json
10359         - application/xml
10360       produces:
10361         - application/json
10362         - application/xml
10363       responses:
10364         "default":
10365           description: Response codes found in [response codes](https://wiki.onap.org/).
10366       parameters:
10367         - name: hostname
10368           in: path
10369           description: Value from executing hostname on the compute node.
10370           required: true
10371           type: string
10372           example: __HOSTNAME__
10373         - name: interface-name
10374           in: path
10375           description: Name that identifies the link aggregate interface
10376           required: true
10377           type: string
10378           example: __INTERFACE-NAME__
10379         - name: interface-name
10380           in: path
10381           description: Name given to the interface
10382           required: true
10383           type: string
10384           example: __INTERFACE-NAME__
10385         - name: vlan-interface
10386           in: path
10387           description: String that identifies the interface
10388           required: true
10389           type: string
10390           example: __VLAN-INTERFACE__
10391         - name: l3-interface-ipv6-address
10392           in: path
10393           description: IP address
10394           required: true
10395           type: string
10396           example: __L3-INTERFACE-IPV6-ADDRESS__
10397         - name: resource-version
10398           in: query
10399           description: resource-version for concurrency
10400           required: true
10401           type: string
10402   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10403     get:
10404       tags:
10405         - CloudInfrastructure
10406       summary: returns vlan
10407       description: returns vlan
10408       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10409       produces:
10410         - application/json
10411         - application/xml
10412       responses:
10413         "200":
10414           description: successful operation
10415           schema:
10416               $ref: "#/getDefinitions/vlan"
10417         "default":
10418           description: Response codes found in [response codes](https://wiki.onap.org/).
10419       parameters:
10420         - name: hostname
10421           in: path
10422           description: Value from executing hostname on the compute node.
10423           required: true
10424           type: string
10425           example: __HOSTNAME__
10426         - name: interface-name
10427           in: path
10428           description: Name that identifies the link aggregate interface
10429           required: true
10430           type: string
10431           example: __INTERFACE-NAME__
10432         - name: interface-name
10433           in: path
10434           description: Name given to the interface
10435           required: true
10436           type: string
10437           example: __INTERFACE-NAME__
10438         - name: vlan-interface
10439           in: path
10440           description: String that identifies the interface
10441           required: true
10442           type: string
10443           example: __VLAN-INTERFACE__
10444     put:
10445       tags:
10446         - CloudInfrastructure
10447       summary: create or update an existing vlan
10448       description: |
10449         Create or update an existing vlan.
10450         #
10451         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10452       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10453       consumes:
10454         - application/json
10455         - application/xml
10456       produces:
10457         - application/json
10458         - application/xml
10459       responses:
10460         "default":
10461           description: Response codes found in [response codes](https://wiki.onap.org/).
10462       parameters:
10463         - name: hostname
10464           in: path
10465           description: Value from executing hostname on the compute node.
10466           required: true
10467           type: string
10468           example: __HOSTNAME__
10469         - name: interface-name
10470           in: path
10471           description: Name that identifies the link aggregate interface
10472           required: true
10473           type: string
10474           example: __INTERFACE-NAME__
10475         - name: interface-name
10476           in: path
10477           description: Name given to the interface
10478           required: true
10479           type: string
10480           example: __INTERFACE-NAME__
10481         - name: vlan-interface
10482           in: path
10483           description: String that identifies the interface
10484           required: true
10485           type: string
10486           example: __VLAN-INTERFACE__
10487         - name: body
10488           in: body
10489           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10490           required: true
10491           schema:
10492             $ref: "#/definitions/vlan"
10493     patch:
10494       tags:
10495         - CloudInfrastructure
10496       summary: update an existing vlan
10497       description: |
10498         Update an existing vlan
10499         #
10500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10501         The PUT operation will entirely replace an existing object.
10502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10503         #
10504         Other differences between PUT and PATCH are:
10505         #
10506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10509       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10510       consumes:
10511         - application/json
10512         - application/xml
10513       produces:
10514         - application/json
10515         - application/xml
10516       responses:
10517         "default":
10518           description: Response codes found in [response codes](https://wiki.onap.org/).
10519       parameters:
10520         - name: hostname
10521           in: path
10522           description: Value from executing hostname on the compute node.
10523           required: true
10524           type: string
10525           example: __HOSTNAME__
10526         - name: interface-name
10527           in: path
10528           description: Name that identifies the link aggregate interface
10529           required: true
10530           type: string
10531           example: __INTERFACE-NAME__
10532         - name: interface-name
10533           in: path
10534           description: Name given to the interface
10535           required: true
10536           type: string
10537           example: __INTERFACE-NAME__
10538         - name: vlan-interface
10539           in: path
10540           description: String that identifies the interface
10541           required: true
10542           type: string
10543           example: __VLAN-INTERFACE__
10544         - name: body
10545           in: body
10546           description: vlan object that needs to be updated.
10547           required: true
10548           schema:
10549             $ref: "#/patchDefinitions/vlan"
10550     delete:
10551       tags:
10552         - CloudInfrastructure
10553       summary: delete an existing vlan
10554       description: delete an existing vlan
10555       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10556       consumes:
10557         - application/json
10558         - application/xml
10559       produces:
10560         - application/json
10561         - application/xml
10562       responses:
10563         "default":
10564           description: Response codes found in [response codes](https://wiki.onap.org/).
10565       parameters:
10566         - name: hostname
10567           in: path
10568           description: Value from executing hostname on the compute node.
10569           required: true
10570           type: string
10571           example: __HOSTNAME__
10572         - name: interface-name
10573           in: path
10574           description: Name that identifies the link aggregate interface
10575           required: true
10576           type: string
10577           example: __INTERFACE-NAME__
10578         - name: interface-name
10579           in: path
10580           description: Name given to the interface
10581           required: true
10582           type: string
10583           example: __INTERFACE-NAME__
10584         - name: vlan-interface
10585           in: path
10586           description: String that identifies the interface
10587           required: true
10588           type: string
10589           example: __VLAN-INTERFACE__
10590         - name: resource-version
10591           in: query
10592           description: resource-version for concurrency
10593           required: true
10594           type: string
10595   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10596     get:
10597       tags:
10598         - CloudInfrastructure
10599       summary: returns vlans
10600       description: returns vlans
10601       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10602       produces:
10603         - application/json
10604         - application/xml
10605       responses:
10606         "200":
10607           description: successful operation
10608           schema:
10609               $ref: "#/getDefinitions/vlans"
10610         "default":
10611           description: Response codes found in [response codes](https://wiki.onap.org/).
10612       parameters:
10613         - name: hostname
10614           in: path
10615           description: Value from executing hostname on the compute node.
10616           required: true
10617           type: string
10618           example: __HOSTNAME__
10619         - name: interface-name
10620           in: path
10621           description: Name that identifies the link aggregate interface
10622           required: true
10623           type: string
10624           example: __INTERFACE-NAME__
10625         - name: interface-name
10626           in: path
10627           description: Name given to the interface
10628           required: true
10629           type: string
10630           example: __INTERFACE-NAME__
10631         - name: vlan-interface
10632           in: query
10633           description:
10634           required: false
10635           type: string
10636         - name: vlan-id-inner
10637           in: query
10638           description:
10639           required: false
10640           type: integer
10641           format: int64
10642         - name: vpn-id
10643           in: query
10644           description:
10645           required: false
10646           type: string
10647   /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:
10648     put:
10649       tags:
10650         - CloudInfrastructure
10651       summary: see node definition for valid relationships
10652       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10653       consumes:
10654         - application/json
10655         - application/xml
10656       produces:
10657         - application/json
10658         - application/xml
10659       responses:
10660         "default":
10661           description: Response codes found in [response codes](https://wiki.onap.org/).
10662       parameters:
10663         - name: hostname
10664           in: path
10665           description: Value from executing hostname on the compute node.
10666           required: true
10667           type: string
10668           example: __HOSTNAME__
10669         - name: interface-name
10670           in: path
10671           description: Name that identifies the link aggregate interface
10672           required: true
10673           type: string
10674           example: __INTERFACE-NAME__
10675         - name: interface-name
10676           in: path
10677           description: Name given to the interface
10678           required: true
10679           type: string
10680           example: __INTERFACE-NAME__
10681         - name: pci-id
10682           in: path
10683           description: PCI ID used to identify the sriov-vf
10684           required: true
10685           type: string
10686           example: __PCI-ID__
10687         - name: body
10688           in: body
10689           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10690           required: true
10691           schema:
10692             $ref: "#/definitions/relationship"
10693     delete:
10694       tags:
10695         - CloudInfrastructure
10696       summary: delete an existing relationship
10697       description: delete an existing relationship
10698       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10699       consumes:
10700         - application/json
10701         - application/xml
10702       produces:
10703         - application/json
10704         - application/xml
10705       responses:
10706         "default":
10707           description: Response codes found in [response codes](https://wiki.onap.org/).
10708       parameters:
10709         - name: hostname
10710           in: path
10711           description: Value from executing hostname on the compute node.
10712           required: true
10713           type: string
10714           example: __HOSTNAME__
10715         - name: interface-name
10716           in: path
10717           description: Name that identifies the link aggregate interface
10718           required: true
10719           type: string
10720           example: __INTERFACE-NAME__
10721         - name: interface-name
10722           in: path
10723           description: Name given to the interface
10724           required: true
10725           type: string
10726           example: __INTERFACE-NAME__
10727         - name: pci-id
10728           in: path
10729           description: PCI ID used to identify the sriov-vf
10730           required: true
10731           type: string
10732           example: __PCI-ID__
10733   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10734     get:
10735       tags:
10736         - CloudInfrastructure
10737       summary: returns sriov-vf
10738       description: returns sriov-vf
10739       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10740       produces:
10741         - application/json
10742         - application/xml
10743       responses:
10744         "200":
10745           description: successful operation
10746           schema:
10747               $ref: "#/getDefinitions/sriov-vf"
10748         "default":
10749           description: Response codes found in [response codes](https://wiki.onap.org/).
10750       parameters:
10751         - name: hostname
10752           in: path
10753           description: Value from executing hostname on the compute node.
10754           required: true
10755           type: string
10756           example: __HOSTNAME__
10757         - name: interface-name
10758           in: path
10759           description: Name that identifies the link aggregate interface
10760           required: true
10761           type: string
10762           example: __INTERFACE-NAME__
10763         - name: interface-name
10764           in: path
10765           description: Name given to the interface
10766           required: true
10767           type: string
10768           example: __INTERFACE-NAME__
10769         - name: pci-id
10770           in: path
10771           description: PCI ID used to identify the sriov-vf
10772           required: true
10773           type: string
10774           example: __PCI-ID__
10775     put:
10776       tags:
10777         - CloudInfrastructure
10778       summary: create or update an existing sriov-vf
10779       description: |
10780         Create or update an existing sriov-vf.
10781         #
10782         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10783       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10784       consumes:
10785         - application/json
10786         - application/xml
10787       produces:
10788         - application/json
10789         - application/xml
10790       responses:
10791         "default":
10792           description: Response codes found in [response codes](https://wiki.onap.org/).
10793       parameters:
10794         - name: hostname
10795           in: path
10796           description: Value from executing hostname on the compute node.
10797           required: true
10798           type: string
10799           example: __HOSTNAME__
10800         - name: interface-name
10801           in: path
10802           description: Name that identifies the link aggregate interface
10803           required: true
10804           type: string
10805           example: __INTERFACE-NAME__
10806         - name: interface-name
10807           in: path
10808           description: Name given to the interface
10809           required: true
10810           type: string
10811           example: __INTERFACE-NAME__
10812         - name: pci-id
10813           in: path
10814           description: PCI ID used to identify the sriov-vf
10815           required: true
10816           type: string
10817           example: __PCI-ID__
10818         - name: body
10819           in: body
10820           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10821           required: true
10822           schema:
10823             $ref: "#/definitions/sriov-vf"
10824     patch:
10825       tags:
10826         - CloudInfrastructure
10827       summary: update an existing sriov-vf
10828       description: |
10829         Update an existing sriov-vf
10830         #
10831         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832         The PUT operation will entirely replace an existing object.
10833         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10834         #
10835         Other differences between PUT and PATCH are:
10836         #
10837         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10838         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10841       consumes:
10842         - application/json
10843         - application/xml
10844       produces:
10845         - application/json
10846         - application/xml
10847       responses:
10848         "default":
10849           description: Response codes found in [response codes](https://wiki.onap.org/).
10850       parameters:
10851         - name: hostname
10852           in: path
10853           description: Value from executing hostname on the compute node.
10854           required: true
10855           type: string
10856           example: __HOSTNAME__
10857         - name: interface-name
10858           in: path
10859           description: Name that identifies the link aggregate interface
10860           required: true
10861           type: string
10862           example: __INTERFACE-NAME__
10863         - name: interface-name
10864           in: path
10865           description: Name given to the interface
10866           required: true
10867           type: string
10868           example: __INTERFACE-NAME__
10869         - name: pci-id
10870           in: path
10871           description: PCI ID used to identify the sriov-vf
10872           required: true
10873           type: string
10874           example: __PCI-ID__
10875         - name: body
10876           in: body
10877           description: sriov-vf object that needs to be updated.
10878           required: true
10879           schema:
10880             $ref: "#/patchDefinitions/sriov-vf"
10881     delete:
10882       tags:
10883         - CloudInfrastructure
10884       summary: delete an existing sriov-vf
10885       description: delete an existing sriov-vf
10886       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10887       consumes:
10888         - application/json
10889         - application/xml
10890       produces:
10891         - application/json
10892         - application/xml
10893       responses:
10894         "default":
10895           description: Response codes found in [response codes](https://wiki.onap.org/).
10896       parameters:
10897         - name: hostname
10898           in: path
10899           description: Value from executing hostname on the compute node.
10900           required: true
10901           type: string
10902           example: __HOSTNAME__
10903         - name: interface-name
10904           in: path
10905           description: Name that identifies the link aggregate interface
10906           required: true
10907           type: string
10908           example: __INTERFACE-NAME__
10909         - name: interface-name
10910           in: path
10911           description: Name given to the interface
10912           required: true
10913           type: string
10914           example: __INTERFACE-NAME__
10915         - name: pci-id
10916           in: path
10917           description: PCI ID used to identify the sriov-vf
10918           required: true
10919           type: string
10920           example: __PCI-ID__
10921         - name: resource-version
10922           in: query
10923           description: resource-version for concurrency
10924           required: true
10925           type: string
10926   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10927     get:
10928       tags:
10929         - CloudInfrastructure
10930       summary: returns sriov-vfs
10931       description: returns sriov-vfs
10932       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10933       produces:
10934         - application/json
10935         - application/xml
10936       responses:
10937         "200":
10938           description: successful operation
10939           schema:
10940               $ref: "#/getDefinitions/sriov-vfs"
10941         "default":
10942           description: Response codes found in [response codes](https://wiki.onap.org/).
10943       parameters:
10944         - name: hostname
10945           in: path
10946           description: Value from executing hostname on the compute node.
10947           required: true
10948           type: string
10949           example: __HOSTNAME__
10950         - name: interface-name
10951           in: path
10952           description: Name that identifies the link aggregate interface
10953           required: true
10954           type: string
10955           example: __INTERFACE-NAME__
10956         - name: interface-name
10957           in: path
10958           description: Name given to the interface
10959           required: true
10960           type: string
10961           example: __INTERFACE-NAME__
10962         - name: pci-id
10963           in: query
10964           description:
10965           required: false
10966           type: string
10967         - name: vf-vlan-filter
10968           in: query
10969           description:
10970           required: false
10971           type: string
10972         - name: vf-mac-filter
10973           in: query
10974           description:
10975           required: false
10976           type: string
10977         - name: vf-vlan-strip
10978           in: query
10979           description:
10980           required: false
10981           type: boolean
10982         - name: neutron-network-id
10983           in: query
10984           description:
10985           required: false
10986           type: string
10987   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10988     put:
10989       tags:
10990         - CloudInfrastructure
10991       summary: see node definition for valid relationships
10992       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
10993       consumes:
10994         - application/json
10995         - application/xml
10996       produces:
10997         - application/json
10998         - application/xml
10999       responses:
11000         "default":
11001           description: Response codes found in [response codes](https://wiki.onap.org/).
11002       parameters:
11003         - name: hostname
11004           in: path
11005           description: Value from executing hostname on the compute node.
11006           required: true
11007           type: string
11008           example: __HOSTNAME__
11009         - name: interface-name
11010           in: path
11011           description: Name that identifies the link aggregate interface
11012           required: true
11013           type: string
11014           example: __INTERFACE-NAME__
11015         - name: interface-name
11016           in: path
11017           description: Name given to the interface
11018           required: true
11019           type: string
11020           example: __INTERFACE-NAME__
11021         - name: body
11022           in: body
11023           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11024           required: true
11025           schema:
11026             $ref: "#/definitions/relationship"
11027     delete:
11028       tags:
11029         - CloudInfrastructure
11030       summary: delete an existing relationship
11031       description: delete an existing relationship
11032       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11033       consumes:
11034         - application/json
11035         - application/xml
11036       produces:
11037         - application/json
11038         - application/xml
11039       responses:
11040         "default":
11041           description: Response codes found in [response codes](https://wiki.onap.org/).
11042       parameters:
11043         - name: hostname
11044           in: path
11045           description: Value from executing hostname on the compute node.
11046           required: true
11047           type: string
11048           example: __HOSTNAME__
11049         - name: interface-name
11050           in: path
11051           description: Name that identifies the link aggregate interface
11052           required: true
11053           type: string
11054           example: __INTERFACE-NAME__
11055         - name: interface-name
11056           in: path
11057           description: Name given to the interface
11058           required: true
11059           type: string
11060           example: __INTERFACE-NAME__
11061   /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:
11062     put:
11063       tags:
11064         - CloudInfrastructure
11065       summary: see node definition for valid relationships
11066       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11067       consumes:
11068         - application/json
11069         - application/xml
11070       produces:
11071         - application/json
11072         - application/xml
11073       responses:
11074         "default":
11075           description: Response codes found in [response codes](https://wiki.onap.org/).
11076       parameters:
11077         - name: hostname
11078           in: path
11079           description: Value from executing hostname on the compute node.
11080           required: true
11081           type: string
11082           example: __HOSTNAME__
11083         - name: interface-name
11084           in: path
11085           description: Name that identifies the link aggregate interface
11086           required: true
11087           type: string
11088           example: __INTERFACE-NAME__
11089         - name: interface-name
11090           in: path
11091           description: Name given to the interface
11092           required: true
11093           type: string
11094           example: __INTERFACE-NAME__
11095         - name: l3-interface-ipv4-address
11096           in: path
11097           description: IP address
11098           required: true
11099           type: string
11100           example: __L3-INTERFACE-IPV4-ADDRESS__
11101         - name: body
11102           in: body
11103           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11104           required: true
11105           schema:
11106             $ref: "#/definitions/relationship"
11107     delete:
11108       tags:
11109         - CloudInfrastructure
11110       summary: delete an existing relationship
11111       description: delete an existing relationship
11112       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11113       consumes:
11114         - application/json
11115         - application/xml
11116       produces:
11117         - application/json
11118         - application/xml
11119       responses:
11120         "default":
11121           description: Response codes found in [response codes](https://wiki.onap.org/).
11122       parameters:
11123         - name: hostname
11124           in: path
11125           description: Value from executing hostname on the compute node.
11126           required: true
11127           type: string
11128           example: __HOSTNAME__
11129         - name: interface-name
11130           in: path
11131           description: Name that identifies the link aggregate interface
11132           required: true
11133           type: string
11134           example: __INTERFACE-NAME__
11135         - name: interface-name
11136           in: path
11137           description: Name given to the interface
11138           required: true
11139           type: string
11140           example: __INTERFACE-NAME__
11141         - name: l3-interface-ipv4-address
11142           in: path
11143           description: IP address
11144           required: true
11145           type: string
11146           example: __L3-INTERFACE-IPV4-ADDRESS__
11147   /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}:
11148     get:
11149       tags:
11150         - CloudInfrastructure
11151       summary: returns l3-interface-ipv4-address-list
11152       description: returns l3-interface-ipv4-address-list
11153       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11154       produces:
11155         - application/json
11156         - application/xml
11157       responses:
11158         "200":
11159           description: successful operation
11160           schema:
11161               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11162         "default":
11163           description: Response codes found in [response codes](https://wiki.onap.org/).
11164       parameters:
11165         - name: hostname
11166           in: path
11167           description: Value from executing hostname on the compute node.
11168           required: true
11169           type: string
11170           example: __HOSTNAME__
11171         - name: interface-name
11172           in: path
11173           description: Name that identifies the link aggregate interface
11174           required: true
11175           type: string
11176           example: __INTERFACE-NAME__
11177         - name: interface-name
11178           in: path
11179           description: Name given to the interface
11180           required: true
11181           type: string
11182           example: __INTERFACE-NAME__
11183         - name: l3-interface-ipv4-address
11184           in: path
11185           description: IP address
11186           required: true
11187           type: string
11188           example: __L3-INTERFACE-IPV4-ADDRESS__
11189     put:
11190       tags:
11191         - CloudInfrastructure
11192       summary: create or update an existing l3-interface-ipv4-address-list
11193       description: |
11194         Create or update an existing l3-interface-ipv4-address-list.
11195         #
11196         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11197       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11198       consumes:
11199         - application/json
11200         - application/xml
11201       produces:
11202         - application/json
11203         - application/xml
11204       responses:
11205         "default":
11206           description: Response codes found in [response codes](https://wiki.onap.org/).
11207       parameters:
11208         - name: hostname
11209           in: path
11210           description: Value from executing hostname on the compute node.
11211           required: true
11212           type: string
11213           example: __HOSTNAME__
11214         - name: interface-name
11215           in: path
11216           description: Name that identifies the link aggregate interface
11217           required: true
11218           type: string
11219           example: __INTERFACE-NAME__
11220         - name: interface-name
11221           in: path
11222           description: Name given to the interface
11223           required: true
11224           type: string
11225           example: __INTERFACE-NAME__
11226         - name: l3-interface-ipv4-address
11227           in: path
11228           description: IP address
11229           required: true
11230           type: string
11231           example: __L3-INTERFACE-IPV4-ADDRESS__
11232         - name: body
11233           in: body
11234           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11235           required: true
11236           schema:
11237             $ref: "#/definitions/l3-interface-ipv4-address-list"
11238     patch:
11239       tags:
11240         - CloudInfrastructure
11241       summary: update an existing l3-interface-ipv4-address-list
11242       description: |
11243         Update an existing l3-interface-ipv4-address-list
11244         #
11245         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11246         The PUT operation will entirely replace an existing object.
11247         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11248         #
11249         Other differences between PUT and PATCH are:
11250         #
11251         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11252         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11253         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11254       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11255       consumes:
11256         - application/json
11257         - application/xml
11258       produces:
11259         - application/json
11260         - application/xml
11261       responses:
11262         "default":
11263           description: Response codes found in [response codes](https://wiki.onap.org/).
11264       parameters:
11265         - name: hostname
11266           in: path
11267           description: Value from executing hostname on the compute node.
11268           required: true
11269           type: string
11270           example: __HOSTNAME__
11271         - name: interface-name
11272           in: path
11273           description: Name that identifies the link aggregate interface
11274           required: true
11275           type: string
11276           example: __INTERFACE-NAME__
11277         - name: interface-name
11278           in: path
11279           description: Name given to the interface
11280           required: true
11281           type: string
11282           example: __INTERFACE-NAME__
11283         - name: l3-interface-ipv4-address
11284           in: path
11285           description: IP address
11286           required: true
11287           type: string
11288           example: __L3-INTERFACE-IPV4-ADDRESS__
11289         - name: body
11290           in: body
11291           description: l3-interface-ipv4-address-list object that needs to be updated.
11292           required: true
11293           schema:
11294             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11295     delete:
11296       tags:
11297         - CloudInfrastructure
11298       summary: delete an existing l3-interface-ipv4-address-list
11299       description: delete an existing l3-interface-ipv4-address-list
11300       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11301       consumes:
11302         - application/json
11303         - application/xml
11304       produces:
11305         - application/json
11306         - application/xml
11307       responses:
11308         "default":
11309           description: Response codes found in [response codes](https://wiki.onap.org/).
11310       parameters:
11311         - name: hostname
11312           in: path
11313           description: Value from executing hostname on the compute node.
11314           required: true
11315           type: string
11316           example: __HOSTNAME__
11317         - name: interface-name
11318           in: path
11319           description: Name that identifies the link aggregate interface
11320           required: true
11321           type: string
11322           example: __INTERFACE-NAME__
11323         - name: interface-name
11324           in: path
11325           description: Name given to the interface
11326           required: true
11327           type: string
11328           example: __INTERFACE-NAME__
11329         - name: l3-interface-ipv4-address
11330           in: path
11331           description: IP address
11332           required: true
11333           type: string
11334           example: __L3-INTERFACE-IPV4-ADDRESS__
11335         - name: resource-version
11336           in: query
11337           description: resource-version for concurrency
11338           required: true
11339           type: string
11340   /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:
11341     put:
11342       tags:
11343         - CloudInfrastructure
11344       summary: see node definition for valid relationships
11345       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11346       consumes:
11347         - application/json
11348         - application/xml
11349       produces:
11350         - application/json
11351         - application/xml
11352       responses:
11353         "default":
11354           description: Response codes found in [response codes](https://wiki.onap.org/).
11355       parameters:
11356         - name: hostname
11357           in: path
11358           description: Value from executing hostname on the compute node.
11359           required: true
11360           type: string
11361           example: __HOSTNAME__
11362         - name: interface-name
11363           in: path
11364           description: Name that identifies the link aggregate interface
11365           required: true
11366           type: string
11367           example: __INTERFACE-NAME__
11368         - name: interface-name
11369           in: path
11370           description: Name given to the interface
11371           required: true
11372           type: string
11373           example: __INTERFACE-NAME__
11374         - name: l3-interface-ipv6-address
11375           in: path
11376           description: IP address
11377           required: true
11378           type: string
11379           example: __L3-INTERFACE-IPV6-ADDRESS__
11380         - name: body
11381           in: body
11382           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11383           required: true
11384           schema:
11385             $ref: "#/definitions/relationship"
11386     delete:
11387       tags:
11388         - CloudInfrastructure
11389       summary: delete an existing relationship
11390       description: delete an existing relationship
11391       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11392       consumes:
11393         - application/json
11394         - application/xml
11395       produces:
11396         - application/json
11397         - application/xml
11398       responses:
11399         "default":
11400           description: Response codes found in [response codes](https://wiki.onap.org/).
11401       parameters:
11402         - name: hostname
11403           in: path
11404           description: Value from executing hostname on the compute node.
11405           required: true
11406           type: string
11407           example: __HOSTNAME__
11408         - name: interface-name
11409           in: path
11410           description: Name that identifies the link aggregate interface
11411           required: true
11412           type: string
11413           example: __INTERFACE-NAME__
11414         - name: interface-name
11415           in: path
11416           description: Name given to the interface
11417           required: true
11418           type: string
11419           example: __INTERFACE-NAME__
11420         - name: l3-interface-ipv6-address
11421           in: path
11422           description: IP address
11423           required: true
11424           type: string
11425           example: __L3-INTERFACE-IPV6-ADDRESS__
11426   /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}:
11427     get:
11428       tags:
11429         - CloudInfrastructure
11430       summary: returns l3-interface-ipv6-address-list
11431       description: returns l3-interface-ipv6-address-list
11432       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11433       produces:
11434         - application/json
11435         - application/xml
11436       responses:
11437         "200":
11438           description: successful operation
11439           schema:
11440               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11441         "default":
11442           description: Response codes found in [response codes](https://wiki.onap.org/).
11443       parameters:
11444         - name: hostname
11445           in: path
11446           description: Value from executing hostname on the compute node.
11447           required: true
11448           type: string
11449           example: __HOSTNAME__
11450         - name: interface-name
11451           in: path
11452           description: Name that identifies the link aggregate interface
11453           required: true
11454           type: string
11455           example: __INTERFACE-NAME__
11456         - name: interface-name
11457           in: path
11458           description: Name given to the interface
11459           required: true
11460           type: string
11461           example: __INTERFACE-NAME__
11462         - name: l3-interface-ipv6-address
11463           in: path
11464           description: IP address
11465           required: true
11466           type: string
11467           example: __L3-INTERFACE-IPV6-ADDRESS__
11468     put:
11469       tags:
11470         - CloudInfrastructure
11471       summary: create or update an existing l3-interface-ipv6-address-list
11472       description: |
11473         Create or update an existing l3-interface-ipv6-address-list.
11474         #
11475         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11476       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11477       consumes:
11478         - application/json
11479         - application/xml
11480       produces:
11481         - application/json
11482         - application/xml
11483       responses:
11484         "default":
11485           description: Response codes found in [response codes](https://wiki.onap.org/).
11486       parameters:
11487         - name: hostname
11488           in: path
11489           description: Value from executing hostname on the compute node.
11490           required: true
11491           type: string
11492           example: __HOSTNAME__
11493         - name: interface-name
11494           in: path
11495           description: Name that identifies the link aggregate interface
11496           required: true
11497           type: string
11498           example: __INTERFACE-NAME__
11499         - name: interface-name
11500           in: path
11501           description: Name given to the interface
11502           required: true
11503           type: string
11504           example: __INTERFACE-NAME__
11505         - name: l3-interface-ipv6-address
11506           in: path
11507           description: IP address
11508           required: true
11509           type: string
11510           example: __L3-INTERFACE-IPV6-ADDRESS__
11511         - name: body
11512           in: body
11513           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11514           required: true
11515           schema:
11516             $ref: "#/definitions/l3-interface-ipv6-address-list"
11517     patch:
11518       tags:
11519         - CloudInfrastructure
11520       summary: update an existing l3-interface-ipv6-address-list
11521       description: |
11522         Update an existing l3-interface-ipv6-address-list
11523         #
11524         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11525         The PUT operation will entirely replace an existing object.
11526         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11527         #
11528         Other differences between PUT and PATCH are:
11529         #
11530         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11531         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11532         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11533       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11534       consumes:
11535         - application/json
11536         - application/xml
11537       produces:
11538         - application/json
11539         - application/xml
11540       responses:
11541         "default":
11542           description: Response codes found in [response codes](https://wiki.onap.org/).
11543       parameters:
11544         - name: hostname
11545           in: path
11546           description: Value from executing hostname on the compute node.
11547           required: true
11548           type: string
11549           example: __HOSTNAME__
11550         - name: interface-name
11551           in: path
11552           description: Name that identifies the link aggregate interface
11553           required: true
11554           type: string
11555           example: __INTERFACE-NAME__
11556         - name: interface-name
11557           in: path
11558           description: Name given to the interface
11559           required: true
11560           type: string
11561           example: __INTERFACE-NAME__
11562         - name: l3-interface-ipv6-address
11563           in: path
11564           description: IP address
11565           required: true
11566           type: string
11567           example: __L3-INTERFACE-IPV6-ADDRESS__
11568         - name: body
11569           in: body
11570           description: l3-interface-ipv6-address-list object that needs to be updated.
11571           required: true
11572           schema:
11573             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11574     delete:
11575       tags:
11576         - CloudInfrastructure
11577       summary: delete an existing l3-interface-ipv6-address-list
11578       description: delete an existing l3-interface-ipv6-address-list
11579       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11580       consumes:
11581         - application/json
11582         - application/xml
11583       produces:
11584         - application/json
11585         - application/xml
11586       responses:
11587         "default":
11588           description: Response codes found in [response codes](https://wiki.onap.org/).
11589       parameters:
11590         - name: hostname
11591           in: path
11592           description: Value from executing hostname on the compute node.
11593           required: true
11594           type: string
11595           example: __HOSTNAME__
11596         - name: interface-name
11597           in: path
11598           description: Name that identifies the link aggregate interface
11599           required: true
11600           type: string
11601           example: __INTERFACE-NAME__
11602         - name: interface-name
11603           in: path
11604           description: Name given to the interface
11605           required: true
11606           type: string
11607           example: __INTERFACE-NAME__
11608         - name: l3-interface-ipv6-address
11609           in: path
11610           description: IP address
11611           required: true
11612           type: string
11613           example: __L3-INTERFACE-IPV6-ADDRESS__
11614         - name: resource-version
11615           in: query
11616           description: resource-version for concurrency
11617           required: true
11618           type: string
11619   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11620     get:
11621       tags:
11622         - CloudInfrastructure
11623       summary: returns l-interface
11624       description: returns l-interface
11625       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11626       produces:
11627         - application/json
11628         - application/xml
11629       responses:
11630         "200":
11631           description: successful operation
11632           schema:
11633               $ref: "#/getDefinitions/l-interface"
11634         "default":
11635           description: Response codes found in [response codes](https://wiki.onap.org/).
11636       parameters:
11637         - name: hostname
11638           in: path
11639           description: Value from executing hostname on the compute node.
11640           required: true
11641           type: string
11642           example: __HOSTNAME__
11643         - name: interface-name
11644           in: path
11645           description: Name that identifies the link aggregate interface
11646           required: true
11647           type: string
11648           example: __INTERFACE-NAME__
11649         - name: interface-name
11650           in: path
11651           description: Name given to the interface
11652           required: true
11653           type: string
11654           example: __INTERFACE-NAME__
11655     put:
11656       tags:
11657         - CloudInfrastructure
11658       summary: create or update an existing l-interface
11659       description: |
11660         Create or update an existing l-interface.
11661         #
11662         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11663       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11664       consumes:
11665         - application/json
11666         - application/xml
11667       produces:
11668         - application/json
11669         - application/xml
11670       responses:
11671         "default":
11672           description: Response codes found in [response codes](https://wiki.onap.org/).
11673       parameters:
11674         - name: hostname
11675           in: path
11676           description: Value from executing hostname on the compute node.
11677           required: true
11678           type: string
11679           example: __HOSTNAME__
11680         - name: interface-name
11681           in: path
11682           description: Name that identifies the link aggregate interface
11683           required: true
11684           type: string
11685           example: __INTERFACE-NAME__
11686         - name: interface-name
11687           in: path
11688           description: Name given to the interface
11689           required: true
11690           type: string
11691           example: __INTERFACE-NAME__
11692         - name: body
11693           in: body
11694           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11695           required: true
11696           schema:
11697             $ref: "#/definitions/l-interface"
11698     patch:
11699       tags:
11700         - CloudInfrastructure
11701       summary: update an existing l-interface
11702       description: |
11703         Update an existing l-interface
11704         #
11705         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11706         The PUT operation will entirely replace an existing object.
11707         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11708         #
11709         Other differences between PUT and PATCH are:
11710         #
11711         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11712         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11713         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11714       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11715       consumes:
11716         - application/json
11717         - application/xml
11718       produces:
11719         - application/json
11720         - application/xml
11721       responses:
11722         "default":
11723           description: Response codes found in [response codes](https://wiki.onap.org/).
11724       parameters:
11725         - name: hostname
11726           in: path
11727           description: Value from executing hostname on the compute node.
11728           required: true
11729           type: string
11730           example: __HOSTNAME__
11731         - name: interface-name
11732           in: path
11733           description: Name that identifies the link aggregate interface
11734           required: true
11735           type: string
11736           example: __INTERFACE-NAME__
11737         - name: interface-name
11738           in: path
11739           description: Name given to the interface
11740           required: true
11741           type: string
11742           example: __INTERFACE-NAME__
11743         - name: body
11744           in: body
11745           description: l-interface object that needs to be updated.
11746           required: true
11747           schema:
11748             $ref: "#/patchDefinitions/l-interface"
11749     delete:
11750       tags:
11751         - CloudInfrastructure
11752       summary: delete an existing l-interface
11753       description: delete an existing l-interface
11754       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11755       consumes:
11756         - application/json
11757         - application/xml
11758       produces:
11759         - application/json
11760         - application/xml
11761       responses:
11762         "default":
11763           description: Response codes found in [response codes](https://wiki.onap.org/).
11764       parameters:
11765         - name: hostname
11766           in: path
11767           description: Value from executing hostname on the compute node.
11768           required: true
11769           type: string
11770           example: __HOSTNAME__
11771         - name: interface-name
11772           in: path
11773           description: Name that identifies the link aggregate interface
11774           required: true
11775           type: string
11776           example: __INTERFACE-NAME__
11777         - name: interface-name
11778           in: path
11779           description: Name given to the interface
11780           required: true
11781           type: string
11782           example: __INTERFACE-NAME__
11783         - name: resource-version
11784           in: query
11785           description: resource-version for concurrency
11786           required: true
11787           type: string
11788   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11789     get:
11790       tags:
11791         - CloudInfrastructure
11792       summary: returns l-interfaces
11793       description: returns l-interfaces
11794       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11795       produces:
11796         - application/json
11797         - application/xml
11798       responses:
11799         "200":
11800           description: successful operation
11801           schema:
11802               $ref: "#/getDefinitions/l-interfaces"
11803         "default":
11804           description: Response codes found in [response codes](https://wiki.onap.org/).
11805       parameters:
11806         - name: hostname
11807           in: path
11808           description: Value from executing hostname on the compute node.
11809           required: true
11810           type: string
11811           example: __HOSTNAME__
11812         - name: interface-name
11813           in: path
11814           description: Name that identifies the link aggregate interface
11815           required: true
11816           type: string
11817           example: __INTERFACE-NAME__
11818         - name: interface-name
11819           in: query
11820           description:
11821           required: false
11822           type: string
11823         - name: interface-id
11824           in: query
11825           description:
11826           required: false
11827           type: string
11828         - name: macaddr
11829           in: query
11830           description:
11831           required: false
11832           type: string
11833         - name: network-name
11834           in: query
11835           description:
11836           required: false
11837           type: string
11838   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11839     get:
11840       tags:
11841         - CloudInfrastructure
11842       summary: returns lag-interface
11843       description: returns lag-interface
11844       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11845       produces:
11846         - application/json
11847         - application/xml
11848       responses:
11849         "200":
11850           description: successful operation
11851           schema:
11852               $ref: "#/getDefinitions/lag-interface"
11853         "default":
11854           description: Response codes found in [response codes](https://wiki.onap.org/).
11855       parameters:
11856         - name: hostname
11857           in: path
11858           description: Value from executing hostname on the compute node.
11859           required: true
11860           type: string
11861           example: __HOSTNAME__
11862         - name: interface-name
11863           in: path
11864           description: Name that identifies the link aggregate interface
11865           required: true
11866           type: string
11867           example: __INTERFACE-NAME__
11868     put:
11869       tags:
11870         - CloudInfrastructure
11871       summary: create or update an existing lag-interface
11872       description: |
11873         Create or update an existing lag-interface.
11874         #
11875         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11876       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11877       consumes:
11878         - application/json
11879         - application/xml
11880       produces:
11881         - application/json
11882         - application/xml
11883       responses:
11884         "default":
11885           description: Response codes found in [response codes](https://wiki.onap.org/).
11886       parameters:
11887         - name: hostname
11888           in: path
11889           description: Value from executing hostname on the compute node.
11890           required: true
11891           type: string
11892           example: __HOSTNAME__
11893         - name: interface-name
11894           in: path
11895           description: Name that identifies the link aggregate interface
11896           required: true
11897           type: string
11898           example: __INTERFACE-NAME__
11899         - name: body
11900           in: body
11901           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11902           required: true
11903           schema:
11904             $ref: "#/definitions/lag-interface"
11905     patch:
11906       tags:
11907         - CloudInfrastructure
11908       summary: update an existing lag-interface
11909       description: |
11910         Update an existing lag-interface
11911         #
11912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11913         The PUT operation will entirely replace an existing object.
11914         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11915         #
11916         Other differences between PUT and PATCH are:
11917         #
11918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11921       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11922       consumes:
11923         - application/json
11924         - application/xml
11925       produces:
11926         - application/json
11927         - application/xml
11928       responses:
11929         "default":
11930           description: Response codes found in [response codes](https://wiki.onap.org/).
11931       parameters:
11932         - name: hostname
11933           in: path
11934           description: Value from executing hostname on the compute node.
11935           required: true
11936           type: string
11937           example: __HOSTNAME__
11938         - name: interface-name
11939           in: path
11940           description: Name that identifies the link aggregate interface
11941           required: true
11942           type: string
11943           example: __INTERFACE-NAME__
11944         - name: body
11945           in: body
11946           description: lag-interface object that needs to be updated.
11947           required: true
11948           schema:
11949             $ref: "#/patchDefinitions/lag-interface"
11950     delete:
11951       tags:
11952         - CloudInfrastructure
11953       summary: delete an existing lag-interface
11954       description: delete an existing lag-interface
11955       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11956       consumes:
11957         - application/json
11958         - application/xml
11959       produces:
11960         - application/json
11961         - application/xml
11962       responses:
11963         "default":
11964           description: Response codes found in [response codes](https://wiki.onap.org/).
11965       parameters:
11966         - name: hostname
11967           in: path
11968           description: Value from executing hostname on the compute node.
11969           required: true
11970           type: string
11971           example: __HOSTNAME__
11972         - name: interface-name
11973           in: path
11974           description: Name that identifies the link aggregate interface
11975           required: true
11976           type: string
11977           example: __INTERFACE-NAME__
11978         - name: resource-version
11979           in: query
11980           description: resource-version for concurrency
11981           required: true
11982           type: string
11983   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11984     get:
11985       tags:
11986         - CloudInfrastructure
11987       summary: returns lag-interfaces
11988       description: returns lag-interfaces
11989       operationId: getCloudInfrastructurePserversPserverLagInterfaces
11990       produces:
11991         - application/json
11992         - application/xml
11993       responses:
11994         "200":
11995           description: successful operation
11996           schema:
11997               $ref: "#/getDefinitions/lag-interfaces"
11998         "default":
11999           description: Response codes found in [response codes](https://wiki.onap.org/).
12000       parameters:
12001         - name: hostname
12002           in: path
12003           description: Value from executing hostname on the compute node.
12004           required: true
12005           type: string
12006           example: __HOSTNAME__
12007         - name: interface-name
12008           in: query
12009           description:
12010           required: false
12011           type: string
12012         - name: interface-id
12013           in: query
12014           description:
12015           required: false
12016           type: string
12017         - name: interface-role
12018           in: query
12019           description:
12020           required: false
12021           type: string
12022   /cloud-infrastructure/pservers/pserver/{hostname}:
12023     get:
12024       tags:
12025         - CloudInfrastructure
12026       summary: returns pserver
12027       description: returns pserver
12028       operationId: getCloudInfrastructurePserversPserver
12029       produces:
12030         - application/json
12031         - application/xml
12032       responses:
12033         "200":
12034           description: successful operation
12035           schema:
12036               $ref: "#/getDefinitions/pserver"
12037         "default":
12038           description: Response codes found in [response codes](https://wiki.onap.org/).
12039       parameters:
12040         - name: hostname
12041           in: path
12042           description: Value from executing hostname on the compute node.
12043           required: true
12044           type: string
12045           example: __HOSTNAME__
12046     put:
12047       tags:
12048         - CloudInfrastructure
12049       summary: create or update an existing pserver
12050       description: |
12051         Create or update an existing pserver.
12052         #
12053         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12054       operationId: createOrUpdateCloudInfrastructurePserversPserver
12055       consumes:
12056         - application/json
12057         - application/xml
12058       produces:
12059         - application/json
12060         - application/xml
12061       responses:
12062         "default":
12063           description: Response codes found in [response codes](https://wiki.onap.org/).
12064       parameters:
12065         - name: hostname
12066           in: path
12067           description: Value from executing hostname on the compute node.
12068           required: true
12069           type: string
12070           example: __HOSTNAME__
12071         - name: body
12072           in: body
12073           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
12074           required: true
12075           schema:
12076             $ref: "#/definitions/pserver"
12077     patch:
12078       tags:
12079         - CloudInfrastructure
12080       summary: update an existing pserver
12081       description: |
12082         Update an existing pserver
12083         #
12084         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12085         The PUT operation will entirely replace an existing object.
12086         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12087         #
12088         Other differences between PUT and PATCH are:
12089         #
12090         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12091         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12092         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12093       operationId: UpdateCloudInfrastructurePserversPserver
12094       consumes:
12095         - application/json
12096         - application/xml
12097       produces:
12098         - application/json
12099         - application/xml
12100       responses:
12101         "default":
12102           description: Response codes found in [response codes](https://wiki.onap.org/).
12103       parameters:
12104         - name: hostname
12105           in: path
12106           description: Value from executing hostname on the compute node.
12107           required: true
12108           type: string
12109           example: __HOSTNAME__
12110         - name: body
12111           in: body
12112           description: pserver object that needs to be updated.
12113           required: true
12114           schema:
12115             $ref: "#/patchDefinitions/pserver"
12116     delete:
12117       tags:
12118         - CloudInfrastructure
12119       summary: delete an existing pserver
12120       description: delete an existing pserver
12121       operationId: deleteCloudInfrastructurePserversPserver
12122       consumes:
12123         - application/json
12124         - application/xml
12125       produces:
12126         - application/json
12127         - application/xml
12128       responses:
12129         "default":
12130           description: Response codes found in [response codes](https://wiki.onap.org/).
12131       parameters:
12132         - name: hostname
12133           in: path
12134           description: Value from executing hostname on the compute node.
12135           required: true
12136           type: string
12137           example: __HOSTNAME__
12138         - name: resource-version
12139           in: query
12140           description: resource-version for concurrency
12141           required: true
12142           type: string
12143   /cloud-infrastructure/pservers:
12144     get:
12145       tags:
12146         - CloudInfrastructure
12147       summary: returns pservers
12148       description: returns pservers
12149       operationId: getCloudInfrastructurePservers
12150       produces:
12151         - application/json
12152         - application/xml
12153       responses:
12154         "200":
12155           description: successful operation
12156           schema:
12157               $ref: "#/getDefinitions/pservers"
12158         "default":
12159           description: Response codes found in [response codes](https://wiki.onap.org/).
12160       parameters:
12161         - name: hostname
12162           in: query
12163           description:
12164           required: false
12165           type: string
12166         - name: inv-status
12167           in: query
12168           description:
12169           required: false
12170           type: string
12171         - name: pserver-id
12172           in: query
12173           description:
12174           required: false
12175           type: string
12176         - name: in-maint
12177           in: query
12178           description:
12179           required: false
12180           type: boolean
12181         - name: pserver-name2
12182           in: query
12183           description:
12184           required: false
12185           type: string
12186   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12187     put:
12188       tags:
12189         - CloudInfrastructure
12190       summary: see node definition for valid relationships
12191       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12192       consumes:
12193         - application/json
12194         - application/xml
12195       produces:
12196         - application/json
12197         - application/xml
12198       responses:
12199         "default":
12200           description: Response codes found in [response codes](https://wiki.onap.org/).
12201       parameters:
12202         - name: vdc-id
12203           in: path
12204           description: Unique ID of the vdc
12205           required: true
12206           type: string
12207           example: __VDC-ID__
12208         - name: body
12209           in: body
12210           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12211           required: true
12212           schema:
12213             $ref: "#/definitions/relationship"
12214     delete:
12215       tags:
12216         - CloudInfrastructure
12217       summary: delete an existing relationship
12218       description: delete an existing relationship
12219       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12220       consumes:
12221         - application/json
12222         - application/xml
12223       produces:
12224         - application/json
12225         - application/xml
12226       responses:
12227         "default":
12228           description: Response codes found in [response codes](https://wiki.onap.org/).
12229       parameters:
12230         - name: vdc-id
12231           in: path
12232           description: Unique ID of the vdc
12233           required: true
12234           type: string
12235           example: __VDC-ID__
12236   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12237     get:
12238       tags:
12239         - CloudInfrastructure
12240       summary: returns virtual-data-center
12241       description: returns virtual-data-center
12242       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12243       produces:
12244         - application/json
12245         - application/xml
12246       responses:
12247         "200":
12248           description: successful operation
12249           schema:
12250               $ref: "#/getDefinitions/virtual-data-center"
12251         "default":
12252           description: Response codes found in [response codes](https://wiki.onap.org/).
12253       parameters:
12254         - name: vdc-id
12255           in: path
12256           description: Unique ID of the vdc
12257           required: true
12258           type: string
12259           example: __VDC-ID__
12260     put:
12261       tags:
12262         - CloudInfrastructure
12263       summary: create or update an existing virtual-data-center
12264       description: |
12265         Create or update an existing virtual-data-center.
12266         #
12267         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12268       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12269       consumes:
12270         - application/json
12271         - application/xml
12272       produces:
12273         - application/json
12274         - application/xml
12275       responses:
12276         "default":
12277           description: Response codes found in [response codes](https://wiki.onap.org/).
12278       parameters:
12279         - name: vdc-id
12280           in: path
12281           description: Unique ID of the vdc
12282           required: true
12283           type: string
12284           example: __VDC-ID__
12285         - name: body
12286           in: body
12287           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12288           required: true
12289           schema:
12290             $ref: "#/definitions/virtual-data-center"
12291     patch:
12292       tags:
12293         - CloudInfrastructure
12294       summary: update an existing virtual-data-center
12295       description: |
12296         Update an existing virtual-data-center
12297         #
12298         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12299         The PUT operation will entirely replace an existing object.
12300         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12301         #
12302         Other differences between PUT and PATCH are:
12303         #
12304         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12305         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12306         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12307       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12308       consumes:
12309         - application/json
12310         - application/xml
12311       produces:
12312         - application/json
12313         - application/xml
12314       responses:
12315         "default":
12316           description: Response codes found in [response codes](https://wiki.onap.org/).
12317       parameters:
12318         - name: vdc-id
12319           in: path
12320           description: Unique ID of the vdc
12321           required: true
12322           type: string
12323           example: __VDC-ID__
12324         - name: body
12325           in: body
12326           description: virtual-data-center object that needs to be updated.
12327           required: true
12328           schema:
12329             $ref: "#/patchDefinitions/virtual-data-center"
12330     delete:
12331       tags:
12332         - CloudInfrastructure
12333       summary: delete an existing virtual-data-center
12334       description: delete an existing virtual-data-center
12335       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
12336       consumes:
12337         - application/json
12338         - application/xml
12339       produces:
12340         - application/json
12341         - application/xml
12342       responses:
12343         "default":
12344           description: Response codes found in [response codes](https://wiki.onap.org/).
12345       parameters:
12346         - name: vdc-id
12347           in: path
12348           description: Unique ID of the vdc
12349           required: true
12350           type: string
12351           example: __VDC-ID__
12352         - name: resource-version
12353           in: query
12354           description: resource-version for concurrency
12355           required: true
12356           type: string
12357   /cloud-infrastructure/virtual-data-centers:
12358     get:
12359       tags:
12360         - CloudInfrastructure
12361       summary: returns virtual-data-centers
12362       description: returns virtual-data-centers
12363       operationId: getCloudInfrastructureVirtualDataCenters
12364       produces:
12365         - application/json
12366         - application/xml
12367       responses:
12368         "200":
12369           description: successful operation
12370           schema:
12371               $ref: "#/getDefinitions/virtual-data-centers"
12372         "default":
12373           description: Response codes found in [response codes](https://wiki.onap.org/).
12374       parameters:
12375         - name: vdc-id
12376           in: query
12377           description:
12378           required: false
12379           type: string
12380         - name: vdc-name
12381           in: query
12382           description:
12383           required: false
12384           type: string
12385   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12386     put:
12387       tags:
12388         - Business
12389       summary: see node definition for valid relationships
12390       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12391       consumes:
12392         - application/json
12393         - application/xml
12394       produces:
12395         - application/json
12396         - application/xml
12397       responses:
12398         "default":
12399           description: Response codes found in [response codes](https://wiki.onap.org/).
12400       parameters:
12401         - name: resource-instance-id
12402           in: path
12403           description: Unique id of resource instance.
12404           required: true
12405           type: string
12406           example: __RESOURCE-INSTANCE-ID__
12407         - name: body
12408           in: body
12409           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
12410           required: true
12411           schema:
12412             $ref: "#/definitions/relationship"
12413     delete:
12414       tags:
12415         - Business
12416       summary: delete an existing relationship
12417       description: delete an existing relationship
12418       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12419       consumes:
12420         - application/json
12421         - application/xml
12422       produces:
12423         - application/json
12424         - application/xml
12425       responses:
12426         "default":
12427           description: Response codes found in [response codes](https://wiki.onap.org/).
12428       parameters:
12429         - name: resource-instance-id
12430           in: path
12431           description: Unique id of resource instance.
12432           required: true
12433           type: string
12434           example: __RESOURCE-INSTANCE-ID__
12435   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12436     get:
12437       tags:
12438         - Business
12439       summary: returns metadatum
12440       description: returns metadatum
12441       operationId: getBusinessConnectorsConnectorMetadataMetadatum
12442       produces:
12443         - application/json
12444         - application/xml
12445       responses:
12446         "200":
12447           description: successful operation
12448           schema:
12449               $ref: "#/getDefinitions/metadatum"
12450         "default":
12451           description: Response codes found in [response codes](https://wiki.onap.org/).
12452       parameters:
12453         - name: resource-instance-id
12454           in: path
12455           description: Unique id of resource instance.
12456           required: true
12457           type: string
12458           example: __RESOURCE-INSTANCE-ID__
12459         - name: metaname
12460           in: path
12461           required: true
12462           type: string
12463           example: __METANAME__
12464     put:
12465       tags:
12466         - Business
12467       summary: create or update an existing metadatum
12468       description: |
12469         Create or update an existing metadatum.
12470         #
12471         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12472       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12473       consumes:
12474         - application/json
12475         - application/xml
12476       produces:
12477         - application/json
12478         - application/xml
12479       responses:
12480         "default":
12481           description: Response codes found in [response codes](https://wiki.onap.org/).
12482       parameters:
12483         - name: resource-instance-id
12484           in: path
12485           description: Unique id of resource instance.
12486           required: true
12487           type: string
12488           example: __RESOURCE-INSTANCE-ID__
12489         - name: metaname
12490           in: path
12491           required: true
12492           type: string
12493           example: __METANAME__
12494         - name: body
12495           in: body
12496           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnectorMetadataMetadatum.json)
12497           required: true
12498           schema:
12499             $ref: "#/definitions/metadatum"
12500     patch:
12501       tags:
12502         - Business
12503       summary: update an existing metadatum
12504       description: |
12505         Update an existing metadatum
12506         #
12507         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12508         The PUT operation will entirely replace an existing object.
12509         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12510         #
12511         Other differences between PUT and PATCH are:
12512         #
12513         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12514         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12515         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12516       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12517       consumes:
12518         - application/json
12519         - application/xml
12520       produces:
12521         - application/json
12522         - application/xml
12523       responses:
12524         "default":
12525           description: Response codes found in [response codes](https://wiki.onap.org/).
12526       parameters:
12527         - name: resource-instance-id
12528           in: path
12529           description: Unique id of resource instance.
12530           required: true
12531           type: string
12532           example: __RESOURCE-INSTANCE-ID__
12533         - name: metaname
12534           in: path
12535           required: true
12536           type: string
12537           example: __METANAME__
12538         - name: body
12539           in: body
12540           description: metadatum object that needs to be updated.
12541           required: true
12542           schema:
12543             $ref: "#/patchDefinitions/metadatum"
12544     delete:
12545       tags:
12546         - Business
12547       summary: delete an existing metadatum
12548       description: delete an existing metadatum
12549       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12550       consumes:
12551         - application/json
12552         - application/xml
12553       produces:
12554         - application/json
12555         - application/xml
12556       responses:
12557         "default":
12558           description: Response codes found in [response codes](https://wiki.onap.org/).
12559       parameters:
12560         - name: resource-instance-id
12561           in: path
12562           description: Unique id of resource instance.
12563           required: true
12564           type: string
12565           example: __RESOURCE-INSTANCE-ID__
12566         - name: metaname
12567           in: path
12568           required: true
12569           type: string
12570           example: __METANAME__
12571         - name: resource-version
12572           in: query
12573           description: resource-version for concurrency
12574           required: true
12575           type: string
12576   /business/connectors/connector/{resource-instance-id}/metadata:
12577     get:
12578       tags:
12579         - Business
12580       summary: returns metadata
12581       description: returns metadata
12582       operationId: getBusinessConnectorsConnectorMetadata
12583       produces:
12584         - application/json
12585         - application/xml
12586       responses:
12587         "200":
12588           description: successful operation
12589           schema:
12590               $ref: "#/getDefinitions/metadata"
12591         "default":
12592           description: Response codes found in [response codes](https://wiki.onap.org/).
12593       parameters:
12594         - name: resource-instance-id
12595           in: path
12596           description: Unique id of resource instance.
12597           required: true
12598           type: string
12599           example: __RESOURCE-INSTANCE-ID__
12600         - name: metaname
12601           in: query
12602           description:
12603           required: false
12604           type: string
12605   /business/connectors/connector/{resource-instance-id}:
12606     get:
12607       tags:
12608         - Business
12609       summary: returns connector
12610       description: returns connector
12611       operationId: getBusinessConnectorsConnector
12612       produces:
12613         - application/json
12614         - application/xml
12615       responses:
12616         "200":
12617           description: successful operation
12618           schema:
12619               $ref: "#/getDefinitions/connector"
12620         "default":
12621           description: Response codes found in [response codes](https://wiki.onap.org/).
12622       parameters:
12623         - name: resource-instance-id
12624           in: path
12625           description: Unique id of resource instance.
12626           required: true
12627           type: string
12628           example: __RESOURCE-INSTANCE-ID__
12629     put:
12630       tags:
12631         - Business
12632       summary: create or update an existing connector
12633       description: |
12634         Create or update an existing connector.
12635         #
12636         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12637       operationId: createOrUpdateBusinessConnectorsConnector
12638       consumes:
12639         - application/json
12640         - application/xml
12641       produces:
12642         - application/json
12643         - application/xml
12644       responses:
12645         "default":
12646           description: Response codes found in [response codes](https://wiki.onap.org/).
12647       parameters:
12648         - name: resource-instance-id
12649           in: path
12650           description: Unique id of resource instance.
12651           required: true
12652           type: string
12653           example: __RESOURCE-INSTANCE-ID__
12654         - name: body
12655           in: body
12656           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
12657           required: true
12658           schema:
12659             $ref: "#/definitions/connector"
12660     patch:
12661       tags:
12662         - Business
12663       summary: update an existing connector
12664       description: |
12665         Update an existing connector
12666         #
12667         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12668         The PUT operation will entirely replace an existing object.
12669         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12670         #
12671         Other differences between PUT and PATCH are:
12672         #
12673         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12674         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12675         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12676       operationId: UpdateBusinessConnectorsConnector
12677       consumes:
12678         - application/json
12679         - application/xml
12680       produces:
12681         - application/json
12682         - application/xml
12683       responses:
12684         "default":
12685           description: Response codes found in [response codes](https://wiki.onap.org/).
12686       parameters:
12687         - name: resource-instance-id
12688           in: path
12689           description: Unique id of resource instance.
12690           required: true
12691           type: string
12692           example: __RESOURCE-INSTANCE-ID__
12693         - name: body
12694           in: body
12695           description: connector object that needs to be updated.
12696           required: true
12697           schema:
12698             $ref: "#/patchDefinitions/connector"
12699     delete:
12700       tags:
12701         - Business
12702       summary: delete an existing connector
12703       description: delete an existing connector
12704       operationId: deleteBusinessConnectorsConnector
12705       consumes:
12706         - application/json
12707         - application/xml
12708       produces:
12709         - application/json
12710         - application/xml
12711       responses:
12712         "default":
12713           description: Response codes found in [response codes](https://wiki.onap.org/).
12714       parameters:
12715         - name: resource-instance-id
12716           in: path
12717           description: Unique id of resource instance.
12718           required: true
12719           type: string
12720           example: __RESOURCE-INSTANCE-ID__
12721         - name: resource-version
12722           in: query
12723           description: resource-version for concurrency
12724           required: true
12725           type: string
12726   /business/connectors:
12727     get:
12728       tags:
12729         - Business
12730       summary: returns connectors
12731       description: returns connectors
12732       operationId: getBusinessConnectors
12733       produces:
12734         - application/json
12735         - application/xml
12736       responses:
12737         "200":
12738           description: successful operation
12739           schema:
12740               $ref: "#/getDefinitions/connectors"
12741         "default":
12742           description: Response codes found in [response codes](https://wiki.onap.org/).
12743       parameters:
12744         - name: resource-instance-id
12745           in: query
12746           description:
12747           required: false
12748           type: string
12749         - name: model-invariant-id
12750           in: query
12751           description:
12752           required: false
12753           type: string
12754         - name: model-version-id
12755           in: query
12756           description:
12757           required: false
12758           type: string
12759         - name: widget-model-id
12760           in: query
12761           description:
12762           required: false
12763           type: string
12764         - name: widget-model-version
12765           in: query
12766           description:
12767           required: false
12768           type: string
12769   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12770     put:
12771       tags:
12772         - Business
12773       summary: see node definition for valid relationships
12774       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12775       consumes:
12776         - application/json
12777         - application/xml
12778       produces:
12779         - application/json
12780         - application/xml
12781       responses:
12782         "default":
12783           description: Response codes found in [response codes](https://wiki.onap.org/).
12784       parameters:
12785         - name: global-customer-id
12786           in: path
12787           description: Global customer id used across ECOMP to uniquely identify customer.
12788           required: true
12789           type: string
12790           example: __GLOBAL-CUSTOMER-ID__
12791         - name: service-type
12792           in: path
12793           description: Value defined by orchestration to identify this service across ECOMP.
12794           required: true
12795           type: string
12796           example: __SERVICE-TYPE__
12797         - name: service-instance-id
12798           in: path
12799           description: Uniquely identifies this instance of a service
12800           required: true
12801           type: string
12802           example: __SERVICE-INSTANCE-ID__
12803         - name: body
12804           in: body
12805           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12806           required: true
12807           schema:
12808             $ref: "#/definitions/relationship"
12809     delete:
12810       tags:
12811         - Business
12812       summary: delete an existing relationship
12813       description: delete an existing relationship
12814       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12815       consumes:
12816         - application/json
12817         - application/xml
12818       produces:
12819         - application/json
12820         - application/xml
12821       responses:
12822         "default":
12823           description: Response codes found in [response codes](https://wiki.onap.org/).
12824       parameters:
12825         - name: global-customer-id
12826           in: path
12827           description: Global customer id used across ECOMP to uniquely identify customer.
12828           required: true
12829           type: string
12830           example: __GLOBAL-CUSTOMER-ID__
12831         - name: service-type
12832           in: path
12833           description: Value defined by orchestration to identify this service across ECOMP.
12834           required: true
12835           type: string
12836           example: __SERVICE-TYPE__
12837         - name: service-instance-id
12838           in: path
12839           description: Uniquely identifies this instance of a service
12840           required: true
12841           type: string
12842           example: __SERVICE-INSTANCE-ID__
12843   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12844     get:
12845       tags:
12846         - Business
12847       summary: returns metadatum
12848       description: returns metadatum
12849       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12850       produces:
12851         - application/json
12852         - application/xml
12853       responses:
12854         "200":
12855           description: successful operation
12856           schema:
12857               $ref: "#/getDefinitions/metadatum"
12858         "default":
12859           description: Response codes found in [response codes](https://wiki.onap.org/).
12860       parameters:
12861         - name: global-customer-id
12862           in: path
12863           description: Global customer id used across ECOMP to uniquely identify customer.
12864           required: true
12865           type: string
12866           example: __GLOBAL-CUSTOMER-ID__
12867         - name: service-type
12868           in: path
12869           description: Value defined by orchestration to identify this service across ECOMP.
12870           required: true
12871           type: string
12872           example: __SERVICE-TYPE__
12873         - name: service-instance-id
12874           in: path
12875           description: Uniquely identifies this instance of a service
12876           required: true
12877           type: string
12878           example: __SERVICE-INSTANCE-ID__
12879         - name: metaname
12880           in: path
12881           required: true
12882           type: string
12883           example: __METANAME__
12884     put:
12885       tags:
12886         - Business
12887       summary: create or update an existing metadatum
12888       description: |
12889         Create or update an existing metadatum.
12890         #
12891         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12892       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12893       consumes:
12894         - application/json
12895         - application/xml
12896       produces:
12897         - application/json
12898         - application/xml
12899       responses:
12900         "default":
12901           description: Response codes found in [response codes](https://wiki.onap.org/).
12902       parameters:
12903         - name: global-customer-id
12904           in: path
12905           description: Global customer id used across ECOMP to uniquely identify customer.
12906           required: true
12907           type: string
12908           example: __GLOBAL-CUSTOMER-ID__
12909         - name: service-type
12910           in: path
12911           description: Value defined by orchestration to identify this service across ECOMP.
12912           required: true
12913           type: string
12914           example: __SERVICE-TYPE__
12915         - name: service-instance-id
12916           in: path
12917           description: Uniquely identifies this instance of a service
12918           required: true
12919           type: string
12920           example: __SERVICE-INSTANCE-ID__
12921         - name: metaname
12922           in: path
12923           required: true
12924           type: string
12925           example: __METANAME__
12926         - name: body
12927           in: body
12928           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12929           required: true
12930           schema:
12931             $ref: "#/definitions/metadatum"
12932     patch:
12933       tags:
12934         - Business
12935       summary: update an existing metadatum
12936       description: |
12937         Update an existing metadatum
12938         #
12939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12940         The PUT operation will entirely replace an existing object.
12941         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12942         #
12943         Other differences between PUT and PATCH are:
12944         #
12945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12948       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12949       consumes:
12950         - application/json
12951         - application/xml
12952       produces:
12953         - application/json
12954         - application/xml
12955       responses:
12956         "default":
12957           description: Response codes found in [response codes](https://wiki.onap.org/).
12958       parameters:
12959         - name: global-customer-id
12960           in: path
12961           description: Global customer id used across ECOMP to uniquely identify customer.
12962           required: true
12963           type: string
12964           example: __GLOBAL-CUSTOMER-ID__
12965         - name: service-type
12966           in: path
12967           description: Value defined by orchestration to identify this service across ECOMP.
12968           required: true
12969           type: string
12970           example: __SERVICE-TYPE__
12971         - name: service-instance-id
12972           in: path
12973           description: Uniquely identifies this instance of a service
12974           required: true
12975           type: string
12976           example: __SERVICE-INSTANCE-ID__
12977         - name: metaname
12978           in: path
12979           required: true
12980           type: string
12981           example: __METANAME__
12982         - name: body
12983           in: body
12984           description: metadatum object that needs to be updated.
12985           required: true
12986           schema:
12987             $ref: "#/patchDefinitions/metadatum"
12988     delete:
12989       tags:
12990         - Business
12991       summary: delete an existing metadatum
12992       description: delete an existing metadatum
12993       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12994       consumes:
12995         - application/json
12996         - application/xml
12997       produces:
12998         - application/json
12999         - application/xml
13000       responses:
13001         "default":
13002           description: Response codes found in [response codes](https://wiki.onap.org/).
13003       parameters:
13004         - name: global-customer-id
13005           in: path
13006           description: Global customer id used across ECOMP to uniquely identify customer.
13007           required: true
13008           type: string
13009           example: __GLOBAL-CUSTOMER-ID__
13010         - name: service-type
13011           in: path
13012           description: Value defined by orchestration to identify this service across ECOMP.
13013           required: true
13014           type: string
13015           example: __SERVICE-TYPE__
13016         - name: service-instance-id
13017           in: path
13018           description: Uniquely identifies this instance of a service
13019           required: true
13020           type: string
13021           example: __SERVICE-INSTANCE-ID__
13022         - name: metaname
13023           in: path
13024           required: true
13025           type: string
13026           example: __METANAME__
13027         - name: resource-version
13028           in: query
13029           description: resource-version for concurrency
13030           required: true
13031           type: string
13032   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13033     get:
13034       tags:
13035         - Business
13036       summary: returns metadata
13037       description: returns metadata
13038       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13039       produces:
13040         - application/json
13041         - application/xml
13042       responses:
13043         "200":
13044           description: successful operation
13045           schema:
13046               $ref: "#/getDefinitions/metadata"
13047         "default":
13048           description: Response codes found in [response codes](https://wiki.onap.org/).
13049       parameters:
13050         - name: global-customer-id
13051           in: path
13052           description: Global customer id used across ECOMP to uniquely identify customer.
13053           required: true
13054           type: string
13055           example: __GLOBAL-CUSTOMER-ID__
13056         - name: service-type
13057           in: path
13058           description: Value defined by orchestration to identify this service across ECOMP.
13059           required: true
13060           type: string
13061           example: __SERVICE-TYPE__
13062         - name: service-instance-id
13063           in: path
13064           description: Uniquely identifies this instance of a service
13065           required: true
13066           type: string
13067           example: __SERVICE-INSTANCE-ID__
13068         - name: metaname
13069           in: query
13070           description:
13071           required: false
13072           type: string
13073   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
13074     put:
13075       tags:
13076         - Business
13077       summary: see node definition for valid relationships
13078       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13079       consumes:
13080         - application/json
13081         - application/xml
13082       produces:
13083         - application/json
13084         - application/xml
13085       responses:
13086         "default":
13087           description: Response codes found in [response codes](https://wiki.onap.org/).
13088       parameters:
13089         - name: global-customer-id
13090           in: path
13091           description: Global customer id used across ECOMP to uniquely identify customer.
13092           required: true
13093           type: string
13094           example: __GLOBAL-CUSTOMER-ID__
13095         - name: service-type
13096           in: path
13097           description: Value defined by orchestration to identify this service across ECOMP.
13098           required: true
13099           type: string
13100           example: __SERVICE-TYPE__
13101         - name: service-instance-id
13102           in: path
13103           description: Uniquely identifies this instance of a service
13104           required: true
13105           type: string
13106           example: __SERVICE-INSTANCE-ID__
13107         - name: id
13108           in: path
13109           description: Allotted Resource id UUID assigned to this instance.
13110           required: true
13111           type: string
13112           example: __ID__
13113         - name: id
13114           in: path
13115           description: Allotted Resource id UUID assigned to this instance.
13116           required: true
13117           type: string
13118           example: __ID__
13119         - name: body
13120           in: body
13121           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13122           required: true
13123           schema:
13124             $ref: "#/definitions/relationship"
13125     delete:
13126       tags:
13127         - Business
13128       summary: delete an existing relationship
13129       description: delete an existing relationship
13130       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13131       consumes:
13132         - application/json
13133         - application/xml
13134       produces:
13135         - application/json
13136         - application/xml
13137       responses:
13138         "default":
13139           description: Response codes found in [response codes](https://wiki.onap.org/).
13140       parameters:
13141         - name: global-customer-id
13142           in: path
13143           description: Global customer id used across ECOMP to uniquely identify customer.
13144           required: true
13145           type: string
13146           example: __GLOBAL-CUSTOMER-ID__
13147         - name: service-type
13148           in: path
13149           description: Value defined by orchestration to identify this service across ECOMP.
13150           required: true
13151           type: string
13152           example: __SERVICE-TYPE__
13153         - name: service-instance-id
13154           in: path
13155           description: Uniquely identifies this instance of a service
13156           required: true
13157           type: string
13158           example: __SERVICE-INSTANCE-ID__
13159         - name: id
13160           in: path
13161           description: Allotted Resource id UUID assigned to this instance.
13162           required: true
13163           type: string
13164           example: __ID__
13165         - name: id
13166           in: path
13167           description: Allotted Resource id UUID assigned to this instance.
13168           required: true
13169           type: string
13170           example: __ID__
13171   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
13172     get:
13173       tags:
13174         - Business
13175       summary: returns tunnel-xconnect
13176       description: returns tunnel-xconnect
13177       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13178       produces:
13179         - application/json
13180         - application/xml
13181       responses:
13182         "200":
13183           description: successful operation
13184           schema:
13185               $ref: "#/getDefinitions/tunnel-xconnect"
13186         "default":
13187           description: Response codes found in [response codes](https://wiki.onap.org/).
13188       parameters:
13189         - name: global-customer-id
13190           in: path
13191           description: Global customer id used across ECOMP to uniquely identify customer.
13192           required: true
13193           type: string
13194           example: __GLOBAL-CUSTOMER-ID__
13195         - name: service-type
13196           in: path
13197           description: Value defined by orchestration to identify this service across ECOMP.
13198           required: true
13199           type: string
13200           example: __SERVICE-TYPE__
13201         - name: service-instance-id
13202           in: path
13203           description: Uniquely identifies this instance of a service
13204           required: true
13205           type: string
13206           example: __SERVICE-INSTANCE-ID__
13207         - name: id
13208           in: path
13209           description: Allotted Resource id UUID assigned to this instance.
13210           required: true
13211           type: string
13212           example: __ID__
13213         - name: id
13214           in: path
13215           description: Allotted Resource id UUID assigned to this instance.
13216           required: true
13217           type: string
13218           example: __ID__
13219     put:
13220       tags:
13221         - Business
13222       summary: create or update an existing tunnel-xconnect
13223       description: |
13224         Create or update an existing tunnel-xconnect.
13225         #
13226         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13227       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13228       consumes:
13229         - application/json
13230         - application/xml
13231       produces:
13232         - application/json
13233         - application/xml
13234       responses:
13235         "default":
13236           description: Response codes found in [response codes](https://wiki.onap.org/).
13237       parameters:
13238         - name: global-customer-id
13239           in: path
13240           description: Global customer id used across ECOMP to uniquely identify customer.
13241           required: true
13242           type: string
13243           example: __GLOBAL-CUSTOMER-ID__
13244         - name: service-type
13245           in: path
13246           description: Value defined by orchestration to identify this service across ECOMP.
13247           required: true
13248           type: string
13249           example: __SERVICE-TYPE__
13250         - name: service-instance-id
13251           in: path
13252           description: Uniquely identifies this instance of a service
13253           required: true
13254           type: string
13255           example: __SERVICE-INSTANCE-ID__
13256         - name: id
13257           in: path
13258           description: Allotted Resource id UUID assigned to this instance.
13259           required: true
13260           type: string
13261           example: __ID__
13262         - name: id
13263           in: path
13264           description: Allotted Resource id UUID assigned to this instance.
13265           required: true
13266           type: string
13267           example: __ID__
13268         - name: body
13269           in: body
13270           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13271           required: true
13272           schema:
13273             $ref: "#/definitions/tunnel-xconnect"
13274     patch:
13275       tags:
13276         - Business
13277       summary: update an existing tunnel-xconnect
13278       description: |
13279         Update an existing tunnel-xconnect
13280         #
13281         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13282         The PUT operation will entirely replace an existing object.
13283         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13284         #
13285         Other differences between PUT and PATCH are:
13286         #
13287         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13288         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13289         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13290       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13291       consumes:
13292         - application/json
13293         - application/xml
13294       produces:
13295         - application/json
13296         - application/xml
13297       responses:
13298         "default":
13299           description: Response codes found in [response codes](https://wiki.onap.org/).
13300       parameters:
13301         - name: global-customer-id
13302           in: path
13303           description: Global customer id used across ECOMP to uniquely identify customer.
13304           required: true
13305           type: string
13306           example: __GLOBAL-CUSTOMER-ID__
13307         - name: service-type
13308           in: path
13309           description: Value defined by orchestration to identify this service across ECOMP.
13310           required: true
13311           type: string
13312           example: __SERVICE-TYPE__
13313         - name: service-instance-id
13314           in: path
13315           description: Uniquely identifies this instance of a service
13316           required: true
13317           type: string
13318           example: __SERVICE-INSTANCE-ID__
13319         - name: id
13320           in: path
13321           description: Allotted Resource id UUID assigned to this instance.
13322           required: true
13323           type: string
13324           example: __ID__
13325         - name: id
13326           in: path
13327           description: Allotted Resource id UUID assigned to this instance.
13328           required: true
13329           type: string
13330           example: __ID__
13331         - name: body
13332           in: body
13333           description: tunnel-xconnect object that needs to be updated.
13334           required: true
13335           schema:
13336             $ref: "#/patchDefinitions/tunnel-xconnect"
13337     delete:
13338       tags:
13339         - Business
13340       summary: delete an existing tunnel-xconnect
13341       description: delete an existing tunnel-xconnect
13342       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13343       consumes:
13344         - application/json
13345         - application/xml
13346       produces:
13347         - application/json
13348         - application/xml
13349       responses:
13350         "default":
13351           description: Response codes found in [response codes](https://wiki.onap.org/).
13352       parameters:
13353         - name: global-customer-id
13354           in: path
13355           description: Global customer id used across ECOMP to uniquely identify customer.
13356           required: true
13357           type: string
13358           example: __GLOBAL-CUSTOMER-ID__
13359         - name: service-type
13360           in: path
13361           description: Value defined by orchestration to identify this service across ECOMP.
13362           required: true
13363           type: string
13364           example: __SERVICE-TYPE__
13365         - name: service-instance-id
13366           in: path
13367           description: Uniquely identifies this instance of a service
13368           required: true
13369           type: string
13370           example: __SERVICE-INSTANCE-ID__
13371         - name: id
13372           in: path
13373           description: Allotted Resource id UUID assigned to this instance.
13374           required: true
13375           type: string
13376           example: __ID__
13377         - name: id
13378           in: path
13379           description: Allotted Resource id UUID assigned to this instance.
13380           required: true
13381           type: string
13382           example: __ID__
13383         - name: resource-version
13384           in: query
13385           description: resource-version for concurrency
13386           required: true
13387           type: string
13388   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
13389     get:
13390       tags:
13391         - Business
13392       summary: returns tunnel-xconnects
13393       description: returns tunnel-xconnects
13394       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
13395       produces:
13396         - application/json
13397         - application/xml
13398       responses:
13399         "200":
13400           description: successful operation
13401           schema:
13402               $ref: "#/getDefinitions/tunnel-xconnects"
13403         "default":
13404           description: Response codes found in [response codes](https://wiki.onap.org/).
13405       parameters:
13406         - name: global-customer-id
13407           in: path
13408           description: Global customer id used across ECOMP to uniquely identify customer.
13409           required: true
13410           type: string
13411           example: __GLOBAL-CUSTOMER-ID__
13412         - name: service-type
13413           in: path
13414           description: Value defined by orchestration to identify this service across ECOMP.
13415           required: true
13416           type: string
13417           example: __SERVICE-TYPE__
13418         - name: service-instance-id
13419           in: path
13420           description: Uniquely identifies this instance of a service
13421           required: true
13422           type: string
13423           example: __SERVICE-INSTANCE-ID__
13424         - name: id
13425           in: path
13426           description: Allotted Resource id UUID assigned to this instance.
13427           required: true
13428           type: string
13429           example: __ID__
13430         - name: id
13431           in: query
13432           description:
13433           required: false
13434           type: string
13435   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
13436     put:
13437       tags:
13438         - Business
13439       summary: see node definition for valid relationships
13440       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13441       consumes:
13442         - application/json
13443         - application/xml
13444       produces:
13445         - application/json
13446         - application/xml
13447       responses:
13448         "default":
13449           description: Response codes found in [response codes](https://wiki.onap.org/).
13450       parameters:
13451         - name: global-customer-id
13452           in: path
13453           description: Global customer id used across ECOMP to uniquely identify customer.
13454           required: true
13455           type: string
13456           example: __GLOBAL-CUSTOMER-ID__
13457         - name: service-type
13458           in: path
13459           description: Value defined by orchestration to identify this service across ECOMP.
13460           required: true
13461           type: string
13462           example: __SERVICE-TYPE__
13463         - name: service-instance-id
13464           in: path
13465           description: Uniquely identifies this instance of a service
13466           required: true
13467           type: string
13468           example: __SERVICE-INSTANCE-ID__
13469         - name: id
13470           in: path
13471           description: Allotted Resource id UUID assigned to this instance.
13472           required: true
13473           type: string
13474           example: __ID__
13475         - name: body
13476           in: body
13477           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13478           required: true
13479           schema:
13480             $ref: "#/definitions/relationship"
13481     delete:
13482       tags:
13483         - Business
13484       summary: delete an existing relationship
13485       description: delete an existing relationship
13486       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13487       consumes:
13488         - application/json
13489         - application/xml
13490       produces:
13491         - application/json
13492         - application/xml
13493       responses:
13494         "default":
13495           description: Response codes found in [response codes](https://wiki.onap.org/).
13496       parameters:
13497         - name: global-customer-id
13498           in: path
13499           description: Global customer id used across ECOMP to uniquely identify customer.
13500           required: true
13501           type: string
13502           example: __GLOBAL-CUSTOMER-ID__
13503         - name: service-type
13504           in: path
13505           description: Value defined by orchestration to identify this service across ECOMP.
13506           required: true
13507           type: string
13508           example: __SERVICE-TYPE__
13509         - name: service-instance-id
13510           in: path
13511           description: Uniquely identifies this instance of a service
13512           required: true
13513           type: string
13514           example: __SERVICE-INSTANCE-ID__
13515         - name: id
13516           in: path
13517           description: Allotted Resource id UUID assigned to this instance.
13518           required: true
13519           type: string
13520           example: __ID__
13521   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
13522     get:
13523       tags:
13524         - Business
13525       summary: returns allotted-resource
13526       description: returns allotted-resource
13527       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13528       produces:
13529         - application/json
13530         - application/xml
13531       responses:
13532         "200":
13533           description: successful operation
13534           schema:
13535               $ref: "#/getDefinitions/allotted-resource"
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: service-type
13546           in: path
13547           description: Value defined by orchestration to identify this service across ECOMP.
13548           required: true
13549           type: string
13550           example: __SERVICE-TYPE__
13551         - name: service-instance-id
13552           in: path
13553           description: Uniquely identifies this instance of a service
13554           required: true
13555           type: string
13556           example: __SERVICE-INSTANCE-ID__
13557         - name: id
13558           in: path
13559           description: Allotted Resource id UUID assigned to this instance.
13560           required: true
13561           type: string
13562           example: __ID__
13563     put:
13564       tags:
13565         - Business
13566       summary: create or update an existing allotted-resource
13567       description: |
13568         Create or update an existing allotted-resource.
13569         #
13570         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13571       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13572       consumes:
13573         - application/json
13574         - application/xml
13575       produces:
13576         - application/json
13577         - application/xml
13578       responses:
13579         "default":
13580           description: Response codes found in [response codes](https://wiki.onap.org/).
13581       parameters:
13582         - name: global-customer-id
13583           in: path
13584           description: Global customer id used across ECOMP to uniquely identify customer.
13585           required: true
13586           type: string
13587           example: __GLOBAL-CUSTOMER-ID__
13588         - name: service-type
13589           in: path
13590           description: Value defined by orchestration to identify this service across ECOMP.
13591           required: true
13592           type: string
13593           example: __SERVICE-TYPE__
13594         - name: service-instance-id
13595           in: path
13596           description: Uniquely identifies this instance of a service
13597           required: true
13598           type: string
13599           example: __SERVICE-INSTANCE-ID__
13600         - name: id
13601           in: path
13602           description: Allotted Resource id UUID assigned to this instance.
13603           required: true
13604           type: string
13605           example: __ID__
13606         - name: body
13607           in: body
13608           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13609           required: true
13610           schema:
13611             $ref: "#/definitions/allotted-resource"
13612     patch:
13613       tags:
13614         - Business
13615       summary: update an existing allotted-resource
13616       description: |
13617         Update an existing allotted-resource
13618         #
13619         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13620         The PUT operation will entirely replace an existing object.
13621         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13622         #
13623         Other differences between PUT and PATCH are:
13624         #
13625         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13626         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13627         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13628       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13629       consumes:
13630         - application/json
13631         - application/xml
13632       produces:
13633         - application/json
13634         - application/xml
13635       responses:
13636         "default":
13637           description: Response codes found in [response codes](https://wiki.onap.org/).
13638       parameters:
13639         - name: global-customer-id
13640           in: path
13641           description: Global customer id used across ECOMP to uniquely identify customer.
13642           required: true
13643           type: string
13644           example: __GLOBAL-CUSTOMER-ID__
13645         - name: service-type
13646           in: path
13647           description: Value defined by orchestration to identify this service across ECOMP.
13648           required: true
13649           type: string
13650           example: __SERVICE-TYPE__
13651         - name: service-instance-id
13652           in: path
13653           description: Uniquely identifies this instance of a service
13654           required: true
13655           type: string
13656           example: __SERVICE-INSTANCE-ID__
13657         - name: id
13658           in: path
13659           description: Allotted Resource id UUID assigned to this instance.
13660           required: true
13661           type: string
13662           example: __ID__
13663         - name: body
13664           in: body
13665           description: allotted-resource object that needs to be updated.
13666           required: true
13667           schema:
13668             $ref: "#/patchDefinitions/allotted-resource"
13669     delete:
13670       tags:
13671         - Business
13672       summary: delete an existing allotted-resource
13673       description: delete an existing allotted-resource
13674       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13675       consumes:
13676         - application/json
13677         - application/xml
13678       produces:
13679         - application/json
13680         - application/xml
13681       responses:
13682         "default":
13683           description: Response codes found in [response codes](https://wiki.onap.org/).
13684       parameters:
13685         - name: global-customer-id
13686           in: path
13687           description: Global customer id used across ECOMP to uniquely identify customer.
13688           required: true
13689           type: string
13690           example: __GLOBAL-CUSTOMER-ID__
13691         - name: service-type
13692           in: path
13693           description: Value defined by orchestration to identify this service across ECOMP.
13694           required: true
13695           type: string
13696           example: __SERVICE-TYPE__
13697         - name: service-instance-id
13698           in: path
13699           description: Uniquely identifies this instance of a service
13700           required: true
13701           type: string
13702           example: __SERVICE-INSTANCE-ID__
13703         - name: id
13704           in: path
13705           description: Allotted Resource id UUID assigned to this instance.
13706           required: true
13707           type: string
13708           example: __ID__
13709         - name: resource-version
13710           in: query
13711           description: resource-version for concurrency
13712           required: true
13713           type: string
13714   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
13715     get:
13716       tags:
13717         - Business
13718       summary: returns allotted-resources
13719       description: returns allotted-resources
13720       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
13721       produces:
13722         - application/json
13723         - application/xml
13724       responses:
13725         "200":
13726           description: successful operation
13727           schema:
13728               $ref: "#/getDefinitions/allotted-resources"
13729         "default":
13730           description: Response codes found in [response codes](https://wiki.onap.org/).
13731       parameters:
13732         - name: global-customer-id
13733           in: path
13734           description: Global customer id used across ECOMP to uniquely identify customer.
13735           required: true
13736           type: string
13737           example: __GLOBAL-CUSTOMER-ID__
13738         - name: service-type
13739           in: path
13740           description: Value defined by orchestration to identify this service across ECOMP.
13741           required: true
13742           type: string
13743           example: __SERVICE-TYPE__
13744         - name: service-instance-id
13745           in: path
13746           description: Uniquely identifies this instance of a service
13747           required: true
13748           type: string
13749           example: __SERVICE-INSTANCE-ID__
13750         - name: id
13751           in: query
13752           description:
13753           required: false
13754           type: string
13755         - name: model-invariant-id
13756           in: query
13757           description:
13758           required: false
13759           type: string
13760         - name: model-version-id
13761           in: query
13762           description:
13763           required: false
13764           type: string
13765         - name: type
13766           in: query
13767           description:
13768           required: false
13769           type: string
13770         - name: role
13771           in: query
13772           description:
13773           required: false
13774           type: string
13775   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13776     get:
13777       tags:
13778         - Business
13779       summary: returns service-instance
13780       description: returns service-instance
13781       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13782       produces:
13783         - application/json
13784         - application/xml
13785       responses:
13786         "200":
13787           description: successful operation
13788           schema:
13789               $ref: "#/getDefinitions/service-instance"
13790         "default":
13791           description: Response codes found in [response codes](https://wiki.onap.org/).
13792       parameters:
13793         - name: global-customer-id
13794           in: path
13795           description: Global customer id used across ECOMP to uniquely identify customer.
13796           required: true
13797           type: string
13798           example: __GLOBAL-CUSTOMER-ID__
13799         - name: service-type
13800           in: path
13801           description: Value defined by orchestration to identify this service across ECOMP.
13802           required: true
13803           type: string
13804           example: __SERVICE-TYPE__
13805         - name: service-instance-id
13806           in: path
13807           description: Uniquely identifies this instance of a service
13808           required: true
13809           type: string
13810           example: __SERVICE-INSTANCE-ID__
13811     put:
13812       tags:
13813         - Business
13814       summary: create or update an existing service-instance
13815       description: |
13816         Create or update an existing service-instance.
13817         #
13818         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13819       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13820       consumes:
13821         - application/json
13822         - application/xml
13823       produces:
13824         - application/json
13825         - application/xml
13826       responses:
13827         "default":
13828           description: Response codes found in [response codes](https://wiki.onap.org/).
13829       parameters:
13830         - name: global-customer-id
13831           in: path
13832           description: Global customer id used across ECOMP to uniquely identify customer.
13833           required: true
13834           type: string
13835           example: __GLOBAL-CUSTOMER-ID__
13836         - name: service-type
13837           in: path
13838           description: Value defined by orchestration to identify this service across ECOMP.
13839           required: true
13840           type: string
13841           example: __SERVICE-TYPE__
13842         - name: service-instance-id
13843           in: path
13844           description: Uniquely identifies this instance of a service
13845           required: true
13846           type: string
13847           example: __SERVICE-INSTANCE-ID__
13848         - name: body
13849           in: body
13850           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13851           required: true
13852           schema:
13853             $ref: "#/definitions/service-instance"
13854     patch:
13855       tags:
13856         - Business
13857       summary: update an existing service-instance
13858       description: |
13859         Update an existing service-instance
13860         #
13861         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13862         The PUT operation will entirely replace an existing object.
13863         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13864         #
13865         Other differences between PUT and PATCH are:
13866         #
13867         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13868         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13869         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13870       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13871       consumes:
13872         - application/json
13873         - application/xml
13874       produces:
13875         - application/json
13876         - application/xml
13877       responses:
13878         "default":
13879           description: Response codes found in [response codes](https://wiki.onap.org/).
13880       parameters:
13881         - name: global-customer-id
13882           in: path
13883           description: Global customer id used across ECOMP to uniquely identify customer.
13884           required: true
13885           type: string
13886           example: __GLOBAL-CUSTOMER-ID__
13887         - name: service-type
13888           in: path
13889           description: Value defined by orchestration to identify this service across ECOMP.
13890           required: true
13891           type: string
13892           example: __SERVICE-TYPE__
13893         - name: service-instance-id
13894           in: path
13895           description: Uniquely identifies this instance of a service
13896           required: true
13897           type: string
13898           example: __SERVICE-INSTANCE-ID__
13899         - name: body
13900           in: body
13901           description: service-instance object that needs to be updated.
13902           required: true
13903           schema:
13904             $ref: "#/patchDefinitions/service-instance"
13905     delete:
13906       tags:
13907         - Business
13908       summary: delete an existing service-instance
13909       description: delete an existing service-instance
13910       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13911       consumes:
13912         - application/json
13913         - application/xml
13914       produces:
13915         - application/json
13916         - application/xml
13917       responses:
13918         "default":
13919           description: Response codes found in [response codes](https://wiki.onap.org/).
13920       parameters:
13921         - name: global-customer-id
13922           in: path
13923           description: Global customer id used across ECOMP to uniquely identify customer.
13924           required: true
13925           type: string
13926           example: __GLOBAL-CUSTOMER-ID__
13927         - name: service-type
13928           in: path
13929           description: Value defined by orchestration to identify this service across ECOMP.
13930           required: true
13931           type: string
13932           example: __SERVICE-TYPE__
13933         - name: service-instance-id
13934           in: path
13935           description: Uniquely identifies this instance of a service
13936           required: true
13937           type: string
13938           example: __SERVICE-INSTANCE-ID__
13939         - name: resource-version
13940           in: query
13941           description: resource-version for concurrency
13942           required: true
13943           type: string
13944   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13945     get:
13946       tags:
13947         - Business
13948       summary: returns service-instances
13949       description: returns service-instances
13950       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13951       produces:
13952         - application/json
13953         - application/xml
13954       responses:
13955         "200":
13956           description: successful operation
13957           schema:
13958               $ref: "#/getDefinitions/service-instances"
13959         "default":
13960           description: Response codes found in [response codes](https://wiki.onap.org/).
13961       parameters:
13962         - name: global-customer-id
13963           in: path
13964           description: Global customer id used across ECOMP to uniquely identify customer.
13965           required: true
13966           type: string
13967           example: __GLOBAL-CUSTOMER-ID__
13968         - name: service-type
13969           in: path
13970           description: Value defined by orchestration to identify this service across ECOMP.
13971           required: true
13972           type: string
13973           example: __SERVICE-TYPE__
13974         - name: service-instance-id
13975           in: query
13976           description:
13977           required: false
13978           type: string
13979         - name: service-instance-name
13980           in: query
13981           description:
13982           required: false
13983           type: string
13984         - name: model-invariant-id
13985           in: query
13986           description:
13987           required: false
13988           type: string
13989         - name: model-version-id
13990           in: query
13991           description:
13992           required: false
13993           type: string
13994         - name: widget-model-id
13995           in: query
13996           description:
13997           required: false
13998           type: string
13999         - name: widget-model-version
14000           in: query
14001           description:
14002           required: false
14003           type: string
14004         - name: service-instance-location-id
14005           in: query
14006           description:
14007           required: false
14008           type: string
14009         - name: orchestration-status
14010           in: query
14011           description:
14012           required: false
14013           type: string
14014   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14015     put:
14016       tags:
14017         - Business
14018       summary: see node definition for valid relationships
14019       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14020       consumes:
14021         - application/json
14022         - application/xml
14023       produces:
14024         - application/json
14025         - application/xml
14026       responses:
14027         "default":
14028           description: Response codes found in [response codes](https://wiki.onap.org/).
14029       parameters:
14030         - name: global-customer-id
14031           in: path
14032           description: Global customer id used across ECOMP to uniquely identify customer.
14033           required: true
14034           type: string
14035           example: __GLOBAL-CUSTOMER-ID__
14036         - name: service-type
14037           in: path
14038           description: Value defined by orchestration to identify this service across ECOMP.
14039           required: true
14040           type: string
14041           example: __SERVICE-TYPE__
14042         - name: body
14043           in: body
14044           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14045           required: true
14046           schema:
14047             $ref: "#/definitions/relationship"
14048     delete:
14049       tags:
14050         - Business
14051       summary: delete an existing relationship
14052       description: delete an existing relationship
14053       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14054       consumes:
14055         - application/json
14056         - application/xml
14057       produces:
14058         - application/json
14059         - application/xml
14060       responses:
14061         "default":
14062           description: Response codes found in [response codes](https://wiki.onap.org/).
14063       parameters:
14064         - name: global-customer-id
14065           in: path
14066           description: Global customer id used across ECOMP to uniquely identify customer.
14067           required: true
14068           type: string
14069           example: __GLOBAL-CUSTOMER-ID__
14070         - name: service-type
14071           in: path
14072           description: Value defined by orchestration to identify this service across ECOMP.
14073           required: true
14074           type: string
14075           example: __SERVICE-TYPE__
14076   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
14077     get:
14078       tags:
14079         - Business
14080       summary: returns service-subscription
14081       description: returns service-subscription
14082       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14083       produces:
14084         - application/json
14085         - application/xml
14086       responses:
14087         "200":
14088           description: successful operation
14089           schema:
14090               $ref: "#/getDefinitions/service-subscription"
14091         "default":
14092           description: Response codes found in [response codes](https://wiki.onap.org/).
14093       parameters:
14094         - name: global-customer-id
14095           in: path
14096           description: Global customer id used across ECOMP to uniquely identify customer.
14097           required: true
14098           type: string
14099           example: __GLOBAL-CUSTOMER-ID__
14100         - name: service-type
14101           in: path
14102           description: Value defined by orchestration to identify this service across ECOMP.
14103           required: true
14104           type: string
14105           example: __SERVICE-TYPE__
14106     put:
14107       tags:
14108         - Business
14109       summary: create or update an existing service-subscription
14110       description: |
14111         Create or update an existing service-subscription.
14112         #
14113         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14114       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14115       consumes:
14116         - application/json
14117         - application/xml
14118       produces:
14119         - application/json
14120         - application/xml
14121       responses:
14122         "default":
14123           description: Response codes found in [response codes](https://wiki.onap.org/).
14124       parameters:
14125         - name: global-customer-id
14126           in: path
14127           description: Global customer id used across ECOMP to uniquely identify customer.
14128           required: true
14129           type: string
14130           example: __GLOBAL-CUSTOMER-ID__
14131         - name: service-type
14132           in: path
14133           description: Value defined by orchestration to identify this service across ECOMP.
14134           required: true
14135           type: string
14136           example: __SERVICE-TYPE__
14137         - name: body
14138           in: body
14139           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14140           required: true
14141           schema:
14142             $ref: "#/definitions/service-subscription"
14143     patch:
14144       tags:
14145         - Business
14146       summary: update an existing service-subscription
14147       description: |
14148         Update an existing service-subscription
14149         #
14150         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14151         The PUT operation will entirely replace an existing object.
14152         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14153         #
14154         Other differences between PUT and PATCH are:
14155         #
14156         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14157         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14158         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14159       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14160       consumes:
14161         - application/json
14162         - application/xml
14163       produces:
14164         - application/json
14165         - application/xml
14166       responses:
14167         "default":
14168           description: Response codes found in [response codes](https://wiki.onap.org/).
14169       parameters:
14170         - name: global-customer-id
14171           in: path
14172           description: Global customer id used across ECOMP to uniquely identify customer.
14173           required: true
14174           type: string
14175           example: __GLOBAL-CUSTOMER-ID__
14176         - name: service-type
14177           in: path
14178           description: Value defined by orchestration to identify this service across ECOMP.
14179           required: true
14180           type: string
14181           example: __SERVICE-TYPE__
14182         - name: body
14183           in: body
14184           description: service-subscription object that needs to be updated.
14185           required: true
14186           schema:
14187             $ref: "#/patchDefinitions/service-subscription"
14188     delete:
14189       tags:
14190         - Business
14191       summary: delete an existing service-subscription
14192       description: delete an existing service-subscription
14193       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14194       consumes:
14195         - application/json
14196         - application/xml
14197       produces:
14198         - application/json
14199         - application/xml
14200       responses:
14201         "default":
14202           description: Response codes found in [response codes](https://wiki.onap.org/).
14203       parameters:
14204         - name: global-customer-id
14205           in: path
14206           description: Global customer id used across ECOMP to uniquely identify customer.
14207           required: true
14208           type: string
14209           example: __GLOBAL-CUSTOMER-ID__
14210         - name: service-type
14211           in: path
14212           description: Value defined by orchestration to identify this service across ECOMP.
14213           required: true
14214           type: string
14215           example: __SERVICE-TYPE__
14216         - name: resource-version
14217           in: query
14218           description: resource-version for concurrency
14219           required: true
14220           type: string
14221   /business/customers/customer/{global-customer-id}/service-subscriptions:
14222     get:
14223       tags:
14224         - Business
14225       summary: returns service-subscriptions
14226       description: returns service-subscriptions
14227       operationId: getBusinessCustomersCustomerServiceSubscriptions
14228       produces:
14229         - application/json
14230         - application/xml
14231       responses:
14232         "200":
14233           description: successful operation
14234           schema:
14235               $ref: "#/getDefinitions/service-subscriptions"
14236         "default":
14237           description: Response codes found in [response codes](https://wiki.onap.org/).
14238       parameters:
14239         - name: global-customer-id
14240           in: path
14241           description: Global customer id used across ECOMP to uniquely identify customer.
14242           required: true
14243           type: string
14244           example: __GLOBAL-CUSTOMER-ID__
14245         - name: service-type
14246           in: query
14247           description:
14248           required: false
14249           type: string
14250   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
14251     put:
14252       tags:
14253         - Business
14254       summary: see node definition for valid relationships
14255       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
14256       consumes:
14257         - application/json
14258         - application/xml
14259       produces:
14260         - application/json
14261         - application/xml
14262       responses:
14263         "default":
14264           description: Response codes found in [response codes](https://wiki.onap.org/).
14265       parameters:
14266         - name: global-customer-id
14267           in: path
14268           description: Global customer id used across ECOMP to uniquely identify customer.
14269           required: true
14270           type: string
14271           example: __GLOBAL-CUSTOMER-ID__
14272         - name: body
14273           in: body
14274           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
14275           required: true
14276           schema:
14277             $ref: "#/definitions/relationship"
14278     delete:
14279       tags:
14280         - Business
14281       summary: delete an existing relationship
14282       description: delete an existing relationship
14283       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
14284       consumes:
14285         - application/json
14286         - application/xml
14287       produces:
14288         - application/json
14289         - application/xml
14290       responses:
14291         "default":
14292           description: Response codes found in [response codes](https://wiki.onap.org/).
14293       parameters:
14294         - name: global-customer-id
14295           in: path
14296           description: Global customer id used across ECOMP to uniquely identify customer.
14297           required: true
14298           type: string
14299           example: __GLOBAL-CUSTOMER-ID__
14300   /business/customers/customer/{global-customer-id}:
14301     get:
14302       tags:
14303         - Business
14304       summary: returns customer
14305       description: returns customer
14306       operationId: getBusinessCustomersCustomer
14307       produces:
14308         - application/json
14309         - application/xml
14310       responses:
14311         "200":
14312           description: successful operation
14313           schema:
14314               $ref: "#/getDefinitions/customer"
14315         "default":
14316           description: Response codes found in [response codes](https://wiki.onap.org/).
14317       parameters:
14318         - name: global-customer-id
14319           in: path
14320           description: Global customer id used across ECOMP to uniquely identify customer.
14321           required: true
14322           type: string
14323           example: __GLOBAL-CUSTOMER-ID__
14324     put:
14325       tags:
14326         - Business
14327       summary: create or update an existing customer
14328       description: |
14329         Create or update an existing customer.
14330         #
14331         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14332       operationId: createOrUpdateBusinessCustomersCustomer
14333       consumes:
14334         - application/json
14335         - application/xml
14336       produces:
14337         - application/json
14338         - application/xml
14339       responses:
14340         "default":
14341           description: Response codes found in [response codes](https://wiki.onap.org/).
14342       parameters:
14343         - name: global-customer-id
14344           in: path
14345           description: Global customer id used across ECOMP to uniquely identify customer.
14346           required: true
14347           type: string
14348           example: __GLOBAL-CUSTOMER-ID__
14349         - name: body
14350           in: body
14351           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
14352           required: true
14353           schema:
14354             $ref: "#/definitions/customer"
14355     patch:
14356       tags:
14357         - Business
14358       summary: update an existing customer
14359       description: |
14360         Update an existing customer
14361         #
14362         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14363         The PUT operation will entirely replace an existing object.
14364         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14365         #
14366         Other differences between PUT and PATCH are:
14367         #
14368         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14369         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14370         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14371       operationId: UpdateBusinessCustomersCustomer
14372       consumes:
14373         - application/json
14374         - application/xml
14375       produces:
14376         - application/json
14377         - application/xml
14378       responses:
14379         "default":
14380           description: Response codes found in [response codes](https://wiki.onap.org/).
14381       parameters:
14382         - name: global-customer-id
14383           in: path
14384           description: Global customer id used across ECOMP to uniquely identify customer.
14385           required: true
14386           type: string
14387           example: __GLOBAL-CUSTOMER-ID__
14388         - name: body
14389           in: body
14390           description: customer object that needs to be updated.
14391           required: true
14392           schema:
14393             $ref: "#/patchDefinitions/customer"
14394     delete:
14395       tags:
14396         - Business
14397       summary: delete an existing customer
14398       description: delete an existing customer
14399       operationId: deleteBusinessCustomersCustomer
14400       consumes:
14401         - application/json
14402         - application/xml
14403       produces:
14404         - application/json
14405         - application/xml
14406       responses:
14407         "default":
14408           description: Response codes found in [response codes](https://wiki.onap.org/).
14409       parameters:
14410         - name: global-customer-id
14411           in: path
14412           description: Global customer id used across ECOMP to uniquely identify customer.
14413           required: true
14414           type: string
14415           example: __GLOBAL-CUSTOMER-ID__
14416         - name: resource-version
14417           in: query
14418           description: resource-version for concurrency
14419           required: true
14420           type: string
14421   /business/customers:
14422     get:
14423       tags:
14424         - Business
14425       summary: returns customers
14426       description: returns customers
14427       operationId: getBusinessCustomers
14428       produces:
14429         - application/json
14430         - application/xml
14431       responses:
14432         "200":
14433           description: successful operation
14434           schema:
14435               $ref: "#/getDefinitions/customers"
14436         "default":
14437           description: Response codes found in [response codes](https://wiki.onap.org/).
14438       parameters:
14439         - name: global-customer-id
14440           in: query
14441           description:
14442           required: false
14443           type: string
14444         - name: subscriber-name
14445           in: query
14446           description:
14447           required: false
14448           type: string
14449         - name: subscriber-type
14450           in: query
14451           description:
14452           required: false
14453           type: string
14454   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
14455     put:
14456       tags:
14457         - ServiceDesignAndCreation
14458       summary: see node definition for valid relationships
14459       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14460       consumes:
14461         - application/json
14462         - application/xml
14463       produces:
14464         - application/json
14465         - application/xml
14466       responses:
14467         "default":
14468           description: Response codes found in [response codes](https://wiki.onap.org/).
14469       parameters:
14470         - name: vnf-image-uuid
14471           in: path
14472           description: Unique ID of this asset
14473           required: true
14474           type: string
14475           example: __VNF-IMAGE-UUID__
14476         - name: body
14477           in: body
14478           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
14479           required: true
14480           schema:
14481             $ref: "#/definitions/relationship"
14482     delete:
14483       tags:
14484         - ServiceDesignAndCreation
14485       summary: delete an existing relationship
14486       description: delete an existing relationship
14487       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14488       consumes:
14489         - application/json
14490         - application/xml
14491       produces:
14492         - application/json
14493         - application/xml
14494       responses:
14495         "default":
14496           description: Response codes found in [response codes](https://wiki.onap.org/).
14497       parameters:
14498         - name: vnf-image-uuid
14499           in: path
14500           description: Unique ID of this asset
14501           required: true
14502           type: string
14503           example: __VNF-IMAGE-UUID__
14504   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
14505     get:
14506       tags:
14507         - ServiceDesignAndCreation
14508       summary: returns vnf-image
14509       description: returns vnf-image
14510       operationId: getServiceDesignAndCreationVnfImagesVnfImage
14511       produces:
14512         - application/json
14513         - application/xml
14514       responses:
14515         "200":
14516           description: successful operation
14517           schema:
14518               $ref: "#/getDefinitions/vnf-image"
14519         "default":
14520           description: Response codes found in [response codes](https://wiki.onap.org/).
14521       parameters:
14522         - name: vnf-image-uuid
14523           in: path
14524           description: Unique ID of this asset
14525           required: true
14526           type: string
14527           example: __VNF-IMAGE-UUID__
14528     put:
14529       tags:
14530         - ServiceDesignAndCreation
14531       summary: create or update an existing vnf-image
14532       description: |
14533         Create or update an existing vnf-image.
14534         #
14535         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14536       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
14537       consumes:
14538         - application/json
14539         - application/xml
14540       produces:
14541         - application/json
14542         - application/xml
14543       responses:
14544         "default":
14545           description: Response codes found in [response codes](https://wiki.onap.org/).
14546       parameters:
14547         - name: vnf-image-uuid
14548           in: path
14549           description: Unique ID of this asset
14550           required: true
14551           type: string
14552           example: __VNF-IMAGE-UUID__
14553         - name: body
14554           in: body
14555           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
14556           required: true
14557           schema:
14558             $ref: "#/definitions/vnf-image"
14559     patch:
14560       tags:
14561         - ServiceDesignAndCreation
14562       summary: update an existing vnf-image
14563       description: |
14564         Update an existing vnf-image
14565         #
14566         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14567         The PUT operation will entirely replace an existing object.
14568         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14569         #
14570         Other differences between PUT and PATCH are:
14571         #
14572         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14573         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14574         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14575       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
14576       consumes:
14577         - application/json
14578         - application/xml
14579       produces:
14580         - application/json
14581         - application/xml
14582       responses:
14583         "default":
14584           description: Response codes found in [response codes](https://wiki.onap.org/).
14585       parameters:
14586         - name: vnf-image-uuid
14587           in: path
14588           description: Unique ID of this asset
14589           required: true
14590           type: string
14591           example: __VNF-IMAGE-UUID__
14592         - name: body
14593           in: body
14594           description: vnf-image object that needs to be updated.
14595           required: true
14596           schema:
14597             $ref: "#/patchDefinitions/vnf-image"
14598     delete:
14599       tags:
14600         - ServiceDesignAndCreation
14601       summary: delete an existing vnf-image
14602       description: delete an existing vnf-image
14603       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
14604       consumes:
14605         - application/json
14606         - application/xml
14607       produces:
14608         - application/json
14609         - application/xml
14610       responses:
14611         "default":
14612           description: Response codes found in [response codes](https://wiki.onap.org/).
14613       parameters:
14614         - name: vnf-image-uuid
14615           in: path
14616           description: Unique ID of this asset
14617           required: true
14618           type: string
14619           example: __VNF-IMAGE-UUID__
14620         - name: resource-version
14621           in: query
14622           description: resource-version for concurrency
14623           required: true
14624           type: string
14625   /service-design-and-creation/vnf-images:
14626     get:
14627       tags:
14628         - ServiceDesignAndCreation
14629       summary: returns vnf-images
14630       description: returns vnf-images
14631       operationId: getServiceDesignAndCreationVnfImages
14632       produces:
14633         - application/json
14634         - application/xml
14635       responses:
14636         "200":
14637           description: successful operation
14638           schema:
14639               $ref: "#/getDefinitions/vnf-images"
14640         "default":
14641           description: Response codes found in [response codes](https://wiki.onap.org/).
14642       parameters:
14643         - name: vnf-image-uuid
14644           in: query
14645           description:
14646           required: false
14647           type: string
14648         - name: application
14649           in: query
14650           description:
14651           required: false
14652           type: string
14653         - name: application-vendor
14654           in: query
14655           description:
14656           required: false
14657           type: string
14658         - name: application-version
14659           in: query
14660           description:
14661           required: false
14662           type: string
14663   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
14664     put:
14665       tags:
14666         - ServiceDesignAndCreation
14667       summary: see node definition for valid relationships
14668       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
14669       consumes:
14670         - application/json
14671         - application/xml
14672       produces:
14673         - application/json
14674         - application/xml
14675       responses:
14676         "default":
14677           description: Response codes found in [response codes](https://wiki.onap.org/).
14678       parameters:
14679         - name: service-id
14680           in: path
14681           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14682           required: true
14683           type: string
14684           example: __SERVICE-ID__
14685         - name: body
14686           in: body
14687           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
14688           required: true
14689           schema:
14690             $ref: "#/definitions/relationship"
14691     delete:
14692       tags:
14693         - ServiceDesignAndCreation
14694       summary: delete an existing relationship
14695       description: delete an existing relationship
14696       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
14697       consumes:
14698         - application/json
14699         - application/xml
14700       produces:
14701         - application/json
14702         - application/xml
14703       responses:
14704         "default":
14705           description: Response codes found in [response codes](https://wiki.onap.org/).
14706       parameters:
14707         - name: service-id
14708           in: path
14709           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14710           required: true
14711           type: string
14712           example: __SERVICE-ID__
14713   /service-design-and-creation/services/service/{service-id}:
14714     get:
14715       tags:
14716         - ServiceDesignAndCreation
14717       summary: returns service
14718       description: returns service
14719       operationId: getServiceDesignAndCreationServicesService
14720       produces:
14721         - application/json
14722         - application/xml
14723       responses:
14724         "200":
14725           description: successful operation
14726           schema:
14727               $ref: "#/getDefinitions/service"
14728         "default":
14729           description: Response codes found in [response codes](https://wiki.onap.org/).
14730       parameters:
14731         - name: service-id
14732           in: path
14733           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14734           required: true
14735           type: string
14736           example: __SERVICE-ID__
14737     put:
14738       tags:
14739         - ServiceDesignAndCreation
14740       summary: create or update an existing service
14741       description: |
14742         Create or update an existing service.
14743         #
14744         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14745       operationId: createOrUpdateServiceDesignAndCreationServicesService
14746       consumes:
14747         - application/json
14748         - application/xml
14749       produces:
14750         - application/json
14751         - application/xml
14752       responses:
14753         "default":
14754           description: Response codes found in [response codes](https://wiki.onap.org/).
14755       parameters:
14756         - name: service-id
14757           in: path
14758           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14759           required: true
14760           type: string
14761           example: __SERVICE-ID__
14762         - name: body
14763           in: body
14764           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
14765           required: true
14766           schema:
14767             $ref: "#/definitions/service"
14768     patch:
14769       tags:
14770         - ServiceDesignAndCreation
14771       summary: update an existing service
14772       description: |
14773         Update an existing service
14774         #
14775         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14776         The PUT operation will entirely replace an existing object.
14777         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14778         #
14779         Other differences between PUT and PATCH are:
14780         #
14781         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14782         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14783         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14784       operationId: UpdateServiceDesignAndCreationServicesService
14785       consumes:
14786         - application/json
14787         - application/xml
14788       produces:
14789         - application/json
14790         - application/xml
14791       responses:
14792         "default":
14793           description: Response codes found in [response codes](https://wiki.onap.org/).
14794       parameters:
14795         - name: service-id
14796           in: path
14797           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14798           required: true
14799           type: string
14800           example: __SERVICE-ID__
14801         - name: body
14802           in: body
14803           description: service object that needs to be updated.
14804           required: true
14805           schema:
14806             $ref: "#/patchDefinitions/service"
14807     delete:
14808       tags:
14809         - ServiceDesignAndCreation
14810       summary: delete an existing service
14811       description: delete an existing service
14812       operationId: deleteServiceDesignAndCreationServicesService
14813       consumes:
14814         - application/json
14815         - application/xml
14816       produces:
14817         - application/json
14818         - application/xml
14819       responses:
14820         "default":
14821           description: Response codes found in [response codes](https://wiki.onap.org/).
14822       parameters:
14823         - name: service-id
14824           in: path
14825           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14826           required: true
14827           type: string
14828           example: __SERVICE-ID__
14829         - name: resource-version
14830           in: query
14831           description: resource-version for concurrency
14832           required: true
14833           type: string
14834   /service-design-and-creation/services:
14835     get:
14836       tags:
14837         - ServiceDesignAndCreation
14838       summary: returns services
14839       description: returns services
14840       operationId: getServiceDesignAndCreationServices
14841       produces:
14842         - application/json
14843         - application/xml
14844       responses:
14845         "200":
14846           description: successful operation
14847           schema:
14848               $ref: "#/getDefinitions/services"
14849         "default":
14850           description: Response codes found in [response codes](https://wiki.onap.org/).
14851       parameters:
14852         - name: service-id
14853           in: query
14854           description:
14855           required: false
14856           type: string
14857         - name: service-description
14858           in: query
14859           description:
14860           required: false
14861           type: string
14862   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14863     put:
14864       tags:
14865         - ServiceDesignAndCreation
14866       summary: see node definition for valid relationships
14867       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14868       consumes:
14869         - application/json
14870         - application/xml
14871       produces:
14872         - application/json
14873         - application/xml
14874       responses:
14875         "default":
14876           description: Response codes found in [response codes](https://wiki.onap.org/).
14877       parameters:
14878         - name: service-type
14879           in: path
14880           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14881           required: true
14882           type: string
14883           example: __SERVICE-TYPE__
14884         - name: vnf-type
14885           in: path
14886           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
14887           required: true
14888           type: string
14889           example: __VNF-TYPE__
14890         - name: body
14891           in: body
14892           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14893           required: true
14894           schema:
14895             $ref: "#/definitions/relationship"
14896     delete:
14897       tags:
14898         - ServiceDesignAndCreation
14899       summary: delete an existing relationship
14900       description: delete an existing relationship
14901       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14902       consumes:
14903         - application/json
14904         - application/xml
14905       produces:
14906         - application/json
14907         - application/xml
14908       responses:
14909         "default":
14910           description: Response codes found in [response codes](https://wiki.onap.org/).
14911       parameters:
14912         - name: service-type
14913           in: path
14914           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14915           required: true
14916           type: string
14917           example: __SERVICE-TYPE__
14918         - name: vnf-type
14919           in: path
14920           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
14921           required: true
14922           type: string
14923           example: __VNF-TYPE__
14924   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14925     get:
14926       tags:
14927         - ServiceDesignAndCreation
14928       summary: returns service-capability
14929       description: returns service-capability
14930       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14931       produces:
14932         - application/json
14933         - application/xml
14934       responses:
14935         "200":
14936           description: successful operation
14937           schema:
14938               $ref: "#/getDefinitions/service-capability"
14939         "default":
14940           description: Response codes found in [response codes](https://wiki.onap.org/).
14941       parameters:
14942         - name: service-type
14943           in: path
14944           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14945           required: true
14946           type: string
14947           example: __SERVICE-TYPE__
14948         - name: vnf-type
14949           in: path
14950           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
14951           required: true
14952           type: string
14953           example: __VNF-TYPE__
14954     put:
14955       tags:
14956         - ServiceDesignAndCreation
14957       summary: create or update an existing service-capability
14958       description: |
14959         Create or update an existing service-capability.
14960         #
14961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14962       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14963       consumes:
14964         - application/json
14965         - application/xml
14966       produces:
14967         - application/json
14968         - application/xml
14969       responses:
14970         "default":
14971           description: Response codes found in [response codes](https://wiki.onap.org/).
14972       parameters:
14973         - name: service-type
14974           in: path
14975           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14976           required: true
14977           type: string
14978           example: __SERVICE-TYPE__
14979         - name: vnf-type
14980           in: path
14981           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
14982           required: true
14983           type: string
14984           example: __VNF-TYPE__
14985         - name: body
14986           in: body
14987           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14988           required: true
14989           schema:
14990             $ref: "#/definitions/service-capability"
14991     patch:
14992       tags:
14993         - ServiceDesignAndCreation
14994       summary: update an existing service-capability
14995       description: |
14996         Update an existing service-capability
14997         #
14998         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14999         The PUT operation will entirely replace an existing object.
15000         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15001         #
15002         Other differences between PUT and PATCH are:
15003         #
15004         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15005         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15006         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15007       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15008       consumes:
15009         - application/json
15010         - application/xml
15011       produces:
15012         - application/json
15013         - application/xml
15014       responses:
15015         "default":
15016           description: Response codes found in [response codes](https://wiki.onap.org/).
15017       parameters:
15018         - name: service-type
15019           in: path
15020           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15021           required: true
15022           type: string
15023           example: __SERVICE-TYPE__
15024         - name: vnf-type
15025           in: path
15026           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
15027           required: true
15028           type: string
15029           example: __VNF-TYPE__
15030         - name: body
15031           in: body
15032           description: service-capability object that needs to be updated.
15033           required: true
15034           schema:
15035             $ref: "#/patchDefinitions/service-capability"
15036     delete:
15037       tags:
15038         - ServiceDesignAndCreation
15039       summary: delete an existing service-capability
15040       description: delete an existing service-capability
15041       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15042       consumes:
15043         - application/json
15044         - application/xml
15045       produces:
15046         - application/json
15047         - application/xml
15048       responses:
15049         "default":
15050           description: Response codes found in [response codes](https://wiki.onap.org/).
15051       parameters:
15052         - name: service-type
15053           in: path
15054           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15055           required: true
15056           type: string
15057           example: __SERVICE-TYPE__
15058         - name: vnf-type
15059           in: path
15060           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
15061           required: true
15062           type: string
15063           example: __VNF-TYPE__
15064         - name: resource-version
15065           in: query
15066           description: resource-version for concurrency
15067           required: true
15068           type: string
15069   /service-design-and-creation/service-capabilities:
15070     get:
15071       tags:
15072         - ServiceDesignAndCreation
15073       summary: returns service-capabilities
15074       description: returns service-capabilities
15075       operationId: getServiceDesignAndCreationServiceCapabilities
15076       produces:
15077         - application/json
15078         - application/xml
15079       responses:
15080         "200":
15081           description: successful operation
15082           schema:
15083               $ref: "#/getDefinitions/service-capabilities"
15084         "default":
15085           description: Response codes found in [response codes](https://wiki.onap.org/).
15086       parameters:
15087         - name: service-type
15088           in: query
15089           description:
15090           required: false
15091           type: string
15092         - name: vnf-type
15093           in: query
15094           description:
15095           required: false
15096           type: string
15097   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
15098     put:
15099       tags:
15100         - ServiceDesignAndCreation
15101       summary: see node definition for valid relationships
15102       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15103       consumes:
15104         - application/json
15105         - application/xml
15106       produces:
15107         - application/json
15108         - application/xml
15109       responses:
15110         "default":
15111           description: Response codes found in [response codes](https://wiki.onap.org/).
15112       parameters:
15113         - name: model-invariant-id
15114           in: path
15115           description: Unique identifier corresponding to the main definition of a model in ASDC
15116           required: true
15117           type: string
15118           example: __MODEL-INVARIANT-ID__
15119         - name: model-version-id
15120           in: path
15121           description: Unique identifier corresponding to one version of a model in ASDC
15122           required: true
15123           type: string
15124           example: __MODEL-VERSION-ID__
15125         - name: model-element-uuid
15126           in: path
15127           required: true
15128           type: string
15129           example: __MODEL-ELEMENT-UUID__
15130         - name: model-constraint-uuid
15131           in: path
15132           required: true
15133           type: string
15134           example: __MODEL-CONSTRAINT-UUID__
15135         - name: constrained-element-set-uuid
15136           in: path
15137           required: true
15138           type: string
15139           example: __CONSTRAINED-ELEMENT-SET-UUID__
15140         - name: element-choice-set-uuid
15141           in: path
15142           required: true
15143           type: string
15144           example: __ELEMENT-CHOICE-SET-UUID__
15145         - name: body
15146           in: body
15147           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15148           required: true
15149           schema:
15150             $ref: "#/definitions/relationship"
15151     delete:
15152       tags:
15153         - ServiceDesignAndCreation
15154       summary: delete an existing relationship
15155       description: delete an existing relationship
15156       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15157       consumes:
15158         - application/json
15159         - application/xml
15160       produces:
15161         - application/json
15162         - application/xml
15163       responses:
15164         "default":
15165           description: Response codes found in [response codes](https://wiki.onap.org/).
15166       parameters:
15167         - name: model-invariant-id
15168           in: path
15169           description: Unique identifier corresponding to the main definition of a model in ASDC
15170           required: true
15171           type: string
15172           example: __MODEL-INVARIANT-ID__
15173         - name: model-version-id
15174           in: path
15175           description: Unique identifier corresponding to one version of a model in ASDC
15176           required: true
15177           type: string
15178           example: __MODEL-VERSION-ID__
15179         - name: model-element-uuid
15180           in: path
15181           required: true
15182           type: string
15183           example: __MODEL-ELEMENT-UUID__
15184         - name: model-constraint-uuid
15185           in: path
15186           required: true
15187           type: string
15188           example: __MODEL-CONSTRAINT-UUID__
15189         - name: constrained-element-set-uuid
15190           in: path
15191           required: true
15192           type: string
15193           example: __CONSTRAINED-ELEMENT-SET-UUID__
15194         - name: element-choice-set-uuid
15195           in: path
15196           required: true
15197           type: string
15198           example: __ELEMENT-CHOICE-SET-UUID__
15199   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
15200     get:
15201       tags:
15202         - ServiceDesignAndCreation
15203       summary: returns element-choice-set
15204       description: returns element-choice-set
15205       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15206       produces:
15207         - application/json
15208         - application/xml
15209       responses:
15210         "200":
15211           description: successful operation
15212           schema:
15213               $ref: "#/getDefinitions/element-choice-set"
15214         "default":
15215           description: Response codes found in [response codes](https://wiki.onap.org/).
15216       parameters:
15217         - name: model-invariant-id
15218           in: path
15219           description: Unique identifier corresponding to the main definition of a model in ASDC
15220           required: true
15221           type: string
15222           example: __MODEL-INVARIANT-ID__
15223         - name: model-version-id
15224           in: path
15225           description: Unique identifier corresponding to one version of a model in ASDC
15226           required: true
15227           type: string
15228           example: __MODEL-VERSION-ID__
15229         - name: model-element-uuid
15230           in: path
15231           required: true
15232           type: string
15233           example: __MODEL-ELEMENT-UUID__
15234         - name: model-constraint-uuid
15235           in: path
15236           required: true
15237           type: string
15238           example: __MODEL-CONSTRAINT-UUID__
15239         - name: constrained-element-set-uuid
15240           in: path
15241           required: true
15242           type: string
15243           example: __CONSTRAINED-ELEMENT-SET-UUID__
15244         - name: element-choice-set-uuid
15245           in: path
15246           required: true
15247           type: string
15248           example: __ELEMENT-CHOICE-SET-UUID__
15249     put:
15250       tags:
15251         - ServiceDesignAndCreation
15252       summary: create or update an existing element-choice-set
15253       description: |
15254         Create or update an existing element-choice-set.
15255         #
15256         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15257       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15258       consumes:
15259         - application/json
15260         - application/xml
15261       produces:
15262         - application/json
15263         - application/xml
15264       responses:
15265         "default":
15266           description: Response codes found in [response codes](https://wiki.onap.org/).
15267       parameters:
15268         - name: model-invariant-id
15269           in: path
15270           description: Unique identifier corresponding to the main definition of a model in ASDC
15271           required: true
15272           type: string
15273           example: __MODEL-INVARIANT-ID__
15274         - name: model-version-id
15275           in: path
15276           description: Unique identifier corresponding to one version of a model in ASDC
15277           required: true
15278           type: string
15279           example: __MODEL-VERSION-ID__
15280         - name: model-element-uuid
15281           in: path
15282           required: true
15283           type: string
15284           example: __MODEL-ELEMENT-UUID__
15285         - name: model-constraint-uuid
15286           in: path
15287           required: true
15288           type: string
15289           example: __MODEL-CONSTRAINT-UUID__
15290         - name: constrained-element-set-uuid
15291           in: path
15292           required: true
15293           type: string
15294           example: __CONSTRAINED-ELEMENT-SET-UUID__
15295         - name: element-choice-set-uuid
15296           in: path
15297           required: true
15298           type: string
15299           example: __ELEMENT-CHOICE-SET-UUID__
15300         - name: body
15301           in: body
15302           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15303           required: true
15304           schema:
15305             $ref: "#/definitions/element-choice-set"
15306     patch:
15307       tags:
15308         - ServiceDesignAndCreation
15309       summary: update an existing element-choice-set
15310       description: |
15311         Update an existing element-choice-set
15312         #
15313         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15314         The PUT operation will entirely replace an existing object.
15315         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15316         #
15317         Other differences between PUT and PATCH are:
15318         #
15319         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15320         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15321         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15322       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15323       consumes:
15324         - application/json
15325         - application/xml
15326       produces:
15327         - application/json
15328         - application/xml
15329       responses:
15330         "default":
15331           description: Response codes found in [response codes](https://wiki.onap.org/).
15332       parameters:
15333         - name: model-invariant-id
15334           in: path
15335           description: Unique identifier corresponding to the main definition of a model in ASDC
15336           required: true
15337           type: string
15338           example: __MODEL-INVARIANT-ID__
15339         - name: model-version-id
15340           in: path
15341           description: Unique identifier corresponding to one version of a model in ASDC
15342           required: true
15343           type: string
15344           example: __MODEL-VERSION-ID__
15345         - name: model-element-uuid
15346           in: path
15347           required: true
15348           type: string
15349           example: __MODEL-ELEMENT-UUID__
15350         - name: model-constraint-uuid
15351           in: path
15352           required: true
15353           type: string
15354           example: __MODEL-CONSTRAINT-UUID__
15355         - name: constrained-element-set-uuid
15356           in: path
15357           required: true
15358           type: string
15359           example: __CONSTRAINED-ELEMENT-SET-UUID__
15360         - name: element-choice-set-uuid
15361           in: path
15362           required: true
15363           type: string
15364           example: __ELEMENT-CHOICE-SET-UUID__
15365         - name: body
15366           in: body
15367           description: element-choice-set object that needs to be updated.
15368           required: true
15369           schema:
15370             $ref: "#/patchDefinitions/element-choice-set"
15371     delete:
15372       tags:
15373         - ServiceDesignAndCreation
15374       summary: delete an existing element-choice-set
15375       description: delete an existing element-choice-set
15376       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15377       consumes:
15378         - application/json
15379         - application/xml
15380       produces:
15381         - application/json
15382         - application/xml
15383       responses:
15384         "default":
15385           description: Response codes found in [response codes](https://wiki.onap.org/).
15386       parameters:
15387         - name: model-invariant-id
15388           in: path
15389           description: Unique identifier corresponding to the main definition of a model in ASDC
15390           required: true
15391           type: string
15392           example: __MODEL-INVARIANT-ID__
15393         - name: model-version-id
15394           in: path
15395           description: Unique identifier corresponding to one version of a model in ASDC
15396           required: true
15397           type: string
15398           example: __MODEL-VERSION-ID__
15399         - name: model-element-uuid
15400           in: path
15401           required: true
15402           type: string
15403           example: __MODEL-ELEMENT-UUID__
15404         - name: model-constraint-uuid
15405           in: path
15406           required: true
15407           type: string
15408           example: __MODEL-CONSTRAINT-UUID__
15409         - name: constrained-element-set-uuid
15410           in: path
15411           required: true
15412           type: string
15413           example: __CONSTRAINED-ELEMENT-SET-UUID__
15414         - name: element-choice-set-uuid
15415           in: path
15416           required: true
15417           type: string
15418           example: __ELEMENT-CHOICE-SET-UUID__
15419         - name: resource-version
15420           in: query
15421           description: resource-version for concurrency
15422           required: true
15423           type: string
15424   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
15425     get:
15426       tags:
15427         - ServiceDesignAndCreation
15428       summary: returns element-choice-sets
15429       description: returns element-choice-sets
15430       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
15431       produces:
15432         - application/json
15433         - application/xml
15434       responses:
15435         "200":
15436           description: successful operation
15437           schema:
15438               $ref: "#/getDefinitions/element-choice-sets"
15439         "default":
15440           description: Response codes found in [response codes](https://wiki.onap.org/).
15441       parameters:
15442         - name: model-invariant-id
15443           in: path
15444           description: Unique identifier corresponding to the main definition of a model in ASDC
15445           required: true
15446           type: string
15447           example: __MODEL-INVARIANT-ID__
15448         - name: model-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-VERSION-ID__
15454         - name: model-element-uuid
15455           in: path
15456           required: true
15457           type: string
15458           example: __MODEL-ELEMENT-UUID__
15459         - name: model-constraint-uuid
15460           in: path
15461           required: true
15462           type: string
15463           example: __MODEL-CONSTRAINT-UUID__
15464         - name: constrained-element-set-uuid
15465           in: path
15466           required: true
15467           type: string
15468           example: __CONSTRAINED-ELEMENT-SET-UUID__
15469         - name: element-choice-set-uuid
15470           in: query
15471           description:
15472           required: false
15473           type: string
15474   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
15475     put:
15476       tags:
15477         - ServiceDesignAndCreation
15478       summary: see node definition for valid relationships
15479       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15480       consumes:
15481         - application/json
15482         - application/xml
15483       produces:
15484         - application/json
15485         - application/xml
15486       responses:
15487         "default":
15488           description: Response codes found in [response codes](https://wiki.onap.org/).
15489       parameters:
15490         - name: model-invariant-id
15491           in: path
15492           description: Unique identifier corresponding to the main definition of a model in ASDC
15493           required: true
15494           type: string
15495           example: __MODEL-INVARIANT-ID__
15496         - name: model-version-id
15497           in: path
15498           description: Unique identifier corresponding to one version of a model in ASDC
15499           required: true
15500           type: string
15501           example: __MODEL-VERSION-ID__
15502         - name: model-element-uuid
15503           in: path
15504           required: true
15505           type: string
15506           example: __MODEL-ELEMENT-UUID__
15507         - name: model-constraint-uuid
15508           in: path
15509           required: true
15510           type: string
15511           example: __MODEL-CONSTRAINT-UUID__
15512         - name: constrained-element-set-uuid
15513           in: path
15514           required: true
15515           type: string
15516           example: __CONSTRAINED-ELEMENT-SET-UUID__
15517         - name: body
15518           in: body
15519           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15520           required: true
15521           schema:
15522             $ref: "#/definitions/relationship"
15523     delete:
15524       tags:
15525         - ServiceDesignAndCreation
15526       summary: delete an existing relationship
15527       description: delete an existing relationship
15528       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15529       consumes:
15530         - application/json
15531         - application/xml
15532       produces:
15533         - application/json
15534         - application/xml
15535       responses:
15536         "default":
15537           description: Response codes found in [response codes](https://wiki.onap.org/).
15538       parameters:
15539         - name: model-invariant-id
15540           in: path
15541           description: Unique identifier corresponding to the main definition of a model in ASDC
15542           required: true
15543           type: string
15544           example: __MODEL-INVARIANT-ID__
15545         - name: model-version-id
15546           in: path
15547           description: Unique identifier corresponding to one version of a model in ASDC
15548           required: true
15549           type: string
15550           example: __MODEL-VERSION-ID__
15551         - name: model-element-uuid
15552           in: path
15553           required: true
15554           type: string
15555           example: __MODEL-ELEMENT-UUID__
15556         - name: model-constraint-uuid
15557           in: path
15558           required: true
15559           type: string
15560           example: __MODEL-CONSTRAINT-UUID__
15561         - name: constrained-element-set-uuid
15562           in: path
15563           required: true
15564           type: string
15565           example: __CONSTRAINED-ELEMENT-SET-UUID__
15566   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
15567     get:
15568       tags:
15569         - ServiceDesignAndCreation
15570       summary: returns constrained-element-set
15571       description: returns constrained-element-set
15572       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15573       produces:
15574         - application/json
15575         - application/xml
15576       responses:
15577         "200":
15578           description: successful operation
15579           schema:
15580               $ref: "#/getDefinitions/constrained-element-set"
15581         "default":
15582           description: Response codes found in [response codes](https://wiki.onap.org/).
15583       parameters:
15584         - name: model-invariant-id
15585           in: path
15586           description: Unique identifier corresponding to the main definition of a model in ASDC
15587           required: true
15588           type: string
15589           example: __MODEL-INVARIANT-ID__
15590         - name: model-version-id
15591           in: path
15592           description: Unique identifier corresponding to one version of a model in ASDC
15593           required: true
15594           type: string
15595           example: __MODEL-VERSION-ID__
15596         - name: model-element-uuid
15597           in: path
15598           required: true
15599           type: string
15600           example: __MODEL-ELEMENT-UUID__
15601         - name: model-constraint-uuid
15602           in: path
15603           required: true
15604           type: string
15605           example: __MODEL-CONSTRAINT-UUID__
15606         - name: constrained-element-set-uuid
15607           in: path
15608           required: true
15609           type: string
15610           example: __CONSTRAINED-ELEMENT-SET-UUID__
15611     put:
15612       tags:
15613         - ServiceDesignAndCreation
15614       summary: create or update an existing constrained-element-set
15615       description: |
15616         Create or update an existing constrained-element-set.
15617         #
15618         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15619       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15620       consumes:
15621         - application/json
15622         - application/xml
15623       produces:
15624         - application/json
15625         - application/xml
15626       responses:
15627         "default":
15628           description: Response codes found in [response codes](https://wiki.onap.org/).
15629       parameters:
15630         - name: model-invariant-id
15631           in: path
15632           description: Unique identifier corresponding to the main definition of a model in ASDC
15633           required: true
15634           type: string
15635           example: __MODEL-INVARIANT-ID__
15636         - name: model-version-id
15637           in: path
15638           description: Unique identifier corresponding to one version of a model in ASDC
15639           required: true
15640           type: string
15641           example: __MODEL-VERSION-ID__
15642         - name: model-element-uuid
15643           in: path
15644           required: true
15645           type: string
15646           example: __MODEL-ELEMENT-UUID__
15647         - name: model-constraint-uuid
15648           in: path
15649           required: true
15650           type: string
15651           example: __MODEL-CONSTRAINT-UUID__
15652         - name: constrained-element-set-uuid
15653           in: path
15654           required: true
15655           type: string
15656           example: __CONSTRAINED-ELEMENT-SET-UUID__
15657         - name: body
15658           in: body
15659           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15660           required: true
15661           schema:
15662             $ref: "#/definitions/constrained-element-set"
15663     patch:
15664       tags:
15665         - ServiceDesignAndCreation
15666       summary: update an existing constrained-element-set
15667       description: |
15668         Update an existing constrained-element-set
15669         #
15670         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15671         The PUT operation will entirely replace an existing object.
15672         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15673         #
15674         Other differences between PUT and PATCH are:
15675         #
15676         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15677         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15678         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15679       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15680       consumes:
15681         - application/json
15682         - application/xml
15683       produces:
15684         - application/json
15685         - application/xml
15686       responses:
15687         "default":
15688           description: Response codes found in [response codes](https://wiki.onap.org/).
15689       parameters:
15690         - name: model-invariant-id
15691           in: path
15692           description: Unique identifier corresponding to the main definition of a model in ASDC
15693           required: true
15694           type: string
15695           example: __MODEL-INVARIANT-ID__
15696         - name: model-version-id
15697           in: path
15698           description: Unique identifier corresponding to one version of a model in ASDC
15699           required: true
15700           type: string
15701           example: __MODEL-VERSION-ID__
15702         - name: model-element-uuid
15703           in: path
15704           required: true
15705           type: string
15706           example: __MODEL-ELEMENT-UUID__
15707         - name: model-constraint-uuid
15708           in: path
15709           required: true
15710           type: string
15711           example: __MODEL-CONSTRAINT-UUID__
15712         - name: constrained-element-set-uuid
15713           in: path
15714           required: true
15715           type: string
15716           example: __CONSTRAINED-ELEMENT-SET-UUID__
15717         - name: body
15718           in: body
15719           description: constrained-element-set object that needs to be updated.
15720           required: true
15721           schema:
15722             $ref: "#/patchDefinitions/constrained-element-set"
15723     delete:
15724       tags:
15725         - ServiceDesignAndCreation
15726       summary: delete an existing constrained-element-set
15727       description: delete an existing constrained-element-set
15728       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15729       consumes:
15730         - application/json
15731         - application/xml
15732       produces:
15733         - application/json
15734         - application/xml
15735       responses:
15736         "default":
15737           description: Response codes found in [response codes](https://wiki.onap.org/).
15738       parameters:
15739         - name: model-invariant-id
15740           in: path
15741           description: Unique identifier corresponding to the main definition of a model in ASDC
15742           required: true
15743           type: string
15744           example: __MODEL-INVARIANT-ID__
15745         - name: model-version-id
15746           in: path
15747           description: Unique identifier corresponding to one version of a model in ASDC
15748           required: true
15749           type: string
15750           example: __MODEL-VERSION-ID__
15751         - name: model-element-uuid
15752           in: path
15753           required: true
15754           type: string
15755           example: __MODEL-ELEMENT-UUID__
15756         - name: model-constraint-uuid
15757           in: path
15758           required: true
15759           type: string
15760           example: __MODEL-CONSTRAINT-UUID__
15761         - name: constrained-element-set-uuid
15762           in: path
15763           required: true
15764           type: string
15765           example: __CONSTRAINED-ELEMENT-SET-UUID__
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/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
15772     get:
15773       tags:
15774         - ServiceDesignAndCreation
15775       summary: returns constrained-element-sets
15776       description: returns constrained-element-sets
15777       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
15778       produces:
15779         - application/json
15780         - application/xml
15781       responses:
15782         "200":
15783           description: successful operation
15784           schema:
15785               $ref: "#/getDefinitions/constrained-element-sets"
15786         "default":
15787           description: Response codes found in [response codes](https://wiki.onap.org/).
15788       parameters:
15789         - name: model-invariant-id
15790           in: path
15791           description: Unique identifier corresponding to the main definition of a model in ASDC
15792           required: true
15793           type: string
15794           example: __MODEL-INVARIANT-ID__
15795         - name: model-version-id
15796           in: path
15797           description: Unique identifier corresponding to one version of a model in ASDC
15798           required: true
15799           type: string
15800           example: __MODEL-VERSION-ID__
15801         - name: model-element-uuid
15802           in: path
15803           required: true
15804           type: string
15805           example: __MODEL-ELEMENT-UUID__
15806         - name: model-constraint-uuid
15807           in: path
15808           required: true
15809           type: string
15810           example: __MODEL-CONSTRAINT-UUID__
15811         - name: constrained-element-set-uuid
15812           in: query
15813           description:
15814           required: false
15815           type: string
15816   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
15817     get:
15818       tags:
15819         - ServiceDesignAndCreation
15820       summary: returns model-constraint
15821       description: returns model-constraint
15822       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15823       produces:
15824         - application/json
15825         - application/xml
15826       responses:
15827         "200":
15828           description: successful operation
15829           schema:
15830               $ref: "#/getDefinitions/model-constraint"
15831         "default":
15832           description: Response codes found in [response codes](https://wiki.onap.org/).
15833       parameters:
15834         - name: model-invariant-id
15835           in: path
15836           description: Unique identifier corresponding to the main definition of a model in ASDC
15837           required: true
15838           type: string
15839           example: __MODEL-INVARIANT-ID__
15840         - name: model-version-id
15841           in: path
15842           description: Unique identifier corresponding to one version of a model in ASDC
15843           required: true
15844           type: string
15845           example: __MODEL-VERSION-ID__
15846         - name: model-element-uuid
15847           in: path
15848           required: true
15849           type: string
15850           example: __MODEL-ELEMENT-UUID__
15851         - name: model-constraint-uuid
15852           in: path
15853           required: true
15854           type: string
15855           example: __MODEL-CONSTRAINT-UUID__
15856     put:
15857       tags:
15858         - ServiceDesignAndCreation
15859       summary: create or update an existing model-constraint
15860       description: |
15861         Create or update an existing model-constraint.
15862         #
15863         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15864       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15865       consumes:
15866         - application/json
15867         - application/xml
15868       produces:
15869         - application/json
15870         - application/xml
15871       responses:
15872         "default":
15873           description: Response codes found in [response codes](https://wiki.onap.org/).
15874       parameters:
15875         - name: model-invariant-id
15876           in: path
15877           description: Unique identifier corresponding to the main definition of a model in ASDC
15878           required: true
15879           type: string
15880           example: __MODEL-INVARIANT-ID__
15881         - name: model-version-id
15882           in: path
15883           description: Unique identifier corresponding to one version of a model in ASDC
15884           required: true
15885           type: string
15886           example: __MODEL-VERSION-ID__
15887         - name: model-element-uuid
15888           in: path
15889           required: true
15890           type: string
15891           example: __MODEL-ELEMENT-UUID__
15892         - name: model-constraint-uuid
15893           in: path
15894           required: true
15895           type: string
15896           example: __MODEL-CONSTRAINT-UUID__
15897         - name: body
15898           in: body
15899           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
15900           required: true
15901           schema:
15902             $ref: "#/definitions/model-constraint"
15903     patch:
15904       tags:
15905         - ServiceDesignAndCreation
15906       summary: update an existing model-constraint
15907       description: |
15908         Update an existing model-constraint
15909         #
15910         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15911         The PUT operation will entirely replace an existing object.
15912         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15913         #
15914         Other differences between PUT and PATCH are:
15915         #
15916         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15917         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15918         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15919       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15920       consumes:
15921         - application/json
15922         - application/xml
15923       produces:
15924         - application/json
15925         - application/xml
15926       responses:
15927         "default":
15928           description: Response codes found in [response codes](https://wiki.onap.org/).
15929       parameters:
15930         - name: model-invariant-id
15931           in: path
15932           description: Unique identifier corresponding to the main definition of a model in ASDC
15933           required: true
15934           type: string
15935           example: __MODEL-INVARIANT-ID__
15936         - name: model-version-id
15937           in: path
15938           description: Unique identifier corresponding to one version of a model in ASDC
15939           required: true
15940           type: string
15941           example: __MODEL-VERSION-ID__
15942         - name: model-element-uuid
15943           in: path
15944           required: true
15945           type: string
15946           example: __MODEL-ELEMENT-UUID__
15947         - name: model-constraint-uuid
15948           in: path
15949           required: true
15950           type: string
15951           example: __MODEL-CONSTRAINT-UUID__
15952         - name: body
15953           in: body
15954           description: model-constraint object that needs to be updated.
15955           required: true
15956           schema:
15957             $ref: "#/patchDefinitions/model-constraint"
15958     delete:
15959       tags:
15960         - ServiceDesignAndCreation
15961       summary: delete an existing model-constraint
15962       description: delete an existing model-constraint
15963       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15964       consumes:
15965         - application/json
15966         - application/xml
15967       produces:
15968         - application/json
15969         - application/xml
15970       responses:
15971         "default":
15972           description: Response codes found in [response codes](https://wiki.onap.org/).
15973       parameters:
15974         - name: model-invariant-id
15975           in: path
15976           description: Unique identifier corresponding to the main definition of a model in ASDC
15977           required: true
15978           type: string
15979           example: __MODEL-INVARIANT-ID__
15980         - name: model-version-id
15981           in: path
15982           description: Unique identifier corresponding to one version of a model in ASDC
15983           required: true
15984           type: string
15985           example: __MODEL-VERSION-ID__
15986         - name: model-element-uuid
15987           in: path
15988           required: true
15989           type: string
15990           example: __MODEL-ELEMENT-UUID__
15991         - name: model-constraint-uuid
15992           in: path
15993           required: true
15994           type: string
15995           example: __MODEL-CONSTRAINT-UUID__
15996         - name: resource-version
15997           in: query
15998           description: resource-version for concurrency
15999           required: true
16000           type: string
16001   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
16002     get:
16003       tags:
16004         - ServiceDesignAndCreation
16005       summary: returns model-constraints
16006       description: returns model-constraints
16007       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
16008       produces:
16009         - application/json
16010         - application/xml
16011       responses:
16012         "200":
16013           description: successful operation
16014           schema:
16015               $ref: "#/getDefinitions/model-constraints"
16016         "default":
16017           description: Response codes found in [response codes](https://wiki.onap.org/).
16018       parameters:
16019         - name: model-invariant-id
16020           in: path
16021           description: Unique identifier corresponding to the main definition of a model in ASDC
16022           required: true
16023           type: string
16024           example: __MODEL-INVARIANT-ID__
16025         - name: model-version-id
16026           in: path
16027           description: Unique identifier corresponding to one version of a model in ASDC
16028           required: true
16029           type: string
16030           example: __MODEL-VERSION-ID__
16031         - name: model-element-uuid
16032           in: path
16033           required: true
16034           type: string
16035           example: __MODEL-ELEMENT-UUID__
16036         - name: model-constraint-uuid
16037           in: query
16038           description:
16039           required: false
16040           type: string
16041   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
16042     put:
16043       tags:
16044         - ServiceDesignAndCreation
16045       summary: see node definition for valid relationships
16046       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16047       consumes:
16048         - application/json
16049         - application/xml
16050       produces:
16051         - application/json
16052         - application/xml
16053       responses:
16054         "default":
16055           description: Response codes found in [response codes](https://wiki.onap.org/).
16056       parameters:
16057         - name: model-invariant-id
16058           in: path
16059           description: Unique identifier corresponding to the main definition of a model in ASDC
16060           required: true
16061           type: string
16062           example: __MODEL-INVARIANT-ID__
16063         - name: model-version-id
16064           in: path
16065           description: Unique identifier corresponding to one version of a model in ASDC
16066           required: true
16067           type: string
16068           example: __MODEL-VERSION-ID__
16069         - name: model-element-uuid
16070           in: path
16071           required: true
16072           type: string
16073           example: __MODEL-ELEMENT-UUID__
16074         - name: body
16075           in: body
16076           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16077           required: true
16078           schema:
16079             $ref: "#/definitions/relationship"
16080     delete:
16081       tags:
16082         - ServiceDesignAndCreation
16083       summary: delete an existing relationship
16084       description: delete an existing relationship
16085       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16086       consumes:
16087         - application/json
16088         - application/xml
16089       produces:
16090         - application/json
16091         - application/xml
16092       responses:
16093         "default":
16094           description: Response codes found in [response codes](https://wiki.onap.org/).
16095       parameters:
16096         - name: model-invariant-id
16097           in: path
16098           description: Unique identifier corresponding to the main definition of a model in ASDC
16099           required: true
16100           type: string
16101           example: __MODEL-INVARIANT-ID__
16102         - name: model-version-id
16103           in: path
16104           description: Unique identifier corresponding to one version of a model in ASDC
16105           required: true
16106           type: string
16107           example: __MODEL-VERSION-ID__
16108         - name: model-element-uuid
16109           in: path
16110           required: true
16111           type: string
16112           example: __MODEL-ELEMENT-UUID__
16113   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
16114     get:
16115       tags:
16116         - ServiceDesignAndCreation
16117       summary: returns model-element
16118       description: returns model-element
16119       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16120       produces:
16121         - application/json
16122         - application/xml
16123       responses:
16124         "200":
16125           description: successful operation
16126           schema:
16127               $ref: "#/getDefinitions/model-element"
16128         "default":
16129           description: Response codes found in [response codes](https://wiki.onap.org/).
16130       parameters:
16131         - name: model-invariant-id
16132           in: path
16133           description: Unique identifier corresponding to the main definition of a model in ASDC
16134           required: true
16135           type: string
16136           example: __MODEL-INVARIANT-ID__
16137         - name: model-version-id
16138           in: path
16139           description: Unique identifier corresponding to one version of a model in ASDC
16140           required: true
16141           type: string
16142           example: __MODEL-VERSION-ID__
16143         - name: model-element-uuid
16144           in: path
16145           required: true
16146           type: string
16147           example: __MODEL-ELEMENT-UUID__
16148     put:
16149       tags:
16150         - ServiceDesignAndCreation
16151       summary: create or update an existing model-element
16152       description: |
16153         Create or update an existing model-element.
16154         #
16155         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16156       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16157       consumes:
16158         - application/json
16159         - application/xml
16160       produces:
16161         - application/json
16162         - application/xml
16163       responses:
16164         "default":
16165           description: Response codes found in [response codes](https://wiki.onap.org/).
16166       parameters:
16167         - name: model-invariant-id
16168           in: path
16169           description: Unique identifier corresponding to the main definition of a model in ASDC
16170           required: true
16171           type: string
16172           example: __MODEL-INVARIANT-ID__
16173         - name: model-version-id
16174           in: path
16175           description: Unique identifier corresponding to one version of a model in ASDC
16176           required: true
16177           type: string
16178           example: __MODEL-VERSION-ID__
16179         - name: model-element-uuid
16180           in: path
16181           required: true
16182           type: string
16183           example: __MODEL-ELEMENT-UUID__
16184         - name: body
16185           in: body
16186           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16187           required: true
16188           schema:
16189             $ref: "#/definitions/model-element"
16190     patch:
16191       tags:
16192         - ServiceDesignAndCreation
16193       summary: update an existing model-element
16194       description: |
16195         Update an existing model-element
16196         #
16197         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16198         The PUT operation will entirely replace an existing object.
16199         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16200         #
16201         Other differences between PUT and PATCH are:
16202         #
16203         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16204         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16205         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16206       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16207       consumes:
16208         - application/json
16209         - application/xml
16210       produces:
16211         - application/json
16212         - application/xml
16213       responses:
16214         "default":
16215           description: Response codes found in [response codes](https://wiki.onap.org/).
16216       parameters:
16217         - name: model-invariant-id
16218           in: path
16219           description: Unique identifier corresponding to the main definition of a model in ASDC
16220           required: true
16221           type: string
16222           example: __MODEL-INVARIANT-ID__
16223         - name: model-version-id
16224           in: path
16225           description: Unique identifier corresponding to one version of a model in ASDC
16226           required: true
16227           type: string
16228           example: __MODEL-VERSION-ID__
16229         - name: model-element-uuid
16230           in: path
16231           required: true
16232           type: string
16233           example: __MODEL-ELEMENT-UUID__
16234         - name: body
16235           in: body
16236           description: model-element object that needs to be updated.
16237           required: true
16238           schema:
16239             $ref: "#/patchDefinitions/model-element"
16240     delete:
16241       tags:
16242         - ServiceDesignAndCreation
16243       summary: delete an existing model-element
16244       description: delete an existing model-element
16245       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16246       consumes:
16247         - application/json
16248         - application/xml
16249       produces:
16250         - application/json
16251         - application/xml
16252       responses:
16253         "default":
16254           description: Response codes found in [response codes](https://wiki.onap.org/).
16255       parameters:
16256         - name: model-invariant-id
16257           in: path
16258           description: Unique identifier corresponding to the main definition of a model in ASDC
16259           required: true
16260           type: string
16261           example: __MODEL-INVARIANT-ID__
16262         - name: model-version-id
16263           in: path
16264           description: Unique identifier corresponding to one version of a model in ASDC
16265           required: true
16266           type: string
16267           example: __MODEL-VERSION-ID__
16268         - name: model-element-uuid
16269           in: path
16270           required: true
16271           type: string
16272           example: __MODEL-ELEMENT-UUID__
16273         - name: resource-version
16274           in: query
16275           description: resource-version for concurrency
16276           required: true
16277           type: string
16278   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
16279     get:
16280       tags:
16281         - ServiceDesignAndCreation
16282       summary: returns model-elements
16283       description: returns model-elements
16284       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
16285       produces:
16286         - application/json
16287         - application/xml
16288       responses:
16289         "200":
16290           description: successful operation
16291           schema:
16292               $ref: "#/getDefinitions/model-elements"
16293         "default":
16294           description: Response codes found in [response codes](https://wiki.onap.org/).
16295       parameters:
16296         - name: model-invariant-id
16297           in: path
16298           description: Unique identifier corresponding to the main definition of a model in ASDC
16299           required: true
16300           type: string
16301           example: __MODEL-INVARIANT-ID__
16302         - name: model-version-id
16303           in: path
16304           description: Unique identifier corresponding to one version of a model in ASDC
16305           required: true
16306           type: string
16307           example: __MODEL-VERSION-ID__
16308         - name: model-element-uuid
16309           in: query
16310           description:
16311           required: false
16312           type: string
16313   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
16314     get:
16315       tags:
16316         - ServiceDesignAndCreation
16317       summary: returns metadatum
16318       description: returns metadatum
16319       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16320       produces:
16321         - application/json
16322         - application/xml
16323       responses:
16324         "200":
16325           description: successful operation
16326           schema:
16327               $ref: "#/getDefinitions/metadatum"
16328         "default":
16329           description: Response codes found in [response codes](https://wiki.onap.org/).
16330       parameters:
16331         - name: model-invariant-id
16332           in: path
16333           description: Unique identifier corresponding to the main definition of a model in ASDC
16334           required: true
16335           type: string
16336           example: __MODEL-INVARIANT-ID__
16337         - name: model-version-id
16338           in: path
16339           description: Unique identifier corresponding to one version of a model in ASDC
16340           required: true
16341           type: string
16342           example: __MODEL-VERSION-ID__
16343         - name: metaname
16344           in: path
16345           required: true
16346           type: string
16347           example: __METANAME__
16348     put:
16349       tags:
16350         - ServiceDesignAndCreation
16351       summary: create or update an existing metadatum
16352       description: |
16353         Create or update an existing metadatum.
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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
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: model-invariant-id
16368           in: path
16369           description: Unique identifier corresponding to the main definition of a model in ASDC
16370           required: true
16371           type: string
16372           example: __MODEL-INVARIANT-ID__
16373         - name: model-version-id
16374           in: path
16375           description: Unique identifier corresponding to one version of a model in ASDC
16376           required: true
16377           type: string
16378           example: __MODEL-VERSION-ID__
16379         - name: metaname
16380           in: path
16381           required: true
16382           type: string
16383           example: __METANAME__
16384         - name: body
16385           in: body
16386           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
16387           required: true
16388           schema:
16389             $ref: "#/definitions/metadatum"
16390     patch:
16391       tags:
16392         - ServiceDesignAndCreation
16393       summary: update an existing metadatum
16394       description: |
16395         Update an existing metadatum
16396         #
16397         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16398         The PUT operation will entirely replace an existing object.
16399         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16400         #
16401         Other differences between PUT and PATCH are:
16402         #
16403         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16404         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16405         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16406       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16407       consumes:
16408         - application/json
16409         - application/xml
16410       produces:
16411         - application/json
16412         - application/xml
16413       responses:
16414         "default":
16415           description: Response codes found in [response codes](https://wiki.onap.org/).
16416       parameters:
16417         - name: model-invariant-id
16418           in: path
16419           description: Unique identifier corresponding to the main definition of a model in ASDC
16420           required: true
16421           type: string
16422           example: __MODEL-INVARIANT-ID__
16423         - name: model-version-id
16424           in: path
16425           description: Unique identifier corresponding to one version of a model in ASDC
16426           required: true
16427           type: string
16428           example: __MODEL-VERSION-ID__
16429         - name: metaname
16430           in: path
16431           required: true
16432           type: string
16433           example: __METANAME__
16434         - name: body
16435           in: body
16436           description: metadatum object that needs to be updated.
16437           required: true
16438           schema:
16439             $ref: "#/patchDefinitions/metadatum"
16440     delete:
16441       tags:
16442         - ServiceDesignAndCreation
16443       summary: delete an existing metadatum
16444       description: delete an existing metadatum
16445       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16446       consumes:
16447         - application/json
16448         - application/xml
16449       produces:
16450         - application/json
16451         - application/xml
16452       responses:
16453         "default":
16454           description: Response codes found in [response codes](https://wiki.onap.org/).
16455       parameters:
16456         - name: model-invariant-id
16457           in: path
16458           description: Unique identifier corresponding to the main definition of a model in ASDC
16459           required: true
16460           type: string
16461           example: __MODEL-INVARIANT-ID__
16462         - name: model-version-id
16463           in: path
16464           description: Unique identifier corresponding to one version of a model in ASDC
16465           required: true
16466           type: string
16467           example: __MODEL-VERSION-ID__
16468         - name: metaname
16469           in: path
16470           required: true
16471           type: string
16472           example: __METANAME__
16473         - name: resource-version
16474           in: query
16475           description: resource-version for concurrency
16476           required: true
16477           type: string
16478   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
16479     get:
16480       tags:
16481         - ServiceDesignAndCreation
16482       summary: returns metadata
16483       description: returns metadata
16484       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
16485       produces:
16486         - application/json
16487         - application/xml
16488       responses:
16489         "200":
16490           description: successful operation
16491           schema:
16492               $ref: "#/getDefinitions/metadata"
16493         "default":
16494           description: Response codes found in [response codes](https://wiki.onap.org/).
16495       parameters:
16496         - name: model-invariant-id
16497           in: path
16498           description: Unique identifier corresponding to the main definition of a model in ASDC
16499           required: true
16500           type: string
16501           example: __MODEL-INVARIANT-ID__
16502         - name: model-version-id
16503           in: path
16504           description: Unique identifier corresponding to one version of a model in ASDC
16505           required: true
16506           type: string
16507           example: __MODEL-VERSION-ID__
16508         - name: metaname
16509           in: query
16510           description:
16511           required: false
16512           type: string
16513   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
16514     put:
16515       tags:
16516         - ServiceDesignAndCreation
16517       summary: see node definition for valid relationships
16518       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16519       consumes:
16520         - application/json
16521         - application/xml
16522       produces:
16523         - application/json
16524         - application/xml
16525       responses:
16526         "default":
16527           description: Response codes found in [response codes](https://wiki.onap.org/).
16528       parameters:
16529         - name: model-invariant-id
16530           in: path
16531           description: Unique identifier corresponding to the main definition of a model in ASDC
16532           required: true
16533           type: string
16534           example: __MODEL-INVARIANT-ID__
16535         - name: model-version-id
16536           in: path
16537           description: Unique identifier corresponding to one version of a model in ASDC
16538           required: true
16539           type: string
16540           example: __MODEL-VERSION-ID__
16541         - name: body
16542           in: body
16543           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16544           required: true
16545           schema:
16546             $ref: "#/definitions/relationship"
16547     delete:
16548       tags:
16549         - ServiceDesignAndCreation
16550       summary: delete an existing relationship
16551       description: delete an existing relationship
16552       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16553       consumes:
16554         - application/json
16555         - application/xml
16556       produces:
16557         - application/json
16558         - application/xml
16559       responses:
16560         "default":
16561           description: Response codes found in [response codes](https://wiki.onap.org/).
16562       parameters:
16563         - name: model-invariant-id
16564           in: path
16565           description: Unique identifier corresponding to the main definition of a model in ASDC
16566           required: true
16567           type: string
16568           example: __MODEL-INVARIANT-ID__
16569         - name: model-version-id
16570           in: path
16571           description: Unique identifier corresponding to one version of a model in ASDC
16572           required: true
16573           type: string
16574           example: __MODEL-VERSION-ID__
16575   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
16576     get:
16577       tags:
16578         - ServiceDesignAndCreation
16579       summary: returns model-ver
16580       description: returns model-ver
16581       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
16582       produces:
16583         - application/json
16584         - application/xml
16585       responses:
16586         "200":
16587           description: successful operation
16588           schema:
16589               $ref: "#/getDefinitions/model-ver"
16590         "default":
16591           description: Response codes found in [response codes](https://wiki.onap.org/).
16592       parameters:
16593         - name: model-invariant-id
16594           in: path
16595           description: Unique identifier corresponding to the main definition of a model in ASDC
16596           required: true
16597           type: string
16598           example: __MODEL-INVARIANT-ID__
16599         - name: model-version-id
16600           in: path
16601           description: Unique identifier corresponding to one version of a model in ASDC
16602           required: true
16603           type: string
16604           example: __MODEL-VERSION-ID__
16605     put:
16606       tags:
16607         - ServiceDesignAndCreation
16608       summary: create or update an existing model-ver
16609       description: |
16610         Create or update an existing model-ver.
16611         #
16612         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16613       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
16614       consumes:
16615         - application/json
16616         - application/xml
16617       produces:
16618         - application/json
16619         - application/xml
16620       responses:
16621         "default":
16622           description: Response codes found in [response codes](https://wiki.onap.org/).
16623       parameters:
16624         - name: model-invariant-id
16625           in: path
16626           description: Unique identifier corresponding to the main definition of a model in ASDC
16627           required: true
16628           type: string
16629           example: __MODEL-INVARIANT-ID__
16630         - name: model-version-id
16631           in: path
16632           description: Unique identifier corresponding to one version of a model in ASDC
16633           required: true
16634           type: string
16635           example: __MODEL-VERSION-ID__
16636         - name: body
16637           in: body
16638           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16639           required: true
16640           schema:
16641             $ref: "#/definitions/model-ver"
16642     patch:
16643       tags:
16644         - ServiceDesignAndCreation
16645       summary: update an existing model-ver
16646       description: |
16647         Update an existing model-ver
16648         #
16649         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16650         The PUT operation will entirely replace an existing object.
16651         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16652         #
16653         Other differences between PUT and PATCH are:
16654         #
16655         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16656         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16657         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16658       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
16659       consumes:
16660         - application/json
16661         - application/xml
16662       produces:
16663         - application/json
16664         - application/xml
16665       responses:
16666         "default":
16667           description: Response codes found in [response codes](https://wiki.onap.org/).
16668       parameters:
16669         - name: model-invariant-id
16670           in: path
16671           description: Unique identifier corresponding to the main definition of a model in ASDC
16672           required: true
16673           type: string
16674           example: __MODEL-INVARIANT-ID__
16675         - name: model-version-id
16676           in: path
16677           description: Unique identifier corresponding to one version of a model in ASDC
16678           required: true
16679           type: string
16680           example: __MODEL-VERSION-ID__
16681         - name: body
16682           in: body
16683           description: model-ver object that needs to be updated.
16684           required: true
16685           schema:
16686             $ref: "#/patchDefinitions/model-ver"
16687     delete:
16688       tags:
16689         - ServiceDesignAndCreation
16690       summary: delete an existing model-ver
16691       description: delete an existing model-ver
16692       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
16693       consumes:
16694         - application/json
16695         - application/xml
16696       produces:
16697         - application/json
16698         - application/xml
16699       responses:
16700         "default":
16701           description: Response codes found in [response codes](https://wiki.onap.org/).
16702       parameters:
16703         - name: model-invariant-id
16704           in: path
16705           description: Unique identifier corresponding to the main definition of a model in ASDC
16706           required: true
16707           type: string
16708           example: __MODEL-INVARIANT-ID__
16709         - name: model-version-id
16710           in: path
16711           description: Unique identifier corresponding to one version of a model in ASDC
16712           required: true
16713           type: string
16714           example: __MODEL-VERSION-ID__
16715         - name: resource-version
16716           in: query
16717           description: resource-version for concurrency
16718           required: true
16719           type: string
16720   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
16721     get:
16722       tags:
16723         - ServiceDesignAndCreation
16724       summary: returns model-vers
16725       description: returns model-vers
16726       operationId: getServiceDesignAndCreationModelsModelModelVers
16727       produces:
16728         - application/json
16729         - application/xml
16730       responses:
16731         "200":
16732           description: successful operation
16733           schema:
16734               $ref: "#/getDefinitions/model-vers"
16735         "default":
16736           description: Response codes found in [response codes](https://wiki.onap.org/).
16737       parameters:
16738         - name: model-invariant-id
16739           in: path
16740           description: Unique identifier corresponding to the main definition of a model in ASDC
16741           required: true
16742           type: string
16743           example: __MODEL-INVARIANT-ID__
16744         - name: model-version-id
16745           in: query
16746           description:
16747           required: false
16748           type: string
16749         - name: model-name
16750           in: query
16751           description:
16752           required: false
16753           type: string
16754         - name: model-version
16755           in: query
16756           description:
16757           required: false
16758           type: string
16759   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
16760     put:
16761       tags:
16762         - ServiceDesignAndCreation
16763       summary: see node definition for valid relationships
16764       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
16765       consumes:
16766         - application/json
16767         - application/xml
16768       produces:
16769         - application/json
16770         - application/xml
16771       responses:
16772         "default":
16773           description: Response codes found in [response codes](https://wiki.onap.org/).
16774       parameters:
16775         - name: model-invariant-id
16776           in: path
16777           description: Unique identifier corresponding to the main definition of a model in ASDC
16778           required: true
16779           type: string
16780           example: __MODEL-INVARIANT-ID__
16781         - name: body
16782           in: body
16783           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
16784           required: true
16785           schema:
16786             $ref: "#/definitions/relationship"
16787     delete:
16788       tags:
16789         - ServiceDesignAndCreation
16790       summary: delete an existing relationship
16791       description: delete an existing relationship
16792       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
16793       consumes:
16794         - application/json
16795         - application/xml
16796       produces:
16797         - application/json
16798         - application/xml
16799       responses:
16800         "default":
16801           description: Response codes found in [response codes](https://wiki.onap.org/).
16802       parameters:
16803         - name: model-invariant-id
16804           in: path
16805           description: Unique identifier corresponding to the main definition of a model in ASDC
16806           required: true
16807           type: string
16808           example: __MODEL-INVARIANT-ID__
16809   /service-design-and-creation/models/model/{model-invariant-id}:
16810     get:
16811       tags:
16812         - ServiceDesignAndCreation
16813       summary: returns model
16814       description: returns model
16815       operationId: getServiceDesignAndCreationModelsModel
16816       produces:
16817         - application/json
16818         - application/xml
16819       responses:
16820         "200":
16821           description: successful operation
16822           schema:
16823               $ref: "#/getDefinitions/model"
16824         "default":
16825           description: Response codes found in [response codes](https://wiki.onap.org/).
16826       parameters:
16827         - name: model-invariant-id
16828           in: path
16829           description: Unique identifier corresponding to the main definition of a model in ASDC
16830           required: true
16831           type: string
16832           example: __MODEL-INVARIANT-ID__
16833     put:
16834       tags:
16835         - ServiceDesignAndCreation
16836       summary: create or update an existing model
16837       description: |
16838         Create or update an existing model.
16839         #
16840         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16841       operationId: createOrUpdateServiceDesignAndCreationModelsModel
16842       consumes:
16843         - application/json
16844         - application/xml
16845       produces:
16846         - application/json
16847         - application/xml
16848       responses:
16849         "default":
16850           description: Response codes found in [response codes](https://wiki.onap.org/).
16851       parameters:
16852         - name: model-invariant-id
16853           in: path
16854           description: Unique identifier corresponding to the main definition of a model in ASDC
16855           required: true
16856           type: string
16857           example: __MODEL-INVARIANT-ID__
16858         - name: body
16859           in: body
16860           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
16861           required: true
16862           schema:
16863             $ref: "#/definitions/model"
16864     patch:
16865       tags:
16866         - ServiceDesignAndCreation
16867       summary: update an existing model
16868       description: |
16869         Update an existing model
16870         #
16871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16872         The PUT operation will entirely replace an existing object.
16873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16874         #
16875         Other differences between PUT and PATCH are:
16876         #
16877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16880       operationId: UpdateServiceDesignAndCreationModelsModel
16881       consumes:
16882         - application/json
16883         - application/xml
16884       produces:
16885         - application/json
16886         - application/xml
16887       responses:
16888         "default":
16889           description: Response codes found in [response codes](https://wiki.onap.org/).
16890       parameters:
16891         - name: model-invariant-id
16892           in: path
16893           description: Unique identifier corresponding to the main definition of a model in ASDC
16894           required: true
16895           type: string
16896           example: __MODEL-INVARIANT-ID__
16897         - name: body
16898           in: body
16899           description: model object that needs to be updated.
16900           required: true
16901           schema:
16902             $ref: "#/patchDefinitions/model"
16903     delete:
16904       tags:
16905         - ServiceDesignAndCreation
16906       summary: delete an existing model
16907       description: delete an existing model
16908       operationId: deleteServiceDesignAndCreationModelsModel
16909       consumes:
16910         - application/json
16911         - application/xml
16912       produces:
16913         - application/json
16914         - application/xml
16915       responses:
16916         "default":
16917           description: Response codes found in [response codes](https://wiki.onap.org/).
16918       parameters:
16919         - name: model-invariant-id
16920           in: path
16921           description: Unique identifier corresponding to the main definition of a model in ASDC
16922           required: true
16923           type: string
16924           example: __MODEL-INVARIANT-ID__
16925         - name: resource-version
16926           in: query
16927           description: resource-version for concurrency
16928           required: true
16929           type: string
16930   /service-design-and-creation/models:
16931     get:
16932       tags:
16933         - ServiceDesignAndCreation
16934       summary: returns models
16935       description: returns models
16936       operationId: getServiceDesignAndCreationModels
16937       produces:
16938         - application/json
16939         - application/xml
16940       responses:
16941         "200":
16942           description: successful operation
16943           schema:
16944               $ref: "#/getDefinitions/models"
16945         "default":
16946           description: Response codes found in [response codes](https://wiki.onap.org/).
16947       parameters:
16948         - name: model-invariant-id
16949           in: query
16950           description:
16951           required: false
16952           type: string
16953         - name: model-type
16954           in: query
16955           description:
16956           required: false
16957           type: string
16958   /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:
16959     put:
16960       tags:
16961         - ServiceDesignAndCreation
16962       summary: see node definition for valid relationships
16963       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16964       consumes:
16965         - application/json
16966         - application/xml
16967       produces:
16968         - application/json
16969         - application/xml
16970       responses:
16971         "default":
16972           description: Response codes found in [response codes](https://wiki.onap.org/).
16973       parameters:
16974         - name: named-query-uuid
16975           in: path
16976           required: true
16977           type: string
16978           example: __NAMED-QUERY-UUID__
16979         - name: named-query-element-uuid
16980           in: path
16981           required: true
16982           type: string
16983           example: __NAMED-QUERY-ELEMENT-UUID__
16984         - name: related-lookup-uuid
16985           in: path
16986           required: true
16987           type: string
16988           example: __RELATED-LOOKUP-UUID__
16989         - name: body
16990           in: body
16991           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
16992           required: true
16993           schema:
16994             $ref: "#/definitions/relationship"
16995     delete:
16996       tags:
16997         - ServiceDesignAndCreation
16998       summary: delete an existing relationship
16999       description: delete an existing relationship
17000       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17001       consumes:
17002         - application/json
17003         - application/xml
17004       produces:
17005         - application/json
17006         - application/xml
17007       responses:
17008         "default":
17009           description: Response codes found in [response codes](https://wiki.onap.org/).
17010       parameters:
17011         - name: named-query-uuid
17012           in: path
17013           required: true
17014           type: string
17015           example: __NAMED-QUERY-UUID__
17016         - name: named-query-element-uuid
17017           in: path
17018           required: true
17019           type: string
17020           example: __NAMED-QUERY-ELEMENT-UUID__
17021         - name: related-lookup-uuid
17022           in: path
17023           required: true
17024           type: string
17025           example: __RELATED-LOOKUP-UUID__
17026   /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}:
17027     get:
17028       tags:
17029         - ServiceDesignAndCreation
17030       summary: returns related-lookup
17031       description: returns related-lookup
17032       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17033       produces:
17034         - application/json
17035         - application/xml
17036       responses:
17037         "200":
17038           description: successful operation
17039           schema:
17040               $ref: "#/getDefinitions/related-lookup"
17041         "default":
17042           description: Response codes found in [response codes](https://wiki.onap.org/).
17043       parameters:
17044         - name: named-query-uuid
17045           in: path
17046           required: true
17047           type: string
17048           example: __NAMED-QUERY-UUID__
17049         - name: named-query-element-uuid
17050           in: path
17051           required: true
17052           type: string
17053           example: __NAMED-QUERY-ELEMENT-UUID__
17054         - name: related-lookup-uuid
17055           in: path
17056           required: true
17057           type: string
17058           example: __RELATED-LOOKUP-UUID__
17059     put:
17060       tags:
17061         - ServiceDesignAndCreation
17062       summary: create or update an existing related-lookup
17063       description: |
17064         Create or update an existing related-lookup.
17065         #
17066         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17067       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17068       consumes:
17069         - application/json
17070         - application/xml
17071       produces:
17072         - application/json
17073         - application/xml
17074       responses:
17075         "default":
17076           description: Response codes found in [response codes](https://wiki.onap.org/).
17077       parameters:
17078         - name: named-query-uuid
17079           in: path
17080           required: true
17081           type: string
17082           example: __NAMED-QUERY-UUID__
17083         - name: named-query-element-uuid
17084           in: path
17085           required: true
17086           type: string
17087           example: __NAMED-QUERY-ELEMENT-UUID__
17088         - name: related-lookup-uuid
17089           in: path
17090           required: true
17091           type: string
17092           example: __RELATED-LOOKUP-UUID__
17093         - name: body
17094           in: body
17095           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17096           required: true
17097           schema:
17098             $ref: "#/definitions/related-lookup"
17099     patch:
17100       tags:
17101         - ServiceDesignAndCreation
17102       summary: update an existing related-lookup
17103       description: |
17104         Update an existing related-lookup
17105         #
17106         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17107         The PUT operation will entirely replace an existing object.
17108         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17109         #
17110         Other differences between PUT and PATCH are:
17111         #
17112         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17113         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17114         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17115       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17116       consumes:
17117         - application/json
17118         - application/xml
17119       produces:
17120         - application/json
17121         - application/xml
17122       responses:
17123         "default":
17124           description: Response codes found in [response codes](https://wiki.onap.org/).
17125       parameters:
17126         - name: named-query-uuid
17127           in: path
17128           required: true
17129           type: string
17130           example: __NAMED-QUERY-UUID__
17131         - name: named-query-element-uuid
17132           in: path
17133           required: true
17134           type: string
17135           example: __NAMED-QUERY-ELEMENT-UUID__
17136         - name: related-lookup-uuid
17137           in: path
17138           required: true
17139           type: string
17140           example: __RELATED-LOOKUP-UUID__
17141         - name: body
17142           in: body
17143           description: related-lookup object that needs to be updated.
17144           required: true
17145           schema:
17146             $ref: "#/patchDefinitions/related-lookup"
17147     delete:
17148       tags:
17149         - ServiceDesignAndCreation
17150       summary: delete an existing related-lookup
17151       description: delete an existing related-lookup
17152       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17153       consumes:
17154         - application/json
17155         - application/xml
17156       produces:
17157         - application/json
17158         - application/xml
17159       responses:
17160         "default":
17161           description: Response codes found in [response codes](https://wiki.onap.org/).
17162       parameters:
17163         - name: named-query-uuid
17164           in: path
17165           required: true
17166           type: string
17167           example: __NAMED-QUERY-UUID__
17168         - name: named-query-element-uuid
17169           in: path
17170           required: true
17171           type: string
17172           example: __NAMED-QUERY-ELEMENT-UUID__
17173         - name: related-lookup-uuid
17174           in: path
17175           required: true
17176           type: string
17177           example: __RELATED-LOOKUP-UUID__
17178         - name: resource-version
17179           in: query
17180           description: resource-version for concurrency
17181           required: true
17182           type: string
17183   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17184     get:
17185       tags:
17186         - ServiceDesignAndCreation
17187       summary: returns related-lookups
17188       description: returns related-lookups
17189       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17190       produces:
17191         - application/json
17192         - application/xml
17193       responses:
17194         "200":
17195           description: successful operation
17196           schema:
17197               $ref: "#/getDefinitions/related-lookups"
17198         "default":
17199           description: Response codes found in [response codes](https://wiki.onap.org/).
17200       parameters:
17201         - name: named-query-uuid
17202           in: path
17203           required: true
17204           type: string
17205           example: __NAMED-QUERY-UUID__
17206         - name: named-query-element-uuid
17207           in: path
17208           required: true
17209           type: string
17210           example: __NAMED-QUERY-ELEMENT-UUID__
17211         - name: related-lookup-uuid
17212           in: query
17213           description:
17214           required: false
17215           type: string
17216   /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}:
17217     get:
17218       tags:
17219         - ServiceDesignAndCreation
17220       summary: returns property-constraint
17221       description: returns property-constraint
17222       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17223       produces:
17224         - application/json
17225         - application/xml
17226       responses:
17227         "200":
17228           description: successful operation
17229           schema:
17230               $ref: "#/getDefinitions/property-constraint"
17231         "default":
17232           description: Response codes found in [response codes](https://wiki.onap.org/).
17233       parameters:
17234         - name: named-query-uuid
17235           in: path
17236           required: true
17237           type: string
17238           example: __NAMED-QUERY-UUID__
17239         - name: named-query-element-uuid
17240           in: path
17241           required: true
17242           type: string
17243           example: __NAMED-QUERY-ELEMENT-UUID__
17244         - name: property-constraint-uuid
17245           in: path
17246           required: true
17247           type: string
17248           example: __PROPERTY-CONSTRAINT-UUID__
17249     put:
17250       tags:
17251         - ServiceDesignAndCreation
17252       summary: create or update an existing property-constraint
17253       description: |
17254         Create or update an existing property-constraint.
17255         #
17256         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17257       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17258       consumes:
17259         - application/json
17260         - application/xml
17261       produces:
17262         - application/json
17263         - application/xml
17264       responses:
17265         "default":
17266           description: Response codes found in [response codes](https://wiki.onap.org/).
17267       parameters:
17268         - name: named-query-uuid
17269           in: path
17270           required: true
17271           type: string
17272           example: __NAMED-QUERY-UUID__
17273         - name: named-query-element-uuid
17274           in: path
17275           required: true
17276           type: string
17277           example: __NAMED-QUERY-ELEMENT-UUID__
17278         - name: property-constraint-uuid
17279           in: path
17280           required: true
17281           type: string
17282           example: __PROPERTY-CONSTRAINT-UUID__
17283         - name: body
17284           in: body
17285           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17286           required: true
17287           schema:
17288             $ref: "#/definitions/property-constraint"
17289     patch:
17290       tags:
17291         - ServiceDesignAndCreation
17292       summary: update an existing property-constraint
17293       description: |
17294         Update an existing property-constraint
17295         #
17296         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17297         The PUT operation will entirely replace an existing object.
17298         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17299         #
17300         Other differences between PUT and PATCH are:
17301         #
17302         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17303         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17304         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17305       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17306       consumes:
17307         - application/json
17308         - application/xml
17309       produces:
17310         - application/json
17311         - application/xml
17312       responses:
17313         "default":
17314           description: Response codes found in [response codes](https://wiki.onap.org/).
17315       parameters:
17316         - name: named-query-uuid
17317           in: path
17318           required: true
17319           type: string
17320           example: __NAMED-QUERY-UUID__
17321         - name: named-query-element-uuid
17322           in: path
17323           required: true
17324           type: string
17325           example: __NAMED-QUERY-ELEMENT-UUID__
17326         - name: property-constraint-uuid
17327           in: path
17328           required: true
17329           type: string
17330           example: __PROPERTY-CONSTRAINT-UUID__
17331         - name: body
17332           in: body
17333           description: property-constraint object that needs to be updated.
17334           required: true
17335           schema:
17336             $ref: "#/patchDefinitions/property-constraint"
17337     delete:
17338       tags:
17339         - ServiceDesignAndCreation
17340       summary: delete an existing property-constraint
17341       description: delete an existing property-constraint
17342       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17343       consumes:
17344         - application/json
17345         - application/xml
17346       produces:
17347         - application/json
17348         - application/xml
17349       responses:
17350         "default":
17351           description: Response codes found in [response codes](https://wiki.onap.org/).
17352       parameters:
17353         - name: named-query-uuid
17354           in: path
17355           required: true
17356           type: string
17357           example: __NAMED-QUERY-UUID__
17358         - name: named-query-element-uuid
17359           in: path
17360           required: true
17361           type: string
17362           example: __NAMED-QUERY-ELEMENT-UUID__
17363         - name: property-constraint-uuid
17364           in: path
17365           required: true
17366           type: string
17367           example: __PROPERTY-CONSTRAINT-UUID__
17368         - name: resource-version
17369           in: query
17370           description: resource-version for concurrency
17371           required: true
17372           type: string
17373   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
17374     get:
17375       tags:
17376         - ServiceDesignAndCreation
17377       summary: returns property-constraints
17378       description: returns property-constraints
17379       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
17380       produces:
17381         - application/json
17382         - application/xml
17383       responses:
17384         "200":
17385           description: successful operation
17386           schema:
17387               $ref: "#/getDefinitions/property-constraints"
17388         "default":
17389           description: Response codes found in [response codes](https://wiki.onap.org/).
17390       parameters:
17391         - name: named-query-uuid
17392           in: path
17393           required: true
17394           type: string
17395           example: __NAMED-QUERY-UUID__
17396         - name: named-query-element-uuid
17397           in: path
17398           required: true
17399           type: string
17400           example: __NAMED-QUERY-ELEMENT-UUID__
17401         - name: property-constraint-uuid
17402           in: query
17403           description:
17404           required: false
17405           type: string
17406   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
17407     put:
17408       tags:
17409         - ServiceDesignAndCreation
17410       summary: see node definition for valid relationships
17411       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17412       consumes:
17413         - application/json
17414         - application/xml
17415       produces:
17416         - application/json
17417         - application/xml
17418       responses:
17419         "default":
17420           description: Response codes found in [response codes](https://wiki.onap.org/).
17421       parameters:
17422         - name: named-query-uuid
17423           in: path
17424           required: true
17425           type: string
17426           example: __NAMED-QUERY-UUID__
17427         - name: named-query-element-uuid
17428           in: path
17429           required: true
17430           type: string
17431           example: __NAMED-QUERY-ELEMENT-UUID__
17432         - name: body
17433           in: body
17434           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17435           required: true
17436           schema:
17437             $ref: "#/definitions/relationship"
17438     delete:
17439       tags:
17440         - ServiceDesignAndCreation
17441       summary: delete an existing relationship
17442       description: delete an existing relationship
17443       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17444       consumes:
17445         - application/json
17446         - application/xml
17447       produces:
17448         - application/json
17449         - application/xml
17450       responses:
17451         "default":
17452           description: Response codes found in [response codes](https://wiki.onap.org/).
17453       parameters:
17454         - name: named-query-uuid
17455           in: path
17456           required: true
17457           type: string
17458           example: __NAMED-QUERY-UUID__
17459         - name: named-query-element-uuid
17460           in: path
17461           required: true
17462           type: string
17463           example: __NAMED-QUERY-ELEMENT-UUID__
17464   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
17465     get:
17466       tags:
17467         - ServiceDesignAndCreation
17468       summary: returns named-query-element
17469       description: returns named-query-element
17470       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17471       produces:
17472         - application/json
17473         - application/xml
17474       responses:
17475         "200":
17476           description: successful operation
17477           schema:
17478               $ref: "#/getDefinitions/named-query-element"
17479         "default":
17480           description: Response codes found in [response codes](https://wiki.onap.org/).
17481       parameters:
17482         - name: named-query-uuid
17483           in: path
17484           required: true
17485           type: string
17486           example: __NAMED-QUERY-UUID__
17487         - name: named-query-element-uuid
17488           in: path
17489           required: true
17490           type: string
17491           example: __NAMED-QUERY-ELEMENT-UUID__
17492     put:
17493       tags:
17494         - ServiceDesignAndCreation
17495       summary: create or update an existing named-query-element
17496       description: |
17497         Create or update an existing named-query-element.
17498         #
17499         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17500       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
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: named-query-uuid
17512           in: path
17513           required: true
17514           type: string
17515           example: __NAMED-QUERY-UUID__
17516         - name: named-query-element-uuid
17517           in: path
17518           required: true
17519           type: string
17520           example: __NAMED-QUERY-ELEMENT-UUID__
17521         - name: body
17522           in: body
17523           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17524           required: true
17525           schema:
17526             $ref: "#/definitions/named-query-element"
17527     patch:
17528       tags:
17529         - ServiceDesignAndCreation
17530       summary: update an existing named-query-element
17531       description: |
17532         Update an existing named-query-element
17533         #
17534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17535         The PUT operation will entirely replace an existing object.
17536         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17537         #
17538         Other differences between PUT and PATCH are:
17539         #
17540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17543       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17544       consumes:
17545         - application/json
17546         - application/xml
17547       produces:
17548         - application/json
17549         - application/xml
17550       responses:
17551         "default":
17552           description: Response codes found in [response codes](https://wiki.onap.org/).
17553       parameters:
17554         - name: named-query-uuid
17555           in: path
17556           required: true
17557           type: string
17558           example: __NAMED-QUERY-UUID__
17559         - name: named-query-element-uuid
17560           in: path
17561           required: true
17562           type: string
17563           example: __NAMED-QUERY-ELEMENT-UUID__
17564         - name: body
17565           in: body
17566           description: named-query-element object that needs to be updated.
17567           required: true
17568           schema:
17569             $ref: "#/patchDefinitions/named-query-element"
17570     delete:
17571       tags:
17572         - ServiceDesignAndCreation
17573       summary: delete an existing named-query-element
17574       description: delete an existing named-query-element
17575       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17576       consumes:
17577         - application/json
17578         - application/xml
17579       produces:
17580         - application/json
17581         - application/xml
17582       responses:
17583         "default":
17584           description: Response codes found in [response codes](https://wiki.onap.org/).
17585       parameters:
17586         - name: named-query-uuid
17587           in: path
17588           required: true
17589           type: string
17590           example: __NAMED-QUERY-UUID__
17591         - name: named-query-element-uuid
17592           in: path
17593           required: true
17594           type: string
17595           example: __NAMED-QUERY-ELEMENT-UUID__
17596         - name: resource-version
17597           in: query
17598           description: resource-version for concurrency
17599           required: true
17600           type: string
17601   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
17602     get:
17603       tags:
17604         - ServiceDesignAndCreation
17605       summary: returns named-query-elements
17606       description: returns named-query-elements
17607       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
17608       produces:
17609         - application/json
17610         - application/xml
17611       responses:
17612         "200":
17613           description: successful operation
17614           schema:
17615               $ref: "#/getDefinitions/named-query-elements"
17616         "default":
17617           description: Response codes found in [response codes](https://wiki.onap.org/).
17618       parameters:
17619         - name: named-query-uuid
17620           in: path
17621           required: true
17622           type: string
17623           example: __NAMED-QUERY-UUID__
17624         - name: named-query-element-uuid
17625           in: query
17626           description:
17627           required: false
17628           type: string
17629   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
17630     put:
17631       tags:
17632         - ServiceDesignAndCreation
17633       summary: see node definition for valid relationships
17634       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17635       consumes:
17636         - application/json
17637         - application/xml
17638       produces:
17639         - application/json
17640         - application/xml
17641       responses:
17642         "default":
17643           description: Response codes found in [response codes](https://wiki.onap.org/).
17644       parameters:
17645         - name: named-query-uuid
17646           in: path
17647           required: true
17648           type: string
17649           example: __NAMED-QUERY-UUID__
17650         - name: body
17651           in: body
17652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17653           required: true
17654           schema:
17655             $ref: "#/definitions/relationship"
17656     delete:
17657       tags:
17658         - ServiceDesignAndCreation
17659       summary: delete an existing relationship
17660       description: delete an existing relationship
17661       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17662       consumes:
17663         - application/json
17664         - application/xml
17665       produces:
17666         - application/json
17667         - application/xml
17668       responses:
17669         "default":
17670           description: Response codes found in [response codes](https://wiki.onap.org/).
17671       parameters:
17672         - name: named-query-uuid
17673           in: path
17674           required: true
17675           type: string
17676           example: __NAMED-QUERY-UUID__
17677   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
17678     get:
17679       tags:
17680         - ServiceDesignAndCreation
17681       summary: returns named-query
17682       description: returns named-query
17683       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
17684       produces:
17685         - application/json
17686         - application/xml
17687       responses:
17688         "200":
17689           description: successful operation
17690           schema:
17691               $ref: "#/getDefinitions/named-query"
17692         "default":
17693           description: Response codes found in [response codes](https://wiki.onap.org/).
17694       parameters:
17695         - name: named-query-uuid
17696           in: path
17697           required: true
17698           type: string
17699           example: __NAMED-QUERY-UUID__
17700     put:
17701       tags:
17702         - ServiceDesignAndCreation
17703       summary: create or update an existing named-query
17704       description: |
17705         Create or update an existing named-query.
17706         #
17707         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17708       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
17709       consumes:
17710         - application/json
17711         - application/xml
17712       produces:
17713         - application/json
17714         - application/xml
17715       responses:
17716         "default":
17717           description: Response codes found in [response codes](https://wiki.onap.org/).
17718       parameters:
17719         - name: named-query-uuid
17720           in: path
17721           required: true
17722           type: string
17723           example: __NAMED-QUERY-UUID__
17724         - name: body
17725           in: body
17726           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17727           required: true
17728           schema:
17729             $ref: "#/definitions/named-query"
17730     patch:
17731       tags:
17732         - ServiceDesignAndCreation
17733       summary: update an existing named-query
17734       description: |
17735         Update an existing named-query
17736         #
17737         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17738         The PUT operation will entirely replace an existing object.
17739         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17740         #
17741         Other differences between PUT and PATCH are:
17742         #
17743         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17744         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17745         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17746       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
17747       consumes:
17748         - application/json
17749         - application/xml
17750       produces:
17751         - application/json
17752         - application/xml
17753       responses:
17754         "default":
17755           description: Response codes found in [response codes](https://wiki.onap.org/).
17756       parameters:
17757         - name: named-query-uuid
17758           in: path
17759           required: true
17760           type: string
17761           example: __NAMED-QUERY-UUID__
17762         - name: body
17763           in: body
17764           description: named-query object that needs to be updated.
17765           required: true
17766           schema:
17767             $ref: "#/patchDefinitions/named-query"
17768     delete:
17769       tags:
17770         - ServiceDesignAndCreation
17771       summary: delete an existing named-query
17772       description: delete an existing named-query
17773       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
17774       consumes:
17775         - application/json
17776         - application/xml
17777       produces:
17778         - application/json
17779         - application/xml
17780       responses:
17781         "default":
17782           description: Response codes found in [response codes](https://wiki.onap.org/).
17783       parameters:
17784         - name: named-query-uuid
17785           in: path
17786           required: true
17787           type: string
17788           example: __NAMED-QUERY-UUID__
17789         - name: resource-version
17790           in: query
17791           description: resource-version for concurrency
17792           required: true
17793           type: string
17794   /service-design-and-creation/named-queries:
17795     get:
17796       tags:
17797         - ServiceDesignAndCreation
17798       summary: returns named-queries
17799       description: returns named-queries
17800       operationId: getServiceDesignAndCreationNamedQueries
17801       produces:
17802         - application/json
17803         - application/xml
17804       responses:
17805         "200":
17806           description: successful operation
17807           schema:
17808               $ref: "#/getDefinitions/named-queries"
17809         "default":
17810           description: Response codes found in [response codes](https://wiki.onap.org/).
17811       parameters:
17812         - name: named-query-uuid
17813           in: query
17814           description:
17815           required: false
17816           type: string
17817         - name: named-query-name
17818           in: query
17819           description:
17820           required: false
17821           type: string
17822   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
17823     put:
17824       tags:
17825         - Network
17826       summary: see node definition for valid relationships
17827       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17828       consumes:
17829         - application/json
17830         - application/xml
17831       produces:
17832         - application/json
17833         - application/xml
17834       responses:
17835         "default":
17836           description: Response codes found in [response codes](https://wiki.onap.org/).
17837       parameters:
17838         - name: link-name
17839           in: path
17840           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17841           required: true
17842           type: string
17843           example: __LINK-NAME__
17844         - name: body
17845           in: body
17846           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
17847           required: true
17848           schema:
17849             $ref: "#/definitions/relationship"
17850     delete:
17851       tags:
17852         - Network
17853       summary: delete an existing relationship
17854       description: delete an existing relationship
17855       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17856       consumes:
17857         - application/json
17858         - application/xml
17859       produces:
17860         - application/json
17861         - application/xml
17862       responses:
17863         "default":
17864           description: Response codes found in [response codes](https://wiki.onap.org/).
17865       parameters:
17866         - name: link-name
17867           in: path
17868           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17869           required: true
17870           type: string
17871           example: __LINK-NAME__
17872   /network/logical-links/logical-link/{link-name}:
17873     get:
17874       tags:
17875         - Network
17876       summary: returns logical-link
17877       description: returns logical-link
17878       operationId: getNetworkLogicalLinksLogicalLink
17879       produces:
17880         - application/json
17881         - application/xml
17882       responses:
17883         "200":
17884           description: successful operation
17885           schema:
17886               $ref: "#/getDefinitions/logical-link"
17887         "default":
17888           description: Response codes found in [response codes](https://wiki.onap.org/).
17889       parameters:
17890         - name: link-name
17891           in: path
17892           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17893           required: true
17894           type: string
17895           example: __LINK-NAME__
17896     put:
17897       tags:
17898         - Network
17899       summary: create or update an existing logical-link
17900       description: |
17901         Create or update an existing logical-link.
17902         #
17903         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17904       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
17905       consumes:
17906         - application/json
17907         - application/xml
17908       produces:
17909         - application/json
17910         - application/xml
17911       responses:
17912         "default":
17913           description: Response codes found in [response codes](https://wiki.onap.org/).
17914       parameters:
17915         - name: link-name
17916           in: path
17917           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17918           required: true
17919           type: string
17920           example: __LINK-NAME__
17921         - name: body
17922           in: body
17923           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
17924           required: true
17925           schema:
17926             $ref: "#/definitions/logical-link"
17927     patch:
17928       tags:
17929         - Network
17930       summary: update an existing logical-link
17931       description: |
17932         Update an existing logical-link
17933         #
17934         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17935         The PUT operation will entirely replace an existing object.
17936         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17937         #
17938         Other differences between PUT and PATCH are:
17939         #
17940         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17941         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17942         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17943       operationId: UpdateNetworkLogicalLinksLogicalLink
17944       consumes:
17945         - application/json
17946         - application/xml
17947       produces:
17948         - application/json
17949         - application/xml
17950       responses:
17951         "default":
17952           description: Response codes found in [response codes](https://wiki.onap.org/).
17953       parameters:
17954         - name: link-name
17955           in: path
17956           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17957           required: true
17958           type: string
17959           example: __LINK-NAME__
17960         - name: body
17961           in: body
17962           description: logical-link object that needs to be updated.
17963           required: true
17964           schema:
17965             $ref: "#/patchDefinitions/logical-link"
17966     delete:
17967       tags:
17968         - Network
17969       summary: delete an existing logical-link
17970       description: delete an existing logical-link
17971       operationId: deleteNetworkLogicalLinksLogicalLink
17972       consumes:
17973         - application/json
17974         - application/xml
17975       produces:
17976         - application/json
17977         - application/xml
17978       responses:
17979         "default":
17980           description: Response codes found in [response codes](https://wiki.onap.org/).
17981       parameters:
17982         - name: link-name
17983           in: path
17984           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17985           required: true
17986           type: string
17987           example: __LINK-NAME__
17988         - name: resource-version
17989           in: query
17990           description: resource-version for concurrency
17991           required: true
17992           type: string
17993   /network/logical-links:
17994     get:
17995       tags:
17996         - Network
17997       summary: returns logical-links
17998       description: returns logical-links
17999       operationId: getNetworkLogicalLinks
18000       produces:
18001         - application/json
18002         - application/xml
18003       responses:
18004         "200":
18005           description: successful operation
18006           schema:
18007               $ref: "#/getDefinitions/logical-links"
18008         "default":
18009           description: Response codes found in [response codes](https://wiki.onap.org/).
18010       parameters:
18011         - name: link-name
18012           in: query
18013           description:
18014           required: false
18015           type: string
18016         - name: model-invariant-id
18017           in: query
18018           description:
18019           required: false
18020           type: string
18021         - name: model-version-id
18022           in: query
18023           description:
18024           required: false
18025           type: string
18026         - name: widget-model-id
18027           in: query
18028           description:
18029           required: false
18030           type: string
18031         - name: widget-model-version
18032           in: query
18033           description:
18034           required: false
18035           type: string
18036         - name: prov-status
18037           in: query
18038           description:
18039           required: false
18040           type: string
18041         - name: link-id
18042           in: query
18043           description:
18044           required: false
18045           type: string
18046         - name: circuit-id
18047           in: query
18048           description:
18049           required: false
18050           type: string
18051         - name: purpose
18052           in: query
18053           description:
18054           required: false
18055           type: string
18056   /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:
18057     put:
18058       tags:
18059         - Network
18060       summary: see node definition for valid relationships
18061       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18062       consumes:
18063         - application/json
18064         - application/xml
18065       produces:
18066         - application/json
18067         - application/xml
18068       responses:
18069         "default":
18070           description: Response codes found in [response codes](https://wiki.onap.org/).
18071       parameters:
18072         - name: site-pair-set-id
18073           in: path
18074           description: Unique id of site pair set.
18075           required: true
18076           type: string
18077           example: __SITE-PAIR-SET-ID__
18078         - name: routing-instance-id
18079           in: path
18080           description: Unique id of routing instance
18081           required: true
18082           type: string
18083           example: __ROUTING-INSTANCE-ID__
18084         - name: site-pair-id
18085           in: path
18086           description: unique identifier of probe
18087           required: true
18088           type: string
18089           example: __SITE-PAIR-ID__
18090         - name: cos
18091           in: path
18092           description: unique identifier of probe
18093           required: true
18094           type: string
18095           example: __COS__
18096         - name: body
18097           in: body
18098           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18099           required: true
18100           schema:
18101             $ref: "#/definitions/relationship"
18102     delete:
18103       tags:
18104         - Network
18105       summary: delete an existing relationship
18106       description: delete an existing relationship
18107       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18108       consumes:
18109         - application/json
18110         - application/xml
18111       produces:
18112         - application/json
18113         - application/xml
18114       responses:
18115         "default":
18116           description: Response codes found in [response codes](https://wiki.onap.org/).
18117       parameters:
18118         - name: site-pair-set-id
18119           in: path
18120           description: Unique id of site pair set.
18121           required: true
18122           type: string
18123           example: __SITE-PAIR-SET-ID__
18124         - name: routing-instance-id
18125           in: path
18126           description: Unique id of routing instance
18127           required: true
18128           type: string
18129           example: __ROUTING-INSTANCE-ID__
18130         - name: site-pair-id
18131           in: path
18132           description: unique identifier of probe
18133           required: true
18134           type: string
18135           example: __SITE-PAIR-ID__
18136         - name: cos
18137           in: path
18138           description: unique identifier of probe
18139           required: true
18140           type: string
18141           example: __COS__
18142   /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}:
18143     get:
18144       tags:
18145         - Network
18146       summary: returns class-of-service
18147       description: returns class-of-service
18148       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18149       produces:
18150         - application/json
18151         - application/xml
18152       responses:
18153         "200":
18154           description: successful operation
18155           schema:
18156               $ref: "#/getDefinitions/class-of-service"
18157         "default":
18158           description: Response codes found in [response codes](https://wiki.onap.org/).
18159       parameters:
18160         - name: site-pair-set-id
18161           in: path
18162           description: Unique id of site pair set.
18163           required: true
18164           type: string
18165           example: __SITE-PAIR-SET-ID__
18166         - name: routing-instance-id
18167           in: path
18168           description: Unique id of routing instance
18169           required: true
18170           type: string
18171           example: __ROUTING-INSTANCE-ID__
18172         - name: site-pair-id
18173           in: path
18174           description: unique identifier of probe
18175           required: true
18176           type: string
18177           example: __SITE-PAIR-ID__
18178         - name: cos
18179           in: path
18180           description: unique identifier of probe
18181           required: true
18182           type: string
18183           example: __COS__
18184     put:
18185       tags:
18186         - Network
18187       summary: create or update an existing class-of-service
18188       description: |
18189         Create or update an existing class-of-service.
18190         #
18191         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18192       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18193       consumes:
18194         - application/json
18195         - application/xml
18196       produces:
18197         - application/json
18198         - application/xml
18199       responses:
18200         "default":
18201           description: Response codes found in [response codes](https://wiki.onap.org/).
18202       parameters:
18203         - name: site-pair-set-id
18204           in: path
18205           description: Unique id of site pair set.
18206           required: true
18207           type: string
18208           example: __SITE-PAIR-SET-ID__
18209         - name: routing-instance-id
18210           in: path
18211           description: Unique id of routing instance
18212           required: true
18213           type: string
18214           example: __ROUTING-INSTANCE-ID__
18215         - name: site-pair-id
18216           in: path
18217           description: unique identifier of probe
18218           required: true
18219           type: string
18220           example: __SITE-PAIR-ID__
18221         - name: cos
18222           in: path
18223           description: unique identifier of probe
18224           required: true
18225           type: string
18226           example: __COS__
18227         - name: body
18228           in: body
18229           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18230           required: true
18231           schema:
18232             $ref: "#/definitions/class-of-service"
18233     patch:
18234       tags:
18235         - Network
18236       summary: update an existing class-of-service
18237       description: |
18238         Update an existing class-of-service
18239         #
18240         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18241         The PUT operation will entirely replace an existing object.
18242         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18243         #
18244         Other differences between PUT and PATCH are:
18245         #
18246         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18247         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18248         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18249       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18250       consumes:
18251         - application/json
18252         - application/xml
18253       produces:
18254         - application/json
18255         - application/xml
18256       responses:
18257         "default":
18258           description: Response codes found in [response codes](https://wiki.onap.org/).
18259       parameters:
18260         - name: site-pair-set-id
18261           in: path
18262           description: Unique id of site pair set.
18263           required: true
18264           type: string
18265           example: __SITE-PAIR-SET-ID__
18266         - name: routing-instance-id
18267           in: path
18268           description: Unique id of routing instance
18269           required: true
18270           type: string
18271           example: __ROUTING-INSTANCE-ID__
18272         - name: site-pair-id
18273           in: path
18274           description: unique identifier of probe
18275           required: true
18276           type: string
18277           example: __SITE-PAIR-ID__
18278         - name: cos
18279           in: path
18280           description: unique identifier of probe
18281           required: true
18282           type: string
18283           example: __COS__
18284         - name: body
18285           in: body
18286           description: class-of-service object that needs to be updated.
18287           required: true
18288           schema:
18289             $ref: "#/patchDefinitions/class-of-service"
18290     delete:
18291       tags:
18292         - Network
18293       summary: delete an existing class-of-service
18294       description: delete an existing class-of-service
18295       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18296       consumes:
18297         - application/json
18298         - application/xml
18299       produces:
18300         - application/json
18301         - application/xml
18302       responses:
18303         "default":
18304           description: Response codes found in [response codes](https://wiki.onap.org/).
18305       parameters:
18306         - name: site-pair-set-id
18307           in: path
18308           description: Unique id of site pair set.
18309           required: true
18310           type: string
18311           example: __SITE-PAIR-SET-ID__
18312         - name: routing-instance-id
18313           in: path
18314           description: Unique id of routing instance
18315           required: true
18316           type: string
18317           example: __ROUTING-INSTANCE-ID__
18318         - name: site-pair-id
18319           in: path
18320           description: unique identifier of probe
18321           required: true
18322           type: string
18323           example: __SITE-PAIR-ID__
18324         - name: cos
18325           in: path
18326           description: unique identifier of probe
18327           required: true
18328           type: string
18329           example: __COS__
18330         - name: resource-version
18331           in: query
18332           description: resource-version for concurrency
18333           required: true
18334           type: string
18335   /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:
18336     get:
18337       tags:
18338         - Network
18339       summary: returns classes-of-service
18340       description: returns classes-of-service
18341       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
18342       produces:
18343         - application/json
18344         - application/xml
18345       responses:
18346         "200":
18347           description: successful operation
18348           schema:
18349               $ref: "#/getDefinitions/classes-of-service"
18350         "default":
18351           description: Response codes found in [response codes](https://wiki.onap.org/).
18352       parameters:
18353         - name: site-pair-set-id
18354           in: path
18355           description: Unique id of site pair set.
18356           required: true
18357           type: string
18358           example: __SITE-PAIR-SET-ID__
18359         - name: routing-instance-id
18360           in: path
18361           description: Unique id of routing instance
18362           required: true
18363           type: string
18364           example: __ROUTING-INSTANCE-ID__
18365         - name: site-pair-id
18366           in: path
18367           description: unique identifier of probe
18368           required: true
18369           type: string
18370           example: __SITE-PAIR-ID__
18371         - name: cos
18372           in: query
18373           description:
18374           required: false
18375           type: string
18376   /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:
18377     put:
18378       tags:
18379         - Network
18380       summary: see node definition for valid relationships
18381       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18382       consumes:
18383         - application/json
18384         - application/xml
18385       produces:
18386         - application/json
18387         - application/xml
18388       responses:
18389         "default":
18390           description: Response codes found in [response codes](https://wiki.onap.org/).
18391       parameters:
18392         - name: site-pair-set-id
18393           in: path
18394           description: Unique id of site pair set.
18395           required: true
18396           type: string
18397           example: __SITE-PAIR-SET-ID__
18398         - name: routing-instance-id
18399           in: path
18400           description: Unique id of routing instance
18401           required: true
18402           type: string
18403           example: __ROUTING-INSTANCE-ID__
18404         - name: site-pair-id
18405           in: path
18406           description: unique identifier of probe
18407           required: true
18408           type: string
18409           example: __SITE-PAIR-ID__
18410         - name: body
18411           in: body
18412           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18413           required: true
18414           schema:
18415             $ref: "#/definitions/relationship"
18416     delete:
18417       tags:
18418         - Network
18419       summary: delete an existing relationship
18420       description: delete an existing relationship
18421       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18422       consumes:
18423         - application/json
18424         - application/xml
18425       produces:
18426         - application/json
18427         - application/xml
18428       responses:
18429         "default":
18430           description: Response codes found in [response codes](https://wiki.onap.org/).
18431       parameters:
18432         - name: site-pair-set-id
18433           in: path
18434           description: Unique id of site pair set.
18435           required: true
18436           type: string
18437           example: __SITE-PAIR-SET-ID__
18438         - name: routing-instance-id
18439           in: path
18440           description: Unique id of routing instance
18441           required: true
18442           type: string
18443           example: __ROUTING-INSTANCE-ID__
18444         - name: site-pair-id
18445           in: path
18446           description: unique identifier of probe
18447           required: true
18448           type: string
18449           example: __SITE-PAIR-ID__
18450   /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}:
18451     get:
18452       tags:
18453         - Network
18454       summary: returns site-pair
18455       description: returns site-pair
18456       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18457       produces:
18458         - application/json
18459         - application/xml
18460       responses:
18461         "200":
18462           description: successful operation
18463           schema:
18464               $ref: "#/getDefinitions/site-pair"
18465         "default":
18466           description: Response codes found in [response codes](https://wiki.onap.org/).
18467       parameters:
18468         - name: site-pair-set-id
18469           in: path
18470           description: Unique id of site pair set.
18471           required: true
18472           type: string
18473           example: __SITE-PAIR-SET-ID__
18474         - name: routing-instance-id
18475           in: path
18476           description: Unique id of routing instance
18477           required: true
18478           type: string
18479           example: __ROUTING-INSTANCE-ID__
18480         - name: site-pair-id
18481           in: path
18482           description: unique identifier of probe
18483           required: true
18484           type: string
18485           example: __SITE-PAIR-ID__
18486     put:
18487       tags:
18488         - Network
18489       summary: create or update an existing site-pair
18490       description: |
18491         Create or update an existing site-pair.
18492         #
18493         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18494       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18495       consumes:
18496         - application/json
18497         - application/xml
18498       produces:
18499         - application/json
18500         - application/xml
18501       responses:
18502         "default":
18503           description: Response codes found in [response codes](https://wiki.onap.org/).
18504       parameters:
18505         - name: site-pair-set-id
18506           in: path
18507           description: Unique id of site pair set.
18508           required: true
18509           type: string
18510           example: __SITE-PAIR-SET-ID__
18511         - name: routing-instance-id
18512           in: path
18513           description: Unique id of routing instance
18514           required: true
18515           type: string
18516           example: __ROUTING-INSTANCE-ID__
18517         - name: site-pair-id
18518           in: path
18519           description: unique identifier of probe
18520           required: true
18521           type: string
18522           example: __SITE-PAIR-ID__
18523         - name: body
18524           in: body
18525           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18526           required: true
18527           schema:
18528             $ref: "#/definitions/site-pair"
18529     patch:
18530       tags:
18531         - Network
18532       summary: update an existing site-pair
18533       description: |
18534         Update an existing site-pair
18535         #
18536         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18537         The PUT operation will entirely replace an existing object.
18538         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18539         #
18540         Other differences between PUT and PATCH are:
18541         #
18542         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18543         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18544         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18545       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18546       consumes:
18547         - application/json
18548         - application/xml
18549       produces:
18550         - application/json
18551         - application/xml
18552       responses:
18553         "default":
18554           description: Response codes found in [response codes](https://wiki.onap.org/).
18555       parameters:
18556         - name: site-pair-set-id
18557           in: path
18558           description: Unique id of site pair set.
18559           required: true
18560           type: string
18561           example: __SITE-PAIR-SET-ID__
18562         - name: routing-instance-id
18563           in: path
18564           description: Unique id of routing instance
18565           required: true
18566           type: string
18567           example: __ROUTING-INSTANCE-ID__
18568         - name: site-pair-id
18569           in: path
18570           description: unique identifier of probe
18571           required: true
18572           type: string
18573           example: __SITE-PAIR-ID__
18574         - name: body
18575           in: body
18576           description: site-pair object that needs to be updated.
18577           required: true
18578           schema:
18579             $ref: "#/patchDefinitions/site-pair"
18580     delete:
18581       tags:
18582         - Network
18583       summary: delete an existing site-pair
18584       description: delete an existing site-pair
18585       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
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: site-pair-set-id
18597           in: path
18598           description: Unique id of site pair set.
18599           required: true
18600           type: string
18601           example: __SITE-PAIR-SET-ID__
18602         - name: routing-instance-id
18603           in: path
18604           description: Unique id of routing instance
18605           required: true
18606           type: string
18607           example: __ROUTING-INSTANCE-ID__
18608         - name: site-pair-id
18609           in: path
18610           description: unique identifier of probe
18611           required: true
18612           type: string
18613           example: __SITE-PAIR-ID__
18614         - name: resource-version
18615           in: query
18616           description: resource-version for concurrency
18617           required: true
18618           type: string
18619   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
18620     get:
18621       tags:
18622         - Network
18623       summary: returns site-pairs
18624       description: returns site-pairs
18625       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
18626       produces:
18627         - application/json
18628         - application/xml
18629       responses:
18630         "200":
18631           description: successful operation
18632           schema:
18633               $ref: "#/getDefinitions/site-pairs"
18634         "default":
18635           description: Response codes found in [response codes](https://wiki.onap.org/).
18636       parameters:
18637         - name: site-pair-set-id
18638           in: path
18639           description: Unique id of site pair set.
18640           required: true
18641           type: string
18642           example: __SITE-PAIR-SET-ID__
18643         - name: routing-instance-id
18644           in: path
18645           description: Unique id of routing instance
18646           required: true
18647           type: string
18648           example: __ROUTING-INSTANCE-ID__
18649         - name: site-pair-id
18650           in: query
18651           description:
18652           required: false
18653           type: string
18654   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
18655     put:
18656       tags:
18657         - Network
18658       summary: see node definition for valid relationships
18659       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18660       consumes:
18661         - application/json
18662         - application/xml
18663       produces:
18664         - application/json
18665         - application/xml
18666       responses:
18667         "default":
18668           description: Response codes found in [response codes](https://wiki.onap.org/).
18669       parameters:
18670         - name: site-pair-set-id
18671           in: path
18672           description: Unique id of site pair set.
18673           required: true
18674           type: string
18675           example: __SITE-PAIR-SET-ID__
18676         - name: routing-instance-id
18677           in: path
18678           description: Unique id of routing instance
18679           required: true
18680           type: string
18681           example: __ROUTING-INSTANCE-ID__
18682         - name: body
18683           in: body
18684           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18685           required: true
18686           schema:
18687             $ref: "#/definitions/relationship"
18688     delete:
18689       tags:
18690         - Network
18691       summary: delete an existing relationship
18692       description: delete an existing relationship
18693       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18694       consumes:
18695         - application/json
18696         - application/xml
18697       produces:
18698         - application/json
18699         - application/xml
18700       responses:
18701         "default":
18702           description: Response codes found in [response codes](https://wiki.onap.org/).
18703       parameters:
18704         - name: site-pair-set-id
18705           in: path
18706           description: Unique id of site pair set.
18707           required: true
18708           type: string
18709           example: __SITE-PAIR-SET-ID__
18710         - name: routing-instance-id
18711           in: path
18712           description: Unique id of routing instance
18713           required: true
18714           type: string
18715           example: __ROUTING-INSTANCE-ID__
18716   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
18717     get:
18718       tags:
18719         - Network
18720       summary: returns routing-instance
18721       description: returns routing-instance
18722       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18723       produces:
18724         - application/json
18725         - application/xml
18726       responses:
18727         "200":
18728           description: successful operation
18729           schema:
18730               $ref: "#/getDefinitions/routing-instance"
18731         "default":
18732           description: Response codes found in [response codes](https://wiki.onap.org/).
18733       parameters:
18734         - name: site-pair-set-id
18735           in: path
18736           description: Unique id of site pair set.
18737           required: true
18738           type: string
18739           example: __SITE-PAIR-SET-ID__
18740         - name: routing-instance-id
18741           in: path
18742           description: Unique id of routing instance
18743           required: true
18744           type: string
18745           example: __ROUTING-INSTANCE-ID__
18746     put:
18747       tags:
18748         - Network
18749       summary: create or update an existing routing-instance
18750       description: |
18751         Create or update an existing routing-instance.
18752         #
18753         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18754       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18755       consumes:
18756         - application/json
18757         - application/xml
18758       produces:
18759         - application/json
18760         - application/xml
18761       responses:
18762         "default":
18763           description: Response codes found in [response codes](https://wiki.onap.org/).
18764       parameters:
18765         - name: site-pair-set-id
18766           in: path
18767           description: Unique id of site pair set.
18768           required: true
18769           type: string
18770           example: __SITE-PAIR-SET-ID__
18771         - name: routing-instance-id
18772           in: path
18773           description: Unique id of routing instance
18774           required: true
18775           type: string
18776           example: __ROUTING-INSTANCE-ID__
18777         - name: body
18778           in: body
18779           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18780           required: true
18781           schema:
18782             $ref: "#/definitions/routing-instance"
18783     patch:
18784       tags:
18785         - Network
18786       summary: update an existing routing-instance
18787       description: |
18788         Update an existing routing-instance
18789         #
18790         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18791         The PUT operation will entirely replace an existing object.
18792         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18793         #
18794         Other differences between PUT and PATCH are:
18795         #
18796         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18797         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18798         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18799       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18800       consumes:
18801         - application/json
18802         - application/xml
18803       produces:
18804         - application/json
18805         - application/xml
18806       responses:
18807         "default":
18808           description: Response codes found in [response codes](https://wiki.onap.org/).
18809       parameters:
18810         - name: site-pair-set-id
18811           in: path
18812           description: Unique id of site pair set.
18813           required: true
18814           type: string
18815           example: __SITE-PAIR-SET-ID__
18816         - name: routing-instance-id
18817           in: path
18818           description: Unique id of routing instance
18819           required: true
18820           type: string
18821           example: __ROUTING-INSTANCE-ID__
18822         - name: body
18823           in: body
18824           description: routing-instance object that needs to be updated.
18825           required: true
18826           schema:
18827             $ref: "#/patchDefinitions/routing-instance"
18828     delete:
18829       tags:
18830         - Network
18831       summary: delete an existing routing-instance
18832       description: delete an existing routing-instance
18833       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18834       consumes:
18835         - application/json
18836         - application/xml
18837       produces:
18838         - application/json
18839         - application/xml
18840       responses:
18841         "default":
18842           description: Response codes found in [response codes](https://wiki.onap.org/).
18843       parameters:
18844         - name: site-pair-set-id
18845           in: path
18846           description: Unique id of site pair set.
18847           required: true
18848           type: string
18849           example: __SITE-PAIR-SET-ID__
18850         - name: routing-instance-id
18851           in: path
18852           description: Unique id of routing instance
18853           required: true
18854           type: string
18855           example: __ROUTING-INSTANCE-ID__
18856         - name: resource-version
18857           in: query
18858           description: resource-version for concurrency
18859           required: true
18860           type: string
18861   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
18862     get:
18863       tags:
18864         - Network
18865       summary: returns routing-instances
18866       description: returns routing-instances
18867       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
18868       produces:
18869         - application/json
18870         - application/xml
18871       responses:
18872         "200":
18873           description: successful operation
18874           schema:
18875               $ref: "#/getDefinitions/routing-instances"
18876         "default":
18877           description: Response codes found in [response codes](https://wiki.onap.org/).
18878       parameters:
18879         - name: site-pair-set-id
18880           in: path
18881           description: Unique id of site pair set.
18882           required: true
18883           type: string
18884           example: __SITE-PAIR-SET-ID__
18885         - name: routing-instance-id
18886           in: query
18887           description:
18888           required: false
18889           type: string
18890   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
18891     put:
18892       tags:
18893         - Network
18894       summary: see node definition for valid relationships
18895       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
18896       consumes:
18897         - application/json
18898         - application/xml
18899       produces:
18900         - application/json
18901         - application/xml
18902       responses:
18903         "default":
18904           description: Response codes found in [response codes](https://wiki.onap.org/).
18905       parameters:
18906         - name: site-pair-set-id
18907           in: path
18908           description: Unique id of site pair set.
18909           required: true
18910           type: string
18911           example: __SITE-PAIR-SET-ID__
18912         - name: body
18913           in: body
18914           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
18915           required: true
18916           schema:
18917             $ref: "#/definitions/relationship"
18918     delete:
18919       tags:
18920         - Network
18921       summary: delete an existing relationship
18922       description: delete an existing relationship
18923       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
18924       consumes:
18925         - application/json
18926         - application/xml
18927       produces:
18928         - application/json
18929         - application/xml
18930       responses:
18931         "default":
18932           description: Response codes found in [response codes](https://wiki.onap.org/).
18933       parameters:
18934         - name: site-pair-set-id
18935           in: path
18936           description: Unique id of site pair set.
18937           required: true
18938           type: string
18939           example: __SITE-PAIR-SET-ID__
18940   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
18941     get:
18942       tags:
18943         - Network
18944       summary: returns site-pair-set
18945       description: returns site-pair-set
18946       operationId: getNetworkSitePairSetsSitePairSet
18947       produces:
18948         - application/json
18949         - application/xml
18950       responses:
18951         "200":
18952           description: successful operation
18953           schema:
18954               $ref: "#/getDefinitions/site-pair-set"
18955         "default":
18956           description: Response codes found in [response codes](https://wiki.onap.org/).
18957       parameters:
18958         - name: site-pair-set-id
18959           in: path
18960           description: Unique id of site pair set.
18961           required: true
18962           type: string
18963           example: __SITE-PAIR-SET-ID__
18964     put:
18965       tags:
18966         - Network
18967       summary: create or update an existing site-pair-set
18968       description: |
18969         Create or update an existing site-pair-set.
18970         #
18971         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18972       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
18973       consumes:
18974         - application/json
18975         - application/xml
18976       produces:
18977         - application/json
18978         - application/xml
18979       responses:
18980         "default":
18981           description: Response codes found in [response codes](https://wiki.onap.org/).
18982       parameters:
18983         - name: site-pair-set-id
18984           in: path
18985           description: Unique id of site pair set.
18986           required: true
18987           type: string
18988           example: __SITE-PAIR-SET-ID__
18989         - name: body
18990           in: body
18991           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
18992           required: true
18993           schema:
18994             $ref: "#/definitions/site-pair-set"
18995     patch:
18996       tags:
18997         - Network
18998       summary: update an existing site-pair-set
18999       description: |
19000         Update an existing site-pair-set
19001         #
19002         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19003         The PUT operation will entirely replace an existing object.
19004         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19005         #
19006         Other differences between PUT and PATCH are:
19007         #
19008         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19009         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19010         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19011       operationId: UpdateNetworkSitePairSetsSitePairSet
19012       consumes:
19013         - application/json
19014         - application/xml
19015       produces:
19016         - application/json
19017         - application/xml
19018       responses:
19019         "default":
19020           description: Response codes found in [response codes](https://wiki.onap.org/).
19021       parameters:
19022         - name: site-pair-set-id
19023           in: path
19024           description: Unique id of site pair set.
19025           required: true
19026           type: string
19027           example: __SITE-PAIR-SET-ID__
19028         - name: body
19029           in: body
19030           description: site-pair-set object that needs to be updated.
19031           required: true
19032           schema:
19033             $ref: "#/patchDefinitions/site-pair-set"
19034     delete:
19035       tags:
19036         - Network
19037       summary: delete an existing site-pair-set
19038       description: delete an existing site-pair-set
19039       operationId: deleteNetworkSitePairSetsSitePairSet
19040       consumes:
19041         - application/json
19042         - application/xml
19043       produces:
19044         - application/json
19045         - application/xml
19046       responses:
19047         "default":
19048           description: Response codes found in [response codes](https://wiki.onap.org/).
19049       parameters:
19050         - name: site-pair-set-id
19051           in: path
19052           description: Unique id of site pair set.
19053           required: true
19054           type: string
19055           example: __SITE-PAIR-SET-ID__
19056         - name: resource-version
19057           in: query
19058           description: resource-version for concurrency
19059           required: true
19060           type: string
19061   /network/site-pair-sets:
19062     get:
19063       tags:
19064         - Network
19065       summary: returns site-pair-sets
19066       description: returns site-pair-sets
19067       operationId: getNetworkSitePairSets
19068       produces:
19069         - application/json
19070         - application/xml
19071       responses:
19072         "200":
19073           description: successful operation
19074           schema:
19075               $ref: "#/getDefinitions/site-pair-sets"
19076         "default":
19077           description: Response codes found in [response codes](https://wiki.onap.org/).
19078       parameters:
19079         - name: site-pair-set-id
19080           in: query
19081           description:
19082           required: false
19083           type: string
19084   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
19085     put:
19086       tags:
19087         - Network
19088       summary: see node definition for valid relationships
19089       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
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: vpn-id
19101           in: path
19102           description: VPN ID, globally unique within A&AI
19103           required: true
19104           type: string
19105           example: __VPN-ID__
19106         - name: global-route-target
19107           in: path
19108           description: Number used to identify an RT, globally unique in the network
19109           required: true
19110           type: string
19111           example: __GLOBAL-ROUTE-TARGET__
19112         - name: route-target-role
19113           in: path
19114           description: Role assigned to this route target
19115           required: true
19116           type: string
19117           example: __ROUTE-TARGET-ROLE__
19118         - name: body
19119           in: body
19120           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
19121           required: true
19122           schema:
19123             $ref: "#/definitions/relationship"
19124     delete:
19125       tags:
19126         - Network
19127       summary: delete an existing relationship
19128       description: delete an existing relationship
19129       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
19130       consumes:
19131         - application/json
19132         - application/xml
19133       produces:
19134         - application/json
19135         - application/xml
19136       responses:
19137         "default":
19138           description: Response codes found in [response codes](https://wiki.onap.org/).
19139       parameters:
19140         - name: vpn-id
19141           in: path
19142           description: VPN ID, globally unique within A&AI
19143           required: true
19144           type: string
19145           example: __VPN-ID__
19146         - name: global-route-target
19147           in: path
19148           description: Number used to identify an RT, globally unique in the network
19149           required: true
19150           type: string
19151           example: __GLOBAL-ROUTE-TARGET__
19152         - name: route-target-role
19153           in: path
19154           description: Role assigned to this route target
19155           required: true
19156           type: string
19157           example: __ROUTE-TARGET-ROLE__
19158   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
19159     get:
19160       tags:
19161         - Network
19162       summary: returns route-target
19163       description: returns route-target
19164       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19165       produces:
19166         - application/json
19167         - application/xml
19168       responses:
19169         "200":
19170           description: successful operation
19171           schema:
19172               $ref: "#/getDefinitions/route-target"
19173         "default":
19174           description: Response codes found in [response codes](https://wiki.onap.org/).
19175       parameters:
19176         - name: vpn-id
19177           in: path
19178           description: VPN ID, globally unique within A&AI
19179           required: true
19180           type: string
19181           example: __VPN-ID__
19182         - name: global-route-target
19183           in: path
19184           description: Number used to identify an RT, globally unique in the network
19185           required: true
19186           type: string
19187           example: __GLOBAL-ROUTE-TARGET__
19188         - name: route-target-role
19189           in: path
19190           description: Role assigned to this route target
19191           required: true
19192           type: string
19193           example: __ROUTE-TARGET-ROLE__
19194     put:
19195       tags:
19196         - Network
19197       summary: create or update an existing route-target
19198       description: |
19199         Create or update an existing route-target.
19200         #
19201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19202       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19203       consumes:
19204         - application/json
19205         - application/xml
19206       produces:
19207         - application/json
19208         - application/xml
19209       responses:
19210         "default":
19211           description: Response codes found in [response codes](https://wiki.onap.org/).
19212       parameters:
19213         - name: vpn-id
19214           in: path
19215           description: VPN ID, globally unique within A&AI
19216           required: true
19217           type: string
19218           example: __VPN-ID__
19219         - name: global-route-target
19220           in: path
19221           description: Number used to identify an RT, globally unique in the network
19222           required: true
19223           type: string
19224           example: __GLOBAL-ROUTE-TARGET__
19225         - name: route-target-role
19226           in: path
19227           description: Role assigned to this route target
19228           required: true
19229           type: string
19230           example: __ROUTE-TARGET-ROLE__
19231         - name: body
19232           in: body
19233           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
19234           required: true
19235           schema:
19236             $ref: "#/definitions/route-target"
19237     patch:
19238       tags:
19239         - Network
19240       summary: update an existing route-target
19241       description: |
19242         Update an existing route-target
19243         #
19244         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19245         The PUT operation will entirely replace an existing object.
19246         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19247         #
19248         Other differences between PUT and PATCH are:
19249         #
19250         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19251         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19252         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19253       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19254       consumes:
19255         - application/json
19256         - application/xml
19257       produces:
19258         - application/json
19259         - application/xml
19260       responses:
19261         "default":
19262           description: Response codes found in [response codes](https://wiki.onap.org/).
19263       parameters:
19264         - name: vpn-id
19265           in: path
19266           description: VPN ID, globally unique within A&AI
19267           required: true
19268           type: string
19269           example: __VPN-ID__
19270         - name: global-route-target
19271           in: path
19272           description: Number used to identify an RT, globally unique in the network
19273           required: true
19274           type: string
19275           example: __GLOBAL-ROUTE-TARGET__
19276         - name: route-target-role
19277           in: path
19278           description: Role assigned to this route target
19279           required: true
19280           type: string
19281           example: __ROUTE-TARGET-ROLE__
19282         - name: body
19283           in: body
19284           description: route-target object that needs to be updated.
19285           required: true
19286           schema:
19287             $ref: "#/patchDefinitions/route-target"
19288     delete:
19289       tags:
19290         - Network
19291       summary: delete an existing route-target
19292       description: delete an existing route-target
19293       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19294       consumes:
19295         - application/json
19296         - application/xml
19297       produces:
19298         - application/json
19299         - application/xml
19300       responses:
19301         "default":
19302           description: Response codes found in [response codes](https://wiki.onap.org/).
19303       parameters:
19304         - name: vpn-id
19305           in: path
19306           description: VPN ID, globally unique within A&AI
19307           required: true
19308           type: string
19309           example: __VPN-ID__
19310         - name: global-route-target
19311           in: path
19312           description: Number used to identify an RT, globally unique in the network
19313           required: true
19314           type: string
19315           example: __GLOBAL-ROUTE-TARGET__
19316         - name: route-target-role
19317           in: path
19318           description: Role assigned to this route target
19319           required: true
19320           type: string
19321           example: __ROUTE-TARGET-ROLE__
19322         - name: resource-version
19323           in: query
19324           description: resource-version for concurrency
19325           required: true
19326           type: string
19327   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
19328     get:
19329       tags:
19330         - Network
19331       summary: returns route-targets
19332       description: returns route-targets
19333       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
19334       produces:
19335         - application/json
19336         - application/xml
19337       responses:
19338         "200":
19339           description: successful operation
19340           schema:
19341               $ref: "#/getDefinitions/route-targets"
19342         "default":
19343           description: Response codes found in [response codes](https://wiki.onap.org/).
19344       parameters:
19345         - name: vpn-id
19346           in: path
19347           description: VPN ID, globally unique within A&AI
19348           required: true
19349           type: string
19350           example: __VPN-ID__
19351   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19352     put:
19353       tags:
19354         - Network
19355       summary: see node definition for valid relationships
19356       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19357       consumes:
19358         - application/json
19359         - application/xml
19360       produces:
19361         - application/json
19362         - application/xml
19363       responses:
19364         "default":
19365           description: Response codes found in [response codes](https://wiki.onap.org/).
19366       parameters:
19367         - name: vpn-id
19368           in: path
19369           description: VPN ID, globally unique within A&AI
19370           required: true
19371           type: string
19372           example: __VPN-ID__
19373         - name: body
19374           in: body
19375           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
19376           required: true
19377           schema:
19378             $ref: "#/definitions/relationship"
19379     delete:
19380       tags:
19381         - Network
19382       summary: delete an existing relationship
19383       description: delete an existing relationship
19384       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19385       consumes:
19386         - application/json
19387         - application/xml
19388       produces:
19389         - application/json
19390         - application/xml
19391       responses:
19392         "default":
19393           description: Response codes found in [response codes](https://wiki.onap.org/).
19394       parameters:
19395         - name: vpn-id
19396           in: path
19397           description: VPN ID, globally unique within A&AI
19398           required: true
19399           type: string
19400           example: __VPN-ID__
19401   /network/vpn-bindings/vpn-binding/{vpn-id}:
19402     get:
19403       tags:
19404         - Network
19405       summary: returns vpn-binding
19406       description: returns vpn-binding
19407       operationId: getNetworkVpnBindingsVpnBinding
19408       produces:
19409         - application/json
19410         - application/xml
19411       responses:
19412         "200":
19413           description: successful operation
19414           schema:
19415               $ref: "#/getDefinitions/vpn-binding"
19416         "default":
19417           description: Response codes found in [response codes](https://wiki.onap.org/).
19418       parameters:
19419         - name: vpn-id
19420           in: path
19421           description: VPN ID, globally unique within A&AI
19422           required: true
19423           type: string
19424           example: __VPN-ID__
19425     put:
19426       tags:
19427         - Network
19428       summary: create or update an existing vpn-binding
19429       description: |
19430         Create or update an existing vpn-binding.
19431         #
19432         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19433       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19434       consumes:
19435         - application/json
19436         - application/xml
19437       produces:
19438         - application/json
19439         - application/xml
19440       responses:
19441         "default":
19442           description: Response codes found in [response codes](https://wiki.onap.org/).
19443       parameters:
19444         - name: vpn-id
19445           in: path
19446           description: VPN ID, globally unique within A&AI
19447           required: true
19448           type: string
19449           example: __VPN-ID__
19450         - name: body
19451           in: body
19452           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
19453           required: true
19454           schema:
19455             $ref: "#/definitions/vpn-binding"
19456     patch:
19457       tags:
19458         - Network
19459       summary: update an existing vpn-binding
19460       description: |
19461         Update an existing vpn-binding
19462         #
19463         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19464         The PUT operation will entirely replace an existing object.
19465         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19466         #
19467         Other differences between PUT and PATCH are:
19468         #
19469         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19470         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19471         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19472       operationId: UpdateNetworkVpnBindingsVpnBinding
19473       consumes:
19474         - application/json
19475         - application/xml
19476       produces:
19477         - application/json
19478         - application/xml
19479       responses:
19480         "default":
19481           description: Response codes found in [response codes](https://wiki.onap.org/).
19482       parameters:
19483         - name: vpn-id
19484           in: path
19485           description: VPN ID, globally unique within A&AI
19486           required: true
19487           type: string
19488           example: __VPN-ID__
19489         - name: body
19490           in: body
19491           description: vpn-binding object that needs to be updated.
19492           required: true
19493           schema:
19494             $ref: "#/patchDefinitions/vpn-binding"
19495     delete:
19496       tags:
19497         - Network
19498       summary: delete an existing vpn-binding
19499       description: delete an existing vpn-binding
19500       operationId: deleteNetworkVpnBindingsVpnBinding
19501       consumes:
19502         - application/json
19503         - application/xml
19504       produces:
19505         - application/json
19506         - application/xml
19507       responses:
19508         "default":
19509           description: Response codes found in [response codes](https://wiki.onap.org/).
19510       parameters:
19511         - name: vpn-id
19512           in: path
19513           description: VPN ID, globally unique within A&AI
19514           required: true
19515           type: string
19516           example: __VPN-ID__
19517         - name: resource-version
19518           in: query
19519           description: resource-version for concurrency
19520           required: true
19521           type: string
19522   /network/vpn-bindings:
19523     get:
19524       tags:
19525         - Network
19526       summary: returns vpn-bindings
19527       description: returns vpn-bindings
19528       operationId: getNetworkVpnBindings
19529       produces:
19530         - application/json
19531         - application/xml
19532       responses:
19533         "200":
19534           description: successful operation
19535           schema:
19536               $ref: "#/getDefinitions/vpn-bindings"
19537         "default":
19538           description: Response codes found in [response codes](https://wiki.onap.org/).
19539       parameters:
19540         - name: vpn-id
19541           in: query
19542           description:
19543           required: false
19544           type: string
19545         - name: vpn-name
19546           in: query
19547           description:
19548           required: false
19549           type: string
19550         - name: vpn-type
19551           in: query
19552           description:
19553           required: false
19554           type: string
19555   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19556     put:
19557       tags:
19558         - Network
19559       summary: see node definition for valid relationships
19560       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19561       consumes:
19562         - application/json
19563         - application/xml
19564       produces:
19565         - application/json
19566         - application/xml
19567       responses:
19568         "default":
19569           description: Response codes found in [response codes](https://wiki.onap.org/).
19570       parameters:
19571         - name: equipment-name
19572           in: path
19573           required: true
19574           type: string
19575           example: __EQUIPMENT-NAME__
19576         - name: body
19577           in: body
19578           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
19579           required: true
19580           schema:
19581             $ref: "#/definitions/relationship"
19582     delete:
19583       tags:
19584         - Network
19585       summary: delete an existing relationship
19586       description: delete an existing relationship
19587       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19588       consumes:
19589         - application/json
19590         - application/xml
19591       produces:
19592         - application/json
19593         - application/xml
19594       responses:
19595         "default":
19596           description: Response codes found in [response codes](https://wiki.onap.org/).
19597       parameters:
19598         - name: equipment-name
19599           in: path
19600           required: true
19601           type: string
19602           example: __EQUIPMENT-NAME__
19603   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19604     put:
19605       tags:
19606         - Network
19607       summary: see node definition for valid relationships
19608       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19609       consumes:
19610         - application/json
19611         - application/xml
19612       produces:
19613         - application/json
19614         - application/xml
19615       responses:
19616         "default":
19617           description: Response codes found in [response codes](https://wiki.onap.org/).
19618       parameters:
19619         - name: equipment-name
19620           in: path
19621           required: true
19622           type: string
19623           example: __EQUIPMENT-NAME__
19624         - name: interface-name
19625           in: path
19626           description: Name that identifies the physical interface
19627           required: true
19628           type: string
19629           example: __INTERFACE-NAME__
19630         - name: body
19631           in: body
19632           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
19633           required: true
19634           schema:
19635             $ref: "#/definitions/relationship"
19636     delete:
19637       tags:
19638         - Network
19639       summary: delete an existing relationship
19640       description: delete an existing relationship
19641       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19642       consumes:
19643         - application/json
19644         - application/xml
19645       produces:
19646         - application/json
19647         - application/xml
19648       responses:
19649         "default":
19650           description: Response codes found in [response codes](https://wiki.onap.org/).
19651       parameters:
19652         - name: equipment-name
19653           in: path
19654           required: true
19655           type: string
19656           example: __EQUIPMENT-NAME__
19657         - name: interface-name
19658           in: path
19659           description: Name that identifies the physical interface
19660           required: true
19661           type: string
19662           example: __INTERFACE-NAME__
19663   /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:
19664     put:
19665       tags:
19666         - Network
19667       summary: see node definition for valid relationships
19668       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19669       consumes:
19670         - application/json
19671         - application/xml
19672       produces:
19673         - application/json
19674         - application/xml
19675       responses:
19676         "default":
19677           description: Response codes found in [response codes](https://wiki.onap.org/).
19678       parameters:
19679         - name: equipment-name
19680           in: path
19681           required: true
19682           type: string
19683           example: __EQUIPMENT-NAME__
19684         - name: interface-name
19685           in: path
19686           description: Name that identifies the physical interface
19687           required: true
19688           type: string
19689           example: __INTERFACE-NAME__
19690         - name: interface-name
19691           in: path
19692           description: Name given to the interface
19693           required: true
19694           type: string
19695           example: __INTERFACE-NAME__
19696         - name: vlan-interface
19697           in: path
19698           description: String that identifies the interface
19699           required: true
19700           type: string
19701           example: __VLAN-INTERFACE__
19702         - name: body
19703           in: body
19704           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19705           required: true
19706           schema:
19707             $ref: "#/definitions/relationship"
19708     delete:
19709       tags:
19710         - Network
19711       summary: delete an existing relationship
19712       description: delete an existing relationship
19713       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19714       consumes:
19715         - application/json
19716         - application/xml
19717       produces:
19718         - application/json
19719         - application/xml
19720       responses:
19721         "default":
19722           description: Response codes found in [response codes](https://wiki.onap.org/).
19723       parameters:
19724         - name: equipment-name
19725           in: path
19726           required: true
19727           type: string
19728           example: __EQUIPMENT-NAME__
19729         - name: interface-name
19730           in: path
19731           description: Name that identifies the physical interface
19732           required: true
19733           type: string
19734           example: __INTERFACE-NAME__
19735         - name: interface-name
19736           in: path
19737           description: Name given to the interface
19738           required: true
19739           type: string
19740           example: __INTERFACE-NAME__
19741         - name: vlan-interface
19742           in: path
19743           description: String that identifies the interface
19744           required: true
19745           type: string
19746           example: __VLAN-INTERFACE__
19747   /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:
19748     put:
19749       tags:
19750         - Network
19751       summary: see node definition for valid relationships
19752       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19753       consumes:
19754         - application/json
19755         - application/xml
19756       produces:
19757         - application/json
19758         - application/xml
19759       responses:
19760         "default":
19761           description: Response codes found in [response codes](https://wiki.onap.org/).
19762       parameters:
19763         - name: equipment-name
19764           in: path
19765           required: true
19766           type: string
19767           example: __EQUIPMENT-NAME__
19768         - name: interface-name
19769           in: path
19770           description: Name that identifies the physical interface
19771           required: true
19772           type: string
19773           example: __INTERFACE-NAME__
19774         - name: interface-name
19775           in: path
19776           description: Name given to the interface
19777           required: true
19778           type: string
19779           example: __INTERFACE-NAME__
19780         - name: vlan-interface
19781           in: path
19782           description: String that identifies the interface
19783           required: true
19784           type: string
19785           example: __VLAN-INTERFACE__
19786         - name: l3-interface-ipv4-address
19787           in: path
19788           description: IP address
19789           required: true
19790           type: string
19791           example: __L3-INTERFACE-IPV4-ADDRESS__
19792         - name: body
19793           in: body
19794           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19795           required: true
19796           schema:
19797             $ref: "#/definitions/relationship"
19798     delete:
19799       tags:
19800         - Network
19801       summary: delete an existing relationship
19802       description: delete an existing relationship
19803       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19804       consumes:
19805         - application/json
19806         - application/xml
19807       produces:
19808         - application/json
19809         - application/xml
19810       responses:
19811         "default":
19812           description: Response codes found in [response codes](https://wiki.onap.org/).
19813       parameters:
19814         - name: equipment-name
19815           in: path
19816           required: true
19817           type: string
19818           example: __EQUIPMENT-NAME__
19819         - name: interface-name
19820           in: path
19821           description: Name that identifies the physical interface
19822           required: true
19823           type: string
19824           example: __INTERFACE-NAME__
19825         - name: interface-name
19826           in: path
19827           description: Name given to the interface
19828           required: true
19829           type: string
19830           example: __INTERFACE-NAME__
19831         - name: vlan-interface
19832           in: path
19833           description: String that identifies the interface
19834           required: true
19835           type: string
19836           example: __VLAN-INTERFACE__
19837         - name: l3-interface-ipv4-address
19838           in: path
19839           description: IP address
19840           required: true
19841           type: string
19842           example: __L3-INTERFACE-IPV4-ADDRESS__
19843   /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}:
19844     get:
19845       tags:
19846         - Network
19847       summary: returns l3-interface-ipv4-address-list
19848       description: returns l3-interface-ipv4-address-list
19849       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19850       produces:
19851         - application/json
19852         - application/xml
19853       responses:
19854         "200":
19855           description: successful operation
19856           schema:
19857               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19858         "default":
19859           description: Response codes found in [response codes](https://wiki.onap.org/).
19860       parameters:
19861         - name: equipment-name
19862           in: path
19863           required: true
19864           type: string
19865           example: __EQUIPMENT-NAME__
19866         - name: interface-name
19867           in: path
19868           description: Name that identifies the physical interface
19869           required: true
19870           type: string
19871           example: __INTERFACE-NAME__
19872         - name: interface-name
19873           in: path
19874           description: Name given to the interface
19875           required: true
19876           type: string
19877           example: __INTERFACE-NAME__
19878         - name: vlan-interface
19879           in: path
19880           description: String that identifies the interface
19881           required: true
19882           type: string
19883           example: __VLAN-INTERFACE__
19884         - name: l3-interface-ipv4-address
19885           in: path
19886           description: IP address
19887           required: true
19888           type: string
19889           example: __L3-INTERFACE-IPV4-ADDRESS__
19890     put:
19891       tags:
19892         - Network
19893       summary: create or update an existing l3-interface-ipv4-address-list
19894       description: |
19895         Create or update an existing l3-interface-ipv4-address-list.
19896         #
19897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19898       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19899       consumes:
19900         - application/json
19901         - application/xml
19902       produces:
19903         - application/json
19904         - application/xml
19905       responses:
19906         "default":
19907           description: Response codes found in [response codes](https://wiki.onap.org/).
19908       parameters:
19909         - name: equipment-name
19910           in: path
19911           required: true
19912           type: string
19913           example: __EQUIPMENT-NAME__
19914         - name: interface-name
19915           in: path
19916           description: Name that identifies the physical interface
19917           required: true
19918           type: string
19919           example: __INTERFACE-NAME__
19920         - name: interface-name
19921           in: path
19922           description: Name given to the interface
19923           required: true
19924           type: string
19925           example: __INTERFACE-NAME__
19926         - name: vlan-interface
19927           in: path
19928           description: String that identifies the interface
19929           required: true
19930           type: string
19931           example: __VLAN-INTERFACE__
19932         - name: l3-interface-ipv4-address
19933           in: path
19934           description: IP address
19935           required: true
19936           type: string
19937           example: __L3-INTERFACE-IPV4-ADDRESS__
19938         - name: body
19939           in: body
19940           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19941           required: true
19942           schema:
19943             $ref: "#/definitions/l3-interface-ipv4-address-list"
19944     patch:
19945       tags:
19946         - Network
19947       summary: update an existing l3-interface-ipv4-address-list
19948       description: |
19949         Update an existing l3-interface-ipv4-address-list
19950         #
19951         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19952         The PUT operation will entirely replace an existing object.
19953         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19954         #
19955         Other differences between PUT and PATCH are:
19956         #
19957         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19958         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19959         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19960       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19961       consumes:
19962         - application/json
19963         - application/xml
19964       produces:
19965         - application/json
19966         - application/xml
19967       responses:
19968         "default":
19969           description: Response codes found in [response codes](https://wiki.onap.org/).
19970       parameters:
19971         - name: equipment-name
19972           in: path
19973           required: true
19974           type: string
19975           example: __EQUIPMENT-NAME__
19976         - name: interface-name
19977           in: path
19978           description: Name that identifies the physical interface
19979           required: true
19980           type: string
19981           example: __INTERFACE-NAME__
19982         - name: interface-name
19983           in: path
19984           description: Name given to the interface
19985           required: true
19986           type: string
19987           example: __INTERFACE-NAME__
19988         - name: vlan-interface
19989           in: path
19990           description: String that identifies the interface
19991           required: true
19992           type: string
19993           example: __VLAN-INTERFACE__
19994         - name: l3-interface-ipv4-address
19995           in: path
19996           description: IP address
19997           required: true
19998           type: string
19999           example: __L3-INTERFACE-IPV4-ADDRESS__
20000         - name: body
20001           in: body
20002           description: l3-interface-ipv4-address-list object that needs to be updated.
20003           required: true
20004           schema:
20005             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20006     delete:
20007       tags:
20008         - Network
20009       summary: delete an existing l3-interface-ipv4-address-list
20010       description: delete an existing l3-interface-ipv4-address-list
20011       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20012       consumes:
20013         - application/json
20014         - application/xml
20015       produces:
20016         - application/json
20017         - application/xml
20018       responses:
20019         "default":
20020           description: Response codes found in [response codes](https://wiki.onap.org/).
20021       parameters:
20022         - name: equipment-name
20023           in: path
20024           required: true
20025           type: string
20026           example: __EQUIPMENT-NAME__
20027         - name: interface-name
20028           in: path
20029           description: Name that identifies the physical interface
20030           required: true
20031           type: string
20032           example: __INTERFACE-NAME__
20033         - name: interface-name
20034           in: path
20035           description: Name given to the interface
20036           required: true
20037           type: string
20038           example: __INTERFACE-NAME__
20039         - name: vlan-interface
20040           in: path
20041           description: String that identifies the interface
20042           required: true
20043           type: string
20044           example: __VLAN-INTERFACE__
20045         - name: l3-interface-ipv4-address
20046           in: path
20047           description: IP address
20048           required: true
20049           type: string
20050           example: __L3-INTERFACE-IPV4-ADDRESS__
20051         - name: resource-version
20052           in: query
20053           description: resource-version for concurrency
20054           required: true
20055           type: string
20056   /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:
20057     put:
20058       tags:
20059         - Network
20060       summary: see node definition for valid relationships
20061       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20062       consumes:
20063         - application/json
20064         - application/xml
20065       produces:
20066         - application/json
20067         - application/xml
20068       responses:
20069         "default":
20070           description: Response codes found in [response codes](https://wiki.onap.org/).
20071       parameters:
20072         - name: equipment-name
20073           in: path
20074           required: true
20075           type: string
20076           example: __EQUIPMENT-NAME__
20077         - name: interface-name
20078           in: path
20079           description: Name that identifies the physical interface
20080           required: true
20081           type: string
20082           example: __INTERFACE-NAME__
20083         - name: interface-name
20084           in: path
20085           description: Name given to the interface
20086           required: true
20087           type: string
20088           example: __INTERFACE-NAME__
20089         - name: vlan-interface
20090           in: path
20091           description: String that identifies the interface
20092           required: true
20093           type: string
20094           example: __VLAN-INTERFACE__
20095         - name: l3-interface-ipv6-address
20096           in: path
20097           description: IP address
20098           required: true
20099           type: string
20100           example: __L3-INTERFACE-IPV6-ADDRESS__
20101         - name: body
20102           in: body
20103           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20104           required: true
20105           schema:
20106             $ref: "#/definitions/relationship"
20107     delete:
20108       tags:
20109         - Network
20110       summary: delete an existing relationship
20111       description: delete an existing relationship
20112       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20113       consumes:
20114         - application/json
20115         - application/xml
20116       produces:
20117         - application/json
20118         - application/xml
20119       responses:
20120         "default":
20121           description: Response codes found in [response codes](https://wiki.onap.org/).
20122       parameters:
20123         - name: equipment-name
20124           in: path
20125           required: true
20126           type: string
20127           example: __EQUIPMENT-NAME__
20128         - name: interface-name
20129           in: path
20130           description: Name that identifies the physical interface
20131           required: true
20132           type: string
20133           example: __INTERFACE-NAME__
20134         - name: interface-name
20135           in: path
20136           description: Name given to the interface
20137           required: true
20138           type: string
20139           example: __INTERFACE-NAME__
20140         - name: vlan-interface
20141           in: path
20142           description: String that identifies the interface
20143           required: true
20144           type: string
20145           example: __VLAN-INTERFACE__
20146         - name: l3-interface-ipv6-address
20147           in: path
20148           description: IP address
20149           required: true
20150           type: string
20151           example: __L3-INTERFACE-IPV6-ADDRESS__
20152   /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}:
20153     get:
20154       tags:
20155         - Network
20156       summary: returns l3-interface-ipv6-address-list
20157       description: returns l3-interface-ipv6-address-list
20158       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20159       produces:
20160         - application/json
20161         - application/xml
20162       responses:
20163         "200":
20164           description: successful operation
20165           schema:
20166               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
20167         "default":
20168           description: Response codes found in [response codes](https://wiki.onap.org/).
20169       parameters:
20170         - name: equipment-name
20171           in: path
20172           required: true
20173           type: string
20174           example: __EQUIPMENT-NAME__
20175         - name: interface-name
20176           in: path
20177           description: Name that identifies the physical interface
20178           required: true
20179           type: string
20180           example: __INTERFACE-NAME__
20181         - name: interface-name
20182           in: path
20183           description: Name given to the interface
20184           required: true
20185           type: string
20186           example: __INTERFACE-NAME__
20187         - name: vlan-interface
20188           in: path
20189           description: String that identifies the interface
20190           required: true
20191           type: string
20192           example: __VLAN-INTERFACE__
20193         - name: l3-interface-ipv6-address
20194           in: path
20195           description: IP address
20196           required: true
20197           type: string
20198           example: __L3-INTERFACE-IPV6-ADDRESS__
20199     put:
20200       tags:
20201         - Network
20202       summary: create or update an existing l3-interface-ipv6-address-list
20203       description: |
20204         Create or update an existing l3-interface-ipv6-address-list.
20205         #
20206         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20207       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20208       consumes:
20209         - application/json
20210         - application/xml
20211       produces:
20212         - application/json
20213         - application/xml
20214       responses:
20215         "default":
20216           description: Response codes found in [response codes](https://wiki.onap.org/).
20217       parameters:
20218         - name: equipment-name
20219           in: path
20220           required: true
20221           type: string
20222           example: __EQUIPMENT-NAME__
20223         - name: interface-name
20224           in: path
20225           description: Name that identifies the physical interface
20226           required: true
20227           type: string
20228           example: __INTERFACE-NAME__
20229         - name: interface-name
20230           in: path
20231           description: Name given to the interface
20232           required: true
20233           type: string
20234           example: __INTERFACE-NAME__
20235         - name: vlan-interface
20236           in: path
20237           description: String that identifies the interface
20238           required: true
20239           type: string
20240           example: __VLAN-INTERFACE__
20241         - name: l3-interface-ipv6-address
20242           in: path
20243           description: IP address
20244           required: true
20245           type: string
20246           example: __L3-INTERFACE-IPV6-ADDRESS__
20247         - name: body
20248           in: body
20249           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20250           required: true
20251           schema:
20252             $ref: "#/definitions/l3-interface-ipv6-address-list"
20253     patch:
20254       tags:
20255         - Network
20256       summary: update an existing l3-interface-ipv6-address-list
20257       description: |
20258         Update an existing l3-interface-ipv6-address-list
20259         #
20260         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20261         The PUT operation will entirely replace an existing object.
20262         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20263         #
20264         Other differences between PUT and PATCH are:
20265         #
20266         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20267         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20268         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20269       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20270       consumes:
20271         - application/json
20272         - application/xml
20273       produces:
20274         - application/json
20275         - application/xml
20276       responses:
20277         "default":
20278           description: Response codes found in [response codes](https://wiki.onap.org/).
20279       parameters:
20280         - name: equipment-name
20281           in: path
20282           required: true
20283           type: string
20284           example: __EQUIPMENT-NAME__
20285         - name: interface-name
20286           in: path
20287           description: Name that identifies the physical interface
20288           required: true
20289           type: string
20290           example: __INTERFACE-NAME__
20291         - name: interface-name
20292           in: path
20293           description: Name given to the interface
20294           required: true
20295           type: string
20296           example: __INTERFACE-NAME__
20297         - name: vlan-interface
20298           in: path
20299           description: String that identifies the interface
20300           required: true
20301           type: string
20302           example: __VLAN-INTERFACE__
20303         - name: l3-interface-ipv6-address
20304           in: path
20305           description: IP address
20306           required: true
20307           type: string
20308           example: __L3-INTERFACE-IPV6-ADDRESS__
20309         - name: body
20310           in: body
20311           description: l3-interface-ipv6-address-list object that needs to be updated.
20312           required: true
20313           schema:
20314             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20315     delete:
20316       tags:
20317         - Network
20318       summary: delete an existing l3-interface-ipv6-address-list
20319       description: delete an existing l3-interface-ipv6-address-list
20320       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20321       consumes:
20322         - application/json
20323         - application/xml
20324       produces:
20325         - application/json
20326         - application/xml
20327       responses:
20328         "default":
20329           description: Response codes found in [response codes](https://wiki.onap.org/).
20330       parameters:
20331         - name: equipment-name
20332           in: path
20333           required: true
20334           type: string
20335           example: __EQUIPMENT-NAME__
20336         - name: interface-name
20337           in: path
20338           description: Name that identifies the physical interface
20339           required: true
20340           type: string
20341           example: __INTERFACE-NAME__
20342         - name: interface-name
20343           in: path
20344           description: Name given to the interface
20345           required: true
20346           type: string
20347           example: __INTERFACE-NAME__
20348         - name: vlan-interface
20349           in: path
20350           description: String that identifies the interface
20351           required: true
20352           type: string
20353           example: __VLAN-INTERFACE__
20354         - name: l3-interface-ipv6-address
20355           in: path
20356           description: IP address
20357           required: true
20358           type: string
20359           example: __L3-INTERFACE-IPV6-ADDRESS__
20360         - name: resource-version
20361           in: query
20362           description: resource-version for concurrency
20363           required: true
20364           type: string
20365   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20366     get:
20367       tags:
20368         - Network
20369       summary: returns vlan
20370       description: returns vlan
20371       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20372       produces:
20373         - application/json
20374         - application/xml
20375       responses:
20376         "200":
20377           description: successful operation
20378           schema:
20379               $ref: "#/getDefinitions/vlan"
20380         "default":
20381           description: Response codes found in [response codes](https://wiki.onap.org/).
20382       parameters:
20383         - name: equipment-name
20384           in: path
20385           required: true
20386           type: string
20387           example: __EQUIPMENT-NAME__
20388         - name: interface-name
20389           in: path
20390           description: Name that identifies the physical interface
20391           required: true
20392           type: string
20393           example: __INTERFACE-NAME__
20394         - name: interface-name
20395           in: path
20396           description: Name given to the interface
20397           required: true
20398           type: string
20399           example: __INTERFACE-NAME__
20400         - name: vlan-interface
20401           in: path
20402           description: String that identifies the interface
20403           required: true
20404           type: string
20405           example: __VLAN-INTERFACE__
20406     put:
20407       tags:
20408         - Network
20409       summary: create or update an existing vlan
20410       description: |
20411         Create or update an existing vlan.
20412         #
20413         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20414       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20415       consumes:
20416         - application/json
20417         - application/xml
20418       produces:
20419         - application/json
20420         - application/xml
20421       responses:
20422         "default":
20423           description: Response codes found in [response codes](https://wiki.onap.org/).
20424       parameters:
20425         - name: equipment-name
20426           in: path
20427           required: true
20428           type: string
20429           example: __EQUIPMENT-NAME__
20430         - name: interface-name
20431           in: path
20432           description: Name that identifies the physical interface
20433           required: true
20434           type: string
20435           example: __INTERFACE-NAME__
20436         - name: interface-name
20437           in: path
20438           description: Name given to the interface
20439           required: true
20440           type: string
20441           example: __INTERFACE-NAME__
20442         - name: vlan-interface
20443           in: path
20444           description: String that identifies the interface
20445           required: true
20446           type: string
20447           example: __VLAN-INTERFACE__
20448         - name: body
20449           in: body
20450           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20451           required: true
20452           schema:
20453             $ref: "#/definitions/vlan"
20454     patch:
20455       tags:
20456         - Network
20457       summary: update an existing vlan
20458       description: |
20459         Update an existing vlan
20460         #
20461         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20462         The PUT operation will entirely replace an existing object.
20463         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20464         #
20465         Other differences between PUT and PATCH are:
20466         #
20467         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20468         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20469         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20470       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20471       consumes:
20472         - application/json
20473         - application/xml
20474       produces:
20475         - application/json
20476         - application/xml
20477       responses:
20478         "default":
20479           description: Response codes found in [response codes](https://wiki.onap.org/).
20480       parameters:
20481         - name: equipment-name
20482           in: path
20483           required: true
20484           type: string
20485           example: __EQUIPMENT-NAME__
20486         - name: interface-name
20487           in: path
20488           description: Name that identifies the physical interface
20489           required: true
20490           type: string
20491           example: __INTERFACE-NAME__
20492         - name: interface-name
20493           in: path
20494           description: Name given to the interface
20495           required: true
20496           type: string
20497           example: __INTERFACE-NAME__
20498         - name: vlan-interface
20499           in: path
20500           description: String that identifies the interface
20501           required: true
20502           type: string
20503           example: __VLAN-INTERFACE__
20504         - name: body
20505           in: body
20506           description: vlan object that needs to be updated.
20507           required: true
20508           schema:
20509             $ref: "#/patchDefinitions/vlan"
20510     delete:
20511       tags:
20512         - Network
20513       summary: delete an existing vlan
20514       description: delete an existing vlan
20515       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20516       consumes:
20517         - application/json
20518         - application/xml
20519       produces:
20520         - application/json
20521         - application/xml
20522       responses:
20523         "default":
20524           description: Response codes found in [response codes](https://wiki.onap.org/).
20525       parameters:
20526         - name: equipment-name
20527           in: path
20528           required: true
20529           type: string
20530           example: __EQUIPMENT-NAME__
20531         - name: interface-name
20532           in: path
20533           description: Name that identifies the physical interface
20534           required: true
20535           type: string
20536           example: __INTERFACE-NAME__
20537         - name: interface-name
20538           in: path
20539           description: Name given to the interface
20540           required: true
20541           type: string
20542           example: __INTERFACE-NAME__
20543         - name: vlan-interface
20544           in: path
20545           description: String that identifies the interface
20546           required: true
20547           type: string
20548           example: __VLAN-INTERFACE__
20549         - name: resource-version
20550           in: query
20551           description: resource-version for concurrency
20552           required: true
20553           type: string
20554   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
20555     get:
20556       tags:
20557         - Network
20558       summary: returns vlans
20559       description: returns vlans
20560       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
20561       produces:
20562         - application/json
20563         - application/xml
20564       responses:
20565         "200":
20566           description: successful operation
20567           schema:
20568               $ref: "#/getDefinitions/vlans"
20569         "default":
20570           description: Response codes found in [response codes](https://wiki.onap.org/).
20571       parameters:
20572         - name: equipment-name
20573           in: path
20574           required: true
20575           type: string
20576           example: __EQUIPMENT-NAME__
20577         - name: interface-name
20578           in: path
20579           description: Name that identifies the physical interface
20580           required: true
20581           type: string
20582           example: __INTERFACE-NAME__
20583         - name: interface-name
20584           in: path
20585           description: Name given to the interface
20586           required: true
20587           type: string
20588           example: __INTERFACE-NAME__
20589         - name: vlan-interface
20590           in: query
20591           description:
20592           required: false
20593           type: string
20594         - name: vlan-id-inner
20595           in: query
20596           description:
20597           required: false
20598           type: integer
20599           format: int64
20600         - name: vpn-id
20601           in: query
20602           description:
20603           required: false
20604           type: string
20605   /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:
20606     put:
20607       tags:
20608         - Network
20609       summary: see node definition for valid relationships
20610       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20611       consumes:
20612         - application/json
20613         - application/xml
20614       produces:
20615         - application/json
20616         - application/xml
20617       responses:
20618         "default":
20619           description: Response codes found in [response codes](https://wiki.onap.org/).
20620       parameters:
20621         - name: equipment-name
20622           in: path
20623           required: true
20624           type: string
20625           example: __EQUIPMENT-NAME__
20626         - name: interface-name
20627           in: path
20628           description: Name that identifies the physical interface
20629           required: true
20630           type: string
20631           example: __INTERFACE-NAME__
20632         - name: interface-name
20633           in: path
20634           description: Name given to the interface
20635           required: true
20636           type: string
20637           example: __INTERFACE-NAME__
20638         - name: pci-id
20639           in: path
20640           description: PCI ID used to identify the sriov-vf
20641           required: true
20642           type: string
20643           example: __PCI-ID__
20644         - name: body
20645           in: body
20646           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20647           required: true
20648           schema:
20649             $ref: "#/definitions/relationship"
20650     delete:
20651       tags:
20652         - Network
20653       summary: delete an existing relationship
20654       description: delete an existing relationship
20655       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20656       consumes:
20657         - application/json
20658         - application/xml
20659       produces:
20660         - application/json
20661         - application/xml
20662       responses:
20663         "default":
20664           description: Response codes found in [response codes](https://wiki.onap.org/).
20665       parameters:
20666         - name: equipment-name
20667           in: path
20668           required: true
20669           type: string
20670           example: __EQUIPMENT-NAME__
20671         - name: interface-name
20672           in: path
20673           description: Name that identifies the physical interface
20674           required: true
20675           type: string
20676           example: __INTERFACE-NAME__
20677         - name: interface-name
20678           in: path
20679           description: Name given to the interface
20680           required: true
20681           type: string
20682           example: __INTERFACE-NAME__
20683         - name: pci-id
20684           in: path
20685           description: PCI ID used to identify the sriov-vf
20686           required: true
20687           type: string
20688           example: __PCI-ID__
20689   /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}:
20690     get:
20691       tags:
20692         - Network
20693       summary: returns sriov-vf
20694       description: returns sriov-vf
20695       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20696       produces:
20697         - application/json
20698         - application/xml
20699       responses:
20700         "200":
20701           description: successful operation
20702           schema:
20703               $ref: "#/getDefinitions/sriov-vf"
20704         "default":
20705           description: Response codes found in [response codes](https://wiki.onap.org/).
20706       parameters:
20707         - name: equipment-name
20708           in: path
20709           required: true
20710           type: string
20711           example: __EQUIPMENT-NAME__
20712         - name: interface-name
20713           in: path
20714           description: Name that identifies the physical interface
20715           required: true
20716           type: string
20717           example: __INTERFACE-NAME__
20718         - name: interface-name
20719           in: path
20720           description: Name given to the interface
20721           required: true
20722           type: string
20723           example: __INTERFACE-NAME__
20724         - name: pci-id
20725           in: path
20726           description: PCI ID used to identify the sriov-vf
20727           required: true
20728           type: string
20729           example: __PCI-ID__
20730     put:
20731       tags:
20732         - Network
20733       summary: create or update an existing sriov-vf
20734       description: |
20735         Create or update an existing sriov-vf.
20736         #
20737         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20738       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20739       consumes:
20740         - application/json
20741         - application/xml
20742       produces:
20743         - application/json
20744         - application/xml
20745       responses:
20746         "default":
20747           description: Response codes found in [response codes](https://wiki.onap.org/).
20748       parameters:
20749         - name: equipment-name
20750           in: path
20751           required: true
20752           type: string
20753           example: __EQUIPMENT-NAME__
20754         - name: interface-name
20755           in: path
20756           description: Name that identifies the physical interface
20757           required: true
20758           type: string
20759           example: __INTERFACE-NAME__
20760         - name: interface-name
20761           in: path
20762           description: Name given to the interface
20763           required: true
20764           type: string
20765           example: __INTERFACE-NAME__
20766         - name: pci-id
20767           in: path
20768           description: PCI ID used to identify the sriov-vf
20769           required: true
20770           type: string
20771           example: __PCI-ID__
20772         - name: body
20773           in: body
20774           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20775           required: true
20776           schema:
20777             $ref: "#/definitions/sriov-vf"
20778     patch:
20779       tags:
20780         - Network
20781       summary: update an existing sriov-vf
20782       description: |
20783         Update an existing sriov-vf
20784         #
20785         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20786         The PUT operation will entirely replace an existing object.
20787         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20788         #
20789         Other differences between PUT and PATCH are:
20790         #
20791         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20792         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20793         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20794       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20795       consumes:
20796         - application/json
20797         - application/xml
20798       produces:
20799         - application/json
20800         - application/xml
20801       responses:
20802         "default":
20803           description: Response codes found in [response codes](https://wiki.onap.org/).
20804       parameters:
20805         - name: equipment-name
20806           in: path
20807           required: true
20808           type: string
20809           example: __EQUIPMENT-NAME__
20810         - name: interface-name
20811           in: path
20812           description: Name that identifies the physical interface
20813           required: true
20814           type: string
20815           example: __INTERFACE-NAME__
20816         - name: interface-name
20817           in: path
20818           description: Name given to the interface
20819           required: true
20820           type: string
20821           example: __INTERFACE-NAME__
20822         - name: pci-id
20823           in: path
20824           description: PCI ID used to identify the sriov-vf
20825           required: true
20826           type: string
20827           example: __PCI-ID__
20828         - name: body
20829           in: body
20830           description: sriov-vf object that needs to be updated.
20831           required: true
20832           schema:
20833             $ref: "#/patchDefinitions/sriov-vf"
20834     delete:
20835       tags:
20836         - Network
20837       summary: delete an existing sriov-vf
20838       description: delete an existing sriov-vf
20839       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20840       consumes:
20841         - application/json
20842         - application/xml
20843       produces:
20844         - application/json
20845         - application/xml
20846       responses:
20847         "default":
20848           description: Response codes found in [response codes](https://wiki.onap.org/).
20849       parameters:
20850         - name: equipment-name
20851           in: path
20852           required: true
20853           type: string
20854           example: __EQUIPMENT-NAME__
20855         - name: interface-name
20856           in: path
20857           description: Name that identifies the physical interface
20858           required: true
20859           type: string
20860           example: __INTERFACE-NAME__
20861         - name: interface-name
20862           in: path
20863           description: Name given to the interface
20864           required: true
20865           type: string
20866           example: __INTERFACE-NAME__
20867         - name: pci-id
20868           in: path
20869           description: PCI ID used to identify the sriov-vf
20870           required: true
20871           type: string
20872           example: __PCI-ID__
20873         - name: resource-version
20874           in: query
20875           description: resource-version for concurrency
20876           required: true
20877           type: string
20878   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
20879     get:
20880       tags:
20881         - Network
20882       summary: returns sriov-vfs
20883       description: returns sriov-vfs
20884       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
20885       produces:
20886         - application/json
20887         - application/xml
20888       responses:
20889         "200":
20890           description: successful operation
20891           schema:
20892               $ref: "#/getDefinitions/sriov-vfs"
20893         "default":
20894           description: Response codes found in [response codes](https://wiki.onap.org/).
20895       parameters:
20896         - name: equipment-name
20897           in: path
20898           required: true
20899           type: string
20900           example: __EQUIPMENT-NAME__
20901         - name: interface-name
20902           in: path
20903           description: Name that identifies the physical interface
20904           required: true
20905           type: string
20906           example: __INTERFACE-NAME__
20907         - name: interface-name
20908           in: path
20909           description: Name given to the interface
20910           required: true
20911           type: string
20912           example: __INTERFACE-NAME__
20913         - name: pci-id
20914           in: query
20915           description:
20916           required: false
20917           type: string
20918         - name: vf-vlan-filter
20919           in: query
20920           description:
20921           required: false
20922           type: string
20923         - name: vf-mac-filter
20924           in: query
20925           description:
20926           required: false
20927           type: string
20928         - name: vf-vlan-strip
20929           in: query
20930           description:
20931           required: false
20932           type: boolean
20933         - name: neutron-network-id
20934           in: query
20935           description:
20936           required: false
20937           type: string
20938   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
20939     put:
20940       tags:
20941         - Network
20942       summary: see node definition for valid relationships
20943       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20944       consumes:
20945         - application/json
20946         - application/xml
20947       produces:
20948         - application/json
20949         - application/xml
20950       responses:
20951         "default":
20952           description: Response codes found in [response codes](https://wiki.onap.org/).
20953       parameters:
20954         - name: equipment-name
20955           in: path
20956           required: true
20957           type: string
20958           example: __EQUIPMENT-NAME__
20959         - name: interface-name
20960           in: path
20961           description: Name that identifies the physical interface
20962           required: true
20963           type: string
20964           example: __INTERFACE-NAME__
20965         - name: interface-name
20966           in: path
20967           description: Name given to the interface
20968           required: true
20969           type: string
20970           example: __INTERFACE-NAME__
20971         - name: body
20972           in: body
20973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20974           required: true
20975           schema:
20976             $ref: "#/definitions/relationship"
20977     delete:
20978       tags:
20979         - Network
20980       summary: delete an existing relationship
20981       description: delete an existing relationship
20982       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20983       consumes:
20984         - application/json
20985         - application/xml
20986       produces:
20987         - application/json
20988         - application/xml
20989       responses:
20990         "default":
20991           description: Response codes found in [response codes](https://wiki.onap.org/).
20992       parameters:
20993         - name: equipment-name
20994           in: path
20995           required: true
20996           type: string
20997           example: __EQUIPMENT-NAME__
20998         - name: interface-name
20999           in: path
21000           description: Name that identifies the physical interface
21001           required: true
21002           type: string
21003           example: __INTERFACE-NAME__
21004         - name: interface-name
21005           in: path
21006           description: Name given to the interface
21007           required: true
21008           type: string
21009           example: __INTERFACE-NAME__
21010   /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:
21011     put:
21012       tags:
21013         - Network
21014       summary: see node definition for valid relationships
21015       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21016       consumes:
21017         - application/json
21018         - application/xml
21019       produces:
21020         - application/json
21021         - application/xml
21022       responses:
21023         "default":
21024           description: Response codes found in [response codes](https://wiki.onap.org/).
21025       parameters:
21026         - name: equipment-name
21027           in: path
21028           required: true
21029           type: string
21030           example: __EQUIPMENT-NAME__
21031         - name: interface-name
21032           in: path
21033           description: Name that identifies the physical interface
21034           required: true
21035           type: string
21036           example: __INTERFACE-NAME__
21037         - name: interface-name
21038           in: path
21039           description: Name given to the interface
21040           required: true
21041           type: string
21042           example: __INTERFACE-NAME__
21043         - name: l3-interface-ipv4-address
21044           in: path
21045           description: IP address
21046           required: true
21047           type: string
21048           example: __L3-INTERFACE-IPV4-ADDRESS__
21049         - name: body
21050           in: body
21051           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21052           required: true
21053           schema:
21054             $ref: "#/definitions/relationship"
21055     delete:
21056       tags:
21057         - Network
21058       summary: delete an existing relationship
21059       description: delete an existing relationship
21060       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21061       consumes:
21062         - application/json
21063         - application/xml
21064       produces:
21065         - application/json
21066         - application/xml
21067       responses:
21068         "default":
21069           description: Response codes found in [response codes](https://wiki.onap.org/).
21070       parameters:
21071         - name: equipment-name
21072           in: path
21073           required: true
21074           type: string
21075           example: __EQUIPMENT-NAME__
21076         - name: interface-name
21077           in: path
21078           description: Name that identifies the physical interface
21079           required: true
21080           type: string
21081           example: __INTERFACE-NAME__
21082         - name: interface-name
21083           in: path
21084           description: Name given to the interface
21085           required: true
21086           type: string
21087           example: __INTERFACE-NAME__
21088         - name: l3-interface-ipv4-address
21089           in: path
21090           description: IP address
21091           required: true
21092           type: string
21093           example: __L3-INTERFACE-IPV4-ADDRESS__
21094   /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}:
21095     get:
21096       tags:
21097         - Network
21098       summary: returns l3-interface-ipv4-address-list
21099       description: returns l3-interface-ipv4-address-list
21100       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21101       produces:
21102         - application/json
21103         - application/xml
21104       responses:
21105         "200":
21106           description: successful operation
21107           schema:
21108               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21109         "default":
21110           description: Response codes found in [response codes](https://wiki.onap.org/).
21111       parameters:
21112         - name: equipment-name
21113           in: path
21114           required: true
21115           type: string
21116           example: __EQUIPMENT-NAME__
21117         - name: interface-name
21118           in: path
21119           description: Name that identifies the physical interface
21120           required: true
21121           type: string
21122           example: __INTERFACE-NAME__
21123         - name: interface-name
21124           in: path
21125           description: Name given to the interface
21126           required: true
21127           type: string
21128           example: __INTERFACE-NAME__
21129         - name: l3-interface-ipv4-address
21130           in: path
21131           description: IP address
21132           required: true
21133           type: string
21134           example: __L3-INTERFACE-IPV4-ADDRESS__
21135     put:
21136       tags:
21137         - Network
21138       summary: create or update an existing l3-interface-ipv4-address-list
21139       description: |
21140         Create or update an existing l3-interface-ipv4-address-list.
21141         #
21142         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21143       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21144       consumes:
21145         - application/json
21146         - application/xml
21147       produces:
21148         - application/json
21149         - application/xml
21150       responses:
21151         "default":
21152           description: Response codes found in [response codes](https://wiki.onap.org/).
21153       parameters:
21154         - name: equipment-name
21155           in: path
21156           required: true
21157           type: string
21158           example: __EQUIPMENT-NAME__
21159         - name: interface-name
21160           in: path
21161           description: Name that identifies the physical interface
21162           required: true
21163           type: string
21164           example: __INTERFACE-NAME__
21165         - name: interface-name
21166           in: path
21167           description: Name given to the interface
21168           required: true
21169           type: string
21170           example: __INTERFACE-NAME__
21171         - name: l3-interface-ipv4-address
21172           in: path
21173           description: IP address
21174           required: true
21175           type: string
21176           example: __L3-INTERFACE-IPV4-ADDRESS__
21177         - name: body
21178           in: body
21179           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21180           required: true
21181           schema:
21182             $ref: "#/definitions/l3-interface-ipv4-address-list"
21183     patch:
21184       tags:
21185         - Network
21186       summary: update an existing l3-interface-ipv4-address-list
21187       description: |
21188         Update an existing l3-interface-ipv4-address-list
21189         #
21190         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21191         The PUT operation will entirely replace an existing object.
21192         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21193         #
21194         Other differences between PUT and PATCH are:
21195         #
21196         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21197         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21198         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21199       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21200       consumes:
21201         - application/json
21202         - application/xml
21203       produces:
21204         - application/json
21205         - application/xml
21206       responses:
21207         "default":
21208           description: Response codes found in [response codes](https://wiki.onap.org/).
21209       parameters:
21210         - name: equipment-name
21211           in: path
21212           required: true
21213           type: string
21214           example: __EQUIPMENT-NAME__
21215         - name: interface-name
21216           in: path
21217           description: Name that identifies the physical interface
21218           required: true
21219           type: string
21220           example: __INTERFACE-NAME__
21221         - name: interface-name
21222           in: path
21223           description: Name given to the interface
21224           required: true
21225           type: string
21226           example: __INTERFACE-NAME__
21227         - name: l3-interface-ipv4-address
21228           in: path
21229           description: IP address
21230           required: true
21231           type: string
21232           example: __L3-INTERFACE-IPV4-ADDRESS__
21233         - name: body
21234           in: body
21235           description: l3-interface-ipv4-address-list object that needs to be updated.
21236           required: true
21237           schema:
21238             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
21239     delete:
21240       tags:
21241         - Network
21242       summary: delete an existing l3-interface-ipv4-address-list
21243       description: delete an existing l3-interface-ipv4-address-list
21244       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21245       consumes:
21246         - application/json
21247         - application/xml
21248       produces:
21249         - application/json
21250         - application/xml
21251       responses:
21252         "default":
21253           description: Response codes found in [response codes](https://wiki.onap.org/).
21254       parameters:
21255         - name: equipment-name
21256           in: path
21257           required: true
21258           type: string
21259           example: __EQUIPMENT-NAME__
21260         - name: interface-name
21261           in: path
21262           description: Name that identifies the physical interface
21263           required: true
21264           type: string
21265           example: __INTERFACE-NAME__
21266         - name: interface-name
21267           in: path
21268           description: Name given to the interface
21269           required: true
21270           type: string
21271           example: __INTERFACE-NAME__
21272         - name: l3-interface-ipv4-address
21273           in: path
21274           description: IP address
21275           required: true
21276           type: string
21277           example: __L3-INTERFACE-IPV4-ADDRESS__
21278         - name: resource-version
21279           in: query
21280           description: resource-version for concurrency
21281           required: true
21282           type: string
21283   /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:
21284     put:
21285       tags:
21286         - Network
21287       summary: see node definition for valid relationships
21288       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21289       consumes:
21290         - application/json
21291         - application/xml
21292       produces:
21293         - application/json
21294         - application/xml
21295       responses:
21296         "default":
21297           description: Response codes found in [response codes](https://wiki.onap.org/).
21298       parameters:
21299         - name: equipment-name
21300           in: path
21301           required: true
21302           type: string
21303           example: __EQUIPMENT-NAME__
21304         - name: interface-name
21305           in: path
21306           description: Name that identifies the physical interface
21307           required: true
21308           type: string
21309           example: __INTERFACE-NAME__
21310         - name: interface-name
21311           in: path
21312           description: Name given to the interface
21313           required: true
21314           type: string
21315           example: __INTERFACE-NAME__
21316         - name: l3-interface-ipv6-address
21317           in: path
21318           description: IP address
21319           required: true
21320           type: string
21321           example: __L3-INTERFACE-IPV6-ADDRESS__
21322         - name: body
21323           in: body
21324           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21325           required: true
21326           schema:
21327             $ref: "#/definitions/relationship"
21328     delete:
21329       tags:
21330         - Network
21331       summary: delete an existing relationship
21332       description: delete an existing relationship
21333       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21334       consumes:
21335         - application/json
21336         - application/xml
21337       produces:
21338         - application/json
21339         - application/xml
21340       responses:
21341         "default":
21342           description: Response codes found in [response codes](https://wiki.onap.org/).
21343       parameters:
21344         - name: equipment-name
21345           in: path
21346           required: true
21347           type: string
21348           example: __EQUIPMENT-NAME__
21349         - name: interface-name
21350           in: path
21351           description: Name that identifies the physical interface
21352           required: true
21353           type: string
21354           example: __INTERFACE-NAME__
21355         - name: interface-name
21356           in: path
21357           description: Name given to the interface
21358           required: true
21359           type: string
21360           example: __INTERFACE-NAME__
21361         - name: l3-interface-ipv6-address
21362           in: path
21363           description: IP address
21364           required: true
21365           type: string
21366           example: __L3-INTERFACE-IPV6-ADDRESS__
21367   /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}:
21368     get:
21369       tags:
21370         - Network
21371       summary: returns l3-interface-ipv6-address-list
21372       description: returns l3-interface-ipv6-address-list
21373       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21374       produces:
21375         - application/json
21376         - application/xml
21377       responses:
21378         "200":
21379           description: successful operation
21380           schema:
21381               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21382         "default":
21383           description: Response codes found in [response codes](https://wiki.onap.org/).
21384       parameters:
21385         - name: equipment-name
21386           in: path
21387           required: true
21388           type: string
21389           example: __EQUIPMENT-NAME__
21390         - name: interface-name
21391           in: path
21392           description: Name that identifies the physical interface
21393           required: true
21394           type: string
21395           example: __INTERFACE-NAME__
21396         - name: interface-name
21397           in: path
21398           description: Name given to the interface
21399           required: true
21400           type: string
21401           example: __INTERFACE-NAME__
21402         - name: l3-interface-ipv6-address
21403           in: path
21404           description: IP address
21405           required: true
21406           type: string
21407           example: __L3-INTERFACE-IPV6-ADDRESS__
21408     put:
21409       tags:
21410         - Network
21411       summary: create or update an existing l3-interface-ipv6-address-list
21412       description: |
21413         Create or update an existing l3-interface-ipv6-address-list.
21414         #
21415         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21416       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21417       consumes:
21418         - application/json
21419         - application/xml
21420       produces:
21421         - application/json
21422         - application/xml
21423       responses:
21424         "default":
21425           description: Response codes found in [response codes](https://wiki.onap.org/).
21426       parameters:
21427         - name: equipment-name
21428           in: path
21429           required: true
21430           type: string
21431           example: __EQUIPMENT-NAME__
21432         - name: interface-name
21433           in: path
21434           description: Name that identifies the physical interface
21435           required: true
21436           type: string
21437           example: __INTERFACE-NAME__
21438         - name: interface-name
21439           in: path
21440           description: Name given to the interface
21441           required: true
21442           type: string
21443           example: __INTERFACE-NAME__
21444         - name: l3-interface-ipv6-address
21445           in: path
21446           description: IP address
21447           required: true
21448           type: string
21449           example: __L3-INTERFACE-IPV6-ADDRESS__
21450         - name: body
21451           in: body
21452           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21453           required: true
21454           schema:
21455             $ref: "#/definitions/l3-interface-ipv6-address-list"
21456     patch:
21457       tags:
21458         - Network
21459       summary: update an existing l3-interface-ipv6-address-list
21460       description: |
21461         Update an existing l3-interface-ipv6-address-list
21462         #
21463         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21464         The PUT operation will entirely replace an existing object.
21465         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21466         #
21467         Other differences between PUT and PATCH are:
21468         #
21469         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21470         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21471         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21472       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21473       consumes:
21474         - application/json
21475         - application/xml
21476       produces:
21477         - application/json
21478         - application/xml
21479       responses:
21480         "default":
21481           description: Response codes found in [response codes](https://wiki.onap.org/).
21482       parameters:
21483         - name: equipment-name
21484           in: path
21485           required: true
21486           type: string
21487           example: __EQUIPMENT-NAME__
21488         - name: interface-name
21489           in: path
21490           description: Name that identifies the physical interface
21491           required: true
21492           type: string
21493           example: __INTERFACE-NAME__
21494         - name: interface-name
21495           in: path
21496           description: Name given to the interface
21497           required: true
21498           type: string
21499           example: __INTERFACE-NAME__
21500         - name: l3-interface-ipv6-address
21501           in: path
21502           description: IP address
21503           required: true
21504           type: string
21505           example: __L3-INTERFACE-IPV6-ADDRESS__
21506         - name: body
21507           in: body
21508           description: l3-interface-ipv6-address-list object that needs to be updated.
21509           required: true
21510           schema:
21511             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21512     delete:
21513       tags:
21514         - Network
21515       summary: delete an existing l3-interface-ipv6-address-list
21516       description: delete an existing l3-interface-ipv6-address-list
21517       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21518       consumes:
21519         - application/json
21520         - application/xml
21521       produces:
21522         - application/json
21523         - application/xml
21524       responses:
21525         "default":
21526           description: Response codes found in [response codes](https://wiki.onap.org/).
21527       parameters:
21528         - name: equipment-name
21529           in: path
21530           required: true
21531           type: string
21532           example: __EQUIPMENT-NAME__
21533         - name: interface-name
21534           in: path
21535           description: Name that identifies the physical interface
21536           required: true
21537           type: string
21538           example: __INTERFACE-NAME__
21539         - name: interface-name
21540           in: path
21541           description: Name given to the interface
21542           required: true
21543           type: string
21544           example: __INTERFACE-NAME__
21545         - name: l3-interface-ipv6-address
21546           in: path
21547           description: IP address
21548           required: true
21549           type: string
21550           example: __L3-INTERFACE-IPV6-ADDRESS__
21551         - name: resource-version
21552           in: query
21553           description: resource-version for concurrency
21554           required: true
21555           type: string
21556   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
21557     get:
21558       tags:
21559         - Network
21560       summary: returns l-interface
21561       description: returns l-interface
21562       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21563       produces:
21564         - application/json
21565         - application/xml
21566       responses:
21567         "200":
21568           description: successful operation
21569           schema:
21570               $ref: "#/getDefinitions/l-interface"
21571         "default":
21572           description: Response codes found in [response codes](https://wiki.onap.org/).
21573       parameters:
21574         - name: equipment-name
21575           in: path
21576           required: true
21577           type: string
21578           example: __EQUIPMENT-NAME__
21579         - name: interface-name
21580           in: path
21581           description: Name that identifies the physical interface
21582           required: true
21583           type: string
21584           example: __INTERFACE-NAME__
21585         - name: interface-name
21586           in: path
21587           description: Name given to the interface
21588           required: true
21589           type: string
21590           example: __INTERFACE-NAME__
21591     put:
21592       tags:
21593         - Network
21594       summary: create or update an existing l-interface
21595       description: |
21596         Create or update an existing l-interface.
21597         #
21598         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21599       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21600       consumes:
21601         - application/json
21602         - application/xml
21603       produces:
21604         - application/json
21605         - application/xml
21606       responses:
21607         "default":
21608           description: Response codes found in [response codes](https://wiki.onap.org/).
21609       parameters:
21610         - name: equipment-name
21611           in: path
21612           required: true
21613           type: string
21614           example: __EQUIPMENT-NAME__
21615         - name: interface-name
21616           in: path
21617           description: Name that identifies the physical interface
21618           required: true
21619           type: string
21620           example: __INTERFACE-NAME__
21621         - name: interface-name
21622           in: path
21623           description: Name given to the interface
21624           required: true
21625           type: string
21626           example: __INTERFACE-NAME__
21627         - name: body
21628           in: body
21629           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21630           required: true
21631           schema:
21632             $ref: "#/definitions/l-interface"
21633     patch:
21634       tags:
21635         - Network
21636       summary: update an existing l-interface
21637       description: |
21638         Update an existing l-interface
21639         #
21640         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21641         The PUT operation will entirely replace an existing object.
21642         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21643         #
21644         Other differences between PUT and PATCH are:
21645         #
21646         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21647         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21648         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21649       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21650       consumes:
21651         - application/json
21652         - application/xml
21653       produces:
21654         - application/json
21655         - application/xml
21656       responses:
21657         "default":
21658           description: Response codes found in [response codes](https://wiki.onap.org/).
21659       parameters:
21660         - name: equipment-name
21661           in: path
21662           required: true
21663           type: string
21664           example: __EQUIPMENT-NAME__
21665         - name: interface-name
21666           in: path
21667           description: Name that identifies the physical interface
21668           required: true
21669           type: string
21670           example: __INTERFACE-NAME__
21671         - name: interface-name
21672           in: path
21673           description: Name given to the interface
21674           required: true
21675           type: string
21676           example: __INTERFACE-NAME__
21677         - name: body
21678           in: body
21679           description: l-interface object that needs to be updated.
21680           required: true
21681           schema:
21682             $ref: "#/patchDefinitions/l-interface"
21683     delete:
21684       tags:
21685         - Network
21686       summary: delete an existing l-interface
21687       description: delete an existing l-interface
21688       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21689       consumes:
21690         - application/json
21691         - application/xml
21692       produces:
21693         - application/json
21694         - application/xml
21695       responses:
21696         "default":
21697           description: Response codes found in [response codes](https://wiki.onap.org/).
21698       parameters:
21699         - name: equipment-name
21700           in: path
21701           required: true
21702           type: string
21703           example: __EQUIPMENT-NAME__
21704         - name: interface-name
21705           in: path
21706           description: Name that identifies the physical interface
21707           required: true
21708           type: string
21709           example: __INTERFACE-NAME__
21710         - name: interface-name
21711           in: path
21712           description: Name given to the interface
21713           required: true
21714           type: string
21715           example: __INTERFACE-NAME__
21716         - name: resource-version
21717           in: query
21718           description: resource-version for concurrency
21719           required: true
21720           type: string
21721   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
21722     get:
21723       tags:
21724         - Network
21725       summary: returns l-interfaces
21726       description: returns l-interfaces
21727       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
21728       produces:
21729         - application/json
21730         - application/xml
21731       responses:
21732         "200":
21733           description: successful operation
21734           schema:
21735               $ref: "#/getDefinitions/l-interfaces"
21736         "default":
21737           description: Response codes found in [response codes](https://wiki.onap.org/).
21738       parameters:
21739         - name: equipment-name
21740           in: path
21741           required: true
21742           type: string
21743           example: __EQUIPMENT-NAME__
21744         - name: interface-name
21745           in: path
21746           description: Name that identifies the physical interface
21747           required: true
21748           type: string
21749           example: __INTERFACE-NAME__
21750         - name: interface-name
21751           in: query
21752           description:
21753           required: false
21754           type: string
21755         - name: interface-id
21756           in: query
21757           description:
21758           required: false
21759           type: string
21760         - name: macaddr
21761           in: query
21762           description:
21763           required: false
21764           type: string
21765         - name: network-name
21766           in: query
21767           description:
21768           required: false
21769           type: string
21770   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
21771     get:
21772       tags:
21773         - Network
21774       summary: returns p-interface
21775       description: returns p-interface
21776       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
21777       produces:
21778         - application/json
21779         - application/xml
21780       responses:
21781         "200":
21782           description: successful operation
21783           schema:
21784               $ref: "#/getDefinitions/p-interface"
21785         "default":
21786           description: Response codes found in [response codes](https://wiki.onap.org/).
21787       parameters:
21788         - name: equipment-name
21789           in: path
21790           required: true
21791           type: string
21792           example: __EQUIPMENT-NAME__
21793         - name: interface-name
21794           in: path
21795           description: Name that identifies the physical interface
21796           required: true
21797           type: string
21798           example: __INTERFACE-NAME__
21799     put:
21800       tags:
21801         - Network
21802       summary: create or update an existing p-interface
21803       description: |
21804         Create or update an existing p-interface.
21805         #
21806         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21807       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
21808       consumes:
21809         - application/json
21810         - application/xml
21811       produces:
21812         - application/json
21813         - application/xml
21814       responses:
21815         "default":
21816           description: Response codes found in [response codes](https://wiki.onap.org/).
21817       parameters:
21818         - name: equipment-name
21819           in: path
21820           required: true
21821           type: string
21822           example: __EQUIPMENT-NAME__
21823         - name: interface-name
21824           in: path
21825           description: Name that identifies the physical interface
21826           required: true
21827           type: string
21828           example: __INTERFACE-NAME__
21829         - name: body
21830           in: body
21831           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
21832           required: true
21833           schema:
21834             $ref: "#/definitions/p-interface"
21835     patch:
21836       tags:
21837         - Network
21838       summary: update an existing p-interface
21839       description: |
21840         Update an existing p-interface
21841         #
21842         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21843         The PUT operation will entirely replace an existing object.
21844         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21845         #
21846         Other differences between PUT and PATCH are:
21847         #
21848         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21849         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21850         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21851       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
21852       consumes:
21853         - application/json
21854         - application/xml
21855       produces:
21856         - application/json
21857         - application/xml
21858       responses:
21859         "default":
21860           description: Response codes found in [response codes](https://wiki.onap.org/).
21861       parameters:
21862         - name: equipment-name
21863           in: path
21864           required: true
21865           type: string
21866           example: __EQUIPMENT-NAME__
21867         - name: interface-name
21868           in: path
21869           description: Name that identifies the physical interface
21870           required: true
21871           type: string
21872           example: __INTERFACE-NAME__
21873         - name: body
21874           in: body
21875           description: p-interface object that needs to be updated.
21876           required: true
21877           schema:
21878             $ref: "#/patchDefinitions/p-interface"
21879     delete:
21880       tags:
21881         - Network
21882       summary: delete an existing p-interface
21883       description: delete an existing p-interface
21884       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
21885       consumes:
21886         - application/json
21887         - application/xml
21888       produces:
21889         - application/json
21890         - application/xml
21891       responses:
21892         "default":
21893           description: Response codes found in [response codes](https://wiki.onap.org/).
21894       parameters:
21895         - name: equipment-name
21896           in: path
21897           required: true
21898           type: string
21899           example: __EQUIPMENT-NAME__
21900         - name: interface-name
21901           in: path
21902           description: Name that identifies the physical interface
21903           required: true
21904           type: string
21905           example: __INTERFACE-NAME__
21906         - name: resource-version
21907           in: query
21908           description: resource-version for concurrency
21909           required: true
21910           type: string
21911   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
21912     get:
21913       tags:
21914         - Network
21915       summary: returns p-interfaces
21916       description: returns p-interfaces
21917       operationId: getNetworkVplsPesVplsPePInterfaces
21918       produces:
21919         - application/json
21920         - application/xml
21921       responses:
21922         "200":
21923           description: successful operation
21924           schema:
21925               $ref: "#/getDefinitions/p-interfaces"
21926         "default":
21927           description: Response codes found in [response codes](https://wiki.onap.org/).
21928       parameters:
21929         - name: equipment-name
21930           in: path
21931           required: true
21932           type: string
21933           example: __EQUIPMENT-NAME__
21934         - name: interface-name
21935           in: query
21936           description:
21937           required: false
21938           type: string
21939         - name: prov-status
21940           in: query
21941           description:
21942           required: false
21943           type: string
21944   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
21945     put:
21946       tags:
21947         - Network
21948       summary: see node definition for valid relationships
21949       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21950       consumes:
21951         - application/json
21952         - application/xml
21953       produces:
21954         - application/json
21955         - application/xml
21956       responses:
21957         "default":
21958           description: Response codes found in [response codes](https://wiki.onap.org/).
21959       parameters:
21960         - name: equipment-name
21961           in: path
21962           required: true
21963           type: string
21964           example: __EQUIPMENT-NAME__
21965         - name: interface-name
21966           in: path
21967           description: Name that identifies the link aggregate interface
21968           required: true
21969           type: string
21970           example: __INTERFACE-NAME__
21971         - name: body
21972           in: body
21973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
21974           required: true
21975           schema:
21976             $ref: "#/definitions/relationship"
21977     delete:
21978       tags:
21979         - Network
21980       summary: delete an existing relationship
21981       description: delete an existing relationship
21982       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21983       consumes:
21984         - application/json
21985         - application/xml
21986       produces:
21987         - application/json
21988         - application/xml
21989       responses:
21990         "default":
21991           description: Response codes found in [response codes](https://wiki.onap.org/).
21992       parameters:
21993         - name: equipment-name
21994           in: path
21995           required: true
21996           type: string
21997           example: __EQUIPMENT-NAME__
21998         - name: interface-name
21999           in: path
22000           description: Name that identifies the link aggregate interface
22001           required: true
22002           type: string
22003           example: __INTERFACE-NAME__
22004   /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:
22005     put:
22006       tags:
22007         - Network
22008       summary: see node definition for valid relationships
22009       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22010       consumes:
22011         - application/json
22012         - application/xml
22013       produces:
22014         - application/json
22015         - application/xml
22016       responses:
22017         "default":
22018           description: Response codes found in [response codes](https://wiki.onap.org/).
22019       parameters:
22020         - name: equipment-name
22021           in: path
22022           required: true
22023           type: string
22024           example: __EQUIPMENT-NAME__
22025         - name: interface-name
22026           in: path
22027           description: Name that identifies the link aggregate interface
22028           required: true
22029           type: string
22030           example: __INTERFACE-NAME__
22031         - name: interface-name
22032           in: path
22033           description: Name given to the interface
22034           required: true
22035           type: string
22036           example: __INTERFACE-NAME__
22037         - name: vlan-interface
22038           in: path
22039           description: String that identifies the interface
22040           required: true
22041           type: string
22042           example: __VLAN-INTERFACE__
22043         - name: body
22044           in: body
22045           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22046           required: true
22047           schema:
22048             $ref: "#/definitions/relationship"
22049     delete:
22050       tags:
22051         - Network
22052       summary: delete an existing relationship
22053       description: delete an existing relationship
22054       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22055       consumes:
22056         - application/json
22057         - application/xml
22058       produces:
22059         - application/json
22060         - application/xml
22061       responses:
22062         "default":
22063           description: Response codes found in [response codes](https://wiki.onap.org/).
22064       parameters:
22065         - name: equipment-name
22066           in: path
22067           required: true
22068           type: string
22069           example: __EQUIPMENT-NAME__
22070         - name: interface-name
22071           in: path
22072           description: Name that identifies the link aggregate interface
22073           required: true
22074           type: string
22075           example: __INTERFACE-NAME__
22076         - name: interface-name
22077           in: path
22078           description: Name given to the interface
22079           required: true
22080           type: string
22081           example: __INTERFACE-NAME__
22082         - name: vlan-interface
22083           in: path
22084           description: String that identifies the interface
22085           required: true
22086           type: string
22087           example: __VLAN-INTERFACE__
22088   /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:
22089     put:
22090       tags:
22091         - Network
22092       summary: see node definition for valid relationships
22093       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22094       consumes:
22095         - application/json
22096         - application/xml
22097       produces:
22098         - application/json
22099         - application/xml
22100       responses:
22101         "default":
22102           description: Response codes found in [response codes](https://wiki.onap.org/).
22103       parameters:
22104         - name: equipment-name
22105           in: path
22106           required: true
22107           type: string
22108           example: __EQUIPMENT-NAME__
22109         - name: interface-name
22110           in: path
22111           description: Name that identifies the link aggregate interface
22112           required: true
22113           type: string
22114           example: __INTERFACE-NAME__
22115         - name: interface-name
22116           in: path
22117           description: Name given to the interface
22118           required: true
22119           type: string
22120           example: __INTERFACE-NAME__
22121         - name: vlan-interface
22122           in: path
22123           description: String that identifies the interface
22124           required: true
22125           type: string
22126           example: __VLAN-INTERFACE__
22127         - name: l3-interface-ipv4-address
22128           in: path
22129           description: IP address
22130           required: true
22131           type: string
22132           example: __L3-INTERFACE-IPV4-ADDRESS__
22133         - name: body
22134           in: body
22135           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22136           required: true
22137           schema:
22138             $ref: "#/definitions/relationship"
22139     delete:
22140       tags:
22141         - Network
22142       summary: delete an existing relationship
22143       description: delete an existing relationship
22144       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22145       consumes:
22146         - application/json
22147         - application/xml
22148       produces:
22149         - application/json
22150         - application/xml
22151       responses:
22152         "default":
22153           description: Response codes found in [response codes](https://wiki.onap.org/).
22154       parameters:
22155         - name: equipment-name
22156           in: path
22157           required: true
22158           type: string
22159           example: __EQUIPMENT-NAME__
22160         - name: interface-name
22161           in: path
22162           description: Name that identifies the link aggregate interface
22163           required: true
22164           type: string
22165           example: __INTERFACE-NAME__
22166         - name: interface-name
22167           in: path
22168           description: Name given to the interface
22169           required: true
22170           type: string
22171           example: __INTERFACE-NAME__
22172         - name: vlan-interface
22173           in: path
22174           description: String that identifies the interface
22175           required: true
22176           type: string
22177           example: __VLAN-INTERFACE__
22178         - name: l3-interface-ipv4-address
22179           in: path
22180           description: IP address
22181           required: true
22182           type: string
22183           example: __L3-INTERFACE-IPV4-ADDRESS__
22184   /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}:
22185     get:
22186       tags:
22187         - Network
22188       summary: returns l3-interface-ipv4-address-list
22189       description: returns l3-interface-ipv4-address-list
22190       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22191       produces:
22192         - application/json
22193         - application/xml
22194       responses:
22195         "200":
22196           description: successful operation
22197           schema:
22198               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22199         "default":
22200           description: Response codes found in [response codes](https://wiki.onap.org/).
22201       parameters:
22202         - name: equipment-name
22203           in: path
22204           required: true
22205           type: string
22206           example: __EQUIPMENT-NAME__
22207         - name: interface-name
22208           in: path
22209           description: Name that identifies the link aggregate interface
22210           required: true
22211           type: string
22212           example: __INTERFACE-NAME__
22213         - name: interface-name
22214           in: path
22215           description: Name given to the interface
22216           required: true
22217           type: string
22218           example: __INTERFACE-NAME__
22219         - name: vlan-interface
22220           in: path
22221           description: String that identifies the interface
22222           required: true
22223           type: string
22224           example: __VLAN-INTERFACE__
22225         - name: l3-interface-ipv4-address
22226           in: path
22227           description: IP address
22228           required: true
22229           type: string
22230           example: __L3-INTERFACE-IPV4-ADDRESS__
22231     put:
22232       tags:
22233         - Network
22234       summary: create or update an existing l3-interface-ipv4-address-list
22235       description: |
22236         Create or update an existing l3-interface-ipv4-address-list.
22237         #
22238         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22239       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22240       consumes:
22241         - application/json
22242         - application/xml
22243       produces:
22244         - application/json
22245         - application/xml
22246       responses:
22247         "default":
22248           description: Response codes found in [response codes](https://wiki.onap.org/).
22249       parameters:
22250         - name: equipment-name
22251           in: path
22252           required: true
22253           type: string
22254           example: __EQUIPMENT-NAME__
22255         - name: interface-name
22256           in: path
22257           description: Name that identifies the link aggregate interface
22258           required: true
22259           type: string
22260           example: __INTERFACE-NAME__
22261         - name: interface-name
22262           in: path
22263           description: Name given to the interface
22264           required: true
22265           type: string
22266           example: __INTERFACE-NAME__
22267         - name: vlan-interface
22268           in: path
22269           description: String that identifies the interface
22270           required: true
22271           type: string
22272           example: __VLAN-INTERFACE__
22273         - name: l3-interface-ipv4-address
22274           in: path
22275           description: IP address
22276           required: true
22277           type: string
22278           example: __L3-INTERFACE-IPV4-ADDRESS__
22279         - name: body
22280           in: body
22281           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22282           required: true
22283           schema:
22284             $ref: "#/definitions/l3-interface-ipv4-address-list"
22285     patch:
22286       tags:
22287         - Network
22288       summary: update an existing l3-interface-ipv4-address-list
22289       description: |
22290         Update an existing l3-interface-ipv4-address-list
22291         #
22292         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22293         The PUT operation will entirely replace an existing object.
22294         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22295         #
22296         Other differences between PUT and PATCH are:
22297         #
22298         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22299         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22300         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22301       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22302       consumes:
22303         - application/json
22304         - application/xml
22305       produces:
22306         - application/json
22307         - application/xml
22308       responses:
22309         "default":
22310           description: Response codes found in [response codes](https://wiki.onap.org/).
22311       parameters:
22312         - name: equipment-name
22313           in: path
22314           required: true
22315           type: string
22316           example: __EQUIPMENT-NAME__
22317         - name: interface-name
22318           in: path
22319           description: Name that identifies the link aggregate interface
22320           required: true
22321           type: string
22322           example: __INTERFACE-NAME__
22323         - name: interface-name
22324           in: path
22325           description: Name given to the interface
22326           required: true
22327           type: string
22328           example: __INTERFACE-NAME__
22329         - name: vlan-interface
22330           in: path
22331           description: String that identifies the interface
22332           required: true
22333           type: string
22334           example: __VLAN-INTERFACE__
22335         - name: l3-interface-ipv4-address
22336           in: path
22337           description: IP address
22338           required: true
22339           type: string
22340           example: __L3-INTERFACE-IPV4-ADDRESS__
22341         - name: body
22342           in: body
22343           description: l3-interface-ipv4-address-list object that needs to be updated.
22344           required: true
22345           schema:
22346             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22347     delete:
22348       tags:
22349         - Network
22350       summary: delete an existing l3-interface-ipv4-address-list
22351       description: delete an existing l3-interface-ipv4-address-list
22352       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22353       consumes:
22354         - application/json
22355         - application/xml
22356       produces:
22357         - application/json
22358         - application/xml
22359       responses:
22360         "default":
22361           description: Response codes found in [response codes](https://wiki.onap.org/).
22362       parameters:
22363         - name: equipment-name
22364           in: path
22365           required: true
22366           type: string
22367           example: __EQUIPMENT-NAME__
22368         - name: interface-name
22369           in: path
22370           description: Name that identifies the link aggregate interface
22371           required: true
22372           type: string
22373           example: __INTERFACE-NAME__
22374         - name: interface-name
22375           in: path
22376           description: Name given to the interface
22377           required: true
22378           type: string
22379           example: __INTERFACE-NAME__
22380         - name: vlan-interface
22381           in: path
22382           description: String that identifies the interface
22383           required: true
22384           type: string
22385           example: __VLAN-INTERFACE__
22386         - name: l3-interface-ipv4-address
22387           in: path
22388           description: IP address
22389           required: true
22390           type: string
22391           example: __L3-INTERFACE-IPV4-ADDRESS__
22392         - name: resource-version
22393           in: query
22394           description: resource-version for concurrency
22395           required: true
22396           type: string
22397   /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:
22398     put:
22399       tags:
22400         - Network
22401       summary: see node definition for valid relationships
22402       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22403       consumes:
22404         - application/json
22405         - application/xml
22406       produces:
22407         - application/json
22408         - application/xml
22409       responses:
22410         "default":
22411           description: Response codes found in [response codes](https://wiki.onap.org/).
22412       parameters:
22413         - name: equipment-name
22414           in: path
22415           required: true
22416           type: string
22417           example: __EQUIPMENT-NAME__
22418         - name: interface-name
22419           in: path
22420           description: Name that identifies the link aggregate interface
22421           required: true
22422           type: string
22423           example: __INTERFACE-NAME__
22424         - name: interface-name
22425           in: path
22426           description: Name given to the interface
22427           required: true
22428           type: string
22429           example: __INTERFACE-NAME__
22430         - name: vlan-interface
22431           in: path
22432           description: String that identifies the interface
22433           required: true
22434           type: string
22435           example: __VLAN-INTERFACE__
22436         - name: l3-interface-ipv6-address
22437           in: path
22438           description: IP address
22439           required: true
22440           type: string
22441           example: __L3-INTERFACE-IPV6-ADDRESS__
22442         - name: body
22443           in: body
22444           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22445           required: true
22446           schema:
22447             $ref: "#/definitions/relationship"
22448     delete:
22449       tags:
22450         - Network
22451       summary: delete an existing relationship
22452       description: delete an existing relationship
22453       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22454       consumes:
22455         - application/json
22456         - application/xml
22457       produces:
22458         - application/json
22459         - application/xml
22460       responses:
22461         "default":
22462           description: Response codes found in [response codes](https://wiki.onap.org/).
22463       parameters:
22464         - name: equipment-name
22465           in: path
22466           required: true
22467           type: string
22468           example: __EQUIPMENT-NAME__
22469         - name: interface-name
22470           in: path
22471           description: Name that identifies the link aggregate interface
22472           required: true
22473           type: string
22474           example: __INTERFACE-NAME__
22475         - name: interface-name
22476           in: path
22477           description: Name given to the interface
22478           required: true
22479           type: string
22480           example: __INTERFACE-NAME__
22481         - name: vlan-interface
22482           in: path
22483           description: String that identifies the interface
22484           required: true
22485           type: string
22486           example: __VLAN-INTERFACE__
22487         - name: l3-interface-ipv6-address
22488           in: path
22489           description: IP address
22490           required: true
22491           type: string
22492           example: __L3-INTERFACE-IPV6-ADDRESS__
22493   /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}:
22494     get:
22495       tags:
22496         - Network
22497       summary: returns l3-interface-ipv6-address-list
22498       description: returns l3-interface-ipv6-address-list
22499       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22500       produces:
22501         - application/json
22502         - application/xml
22503       responses:
22504         "200":
22505           description: successful operation
22506           schema:
22507               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22508         "default":
22509           description: Response codes found in [response codes](https://wiki.onap.org/).
22510       parameters:
22511         - name: equipment-name
22512           in: path
22513           required: true
22514           type: string
22515           example: __EQUIPMENT-NAME__
22516         - name: interface-name
22517           in: path
22518           description: Name that identifies the link aggregate interface
22519           required: true
22520           type: string
22521           example: __INTERFACE-NAME__
22522         - name: interface-name
22523           in: path
22524           description: Name given to the interface
22525           required: true
22526           type: string
22527           example: __INTERFACE-NAME__
22528         - name: vlan-interface
22529           in: path
22530           description: String that identifies the interface
22531           required: true
22532           type: string
22533           example: __VLAN-INTERFACE__
22534         - name: l3-interface-ipv6-address
22535           in: path
22536           description: IP address
22537           required: true
22538           type: string
22539           example: __L3-INTERFACE-IPV6-ADDRESS__
22540     put:
22541       tags:
22542         - Network
22543       summary: create or update an existing l3-interface-ipv6-address-list
22544       description: |
22545         Create or update an existing l3-interface-ipv6-address-list.
22546         #
22547         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22548       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22549       consumes:
22550         - application/json
22551         - application/xml
22552       produces:
22553         - application/json
22554         - application/xml
22555       responses:
22556         "default":
22557           description: Response codes found in [response codes](https://wiki.onap.org/).
22558       parameters:
22559         - name: equipment-name
22560           in: path
22561           required: true
22562           type: string
22563           example: __EQUIPMENT-NAME__
22564         - name: interface-name
22565           in: path
22566           description: Name that identifies the link aggregate interface
22567           required: true
22568           type: string
22569           example: __INTERFACE-NAME__
22570         - name: interface-name
22571           in: path
22572           description: Name given to the interface
22573           required: true
22574           type: string
22575           example: __INTERFACE-NAME__
22576         - name: vlan-interface
22577           in: path
22578           description: String that identifies the interface
22579           required: true
22580           type: string
22581           example: __VLAN-INTERFACE__
22582         - name: l3-interface-ipv6-address
22583           in: path
22584           description: IP address
22585           required: true
22586           type: string
22587           example: __L3-INTERFACE-IPV6-ADDRESS__
22588         - name: body
22589           in: body
22590           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22591           required: true
22592           schema:
22593             $ref: "#/definitions/l3-interface-ipv6-address-list"
22594     patch:
22595       tags:
22596         - Network
22597       summary: update an existing l3-interface-ipv6-address-list
22598       description: |
22599         Update an existing l3-interface-ipv6-address-list
22600         #
22601         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22602         The PUT operation will entirely replace an existing object.
22603         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22604         #
22605         Other differences between PUT and PATCH are:
22606         #
22607         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22608         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22609         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22610       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22611       consumes:
22612         - application/json
22613         - application/xml
22614       produces:
22615         - application/json
22616         - application/xml
22617       responses:
22618         "default":
22619           description: Response codes found in [response codes](https://wiki.onap.org/).
22620       parameters:
22621         - name: equipment-name
22622           in: path
22623           required: true
22624           type: string
22625           example: __EQUIPMENT-NAME__
22626         - name: interface-name
22627           in: path
22628           description: Name that identifies the link aggregate interface
22629           required: true
22630           type: string
22631           example: __INTERFACE-NAME__
22632         - name: interface-name
22633           in: path
22634           description: Name given to the interface
22635           required: true
22636           type: string
22637           example: __INTERFACE-NAME__
22638         - name: vlan-interface
22639           in: path
22640           description: String that identifies the interface
22641           required: true
22642           type: string
22643           example: __VLAN-INTERFACE__
22644         - name: l3-interface-ipv6-address
22645           in: path
22646           description: IP address
22647           required: true
22648           type: string
22649           example: __L3-INTERFACE-IPV6-ADDRESS__
22650         - name: body
22651           in: body
22652           description: l3-interface-ipv6-address-list object that needs to be updated.
22653           required: true
22654           schema:
22655             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22656     delete:
22657       tags:
22658         - Network
22659       summary: delete an existing l3-interface-ipv6-address-list
22660       description: delete an existing l3-interface-ipv6-address-list
22661       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22662       consumes:
22663         - application/json
22664         - application/xml
22665       produces:
22666         - application/json
22667         - application/xml
22668       responses:
22669         "default":
22670           description: Response codes found in [response codes](https://wiki.onap.org/).
22671       parameters:
22672         - name: equipment-name
22673           in: path
22674           required: true
22675           type: string
22676           example: __EQUIPMENT-NAME__
22677         - name: interface-name
22678           in: path
22679           description: Name that identifies the link aggregate interface
22680           required: true
22681           type: string
22682           example: __INTERFACE-NAME__
22683         - name: interface-name
22684           in: path
22685           description: Name given to the interface
22686           required: true
22687           type: string
22688           example: __INTERFACE-NAME__
22689         - name: vlan-interface
22690           in: path
22691           description: String that identifies the interface
22692           required: true
22693           type: string
22694           example: __VLAN-INTERFACE__
22695         - name: l3-interface-ipv6-address
22696           in: path
22697           description: IP address
22698           required: true
22699           type: string
22700           example: __L3-INTERFACE-IPV6-ADDRESS__
22701         - name: resource-version
22702           in: query
22703           description: resource-version for concurrency
22704           required: true
22705           type: string
22706   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22707     get:
22708       tags:
22709         - Network
22710       summary: returns vlan
22711       description: returns vlan
22712       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22713       produces:
22714         - application/json
22715         - application/xml
22716       responses:
22717         "200":
22718           description: successful operation
22719           schema:
22720               $ref: "#/getDefinitions/vlan"
22721         "default":
22722           description: Response codes found in [response codes](https://wiki.onap.org/).
22723       parameters:
22724         - name: equipment-name
22725           in: path
22726           required: true
22727           type: string
22728           example: __EQUIPMENT-NAME__
22729         - name: interface-name
22730           in: path
22731           description: Name that identifies the link aggregate interface
22732           required: true
22733           type: string
22734           example: __INTERFACE-NAME__
22735         - name: interface-name
22736           in: path
22737           description: Name given to the interface
22738           required: true
22739           type: string
22740           example: __INTERFACE-NAME__
22741         - name: vlan-interface
22742           in: path
22743           description: String that identifies the interface
22744           required: true
22745           type: string
22746           example: __VLAN-INTERFACE__
22747     put:
22748       tags:
22749         - Network
22750       summary: create or update an existing vlan
22751       description: |
22752         Create or update an existing vlan.
22753         #
22754         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22755       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22756       consumes:
22757         - application/json
22758         - application/xml
22759       produces:
22760         - application/json
22761         - application/xml
22762       responses:
22763         "default":
22764           description: Response codes found in [response codes](https://wiki.onap.org/).
22765       parameters:
22766         - name: equipment-name
22767           in: path
22768           required: true
22769           type: string
22770           example: __EQUIPMENT-NAME__
22771         - name: interface-name
22772           in: path
22773           description: Name that identifies the link aggregate interface
22774           required: true
22775           type: string
22776           example: __INTERFACE-NAME__
22777         - name: interface-name
22778           in: path
22779           description: Name given to the interface
22780           required: true
22781           type: string
22782           example: __INTERFACE-NAME__
22783         - name: vlan-interface
22784           in: path
22785           description: String that identifies the interface
22786           required: true
22787           type: string
22788           example: __VLAN-INTERFACE__
22789         - name: body
22790           in: body
22791           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22792           required: true
22793           schema:
22794             $ref: "#/definitions/vlan"
22795     patch:
22796       tags:
22797         - Network
22798       summary: update an existing vlan
22799       description: |
22800         Update an existing vlan
22801         #
22802         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22803         The PUT operation will entirely replace an existing object.
22804         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22805         #
22806         Other differences between PUT and PATCH are:
22807         #
22808         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22809         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22810         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22811       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22812       consumes:
22813         - application/json
22814         - application/xml
22815       produces:
22816         - application/json
22817         - application/xml
22818       responses:
22819         "default":
22820           description: Response codes found in [response codes](https://wiki.onap.org/).
22821       parameters:
22822         - name: equipment-name
22823           in: path
22824           required: true
22825           type: string
22826           example: __EQUIPMENT-NAME__
22827         - name: interface-name
22828           in: path
22829           description: Name that identifies the link aggregate interface
22830           required: true
22831           type: string
22832           example: __INTERFACE-NAME__
22833         - name: interface-name
22834           in: path
22835           description: Name given to the interface
22836           required: true
22837           type: string
22838           example: __INTERFACE-NAME__
22839         - name: vlan-interface
22840           in: path
22841           description: String that identifies the interface
22842           required: true
22843           type: string
22844           example: __VLAN-INTERFACE__
22845         - name: body
22846           in: body
22847           description: vlan object that needs to be updated.
22848           required: true
22849           schema:
22850             $ref: "#/patchDefinitions/vlan"
22851     delete:
22852       tags:
22853         - Network
22854       summary: delete an existing vlan
22855       description: delete an existing vlan
22856       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22857       consumes:
22858         - application/json
22859         - application/xml
22860       produces:
22861         - application/json
22862         - application/xml
22863       responses:
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         - name: interface-name
22873           in: path
22874           description: Name that identifies the link aggregate interface
22875           required: true
22876           type: string
22877           example: __INTERFACE-NAME__
22878         - name: interface-name
22879           in: path
22880           description: Name given to the interface
22881           required: true
22882           type: string
22883           example: __INTERFACE-NAME__
22884         - name: vlan-interface
22885           in: path
22886           description: String that identifies the interface
22887           required: true
22888           type: string
22889           example: __VLAN-INTERFACE__
22890         - name: resource-version
22891           in: query
22892           description: resource-version for concurrency
22893           required: true
22894           type: string
22895   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22896     get:
22897       tags:
22898         - Network
22899       summary: returns vlans
22900       description: returns vlans
22901       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
22902       produces:
22903         - application/json
22904         - application/xml
22905       responses:
22906         "200":
22907           description: successful operation
22908           schema:
22909               $ref: "#/getDefinitions/vlans"
22910         "default":
22911           description: Response codes found in [response codes](https://wiki.onap.org/).
22912       parameters:
22913         - name: equipment-name
22914           in: path
22915           required: true
22916           type: string
22917           example: __EQUIPMENT-NAME__
22918         - name: interface-name
22919           in: path
22920           description: Name that identifies the link aggregate interface
22921           required: true
22922           type: string
22923           example: __INTERFACE-NAME__
22924         - name: interface-name
22925           in: path
22926           description: Name given to the interface
22927           required: true
22928           type: string
22929           example: __INTERFACE-NAME__
22930         - name: vlan-interface
22931           in: query
22932           description:
22933           required: false
22934           type: string
22935         - name: vlan-id-inner
22936           in: query
22937           description:
22938           required: false
22939           type: integer
22940           format: int64
22941         - name: vpn-id
22942           in: query
22943           description:
22944           required: false
22945           type: string
22946   /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:
22947     put:
22948       tags:
22949         - Network
22950       summary: see node definition for valid relationships
22951       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22952       consumes:
22953         - application/json
22954         - application/xml
22955       produces:
22956         - application/json
22957         - application/xml
22958       responses:
22959         "default":
22960           description: Response codes found in [response codes](https://wiki.onap.org/).
22961       parameters:
22962         - name: equipment-name
22963           in: path
22964           required: true
22965           type: string
22966           example: __EQUIPMENT-NAME__
22967         - name: interface-name
22968           in: path
22969           description: Name that identifies the link aggregate interface
22970           required: true
22971           type: string
22972           example: __INTERFACE-NAME__
22973         - name: interface-name
22974           in: path
22975           description: Name given to the interface
22976           required: true
22977           type: string
22978           example: __INTERFACE-NAME__
22979         - name: pci-id
22980           in: path
22981           description: PCI ID used to identify the sriov-vf
22982           required: true
22983           type: string
22984           example: __PCI-ID__
22985         - name: body
22986           in: body
22987           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22988           required: true
22989           schema:
22990             $ref: "#/definitions/relationship"
22991     delete:
22992       tags:
22993         - Network
22994       summary: delete an existing relationship
22995       description: delete an existing relationship
22996       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22997       consumes:
22998         - application/json
22999         - application/xml
23000       produces:
23001         - application/json
23002         - application/xml
23003       responses:
23004         "default":
23005           description: Response codes found in [response codes](https://wiki.onap.org/).
23006       parameters:
23007         - name: equipment-name
23008           in: path
23009           required: true
23010           type: string
23011           example: __EQUIPMENT-NAME__
23012         - name: interface-name
23013           in: path
23014           description: Name that identifies the link aggregate interface
23015           required: true
23016           type: string
23017           example: __INTERFACE-NAME__
23018         - name: interface-name
23019           in: path
23020           description: Name given to the interface
23021           required: true
23022           type: string
23023           example: __INTERFACE-NAME__
23024         - name: pci-id
23025           in: path
23026           description: PCI ID used to identify the sriov-vf
23027           required: true
23028           type: string
23029           example: __PCI-ID__
23030   /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}:
23031     get:
23032       tags:
23033         - Network
23034       summary: returns sriov-vf
23035       description: returns sriov-vf
23036       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23037       produces:
23038         - application/json
23039         - application/xml
23040       responses:
23041         "200":
23042           description: successful operation
23043           schema:
23044               $ref: "#/getDefinitions/sriov-vf"
23045         "default":
23046           description: Response codes found in [response codes](https://wiki.onap.org/).
23047       parameters:
23048         - name: equipment-name
23049           in: path
23050           required: true
23051           type: string
23052           example: __EQUIPMENT-NAME__
23053         - name: interface-name
23054           in: path
23055           description: Name that identifies the link aggregate interface
23056           required: true
23057           type: string
23058           example: __INTERFACE-NAME__
23059         - name: interface-name
23060           in: path
23061           description: Name given to the interface
23062           required: true
23063           type: string
23064           example: __INTERFACE-NAME__
23065         - name: pci-id
23066           in: path
23067           description: PCI ID used to identify the sriov-vf
23068           required: true
23069           type: string
23070           example: __PCI-ID__
23071     put:
23072       tags:
23073         - Network
23074       summary: create or update an existing sriov-vf
23075       description: |
23076         Create or update an existing sriov-vf.
23077         #
23078         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23079       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23080       consumes:
23081         - application/json
23082         - application/xml
23083       produces:
23084         - application/json
23085         - application/xml
23086       responses:
23087         "default":
23088           description: Response codes found in [response codes](https://wiki.onap.org/).
23089       parameters:
23090         - name: equipment-name
23091           in: path
23092           required: true
23093           type: string
23094           example: __EQUIPMENT-NAME__
23095         - name: interface-name
23096           in: path
23097           description: Name that identifies the link aggregate interface
23098           required: true
23099           type: string
23100           example: __INTERFACE-NAME__
23101         - name: interface-name
23102           in: path
23103           description: Name given to the interface
23104           required: true
23105           type: string
23106           example: __INTERFACE-NAME__
23107         - name: pci-id
23108           in: path
23109           description: PCI ID used to identify the sriov-vf
23110           required: true
23111           type: string
23112           example: __PCI-ID__
23113         - name: body
23114           in: body
23115           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23116           required: true
23117           schema:
23118             $ref: "#/definitions/sriov-vf"
23119     patch:
23120       tags:
23121         - Network
23122       summary: update an existing sriov-vf
23123       description: |
23124         Update an existing sriov-vf
23125         #
23126         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23127         The PUT operation will entirely replace an existing object.
23128         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23129         #
23130         Other differences between PUT and PATCH are:
23131         #
23132         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23133         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23134         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23135       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23136       consumes:
23137         - application/json
23138         - application/xml
23139       produces:
23140         - application/json
23141         - application/xml
23142       responses:
23143         "default":
23144           description: Response codes found in [response codes](https://wiki.onap.org/).
23145       parameters:
23146         - name: equipment-name
23147           in: path
23148           required: true
23149           type: string
23150           example: __EQUIPMENT-NAME__
23151         - name: interface-name
23152           in: path
23153           description: Name that identifies the link aggregate interface
23154           required: true
23155           type: string
23156           example: __INTERFACE-NAME__
23157         - name: interface-name
23158           in: path
23159           description: Name given to the interface
23160           required: true
23161           type: string
23162           example: __INTERFACE-NAME__
23163         - name: pci-id
23164           in: path
23165           description: PCI ID used to identify the sriov-vf
23166           required: true
23167           type: string
23168           example: __PCI-ID__
23169         - name: body
23170           in: body
23171           description: sriov-vf object that needs to be updated.
23172           required: true
23173           schema:
23174             $ref: "#/patchDefinitions/sriov-vf"
23175     delete:
23176       tags:
23177         - Network
23178       summary: delete an existing sriov-vf
23179       description: delete an existing sriov-vf
23180       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23181       consumes:
23182         - application/json
23183         - application/xml
23184       produces:
23185         - application/json
23186         - application/xml
23187       responses:
23188         "default":
23189           description: Response codes found in [response codes](https://wiki.onap.org/).
23190       parameters:
23191         - name: equipment-name
23192           in: path
23193           required: true
23194           type: string
23195           example: __EQUIPMENT-NAME__
23196         - name: interface-name
23197           in: path
23198           description: Name that identifies the link aggregate interface
23199           required: true
23200           type: string
23201           example: __INTERFACE-NAME__
23202         - name: interface-name
23203           in: path
23204           description: Name given to the interface
23205           required: true
23206           type: string
23207           example: __INTERFACE-NAME__
23208         - name: pci-id
23209           in: path
23210           description: PCI ID used to identify the sriov-vf
23211           required: true
23212           type: string
23213           example: __PCI-ID__
23214         - name: resource-version
23215           in: query
23216           description: resource-version for concurrency
23217           required: true
23218           type: string
23219   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23220     get:
23221       tags:
23222         - Network
23223       summary: returns sriov-vfs
23224       description: returns sriov-vfs
23225       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
23226       produces:
23227         - application/json
23228         - application/xml
23229       responses:
23230         "200":
23231           description: successful operation
23232           schema:
23233               $ref: "#/getDefinitions/sriov-vfs"
23234         "default":
23235           description: Response codes found in [response codes](https://wiki.onap.org/).
23236       parameters:
23237         - name: equipment-name
23238           in: path
23239           required: true
23240           type: string
23241           example: __EQUIPMENT-NAME__
23242         - name: interface-name
23243           in: path
23244           description: Name that identifies the link aggregate interface
23245           required: true
23246           type: string
23247           example: __INTERFACE-NAME__
23248         - name: interface-name
23249           in: path
23250           description: Name given to the interface
23251           required: true
23252           type: string
23253           example: __INTERFACE-NAME__
23254         - name: pci-id
23255           in: query
23256           description:
23257           required: false
23258           type: string
23259         - name: vf-vlan-filter
23260           in: query
23261           description:
23262           required: false
23263           type: string
23264         - name: vf-mac-filter
23265           in: query
23266           description:
23267           required: false
23268           type: string
23269         - name: vf-vlan-strip
23270           in: query
23271           description:
23272           required: false
23273           type: boolean
23274         - name: neutron-network-id
23275           in: query
23276           description:
23277           required: false
23278           type: string
23279   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23280     put:
23281       tags:
23282         - Network
23283       summary: see node definition for valid relationships
23284       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23285       consumes:
23286         - application/json
23287         - application/xml
23288       produces:
23289         - application/json
23290         - application/xml
23291       responses:
23292         "default":
23293           description: Response codes found in [response codes](https://wiki.onap.org/).
23294       parameters:
23295         - name: equipment-name
23296           in: path
23297           required: true
23298           type: string
23299           example: __EQUIPMENT-NAME__
23300         - name: interface-name
23301           in: path
23302           description: Name that identifies the link aggregate interface
23303           required: true
23304           type: string
23305           example: __INTERFACE-NAME__
23306         - name: interface-name
23307           in: path
23308           description: Name given to the interface
23309           required: true
23310           type: string
23311           example: __INTERFACE-NAME__
23312         - name: body
23313           in: body
23314           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23315           required: true
23316           schema:
23317             $ref: "#/definitions/relationship"
23318     delete:
23319       tags:
23320         - Network
23321       summary: delete an existing relationship
23322       description: delete an existing relationship
23323       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23324       consumes:
23325         - application/json
23326         - application/xml
23327       produces:
23328         - application/json
23329         - application/xml
23330       responses:
23331         "default":
23332           description: Response codes found in [response codes](https://wiki.onap.org/).
23333       parameters:
23334         - name: equipment-name
23335           in: path
23336           required: true
23337           type: string
23338           example: __EQUIPMENT-NAME__
23339         - name: interface-name
23340           in: path
23341           description: Name that identifies the link aggregate interface
23342           required: true
23343           type: string
23344           example: __INTERFACE-NAME__
23345         - name: interface-name
23346           in: path
23347           description: Name given to the interface
23348           required: true
23349           type: string
23350           example: __INTERFACE-NAME__
23351   /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:
23352     put:
23353       tags:
23354         - Network
23355       summary: see node definition for valid relationships
23356       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23357       consumes:
23358         - application/json
23359         - application/xml
23360       produces:
23361         - application/json
23362         - application/xml
23363       responses:
23364         "default":
23365           description: Response codes found in [response codes](https://wiki.onap.org/).
23366       parameters:
23367         - name: equipment-name
23368           in: path
23369           required: true
23370           type: string
23371           example: __EQUIPMENT-NAME__
23372         - name: interface-name
23373           in: path
23374           description: Name that identifies the link aggregate interface
23375           required: true
23376           type: string
23377           example: __INTERFACE-NAME__
23378         - name: interface-name
23379           in: path
23380           description: Name given to the interface
23381           required: true
23382           type: string
23383           example: __INTERFACE-NAME__
23384         - name: l3-interface-ipv4-address
23385           in: path
23386           description: IP address
23387           required: true
23388           type: string
23389           example: __L3-INTERFACE-IPV4-ADDRESS__
23390         - name: body
23391           in: body
23392           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23393           required: true
23394           schema:
23395             $ref: "#/definitions/relationship"
23396     delete:
23397       tags:
23398         - Network
23399       summary: delete an existing relationship
23400       description: delete an existing relationship
23401       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23402       consumes:
23403         - application/json
23404         - application/xml
23405       produces:
23406         - application/json
23407         - application/xml
23408       responses:
23409         "default":
23410           description: Response codes found in [response codes](https://wiki.onap.org/).
23411       parameters:
23412         - name: equipment-name
23413           in: path
23414           required: true
23415           type: string
23416           example: __EQUIPMENT-NAME__
23417         - name: interface-name
23418           in: path
23419           description: Name that identifies the link aggregate interface
23420           required: true
23421           type: string
23422           example: __INTERFACE-NAME__
23423         - name: interface-name
23424           in: path
23425           description: Name given to the interface
23426           required: true
23427           type: string
23428           example: __INTERFACE-NAME__
23429         - name: l3-interface-ipv4-address
23430           in: path
23431           description: IP address
23432           required: true
23433           type: string
23434           example: __L3-INTERFACE-IPV4-ADDRESS__
23435   /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}:
23436     get:
23437       tags:
23438         - Network
23439       summary: returns l3-interface-ipv4-address-list
23440       description: returns l3-interface-ipv4-address-list
23441       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23442       produces:
23443         - application/json
23444         - application/xml
23445       responses:
23446         "200":
23447           description: successful operation
23448           schema:
23449               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23450         "default":
23451           description: Response codes found in [response codes](https://wiki.onap.org/).
23452       parameters:
23453         - name: equipment-name
23454           in: path
23455           required: true
23456           type: string
23457           example: __EQUIPMENT-NAME__
23458         - name: interface-name
23459           in: path
23460           description: Name that identifies the link aggregate interface
23461           required: true
23462           type: string
23463           example: __INTERFACE-NAME__
23464         - name: interface-name
23465           in: path
23466           description: Name given to the interface
23467           required: true
23468           type: string
23469           example: __INTERFACE-NAME__
23470         - name: l3-interface-ipv4-address
23471           in: path
23472           description: IP address
23473           required: true
23474           type: string
23475           example: __L3-INTERFACE-IPV4-ADDRESS__
23476     put:
23477       tags:
23478         - Network
23479       summary: create or update an existing l3-interface-ipv4-address-list
23480       description: |
23481         Create or update an existing l3-interface-ipv4-address-list.
23482         #
23483         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23484       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23485       consumes:
23486         - application/json
23487         - application/xml
23488       produces:
23489         - application/json
23490         - application/xml
23491       responses:
23492         "default":
23493           description: Response codes found in [response codes](https://wiki.onap.org/).
23494       parameters:
23495         - name: equipment-name
23496           in: path
23497           required: true
23498           type: string
23499           example: __EQUIPMENT-NAME__
23500         - name: interface-name
23501           in: path
23502           description: Name that identifies the link aggregate interface
23503           required: true
23504           type: string
23505           example: __INTERFACE-NAME__
23506         - name: interface-name
23507           in: path
23508           description: Name given to the interface
23509           required: true
23510           type: string
23511           example: __INTERFACE-NAME__
23512         - name: l3-interface-ipv4-address
23513           in: path
23514           description: IP address
23515           required: true
23516           type: string
23517           example: __L3-INTERFACE-IPV4-ADDRESS__
23518         - name: body
23519           in: body
23520           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23521           required: true
23522           schema:
23523             $ref: "#/definitions/l3-interface-ipv4-address-list"
23524     patch:
23525       tags:
23526         - Network
23527       summary: update an existing l3-interface-ipv4-address-list
23528       description: |
23529         Update an existing l3-interface-ipv4-address-list
23530         #
23531         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23532         The PUT operation will entirely replace an existing object.
23533         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23534         #
23535         Other differences between PUT and PATCH are:
23536         #
23537         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23538         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23539         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23540       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23541       consumes:
23542         - application/json
23543         - application/xml
23544       produces:
23545         - application/json
23546         - application/xml
23547       responses:
23548         "default":
23549           description: Response codes found in [response codes](https://wiki.onap.org/).
23550       parameters:
23551         - name: equipment-name
23552           in: path
23553           required: true
23554           type: string
23555           example: __EQUIPMENT-NAME__
23556         - name: interface-name
23557           in: path
23558           description: Name that identifies the link aggregate interface
23559           required: true
23560           type: string
23561           example: __INTERFACE-NAME__
23562         - name: interface-name
23563           in: path
23564           description: Name given to the interface
23565           required: true
23566           type: string
23567           example: __INTERFACE-NAME__
23568         - name: l3-interface-ipv4-address
23569           in: path
23570           description: IP address
23571           required: true
23572           type: string
23573           example: __L3-INTERFACE-IPV4-ADDRESS__
23574         - name: body
23575           in: body
23576           description: l3-interface-ipv4-address-list object that needs to be updated.
23577           required: true
23578           schema:
23579             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23580     delete:
23581       tags:
23582         - Network
23583       summary: delete an existing l3-interface-ipv4-address-list
23584       description: delete an existing l3-interface-ipv4-address-list
23585       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23586       consumes:
23587         - application/json
23588         - application/xml
23589       produces:
23590         - application/json
23591         - application/xml
23592       responses:
23593         "default":
23594           description: Response codes found in [response codes](https://wiki.onap.org/).
23595       parameters:
23596         - name: equipment-name
23597           in: path
23598           required: true
23599           type: string
23600           example: __EQUIPMENT-NAME__
23601         - name: interface-name
23602           in: path
23603           description: Name that identifies the link aggregate interface
23604           required: true
23605           type: string
23606           example: __INTERFACE-NAME__
23607         - name: interface-name
23608           in: path
23609           description: Name given to the interface
23610           required: true
23611           type: string
23612           example: __INTERFACE-NAME__
23613         - name: l3-interface-ipv4-address
23614           in: path
23615           description: IP address
23616           required: true
23617           type: string
23618           example: __L3-INTERFACE-IPV4-ADDRESS__
23619         - name: resource-version
23620           in: query
23621           description: resource-version for concurrency
23622           required: true
23623           type: string
23624   /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:
23625     put:
23626       tags:
23627         - Network
23628       summary: see node definition for valid relationships
23629       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23630       consumes:
23631         - application/json
23632         - application/xml
23633       produces:
23634         - application/json
23635         - application/xml
23636       responses:
23637         "default":
23638           description: Response codes found in [response codes](https://wiki.onap.org/).
23639       parameters:
23640         - name: equipment-name
23641           in: path
23642           required: true
23643           type: string
23644           example: __EQUIPMENT-NAME__
23645         - name: interface-name
23646           in: path
23647           description: Name that identifies the link aggregate interface
23648           required: true
23649           type: string
23650           example: __INTERFACE-NAME__
23651         - name: interface-name
23652           in: path
23653           description: Name given to the interface
23654           required: true
23655           type: string
23656           example: __INTERFACE-NAME__
23657         - name: l3-interface-ipv6-address
23658           in: path
23659           description: IP address
23660           required: true
23661           type: string
23662           example: __L3-INTERFACE-IPV6-ADDRESS__
23663         - name: body
23664           in: body
23665           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23666           required: true
23667           schema:
23668             $ref: "#/definitions/relationship"
23669     delete:
23670       tags:
23671         - Network
23672       summary: delete an existing relationship
23673       description: delete an existing relationship
23674       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23675       consumes:
23676         - application/json
23677         - application/xml
23678       produces:
23679         - application/json
23680         - application/xml
23681       responses:
23682         "default":
23683           description: Response codes found in [response codes](https://wiki.onap.org/).
23684       parameters:
23685         - name: equipment-name
23686           in: path
23687           required: true
23688           type: string
23689           example: __EQUIPMENT-NAME__
23690         - name: interface-name
23691           in: path
23692           description: Name that identifies the link aggregate interface
23693           required: true
23694           type: string
23695           example: __INTERFACE-NAME__
23696         - name: interface-name
23697           in: path
23698           description: Name given to the interface
23699           required: true
23700           type: string
23701           example: __INTERFACE-NAME__
23702         - name: l3-interface-ipv6-address
23703           in: path
23704           description: IP address
23705           required: true
23706           type: string
23707           example: __L3-INTERFACE-IPV6-ADDRESS__
23708   /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}:
23709     get:
23710       tags:
23711         - Network
23712       summary: returns l3-interface-ipv6-address-list
23713       description: returns l3-interface-ipv6-address-list
23714       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23715       produces:
23716         - application/json
23717         - application/xml
23718       responses:
23719         "200":
23720           description: successful operation
23721           schema:
23722               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23723         "default":
23724           description: Response codes found in [response codes](https://wiki.onap.org/).
23725       parameters:
23726         - name: equipment-name
23727           in: path
23728           required: true
23729           type: string
23730           example: __EQUIPMENT-NAME__
23731         - name: interface-name
23732           in: path
23733           description: Name that identifies the link aggregate interface
23734           required: true
23735           type: string
23736           example: __INTERFACE-NAME__
23737         - name: interface-name
23738           in: path
23739           description: Name given to the interface
23740           required: true
23741           type: string
23742           example: __INTERFACE-NAME__
23743         - name: l3-interface-ipv6-address
23744           in: path
23745           description: IP address
23746           required: true
23747           type: string
23748           example: __L3-INTERFACE-IPV6-ADDRESS__
23749     put:
23750       tags:
23751         - Network
23752       summary: create or update an existing l3-interface-ipv6-address-list
23753       description: |
23754         Create or update an existing l3-interface-ipv6-address-list.
23755         #
23756         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23757       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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: equipment-name
23769           in: path
23770           required: true
23771           type: string
23772           example: __EQUIPMENT-NAME__
23773         - name: interface-name
23774           in: path
23775           description: Name that identifies the link aggregate interface
23776           required: true
23777           type: string
23778           example: __INTERFACE-NAME__
23779         - name: interface-name
23780           in: path
23781           description: Name given to the interface
23782           required: true
23783           type: string
23784           example: __INTERFACE-NAME__
23785         - name: l3-interface-ipv6-address
23786           in: path
23787           description: IP address
23788           required: true
23789           type: string
23790           example: __L3-INTERFACE-IPV6-ADDRESS__
23791         - name: body
23792           in: body
23793           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23794           required: true
23795           schema:
23796             $ref: "#/definitions/l3-interface-ipv6-address-list"
23797     patch:
23798       tags:
23799         - Network
23800       summary: update an existing l3-interface-ipv6-address-list
23801       description: |
23802         Update an existing l3-interface-ipv6-address-list
23803         #
23804         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23805         The PUT operation will entirely replace an existing object.
23806         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23807         #
23808         Other differences between PUT and PATCH are:
23809         #
23810         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23811         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23812         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23813       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23814       consumes:
23815         - application/json
23816         - application/xml
23817       produces:
23818         - application/json
23819         - application/xml
23820       responses:
23821         "default":
23822           description: Response codes found in [response codes](https://wiki.onap.org/).
23823       parameters:
23824         - name: equipment-name
23825           in: path
23826           required: true
23827           type: string
23828           example: __EQUIPMENT-NAME__
23829         - name: interface-name
23830           in: path
23831           description: Name that identifies the link aggregate interface
23832           required: true
23833           type: string
23834           example: __INTERFACE-NAME__
23835         - name: interface-name
23836           in: path
23837           description: Name given to the interface
23838           required: true
23839           type: string
23840           example: __INTERFACE-NAME__
23841         - name: l3-interface-ipv6-address
23842           in: path
23843           description: IP address
23844           required: true
23845           type: string
23846           example: __L3-INTERFACE-IPV6-ADDRESS__
23847         - name: body
23848           in: body
23849           description: l3-interface-ipv6-address-list object that needs to be updated.
23850           required: true
23851           schema:
23852             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23853     delete:
23854       tags:
23855         - Network
23856       summary: delete an existing l3-interface-ipv6-address-list
23857       description: delete an existing l3-interface-ipv6-address-list
23858       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23859       consumes:
23860         - application/json
23861         - application/xml
23862       produces:
23863         - application/json
23864         - application/xml
23865       responses:
23866         "default":
23867           description: Response codes found in [response codes](https://wiki.onap.org/).
23868       parameters:
23869         - name: equipment-name
23870           in: path
23871           required: true
23872           type: string
23873           example: __EQUIPMENT-NAME__
23874         - name: interface-name
23875           in: path
23876           description: Name that identifies the link aggregate interface
23877           required: true
23878           type: string
23879           example: __INTERFACE-NAME__
23880         - name: interface-name
23881           in: path
23882           description: Name given to the interface
23883           required: true
23884           type: string
23885           example: __INTERFACE-NAME__
23886         - name: l3-interface-ipv6-address
23887           in: path
23888           description: IP address
23889           required: true
23890           type: string
23891           example: __L3-INTERFACE-IPV6-ADDRESS__
23892         - name: resource-version
23893           in: query
23894           description: resource-version for concurrency
23895           required: true
23896           type: string
23897   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23898     get:
23899       tags:
23900         - Network
23901       summary: returns l-interface
23902       description: returns l-interface
23903       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23904       produces:
23905         - application/json
23906         - application/xml
23907       responses:
23908         "200":
23909           description: successful operation
23910           schema:
23911               $ref: "#/getDefinitions/l-interface"
23912         "default":
23913           description: Response codes found in [response codes](https://wiki.onap.org/).
23914       parameters:
23915         - name: equipment-name
23916           in: path
23917           required: true
23918           type: string
23919           example: __EQUIPMENT-NAME__
23920         - name: interface-name
23921           in: path
23922           description: Name that identifies the link aggregate interface
23923           required: true
23924           type: string
23925           example: __INTERFACE-NAME__
23926         - name: interface-name
23927           in: path
23928           description: Name given to the interface
23929           required: true
23930           type: string
23931           example: __INTERFACE-NAME__
23932     put:
23933       tags:
23934         - Network
23935       summary: create or update an existing l-interface
23936       description: |
23937         Create or update an existing l-interface.
23938         #
23939         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23940       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23941       consumes:
23942         - application/json
23943         - application/xml
23944       produces:
23945         - application/json
23946         - application/xml
23947       responses:
23948         "default":
23949           description: Response codes found in [response codes](https://wiki.onap.org/).
23950       parameters:
23951         - name: equipment-name
23952           in: path
23953           required: true
23954           type: string
23955           example: __EQUIPMENT-NAME__
23956         - name: interface-name
23957           in: path
23958           description: Name that identifies the link aggregate interface
23959           required: true
23960           type: string
23961           example: __INTERFACE-NAME__
23962         - name: interface-name
23963           in: path
23964           description: Name given to the interface
23965           required: true
23966           type: string
23967           example: __INTERFACE-NAME__
23968         - name: body
23969           in: body
23970           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23971           required: true
23972           schema:
23973             $ref: "#/definitions/l-interface"
23974     patch:
23975       tags:
23976         - Network
23977       summary: update an existing l-interface
23978       description: |
23979         Update an existing l-interface
23980         #
23981         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23982         The PUT operation will entirely replace an existing object.
23983         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23984         #
23985         Other differences between PUT and PATCH are:
23986         #
23987         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23988         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23989         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23990       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23991       consumes:
23992         - application/json
23993         - application/xml
23994       produces:
23995         - application/json
23996         - application/xml
23997       responses:
23998         "default":
23999           description: Response codes found in [response codes](https://wiki.onap.org/).
24000       parameters:
24001         - name: equipment-name
24002           in: path
24003           required: true
24004           type: string
24005           example: __EQUIPMENT-NAME__
24006         - name: interface-name
24007           in: path
24008           description: Name that identifies the link aggregate interface
24009           required: true
24010           type: string
24011           example: __INTERFACE-NAME__
24012         - name: interface-name
24013           in: path
24014           description: Name given to the interface
24015           required: true
24016           type: string
24017           example: __INTERFACE-NAME__
24018         - name: body
24019           in: body
24020           description: l-interface object that needs to be updated.
24021           required: true
24022           schema:
24023             $ref: "#/patchDefinitions/l-interface"
24024     delete:
24025       tags:
24026         - Network
24027       summary: delete an existing l-interface
24028       description: delete an existing l-interface
24029       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24030       consumes:
24031         - application/json
24032         - application/xml
24033       produces:
24034         - application/json
24035         - application/xml
24036       responses:
24037         "default":
24038           description: Response codes found in [response codes](https://wiki.onap.org/).
24039       parameters:
24040         - name: equipment-name
24041           in: path
24042           required: true
24043           type: string
24044           example: __EQUIPMENT-NAME__
24045         - name: interface-name
24046           in: path
24047           description: Name that identifies the link aggregate interface
24048           required: true
24049           type: string
24050           example: __INTERFACE-NAME__
24051         - name: interface-name
24052           in: path
24053           description: Name given to the interface
24054           required: true
24055           type: string
24056           example: __INTERFACE-NAME__
24057         - name: resource-version
24058           in: query
24059           description: resource-version for concurrency
24060           required: true
24061           type: string
24062   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
24063     get:
24064       tags:
24065         - Network
24066       summary: returns l-interfaces
24067       description: returns l-interfaces
24068       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
24069       produces:
24070         - application/json
24071         - application/xml
24072       responses:
24073         "200":
24074           description: successful operation
24075           schema:
24076               $ref: "#/getDefinitions/l-interfaces"
24077         "default":
24078           description: Response codes found in [response codes](https://wiki.onap.org/).
24079       parameters:
24080         - name: equipment-name
24081           in: path
24082           required: true
24083           type: string
24084           example: __EQUIPMENT-NAME__
24085         - name: interface-name
24086           in: path
24087           description: Name that identifies the link aggregate interface
24088           required: true
24089           type: string
24090           example: __INTERFACE-NAME__
24091         - name: interface-name
24092           in: query
24093           description:
24094           required: false
24095           type: string
24096         - name: interface-id
24097           in: query
24098           description:
24099           required: false
24100           type: string
24101         - name: macaddr
24102           in: query
24103           description:
24104           required: false
24105           type: string
24106         - name: network-name
24107           in: query
24108           description:
24109           required: false
24110           type: string
24111   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
24112     get:
24113       tags:
24114         - Network
24115       summary: returns lag-interface
24116       description: returns lag-interface
24117       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
24118       produces:
24119         - application/json
24120         - application/xml
24121       responses:
24122         "200":
24123           description: successful operation
24124           schema:
24125               $ref: "#/getDefinitions/lag-interface"
24126         "default":
24127           description: Response codes found in [response codes](https://wiki.onap.org/).
24128       parameters:
24129         - name: equipment-name
24130           in: path
24131           required: true
24132           type: string
24133           example: __EQUIPMENT-NAME__
24134         - name: interface-name
24135           in: path
24136           description: Name that identifies the link aggregate interface
24137           required: true
24138           type: string
24139           example: __INTERFACE-NAME__
24140     put:
24141       tags:
24142         - Network
24143       summary: create or update an existing lag-interface
24144       description: |
24145         Create or update an existing lag-interface.
24146         #
24147         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24148       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
24149       consumes:
24150         - application/json
24151         - application/xml
24152       produces:
24153         - application/json
24154         - application/xml
24155       responses:
24156         "default":
24157           description: Response codes found in [response codes](https://wiki.onap.org/).
24158       parameters:
24159         - name: equipment-name
24160           in: path
24161           required: true
24162           type: string
24163           example: __EQUIPMENT-NAME__
24164         - name: interface-name
24165           in: path
24166           description: Name that identifies the link aggregate interface
24167           required: true
24168           type: string
24169           example: __INTERFACE-NAME__
24170         - name: body
24171           in: body
24172           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24173           required: true
24174           schema:
24175             $ref: "#/definitions/lag-interface"
24176     patch:
24177       tags:
24178         - Network
24179       summary: update an existing lag-interface
24180       description: |
24181         Update an existing lag-interface
24182         #
24183         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24184         The PUT operation will entirely replace an existing object.
24185         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24186         #
24187         Other differences between PUT and PATCH are:
24188         #
24189         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24190         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24191         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24192       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
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: equipment-name
24204           in: path
24205           required: true
24206           type: string
24207           example: __EQUIPMENT-NAME__
24208         - name: interface-name
24209           in: path
24210           description: Name that identifies the link aggregate interface
24211           required: true
24212           type: string
24213           example: __INTERFACE-NAME__
24214         - name: body
24215           in: body
24216           description: lag-interface object that needs to be updated.
24217           required: true
24218           schema:
24219             $ref: "#/patchDefinitions/lag-interface"
24220     delete:
24221       tags:
24222         - Network
24223       summary: delete an existing lag-interface
24224       description: delete an existing lag-interface
24225       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
24226       consumes:
24227         - application/json
24228         - application/xml
24229       produces:
24230         - application/json
24231         - application/xml
24232       responses:
24233         "default":
24234           description: Response codes found in [response codes](https://wiki.onap.org/).
24235       parameters:
24236         - name: equipment-name
24237           in: path
24238           required: true
24239           type: string
24240           example: __EQUIPMENT-NAME__
24241         - name: interface-name
24242           in: path
24243           description: Name that identifies the link aggregate interface
24244           required: true
24245           type: string
24246           example: __INTERFACE-NAME__
24247         - name: resource-version
24248           in: query
24249           description: resource-version for concurrency
24250           required: true
24251           type: string
24252   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
24253     get:
24254       tags:
24255         - Network
24256       summary: returns lag-interfaces
24257       description: returns lag-interfaces
24258       operationId: getNetworkVplsPesVplsPeLagInterfaces
24259       produces:
24260         - application/json
24261         - application/xml
24262       responses:
24263         "200":
24264           description: successful operation
24265           schema:
24266               $ref: "#/getDefinitions/lag-interfaces"
24267         "default":
24268           description: Response codes found in [response codes](https://wiki.onap.org/).
24269       parameters:
24270         - name: equipment-name
24271           in: path
24272           required: true
24273           type: string
24274           example: __EQUIPMENT-NAME__
24275         - name: interface-name
24276           in: query
24277           description:
24278           required: false
24279           type: string
24280         - name: interface-id
24281           in: query
24282           description:
24283           required: false
24284           type: string
24285         - name: interface-role
24286           in: query
24287           description:
24288           required: false
24289           type: string
24290   /network/vpls-pes/vpls-pe/{equipment-name}:
24291     get:
24292       tags:
24293         - Network
24294       summary: returns vpls-pe
24295       description: returns vpls-pe
24296       operationId: getNetworkVplsPesVplsPe
24297       produces:
24298         - application/json
24299         - application/xml
24300       responses:
24301         "200":
24302           description: successful operation
24303           schema:
24304               $ref: "#/getDefinitions/vpls-pe"
24305         "default":
24306           description: Response codes found in [response codes](https://wiki.onap.org/).
24307       parameters:
24308         - name: equipment-name
24309           in: path
24310           required: true
24311           type: string
24312           example: __EQUIPMENT-NAME__
24313     put:
24314       tags:
24315         - Network
24316       summary: create or update an existing vpls-pe
24317       description: |
24318         Create or update an existing vpls-pe.
24319         #
24320         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24321       operationId: createOrUpdateNetworkVplsPesVplsPe
24322       consumes:
24323         - application/json
24324         - application/xml
24325       produces:
24326         - application/json
24327         - application/xml
24328       responses:
24329         "default":
24330           description: Response codes found in [response codes](https://wiki.onap.org/).
24331       parameters:
24332         - name: equipment-name
24333           in: path
24334           required: true
24335           type: string
24336           example: __EQUIPMENT-NAME__
24337         - name: body
24338           in: body
24339           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
24340           required: true
24341           schema:
24342             $ref: "#/definitions/vpls-pe"
24343     patch:
24344       tags:
24345         - Network
24346       summary: update an existing vpls-pe
24347       description: |
24348         Update an existing vpls-pe
24349         #
24350         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24351         The PUT operation will entirely replace an existing object.
24352         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24353         #
24354         Other differences between PUT and PATCH are:
24355         #
24356         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24357         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24358         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24359       operationId: UpdateNetworkVplsPesVplsPe
24360       consumes:
24361         - application/json
24362         - application/xml
24363       produces:
24364         - application/json
24365         - application/xml
24366       responses:
24367         "default":
24368           description: Response codes found in [response codes](https://wiki.onap.org/).
24369       parameters:
24370         - name: equipment-name
24371           in: path
24372           required: true
24373           type: string
24374           example: __EQUIPMENT-NAME__
24375         - name: body
24376           in: body
24377           description: vpls-pe object that needs to be updated.
24378           required: true
24379           schema:
24380             $ref: "#/patchDefinitions/vpls-pe"
24381     delete:
24382       tags:
24383         - Network
24384       summary: delete an existing vpls-pe
24385       description: delete an existing vpls-pe
24386       operationId: deleteNetworkVplsPesVplsPe
24387       consumes:
24388         - application/json
24389         - application/xml
24390       produces:
24391         - application/json
24392         - application/xml
24393       responses:
24394         "default":
24395           description: Response codes found in [response codes](https://wiki.onap.org/).
24396       parameters:
24397         - name: equipment-name
24398           in: path
24399           required: true
24400           type: string
24401           example: __EQUIPMENT-NAME__
24402         - name: resource-version
24403           in: query
24404           description: resource-version for concurrency
24405           required: true
24406           type: string
24407   /network/vpls-pes:
24408     get:
24409       tags:
24410         - Network
24411       summary: returns vpls-pes
24412       description: returns vpls-pes
24413       operationId: getNetworkVplsPes
24414       produces:
24415         - application/json
24416         - application/xml
24417       responses:
24418         "200":
24419           description: successful operation
24420           schema:
24421               $ref: "#/getDefinitions/vpls-pes"
24422         "default":
24423           description: Response codes found in [response codes](https://wiki.onap.org/).
24424       parameters:
24425         - name: equipment-name
24426           in: query
24427           description:
24428           required: false
24429           type: string
24430         - name: prov-status
24431           in: query
24432           description:
24433           required: false
24434           type: string
24435   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
24436     put:
24437       tags:
24438         - Network
24439       summary: see node definition for valid relationships
24440       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24441       consumes:
24442         - application/json
24443         - application/xml
24444       produces:
24445         - application/json
24446         - application/xml
24447       responses:
24448         "default":
24449           description: Response codes found in [response codes](https://wiki.onap.org/).
24450       parameters:
24451         - name: multicast-configuration-id
24452           in: path
24453           description: Unique id of multicast configuration.
24454           required: true
24455           type: string
24456           example: __MULTICAST-CONFIGURATION-ID__
24457         - name: body
24458           in: body
24459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.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: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
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: multicast-configuration-id
24480           in: path
24481           description: Unique id of multicast configuration.
24482           required: true
24483           type: string
24484           example: __MULTICAST-CONFIGURATION-ID__
24485   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
24486     get:
24487       tags:
24488         - Network
24489       summary: returns multicast-configuration
24490       description: returns multicast-configuration
24491       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
24492       produces:
24493         - application/json
24494         - application/xml
24495       responses:
24496         "200":
24497           description: successful operation
24498           schema:
24499               $ref: "#/getDefinitions/multicast-configuration"
24500         "default":
24501           description: Response codes found in [response codes](https://wiki.onap.org/).
24502       parameters:
24503         - name: multicast-configuration-id
24504           in: path
24505           description: Unique id of multicast configuration.
24506           required: true
24507           type: string
24508           example: __MULTICAST-CONFIGURATION-ID__
24509     put:
24510       tags:
24511         - Network
24512       summary: create or update an existing multicast-configuration
24513       description: |
24514         Create or update an existing multicast-configuration.
24515         #
24516         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24517       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
24518       consumes:
24519         - application/json
24520         - application/xml
24521       produces:
24522         - application/json
24523         - application/xml
24524       responses:
24525         "default":
24526           description: Response codes found in [response codes](https://wiki.onap.org/).
24527       parameters:
24528         - name: multicast-configuration-id
24529           in: path
24530           description: Unique id of multicast configuration.
24531           required: true
24532           type: string
24533           example: __MULTICAST-CONFIGURATION-ID__
24534         - name: body
24535           in: body
24536           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
24537           required: true
24538           schema:
24539             $ref: "#/definitions/multicast-configuration"
24540     patch:
24541       tags:
24542         - Network
24543       summary: update an existing multicast-configuration
24544       description: |
24545         Update an existing multicast-configuration
24546         #
24547         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24548         The PUT operation will entirely replace an existing object.
24549         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24550         #
24551         Other differences between PUT and PATCH are:
24552         #
24553         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24554         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24555         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24556       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
24557       consumes:
24558         - application/json
24559         - application/xml
24560       produces:
24561         - application/json
24562         - application/xml
24563       responses:
24564         "default":
24565           description: Response codes found in [response codes](https://wiki.onap.org/).
24566       parameters:
24567         - name: multicast-configuration-id
24568           in: path
24569           description: Unique id of multicast configuration.
24570           required: true
24571           type: string
24572           example: __MULTICAST-CONFIGURATION-ID__
24573         - name: body
24574           in: body
24575           description: multicast-configuration object that needs to be updated.
24576           required: true
24577           schema:
24578             $ref: "#/patchDefinitions/multicast-configuration"
24579     delete:
24580       tags:
24581         - Network
24582       summary: delete an existing multicast-configuration
24583       description: delete an existing multicast-configuration
24584       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
24585       consumes:
24586         - application/json
24587         - application/xml
24588       produces:
24589         - application/json
24590         - application/xml
24591       responses:
24592         "default":
24593           description: Response codes found in [response codes](https://wiki.onap.org/).
24594       parameters:
24595         - name: multicast-configuration-id
24596           in: path
24597           description: Unique id of multicast configuration.
24598           required: true
24599           type: string
24600           example: __MULTICAST-CONFIGURATION-ID__
24601         - name: resource-version
24602           in: query
24603           description: resource-version for concurrency
24604           required: true
24605           type: string
24606   /network/multicast-configurations:
24607     get:
24608       tags:
24609         - Network
24610       summary: returns multicast-configurations
24611       description: returns multicast-configurations
24612       operationId: getNetworkMulticastConfigurations
24613       produces:
24614         - application/json
24615         - application/xml
24616       responses:
24617         "200":
24618           description: successful operation
24619           schema:
24620               $ref: "#/getDefinitions/multicast-configurations"
24621         "default":
24622           description: Response codes found in [response codes](https://wiki.onap.org/).
24623       parameters:
24624         - name: multicast-configuration-id
24625           in: query
24626           description:
24627           required: false
24628           type: string
24629   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
24630     put:
24631       tags:
24632         - Network
24633       summary: see node definition for valid relationships
24634       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24635       consumes:
24636         - application/json
24637         - application/xml
24638       produces:
24639         - application/json
24640         - application/xml
24641       responses:
24642         "default":
24643           description: Response codes found in [response codes](https://wiki.onap.org/).
24644       parameters:
24645         - name: vnf-id
24646           in: path
24647           description: Unique id of VNF.  This is unique across the graph.
24648           required: true
24649           type: string
24650           example: __VNF-ID__
24651         - name: interface-id
24652           in: path
24653           description: Unique ID of the interface
24654           required: true
24655           type: string
24656           example: __INTERFACE-ID__
24657         - name: cvlan-tag
24658           in: path
24659           description: See mis-na-virtualization-platform.yang
24660           required: true
24661           type: integer
24662           format: int64
24663           example: __CVLAN-TAG__
24664         - name: body
24665           in: body
24666           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24667           required: true
24668           schema:
24669             $ref: "#/definitions/relationship"
24670     delete:
24671       tags:
24672         - Network
24673       summary: delete an existing relationship
24674       description: delete an existing relationship
24675       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24676       consumes:
24677         - application/json
24678         - application/xml
24679       produces:
24680         - application/json
24681         - application/xml
24682       responses:
24683         "default":
24684           description: Response codes found in [response codes](https://wiki.onap.org/).
24685       parameters:
24686         - name: vnf-id
24687           in: path
24688           description: Unique id of VNF.  This is unique across the graph.
24689           required: true
24690           type: string
24691           example: __VNF-ID__
24692         - name: interface-id
24693           in: path
24694           description: Unique ID of the interface
24695           required: true
24696           type: string
24697           example: __INTERFACE-ID__
24698         - name: cvlan-tag
24699           in: path
24700           description: See mis-na-virtualization-platform.yang
24701           required: true
24702           type: integer
24703           format: int64
24704           example: __CVLAN-TAG__
24705   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
24706     get:
24707       tags:
24708         - Network
24709       summary: returns cvlan-tag-entry
24710       description: returns cvlan-tag-entry
24711       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24712       produces:
24713         - application/json
24714         - application/xml
24715       responses:
24716         "200":
24717           description: successful operation
24718           schema:
24719               $ref: "#/getDefinitions/cvlan-tag-entry"
24720         "default":
24721           description: Response codes found in [response codes](https://wiki.onap.org/).
24722       parameters:
24723         - name: vnf-id
24724           in: path
24725           description: Unique id of VNF.  This is unique across the graph.
24726           required: true
24727           type: string
24728           example: __VNF-ID__
24729         - name: interface-id
24730           in: path
24731           description: Unique ID of the interface
24732           required: true
24733           type: string
24734           example: __INTERFACE-ID__
24735         - name: cvlan-tag
24736           in: path
24737           description: See mis-na-virtualization-platform.yang
24738           required: true
24739           type: integer
24740           format: int64
24741           example: __CVLAN-TAG__
24742     put:
24743       tags:
24744         - Network
24745       summary: create or update an existing cvlan-tag-entry
24746       description: |
24747         Create or update an existing cvlan-tag-entry.
24748         #
24749         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24750       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24751       consumes:
24752         - application/json
24753         - application/xml
24754       produces:
24755         - application/json
24756         - application/xml
24757       responses:
24758         "default":
24759           description: Response codes found in [response codes](https://wiki.onap.org/).
24760       parameters:
24761         - name: vnf-id
24762           in: path
24763           description: Unique id of VNF.  This is unique across the graph.
24764           required: true
24765           type: string
24766           example: __VNF-ID__
24767         - name: interface-id
24768           in: path
24769           description: Unique ID of the interface
24770           required: true
24771           type: string
24772           example: __INTERFACE-ID__
24773         - name: cvlan-tag
24774           in: path
24775           description: See mis-na-virtualization-platform.yang
24776           required: true
24777           type: integer
24778           format: int64
24779           example: __CVLAN-TAG__
24780         - name: body
24781           in: body
24782           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24783           required: true
24784           schema:
24785             $ref: "#/definitions/cvlan-tag-entry"
24786     patch:
24787       tags:
24788         - Network
24789       summary: update an existing cvlan-tag-entry
24790       description: |
24791         Update an existing cvlan-tag-entry
24792         #
24793         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24794         The PUT operation will entirely replace an existing object.
24795         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24796         #
24797         Other differences between PUT and PATCH are:
24798         #
24799         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24800         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24801         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24802       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24803       consumes:
24804         - application/json
24805         - application/xml
24806       produces:
24807         - application/json
24808         - application/xml
24809       responses:
24810         "default":
24811           description: Response codes found in [response codes](https://wiki.onap.org/).
24812       parameters:
24813         - name: vnf-id
24814           in: path
24815           description: Unique id of VNF.  This is unique across the graph.
24816           required: true
24817           type: string
24818           example: __VNF-ID__
24819         - name: interface-id
24820           in: path
24821           description: Unique ID of the interface
24822           required: true
24823           type: string
24824           example: __INTERFACE-ID__
24825         - name: cvlan-tag
24826           in: path
24827           description: See mis-na-virtualization-platform.yang
24828           required: true
24829           type: integer
24830           format: int64
24831           example: __CVLAN-TAG__
24832         - name: body
24833           in: body
24834           description: cvlan-tag-entry object that needs to be updated.
24835           required: true
24836           schema:
24837             $ref: "#/patchDefinitions/cvlan-tag-entry"
24838     delete:
24839       tags:
24840         - Network
24841       summary: delete an existing cvlan-tag-entry
24842       description: delete an existing cvlan-tag-entry
24843       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24844       consumes:
24845         - application/json
24846         - application/xml
24847       produces:
24848         - application/json
24849         - application/xml
24850       responses:
24851         "default":
24852           description: Response codes found in [response codes](https://wiki.onap.org/).
24853       parameters:
24854         - name: vnf-id
24855           in: path
24856           description: Unique id of VNF.  This is unique across the graph.
24857           required: true
24858           type: string
24859           example: __VNF-ID__
24860         - name: interface-id
24861           in: path
24862           description: Unique ID of the interface
24863           required: true
24864           type: string
24865           example: __INTERFACE-ID__
24866         - name: cvlan-tag
24867           in: path
24868           description: See mis-na-virtualization-platform.yang
24869           required: true
24870           type: integer
24871           format: int64
24872           example: __CVLAN-TAG__
24873         - name: resource-version
24874           in: query
24875           description: resource-version for concurrency
24876           required: true
24877           type: string
24878   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
24879     get:
24880       tags:
24881         - Network
24882       summary: returns cvlan-tags
24883       description: returns cvlan-tags
24884       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
24885       produces:
24886         - application/json
24887         - application/xml
24888       responses:
24889         "200":
24890           description: successful operation
24891           schema:
24892               $ref: "#/getDefinitions/cvlan-tags"
24893         "default":
24894           description: Response codes found in [response codes](https://wiki.onap.org/).
24895       parameters:
24896         - name: vnf-id
24897           in: path
24898           description: Unique id of VNF.  This is unique across the graph.
24899           required: true
24900           type: string
24901           example: __VNF-ID__
24902         - name: interface-id
24903           in: path
24904           description: Unique ID of the interface
24905           required: true
24906           type: string
24907           example: __INTERFACE-ID__
24908         - name: cvlan-tag
24909           in: query
24910           description:
24911           required: false
24912           type: integer
24913           format: int64
24914   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
24915     put:
24916       tags:
24917         - Network
24918       summary: see node definition for valid relationships
24919       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24920       consumes:
24921         - application/json
24922         - application/xml
24923       produces:
24924         - application/json
24925         - application/xml
24926       responses:
24927         "default":
24928           description: Response codes found in [response codes](https://wiki.onap.org/).
24929       parameters:
24930         - name: vnf-id
24931           in: path
24932           description: Unique id of VNF.  This is unique across the graph.
24933           required: true
24934           type: string
24935           example: __VNF-ID__
24936         - name: interface-id
24937           in: path
24938           description: Unique ID of the interface
24939           required: true
24940           type: string
24941           example: __INTERFACE-ID__
24942         - name: body
24943           in: body
24944           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
24945           required: true
24946           schema:
24947             $ref: "#/definitions/relationship"
24948     delete:
24949       tags:
24950         - Network
24951       summary: delete an existing relationship
24952       description: delete an existing relationship
24953       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24954       consumes:
24955         - application/json
24956         - application/xml
24957       produces:
24958         - application/json
24959         - application/xml
24960       responses:
24961         "default":
24962           description: Response codes found in [response codes](https://wiki.onap.org/).
24963       parameters:
24964         - name: vnf-id
24965           in: path
24966           description: Unique id of VNF.  This is unique across the graph.
24967           required: true
24968           type: string
24969           example: __VNF-ID__
24970         - name: interface-id
24971           in: path
24972           description: Unique ID of the interface
24973           required: true
24974           type: string
24975           example: __INTERFACE-ID__
24976   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
24977     get:
24978       tags:
24979         - Network
24980       summary: returns port-group
24981       description: returns port-group
24982       operationId: getNetworkVcesVcePortGroupsPortGroup
24983       produces:
24984         - application/json
24985         - application/xml
24986       responses:
24987         "200":
24988           description: successful operation
24989           schema:
24990               $ref: "#/getDefinitions/port-group"
24991         "default":
24992           description: Response codes found in [response codes](https://wiki.onap.org/).
24993       parameters:
24994         - name: vnf-id
24995           in: path
24996           description: Unique id of VNF.  This is unique across the graph.
24997           required: true
24998           type: string
24999           example: __VNF-ID__
25000         - name: interface-id
25001           in: path
25002           description: Unique ID of the interface
25003           required: true
25004           type: string
25005           example: __INTERFACE-ID__
25006     put:
25007       tags:
25008         - Network
25009       summary: create or update an existing port-group
25010       description: |
25011         Create or update an existing port-group.
25012         #
25013         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25014       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
25015       consumes:
25016         - application/json
25017         - application/xml
25018       produces:
25019         - application/json
25020         - application/xml
25021       responses:
25022         "default":
25023           description: Response codes found in [response codes](https://wiki.onap.org/).
25024       parameters:
25025         - name: vnf-id
25026           in: path
25027           description: Unique id of VNF.  This is unique across the graph.
25028           required: true
25029           type: string
25030           example: __VNF-ID__
25031         - name: interface-id
25032           in: path
25033           description: Unique ID of the interface
25034           required: true
25035           type: string
25036           example: __INTERFACE-ID__
25037         - name: body
25038           in: body
25039           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
25040           required: true
25041           schema:
25042             $ref: "#/definitions/port-group"
25043     patch:
25044       tags:
25045         - Network
25046       summary: update an existing port-group
25047       description: |
25048         Update an existing port-group
25049         #
25050         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25051         The PUT operation will entirely replace an existing object.
25052         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25053         #
25054         Other differences between PUT and PATCH are:
25055         #
25056         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25057         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25058         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25059       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
25060       consumes:
25061         - application/json
25062         - application/xml
25063       produces:
25064         - application/json
25065         - application/xml
25066       responses:
25067         "default":
25068           description: Response codes found in [response codes](https://wiki.onap.org/).
25069       parameters:
25070         - name: vnf-id
25071           in: path
25072           description: Unique id of VNF.  This is unique across the graph.
25073           required: true
25074           type: string
25075           example: __VNF-ID__
25076         - name: interface-id
25077           in: path
25078           description: Unique ID of the interface
25079           required: true
25080           type: string
25081           example: __INTERFACE-ID__
25082         - name: body
25083           in: body
25084           description: port-group object that needs to be updated.
25085           required: true
25086           schema:
25087             $ref: "#/patchDefinitions/port-group"
25088     delete:
25089       tags:
25090         - Network
25091       summary: delete an existing port-group
25092       description: delete an existing port-group
25093       operationId: deleteNetworkVcesVcePortGroupsPortGroup
25094       consumes:
25095         - application/json
25096         - application/xml
25097       produces:
25098         - application/json
25099         - application/xml
25100       responses:
25101         "default":
25102           description: Response codes found in [response codes](https://wiki.onap.org/).
25103       parameters:
25104         - name: vnf-id
25105           in: path
25106           description: Unique id of VNF.  This is unique across the graph.
25107           required: true
25108           type: string
25109           example: __VNF-ID__
25110         - name: interface-id
25111           in: path
25112           description: Unique ID of the interface
25113           required: true
25114           type: string
25115           example: __INTERFACE-ID__
25116         - name: resource-version
25117           in: query
25118           description: resource-version for concurrency
25119           required: true
25120           type: string
25121   /network/vces/vce/{vnf-id}/port-groups:
25122     get:
25123       tags:
25124         - Network
25125       summary: returns port-groups
25126       description: returns port-groups
25127       operationId: getNetworkVcesVcePortGroups
25128       produces:
25129         - application/json
25130         - application/xml
25131       responses:
25132         "200":
25133           description: successful operation
25134           schema:
25135               $ref: "#/getDefinitions/port-groups"
25136         "default":
25137           description: Response codes found in [response codes](https://wiki.onap.org/).
25138       parameters:
25139         - name: vnf-id
25140           in: path
25141           description: Unique id of VNF.  This is unique across the graph.
25142           required: true
25143           type: string
25144           example: __VNF-ID__
25145         - name: interface-id
25146           in: query
25147           description:
25148           required: false
25149           type: string
25150         - name: port-group-id
25151           in: query
25152           description:
25153           required: false
25154           type: string
25155         - name: switch-name
25156           in: query
25157           description:
25158           required: false
25159           type: string
25160         - name: heat-stack-id
25161           in: query
25162           description:
25163           required: false
25164           type: string
25165   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25166     put:
25167       tags:
25168         - Network
25169       summary: see node definition for valid relationships
25170       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
25171       consumes:
25172         - application/json
25173         - application/xml
25174       produces:
25175         - application/json
25176         - application/xml
25177       responses:
25178         "default":
25179           description: Response codes found in [response codes](https://wiki.onap.org/).
25180       parameters:
25181         - name: vnf-id
25182           in: path
25183           description: Unique id of VNF.  This is unique across the graph.
25184           required: true
25185           type: string
25186           example: __VNF-ID__
25187         - name: group-uuid
25188           in: path
25189           description: Unique ID for the license group the resource belongs to, should be uuid.
25190           required: true
25191           type: string
25192           example: __GROUP-UUID__
25193         - name: resource-uuid
25194           in: path
25195           description: Unique ID of a license resource.
25196           required: true
25197           type: string
25198           example: __RESOURCE-UUID__
25199         - name: body
25200           in: body
25201           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
25202           required: true
25203           schema:
25204             $ref: "#/definitions/relationship"
25205     delete:
25206       tags:
25207         - Network
25208       summary: delete an existing relationship
25209       description: delete an existing relationship
25210       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
25211       consumes:
25212         - application/json
25213         - application/xml
25214       produces:
25215         - application/json
25216         - application/xml
25217       responses:
25218         "default":
25219           description: Response codes found in [response codes](https://wiki.onap.org/).
25220       parameters:
25221         - name: vnf-id
25222           in: path
25223           description: Unique id of VNF.  This is unique across the graph.
25224           required: true
25225           type: string
25226           example: __VNF-ID__
25227         - name: group-uuid
25228           in: path
25229           description: Unique ID for the license group the resource belongs to, should be uuid.
25230           required: true
25231           type: string
25232           example: __GROUP-UUID__
25233         - name: resource-uuid
25234           in: path
25235           description: Unique ID of a license resource.
25236           required: true
25237           type: string
25238           example: __RESOURCE-UUID__
25239   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
25240     get:
25241       tags:
25242         - Network
25243       summary: returns license
25244       description: returns license
25245       operationId: getNetworkVcesVceLicensesLicense
25246       produces:
25247         - application/json
25248         - application/xml
25249       responses:
25250         "200":
25251           description: successful operation
25252           schema:
25253               $ref: "#/getDefinitions/license"
25254         "default":
25255           description: Response codes found in [response codes](https://wiki.onap.org/).
25256       parameters:
25257         - name: vnf-id
25258           in: path
25259           description: Unique id of VNF.  This is unique across the graph.
25260           required: true
25261           type: string
25262           example: __VNF-ID__
25263         - name: group-uuid
25264           in: path
25265           description: Unique ID for the license group the resource belongs to, should be uuid.
25266           required: true
25267           type: string
25268           example: __GROUP-UUID__
25269         - name: resource-uuid
25270           in: path
25271           description: Unique ID of a license resource.
25272           required: true
25273           type: string
25274           example: __RESOURCE-UUID__
25275     put:
25276       tags:
25277         - Network
25278       summary: create or update an existing license
25279       description: |
25280         Create or update an existing license.
25281         #
25282         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25283       operationId: createOrUpdateNetworkVcesVceLicensesLicense
25284       consumes:
25285         - application/json
25286         - application/xml
25287       produces:
25288         - application/json
25289         - application/xml
25290       responses:
25291         "default":
25292           description: Response codes found in [response codes](https://wiki.onap.org/).
25293       parameters:
25294         - name: vnf-id
25295           in: path
25296           description: Unique id of VNF.  This is unique across the graph.
25297           required: true
25298           type: string
25299           example: __VNF-ID__
25300         - name: group-uuid
25301           in: path
25302           description: Unique ID for the license group the resource belongs to, should be uuid.
25303           required: true
25304           type: string
25305           example: __GROUP-UUID__
25306         - name: resource-uuid
25307           in: path
25308           description: Unique ID of a license resource.
25309           required: true
25310           type: string
25311           example: __RESOURCE-UUID__
25312         - name: body
25313           in: body
25314           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
25315           required: true
25316           schema:
25317             $ref: "#/definitions/license"
25318     patch:
25319       tags:
25320         - Network
25321       summary: update an existing license
25322       description: |
25323         Update an existing license
25324         #
25325         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25326         The PUT operation will entirely replace an existing object.
25327         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25328         #
25329         Other differences between PUT and PATCH are:
25330         #
25331         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25332         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25333         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25334       operationId: UpdateNetworkVcesVceLicensesLicense
25335       consumes:
25336         - application/json
25337         - application/xml
25338       produces:
25339         - application/json
25340         - application/xml
25341       responses:
25342         "default":
25343           description: Response codes found in [response codes](https://wiki.onap.org/).
25344       parameters:
25345         - name: vnf-id
25346           in: path
25347           description: Unique id of VNF.  This is unique across the graph.
25348           required: true
25349           type: string
25350           example: __VNF-ID__
25351         - name: group-uuid
25352           in: path
25353           description: Unique ID for the license group the resource belongs to, should be uuid.
25354           required: true
25355           type: string
25356           example: __GROUP-UUID__
25357         - name: resource-uuid
25358           in: path
25359           description: Unique ID of a license resource.
25360           required: true
25361           type: string
25362           example: __RESOURCE-UUID__
25363         - name: body
25364           in: body
25365           description: license object that needs to be updated.
25366           required: true
25367           schema:
25368             $ref: "#/patchDefinitions/license"
25369     delete:
25370       tags:
25371         - Network
25372       summary: delete an existing license
25373       description: delete an existing license
25374       operationId: deleteNetworkVcesVceLicensesLicense
25375       consumes:
25376         - application/json
25377         - application/xml
25378       produces:
25379         - application/json
25380         - application/xml
25381       responses:
25382         "default":
25383           description: Response codes found in [response codes](https://wiki.onap.org/).
25384       parameters:
25385         - name: vnf-id
25386           in: path
25387           description: Unique id of VNF.  This is unique across the graph.
25388           required: true
25389           type: string
25390           example: __VNF-ID__
25391         - name: group-uuid
25392           in: path
25393           description: Unique ID for the license group the resource belongs to, should be uuid.
25394           required: true
25395           type: string
25396           example: __GROUP-UUID__
25397         - name: resource-uuid
25398           in: path
25399           description: Unique ID of a license resource.
25400           required: true
25401           type: string
25402           example: __RESOURCE-UUID__
25403         - name: resource-version
25404           in: query
25405           description: resource-version for concurrency
25406           required: true
25407           type: string
25408   /network/vces/vce/{vnf-id}/licenses:
25409     get:
25410       tags:
25411         - Network
25412       summary: returns licenses
25413       description: returns licenses
25414       operationId: getNetworkVcesVceLicenses
25415       produces:
25416         - application/json
25417         - application/xml
25418       responses:
25419         "200":
25420           description: successful operation
25421           schema:
25422               $ref: "#/getDefinitions/licenses"
25423         "default":
25424           description: Response codes found in [response codes](https://wiki.onap.org/).
25425       parameters:
25426         - name: vnf-id
25427           in: path
25428           description: Unique id of VNF.  This is unique across the graph.
25429           required: true
25430           type: string
25431           example: __VNF-ID__
25432         - name: group-uuid
25433           in: query
25434           description:
25435           required: false
25436           type: string
25437         - name: resource-uuid
25438           in: query
25439           description:
25440           required: false
25441           type: string
25442   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25443     put:
25444       tags:
25445         - Network
25446       summary: see node definition for valid relationships
25447       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25448       consumes:
25449         - application/json
25450         - application/xml
25451       produces:
25452         - application/json
25453         - application/xml
25454       responses:
25455         "default":
25456           description: Response codes found in [response codes](https://wiki.onap.org/).
25457       parameters:
25458         - name: vnf-id
25459           in: path
25460           description: Unique id of VNF.  This is unique across the graph.
25461           required: true
25462           type: string
25463           example: __VNF-ID__
25464         - name: group-uuid
25465           in: path
25466           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25467           required: true
25468           type: string
25469           example: __GROUP-UUID__
25470         - name: resource-uuid
25471           in: path
25472           description: Unique ID of an entitlement resource.
25473           required: true
25474           type: string
25475           example: __RESOURCE-UUID__
25476         - name: body
25477           in: body
25478           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
25479           required: true
25480           schema:
25481             $ref: "#/definitions/relationship"
25482     delete:
25483       tags:
25484         - Network
25485       summary: delete an existing relationship
25486       description: delete an existing relationship
25487       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25488       consumes:
25489         - application/json
25490         - application/xml
25491       produces:
25492         - application/json
25493         - application/xml
25494       responses:
25495         "default":
25496           description: Response codes found in [response codes](https://wiki.onap.org/).
25497       parameters:
25498         - name: vnf-id
25499           in: path
25500           description: Unique id of VNF.  This is unique across the graph.
25501           required: true
25502           type: string
25503           example: __VNF-ID__
25504         - name: group-uuid
25505           in: path
25506           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25507           required: true
25508           type: string
25509           example: __GROUP-UUID__
25510         - name: resource-uuid
25511           in: path
25512           description: Unique ID of an entitlement resource.
25513           required: true
25514           type: string
25515           example: __RESOURCE-UUID__
25516   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
25517     get:
25518       tags:
25519         - Network
25520       summary: returns entitlement
25521       description: returns entitlement
25522       operationId: getNetworkVcesVceEntitlementsEntitlement
25523       produces:
25524         - application/json
25525         - application/xml
25526       responses:
25527         "200":
25528           description: successful operation
25529           schema:
25530               $ref: "#/getDefinitions/entitlement"
25531         "default":
25532           description: Response codes found in [response codes](https://wiki.onap.org/).
25533       parameters:
25534         - name: vnf-id
25535           in: path
25536           description: Unique id of VNF.  This is unique across the graph.
25537           required: true
25538           type: string
25539           example: __VNF-ID__
25540         - name: group-uuid
25541           in: path
25542           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25543           required: true
25544           type: string
25545           example: __GROUP-UUID__
25546         - name: resource-uuid
25547           in: path
25548           description: Unique ID of an entitlement resource.
25549           required: true
25550           type: string
25551           example: __RESOURCE-UUID__
25552     put:
25553       tags:
25554         - Network
25555       summary: create or update an existing entitlement
25556       description: |
25557         Create or update an existing entitlement.
25558         #
25559         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25560       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
25561       consumes:
25562         - application/json
25563         - application/xml
25564       produces:
25565         - application/json
25566         - application/xml
25567       responses:
25568         "default":
25569           description: Response codes found in [response codes](https://wiki.onap.org/).
25570       parameters:
25571         - name: vnf-id
25572           in: path
25573           description: Unique id of VNF.  This is unique across the graph.
25574           required: true
25575           type: string
25576           example: __VNF-ID__
25577         - name: group-uuid
25578           in: path
25579           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25580           required: true
25581           type: string
25582           example: __GROUP-UUID__
25583         - name: resource-uuid
25584           in: path
25585           description: Unique ID of an entitlement resource.
25586           required: true
25587           type: string
25588           example: __RESOURCE-UUID__
25589         - name: body
25590           in: body
25591           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
25592           required: true
25593           schema:
25594             $ref: "#/definitions/entitlement"
25595     patch:
25596       tags:
25597         - Network
25598       summary: update an existing entitlement
25599       description: |
25600         Update an existing entitlement
25601         #
25602         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25603         The PUT operation will entirely replace an existing object.
25604         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25605         #
25606         Other differences between PUT and PATCH are:
25607         #
25608         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25609         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25610         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25611       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
25612       consumes:
25613         - application/json
25614         - application/xml
25615       produces:
25616         - application/json
25617         - application/xml
25618       responses:
25619         "default":
25620           description: Response codes found in [response codes](https://wiki.onap.org/).
25621       parameters:
25622         - name: vnf-id
25623           in: path
25624           description: Unique id of VNF.  This is unique across the graph.
25625           required: true
25626           type: string
25627           example: __VNF-ID__
25628         - name: group-uuid
25629           in: path
25630           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25631           required: true
25632           type: string
25633           example: __GROUP-UUID__
25634         - name: resource-uuid
25635           in: path
25636           description: Unique ID of an entitlement resource.
25637           required: true
25638           type: string
25639           example: __RESOURCE-UUID__
25640         - name: body
25641           in: body
25642           description: entitlement object that needs to be updated.
25643           required: true
25644           schema:
25645             $ref: "#/patchDefinitions/entitlement"
25646     delete:
25647       tags:
25648         - Network
25649       summary: delete an existing entitlement
25650       description: delete an existing entitlement
25651       operationId: deleteNetworkVcesVceEntitlementsEntitlement
25652       consumes:
25653         - application/json
25654         - application/xml
25655       produces:
25656         - application/json
25657         - application/xml
25658       responses:
25659         "default":
25660           description: Response codes found in [response codes](https://wiki.onap.org/).
25661       parameters:
25662         - name: vnf-id
25663           in: path
25664           description: Unique id of VNF.  This is unique across the graph.
25665           required: true
25666           type: string
25667           example: __VNF-ID__
25668         - name: group-uuid
25669           in: path
25670           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25671           required: true
25672           type: string
25673           example: __GROUP-UUID__
25674         - name: resource-uuid
25675           in: path
25676           description: Unique ID of an entitlement resource.
25677           required: true
25678           type: string
25679           example: __RESOURCE-UUID__
25680         - name: resource-version
25681           in: query
25682           description: resource-version for concurrency
25683           required: true
25684           type: string
25685   /network/vces/vce/{vnf-id}/entitlements:
25686     get:
25687       tags:
25688         - Network
25689       summary: returns entitlements
25690       description: returns entitlements
25691       operationId: getNetworkVcesVceEntitlements
25692       produces:
25693         - application/json
25694         - application/xml
25695       responses:
25696         "200":
25697           description: successful operation
25698           schema:
25699               $ref: "#/getDefinitions/entitlements"
25700         "default":
25701           description: Response codes found in [response codes](https://wiki.onap.org/).
25702       parameters:
25703         - name: vnf-id
25704           in: path
25705           description: Unique id of VNF.  This is unique across the graph.
25706           required: true
25707           type: string
25708           example: __VNF-ID__
25709         - name: group-uuid
25710           in: query
25711           description:
25712           required: false
25713           type: string
25714         - name: resource-uuid
25715           in: query
25716           description:
25717           required: false
25718           type: string
25719   /network/vces/vce/{vnf-id}/relationship-list/relationship:
25720     put:
25721       tags:
25722         - Network
25723       summary: see node definition for valid relationships
25724       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
25725       consumes:
25726         - application/json
25727         - application/xml
25728       produces:
25729         - application/json
25730         - application/xml
25731       responses:
25732         "default":
25733           description: Response codes found in [response codes](https://wiki.onap.org/).
25734       parameters:
25735         - name: vnf-id
25736           in: path
25737           description: Unique id of VNF.  This is unique across the graph.
25738           required: true
25739           type: string
25740           example: __VNF-ID__
25741         - name: body
25742           in: body
25743           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
25744           required: true
25745           schema:
25746             $ref: "#/definitions/relationship"
25747     delete:
25748       tags:
25749         - Network
25750       summary: delete an existing relationship
25751       description: delete an existing relationship
25752       operationId: deleteNetworkVcesVceRelationshipListRelationship
25753       consumes:
25754         - application/json
25755         - application/xml
25756       produces:
25757         - application/json
25758         - application/xml
25759       responses:
25760         "default":
25761           description: Response codes found in [response codes](https://wiki.onap.org/).
25762       parameters:
25763         - name: vnf-id
25764           in: path
25765           description: Unique id of VNF.  This is unique across the graph.
25766           required: true
25767           type: string
25768           example: __VNF-ID__
25769   /network/vces/vce/{vnf-id}:
25770     get:
25771       tags:
25772         - Network
25773       summary: returns vce
25774       description: returns vce
25775       operationId: getNetworkVcesVce
25776       produces:
25777         - application/json
25778         - application/xml
25779       responses:
25780         "200":
25781           description: successful operation
25782           schema:
25783               $ref: "#/getDefinitions/vce"
25784         "default":
25785           description: Response codes found in [response codes](https://wiki.onap.org/).
25786       parameters:
25787         - name: vnf-id
25788           in: path
25789           description: Unique id of VNF.  This is unique across the graph.
25790           required: true
25791           type: string
25792           example: __VNF-ID__
25793     put:
25794       tags:
25795         - Network
25796       summary: create or update an existing vce
25797       description: |
25798         Create or update an existing vce.
25799         #
25800         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25801       operationId: createOrUpdateNetworkVcesVce
25802       consumes:
25803         - application/json
25804         - application/xml
25805       produces:
25806         - application/json
25807         - application/xml
25808       responses:
25809         "default":
25810           description: Response codes found in [response codes](https://wiki.onap.org/).
25811       parameters:
25812         - name: vnf-id
25813           in: path
25814           description: Unique id of VNF.  This is unique across the graph.
25815           required: true
25816           type: string
25817           example: __VNF-ID__
25818         - name: body
25819           in: body
25820           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
25821           required: true
25822           schema:
25823             $ref: "#/definitions/vce"
25824     patch:
25825       tags:
25826         - Network
25827       summary: update an existing vce
25828       description: |
25829         Update an existing vce
25830         #
25831         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25832         The PUT operation will entirely replace an existing object.
25833         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25834         #
25835         Other differences between PUT and PATCH are:
25836         #
25837         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25838         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25839         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25840       operationId: UpdateNetworkVcesVce
25841       consumes:
25842         - application/json
25843         - application/xml
25844       produces:
25845         - application/json
25846         - application/xml
25847       responses:
25848         "default":
25849           description: Response codes found in [response codes](https://wiki.onap.org/).
25850       parameters:
25851         - name: vnf-id
25852           in: path
25853           description: Unique id of VNF.  This is unique across the graph.
25854           required: true
25855           type: string
25856           example: __VNF-ID__
25857         - name: body
25858           in: body
25859           description: vce object that needs to be updated.
25860           required: true
25861           schema:
25862             $ref: "#/patchDefinitions/vce"
25863     delete:
25864       tags:
25865         - Network
25866       summary: delete an existing vce
25867       description: delete an existing vce
25868       operationId: deleteNetworkVcesVce
25869       consumes:
25870         - application/json
25871         - application/xml
25872       produces:
25873         - application/json
25874         - application/xml
25875       responses:
25876         "default":
25877           description: Response codes found in [response codes](https://wiki.onap.org/).
25878       parameters:
25879         - name: vnf-id
25880           in: path
25881           description: Unique id of VNF.  This is unique across the graph.
25882           required: true
25883           type: string
25884           example: __VNF-ID__
25885         - name: resource-version
25886           in: query
25887           description: resource-version for concurrency
25888           required: true
25889           type: string
25890   /network/vces:
25891     get:
25892       tags:
25893         - Network
25894       summary: returns vces
25895       description: returns vces
25896       operationId: getNetworkVces
25897       produces:
25898         - application/json
25899         - application/xml
25900       responses:
25901         "200":
25902           description: successful operation
25903           schema:
25904               $ref: "#/getDefinitions/vces"
25905         "default":
25906           description: Response codes found in [response codes](https://wiki.onap.org/).
25907       parameters:
25908         - name: vnf-id
25909           in: query
25910           description:
25911           required: false
25912           type: string
25913         - name: vnf-name
25914           in: query
25915           description:
25916           required: false
25917           type: string
25918         - name: vnf-name2
25919           in: query
25920           description:
25921           required: false
25922           type: string
25923         - name: vnf-type
25924           in: query
25925           description:
25926           required: false
25927           type: string
25928         - name: service-id
25929           in: query
25930           description:
25931           required: false
25932           type: string
25933         - name: regional-resource-zone
25934           in: query
25935           description:
25936           required: false
25937           type: string
25938         - name: prov-status
25939           in: query
25940           description:
25941           required: false
25942           type: string
25943         - name: heat-stack-id
25944           in: query
25945           description:
25946           required: false
25947           type: string
25948         - name: vpe-id
25949           in: query
25950           description:
25951           required: false
25952           type: string
25953   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
25954     put:
25955       tags:
25956         - Network
25957       summary: see node definition for valid relationships
25958       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
25959       consumes:
25960         - application/json
25961         - application/xml
25962       produces:
25963         - application/json
25964         - application/xml
25965       responses:
25966         "default":
25967           description: Response codes found in [response codes](https://wiki.onap.org/).
25968       parameters:
25969         - name: vnfc-name
25970           in: path
25971           description: Unique ID of vnfc.
25972           required: true
25973           type: string
25974           example: __VNFC-NAME__
25975         - name: body
25976           in: body
25977           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
25978           required: true
25979           schema:
25980             $ref: "#/definitions/relationship"
25981     delete:
25982       tags:
25983         - Network
25984       summary: delete an existing relationship
25985       description: delete an existing relationship
25986       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
25987       consumes:
25988         - application/json
25989         - application/xml
25990       produces:
25991         - application/json
25992         - application/xml
25993       responses:
25994         "default":
25995           description: Response codes found in [response codes](https://wiki.onap.org/).
25996       parameters:
25997         - name: vnfc-name
25998           in: path
25999           description: Unique ID of vnfc.
26000           required: true
26001           type: string
26002           example: __VNFC-NAME__
26003   /network/vnfcs/vnfc/{vnfc-name}:
26004     get:
26005       tags:
26006         - Network
26007       summary: returns vnfc
26008       description: returns vnfc
26009       operationId: getNetworkVnfcsVnfc
26010       produces:
26011         - application/json
26012         - application/xml
26013       responses:
26014         "200":
26015           description: successful operation
26016           schema:
26017               $ref: "#/getDefinitions/vnfc"
26018         "default":
26019           description: Response codes found in [response codes](https://wiki.onap.org/).
26020       parameters:
26021         - name: vnfc-name
26022           in: path
26023           description: Unique ID of vnfc.
26024           required: true
26025           type: string
26026           example: __VNFC-NAME__
26027     put:
26028       tags:
26029         - Network
26030       summary: create or update an existing vnfc
26031       description: |
26032         Create or update an existing vnfc.
26033         #
26034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26035       operationId: createOrUpdateNetworkVnfcsVnfc
26036       consumes:
26037         - application/json
26038         - application/xml
26039       produces:
26040         - application/json
26041         - application/xml
26042       responses:
26043         "default":
26044           description: Response codes found in [response codes](https://wiki.onap.org/).
26045       parameters:
26046         - name: vnfc-name
26047           in: path
26048           description: Unique ID of vnfc.
26049           required: true
26050           type: string
26051           example: __VNFC-NAME__
26052         - name: body
26053           in: body
26054           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
26055           required: true
26056           schema:
26057             $ref: "#/definitions/vnfc"
26058     patch:
26059       tags:
26060         - Network
26061       summary: update an existing vnfc
26062       description: |
26063         Update an existing vnfc
26064         #
26065         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26066         The PUT operation will entirely replace an existing object.
26067         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26068         #
26069         Other differences between PUT and PATCH are:
26070         #
26071         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26072         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26073         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26074       operationId: UpdateNetworkVnfcsVnfc
26075       consumes:
26076         - application/json
26077         - application/xml
26078       produces:
26079         - application/json
26080         - application/xml
26081       responses:
26082         "default":
26083           description: Response codes found in [response codes](https://wiki.onap.org/).
26084       parameters:
26085         - name: vnfc-name
26086           in: path
26087           description: Unique ID of vnfc.
26088           required: true
26089           type: string
26090           example: __VNFC-NAME__
26091         - name: body
26092           in: body
26093           description: vnfc object that needs to be updated.
26094           required: true
26095           schema:
26096             $ref: "#/patchDefinitions/vnfc"
26097     delete:
26098       tags:
26099         - Network
26100       summary: delete an existing vnfc
26101       description: delete an existing vnfc
26102       operationId: deleteNetworkVnfcsVnfc
26103       consumes:
26104         - application/json
26105         - application/xml
26106       produces:
26107         - application/json
26108         - application/xml
26109       responses:
26110         "default":
26111           description: Response codes found in [response codes](https://wiki.onap.org/).
26112       parameters:
26113         - name: vnfc-name
26114           in: path
26115           description: Unique ID of vnfc.
26116           required: true
26117           type: string
26118           example: __VNFC-NAME__
26119         - name: resource-version
26120           in: query
26121           description: resource-version for concurrency
26122           required: true
26123           type: string
26124   /network/vnfcs:
26125     get:
26126       tags:
26127         - Network
26128       summary: returns vnfcs
26129       description: returns vnfcs
26130       operationId: getNetworkVnfcs
26131       produces:
26132         - application/json
26133         - application/xml
26134       responses:
26135         "200":
26136           description: successful operation
26137           schema:
26138               $ref: "#/getDefinitions/vnfcs"
26139         "default":
26140           description: Response codes found in [response codes](https://wiki.onap.org/).
26141       parameters:
26142         - name: vnfc-name
26143           in: query
26144           description:
26145           required: false
26146           type: string
26147         - name: vnfc-function-code
26148           in: query
26149           description:
26150           required: false
26151           type: string
26152         - name: vnfc-type
26153           in: query
26154           description:
26155           required: false
26156           type: string
26157         - name: prov-status
26158           in: query
26159           description:
26160           required: false
26161           type: string
26162         - name: ipaddress-v4-oam-vip
26163           in: query
26164           description:
26165           required: false
26166           type: string
26167         - name: in-maint
26168           in: query
26169           description:
26170           required: false
26171           type: boolean
26172         - name: is-closed-loop-disabled
26173           in: query
26174           description:
26175           required: false
26176           type: boolean
26177         - name: group-notation
26178           in: query
26179           description:
26180           required: false
26181           type: string
26182   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
26183     put:
26184       tags:
26185         - Network
26186       summary: see node definition for valid relationships
26187       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26188       consumes:
26189         - application/json
26190         - application/xml
26191       produces:
26192         - application/json
26193         - application/xml
26194       responses:
26195         "default":
26196           description: Response codes found in [response codes](https://wiki.onap.org/).
26197       parameters:
26198         - name: network-id
26199           in: path
26200           description: Network ID, should be uuid. Unique across A&AI.
26201           required: true
26202           type: string
26203           example: __NETWORK-ID__
26204         - name: subnet-id
26205           in: path
26206           description: Subnet ID, should be UUID.
26207           required: true
26208           type: string
26209           example: __SUBNET-ID__
26210         - name: body
26211           in: body
26212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26213           required: true
26214           schema:
26215             $ref: "#/definitions/relationship"
26216     delete:
26217       tags:
26218         - Network
26219       summary: delete an existing relationship
26220       description: delete an existing relationship
26221       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26222       consumes:
26223         - application/json
26224         - application/xml
26225       produces:
26226         - application/json
26227         - application/xml
26228       responses:
26229         "default":
26230           description: Response codes found in [response codes](https://wiki.onap.org/).
26231       parameters:
26232         - name: network-id
26233           in: path
26234           description: Network ID, should be uuid. Unique across A&AI.
26235           required: true
26236           type: string
26237           example: __NETWORK-ID__
26238         - name: subnet-id
26239           in: path
26240           description: Subnet ID, should be UUID.
26241           required: true
26242           type: string
26243           example: __SUBNET-ID__
26244   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
26245     get:
26246       tags:
26247         - Network
26248       summary: returns subnet
26249       description: returns subnet
26250       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
26251       produces:
26252         - application/json
26253         - application/xml
26254       responses:
26255         "200":
26256           description: successful operation
26257           schema:
26258               $ref: "#/getDefinitions/subnet"
26259         "default":
26260           description: Response codes found in [response codes](https://wiki.onap.org/).
26261       parameters:
26262         - name: network-id
26263           in: path
26264           description: Network ID, should be uuid. Unique across A&AI.
26265           required: true
26266           type: string
26267           example: __NETWORK-ID__
26268         - name: subnet-id
26269           in: path
26270           description: Subnet ID, should be UUID.
26271           required: true
26272           type: string
26273           example: __SUBNET-ID__
26274     put:
26275       tags:
26276         - Network
26277       summary: create or update an existing subnet
26278       description: |
26279         Create or update an existing subnet.
26280         #
26281         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26282       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
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: network-id
26294           in: path
26295           description: Network ID, should be uuid. Unique across A&AI.
26296           required: true
26297           type: string
26298           example: __NETWORK-ID__
26299         - name: subnet-id
26300           in: path
26301           description: Subnet ID, should be UUID.
26302           required: true
26303           type: string
26304           example: __SUBNET-ID__
26305         - name: body
26306           in: body
26307           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26308           required: true
26309           schema:
26310             $ref: "#/definitions/subnet"
26311     patch:
26312       tags:
26313         - Network
26314       summary: update an existing subnet
26315       description: |
26316         Update an existing subnet
26317         #
26318         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26319         The PUT operation will entirely replace an existing object.
26320         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26321         #
26322         Other differences between PUT and PATCH are:
26323         #
26324         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26325         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26326         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26327       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26328       consumes:
26329         - application/json
26330         - application/xml
26331       produces:
26332         - application/json
26333         - application/xml
26334       responses:
26335         "default":
26336           description: Response codes found in [response codes](https://wiki.onap.org/).
26337       parameters:
26338         - name: network-id
26339           in: path
26340           description: Network ID, should be uuid. Unique across A&AI.
26341           required: true
26342           type: string
26343           example: __NETWORK-ID__
26344         - name: subnet-id
26345           in: path
26346           description: Subnet ID, should be UUID.
26347           required: true
26348           type: string
26349           example: __SUBNET-ID__
26350         - name: body
26351           in: body
26352           description: subnet object that needs to be updated.
26353           required: true
26354           schema:
26355             $ref: "#/patchDefinitions/subnet"
26356     delete:
26357       tags:
26358         - Network
26359       summary: delete an existing subnet
26360       description: delete an existing subnet
26361       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26362       consumes:
26363         - application/json
26364         - application/xml
26365       produces:
26366         - application/json
26367         - application/xml
26368       responses:
26369         "default":
26370           description: Response codes found in [response codes](https://wiki.onap.org/).
26371       parameters:
26372         - name: network-id
26373           in: path
26374           description: Network ID, should be uuid. Unique across A&AI.
26375           required: true
26376           type: string
26377           example: __NETWORK-ID__
26378         - name: subnet-id
26379           in: path
26380           description: Subnet ID, should be UUID.
26381           required: true
26382           type: string
26383           example: __SUBNET-ID__
26384         - name: resource-version
26385           in: query
26386           description: resource-version for concurrency
26387           required: true
26388           type: string
26389   /network/l3-networks/l3-network/{network-id}/subnets:
26390     get:
26391       tags:
26392         - Network
26393       summary: returns subnets
26394       description: returns subnets
26395       operationId: getNetworkL3NetworksL3NetworkSubnets
26396       produces:
26397         - application/json
26398         - application/xml
26399       responses:
26400         "200":
26401           description: successful operation
26402           schema:
26403               $ref: "#/getDefinitions/subnets"
26404         "default":
26405           description: Response codes found in [response codes](https://wiki.onap.org/).
26406       parameters:
26407         - name: network-id
26408           in: path
26409           description: Network ID, should be uuid. Unique across A&AI.
26410           required: true
26411           type: string
26412           example: __NETWORK-ID__
26413         - name: subnet-id
26414           in: query
26415           description:
26416           required: false
26417           type: string
26418         - name: subnet-name
26419           in: query
26420           description:
26421           required: false
26422           type: string
26423   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26424     put:
26425       tags:
26426         - Network
26427       summary: see node definition for valid relationships
26428       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26429       consumes:
26430         - application/json
26431         - application/xml
26432       produces:
26433         - application/json
26434         - application/xml
26435       responses:
26436         "default":
26437           description: Response codes found in [response codes](https://wiki.onap.org/).
26438       parameters:
26439         - name: network-id
26440           in: path
26441           description: Network ID, should be uuid. Unique across A&AI.
26442           required: true
26443           type: string
26444           example: __NETWORK-ID__
26445         - name: vlan-id-inner
26446           in: path
26447           description: id.
26448           required: true
26449           type: integer
26450           format: int64
26451           example: __VLAN-ID-INNER__
26452         - name: body
26453           in: body
26454           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26455           required: true
26456           schema:
26457             $ref: "#/definitions/relationship"
26458     delete:
26459       tags:
26460         - Network
26461       summary: delete an existing relationship
26462       description: delete an existing relationship
26463       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26464       consumes:
26465         - application/json
26466         - application/xml
26467       produces:
26468         - application/json
26469         - application/xml
26470       responses:
26471         "default":
26472           description: Response codes found in [response codes](https://wiki.onap.org/).
26473       parameters:
26474         - name: network-id
26475           in: path
26476           description: Network ID, should be uuid. Unique across A&AI.
26477           required: true
26478           type: string
26479           example: __NETWORK-ID__
26480         - name: vlan-id-inner
26481           in: path
26482           description: id.
26483           required: true
26484           type: integer
26485           format: int64
26486           example: __VLAN-ID-INNER__
26487   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
26488     get:
26489       tags:
26490         - Network
26491       summary: returns ctag-assignment
26492       description: returns ctag-assignment
26493       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26494       produces:
26495         - application/json
26496         - application/xml
26497       responses:
26498         "200":
26499           description: successful operation
26500           schema:
26501               $ref: "#/getDefinitions/ctag-assignment"
26502         "default":
26503           description: Response codes found in [response codes](https://wiki.onap.org/).
26504       parameters:
26505         - name: network-id
26506           in: path
26507           description: Network ID, should be uuid. Unique across A&AI.
26508           required: true
26509           type: string
26510           example: __NETWORK-ID__
26511         - name: vlan-id-inner
26512           in: path
26513           description: id.
26514           required: true
26515           type: integer
26516           format: int64
26517           example: __VLAN-ID-INNER__
26518     put:
26519       tags:
26520         - Network
26521       summary: create or update an existing ctag-assignment
26522       description: |
26523         Create or update an existing ctag-assignment.
26524         #
26525         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26526       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26527       consumes:
26528         - application/json
26529         - application/xml
26530       produces:
26531         - application/json
26532         - application/xml
26533       responses:
26534         "default":
26535           description: Response codes found in [response codes](https://wiki.onap.org/).
26536       parameters:
26537         - name: network-id
26538           in: path
26539           description: Network ID, should be uuid. Unique across A&AI.
26540           required: true
26541           type: string
26542           example: __NETWORK-ID__
26543         - name: vlan-id-inner
26544           in: path
26545           description: id.
26546           required: true
26547           type: integer
26548           format: int64
26549           example: __VLAN-ID-INNER__
26550         - name: body
26551           in: body
26552           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26553           required: true
26554           schema:
26555             $ref: "#/definitions/ctag-assignment"
26556     patch:
26557       tags:
26558         - Network
26559       summary: update an existing ctag-assignment
26560       description: |
26561         Update an existing ctag-assignment
26562         #
26563         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26564         The PUT operation will entirely replace an existing object.
26565         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26566         #
26567         Other differences between PUT and PATCH are:
26568         #
26569         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26570         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26571         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26572       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26573       consumes:
26574         - application/json
26575         - application/xml
26576       produces:
26577         - application/json
26578         - application/xml
26579       responses:
26580         "default":
26581           description: Response codes found in [response codes](https://wiki.onap.org/).
26582       parameters:
26583         - name: network-id
26584           in: path
26585           description: Network ID, should be uuid. Unique across A&AI.
26586           required: true
26587           type: string
26588           example: __NETWORK-ID__
26589         - name: vlan-id-inner
26590           in: path
26591           description: id.
26592           required: true
26593           type: integer
26594           format: int64
26595           example: __VLAN-ID-INNER__
26596         - name: body
26597           in: body
26598           description: ctag-assignment object that needs to be updated.
26599           required: true
26600           schema:
26601             $ref: "#/patchDefinitions/ctag-assignment"
26602     delete:
26603       tags:
26604         - Network
26605       summary: delete an existing ctag-assignment
26606       description: delete an existing ctag-assignment
26607       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26608       consumes:
26609         - application/json
26610         - application/xml
26611       produces:
26612         - application/json
26613         - application/xml
26614       responses:
26615         "default":
26616           description: Response codes found in [response codes](https://wiki.onap.org/).
26617       parameters:
26618         - name: network-id
26619           in: path
26620           description: Network ID, should be uuid. Unique across A&AI.
26621           required: true
26622           type: string
26623           example: __NETWORK-ID__
26624         - name: vlan-id-inner
26625           in: path
26626           description: id.
26627           required: true
26628           type: integer
26629           format: int64
26630           example: __VLAN-ID-INNER__
26631         - name: resource-version
26632           in: query
26633           description: resource-version for concurrency
26634           required: true
26635           type: string
26636   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
26637     get:
26638       tags:
26639         - Network
26640       summary: returns ctag-assignments
26641       description: returns ctag-assignments
26642       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
26643       produces:
26644         - application/json
26645         - application/xml
26646       responses:
26647         "200":
26648           description: successful operation
26649           schema:
26650               $ref: "#/getDefinitions/ctag-assignments"
26651         "default":
26652           description: Response codes found in [response codes](https://wiki.onap.org/).
26653       parameters:
26654         - name: network-id
26655           in: path
26656           description: Network ID, should be uuid. Unique across A&AI.
26657           required: true
26658           type: string
26659           example: __NETWORK-ID__
26660         - name: vlan-id-inner
26661           in: query
26662           description:
26663           required: false
26664           type: integer
26665           format: int64
26666   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
26667     put:
26668       tags:
26669         - Network
26670       summary: see node definition for valid relationships
26671       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26672       consumes:
26673         - application/json
26674         - application/xml
26675       produces:
26676         - application/json
26677         - application/xml
26678       responses:
26679         "default":
26680           description: Response codes found in [response codes](https://wiki.onap.org/).
26681       parameters:
26682         - name: network-id
26683           in: path
26684           description: Network ID, should be uuid. Unique across A&AI.
26685           required: true
26686           type: string
26687           example: __NETWORK-ID__
26688         - name: segmentation-id
26689           in: path
26690           description: Route Table Reference id, UUID assigned to this instance.
26691           required: true
26692           type: string
26693           example: __SEGMENTATION-ID__
26694         - name: body
26695           in: body
26696           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26697           required: true
26698           schema:
26699             $ref: "#/definitions/relationship"
26700     delete:
26701       tags:
26702         - Network
26703       summary: delete an existing relationship
26704       description: delete an existing relationship
26705       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26706       consumes:
26707         - application/json
26708         - application/xml
26709       produces:
26710         - application/json
26711         - application/xml
26712       responses:
26713         "default":
26714           description: Response codes found in [response codes](https://wiki.onap.org/).
26715       parameters:
26716         - name: network-id
26717           in: path
26718           description: Network ID, should be uuid. Unique across A&AI.
26719           required: true
26720           type: string
26721           example: __NETWORK-ID__
26722         - name: segmentation-id
26723           in: path
26724           description: Route Table Reference id, UUID assigned to this instance.
26725           required: true
26726           type: string
26727           example: __SEGMENTATION-ID__
26728   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
26729     get:
26730       tags:
26731         - Network
26732       summary: returns segmentation-assignment
26733       description: returns segmentation-assignment
26734       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26735       produces:
26736         - application/json
26737         - application/xml
26738       responses:
26739         "200":
26740           description: successful operation
26741           schema:
26742               $ref: "#/getDefinitions/segmentation-assignment"
26743         "default":
26744           description: Response codes found in [response codes](https://wiki.onap.org/).
26745       parameters:
26746         - name: network-id
26747           in: path
26748           description: Network ID, should be uuid. Unique across A&AI.
26749           required: true
26750           type: string
26751           example: __NETWORK-ID__
26752         - name: segmentation-id
26753           in: path
26754           description: Route Table Reference id, UUID assigned to this instance.
26755           required: true
26756           type: string
26757           example: __SEGMENTATION-ID__
26758     put:
26759       tags:
26760         - Network
26761       summary: create or update an existing segmentation-assignment
26762       description: |
26763         Create or update an existing segmentation-assignment.
26764         #
26765         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26766       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
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: network-id
26778           in: path
26779           description: Network ID, should be uuid. Unique across A&AI.
26780           required: true
26781           type: string
26782           example: __NETWORK-ID__
26783         - name: segmentation-id
26784           in: path
26785           description: Route Table Reference id, UUID assigned to this instance.
26786           required: true
26787           type: string
26788           example: __SEGMENTATION-ID__
26789         - name: body
26790           in: body
26791           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26792           required: true
26793           schema:
26794             $ref: "#/definitions/segmentation-assignment"
26795     patch:
26796       tags:
26797         - Network
26798       summary: update an existing segmentation-assignment
26799       description: |
26800         Update an existing segmentation-assignment
26801         #
26802         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26803         The PUT operation will entirely replace an existing object.
26804         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26805         #
26806         Other differences between PUT and PATCH are:
26807         #
26808         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26809         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26810         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26811       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26812       consumes:
26813         - application/json
26814         - application/xml
26815       produces:
26816         - application/json
26817         - application/xml
26818       responses:
26819         "default":
26820           description: Response codes found in [response codes](https://wiki.onap.org/).
26821       parameters:
26822         - name: network-id
26823           in: path
26824           description: Network ID, should be uuid. Unique across A&AI.
26825           required: true
26826           type: string
26827           example: __NETWORK-ID__
26828         - name: segmentation-id
26829           in: path
26830           description: Route Table Reference id, UUID assigned to this instance.
26831           required: true
26832           type: string
26833           example: __SEGMENTATION-ID__
26834         - name: body
26835           in: body
26836           description: segmentation-assignment object that needs to be updated.
26837           required: true
26838           schema:
26839             $ref: "#/patchDefinitions/segmentation-assignment"
26840     delete:
26841       tags:
26842         - Network
26843       summary: delete an existing segmentation-assignment
26844       description: delete an existing segmentation-assignment
26845       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
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: network-id
26857           in: path
26858           description: Network ID, should be uuid. Unique across A&AI.
26859           required: true
26860           type: string
26861           example: __NETWORK-ID__
26862         - name: segmentation-id
26863           in: path
26864           description: Route Table Reference id, UUID assigned to this instance.
26865           required: true
26866           type: string
26867           example: __SEGMENTATION-ID__
26868         - name: resource-version
26869           in: query
26870           description: resource-version for concurrency
26871           required: true
26872           type: string
26873   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
26874     get:
26875       tags:
26876         - Network
26877       summary: returns segmentation-assignments
26878       description: returns segmentation-assignments
26879       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
26880       produces:
26881         - application/json
26882         - application/xml
26883       responses:
26884         "200":
26885           description: successful operation
26886           schema:
26887               $ref: "#/getDefinitions/segmentation-assignments"
26888         "default":
26889           description: Response codes found in [response codes](https://wiki.onap.org/).
26890       parameters:
26891         - name: network-id
26892           in: path
26893           description: Network ID, should be uuid. Unique across A&AI.
26894           required: true
26895           type: string
26896           example: __NETWORK-ID__
26897         - name: segmentation-id
26898           in: query
26899           description:
26900           required: false
26901           type: string
26902   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
26903     put:
26904       tags:
26905         - Network
26906       summary: see node definition for valid relationships
26907       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
26908       consumes:
26909         - application/json
26910         - application/xml
26911       produces:
26912         - application/json
26913         - application/xml
26914       responses:
26915         "default":
26916           description: Response codes found in [response codes](https://wiki.onap.org/).
26917       parameters:
26918         - name: network-id
26919           in: path
26920           description: Network ID, should be uuid. Unique across A&AI.
26921           required: true
26922           type: string
26923           example: __NETWORK-ID__
26924         - name: body
26925           in: body
26926           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
26927           required: true
26928           schema:
26929             $ref: "#/definitions/relationship"
26930     delete:
26931       tags:
26932         - Network
26933       summary: delete an existing relationship
26934       description: delete an existing relationship
26935       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
26936       consumes:
26937         - application/json
26938         - application/xml
26939       produces:
26940         - application/json
26941         - application/xml
26942       responses:
26943         "default":
26944           description: Response codes found in [response codes](https://wiki.onap.org/).
26945       parameters:
26946         - name: network-id
26947           in: path
26948           description: Network ID, should be uuid. Unique across A&AI.
26949           required: true
26950           type: string
26951           example: __NETWORK-ID__
26952   /network/l3-networks/l3-network/{network-id}:
26953     get:
26954       tags:
26955         - Network
26956       summary: returns l3-network
26957       description: returns l3-network
26958       operationId: getNetworkL3NetworksL3Network
26959       produces:
26960         - application/json
26961         - application/xml
26962       responses:
26963         "200":
26964           description: successful operation
26965           schema:
26966               $ref: "#/getDefinitions/l3-network"
26967         "default":
26968           description: Response codes found in [response codes](https://wiki.onap.org/).
26969       parameters:
26970         - name: network-id
26971           in: path
26972           description: Network ID, should be uuid. Unique across A&AI.
26973           required: true
26974           type: string
26975           example: __NETWORK-ID__
26976     put:
26977       tags:
26978         - Network
26979       summary: create or update an existing l3-network
26980       description: |
26981         Create or update an existing l3-network.
26982         #
26983         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26984       operationId: createOrUpdateNetworkL3NetworksL3Network
26985       consumes:
26986         - application/json
26987         - application/xml
26988       produces:
26989         - application/json
26990         - application/xml
26991       responses:
26992         "default":
26993           description: Response codes found in [response codes](https://wiki.onap.org/).
26994       parameters:
26995         - name: network-id
26996           in: path
26997           description: Network ID, should be uuid. Unique across A&AI.
26998           required: true
26999           type: string
27000           example: __NETWORK-ID__
27001         - name: body
27002           in: body
27003           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
27004           required: true
27005           schema:
27006             $ref: "#/definitions/l3-network"
27007     patch:
27008       tags:
27009         - Network
27010       summary: update an existing l3-network
27011       description: |
27012         Update an existing l3-network
27013         #
27014         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27015         The PUT operation will entirely replace an existing object.
27016         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27017         #
27018         Other differences between PUT and PATCH are:
27019         #
27020         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27021         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27022         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27023       operationId: UpdateNetworkL3NetworksL3Network
27024       consumes:
27025         - application/json
27026         - application/xml
27027       produces:
27028         - application/json
27029         - application/xml
27030       responses:
27031         "default":
27032           description: Response codes found in [response codes](https://wiki.onap.org/).
27033       parameters:
27034         - name: network-id
27035           in: path
27036           description: Network ID, should be uuid. Unique across A&AI.
27037           required: true
27038           type: string
27039           example: __NETWORK-ID__
27040         - name: body
27041           in: body
27042           description: l3-network object that needs to be updated.
27043           required: true
27044           schema:
27045             $ref: "#/patchDefinitions/l3-network"
27046     delete:
27047       tags:
27048         - Network
27049       summary: delete an existing l3-network
27050       description: delete an existing l3-network
27051       operationId: deleteNetworkL3NetworksL3Network
27052       consumes:
27053         - application/json
27054         - application/xml
27055       produces:
27056         - application/json
27057         - application/xml
27058       responses:
27059         "default":
27060           description: Response codes found in [response codes](https://wiki.onap.org/).
27061       parameters:
27062         - name: network-id
27063           in: path
27064           description: Network ID, should be uuid. Unique across A&AI.
27065           required: true
27066           type: string
27067           example: __NETWORK-ID__
27068         - name: resource-version
27069           in: query
27070           description: resource-version for concurrency
27071           required: true
27072           type: string
27073   /network/l3-networks:
27074     get:
27075       tags:
27076         - Network
27077       summary: returns l3-networks
27078       description: returns l3-networks
27079       operationId: getNetworkL3Networks
27080       produces:
27081         - application/json
27082         - application/xml
27083       responses:
27084         "200":
27085           description: successful operation
27086           schema:
27087               $ref: "#/getDefinitions/l3-networks"
27088         "default":
27089           description: Response codes found in [response codes](https://wiki.onap.org/).
27090       parameters:
27091         - name: network-id
27092           in: query
27093           description:
27094           required: false
27095           type: string
27096         - name: network-name
27097           in: query
27098           description:
27099           required: false
27100           type: string
27101         - name: network-role
27102           in: query
27103           description:
27104           required: false
27105           type: string
27106         - name: service-id
27107           in: query
27108           description:
27109           required: false
27110           type: string
27111         - name: heat-stack-id
27112           in: query
27113           description:
27114           required: false
27115           type: string
27116         - name: contrail-network-fqdn
27117           in: query
27118           description:
27119           required: false
27120           type: string
27121         - name: model-invariant-id
27122           in: query
27123           description:
27124           required: false
27125           type: string
27126         - name: model-version-id
27127           in: query
27128           description:
27129           required: false
27130           type: string
27131         - name: widget-model-id
27132           in: query
27133           description:
27134           required: false
27135           type: string
27136         - name: widget-model-version
27137           in: query
27138           description:
27139           required: false
27140           type: string
27141   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
27142     put:
27143       tags:
27144         - Network
27145       summary: see node definition for valid relationships
27146       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27147       consumes:
27148         - application/json
27149         - application/xml
27150       produces:
27151         - application/json
27152         - application/xml
27153       responses:
27154         "default":
27155           description: Response codes found in [response codes](https://wiki.onap.org/).
27156       parameters:
27157         - name: network-policy-id
27158           in: path
27159           description: UUID representing unique key to this instance
27160           required: true
27161           type: string
27162           example: __NETWORK-POLICY-ID__
27163         - name: body
27164           in: body
27165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
27166           required: true
27167           schema:
27168             $ref: "#/definitions/relationship"
27169     delete:
27170       tags:
27171         - Network
27172       summary: delete an existing relationship
27173       description: delete an existing relationship
27174       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27175       consumes:
27176         - application/json
27177         - application/xml
27178       produces:
27179         - application/json
27180         - application/xml
27181       responses:
27182         "default":
27183           description: Response codes found in [response codes](https://wiki.onap.org/).
27184       parameters:
27185         - name: network-policy-id
27186           in: path
27187           description: UUID representing unique key to this instance
27188           required: true
27189           type: string
27190           example: __NETWORK-POLICY-ID__
27191   /network/network-policies/network-policy/{network-policy-id}:
27192     get:
27193       tags:
27194         - Network
27195       summary: returns network-policy
27196       description: returns network-policy
27197       operationId: getNetworkNetworkPoliciesNetworkPolicy
27198       produces:
27199         - application/json
27200         - application/xml
27201       responses:
27202         "200":
27203           description: successful operation
27204           schema:
27205               $ref: "#/getDefinitions/network-policy"
27206         "default":
27207           description: Response codes found in [response codes](https://wiki.onap.org/).
27208       parameters:
27209         - name: network-policy-id
27210           in: path
27211           description: UUID representing unique key to this instance
27212           required: true
27213           type: string
27214           example: __NETWORK-POLICY-ID__
27215     put:
27216       tags:
27217         - Network
27218       summary: create or update an existing network-policy
27219       description: |
27220         Create or update an existing network-policy.
27221         #
27222         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27223       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
27224       consumes:
27225         - application/json
27226         - application/xml
27227       produces:
27228         - application/json
27229         - application/xml
27230       responses:
27231         "default":
27232           description: Response codes found in [response codes](https://wiki.onap.org/).
27233       parameters:
27234         - name: network-policy-id
27235           in: path
27236           description: UUID representing unique key to this instance
27237           required: true
27238           type: string
27239           example: __NETWORK-POLICY-ID__
27240         - name: body
27241           in: body
27242           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
27243           required: true
27244           schema:
27245             $ref: "#/definitions/network-policy"
27246     patch:
27247       tags:
27248         - Network
27249       summary: update an existing network-policy
27250       description: |
27251         Update an existing network-policy
27252         #
27253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27254         The PUT operation will entirely replace an existing object.
27255         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27256         #
27257         Other differences between PUT and PATCH are:
27258         #
27259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27262       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
27263       consumes:
27264         - application/json
27265         - application/xml
27266       produces:
27267         - application/json
27268         - application/xml
27269       responses:
27270         "default":
27271           description: Response codes found in [response codes](https://wiki.onap.org/).
27272       parameters:
27273         - name: network-policy-id
27274           in: path
27275           description: UUID representing unique key to this instance
27276           required: true
27277           type: string
27278           example: __NETWORK-POLICY-ID__
27279         - name: body
27280           in: body
27281           description: network-policy object that needs to be updated.
27282           required: true
27283           schema:
27284             $ref: "#/patchDefinitions/network-policy"
27285     delete:
27286       tags:
27287         - Network
27288       summary: delete an existing network-policy
27289       description: delete an existing network-policy
27290       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27291       consumes:
27292         - application/json
27293         - application/xml
27294       produces:
27295         - application/json
27296         - application/xml
27297       responses:
27298         "default":
27299           description: Response codes found in [response codes](https://wiki.onap.org/).
27300       parameters:
27301         - name: network-policy-id
27302           in: path
27303           description: UUID representing unique key to this instance
27304           required: true
27305           type: string
27306           example: __NETWORK-POLICY-ID__
27307         - name: resource-version
27308           in: query
27309           description: resource-version for concurrency
27310           required: true
27311           type: string
27312   /network/network-policies:
27313     get:
27314       tags:
27315         - Network
27316       summary: returns network-policies
27317       description: returns network-policies
27318       operationId: getNetworkNetworkPolicies
27319       produces:
27320         - application/json
27321         - application/xml
27322       responses:
27323         "200":
27324           description: successful operation
27325           schema:
27326               $ref: "#/getDefinitions/network-policies"
27327         "default":
27328           description: Response codes found in [response codes](https://wiki.onap.org/).
27329       parameters:
27330         - name: network-policy-id
27331           in: query
27332           description:
27333           required: false
27334           type: string
27335         - name: network-policy-fqdn
27336           in: query
27337           description:
27338           required: false
27339           type: string
27340   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27341     put:
27342       tags:
27343         - Network
27344       summary: see node definition for valid relationships
27345       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
27346       consumes:
27347         - application/json
27348         - application/xml
27349       produces:
27350         - application/json
27351         - application/xml
27352       responses:
27353         "default":
27354           description: Response codes found in [response codes](https://wiki.onap.org/).
27355       parameters:
27356         - name: vnf-id
27357           in: path
27358           description: Unique id of VNF.  This is unique across the graph.
27359           required: true
27360           type: string
27361           example: __VNF-ID__
27362         - name: body
27363           in: body
27364           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
27365           required: true
27366           schema:
27367             $ref: "#/definitions/relationship"
27368     delete:
27369       tags:
27370         - Network
27371       summary: delete an existing relationship
27372       description: delete an existing relationship
27373       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
27374       consumes:
27375         - application/json
27376         - application/xml
27377       produces:
27378         - application/json
27379         - application/xml
27380       responses:
27381         "default":
27382           description: Response codes found in [response codes](https://wiki.onap.org/).
27383       parameters:
27384         - name: vnf-id
27385           in: path
27386           description: Unique id of VNF.  This is unique across the graph.
27387           required: true
27388           type: string
27389           example: __VNF-ID__
27390   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
27391     put:
27392       tags:
27393         - Network
27394       summary: see node definition for valid relationships
27395       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27396       consumes:
27397         - application/json
27398         - application/xml
27399       produces:
27400         - application/json
27401         - application/xml
27402       responses:
27403         "default":
27404           description: Response codes found in [response codes](https://wiki.onap.org/).
27405       parameters:
27406         - name: vnf-id
27407           in: path
27408           description: Unique id of VNF.  This is unique across the graph.
27409           required: true
27410           type: string
27411           example: __VNF-ID__
27412         - name: interface-name
27413           in: path
27414           description: Name given to the interface
27415           required: true
27416           type: string
27417           example: __INTERFACE-NAME__
27418         - name: vlan-interface
27419           in: path
27420           description: String that identifies the interface
27421           required: true
27422           type: string
27423           example: __VLAN-INTERFACE__
27424         - name: body
27425           in: body
27426           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27427           required: true
27428           schema:
27429             $ref: "#/definitions/relationship"
27430     delete:
27431       tags:
27432         - Network
27433       summary: delete an existing relationship
27434       description: delete an existing relationship
27435       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27436       consumes:
27437         - application/json
27438         - application/xml
27439       produces:
27440         - application/json
27441         - application/xml
27442       responses:
27443         "default":
27444           description: Response codes found in [response codes](https://wiki.onap.org/).
27445       parameters:
27446         - name: vnf-id
27447           in: path
27448           description: Unique id of VNF.  This is unique across the graph.
27449           required: true
27450           type: string
27451           example: __VNF-ID__
27452         - name: interface-name
27453           in: path
27454           description: Name given to the interface
27455           required: true
27456           type: string
27457           example: __INTERFACE-NAME__
27458         - name: vlan-interface
27459           in: path
27460           description: String that identifies the interface
27461           required: true
27462           type: string
27463           example: __VLAN-INTERFACE__
27464   /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:
27465     put:
27466       tags:
27467         - Network
27468       summary: see node definition for valid relationships
27469       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27470       consumes:
27471         - application/json
27472         - application/xml
27473       produces:
27474         - application/json
27475         - application/xml
27476       responses:
27477         "default":
27478           description: Response codes found in [response codes](https://wiki.onap.org/).
27479       parameters:
27480         - name: vnf-id
27481           in: path
27482           description: Unique id of VNF.  This is unique across the graph.
27483           required: true
27484           type: string
27485           example: __VNF-ID__
27486         - name: interface-name
27487           in: path
27488           description: Name given to the interface
27489           required: true
27490           type: string
27491           example: __INTERFACE-NAME__
27492         - name: vlan-interface
27493           in: path
27494           description: String that identifies the interface
27495           required: true
27496           type: string
27497           example: __VLAN-INTERFACE__
27498         - name: l3-interface-ipv4-address
27499           in: path
27500           description: IP address
27501           required: true
27502           type: string
27503           example: __L3-INTERFACE-IPV4-ADDRESS__
27504         - name: body
27505           in: body
27506           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27507           required: true
27508           schema:
27509             $ref: "#/definitions/relationship"
27510     delete:
27511       tags:
27512         - Network
27513       summary: delete an existing relationship
27514       description: delete an existing relationship
27515       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27516       consumes:
27517         - application/json
27518         - application/xml
27519       produces:
27520         - application/json
27521         - application/xml
27522       responses:
27523         "default":
27524           description: Response codes found in [response codes](https://wiki.onap.org/).
27525       parameters:
27526         - name: vnf-id
27527           in: path
27528           description: Unique id of VNF.  This is unique across the graph.
27529           required: true
27530           type: string
27531           example: __VNF-ID__
27532         - name: interface-name
27533           in: path
27534           description: Name given to the interface
27535           required: true
27536           type: string
27537           example: __INTERFACE-NAME__
27538         - name: vlan-interface
27539           in: path
27540           description: String that identifies the interface
27541           required: true
27542           type: string
27543           example: __VLAN-INTERFACE__
27544         - name: l3-interface-ipv4-address
27545           in: path
27546           description: IP address
27547           required: true
27548           type: string
27549           example: __L3-INTERFACE-IPV4-ADDRESS__
27550   /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}:
27551     get:
27552       tags:
27553         - Network
27554       summary: returns l3-interface-ipv4-address-list
27555       description: returns l3-interface-ipv4-address-list
27556       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27557       produces:
27558         - application/json
27559         - application/xml
27560       responses:
27561         "200":
27562           description: successful operation
27563           schema:
27564               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27565         "default":
27566           description: Response codes found in [response codes](https://wiki.onap.org/).
27567       parameters:
27568         - name: vnf-id
27569           in: path
27570           description: Unique id of VNF.  This is unique across the graph.
27571           required: true
27572           type: string
27573           example: __VNF-ID__
27574         - name: interface-name
27575           in: path
27576           description: Name given to the interface
27577           required: true
27578           type: string
27579           example: __INTERFACE-NAME__
27580         - name: vlan-interface
27581           in: path
27582           description: String that identifies the interface
27583           required: true
27584           type: string
27585           example: __VLAN-INTERFACE__
27586         - name: l3-interface-ipv4-address
27587           in: path
27588           description: IP address
27589           required: true
27590           type: string
27591           example: __L3-INTERFACE-IPV4-ADDRESS__
27592     put:
27593       tags:
27594         - Network
27595       summary: create or update an existing l3-interface-ipv4-address-list
27596       description: |
27597         Create or update an existing l3-interface-ipv4-address-list.
27598         #
27599         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27600       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27601       consumes:
27602         - application/json
27603         - application/xml
27604       produces:
27605         - application/json
27606         - application/xml
27607       responses:
27608         "default":
27609           description: Response codes found in [response codes](https://wiki.onap.org/).
27610       parameters:
27611         - name: vnf-id
27612           in: path
27613           description: Unique id of VNF.  This is unique across the graph.
27614           required: true
27615           type: string
27616           example: __VNF-ID__
27617         - name: interface-name
27618           in: path
27619           description: Name given to the interface
27620           required: true
27621           type: string
27622           example: __INTERFACE-NAME__
27623         - name: vlan-interface
27624           in: path
27625           description: String that identifies the interface
27626           required: true
27627           type: string
27628           example: __VLAN-INTERFACE__
27629         - name: l3-interface-ipv4-address
27630           in: path
27631           description: IP address
27632           required: true
27633           type: string
27634           example: __L3-INTERFACE-IPV4-ADDRESS__
27635         - name: body
27636           in: body
27637           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27638           required: true
27639           schema:
27640             $ref: "#/definitions/l3-interface-ipv4-address-list"
27641     patch:
27642       tags:
27643         - Network
27644       summary: update an existing l3-interface-ipv4-address-list
27645       description: |
27646         Update an existing l3-interface-ipv4-address-list
27647         #
27648         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27649         The PUT operation will entirely replace an existing object.
27650         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27651         #
27652         Other differences between PUT and PATCH are:
27653         #
27654         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27655         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27656         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27657       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27658       consumes:
27659         - application/json
27660         - application/xml
27661       produces:
27662         - application/json
27663         - application/xml
27664       responses:
27665         "default":
27666           description: Response codes found in [response codes](https://wiki.onap.org/).
27667       parameters:
27668         - name: vnf-id
27669           in: path
27670           description: Unique id of VNF.  This is unique across the graph.
27671           required: true
27672           type: string
27673           example: __VNF-ID__
27674         - name: interface-name
27675           in: path
27676           description: Name given to the interface
27677           required: true
27678           type: string
27679           example: __INTERFACE-NAME__
27680         - name: vlan-interface
27681           in: path
27682           description: String that identifies the interface
27683           required: true
27684           type: string
27685           example: __VLAN-INTERFACE__
27686         - name: l3-interface-ipv4-address
27687           in: path
27688           description: IP address
27689           required: true
27690           type: string
27691           example: __L3-INTERFACE-IPV4-ADDRESS__
27692         - name: body
27693           in: body
27694           description: l3-interface-ipv4-address-list object that needs to be updated.
27695           required: true
27696           schema:
27697             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27698     delete:
27699       tags:
27700         - Network
27701       summary: delete an existing l3-interface-ipv4-address-list
27702       description: delete an existing l3-interface-ipv4-address-list
27703       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27704       consumes:
27705         - application/json
27706         - application/xml
27707       produces:
27708         - application/json
27709         - application/xml
27710       responses:
27711         "default":
27712           description: Response codes found in [response codes](https://wiki.onap.org/).
27713       parameters:
27714         - name: vnf-id
27715           in: path
27716           description: Unique id of VNF.  This is unique across the graph.
27717           required: true
27718           type: string
27719           example: __VNF-ID__
27720         - name: interface-name
27721           in: path
27722           description: Name given to the interface
27723           required: true
27724           type: string
27725           example: __INTERFACE-NAME__
27726         - name: vlan-interface
27727           in: path
27728           description: String that identifies the interface
27729           required: true
27730           type: string
27731           example: __VLAN-INTERFACE__
27732         - name: l3-interface-ipv4-address
27733           in: path
27734           description: IP address
27735           required: true
27736           type: string
27737           example: __L3-INTERFACE-IPV4-ADDRESS__
27738         - name: resource-version
27739           in: query
27740           description: resource-version for concurrency
27741           required: true
27742           type: string
27743   /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:
27744     put:
27745       tags:
27746         - Network
27747       summary: see node definition for valid relationships
27748       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27749       consumes:
27750         - application/json
27751         - application/xml
27752       produces:
27753         - application/json
27754         - application/xml
27755       responses:
27756         "default":
27757           description: Response codes found in [response codes](https://wiki.onap.org/).
27758       parameters:
27759         - name: vnf-id
27760           in: path
27761           description: Unique id of VNF.  This is unique across the graph.
27762           required: true
27763           type: string
27764           example: __VNF-ID__
27765         - name: interface-name
27766           in: path
27767           description: Name given to the interface
27768           required: true
27769           type: string
27770           example: __INTERFACE-NAME__
27771         - name: vlan-interface
27772           in: path
27773           description: String that identifies the interface
27774           required: true
27775           type: string
27776           example: __VLAN-INTERFACE__
27777         - name: l3-interface-ipv6-address
27778           in: path
27779           description: IP address
27780           required: true
27781           type: string
27782           example: __L3-INTERFACE-IPV6-ADDRESS__
27783         - name: body
27784           in: body
27785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27786           required: true
27787           schema:
27788             $ref: "#/definitions/relationship"
27789     delete:
27790       tags:
27791         - Network
27792       summary: delete an existing relationship
27793       description: delete an existing relationship
27794       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27795       consumes:
27796         - application/json
27797         - application/xml
27798       produces:
27799         - application/json
27800         - application/xml
27801       responses:
27802         "default":
27803           description: Response codes found in [response codes](https://wiki.onap.org/).
27804       parameters:
27805         - name: vnf-id
27806           in: path
27807           description: Unique id of VNF.  This is unique across the graph.
27808           required: true
27809           type: string
27810           example: __VNF-ID__
27811         - name: interface-name
27812           in: path
27813           description: Name given to the interface
27814           required: true
27815           type: string
27816           example: __INTERFACE-NAME__
27817         - name: vlan-interface
27818           in: path
27819           description: String that identifies the interface
27820           required: true
27821           type: string
27822           example: __VLAN-INTERFACE__
27823         - name: l3-interface-ipv6-address
27824           in: path
27825           description: IP address
27826           required: true
27827           type: string
27828           example: __L3-INTERFACE-IPV6-ADDRESS__
27829   /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}:
27830     get:
27831       tags:
27832         - Network
27833       summary: returns l3-interface-ipv6-address-list
27834       description: returns l3-interface-ipv6-address-list
27835       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27836       produces:
27837         - application/json
27838         - application/xml
27839       responses:
27840         "200":
27841           description: successful operation
27842           schema:
27843               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27844         "default":
27845           description: Response codes found in [response codes](https://wiki.onap.org/).
27846       parameters:
27847         - name: vnf-id
27848           in: path
27849           description: Unique id of VNF.  This is unique across the graph.
27850           required: true
27851           type: string
27852           example: __VNF-ID__
27853         - name: interface-name
27854           in: path
27855           description: Name given to the interface
27856           required: true
27857           type: string
27858           example: __INTERFACE-NAME__
27859         - name: vlan-interface
27860           in: path
27861           description: String that identifies the interface
27862           required: true
27863           type: string
27864           example: __VLAN-INTERFACE__
27865         - name: l3-interface-ipv6-address
27866           in: path
27867           description: IP address
27868           required: true
27869           type: string
27870           example: __L3-INTERFACE-IPV6-ADDRESS__
27871     put:
27872       tags:
27873         - Network
27874       summary: create or update an existing l3-interface-ipv6-address-list
27875       description: |
27876         Create or update an existing l3-interface-ipv6-address-list.
27877         #
27878         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27879       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27880       consumes:
27881         - application/json
27882         - application/xml
27883       produces:
27884         - application/json
27885         - application/xml
27886       responses:
27887         "default":
27888           description: Response codes found in [response codes](https://wiki.onap.org/).
27889       parameters:
27890         - name: vnf-id
27891           in: path
27892           description: Unique id of VNF.  This is unique across the graph.
27893           required: true
27894           type: string
27895           example: __VNF-ID__
27896         - name: interface-name
27897           in: path
27898           description: Name given to the interface
27899           required: true
27900           type: string
27901           example: __INTERFACE-NAME__
27902         - name: vlan-interface
27903           in: path
27904           description: String that identifies the interface
27905           required: true
27906           type: string
27907           example: __VLAN-INTERFACE__
27908         - name: l3-interface-ipv6-address
27909           in: path
27910           description: IP address
27911           required: true
27912           type: string
27913           example: __L3-INTERFACE-IPV6-ADDRESS__
27914         - name: body
27915           in: body
27916           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27917           required: true
27918           schema:
27919             $ref: "#/definitions/l3-interface-ipv6-address-list"
27920     patch:
27921       tags:
27922         - Network
27923       summary: update an existing l3-interface-ipv6-address-list
27924       description: |
27925         Update an existing l3-interface-ipv6-address-list
27926         #
27927         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27928         The PUT operation will entirely replace an existing object.
27929         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27930         #
27931         Other differences between PUT and PATCH are:
27932         #
27933         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27934         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27935         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27936       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27937       consumes:
27938         - application/json
27939         - application/xml
27940       produces:
27941         - application/json
27942         - application/xml
27943       responses:
27944         "default":
27945           description: Response codes found in [response codes](https://wiki.onap.org/).
27946       parameters:
27947         - name: vnf-id
27948           in: path
27949           description: Unique id of VNF.  This is unique across the graph.
27950           required: true
27951           type: string
27952           example: __VNF-ID__
27953         - name: interface-name
27954           in: path
27955           description: Name given to the interface
27956           required: true
27957           type: string
27958           example: __INTERFACE-NAME__
27959         - name: vlan-interface
27960           in: path
27961           description: String that identifies the interface
27962           required: true
27963           type: string
27964           example: __VLAN-INTERFACE__
27965         - name: l3-interface-ipv6-address
27966           in: path
27967           description: IP address
27968           required: true
27969           type: string
27970           example: __L3-INTERFACE-IPV6-ADDRESS__
27971         - name: body
27972           in: body
27973           description: l3-interface-ipv6-address-list object that needs to be updated.
27974           required: true
27975           schema:
27976             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27977     delete:
27978       tags:
27979         - Network
27980       summary: delete an existing l3-interface-ipv6-address-list
27981       description: delete an existing l3-interface-ipv6-address-list
27982       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27983       consumes:
27984         - application/json
27985         - application/xml
27986       produces:
27987         - application/json
27988         - application/xml
27989       responses:
27990         "default":
27991           description: Response codes found in [response codes](https://wiki.onap.org/).
27992       parameters:
27993         - name: vnf-id
27994           in: path
27995           description: Unique id of VNF.  This is unique across the graph.
27996           required: true
27997           type: string
27998           example: __VNF-ID__
27999         - name: interface-name
28000           in: path
28001           description: Name given to the interface
28002           required: true
28003           type: string
28004           example: __INTERFACE-NAME__
28005         - name: vlan-interface
28006           in: path
28007           description: String that identifies the interface
28008           required: true
28009           type: string
28010           example: __VLAN-INTERFACE__
28011         - name: l3-interface-ipv6-address
28012           in: path
28013           description: IP address
28014           required: true
28015           type: string
28016           example: __L3-INTERFACE-IPV6-ADDRESS__
28017         - name: resource-version
28018           in: query
28019           description: resource-version for concurrency
28020           required: true
28021           type: string
28022   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28023     get:
28024       tags:
28025         - Network
28026       summary: returns vlan
28027       description: returns vlan
28028       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28029       produces:
28030         - application/json
28031         - application/xml
28032       responses:
28033         "200":
28034           description: successful operation
28035           schema:
28036               $ref: "#/getDefinitions/vlan"
28037         "default":
28038           description: Response codes found in [response codes](https://wiki.onap.org/).
28039       parameters:
28040         - name: vnf-id
28041           in: path
28042           description: Unique id of VNF.  This is unique across the graph.
28043           required: true
28044           type: string
28045           example: __VNF-ID__
28046         - name: interface-name
28047           in: path
28048           description: Name given to the interface
28049           required: true
28050           type: string
28051           example: __INTERFACE-NAME__
28052         - name: vlan-interface
28053           in: path
28054           description: String that identifies the interface
28055           required: true
28056           type: string
28057           example: __VLAN-INTERFACE__
28058     put:
28059       tags:
28060         - Network
28061       summary: create or update an existing vlan
28062       description: |
28063         Create or update an existing vlan.
28064         #
28065         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28066       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28067       consumes:
28068         - application/json
28069         - application/xml
28070       produces:
28071         - application/json
28072         - application/xml
28073       responses:
28074         "default":
28075           description: Response codes found in [response codes](https://wiki.onap.org/).
28076       parameters:
28077         - name: vnf-id
28078           in: path
28079           description: Unique id of VNF.  This is unique across the graph.
28080           required: true
28081           type: string
28082           example: __VNF-ID__
28083         - name: interface-name
28084           in: path
28085           description: Name given to the interface
28086           required: true
28087           type: string
28088           example: __INTERFACE-NAME__
28089         - name: vlan-interface
28090           in: path
28091           description: String that identifies the interface
28092           required: true
28093           type: string
28094           example: __VLAN-INTERFACE__
28095         - name: body
28096           in: body
28097           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
28098           required: true
28099           schema:
28100             $ref: "#/definitions/vlan"
28101     patch:
28102       tags:
28103         - Network
28104       summary: update an existing vlan
28105       description: |
28106         Update an existing vlan
28107         #
28108         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28109         The PUT operation will entirely replace an existing object.
28110         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28111         #
28112         Other differences between PUT and PATCH are:
28113         #
28114         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28115         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28116         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28117       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28118       consumes:
28119         - application/json
28120         - application/xml
28121       produces:
28122         - application/json
28123         - application/xml
28124       responses:
28125         "default":
28126           description: Response codes found in [response codes](https://wiki.onap.org/).
28127       parameters:
28128         - name: vnf-id
28129           in: path
28130           description: Unique id of VNF.  This is unique across the graph.
28131           required: true
28132           type: string
28133           example: __VNF-ID__
28134         - name: interface-name
28135           in: path
28136           description: Name given to the interface
28137           required: true
28138           type: string
28139           example: __INTERFACE-NAME__
28140         - name: vlan-interface
28141           in: path
28142           description: String that identifies the interface
28143           required: true
28144           type: string
28145           example: __VLAN-INTERFACE__
28146         - name: body
28147           in: body
28148           description: vlan object that needs to be updated.
28149           required: true
28150           schema:
28151             $ref: "#/patchDefinitions/vlan"
28152     delete:
28153       tags:
28154         - Network
28155       summary: delete an existing vlan
28156       description: delete an existing vlan
28157       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
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 given to the interface
28177           required: true
28178           type: string
28179           example: __INTERFACE-NAME__
28180         - name: vlan-interface
28181           in: path
28182           description: String that identifies the interface
28183           required: true
28184           type: string
28185           example: __VLAN-INTERFACE__
28186         - name: resource-version
28187           in: query
28188           description: resource-version for concurrency
28189           required: true
28190           type: string
28191   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
28192     get:
28193       tags:
28194         - Network
28195       summary: returns vlans
28196       description: returns vlans
28197       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
28198       produces:
28199         - application/json
28200         - application/xml
28201       responses:
28202         "200":
28203           description: successful operation
28204           schema:
28205               $ref: "#/getDefinitions/vlans"
28206         "default":
28207           description: Response codes found in [response codes](https://wiki.onap.org/).
28208       parameters:
28209         - name: vnf-id
28210           in: path
28211           description: Unique id of VNF.  This is unique across the graph.
28212           required: true
28213           type: string
28214           example: __VNF-ID__
28215         - name: interface-name
28216           in: path
28217           description: Name given to the interface
28218           required: true
28219           type: string
28220           example: __INTERFACE-NAME__
28221         - name: vlan-interface
28222           in: query
28223           description:
28224           required: false
28225           type: string
28226         - name: vlan-id-inner
28227           in: query
28228           description:
28229           required: false
28230           type: integer
28231           format: int64
28232         - name: vpn-id
28233           in: query
28234           description:
28235           required: false
28236           type: string
28237   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
28238     put:
28239       tags:
28240         - Network
28241       summary: see node definition for valid relationships
28242       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28243       consumes:
28244         - application/json
28245         - application/xml
28246       produces:
28247         - application/json
28248         - application/xml
28249       responses:
28250         "default":
28251           description: Response codes found in [response codes](https://wiki.onap.org/).
28252       parameters:
28253         - name: vnf-id
28254           in: path
28255           description: Unique id of VNF.  This is unique across the graph.
28256           required: true
28257           type: string
28258           example: __VNF-ID__
28259         - name: interface-name
28260           in: path
28261           description: Name given to the interface
28262           required: true
28263           type: string
28264           example: __INTERFACE-NAME__
28265         - name: pci-id
28266           in: path
28267           description: PCI ID used to identify the sriov-vf
28268           required: true
28269           type: string
28270           example: __PCI-ID__
28271         - name: body
28272           in: body
28273           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28274           required: true
28275           schema:
28276             $ref: "#/definitions/relationship"
28277     delete:
28278       tags:
28279         - Network
28280       summary: delete an existing relationship
28281       description: delete an existing relationship
28282       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28283       consumes:
28284         - application/json
28285         - application/xml
28286       produces:
28287         - application/json
28288         - application/xml
28289       responses:
28290         "default":
28291           description: Response codes found in [response codes](https://wiki.onap.org/).
28292       parameters:
28293         - name: vnf-id
28294           in: path
28295           description: Unique id of VNF.  This is unique across the graph.
28296           required: true
28297           type: string
28298           example: __VNF-ID__
28299         - name: interface-name
28300           in: path
28301           description: Name given to the interface
28302           required: true
28303           type: string
28304           example: __INTERFACE-NAME__
28305         - name: pci-id
28306           in: path
28307           description: PCI ID used to identify the sriov-vf
28308           required: true
28309           type: string
28310           example: __PCI-ID__
28311   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
28312     get:
28313       tags:
28314         - Network
28315       summary: returns sriov-vf
28316       description: returns sriov-vf
28317       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28318       produces:
28319         - application/json
28320         - application/xml
28321       responses:
28322         "200":
28323           description: successful operation
28324           schema:
28325               $ref: "#/getDefinitions/sriov-vf"
28326         "default":
28327           description: Response codes found in [response codes](https://wiki.onap.org/).
28328       parameters:
28329         - name: vnf-id
28330           in: path
28331           description: Unique id of VNF.  This is unique across the graph.
28332           required: true
28333           type: string
28334           example: __VNF-ID__
28335         - name: interface-name
28336           in: path
28337           description: Name given to the interface
28338           required: true
28339           type: string
28340           example: __INTERFACE-NAME__
28341         - name: pci-id
28342           in: path
28343           description: PCI ID used to identify the sriov-vf
28344           required: true
28345           type: string
28346           example: __PCI-ID__
28347     put:
28348       tags:
28349         - Network
28350       summary: create or update an existing sriov-vf
28351       description: |
28352         Create or update an existing sriov-vf.
28353         #
28354         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28355       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28356       consumes:
28357         - application/json
28358         - application/xml
28359       produces:
28360         - application/json
28361         - application/xml
28362       responses:
28363         "default":
28364           description: Response codes found in [response codes](https://wiki.onap.org/).
28365       parameters:
28366         - name: vnf-id
28367           in: path
28368           description: Unique id of VNF.  This is unique across the graph.
28369           required: true
28370           type: string
28371           example: __VNF-ID__
28372         - name: interface-name
28373           in: path
28374           description: Name given to the interface
28375           required: true
28376           type: string
28377           example: __INTERFACE-NAME__
28378         - name: pci-id
28379           in: path
28380           description: PCI ID used to identify the sriov-vf
28381           required: true
28382           type: string
28383           example: __PCI-ID__
28384         - name: body
28385           in: body
28386           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28387           required: true
28388           schema:
28389             $ref: "#/definitions/sriov-vf"
28390     patch:
28391       tags:
28392         - Network
28393       summary: update an existing sriov-vf
28394       description: |
28395         Update an existing sriov-vf
28396         #
28397         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28398         The PUT operation will entirely replace an existing object.
28399         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28400         #
28401         Other differences between PUT and PATCH are:
28402         #
28403         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28404         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28405         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28406       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28407       consumes:
28408         - application/json
28409         - application/xml
28410       produces:
28411         - application/json
28412         - application/xml
28413       responses:
28414         "default":
28415           description: Response codes found in [response codes](https://wiki.onap.org/).
28416       parameters:
28417         - name: vnf-id
28418           in: path
28419           description: Unique id of VNF.  This is unique across the graph.
28420           required: true
28421           type: string
28422           example: __VNF-ID__
28423         - name: interface-name
28424           in: path
28425           description: Name given to the interface
28426           required: true
28427           type: string
28428           example: __INTERFACE-NAME__
28429         - name: pci-id
28430           in: path
28431           description: PCI ID used to identify the sriov-vf
28432           required: true
28433           type: string
28434           example: __PCI-ID__
28435         - name: body
28436           in: body
28437           description: sriov-vf object that needs to be updated.
28438           required: true
28439           schema:
28440             $ref: "#/patchDefinitions/sriov-vf"
28441     delete:
28442       tags:
28443         - Network
28444       summary: delete an existing sriov-vf
28445       description: delete an existing sriov-vf
28446       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28447       consumes:
28448         - application/json
28449         - application/xml
28450       produces:
28451         - application/json
28452         - application/xml
28453       responses:
28454         "default":
28455           description: Response codes found in [response codes](https://wiki.onap.org/).
28456       parameters:
28457         - name: vnf-id
28458           in: path
28459           description: Unique id of VNF.  This is unique across the graph.
28460           required: true
28461           type: string
28462           example: __VNF-ID__
28463         - name: interface-name
28464           in: path
28465           description: Name given to the interface
28466           required: true
28467           type: string
28468           example: __INTERFACE-NAME__
28469         - name: pci-id
28470           in: path
28471           description: PCI ID used to identify the sriov-vf
28472           required: true
28473           type: string
28474           example: __PCI-ID__
28475         - name: resource-version
28476           in: query
28477           description: resource-version for concurrency
28478           required: true
28479           type: string
28480   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28481     get:
28482       tags:
28483         - Network
28484       summary: returns sriov-vfs
28485       description: returns sriov-vfs
28486       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
28487       produces:
28488         - application/json
28489         - application/xml
28490       responses:
28491         "200":
28492           description: successful operation
28493           schema:
28494               $ref: "#/getDefinitions/sriov-vfs"
28495         "default":
28496           description: Response codes found in [response codes](https://wiki.onap.org/).
28497       parameters:
28498         - name: vnf-id
28499           in: path
28500           description: Unique id of VNF.  This is unique across the graph.
28501           required: true
28502           type: string
28503           example: __VNF-ID__
28504         - name: interface-name
28505           in: path
28506           description: Name given to the interface
28507           required: true
28508           type: string
28509           example: __INTERFACE-NAME__
28510         - name: pci-id
28511           in: query
28512           description:
28513           required: false
28514           type: string
28515         - name: vf-vlan-filter
28516           in: query
28517           description:
28518           required: false
28519           type: string
28520         - name: vf-mac-filter
28521           in: query
28522           description:
28523           required: false
28524           type: string
28525         - name: vf-vlan-strip
28526           in: query
28527           description:
28528           required: false
28529           type: boolean
28530         - name: neutron-network-id
28531           in: query
28532           description:
28533           required: false
28534           type: string
28535   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28536     put:
28537       tags:
28538         - Network
28539       summary: see node definition for valid relationships
28540       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28541       consumes:
28542         - application/json
28543         - application/xml
28544       produces:
28545         - application/json
28546         - application/xml
28547       responses:
28548         "default":
28549           description: Response codes found in [response codes](https://wiki.onap.org/).
28550       parameters:
28551         - name: vnf-id
28552           in: path
28553           description: Unique id of VNF.  This is unique across the graph.
28554           required: true
28555           type: string
28556           example: __VNF-ID__
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: body
28564           in: body
28565           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28566           required: true
28567           schema:
28568             $ref: "#/definitions/relationship"
28569     delete:
28570       tags:
28571         - Network
28572       summary: delete an existing relationship
28573       description: delete an existing relationship
28574       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28575       consumes:
28576         - application/json
28577         - application/xml
28578       produces:
28579         - application/json
28580         - application/xml
28581       responses:
28582         "default":
28583           description: Response codes found in [response codes](https://wiki.onap.org/).
28584       parameters:
28585         - name: vnf-id
28586           in: path
28587           description: Unique id of VNF.  This is unique across the graph.
28588           required: true
28589           type: string
28590           example: __VNF-ID__
28591         - name: interface-name
28592           in: path
28593           description: Name given to the interface
28594           required: true
28595           type: string
28596           example: __INTERFACE-NAME__
28597   /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:
28598     put:
28599       tags:
28600         - Network
28601       summary: see node definition for valid relationships
28602       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28603       consumes:
28604         - application/json
28605         - application/xml
28606       produces:
28607         - application/json
28608         - application/xml
28609       responses:
28610         "default":
28611           description: Response codes found in [response codes](https://wiki.onap.org/).
28612       parameters:
28613         - name: vnf-id
28614           in: path
28615           description: Unique id of VNF.  This is unique across the graph.
28616           required: true
28617           type: string
28618           example: __VNF-ID__
28619         - name: interface-name
28620           in: path
28621           description: Name given to the interface
28622           required: true
28623           type: string
28624           example: __INTERFACE-NAME__
28625         - name: l3-interface-ipv4-address
28626           in: path
28627           description: IP address
28628           required: true
28629           type: string
28630           example: __L3-INTERFACE-IPV4-ADDRESS__
28631         - name: body
28632           in: body
28633           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28634           required: true
28635           schema:
28636             $ref: "#/definitions/relationship"
28637     delete:
28638       tags:
28639         - Network
28640       summary: delete an existing relationship
28641       description: delete an existing relationship
28642       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28643       consumes:
28644         - application/json
28645         - application/xml
28646       produces:
28647         - application/json
28648         - application/xml
28649       responses:
28650         "default":
28651           description: Response codes found in [response codes](https://wiki.onap.org/).
28652       parameters:
28653         - name: vnf-id
28654           in: path
28655           description: Unique id of VNF.  This is unique across the graph.
28656           required: true
28657           type: string
28658           example: __VNF-ID__
28659         - name: interface-name
28660           in: path
28661           description: Name given to the interface
28662           required: true
28663           type: string
28664           example: __INTERFACE-NAME__
28665         - name: l3-interface-ipv4-address
28666           in: path
28667           description: IP address
28668           required: true
28669           type: string
28670           example: __L3-INTERFACE-IPV4-ADDRESS__
28671   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28672     get:
28673       tags:
28674         - Network
28675       summary: returns l3-interface-ipv4-address-list
28676       description: returns l3-interface-ipv4-address-list
28677       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28678       produces:
28679         - application/json
28680         - application/xml
28681       responses:
28682         "200":
28683           description: successful operation
28684           schema:
28685               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28686         "default":
28687           description: Response codes found in [response codes](https://wiki.onap.org/).
28688       parameters:
28689         - name: vnf-id
28690           in: path
28691           description: Unique id of VNF.  This is unique across the graph.
28692           required: true
28693           type: string
28694           example: __VNF-ID__
28695         - name: interface-name
28696           in: path
28697           description: Name given to the interface
28698           required: true
28699           type: string
28700           example: __INTERFACE-NAME__
28701         - name: l3-interface-ipv4-address
28702           in: path
28703           description: IP address
28704           required: true
28705           type: string
28706           example: __L3-INTERFACE-IPV4-ADDRESS__
28707     put:
28708       tags:
28709         - Network
28710       summary: create or update an existing l3-interface-ipv4-address-list
28711       description: |
28712         Create or update an existing l3-interface-ipv4-address-list.
28713         #
28714         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28715       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28716       consumes:
28717         - application/json
28718         - application/xml
28719       produces:
28720         - application/json
28721         - application/xml
28722       responses:
28723         "default":
28724           description: Response codes found in [response codes](https://wiki.onap.org/).
28725       parameters:
28726         - name: vnf-id
28727           in: path
28728           description: Unique id of VNF.  This is unique across the graph.
28729           required: true
28730           type: string
28731           example: __VNF-ID__
28732         - name: interface-name
28733           in: path
28734           description: Name given to the interface
28735           required: true
28736           type: string
28737           example: __INTERFACE-NAME__
28738         - name: l3-interface-ipv4-address
28739           in: path
28740           description: IP address
28741           required: true
28742           type: string
28743           example: __L3-INTERFACE-IPV4-ADDRESS__
28744         - name: body
28745           in: body
28746           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28747           required: true
28748           schema:
28749             $ref: "#/definitions/l3-interface-ipv4-address-list"
28750     patch:
28751       tags:
28752         - Network
28753       summary: update an existing l3-interface-ipv4-address-list
28754       description: |
28755         Update an existing l3-interface-ipv4-address-list
28756         #
28757         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28758         The PUT operation will entirely replace an existing object.
28759         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28760         #
28761         Other differences between PUT and PATCH are:
28762         #
28763         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28764         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28765         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28766       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28767       consumes:
28768         - application/json
28769         - application/xml
28770       produces:
28771         - application/json
28772         - application/xml
28773       responses:
28774         "default":
28775           description: Response codes found in [response codes](https://wiki.onap.org/).
28776       parameters:
28777         - name: vnf-id
28778           in: path
28779           description: Unique id of VNF.  This is unique across the graph.
28780           required: true
28781           type: string
28782           example: __VNF-ID__
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         - name: body
28796           in: body
28797           description: l3-interface-ipv4-address-list object that needs to be updated.
28798           required: true
28799           schema:
28800             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28801     delete:
28802       tags:
28803         - Network
28804       summary: delete an existing l3-interface-ipv4-address-list
28805       description: delete an existing l3-interface-ipv4-address-list
28806       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28807       consumes:
28808         - application/json
28809         - application/xml
28810       produces:
28811         - application/json
28812         - application/xml
28813       responses:
28814         "default":
28815           description: Response codes found in [response codes](https://wiki.onap.org/).
28816       parameters:
28817         - name: vnf-id
28818           in: path
28819           description: Unique id of VNF.  This is unique across the graph.
28820           required: true
28821           type: string
28822           example: __VNF-ID__
28823         - name: interface-name
28824           in: path
28825           description: Name given to the interface
28826           required: true
28827           type: string
28828           example: __INTERFACE-NAME__
28829         - name: l3-interface-ipv4-address
28830           in: path
28831           description: IP address
28832           required: true
28833           type: string
28834           example: __L3-INTERFACE-IPV4-ADDRESS__
28835         - name: resource-version
28836           in: query
28837           description: resource-version for concurrency
28838           required: true
28839           type: string
28840   /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:
28841     put:
28842       tags:
28843         - Network
28844       summary: see node definition for valid relationships
28845       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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 given to the interface
28865           required: true
28866           type: string
28867           example: __INTERFACE-NAME__
28868         - name: l3-interface-ipv6-address
28869           in: path
28870           description: IP address
28871           required: true
28872           type: string
28873           example: __L3-INTERFACE-IPV6-ADDRESS__
28874         - name: body
28875           in: body
28876           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28877           required: true
28878           schema:
28879             $ref: "#/definitions/relationship"
28880     delete:
28881       tags:
28882         - Network
28883       summary: delete an existing relationship
28884       description: delete an existing relationship
28885       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28886       consumes:
28887         - application/json
28888         - application/xml
28889       produces:
28890         - application/json
28891         - application/xml
28892       responses:
28893         "default":
28894           description: Response codes found in [response codes](https://wiki.onap.org/).
28895       parameters:
28896         - name: vnf-id
28897           in: path
28898           description: Unique id of VNF.  This is unique across the graph.
28899           required: true
28900           type: string
28901           example: __VNF-ID__
28902         - name: interface-name
28903           in: path
28904           description: Name given to the interface
28905           required: true
28906           type: string
28907           example: __INTERFACE-NAME__
28908         - name: l3-interface-ipv6-address
28909           in: path
28910           description: IP address
28911           required: true
28912           type: string
28913           example: __L3-INTERFACE-IPV6-ADDRESS__
28914   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28915     get:
28916       tags:
28917         - Network
28918       summary: returns l3-interface-ipv6-address-list
28919       description: returns l3-interface-ipv6-address-list
28920       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28921       produces:
28922         - application/json
28923         - application/xml
28924       responses:
28925         "200":
28926           description: successful operation
28927           schema:
28928               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28929         "default":
28930           description: Response codes found in [response codes](https://wiki.onap.org/).
28931       parameters:
28932         - name: vnf-id
28933           in: path
28934           description: Unique id of VNF.  This is unique across the graph.
28935           required: true
28936           type: string
28937           example: __VNF-ID__
28938         - name: interface-name
28939           in: path
28940           description: Name given to the interface
28941           required: true
28942           type: string
28943           example: __INTERFACE-NAME__
28944         - name: l3-interface-ipv6-address
28945           in: path
28946           description: IP address
28947           required: true
28948           type: string
28949           example: __L3-INTERFACE-IPV6-ADDRESS__
28950     put:
28951       tags:
28952         - Network
28953       summary: create or update an existing l3-interface-ipv6-address-list
28954       description: |
28955         Create or update an existing l3-interface-ipv6-address-list.
28956         #
28957         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28958       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28959       consumes:
28960         - application/json
28961         - application/xml
28962       produces:
28963         - application/json
28964         - application/xml
28965       responses:
28966         "default":
28967           description: Response codes found in [response codes](https://wiki.onap.org/).
28968       parameters:
28969         - name: vnf-id
28970           in: path
28971           description: Unique id of VNF.  This is unique across the graph.
28972           required: true
28973           type: string
28974           example: __VNF-ID__
28975         - name: interface-name
28976           in: path
28977           description: Name given to the interface
28978           required: true
28979           type: string
28980           example: __INTERFACE-NAME__
28981         - name: l3-interface-ipv6-address
28982           in: path
28983           description: IP address
28984           required: true
28985           type: string
28986           example: __L3-INTERFACE-IPV6-ADDRESS__
28987         - name: body
28988           in: body
28989           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28990           required: true
28991           schema:
28992             $ref: "#/definitions/l3-interface-ipv6-address-list"
28993     patch:
28994       tags:
28995         - Network
28996       summary: update an existing l3-interface-ipv6-address-list
28997       description: |
28998         Update an existing l3-interface-ipv6-address-list
28999         #
29000         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29001         The PUT operation will entirely replace an existing object.
29002         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29003         #
29004         Other differences between PUT and PATCH are:
29005         #
29006         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29007         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29008         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29009       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
29010       consumes:
29011         - application/json
29012         - application/xml
29013       produces:
29014         - application/json
29015         - application/xml
29016       responses:
29017         "default":
29018           description: Response codes found in [response codes](https://wiki.onap.org/).
29019       parameters:
29020         - name: vnf-id
29021           in: path
29022           description: Unique id of VNF.  This is unique across the graph.
29023           required: true
29024           type: string
29025           example: __VNF-ID__
29026         - name: interface-name
29027           in: path
29028           description: Name given to the interface
29029           required: true
29030           type: string
29031           example: __INTERFACE-NAME__
29032         - name: l3-interface-ipv6-address
29033           in: path
29034           description: IP address
29035           required: true
29036           type: string
29037           example: __L3-INTERFACE-IPV6-ADDRESS__
29038         - name: body
29039           in: body
29040           description: l3-interface-ipv6-address-list object that needs to be updated.
29041           required: true
29042           schema:
29043             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29044     delete:
29045       tags:
29046         - Network
29047       summary: delete an existing l3-interface-ipv6-address-list
29048       description: delete an existing l3-interface-ipv6-address-list
29049       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
29050       consumes:
29051         - application/json
29052         - application/xml
29053       produces:
29054         - application/json
29055         - application/xml
29056       responses:
29057         "default":
29058           description: Response codes found in [response codes](https://wiki.onap.org/).
29059       parameters:
29060         - name: vnf-id
29061           in: path
29062           description: Unique id of VNF.  This is unique across the graph.
29063           required: true
29064           type: string
29065           example: __VNF-ID__
29066         - name: interface-name
29067           in: path
29068           description: Name given to the interface
29069           required: true
29070           type: string
29071           example: __INTERFACE-NAME__
29072         - name: l3-interface-ipv6-address
29073           in: path
29074           description: IP address
29075           required: true
29076           type: string
29077           example: __L3-INTERFACE-IPV6-ADDRESS__
29078         - name: resource-version
29079           in: query
29080           description: resource-version for concurrency
29081           required: true
29082           type: string
29083   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
29084     get:
29085       tags:
29086         - Network
29087       summary: returns l-interface
29088       description: returns l-interface
29089       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
29090       produces:
29091         - application/json
29092         - application/xml
29093       responses:
29094         "200":
29095           description: successful operation
29096           schema:
29097               $ref: "#/getDefinitions/l-interface"
29098         "default":
29099           description: Response codes found in [response codes](https://wiki.onap.org/).
29100       parameters:
29101         - name: vnf-id
29102           in: path
29103           description: Unique id of VNF.  This is unique across the graph.
29104           required: true
29105           type: string
29106           example: __VNF-ID__
29107         - name: interface-name
29108           in: path
29109           description: Name given to the interface
29110           required: true
29111           type: string
29112           example: __INTERFACE-NAME__
29113     put:
29114       tags:
29115         - Network
29116       summary: create or update an existing l-interface
29117       description: |
29118         Create or update an existing l-interface.
29119         #
29120         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29121       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
29122       consumes:
29123         - application/json
29124         - application/xml
29125       produces:
29126         - application/json
29127         - application/xml
29128       responses:
29129         "default":
29130           description: Response codes found in [response codes](https://wiki.onap.org/).
29131       parameters:
29132         - name: vnf-id
29133           in: path
29134           description: Unique id of VNF.  This is unique across the graph.
29135           required: true
29136           type: string
29137           example: __VNF-ID__
29138         - name: interface-name
29139           in: path
29140           description: Name given to the interface
29141           required: true
29142           type: string
29143           example: __INTERFACE-NAME__
29144         - name: body
29145           in: body
29146           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
29147           required: true
29148           schema:
29149             $ref: "#/definitions/l-interface"
29150     patch:
29151       tags:
29152         - Network
29153       summary: update an existing l-interface
29154       description: |
29155         Update an existing l-interface
29156         #
29157         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29158         The PUT operation will entirely replace an existing object.
29159         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29160         #
29161         Other differences between PUT and PATCH are:
29162         #
29163         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29164         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29165         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29166       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
29167       consumes:
29168         - application/json
29169         - application/xml
29170       produces:
29171         - application/json
29172         - application/xml
29173       responses:
29174         "default":
29175           description: Response codes found in [response codes](https://wiki.onap.org/).
29176       parameters:
29177         - name: vnf-id
29178           in: path
29179           description: Unique id of VNF.  This is unique across the graph.
29180           required: true
29181           type: string
29182           example: __VNF-ID__
29183         - name: interface-name
29184           in: path
29185           description: Name given to the interface
29186           required: true
29187           type: string
29188           example: __INTERFACE-NAME__
29189         - name: body
29190           in: body
29191           description: l-interface object that needs to be updated.
29192           required: true
29193           schema:
29194             $ref: "#/patchDefinitions/l-interface"
29195     delete:
29196       tags:
29197         - Network
29198       summary: delete an existing l-interface
29199       description: delete an existing l-interface
29200       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
29201       consumes:
29202         - application/json
29203         - application/xml
29204       produces:
29205         - application/json
29206         - application/xml
29207       responses:
29208         "default":
29209           description: Response codes found in [response codes](https://wiki.onap.org/).
29210       parameters:
29211         - name: vnf-id
29212           in: path
29213           description: Unique id of VNF.  This is unique across the graph.
29214           required: true
29215           type: string
29216           example: __VNF-ID__
29217         - name: interface-name
29218           in: path
29219           description: Name given to the interface
29220           required: true
29221           type: string
29222           example: __INTERFACE-NAME__
29223         - name: resource-version
29224           in: query
29225           description: resource-version for concurrency
29226           required: true
29227           type: string
29228   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
29229     get:
29230       tags:
29231         - Network
29232       summary: returns l-interfaces
29233       description: returns l-interfaces
29234       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
29235       produces:
29236         - application/json
29237         - application/xml
29238       responses:
29239         "200":
29240           description: successful operation
29241           schema:
29242               $ref: "#/getDefinitions/l-interfaces"
29243         "default":
29244           description: Response codes found in [response codes](https://wiki.onap.org/).
29245       parameters:
29246         - name: vnf-id
29247           in: path
29248           description: Unique id of VNF.  This is unique across the graph.
29249           required: true
29250           type: string
29251           example: __VNF-ID__
29252         - name: interface-name
29253           in: query
29254           description:
29255           required: false
29256           type: string
29257         - name: interface-id
29258           in: query
29259           description:
29260           required: false
29261           type: string
29262         - name: macaddr
29263           in: query
29264           description:
29265           required: false
29266           type: string
29267         - name: network-name
29268           in: query
29269           description:
29270           required: false
29271           type: string
29272   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
29273     put:
29274       tags:
29275         - Network
29276       summary: see node definition for valid relationships
29277       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29278       consumes:
29279         - application/json
29280         - application/xml
29281       produces:
29282         - application/json
29283         - application/xml
29284       responses:
29285         "default":
29286           description: Response codes found in [response codes](https://wiki.onap.org/).
29287       parameters:
29288         - name: vnf-id
29289           in: path
29290           description: Unique id of VNF.  This is unique across the graph.
29291           required: true
29292           type: string
29293           example: __VNF-ID__
29294         - name: interface-name
29295           in: path
29296           description: Name that identifies the link aggregate interface
29297           required: true
29298           type: string
29299           example: __INTERFACE-NAME__
29300         - name: body
29301           in: body
29302           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29303           required: true
29304           schema:
29305             $ref: "#/definitions/relationship"
29306     delete:
29307       tags:
29308         - Network
29309       summary: delete an existing relationship
29310       description: delete an existing relationship
29311       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
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   /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:
29335     put:
29336       tags:
29337         - Network
29338       summary: see node definition for valid relationships
29339       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29340       consumes:
29341         - application/json
29342         - application/xml
29343       produces:
29344         - application/json
29345         - application/xml
29346       responses:
29347         "default":
29348           description: Response codes found in [response codes](https://wiki.onap.org/).
29349       parameters:
29350         - name: vnf-id
29351           in: path
29352           description: Unique id of VNF.  This is unique across the graph.
29353           required: true
29354           type: string
29355           example: __VNF-ID__
29356         - name: interface-name
29357           in: path
29358           description: Name that identifies the link aggregate interface
29359           required: true
29360           type: string
29361           example: __INTERFACE-NAME__
29362         - name: interface-name
29363           in: path
29364           description: Name given to the interface
29365           required: true
29366           type: string
29367           example: __INTERFACE-NAME__
29368         - name: vlan-interface
29369           in: path
29370           description: String that identifies the interface
29371           required: true
29372           type: string
29373           example: __VLAN-INTERFACE__
29374         - name: body
29375           in: body
29376           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29377           required: true
29378           schema:
29379             $ref: "#/definitions/relationship"
29380     delete:
29381       tags:
29382         - Network
29383       summary: delete an existing relationship
29384       description: delete an existing relationship
29385       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29386       consumes:
29387         - application/json
29388         - application/xml
29389       produces:
29390         - application/json
29391         - application/xml
29392       responses:
29393         "default":
29394           description: Response codes found in [response codes](https://wiki.onap.org/).
29395       parameters:
29396         - name: vnf-id
29397           in: path
29398           description: Unique id of VNF.  This is unique across the graph.
29399           required: true
29400           type: string
29401           example: __VNF-ID__
29402         - name: interface-name
29403           in: path
29404           description: Name that identifies the link aggregate interface
29405           required: true
29406           type: string
29407           example: __INTERFACE-NAME__
29408         - name: interface-name
29409           in: path
29410           description: Name given to the interface
29411           required: true
29412           type: string
29413           example: __INTERFACE-NAME__
29414         - name: vlan-interface
29415           in: path
29416           description: String that identifies the interface
29417           required: true
29418           type: string
29419           example: __VLAN-INTERFACE__
29420   /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:
29421     put:
29422       tags:
29423         - Network
29424       summary: see node definition for valid relationships
29425       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29426       consumes:
29427         - application/json
29428         - application/xml
29429       produces:
29430         - application/json
29431         - application/xml
29432       responses:
29433         "default":
29434           description: Response codes found in [response codes](https://wiki.onap.org/).
29435       parameters:
29436         - name: vnf-id
29437           in: path
29438           description: Unique id of VNF.  This is unique across the graph.
29439           required: true
29440           type: string
29441           example: __VNF-ID__
29442         - name: interface-name
29443           in: path
29444           description: Name that identifies the link aggregate interface
29445           required: true
29446           type: string
29447           example: __INTERFACE-NAME__
29448         - name: interface-name
29449           in: path
29450           description: Name given to the interface
29451           required: true
29452           type: string
29453           example: __INTERFACE-NAME__
29454         - name: vlan-interface
29455           in: path
29456           description: String that identifies the interface
29457           required: true
29458           type: string
29459           example: __VLAN-INTERFACE__
29460         - name: l3-interface-ipv4-address
29461           in: path
29462           description: IP address
29463           required: true
29464           type: string
29465           example: __L3-INTERFACE-IPV4-ADDRESS__
29466         - name: body
29467           in: body
29468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29469           required: true
29470           schema:
29471             $ref: "#/definitions/relationship"
29472     delete:
29473       tags:
29474         - Network
29475       summary: delete an existing relationship
29476       description: delete an existing relationship
29477       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29478       consumes:
29479         - application/json
29480         - application/xml
29481       produces:
29482         - application/json
29483         - application/xml
29484       responses:
29485         "default":
29486           description: Response codes found in [response codes](https://wiki.onap.org/).
29487       parameters:
29488         - name: vnf-id
29489           in: path
29490           description: Unique id of VNF.  This is unique across the graph.
29491           required: true
29492           type: string
29493           example: __VNF-ID__
29494         - name: interface-name
29495           in: path
29496           description: Name that identifies the link aggregate interface
29497           required: true
29498           type: string
29499           example: __INTERFACE-NAME__
29500         - name: interface-name
29501           in: path
29502           description: Name given to the interface
29503           required: true
29504           type: string
29505           example: __INTERFACE-NAME__
29506         - name: vlan-interface
29507           in: path
29508           description: String that identifies the interface
29509           required: true
29510           type: string
29511           example: __VLAN-INTERFACE__
29512         - name: l3-interface-ipv4-address
29513           in: path
29514           description: IP address
29515           required: true
29516           type: string
29517           example: __L3-INTERFACE-IPV4-ADDRESS__
29518   /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}:
29519     get:
29520       tags:
29521         - Network
29522       summary: returns l3-interface-ipv4-address-list
29523       description: returns l3-interface-ipv4-address-list
29524       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29525       produces:
29526         - application/json
29527         - application/xml
29528       responses:
29529         "200":
29530           description: successful operation
29531           schema:
29532               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29533         "default":
29534           description: Response codes found in [response codes](https://wiki.onap.org/).
29535       parameters:
29536         - name: vnf-id
29537           in: path
29538           description: Unique id of VNF.  This is unique across the graph.
29539           required: true
29540           type: string
29541           example: __VNF-ID__
29542         - name: interface-name
29543           in: path
29544           description: Name that identifies the link aggregate interface
29545           required: true
29546           type: string
29547           example: __INTERFACE-NAME__
29548         - name: interface-name
29549           in: path
29550           description: Name given to the interface
29551           required: true
29552           type: string
29553           example: __INTERFACE-NAME__
29554         - name: vlan-interface
29555           in: path
29556           description: String that identifies the interface
29557           required: true
29558           type: string
29559           example: __VLAN-INTERFACE__
29560         - name: l3-interface-ipv4-address
29561           in: path
29562           description: IP address
29563           required: true
29564           type: string
29565           example: __L3-INTERFACE-IPV4-ADDRESS__
29566     put:
29567       tags:
29568         - Network
29569       summary: create or update an existing l3-interface-ipv4-address-list
29570       description: |
29571         Create or update an existing l3-interface-ipv4-address-list.
29572         #
29573         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29574       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29575       consumes:
29576         - application/json
29577         - application/xml
29578       produces:
29579         - application/json
29580         - application/xml
29581       responses:
29582         "default":
29583           description: Response codes found in [response codes](https://wiki.onap.org/).
29584       parameters:
29585         - name: vnf-id
29586           in: path
29587           description: Unique id of VNF.  This is unique across the graph.
29588           required: true
29589           type: string
29590           example: __VNF-ID__
29591         - name: interface-name
29592           in: path
29593           description: Name that identifies the link aggregate interface
29594           required: true
29595           type: string
29596           example: __INTERFACE-NAME__
29597         - name: interface-name
29598           in: path
29599           description: Name given to the interface
29600           required: true
29601           type: string
29602           example: __INTERFACE-NAME__
29603         - name: vlan-interface
29604           in: path
29605           description: String that identifies the interface
29606           required: true
29607           type: string
29608           example: __VLAN-INTERFACE__
29609         - name: l3-interface-ipv4-address
29610           in: path
29611           description: IP address
29612           required: true
29613           type: string
29614           example: __L3-INTERFACE-IPV4-ADDRESS__
29615         - name: body
29616           in: body
29617           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29618           required: true
29619           schema:
29620             $ref: "#/definitions/l3-interface-ipv4-address-list"
29621     patch:
29622       tags:
29623         - Network
29624       summary: update an existing l3-interface-ipv4-address-list
29625       description: |
29626         Update an existing l3-interface-ipv4-address-list
29627         #
29628         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29629         The PUT operation will entirely replace an existing object.
29630         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29631         #
29632         Other differences between PUT and PATCH are:
29633         #
29634         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29635         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29636         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29637       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29638       consumes:
29639         - application/json
29640         - application/xml
29641       produces:
29642         - application/json
29643         - application/xml
29644       responses:
29645         "default":
29646           description: Response codes found in [response codes](https://wiki.onap.org/).
29647       parameters:
29648         - name: vnf-id
29649           in: path
29650           description: Unique id of VNF.  This is unique across the graph.
29651           required: true
29652           type: string
29653           example: __VNF-ID__
29654         - name: interface-name
29655           in: path
29656           description: Name that identifies the link aggregate interface
29657           required: true
29658           type: string
29659           example: __INTERFACE-NAME__
29660         - name: interface-name
29661           in: path
29662           description: Name given to the interface
29663           required: true
29664           type: string
29665           example: __INTERFACE-NAME__
29666         - name: vlan-interface
29667           in: path
29668           description: String that identifies the interface
29669           required: true
29670           type: string
29671           example: __VLAN-INTERFACE__
29672         - name: l3-interface-ipv4-address
29673           in: path
29674           description: IP address
29675           required: true
29676           type: string
29677           example: __L3-INTERFACE-IPV4-ADDRESS__
29678         - name: body
29679           in: body
29680           description: l3-interface-ipv4-address-list object that needs to be updated.
29681           required: true
29682           schema:
29683             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29684     delete:
29685       tags:
29686         - Network
29687       summary: delete an existing l3-interface-ipv4-address-list
29688       description: delete an existing l3-interface-ipv4-address-list
29689       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29690       consumes:
29691         - application/json
29692         - application/xml
29693       produces:
29694         - application/json
29695         - application/xml
29696       responses:
29697         "default":
29698           description: Response codes found in [response codes](https://wiki.onap.org/).
29699       parameters:
29700         - name: vnf-id
29701           in: path
29702           description: Unique id of VNF.  This is unique across the graph.
29703           required: true
29704           type: string
29705           example: __VNF-ID__
29706         - name: interface-name
29707           in: path
29708           description: Name that identifies the link aggregate interface
29709           required: true
29710           type: string
29711           example: __INTERFACE-NAME__
29712         - name: interface-name
29713           in: path
29714           description: Name given to the interface
29715           required: true
29716           type: string
29717           example: __INTERFACE-NAME__
29718         - name: vlan-interface
29719           in: path
29720           description: String that identifies the interface
29721           required: true
29722           type: string
29723           example: __VLAN-INTERFACE__
29724         - name: l3-interface-ipv4-address
29725           in: path
29726           description: IP address
29727           required: true
29728           type: string
29729           example: __L3-INTERFACE-IPV4-ADDRESS__
29730         - name: resource-version
29731           in: query
29732           description: resource-version for concurrency
29733           required: true
29734           type: string
29735   /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:
29736     put:
29737       tags:
29738         - Network
29739       summary: see node definition for valid relationships
29740       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29741       consumes:
29742         - application/json
29743         - application/xml
29744       produces:
29745         - application/json
29746         - application/xml
29747       responses:
29748         "default":
29749           description: Response codes found in [response codes](https://wiki.onap.org/).
29750       parameters:
29751         - name: vnf-id
29752           in: path
29753           description: Unique id of VNF.  This is unique across the graph.
29754           required: true
29755           type: string
29756           example: __VNF-ID__
29757         - name: interface-name
29758           in: path
29759           description: Name that identifies the link aggregate interface
29760           required: true
29761           type: string
29762           example: __INTERFACE-NAME__
29763         - name: interface-name
29764           in: path
29765           description: Name given to the interface
29766           required: true
29767           type: string
29768           example: __INTERFACE-NAME__
29769         - name: vlan-interface
29770           in: path
29771           description: String that identifies the interface
29772           required: true
29773           type: string
29774           example: __VLAN-INTERFACE__
29775         - name: l3-interface-ipv6-address
29776           in: path
29777           description: IP address
29778           required: true
29779           type: string
29780           example: __L3-INTERFACE-IPV6-ADDRESS__
29781         - name: body
29782           in: body
29783           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29784           required: true
29785           schema:
29786             $ref: "#/definitions/relationship"
29787     delete:
29788       tags:
29789         - Network
29790       summary: delete an existing relationship
29791       description: delete an existing relationship
29792       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29793       consumes:
29794         - application/json
29795         - application/xml
29796       produces:
29797         - application/json
29798         - application/xml
29799       responses:
29800         "default":
29801           description: Response codes found in [response codes](https://wiki.onap.org/).
29802       parameters:
29803         - name: vnf-id
29804           in: path
29805           description: Unique id of VNF.  This is unique across the graph.
29806           required: true
29807           type: string
29808           example: __VNF-ID__
29809         - name: interface-name
29810           in: path
29811           description: Name that identifies the link aggregate interface
29812           required: true
29813           type: string
29814           example: __INTERFACE-NAME__
29815         - name: interface-name
29816           in: path
29817           description: Name given to the interface
29818           required: true
29819           type: string
29820           example: __INTERFACE-NAME__
29821         - name: vlan-interface
29822           in: path
29823           description: String that identifies the interface
29824           required: true
29825           type: string
29826           example: __VLAN-INTERFACE__
29827         - name: l3-interface-ipv6-address
29828           in: path
29829           description: IP address
29830           required: true
29831           type: string
29832           example: __L3-INTERFACE-IPV6-ADDRESS__
29833   /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}:
29834     get:
29835       tags:
29836         - Network
29837       summary: returns l3-interface-ipv6-address-list
29838       description: returns l3-interface-ipv6-address-list
29839       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29840       produces:
29841         - application/json
29842         - application/xml
29843       responses:
29844         "200":
29845           description: successful operation
29846           schema:
29847               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29848         "default":
29849           description: Response codes found in [response codes](https://wiki.onap.org/).
29850       parameters:
29851         - name: vnf-id
29852           in: path
29853           description: Unique id of VNF.  This is unique across the graph.
29854           required: true
29855           type: string
29856           example: __VNF-ID__
29857         - name: interface-name
29858           in: path
29859           description: Name that identifies the link aggregate interface
29860           required: true
29861           type: string
29862           example: __INTERFACE-NAME__
29863         - name: interface-name
29864           in: path
29865           description: Name given to the interface
29866           required: true
29867           type: string
29868           example: __INTERFACE-NAME__
29869         - name: vlan-interface
29870           in: path
29871           description: String that identifies the interface
29872           required: true
29873           type: string
29874           example: __VLAN-INTERFACE__
29875         - name: l3-interface-ipv6-address
29876           in: path
29877           description: IP address
29878           required: true
29879           type: string
29880           example: __L3-INTERFACE-IPV6-ADDRESS__
29881     put:
29882       tags:
29883         - Network
29884       summary: create or update an existing l3-interface-ipv6-address-list
29885       description: |
29886         Create or update an existing l3-interface-ipv6-address-list.
29887         #
29888         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29889       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29890       consumes:
29891         - application/json
29892         - application/xml
29893       produces:
29894         - application/json
29895         - application/xml
29896       responses:
29897         "default":
29898           description: Response codes found in [response codes](https://wiki.onap.org/).
29899       parameters:
29900         - name: vnf-id
29901           in: path
29902           description: Unique id of VNF.  This is unique across the graph.
29903           required: true
29904           type: string
29905           example: __VNF-ID__
29906         - name: interface-name
29907           in: path
29908           description: Name that identifies the link aggregate interface
29909           required: true
29910           type: string
29911           example: __INTERFACE-NAME__
29912         - name: interface-name
29913           in: path
29914           description: Name given to the interface
29915           required: true
29916           type: string
29917           example: __INTERFACE-NAME__
29918         - name: vlan-interface
29919           in: path
29920           description: String that identifies the interface
29921           required: true
29922           type: string
29923           example: __VLAN-INTERFACE__
29924         - name: l3-interface-ipv6-address
29925           in: path
29926           description: IP address
29927           required: true
29928           type: string
29929           example: __L3-INTERFACE-IPV6-ADDRESS__
29930         - name: body
29931           in: body
29932           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29933           required: true
29934           schema:
29935             $ref: "#/definitions/l3-interface-ipv6-address-list"
29936     patch:
29937       tags:
29938         - Network
29939       summary: update an existing l3-interface-ipv6-address-list
29940       description: |
29941         Update an existing l3-interface-ipv6-address-list
29942         #
29943         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29944         The PUT operation will entirely replace an existing object.
29945         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29946         #
29947         Other differences between PUT and PATCH are:
29948         #
29949         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29950         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29951         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29952       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29953       consumes:
29954         - application/json
29955         - application/xml
29956       produces:
29957         - application/json
29958         - application/xml
29959       responses:
29960         "default":
29961           description: Response codes found in [response codes](https://wiki.onap.org/).
29962       parameters:
29963         - name: vnf-id
29964           in: path
29965           description: Unique id of VNF.  This is unique across the graph.
29966           required: true
29967           type: string
29968           example: __VNF-ID__
29969         - name: interface-name
29970           in: path
29971           description: Name that identifies the link aggregate interface
29972           required: true
29973           type: string
29974           example: __INTERFACE-NAME__
29975         - name: interface-name
29976           in: path
29977           description: Name given to the interface
29978           required: true
29979           type: string
29980           example: __INTERFACE-NAME__
29981         - name: vlan-interface
29982           in: path
29983           description: String that identifies the interface
29984           required: true
29985           type: string
29986           example: __VLAN-INTERFACE__
29987         - name: l3-interface-ipv6-address
29988           in: path
29989           description: IP address
29990           required: true
29991           type: string
29992           example: __L3-INTERFACE-IPV6-ADDRESS__
29993         - name: body
29994           in: body
29995           description: l3-interface-ipv6-address-list object that needs to be updated.
29996           required: true
29997           schema:
29998             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29999     delete:
30000       tags:
30001         - Network
30002       summary: delete an existing l3-interface-ipv6-address-list
30003       description: delete an existing l3-interface-ipv6-address-list
30004       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30005       consumes:
30006         - application/json
30007         - application/xml
30008       produces:
30009         - application/json
30010         - application/xml
30011       responses:
30012         "default":
30013           description: Response codes found in [response codes](https://wiki.onap.org/).
30014       parameters:
30015         - name: vnf-id
30016           in: path
30017           description: Unique id of VNF.  This is unique across the graph.
30018           required: true
30019           type: string
30020           example: __VNF-ID__
30021         - name: interface-name
30022           in: path
30023           description: Name that identifies the link aggregate interface
30024           required: true
30025           type: string
30026           example: __INTERFACE-NAME__
30027         - name: interface-name
30028           in: path
30029           description: Name given to the interface
30030           required: true
30031           type: string
30032           example: __INTERFACE-NAME__
30033         - name: vlan-interface
30034           in: path
30035           description: String that identifies the interface
30036           required: true
30037           type: string
30038           example: __VLAN-INTERFACE__
30039         - name: l3-interface-ipv6-address
30040           in: path
30041           description: IP address
30042           required: true
30043           type: string
30044           example: __L3-INTERFACE-IPV6-ADDRESS__
30045         - name: resource-version
30046           in: query
30047           description: resource-version for concurrency
30048           required: true
30049           type: string
30050   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
30051     get:
30052       tags:
30053         - Network
30054       summary: returns vlan
30055       description: returns vlan
30056       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30057       produces:
30058         - application/json
30059         - application/xml
30060       responses:
30061         "200":
30062           description: successful operation
30063           schema:
30064               $ref: "#/getDefinitions/vlan"
30065         "default":
30066           description: Response codes found in [response codes](https://wiki.onap.org/).
30067       parameters:
30068         - name: vnf-id
30069           in: path
30070           description: Unique id of VNF.  This is unique across the graph.
30071           required: true
30072           type: string
30073           example: __VNF-ID__
30074         - name: interface-name
30075           in: path
30076           description: Name that identifies the link aggregate interface
30077           required: true
30078           type: string
30079           example: __INTERFACE-NAME__
30080         - name: interface-name
30081           in: path
30082           description: Name given to the interface
30083           required: true
30084           type: string
30085           example: __INTERFACE-NAME__
30086         - name: vlan-interface
30087           in: path
30088           description: String that identifies the interface
30089           required: true
30090           type: string
30091           example: __VLAN-INTERFACE__
30092     put:
30093       tags:
30094         - Network
30095       summary: create or update an existing vlan
30096       description: |
30097         Create or update an existing vlan.
30098         #
30099         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30100       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30101       consumes:
30102         - application/json
30103         - application/xml
30104       produces:
30105         - application/json
30106         - application/xml
30107       responses:
30108         "default":
30109           description: Response codes found in [response codes](https://wiki.onap.org/).
30110       parameters:
30111         - name: vnf-id
30112           in: path
30113           description: Unique id of VNF.  This is unique across the graph.
30114           required: true
30115           type: string
30116           example: __VNF-ID__
30117         - name: interface-name
30118           in: path
30119           description: Name that identifies the link aggregate interface
30120           required: true
30121           type: string
30122           example: __INTERFACE-NAME__
30123         - name: interface-name
30124           in: path
30125           description: Name given to the interface
30126           required: true
30127           type: string
30128           example: __INTERFACE-NAME__
30129         - name: vlan-interface
30130           in: path
30131           description: String that identifies the interface
30132           required: true
30133           type: string
30134           example: __VLAN-INTERFACE__
30135         - name: body
30136           in: body
30137           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
30138           required: true
30139           schema:
30140             $ref: "#/definitions/vlan"
30141     patch:
30142       tags:
30143         - Network
30144       summary: update an existing vlan
30145       description: |
30146         Update an existing vlan
30147         #
30148         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30149         The PUT operation will entirely replace an existing object.
30150         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30151         #
30152         Other differences between PUT and PATCH are:
30153         #
30154         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30155         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30156         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30157       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30158       consumes:
30159         - application/json
30160         - application/xml
30161       produces:
30162         - application/json
30163         - application/xml
30164       responses:
30165         "default":
30166           description: Response codes found in [response codes](https://wiki.onap.org/).
30167       parameters:
30168         - name: vnf-id
30169           in: path
30170           description: Unique id of VNF.  This is unique across the graph.
30171           required: true
30172           type: string
30173           example: __VNF-ID__
30174         - name: interface-name
30175           in: path
30176           description: Name that identifies the link aggregate interface
30177           required: true
30178           type: string
30179           example: __INTERFACE-NAME__
30180         - name: interface-name
30181           in: path
30182           description: Name given to the interface
30183           required: true
30184           type: string
30185           example: __INTERFACE-NAME__
30186         - name: vlan-interface
30187           in: path
30188           description: String that identifies the interface
30189           required: true
30190           type: string
30191           example: __VLAN-INTERFACE__
30192         - name: body
30193           in: body
30194           description: vlan object that needs to be updated.
30195           required: true
30196           schema:
30197             $ref: "#/patchDefinitions/vlan"
30198     delete:
30199       tags:
30200         - Network
30201       summary: delete an existing vlan
30202       description: delete an existing vlan
30203       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30204       consumes:
30205         - application/json
30206         - application/xml
30207       produces:
30208         - application/json
30209         - application/xml
30210       responses:
30211         "default":
30212           description: Response codes found in [response codes](https://wiki.onap.org/).
30213       parameters:
30214         - name: vnf-id
30215           in: path
30216           description: Unique id of VNF.  This is unique across the graph.
30217           required: true
30218           type: string
30219           example: __VNF-ID__
30220         - name: interface-name
30221           in: path
30222           description: Name that identifies the link aggregate interface
30223           required: true
30224           type: string
30225           example: __INTERFACE-NAME__
30226         - name: interface-name
30227           in: path
30228           description: Name given to the interface
30229           required: true
30230           type: string
30231           example: __INTERFACE-NAME__
30232         - name: vlan-interface
30233           in: path
30234           description: String that identifies the interface
30235           required: true
30236           type: string
30237           example: __VLAN-INTERFACE__
30238         - name: resource-version
30239           in: query
30240           description: resource-version for concurrency
30241           required: true
30242           type: string
30243   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
30244     get:
30245       tags:
30246         - Network
30247       summary: returns vlans
30248       description: returns vlans
30249       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
30250       produces:
30251         - application/json
30252         - application/xml
30253       responses:
30254         "200":
30255           description: successful operation
30256           schema:
30257               $ref: "#/getDefinitions/vlans"
30258         "default":
30259           description: Response codes found in [response codes](https://wiki.onap.org/).
30260       parameters:
30261         - name: vnf-id
30262           in: path
30263           description: Unique id of VNF.  This is unique across the graph.
30264           required: true
30265           type: string
30266           example: __VNF-ID__
30267         - name: interface-name
30268           in: path
30269           description: Name that identifies the link aggregate interface
30270           required: true
30271           type: string
30272           example: __INTERFACE-NAME__
30273         - name: interface-name
30274           in: path
30275           description: Name given to the interface
30276           required: true
30277           type: string
30278           example: __INTERFACE-NAME__
30279         - name: vlan-interface
30280           in: query
30281           description:
30282           required: false
30283           type: string
30284         - name: vlan-id-inner
30285           in: query
30286           description:
30287           required: false
30288           type: integer
30289           format: int64
30290         - name: vpn-id
30291           in: query
30292           description:
30293           required: false
30294           type: string
30295   /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:
30296     put:
30297       tags:
30298         - Network
30299       summary: see node definition for valid relationships
30300       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30301       consumes:
30302         - application/json
30303         - application/xml
30304       produces:
30305         - application/json
30306         - application/xml
30307       responses:
30308         "default":
30309           description: Response codes found in [response codes](https://wiki.onap.org/).
30310       parameters:
30311         - name: vnf-id
30312           in: path
30313           description: Unique id of VNF.  This is unique across the graph.
30314           required: true
30315           type: string
30316           example: __VNF-ID__
30317         - name: interface-name
30318           in: path
30319           description: Name that identifies the link aggregate interface
30320           required: true
30321           type: string
30322           example: __INTERFACE-NAME__
30323         - name: interface-name
30324           in: path
30325           description: Name given to the interface
30326           required: true
30327           type: string
30328           example: __INTERFACE-NAME__
30329         - name: pci-id
30330           in: path
30331           description: PCI ID used to identify the sriov-vf
30332           required: true
30333           type: string
30334           example: __PCI-ID__
30335         - name: body
30336           in: body
30337           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30338           required: true
30339           schema:
30340             $ref: "#/definitions/relationship"
30341     delete:
30342       tags:
30343         - Network
30344       summary: delete an existing relationship
30345       description: delete an existing relationship
30346       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30347       consumes:
30348         - application/json
30349         - application/xml
30350       produces:
30351         - application/json
30352         - application/xml
30353       responses:
30354         "default":
30355           description: Response codes found in [response codes](https://wiki.onap.org/).
30356       parameters:
30357         - name: vnf-id
30358           in: path
30359           description: Unique id of VNF.  This is unique across the graph.
30360           required: true
30361           type: string
30362           example: __VNF-ID__
30363         - name: interface-name
30364           in: path
30365           description: Name that identifies the link aggregate interface
30366           required: true
30367           type: string
30368           example: __INTERFACE-NAME__
30369         - name: interface-name
30370           in: path
30371           description: Name given to the interface
30372           required: true
30373           type: string
30374           example: __INTERFACE-NAME__
30375         - name: pci-id
30376           in: path
30377           description: PCI ID used to identify the sriov-vf
30378           required: true
30379           type: string
30380           example: __PCI-ID__
30381   /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}:
30382     get:
30383       tags:
30384         - Network
30385       summary: returns sriov-vf
30386       description: returns sriov-vf
30387       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30388       produces:
30389         - application/json
30390         - application/xml
30391       responses:
30392         "200":
30393           description: successful operation
30394           schema:
30395               $ref: "#/getDefinitions/sriov-vf"
30396         "default":
30397           description: Response codes found in [response codes](https://wiki.onap.org/).
30398       parameters:
30399         - name: vnf-id
30400           in: path
30401           description: Unique id of VNF.  This is unique across the graph.
30402           required: true
30403           type: string
30404           example: __VNF-ID__
30405         - name: interface-name
30406           in: path
30407           description: Name that identifies the link aggregate interface
30408           required: true
30409           type: string
30410           example: __INTERFACE-NAME__
30411         - name: interface-name
30412           in: path
30413           description: Name given to the interface
30414           required: true
30415           type: string
30416           example: __INTERFACE-NAME__
30417         - name: pci-id
30418           in: path
30419           description: PCI ID used to identify the sriov-vf
30420           required: true
30421           type: string
30422           example: __PCI-ID__
30423     put:
30424       tags:
30425         - Network
30426       summary: create or update an existing sriov-vf
30427       description: |
30428         Create or update an existing sriov-vf.
30429         #
30430         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30431       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30432       consumes:
30433         - application/json
30434         - application/xml
30435       produces:
30436         - application/json
30437         - application/xml
30438       responses:
30439         "default":
30440           description: Response codes found in [response codes](https://wiki.onap.org/).
30441       parameters:
30442         - name: vnf-id
30443           in: path
30444           description: Unique id of VNF.  This is unique across the graph.
30445           required: true
30446           type: string
30447           example: __VNF-ID__
30448         - name: interface-name
30449           in: path
30450           description: Name that identifies the link aggregate interface
30451           required: true
30452           type: string
30453           example: __INTERFACE-NAME__
30454         - name: interface-name
30455           in: path
30456           description: Name given to the interface
30457           required: true
30458           type: string
30459           example: __INTERFACE-NAME__
30460         - name: pci-id
30461           in: path
30462           description: PCI ID used to identify the sriov-vf
30463           required: true
30464           type: string
30465           example: __PCI-ID__
30466         - name: body
30467           in: body
30468           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30469           required: true
30470           schema:
30471             $ref: "#/definitions/sriov-vf"
30472     patch:
30473       tags:
30474         - Network
30475       summary: update an existing sriov-vf
30476       description: |
30477         Update an existing sriov-vf
30478         #
30479         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30480         The PUT operation will entirely replace an existing object.
30481         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30482         #
30483         Other differences between PUT and PATCH are:
30484         #
30485         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30486         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30487         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30488       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30489       consumes:
30490         - application/json
30491         - application/xml
30492       produces:
30493         - application/json
30494         - application/xml
30495       responses:
30496         "default":
30497           description: Response codes found in [response codes](https://wiki.onap.org/).
30498       parameters:
30499         - name: vnf-id
30500           in: path
30501           description: Unique id of VNF.  This is unique across the graph.
30502           required: true
30503           type: string
30504           example: __VNF-ID__
30505         - name: interface-name
30506           in: path
30507           description: Name that identifies the link aggregate interface
30508           required: true
30509           type: string
30510           example: __INTERFACE-NAME__
30511         - name: interface-name
30512           in: path
30513           description: Name given to the interface
30514           required: true
30515           type: string
30516           example: __INTERFACE-NAME__
30517         - name: pci-id
30518           in: path
30519           description: PCI ID used to identify the sriov-vf
30520           required: true
30521           type: string
30522           example: __PCI-ID__
30523         - name: body
30524           in: body
30525           description: sriov-vf object that needs to be updated.
30526           required: true
30527           schema:
30528             $ref: "#/patchDefinitions/sriov-vf"
30529     delete:
30530       tags:
30531         - Network
30532       summary: delete an existing sriov-vf
30533       description: delete an existing sriov-vf
30534       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30535       consumes:
30536         - application/json
30537         - application/xml
30538       produces:
30539         - application/json
30540         - application/xml
30541       responses:
30542         "default":
30543           description: Response codes found in [response codes](https://wiki.onap.org/).
30544       parameters:
30545         - name: vnf-id
30546           in: path
30547           description: Unique id of VNF.  This is unique across the graph.
30548           required: true
30549           type: string
30550           example: __VNF-ID__
30551         - name: interface-name
30552           in: path
30553           description: Name that identifies the link aggregate interface
30554           required: true
30555           type: string
30556           example: __INTERFACE-NAME__
30557         - name: interface-name
30558           in: path
30559           description: Name given to the interface
30560           required: true
30561           type: string
30562           example: __INTERFACE-NAME__
30563         - name: pci-id
30564           in: path
30565           description: PCI ID used to identify the sriov-vf
30566           required: true
30567           type: string
30568           example: __PCI-ID__
30569         - name: resource-version
30570           in: query
30571           description: resource-version for concurrency
30572           required: true
30573           type: string
30574   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
30575     get:
30576       tags:
30577         - Network
30578       summary: returns sriov-vfs
30579       description: returns sriov-vfs
30580       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
30581       produces:
30582         - application/json
30583         - application/xml
30584       responses:
30585         "200":
30586           description: successful operation
30587           schema:
30588               $ref: "#/getDefinitions/sriov-vfs"
30589         "default":
30590           description: Response codes found in [response codes](https://wiki.onap.org/).
30591       parameters:
30592         - name: vnf-id
30593           in: path
30594           description: Unique id of VNF.  This is unique across the graph.
30595           required: true
30596           type: string
30597           example: __VNF-ID__
30598         - name: interface-name
30599           in: path
30600           description: Name that identifies the link aggregate interface
30601           required: true
30602           type: string
30603           example: __INTERFACE-NAME__
30604         - name: interface-name
30605           in: path
30606           description: Name given to the interface
30607           required: true
30608           type: string
30609           example: __INTERFACE-NAME__
30610         - name: pci-id
30611           in: query
30612           description:
30613           required: false
30614           type: string
30615         - name: vf-vlan-filter
30616           in: query
30617           description:
30618           required: false
30619           type: string
30620         - name: vf-mac-filter
30621           in: query
30622           description:
30623           required: false
30624           type: string
30625         - name: vf-vlan-strip
30626           in: query
30627           description:
30628           required: false
30629           type: boolean
30630         - name: neutron-network-id
30631           in: query
30632           description:
30633           required: false
30634           type: string
30635   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
30636     put:
30637       tags:
30638         - Network
30639       summary: see node definition for valid relationships
30640       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30641       consumes:
30642         - application/json
30643         - application/xml
30644       produces:
30645         - application/json
30646         - application/xml
30647       responses:
30648         "default":
30649           description: Response codes found in [response codes](https://wiki.onap.org/).
30650       parameters:
30651         - name: vnf-id
30652           in: path
30653           description: Unique id of VNF.  This is unique across the graph.
30654           required: true
30655           type: string
30656           example: __VNF-ID__
30657         - name: interface-name
30658           in: path
30659           description: Name that identifies the link aggregate interface
30660           required: true
30661           type: string
30662           example: __INTERFACE-NAME__
30663         - name: interface-name
30664           in: path
30665           description: Name given to the interface
30666           required: true
30667           type: string
30668           example: __INTERFACE-NAME__
30669         - name: body
30670           in: body
30671           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
30672           required: true
30673           schema:
30674             $ref: "#/definitions/relationship"
30675     delete:
30676       tags:
30677         - Network
30678       summary: delete an existing relationship
30679       description: delete an existing relationship
30680       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30681       consumes:
30682         - application/json
30683         - application/xml
30684       produces:
30685         - application/json
30686         - application/xml
30687       responses:
30688         "default":
30689           description: Response codes found in [response codes](https://wiki.onap.org/).
30690       parameters:
30691         - name: vnf-id
30692           in: path
30693           description: Unique id of VNF.  This is unique across the graph.
30694           required: true
30695           type: string
30696           example: __VNF-ID__
30697         - name: interface-name
30698           in: path
30699           description: Name that identifies the link aggregate interface
30700           required: true
30701           type: string
30702           example: __INTERFACE-NAME__
30703         - name: interface-name
30704           in: path
30705           description: Name given to the interface
30706           required: true
30707           type: string
30708           example: __INTERFACE-NAME__
30709   /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:
30710     put:
30711       tags:
30712         - Network
30713       summary: see node definition for valid relationships
30714       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30715       consumes:
30716         - application/json
30717         - application/xml
30718       produces:
30719         - application/json
30720         - application/xml
30721       responses:
30722         "default":
30723           description: Response codes found in [response codes](https://wiki.onap.org/).
30724       parameters:
30725         - name: vnf-id
30726           in: path
30727           description: Unique id of VNF.  This is unique across the graph.
30728           required: true
30729           type: string
30730           example: __VNF-ID__
30731         - name: interface-name
30732           in: path
30733           description: Name that identifies the link aggregate interface
30734           required: true
30735           type: string
30736           example: __INTERFACE-NAME__
30737         - name: interface-name
30738           in: path
30739           description: Name given to the interface
30740           required: true
30741           type: string
30742           example: __INTERFACE-NAME__
30743         - name: l3-interface-ipv4-address
30744           in: path
30745           description: IP address
30746           required: true
30747           type: string
30748           example: __L3-INTERFACE-IPV4-ADDRESS__
30749         - name: body
30750           in: body
30751           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30752           required: true
30753           schema:
30754             $ref: "#/definitions/relationship"
30755     delete:
30756       tags:
30757         - Network
30758       summary: delete an existing relationship
30759       description: delete an existing relationship
30760       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30761       consumes:
30762         - application/json
30763         - application/xml
30764       produces:
30765         - application/json
30766         - application/xml
30767       responses:
30768         "default":
30769           description: Response codes found in [response codes](https://wiki.onap.org/).
30770       parameters:
30771         - name: vnf-id
30772           in: path
30773           description: Unique id of VNF.  This is unique across the graph.
30774           required: true
30775           type: string
30776           example: __VNF-ID__
30777         - name: interface-name
30778           in: path
30779           description: Name that identifies the link aggregate interface
30780           required: true
30781           type: string
30782           example: __INTERFACE-NAME__
30783         - name: interface-name
30784           in: path
30785           description: Name given to the interface
30786           required: true
30787           type: string
30788           example: __INTERFACE-NAME__
30789         - name: l3-interface-ipv4-address
30790           in: path
30791           description: IP address
30792           required: true
30793           type: string
30794           example: __L3-INTERFACE-IPV4-ADDRESS__
30795   /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}:
30796     get:
30797       tags:
30798         - Network
30799       summary: returns l3-interface-ipv4-address-list
30800       description: returns l3-interface-ipv4-address-list
30801       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30802       produces:
30803         - application/json
30804         - application/xml
30805       responses:
30806         "200":
30807           description: successful operation
30808           schema:
30809               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30810         "default":
30811           description: Response codes found in [response codes](https://wiki.onap.org/).
30812       parameters:
30813         - name: vnf-id
30814           in: path
30815           description: Unique id of VNF.  This is unique across the graph.
30816           required: true
30817           type: string
30818           example: __VNF-ID__
30819         - name: interface-name
30820           in: path
30821           description: Name that identifies the link aggregate interface
30822           required: true
30823           type: string
30824           example: __INTERFACE-NAME__
30825         - name: interface-name
30826           in: path
30827           description: Name given to the interface
30828           required: true
30829           type: string
30830           example: __INTERFACE-NAME__
30831         - name: l3-interface-ipv4-address
30832           in: path
30833           description: IP address
30834           required: true
30835           type: string
30836           example: __L3-INTERFACE-IPV4-ADDRESS__
30837     put:
30838       tags:
30839         - Network
30840       summary: create or update an existing l3-interface-ipv4-address-list
30841       description: |
30842         Create or update an existing l3-interface-ipv4-address-list.
30843         #
30844         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30845       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30846       consumes:
30847         - application/json
30848         - application/xml
30849       produces:
30850         - application/json
30851         - application/xml
30852       responses:
30853         "default":
30854           description: Response codes found in [response codes](https://wiki.onap.org/).
30855       parameters:
30856         - name: vnf-id
30857           in: path
30858           description: Unique id of VNF.  This is unique across the graph.
30859           required: true
30860           type: string
30861           example: __VNF-ID__
30862         - name: interface-name
30863           in: path
30864           description: Name that identifies the link aggregate interface
30865           required: true
30866           type: string
30867           example: __INTERFACE-NAME__
30868         - name: interface-name
30869           in: path
30870           description: Name given to the interface
30871           required: true
30872           type: string
30873           example: __INTERFACE-NAME__
30874         - name: l3-interface-ipv4-address
30875           in: path
30876           description: IP address
30877           required: true
30878           type: string
30879           example: __L3-INTERFACE-IPV4-ADDRESS__
30880         - name: body
30881           in: body
30882           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30883           required: true
30884           schema:
30885             $ref: "#/definitions/l3-interface-ipv4-address-list"
30886     patch:
30887       tags:
30888         - Network
30889       summary: update an existing l3-interface-ipv4-address-list
30890       description: |
30891         Update an existing l3-interface-ipv4-address-list
30892         #
30893         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30894         The PUT operation will entirely replace an existing object.
30895         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30896         #
30897         Other differences between PUT and PATCH are:
30898         #
30899         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30900         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30901         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30902       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30903       consumes:
30904         - application/json
30905         - application/xml
30906       produces:
30907         - application/json
30908         - application/xml
30909       responses:
30910         "default":
30911           description: Response codes found in [response codes](https://wiki.onap.org/).
30912       parameters:
30913         - name: vnf-id
30914           in: path
30915           description: Unique id of VNF.  This is unique across the graph.
30916           required: true
30917           type: string
30918           example: __VNF-ID__
30919         - name: interface-name
30920           in: path
30921           description: Name that identifies the link aggregate interface
30922           required: true
30923           type: string
30924           example: __INTERFACE-NAME__
30925         - name: interface-name
30926           in: path
30927           description: Name given to the interface
30928           required: true
30929           type: string
30930           example: __INTERFACE-NAME__
30931         - name: l3-interface-ipv4-address
30932           in: path
30933           description: IP address
30934           required: true
30935           type: string
30936           example: __L3-INTERFACE-IPV4-ADDRESS__
30937         - name: body
30938           in: body
30939           description: l3-interface-ipv4-address-list object that needs to be updated.
30940           required: true
30941           schema:
30942             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30943     delete:
30944       tags:
30945         - Network
30946       summary: delete an existing l3-interface-ipv4-address-list
30947       description: delete an existing l3-interface-ipv4-address-list
30948       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30949       consumes:
30950         - application/json
30951         - application/xml
30952       produces:
30953         - application/json
30954         - application/xml
30955       responses:
30956         "default":
30957           description: Response codes found in [response codes](https://wiki.onap.org/).
30958       parameters:
30959         - name: vnf-id
30960           in: path
30961           description: Unique id of VNF.  This is unique across the graph.
30962           required: true
30963           type: string
30964           example: __VNF-ID__
30965         - name: interface-name
30966           in: path
30967           description: Name that identifies the link aggregate interface
30968           required: true
30969           type: string
30970           example: __INTERFACE-NAME__
30971         - name: interface-name
30972           in: path
30973           description: Name given to the interface
30974           required: true
30975           type: string
30976           example: __INTERFACE-NAME__
30977         - name: l3-interface-ipv4-address
30978           in: path
30979           description: IP address
30980           required: true
30981           type: string
30982           example: __L3-INTERFACE-IPV4-ADDRESS__
30983         - name: resource-version
30984           in: query
30985           description: resource-version for concurrency
30986           required: true
30987           type: string
30988   /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:
30989     put:
30990       tags:
30991         - Network
30992       summary: see node definition for valid relationships
30993       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30994       consumes:
30995         - application/json
30996         - application/xml
30997       produces:
30998         - application/json
30999         - application/xml
31000       responses:
31001         "default":
31002           description: Response codes found in [response codes](https://wiki.onap.org/).
31003       parameters:
31004         - name: vnf-id
31005           in: path
31006           description: Unique id of VNF.  This is unique across the graph.
31007           required: true
31008           type: string
31009           example: __VNF-ID__
31010         - name: interface-name
31011           in: path
31012           description: Name that identifies the link aggregate interface
31013           required: true
31014           type: string
31015           example: __INTERFACE-NAME__
31016         - name: interface-name
31017           in: path
31018           description: Name given to the interface
31019           required: true
31020           type: string
31021           example: __INTERFACE-NAME__
31022         - name: l3-interface-ipv6-address
31023           in: path
31024           description: IP address
31025           required: true
31026           type: string
31027           example: __L3-INTERFACE-IPV6-ADDRESS__
31028         - name: body
31029           in: body
31030           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31031           required: true
31032           schema:
31033             $ref: "#/definitions/relationship"
31034     delete:
31035       tags:
31036         - Network
31037       summary: delete an existing relationship
31038       description: delete an existing relationship
31039       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31040       consumes:
31041         - application/json
31042         - application/xml
31043       produces:
31044         - application/json
31045         - application/xml
31046       responses:
31047         "default":
31048           description: Response codes found in [response codes](https://wiki.onap.org/).
31049       parameters:
31050         - name: vnf-id
31051           in: path
31052           description: Unique id of VNF.  This is unique across the graph.
31053           required: true
31054           type: string
31055           example: __VNF-ID__
31056         - name: interface-name
31057           in: path
31058           description: Name that identifies the link aggregate interface
31059           required: true
31060           type: string
31061           example: __INTERFACE-NAME__
31062         - name: interface-name
31063           in: path
31064           description: Name given to the interface
31065           required: true
31066           type: string
31067           example: __INTERFACE-NAME__
31068         - name: l3-interface-ipv6-address
31069           in: path
31070           description: IP address
31071           required: true
31072           type: string
31073           example: __L3-INTERFACE-IPV6-ADDRESS__
31074   /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}:
31075     get:
31076       tags:
31077         - Network
31078       summary: returns l3-interface-ipv6-address-list
31079       description: returns l3-interface-ipv6-address-list
31080       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31081       produces:
31082         - application/json
31083         - application/xml
31084       responses:
31085         "200":
31086           description: successful operation
31087           schema:
31088               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31089         "default":
31090           description: Response codes found in [response codes](https://wiki.onap.org/).
31091       parameters:
31092         - name: vnf-id
31093           in: path
31094           description: Unique id of VNF.  This is unique across the graph.
31095           required: true
31096           type: string
31097           example: __VNF-ID__
31098         - name: interface-name
31099           in: path
31100           description: Name that identifies the link aggregate interface
31101           required: true
31102           type: string
31103           example: __INTERFACE-NAME__
31104         - name: interface-name
31105           in: path
31106           description: Name given to the interface
31107           required: true
31108           type: string
31109           example: __INTERFACE-NAME__
31110         - name: l3-interface-ipv6-address
31111           in: path
31112           description: IP address
31113           required: true
31114           type: string
31115           example: __L3-INTERFACE-IPV6-ADDRESS__
31116     put:
31117       tags:
31118         - Network
31119       summary: create or update an existing l3-interface-ipv6-address-list
31120       description: |
31121         Create or update an existing l3-interface-ipv6-address-list.
31122         #
31123         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31124       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31125       consumes:
31126         - application/json
31127         - application/xml
31128       produces:
31129         - application/json
31130         - application/xml
31131       responses:
31132         "default":
31133           description: Response codes found in [response codes](https://wiki.onap.org/).
31134       parameters:
31135         - name: vnf-id
31136           in: path
31137           description: Unique id of VNF.  This is unique across the graph.
31138           required: true
31139           type: string
31140           example: __VNF-ID__
31141         - name: interface-name
31142           in: path
31143           description: Name that identifies the link aggregate interface
31144           required: true
31145           type: string
31146           example: __INTERFACE-NAME__
31147         - name: interface-name
31148           in: path
31149           description: Name given to the interface
31150           required: true
31151           type: string
31152           example: __INTERFACE-NAME__
31153         - name: l3-interface-ipv6-address
31154           in: path
31155           description: IP address
31156           required: true
31157           type: string
31158           example: __L3-INTERFACE-IPV6-ADDRESS__
31159         - name: body
31160           in: body
31161           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31162           required: true
31163           schema:
31164             $ref: "#/definitions/l3-interface-ipv6-address-list"
31165     patch:
31166       tags:
31167         - Network
31168       summary: update an existing l3-interface-ipv6-address-list
31169       description: |
31170         Update an existing l3-interface-ipv6-address-list
31171         #
31172         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31173         The PUT operation will entirely replace an existing object.
31174         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31175         #
31176         Other differences between PUT and PATCH are:
31177         #
31178         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31179         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31180         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31181       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31182       consumes:
31183         - application/json
31184         - application/xml
31185       produces:
31186         - application/json
31187         - application/xml
31188       responses:
31189         "default":
31190           description: Response codes found in [response codes](https://wiki.onap.org/).
31191       parameters:
31192         - name: vnf-id
31193           in: path
31194           description: Unique id of VNF.  This is unique across the graph.
31195           required: true
31196           type: string
31197           example: __VNF-ID__
31198         - name: interface-name
31199           in: path
31200           description: Name that identifies the link aggregate interface
31201           required: true
31202           type: string
31203           example: __INTERFACE-NAME__
31204         - name: interface-name
31205           in: path
31206           description: Name given to the interface
31207           required: true
31208           type: string
31209           example: __INTERFACE-NAME__
31210         - name: l3-interface-ipv6-address
31211           in: path
31212           description: IP address
31213           required: true
31214           type: string
31215           example: __L3-INTERFACE-IPV6-ADDRESS__
31216         - name: body
31217           in: body
31218           description: l3-interface-ipv6-address-list object that needs to be updated.
31219           required: true
31220           schema:
31221             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31222     delete:
31223       tags:
31224         - Network
31225       summary: delete an existing l3-interface-ipv6-address-list
31226       description: delete an existing l3-interface-ipv6-address-list
31227       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31228       consumes:
31229         - application/json
31230         - application/xml
31231       produces:
31232         - application/json
31233         - application/xml
31234       responses:
31235         "default":
31236           description: Response codes found in [response codes](https://wiki.onap.org/).
31237       parameters:
31238         - name: vnf-id
31239           in: path
31240           description: Unique id of VNF.  This is unique across the graph.
31241           required: true
31242           type: string
31243           example: __VNF-ID__
31244         - name: interface-name
31245           in: path
31246           description: Name that identifies the link aggregate interface
31247           required: true
31248           type: string
31249           example: __INTERFACE-NAME__
31250         - name: interface-name
31251           in: path
31252           description: Name given to the interface
31253           required: true
31254           type: string
31255           example: __INTERFACE-NAME__
31256         - name: l3-interface-ipv6-address
31257           in: path
31258           description: IP address
31259           required: true
31260           type: string
31261           example: __L3-INTERFACE-IPV6-ADDRESS__
31262         - name: resource-version
31263           in: query
31264           description: resource-version for concurrency
31265           required: true
31266           type: string
31267   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
31268     get:
31269       tags:
31270         - Network
31271       summary: returns l-interface
31272       description: returns l-interface
31273       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31274       produces:
31275         - application/json
31276         - application/xml
31277       responses:
31278         "200":
31279           description: successful operation
31280           schema:
31281               $ref: "#/getDefinitions/l-interface"
31282         "default":
31283           description: Response codes found in [response codes](https://wiki.onap.org/).
31284       parameters:
31285         - name: vnf-id
31286           in: path
31287           description: Unique id of VNF.  This is unique across the graph.
31288           required: true
31289           type: string
31290           example: __VNF-ID__
31291         - name: interface-name
31292           in: path
31293           description: Name that identifies the link aggregate interface
31294           required: true
31295           type: string
31296           example: __INTERFACE-NAME__
31297         - name: interface-name
31298           in: path
31299           description: Name given to the interface
31300           required: true
31301           type: string
31302           example: __INTERFACE-NAME__
31303     put:
31304       tags:
31305         - Network
31306       summary: create or update an existing l-interface
31307       description: |
31308         Create or update an existing l-interface.
31309         #
31310         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31311       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31312       consumes:
31313         - application/json
31314         - application/xml
31315       produces:
31316         - application/json
31317         - application/xml
31318       responses:
31319         "default":
31320           description: Response codes found in [response codes](https://wiki.onap.org/).
31321       parameters:
31322         - name: vnf-id
31323           in: path
31324           description: Unique id of VNF.  This is unique across the graph.
31325           required: true
31326           type: string
31327           example: __VNF-ID__
31328         - name: interface-name
31329           in: path
31330           description: Name that identifies the link aggregate interface
31331           required: true
31332           type: string
31333           example: __INTERFACE-NAME__
31334         - name: interface-name
31335           in: path
31336           description: Name given to the interface
31337           required: true
31338           type: string
31339           example: __INTERFACE-NAME__
31340         - name: body
31341           in: body
31342           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
31343           required: true
31344           schema:
31345             $ref: "#/definitions/l-interface"
31346     patch:
31347       tags:
31348         - Network
31349       summary: update an existing l-interface
31350       description: |
31351         Update an existing l-interface
31352         #
31353         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31354         The PUT operation will entirely replace an existing object.
31355         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31356         #
31357         Other differences between PUT and PATCH are:
31358         #
31359         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31360         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31361         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31362       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31363       consumes:
31364         - application/json
31365         - application/xml
31366       produces:
31367         - application/json
31368         - application/xml
31369       responses:
31370         "default":
31371           description: Response codes found in [response codes](https://wiki.onap.org/).
31372       parameters:
31373         - name: vnf-id
31374           in: path
31375           description: Unique id of VNF.  This is unique across the graph.
31376           required: true
31377           type: string
31378           example: __VNF-ID__
31379         - name: interface-name
31380           in: path
31381           description: Name that identifies the link aggregate interface
31382           required: true
31383           type: string
31384           example: __INTERFACE-NAME__
31385         - name: interface-name
31386           in: path
31387           description: Name given to the interface
31388           required: true
31389           type: string
31390           example: __INTERFACE-NAME__
31391         - name: body
31392           in: body
31393           description: l-interface object that needs to be updated.
31394           required: true
31395           schema:
31396             $ref: "#/patchDefinitions/l-interface"
31397     delete:
31398       tags:
31399         - Network
31400       summary: delete an existing l-interface
31401       description: delete an existing l-interface
31402       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31403       consumes:
31404         - application/json
31405         - application/xml
31406       produces:
31407         - application/json
31408         - application/xml
31409       responses:
31410         "default":
31411           description: Response codes found in [response codes](https://wiki.onap.org/).
31412       parameters:
31413         - name: vnf-id
31414           in: path
31415           description: Unique id of VNF.  This is unique across the graph.
31416           required: true
31417           type: string
31418           example: __VNF-ID__
31419         - name: interface-name
31420           in: path
31421           description: Name that identifies the link aggregate interface
31422           required: true
31423           type: string
31424           example: __INTERFACE-NAME__
31425         - name: interface-name
31426           in: path
31427           description: Name given to the interface
31428           required: true
31429           type: string
31430           example: __INTERFACE-NAME__
31431         - name: resource-version
31432           in: query
31433           description: resource-version for concurrency
31434           required: true
31435           type: string
31436   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
31437     get:
31438       tags:
31439         - Network
31440       summary: returns l-interfaces
31441       description: returns l-interfaces
31442       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
31443       produces:
31444         - application/json
31445         - application/xml
31446       responses:
31447         "200":
31448           description: successful operation
31449           schema:
31450               $ref: "#/getDefinitions/l-interfaces"
31451         "default":
31452           description: Response codes found in [response codes](https://wiki.onap.org/).
31453       parameters:
31454         - name: vnf-id
31455           in: path
31456           description: Unique id of VNF.  This is unique across the graph.
31457           required: true
31458           type: string
31459           example: __VNF-ID__
31460         - name: interface-name
31461           in: path
31462           description: Name that identifies the link aggregate interface
31463           required: true
31464           type: string
31465           example: __INTERFACE-NAME__
31466         - name: interface-name
31467           in: query
31468           description:
31469           required: false
31470           type: string
31471         - name: interface-id
31472           in: query
31473           description:
31474           required: false
31475           type: string
31476         - name: macaddr
31477           in: query
31478           description:
31479           required: false
31480           type: string
31481         - name: network-name
31482           in: query
31483           description:
31484           required: false
31485           type: string
31486   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
31487     get:
31488       tags:
31489         - Network
31490       summary: returns lag-interface
31491       description: returns lag-interface
31492       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31493       produces:
31494         - application/json
31495         - application/xml
31496       responses:
31497         "200":
31498           description: successful operation
31499           schema:
31500               $ref: "#/getDefinitions/lag-interface"
31501         "default":
31502           description: Response codes found in [response codes](https://wiki.onap.org/).
31503       parameters:
31504         - name: vnf-id
31505           in: path
31506           description: Unique id of VNF.  This is unique across the graph.
31507           required: true
31508           type: string
31509           example: __VNF-ID__
31510         - name: interface-name
31511           in: path
31512           description: Name that identifies the link aggregate interface
31513           required: true
31514           type: string
31515           example: __INTERFACE-NAME__
31516     put:
31517       tags:
31518         - Network
31519       summary: create or update an existing lag-interface
31520       description: |
31521         Create or update an existing lag-interface.
31522         #
31523         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31524       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31525       consumes:
31526         - application/json
31527         - application/xml
31528       produces:
31529         - application/json
31530         - application/xml
31531       responses:
31532         "default":
31533           description: Response codes found in [response codes](https://wiki.onap.org/).
31534       parameters:
31535         - name: vnf-id
31536           in: path
31537           description: Unique id of VNF.  This is unique across the graph.
31538           required: true
31539           type: string
31540           example: __VNF-ID__
31541         - name: interface-name
31542           in: path
31543           description: Name that identifies the link aggregate interface
31544           required: true
31545           type: string
31546           example: __INTERFACE-NAME__
31547         - name: body
31548           in: body
31549           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
31550           required: true
31551           schema:
31552             $ref: "#/definitions/lag-interface"
31553     patch:
31554       tags:
31555         - Network
31556       summary: update an existing lag-interface
31557       description: |
31558         Update an existing lag-interface
31559         #
31560         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31561         The PUT operation will entirely replace an existing object.
31562         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31563         #
31564         Other differences between PUT and PATCH are:
31565         #
31566         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31567         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31568         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31569       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31570       consumes:
31571         - application/json
31572         - application/xml
31573       produces:
31574         - application/json
31575         - application/xml
31576       responses:
31577         "default":
31578           description: Response codes found in [response codes](https://wiki.onap.org/).
31579       parameters:
31580         - name: vnf-id
31581           in: path
31582           description: Unique id of VNF.  This is unique across the graph.
31583           required: true
31584           type: string
31585           example: __VNF-ID__
31586         - name: interface-name
31587           in: path
31588           description: Name that identifies the link aggregate interface
31589           required: true
31590           type: string
31591           example: __INTERFACE-NAME__
31592         - name: body
31593           in: body
31594           description: lag-interface object that needs to be updated.
31595           required: true
31596           schema:
31597             $ref: "#/patchDefinitions/lag-interface"
31598     delete:
31599       tags:
31600         - Network
31601       summary: delete an existing lag-interface
31602       description: delete an existing lag-interface
31603       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31604       consumes:
31605         - application/json
31606         - application/xml
31607       produces:
31608         - application/json
31609         - application/xml
31610       responses:
31611         "default":
31612           description: Response codes found in [response codes](https://wiki.onap.org/).
31613       parameters:
31614         - name: vnf-id
31615           in: path
31616           description: Unique id of VNF.  This is unique across the graph.
31617           required: true
31618           type: string
31619           example: __VNF-ID__
31620         - name: interface-name
31621           in: path
31622           description: Name that identifies the link aggregate interface
31623           required: true
31624           type: string
31625           example: __INTERFACE-NAME__
31626         - name: resource-version
31627           in: query
31628           description: resource-version for concurrency
31629           required: true
31630           type: string
31631   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
31632     get:
31633       tags:
31634         - Network
31635       summary: returns lag-interfaces
31636       description: returns lag-interfaces
31637       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
31638       produces:
31639         - application/json
31640         - application/xml
31641       responses:
31642         "200":
31643           description: successful operation
31644           schema:
31645               $ref: "#/getDefinitions/lag-interfaces"
31646         "default":
31647           description: Response codes found in [response codes](https://wiki.onap.org/).
31648       parameters:
31649         - name: vnf-id
31650           in: path
31651           description: Unique id of VNF.  This is unique across the graph.
31652           required: true
31653           type: string
31654           example: __VNF-ID__
31655         - name: interface-name
31656           in: query
31657           description:
31658           required: false
31659           type: string
31660         - name: interface-id
31661           in: query
31662           description:
31663           required: false
31664           type: string
31665         - name: interface-role
31666           in: query
31667           description:
31668           required: false
31669           type: string
31670   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
31671     put:
31672       tags:
31673         - Network
31674       summary: see node definition for valid relationships
31675       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31676       consumes:
31677         - application/json
31678         - application/xml
31679       produces:
31680         - application/json
31681         - application/xml
31682       responses:
31683         "default":
31684           description: Response codes found in [response codes](https://wiki.onap.org/).
31685       parameters:
31686         - name: vnf-id
31687           in: path
31688           description: Unique id of VNF.  This is unique across the graph.
31689           required: true
31690           type: string
31691           example: __VNF-ID__
31692         - name: vf-module-id
31693           in: path
31694           description: Unique ID of vf-module.
31695           required: true
31696           type: string
31697           example: __VF-MODULE-ID__
31698         - name: body
31699           in: body
31700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31701           required: true
31702           schema:
31703             $ref: "#/definitions/relationship"
31704     delete:
31705       tags:
31706         - Network
31707       summary: delete an existing relationship
31708       description: delete an existing relationship
31709       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
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-id
31721           in: path
31722           description: Unique id of VNF.  This is unique across the graph.
31723           required: true
31724           type: string
31725           example: __VNF-ID__
31726         - name: vf-module-id
31727           in: path
31728           description: Unique ID of vf-module.
31729           required: true
31730           type: string
31731           example: __VF-MODULE-ID__
31732   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
31733     get:
31734       tags:
31735         - Network
31736       summary: returns vf-module
31737       description: returns vf-module
31738       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
31739       produces:
31740         - application/json
31741         - application/xml
31742       responses:
31743         "200":
31744           description: successful operation
31745           schema:
31746               $ref: "#/getDefinitions/vf-module"
31747         "default":
31748           description: Response codes found in [response codes](https://wiki.onap.org/).
31749       parameters:
31750         - name: vnf-id
31751           in: path
31752           description: Unique id of VNF.  This is unique across the graph.
31753           required: true
31754           type: string
31755           example: __VNF-ID__
31756         - name: vf-module-id
31757           in: path
31758           description: Unique ID of vf-module.
31759           required: true
31760           type: string
31761           example: __VF-MODULE-ID__
31762     put:
31763       tags:
31764         - Network
31765       summary: create or update an existing vf-module
31766       description: |
31767         Create or update an existing vf-module.
31768         #
31769         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31770       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31771       consumes:
31772         - application/json
31773         - application/xml
31774       produces:
31775         - application/json
31776         - application/xml
31777       responses:
31778         "default":
31779           description: Response codes found in [response codes](https://wiki.onap.org/).
31780       parameters:
31781         - name: vnf-id
31782           in: path
31783           description: Unique id of VNF.  This is unique across the graph.
31784           required: true
31785           type: string
31786           example: __VNF-ID__
31787         - name: vf-module-id
31788           in: path
31789           description: Unique ID of vf-module.
31790           required: true
31791           type: string
31792           example: __VF-MODULE-ID__
31793         - name: body
31794           in: body
31795           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31796           required: true
31797           schema:
31798             $ref: "#/definitions/vf-module"
31799     patch:
31800       tags:
31801         - Network
31802       summary: update an existing vf-module
31803       description: |
31804         Update an existing vf-module
31805         #
31806         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31807         The PUT operation will entirely replace an existing object.
31808         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31809         #
31810         Other differences between PUT and PATCH are:
31811         #
31812         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31813         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31814         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31815       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31816       consumes:
31817         - application/json
31818         - application/xml
31819       produces:
31820         - application/json
31821         - application/xml
31822       responses:
31823         "default":
31824           description: Response codes found in [response codes](https://wiki.onap.org/).
31825       parameters:
31826         - name: vnf-id
31827           in: path
31828           description: Unique id of VNF.  This is unique across the graph.
31829           required: true
31830           type: string
31831           example: __VNF-ID__
31832         - name: vf-module-id
31833           in: path
31834           description: Unique ID of vf-module.
31835           required: true
31836           type: string
31837           example: __VF-MODULE-ID__
31838         - name: body
31839           in: body
31840           description: vf-module object that needs to be updated.
31841           required: true
31842           schema:
31843             $ref: "#/patchDefinitions/vf-module"
31844     delete:
31845       tags:
31846         - Network
31847       summary: delete an existing vf-module
31848       description: delete an existing vf-module
31849       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
31850       consumes:
31851         - application/json
31852         - application/xml
31853       produces:
31854         - application/json
31855         - application/xml
31856       responses:
31857         "default":
31858           description: Response codes found in [response codes](https://wiki.onap.org/).
31859       parameters:
31860         - name: vnf-id
31861           in: path
31862           description: Unique id of VNF.  This is unique across the graph.
31863           required: true
31864           type: string
31865           example: __VNF-ID__
31866         - name: vf-module-id
31867           in: path
31868           description: Unique ID of vf-module.
31869           required: true
31870           type: string
31871           example: __VF-MODULE-ID__
31872         - name: resource-version
31873           in: query
31874           description: resource-version for concurrency
31875           required: true
31876           type: string
31877   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
31878     get:
31879       tags:
31880         - Network
31881       summary: returns vf-modules
31882       description: returns vf-modules
31883       operationId: getNetworkGenericVnfsGenericVnfVfModules
31884       produces:
31885         - application/json
31886         - application/xml
31887       responses:
31888         "200":
31889           description: successful operation
31890           schema:
31891               $ref: "#/getDefinitions/vf-modules"
31892         "default":
31893           description: Response codes found in [response codes](https://wiki.onap.org/).
31894       parameters:
31895         - name: vnf-id
31896           in: path
31897           description: Unique id of VNF.  This is unique across the graph.
31898           required: true
31899           type: string
31900           example: __VNF-ID__
31901         - name: vf-module-id
31902           in: query
31903           description:
31904           required: false
31905           type: string
31906         - name: vf-module-name
31907           in: query
31908           description:
31909           required: false
31910           type: string
31911         - name: heat-stack-id
31912           in: query
31913           description:
31914           required: false
31915           type: string
31916         - name: model-invariant-id
31917           in: query
31918           description:
31919           required: false
31920           type: string
31921         - name: model-version-id
31922           in: query
31923           description:
31924           required: false
31925           type: string
31926         - name: widget-model-id
31927           in: query
31928           description:
31929           required: false
31930           type: string
31931         - name: widget-model-version
31932           in: query
31933           description:
31934           required: false
31935           type: string
31936         - name: contrail-service-instance-fqdn
31937           in: query
31938           description:
31939           required: false
31940           type: string
31941   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31942     put:
31943       tags:
31944         - Network
31945       summary: see node definition for valid relationships
31946       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31947       consumes:
31948         - application/json
31949         - application/xml
31950       produces:
31951         - application/json
31952         - application/xml
31953       responses:
31954         "default":
31955           description: Response codes found in [response codes](https://wiki.onap.org/).
31956       parameters:
31957         - name: vnf-id
31958           in: path
31959           description: Unique id of VNF.  This is unique across the graph.
31960           required: true
31961           type: string
31962           example: __VNF-ID__
31963         - name: group-uuid
31964           in: path
31965           description: Unique ID for the license group the resource belongs to, should be uuid.
31966           required: true
31967           type: string
31968           example: __GROUP-UUID__
31969         - name: resource-uuid
31970           in: path
31971           description: Unique ID of a license resource.
31972           required: true
31973           type: string
31974           example: __RESOURCE-UUID__
31975         - name: body
31976           in: body
31977           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31978           required: true
31979           schema:
31980             $ref: "#/definitions/relationship"
31981     delete:
31982       tags:
31983         - Network
31984       summary: delete an existing relationship
31985       description: delete an existing relationship
31986       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31987       consumes:
31988         - application/json
31989         - application/xml
31990       produces:
31991         - application/json
31992         - application/xml
31993       responses:
31994         "default":
31995           description: Response codes found in [response codes](https://wiki.onap.org/).
31996       parameters:
31997         - name: vnf-id
31998           in: path
31999           description: Unique id of VNF.  This is unique across the graph.
32000           required: true
32001           type: string
32002           example: __VNF-ID__
32003         - name: group-uuid
32004           in: path
32005           description: Unique ID for the license group the resource belongs to, should be uuid.
32006           required: true
32007           type: string
32008           example: __GROUP-UUID__
32009         - name: resource-uuid
32010           in: path
32011           description: Unique ID of a license resource.
32012           required: true
32013           type: string
32014           example: __RESOURCE-UUID__
32015   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
32016     get:
32017       tags:
32018         - Network
32019       summary: returns license
32020       description: returns license
32021       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
32022       produces:
32023         - application/json
32024         - application/xml
32025       responses:
32026         "200":
32027           description: successful operation
32028           schema:
32029               $ref: "#/getDefinitions/license"
32030         "default":
32031           description: Response codes found in [response codes](https://wiki.onap.org/).
32032       parameters:
32033         - name: vnf-id
32034           in: path
32035           description: Unique id of VNF.  This is unique across the graph.
32036           required: true
32037           type: string
32038           example: __VNF-ID__
32039         - name: group-uuid
32040           in: path
32041           description: Unique ID for the license group the resource belongs to, should be uuid.
32042           required: true
32043           type: string
32044           example: __GROUP-UUID__
32045         - name: resource-uuid
32046           in: path
32047           description: Unique ID of a license resource.
32048           required: true
32049           type: string
32050           example: __RESOURCE-UUID__
32051     put:
32052       tags:
32053         - Network
32054       summary: create or update an existing license
32055       description: |
32056         Create or update an existing license.
32057         #
32058         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32059       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
32060       consumes:
32061         - application/json
32062         - application/xml
32063       produces:
32064         - application/json
32065         - application/xml
32066       responses:
32067         "default":
32068           description: Response codes found in [response codes](https://wiki.onap.org/).
32069       parameters:
32070         - name: vnf-id
32071           in: path
32072           description: Unique id of VNF.  This is unique across the graph.
32073           required: true
32074           type: string
32075           example: __VNF-ID__
32076         - name: group-uuid
32077           in: path
32078           description: Unique ID for the license group the resource belongs to, should be uuid.
32079           required: true
32080           type: string
32081           example: __GROUP-UUID__
32082         - name: resource-uuid
32083           in: path
32084           description: Unique ID of a license resource.
32085           required: true
32086           type: string
32087           example: __RESOURCE-UUID__
32088         - name: body
32089           in: body
32090           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
32091           required: true
32092           schema:
32093             $ref: "#/definitions/license"
32094     patch:
32095       tags:
32096         - Network
32097       summary: update an existing license
32098       description: |
32099         Update an existing license
32100         #
32101         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32102         The PUT operation will entirely replace an existing object.
32103         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32104         #
32105         Other differences between PUT and PATCH are:
32106         #
32107         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32108         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32109         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32110       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
32111       consumes:
32112         - application/json
32113         - application/xml
32114       produces:
32115         - application/json
32116         - application/xml
32117       responses:
32118         "default":
32119           description: Response codes found in [response codes](https://wiki.onap.org/).
32120       parameters:
32121         - name: vnf-id
32122           in: path
32123           description: Unique id of VNF.  This is unique across the graph.
32124           required: true
32125           type: string
32126           example: __VNF-ID__
32127         - name: group-uuid
32128           in: path
32129           description: Unique ID for the license group the resource belongs to, should be uuid.
32130           required: true
32131           type: string
32132           example: __GROUP-UUID__
32133         - name: resource-uuid
32134           in: path
32135           description: Unique ID of a license resource.
32136           required: true
32137           type: string
32138           example: __RESOURCE-UUID__
32139         - name: body
32140           in: body
32141           description: license object that needs to be updated.
32142           required: true
32143           schema:
32144             $ref: "#/patchDefinitions/license"
32145     delete:
32146       tags:
32147         - Network
32148       summary: delete an existing license
32149       description: delete an existing license
32150       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
32151       consumes:
32152         - application/json
32153         - application/xml
32154       produces:
32155         - application/json
32156         - application/xml
32157       responses:
32158         "default":
32159           description: Response codes found in [response codes](https://wiki.onap.org/).
32160       parameters:
32161         - name: vnf-id
32162           in: path
32163           description: Unique id of VNF.  This is unique across the graph.
32164           required: true
32165           type: string
32166           example: __VNF-ID__
32167         - name: group-uuid
32168           in: path
32169           description: Unique ID for the license group the resource belongs to, should be uuid.
32170           required: true
32171           type: string
32172           example: __GROUP-UUID__
32173         - name: resource-uuid
32174           in: path
32175           description: Unique ID of a license resource.
32176           required: true
32177           type: string
32178           example: __RESOURCE-UUID__
32179         - name: resource-version
32180           in: query
32181           description: resource-version for concurrency
32182           required: true
32183           type: string
32184   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
32185     get:
32186       tags:
32187         - Network
32188       summary: returns licenses
32189       description: returns licenses
32190       operationId: getNetworkGenericVnfsGenericVnfLicenses
32191       produces:
32192         - application/json
32193         - application/xml
32194       responses:
32195         "200":
32196           description: successful operation
32197           schema:
32198               $ref: "#/getDefinitions/licenses"
32199         "default":
32200           description: Response codes found in [response codes](https://wiki.onap.org/).
32201       parameters:
32202         - name: vnf-id
32203           in: path
32204           description: Unique id of VNF.  This is unique across the graph.
32205           required: true
32206           type: string
32207           example: __VNF-ID__
32208         - name: group-uuid
32209           in: query
32210           description:
32211           required: false
32212           type: string
32213         - name: resource-uuid
32214           in: query
32215           description:
32216           required: false
32217           type: string
32218   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
32219     put:
32220       tags:
32221         - Network
32222       summary: see node definition for valid relationships
32223       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
32224       consumes:
32225         - application/json
32226         - application/xml
32227       produces:
32228         - application/json
32229         - application/xml
32230       responses:
32231         "default":
32232           description: Response codes found in [response codes](https://wiki.onap.org/).
32233       parameters:
32234         - name: vnf-id
32235           in: path
32236           description: Unique id of VNF.  This is unique across the graph.
32237           required: true
32238           type: string
32239           example: __VNF-ID__
32240         - name: group-uuid
32241           in: path
32242           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32243           required: true
32244           type: string
32245           example: __GROUP-UUID__
32246         - name: resource-uuid
32247           in: path
32248           description: Unique ID of an entitlement resource.
32249           required: true
32250           type: string
32251           example: __RESOURCE-UUID__
32252         - name: body
32253           in: body
32254           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32255           required: true
32256           schema:
32257             $ref: "#/definitions/relationship"
32258     delete:
32259       tags:
32260         - Network
32261       summary: delete an existing relationship
32262       description: delete an existing relationship
32263       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
32264       consumes:
32265         - application/json
32266         - application/xml
32267       produces:
32268         - application/json
32269         - application/xml
32270       responses:
32271         "default":
32272           description: Response codes found in [response codes](https://wiki.onap.org/).
32273       parameters:
32274         - name: vnf-id
32275           in: path
32276           description: Unique id of VNF.  This is unique across the graph.
32277           required: true
32278           type: string
32279           example: __VNF-ID__
32280         - name: group-uuid
32281           in: path
32282           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32283           required: true
32284           type: string
32285           example: __GROUP-UUID__
32286         - name: resource-uuid
32287           in: path
32288           description: Unique ID of an entitlement resource.
32289           required: true
32290           type: string
32291           example: __RESOURCE-UUID__
32292   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
32293     get:
32294       tags:
32295         - Network
32296       summary: returns entitlement
32297       description: returns entitlement
32298       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32299       produces:
32300         - application/json
32301         - application/xml
32302       responses:
32303         "200":
32304           description: successful operation
32305           schema:
32306               $ref: "#/getDefinitions/entitlement"
32307         "default":
32308           description: Response codes found in [response codes](https://wiki.onap.org/).
32309       parameters:
32310         - name: vnf-id
32311           in: path
32312           description: Unique id of VNF.  This is unique across the graph.
32313           required: true
32314           type: string
32315           example: __VNF-ID__
32316         - name: group-uuid
32317           in: path
32318           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32319           required: true
32320           type: string
32321           example: __GROUP-UUID__
32322         - name: resource-uuid
32323           in: path
32324           description: Unique ID of an entitlement resource.
32325           required: true
32326           type: string
32327           example: __RESOURCE-UUID__
32328     put:
32329       tags:
32330         - Network
32331       summary: create or update an existing entitlement
32332       description: |
32333         Create or update an existing entitlement.
32334         #
32335         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32336       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32337       consumes:
32338         - application/json
32339         - application/xml
32340       produces:
32341         - application/json
32342         - application/xml
32343       responses:
32344         "default":
32345           description: Response codes found in [response codes](https://wiki.onap.org/).
32346       parameters:
32347         - name: vnf-id
32348           in: path
32349           description: Unique id of VNF.  This is unique across the graph.
32350           required: true
32351           type: string
32352           example: __VNF-ID__
32353         - name: group-uuid
32354           in: path
32355           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32356           required: true
32357           type: string
32358           example: __GROUP-UUID__
32359         - name: resource-uuid
32360           in: path
32361           description: Unique ID of an entitlement resource.
32362           required: true
32363           type: string
32364           example: __RESOURCE-UUID__
32365         - name: body
32366           in: body
32367           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32368           required: true
32369           schema:
32370             $ref: "#/definitions/entitlement"
32371     patch:
32372       tags:
32373         - Network
32374       summary: update an existing entitlement
32375       description: |
32376         Update an existing entitlement
32377         #
32378         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32379         The PUT operation will entirely replace an existing object.
32380         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32381         #
32382         Other differences between PUT and PATCH are:
32383         #
32384         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32385         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32386         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32387       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32388       consumes:
32389         - application/json
32390         - application/xml
32391       produces:
32392         - application/json
32393         - application/xml
32394       responses:
32395         "default":
32396           description: Response codes found in [response codes](https://wiki.onap.org/).
32397       parameters:
32398         - name: vnf-id
32399           in: path
32400           description: Unique id of VNF.  This is unique across the graph.
32401           required: true
32402           type: string
32403           example: __VNF-ID__
32404         - name: group-uuid
32405           in: path
32406           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32407           required: true
32408           type: string
32409           example: __GROUP-UUID__
32410         - name: resource-uuid
32411           in: path
32412           description: Unique ID of an entitlement resource.
32413           required: true
32414           type: string
32415           example: __RESOURCE-UUID__
32416         - name: body
32417           in: body
32418           description: entitlement object that needs to be updated.
32419           required: true
32420           schema:
32421             $ref: "#/patchDefinitions/entitlement"
32422     delete:
32423       tags:
32424         - Network
32425       summary: delete an existing entitlement
32426       description: delete an existing entitlement
32427       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32428       consumes:
32429         - application/json
32430         - application/xml
32431       produces:
32432         - application/json
32433         - application/xml
32434       responses:
32435         "default":
32436           description: Response codes found in [response codes](https://wiki.onap.org/).
32437       parameters:
32438         - name: vnf-id
32439           in: path
32440           description: Unique id of VNF.  This is unique across the graph.
32441           required: true
32442           type: string
32443           example: __VNF-ID__
32444         - name: group-uuid
32445           in: path
32446           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32447           required: true
32448           type: string
32449           example: __GROUP-UUID__
32450         - name: resource-uuid
32451           in: path
32452           description: Unique ID of an entitlement resource.
32453           required: true
32454           type: string
32455           example: __RESOURCE-UUID__
32456         - name: resource-version
32457           in: query
32458           description: resource-version for concurrency
32459           required: true
32460           type: string
32461   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
32462     get:
32463       tags:
32464         - Network
32465       summary: returns entitlements
32466       description: returns entitlements
32467       operationId: getNetworkGenericVnfsGenericVnfEntitlements
32468       produces:
32469         - application/json
32470         - application/xml
32471       responses:
32472         "200":
32473           description: successful operation
32474           schema:
32475               $ref: "#/getDefinitions/entitlements"
32476         "default":
32477           description: Response codes found in [response codes](https://wiki.onap.org/).
32478       parameters:
32479         - name: vnf-id
32480           in: path
32481           description: Unique id of VNF.  This is unique across the graph.
32482           required: true
32483           type: string
32484           example: __VNF-ID__
32485         - name: group-uuid
32486           in: query
32487           description:
32488           required: false
32489           type: string
32490         - name: resource-uuid
32491           in: query
32492           description:
32493           required: false
32494           type: string
32495   /network/generic-vnfs/generic-vnf/{vnf-id}:
32496     get:
32497       tags:
32498         - Network
32499       summary: returns generic-vnf
32500       description: returns generic-vnf
32501       operationId: getNetworkGenericVnfsGenericVnf
32502       produces:
32503         - application/json
32504         - application/xml
32505       responses:
32506         "200":
32507           description: successful operation
32508           schema:
32509               $ref: "#/getDefinitions/generic-vnf"
32510         "default":
32511           description: Response codes found in [response codes](https://wiki.onap.org/).
32512       parameters:
32513         - name: vnf-id
32514           in: path
32515           description: Unique id of VNF.  This is unique across the graph.
32516           required: true
32517           type: string
32518           example: __VNF-ID__
32519     put:
32520       tags:
32521         - Network
32522       summary: create or update an existing generic-vnf
32523       description: |
32524         Create or update an existing generic-vnf.
32525         #
32526         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32527       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
32528       consumes:
32529         - application/json
32530         - application/xml
32531       produces:
32532         - application/json
32533         - application/xml
32534       responses:
32535         "default":
32536           description: Response codes found in [response codes](https://wiki.onap.org/).
32537       parameters:
32538         - name: vnf-id
32539           in: path
32540           description: Unique id of VNF.  This is unique across the graph.
32541           required: true
32542           type: string
32543           example: __VNF-ID__
32544         - name: body
32545           in: body
32546           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
32547           required: true
32548           schema:
32549             $ref: "#/definitions/generic-vnf"
32550     patch:
32551       tags:
32552         - Network
32553       summary: update an existing generic-vnf
32554       description: |
32555         Update an existing generic-vnf
32556         #
32557         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32558         The PUT operation will entirely replace an existing object.
32559         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32560         #
32561         Other differences between PUT and PATCH are:
32562         #
32563         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32564         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32565         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32566       operationId: UpdateNetworkGenericVnfsGenericVnf
32567       consumes:
32568         - application/json
32569         - application/xml
32570       produces:
32571         - application/json
32572         - application/xml
32573       responses:
32574         "default":
32575           description: Response codes found in [response codes](https://wiki.onap.org/).
32576       parameters:
32577         - name: vnf-id
32578           in: path
32579           description: Unique id of VNF.  This is unique across the graph.
32580           required: true
32581           type: string
32582           example: __VNF-ID__
32583         - name: body
32584           in: body
32585           description: generic-vnf object that needs to be updated.
32586           required: true
32587           schema:
32588             $ref: "#/patchDefinitions/generic-vnf"
32589     delete:
32590       tags:
32591         - Network
32592       summary: delete an existing generic-vnf
32593       description: delete an existing generic-vnf
32594       operationId: deleteNetworkGenericVnfsGenericVnf
32595       consumes:
32596         - application/json
32597         - application/xml
32598       produces:
32599         - application/json
32600         - application/xml
32601       responses:
32602         "default":
32603           description: Response codes found in [response codes](https://wiki.onap.org/).
32604       parameters:
32605         - name: vnf-id
32606           in: path
32607           description: Unique id of VNF.  This is unique across the graph.
32608           required: true
32609           type: string
32610           example: __VNF-ID__
32611         - name: resource-version
32612           in: query
32613           description: resource-version for concurrency
32614           required: true
32615           type: string
32616   /network/generic-vnfs:
32617     get:
32618       tags:
32619         - Network
32620       summary: returns generic-vnfs
32621       description: returns generic-vnfs
32622       operationId: getNetworkGenericVnfs
32623       produces:
32624         - application/json
32625         - application/xml
32626       responses:
32627         "200":
32628           description: successful operation
32629           schema:
32630               $ref: "#/getDefinitions/generic-vnfs"
32631         "default":
32632           description: Response codes found in [response codes](https://wiki.onap.org/).
32633       parameters:
32634         - name: vnf-id
32635           in: query
32636           description:
32637           required: false
32638           type: string
32639         - name: vnf-name
32640           in: query
32641           description:
32642           required: false
32643           type: string
32644         - name: vnf-name2
32645           in: query
32646           description:
32647           required: false
32648           type: string
32649         - name: vnf-type
32650           in: query
32651           description:
32652           required: false
32653           type: string
32654         - name: service-id
32655           in: query
32656           description:
32657           required: false
32658           type: string
32659         - name: regional-resource-zone
32660           in: query
32661           description:
32662           required: false
32663           type: string
32664         - name: prov-status
32665           in: query
32666           description:
32667           required: false
32668           type: string
32669         - name: heat-stack-id
32670           in: query
32671           description:
32672           required: false
32673           type: string
32674         - name: in-maint
32675           in: query
32676           description:
32677           required: false
32678           type: boolean
32679         - name: is-closed-loop-disabled
32680           in: query
32681           description:
32682           required: false
32683           type: boolean
32684         - name: model-invariant-id
32685           in: query
32686           description:
32687           required: false
32688           type: string
32689         - name: model-version-id
32690           in: query
32691           description:
32692           required: false
32693           type: string
32694         - name: widget-model-id
32695           in: query
32696           description:
32697           required: false
32698           type: string
32699         - name: widget-model-version
32700           in: query
32701           description:
32702           required: false
32703           type: string
32704         - name: nf-type
32705           in: query
32706           description:
32707           required: false
32708           type: string
32709         - name: nf-function
32710           in: query
32711           description:
32712           required: false
32713           type: string
32714         - name: nf-role
32715           in: query
32716           description:
32717           required: false
32718           type: string
32719         - name: nf-naming-code
32720           in: query
32721           description:
32722           required: false
32723           type: string
32724   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
32725     put:
32726       tags:
32727         - Network
32728       summary: see node definition for valid relationships
32729       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
32730       consumes:
32731         - application/json
32732         - application/xml
32733       produces:
32734         - application/json
32735         - application/xml
32736       responses:
32737         "default":
32738           description: Response codes found in [response codes](https://wiki.onap.org/).
32739       parameters:
32740         - name: link-name
32741           in: path
32742           description: Alphabetical concatenation of lag-interface names
32743           required: true
32744           type: string
32745           example: __LINK-NAME__
32746         - name: body
32747           in: body
32748           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
32749           required: true
32750           schema:
32751             $ref: "#/definitions/relationship"
32752     delete:
32753       tags:
32754         - Network
32755       summary: delete an existing relationship
32756       description: delete an existing relationship
32757       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
32758       consumes:
32759         - application/json
32760         - application/xml
32761       produces:
32762         - application/json
32763         - application/xml
32764       responses:
32765         "default":
32766           description: Response codes found in [response codes](https://wiki.onap.org/).
32767       parameters:
32768         - name: link-name
32769           in: path
32770           description: Alphabetical concatenation of lag-interface names
32771           required: true
32772           type: string
32773           example: __LINK-NAME__
32774   /network/lag-links/lag-link/{link-name}:
32775     get:
32776       tags:
32777         - Network
32778       summary: returns lag-link
32779       description: returns lag-link
32780       operationId: getNetworkLagLinksLagLink
32781       produces:
32782         - application/json
32783         - application/xml
32784       responses:
32785         "200":
32786           description: successful operation
32787           schema:
32788               $ref: "#/getDefinitions/lag-link"
32789         "default":
32790           description: Response codes found in [response codes](https://wiki.onap.org/).
32791       parameters:
32792         - name: link-name
32793           in: path
32794           description: Alphabetical concatenation of lag-interface names
32795           required: true
32796           type: string
32797           example: __LINK-NAME__
32798     put:
32799       tags:
32800         - Network
32801       summary: create or update an existing lag-link
32802       description: |
32803         Create or update an existing lag-link.
32804         #
32805         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32806       operationId: createOrUpdateNetworkLagLinksLagLink
32807       consumes:
32808         - application/json
32809         - application/xml
32810       produces:
32811         - application/json
32812         - application/xml
32813       responses:
32814         "default":
32815           description: Response codes found in [response codes](https://wiki.onap.org/).
32816       parameters:
32817         - name: link-name
32818           in: path
32819           description: Alphabetical concatenation of lag-interface names
32820           required: true
32821           type: string
32822           example: __LINK-NAME__
32823         - name: body
32824           in: body
32825           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
32826           required: true
32827           schema:
32828             $ref: "#/definitions/lag-link"
32829     patch:
32830       tags:
32831         - Network
32832       summary: update an existing lag-link
32833       description: |
32834         Update an existing lag-link
32835         #
32836         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32837         The PUT operation will entirely replace an existing object.
32838         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32839         #
32840         Other differences between PUT and PATCH are:
32841         #
32842         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32843         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32844         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32845       operationId: UpdateNetworkLagLinksLagLink
32846       consumes:
32847         - application/json
32848         - application/xml
32849       produces:
32850         - application/json
32851         - application/xml
32852       responses:
32853         "default":
32854           description: Response codes found in [response codes](https://wiki.onap.org/).
32855       parameters:
32856         - name: link-name
32857           in: path
32858           description: Alphabetical concatenation of lag-interface names
32859           required: true
32860           type: string
32861           example: __LINK-NAME__
32862         - name: body
32863           in: body
32864           description: lag-link object that needs to be updated.
32865           required: true
32866           schema:
32867             $ref: "#/patchDefinitions/lag-link"
32868     delete:
32869       tags:
32870         - Network
32871       summary: delete an existing lag-link
32872       description: delete an existing lag-link
32873       operationId: deleteNetworkLagLinksLagLink
32874       consumes:
32875         - application/json
32876         - application/xml
32877       produces:
32878         - application/json
32879         - application/xml
32880       responses:
32881         "default":
32882           description: Response codes found in [response codes](https://wiki.onap.org/).
32883       parameters:
32884         - name: link-name
32885           in: path
32886           description: Alphabetical concatenation of lag-interface names
32887           required: true
32888           type: string
32889           example: __LINK-NAME__
32890         - name: resource-version
32891           in: query
32892           description: resource-version for concurrency
32893           required: true
32894           type: string
32895   /network/lag-links:
32896     get:
32897       tags:
32898         - Network
32899       summary: returns lag-links
32900       description: returns lag-links
32901       operationId: getNetworkLagLinks
32902       produces:
32903         - application/json
32904         - application/xml
32905       responses:
32906         "200":
32907           description: successful operation
32908           schema:
32909               $ref: "#/getDefinitions/lag-links"
32910         "default":
32911           description: Response codes found in [response codes](https://wiki.onap.org/).
32912       parameters:
32913         - name: link-name
32914           in: query
32915           description:
32916           required: false
32917           type: string
32918   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
32919     put:
32920       tags:
32921         - Network
32922       summary: see node definition for valid relationships
32923       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
32924       consumes:
32925         - application/json
32926         - application/xml
32927       produces:
32928         - application/json
32929         - application/xml
32930       responses:
32931         "default":
32932           description: Response codes found in [response codes](https://wiki.onap.org/).
32933       parameters:
32934         - name: vnf-id2
32935           in: path
32936           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32937           required: true
32938           type: string
32939           example: __VNF-ID2__
32940         - name: body
32941           in: body
32942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
32943           required: true
32944           schema:
32945             $ref: "#/definitions/relationship"
32946     delete:
32947       tags:
32948         - Network
32949       summary: delete an existing relationship
32950       description: delete an existing relationship
32951       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
32952       consumes:
32953         - application/json
32954         - application/xml
32955       produces:
32956         - application/json
32957         - application/xml
32958       responses:
32959         "default":
32960           description: Response codes found in [response codes](https://wiki.onap.org/).
32961       parameters:
32962         - name: vnf-id2
32963           in: path
32964           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32965           required: true
32966           type: string
32967           example: __VNF-ID2__
32968   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32969     put:
32970       tags:
32971         - Network
32972       summary: see node definition for valid relationships
32973       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32974       consumes:
32975         - application/json
32976         - application/xml
32977       produces:
32978         - application/json
32979         - application/xml
32980       responses:
32981         "default":
32982           description: Response codes found in [response codes](https://wiki.onap.org/).
32983       parameters:
32984         - name: vnf-id2
32985           in: path
32986           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32987           required: true
32988           type: string
32989           example: __VNF-ID2__
32990         - name: interface-name
32991           in: path
32992           description: Name given to the interface
32993           required: true
32994           type: string
32995           example: __INTERFACE-NAME__
32996         - name: vlan-interface
32997           in: path
32998           description: String that identifies the interface
32999           required: true
33000           type: string
33001           example: __VLAN-INTERFACE__
33002         - name: body
33003           in: body
33004           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33005           required: true
33006           schema:
33007             $ref: "#/definitions/relationship"
33008     delete:
33009       tags:
33010         - Network
33011       summary: delete an existing relationship
33012       description: delete an existing relationship
33013       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33014       consumes:
33015         - application/json
33016         - application/xml
33017       produces:
33018         - application/json
33019         - application/xml
33020       responses:
33021         "default":
33022           description: Response codes found in [response codes](https://wiki.onap.org/).
33023       parameters:
33024         - name: vnf-id2
33025           in: path
33026           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33027           required: true
33028           type: string
33029           example: __VNF-ID2__
33030         - name: interface-name
33031           in: path
33032           description: Name given to the interface
33033           required: true
33034           type: string
33035           example: __INTERFACE-NAME__
33036         - name: vlan-interface
33037           in: path
33038           description: String that identifies the interface
33039           required: true
33040           type: string
33041           example: __VLAN-INTERFACE__
33042   /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:
33043     put:
33044       tags:
33045         - Network
33046       summary: see node definition for valid relationships
33047       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33048       consumes:
33049         - application/json
33050         - application/xml
33051       produces:
33052         - application/json
33053         - application/xml
33054       responses:
33055         "default":
33056           description: Response codes found in [response codes](https://wiki.onap.org/).
33057       parameters:
33058         - name: vnf-id2
33059           in: path
33060           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33061           required: true
33062           type: string
33063           example: __VNF-ID2__
33064         - name: interface-name
33065           in: path
33066           description: Name given to the interface
33067           required: true
33068           type: string
33069           example: __INTERFACE-NAME__
33070         - name: vlan-interface
33071           in: path
33072           description: String that identifies the interface
33073           required: true
33074           type: string
33075           example: __VLAN-INTERFACE__
33076         - name: l3-interface-ipv4-address
33077           in: path
33078           description: IP address
33079           required: true
33080           type: string
33081           example: __L3-INTERFACE-IPV4-ADDRESS__
33082         - name: body
33083           in: body
33084           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33085           required: true
33086           schema:
33087             $ref: "#/definitions/relationship"
33088     delete:
33089       tags:
33090         - Network
33091       summary: delete an existing relationship
33092       description: delete an existing relationship
33093       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33094       consumes:
33095         - application/json
33096         - application/xml
33097       produces:
33098         - application/json
33099         - application/xml
33100       responses:
33101         "default":
33102           description: Response codes found in [response codes](https://wiki.onap.org/).
33103       parameters:
33104         - name: vnf-id2
33105           in: path
33106           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33107           required: true
33108           type: string
33109           example: __VNF-ID2__
33110         - name: interface-name
33111           in: path
33112           description: Name given to the interface
33113           required: true
33114           type: string
33115           example: __INTERFACE-NAME__
33116         - name: vlan-interface
33117           in: path
33118           description: String that identifies the interface
33119           required: true
33120           type: string
33121           example: __VLAN-INTERFACE__
33122         - name: l3-interface-ipv4-address
33123           in: path
33124           description: IP address
33125           required: true
33126           type: string
33127           example: __L3-INTERFACE-IPV4-ADDRESS__
33128   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33129     get:
33130       tags:
33131         - Network
33132       summary: returns l3-interface-ipv4-address-list
33133       description: returns l3-interface-ipv4-address-list
33134       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33135       produces:
33136         - application/json
33137         - application/xml
33138       responses:
33139         "200":
33140           description: successful operation
33141           schema:
33142               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33143         "default":
33144           description: Response codes found in [response codes](https://wiki.onap.org/).
33145       parameters:
33146         - name: vnf-id2
33147           in: path
33148           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33149           required: true
33150           type: string
33151           example: __VNF-ID2__
33152         - name: interface-name
33153           in: path
33154           description: Name given to the interface
33155           required: true
33156           type: string
33157           example: __INTERFACE-NAME__
33158         - name: vlan-interface
33159           in: path
33160           description: String that identifies the interface
33161           required: true
33162           type: string
33163           example: __VLAN-INTERFACE__
33164         - name: l3-interface-ipv4-address
33165           in: path
33166           description: IP address
33167           required: true
33168           type: string
33169           example: __L3-INTERFACE-IPV4-ADDRESS__
33170     put:
33171       tags:
33172         - Network
33173       summary: create or update an existing l3-interface-ipv4-address-list
33174       description: |
33175         Create or update an existing l3-interface-ipv4-address-list.
33176         #
33177         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33178       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33179       consumes:
33180         - application/json
33181         - application/xml
33182       produces:
33183         - application/json
33184         - application/xml
33185       responses:
33186         "default":
33187           description: Response codes found in [response codes](https://wiki.onap.org/).
33188       parameters:
33189         - name: vnf-id2
33190           in: path
33191           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33192           required: true
33193           type: string
33194           example: __VNF-ID2__
33195         - name: interface-name
33196           in: path
33197           description: Name given to the interface
33198           required: true
33199           type: string
33200           example: __INTERFACE-NAME__
33201         - name: vlan-interface
33202           in: path
33203           description: String that identifies the interface
33204           required: true
33205           type: string
33206           example: __VLAN-INTERFACE__
33207         - name: l3-interface-ipv4-address
33208           in: path
33209           description: IP address
33210           required: true
33211           type: string
33212           example: __L3-INTERFACE-IPV4-ADDRESS__
33213         - name: body
33214           in: body
33215           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33216           required: true
33217           schema:
33218             $ref: "#/definitions/l3-interface-ipv4-address-list"
33219     patch:
33220       tags:
33221         - Network
33222       summary: update an existing l3-interface-ipv4-address-list
33223       description: |
33224         Update an existing l3-interface-ipv4-address-list
33225         #
33226         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33227         The PUT operation will entirely replace an existing object.
33228         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33229         #
33230         Other differences between PUT and PATCH are:
33231         #
33232         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33233         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33234         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33235       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33236       consumes:
33237         - application/json
33238         - application/xml
33239       produces:
33240         - application/json
33241         - application/xml
33242       responses:
33243         "default":
33244           description: Response codes found in [response codes](https://wiki.onap.org/).
33245       parameters:
33246         - name: vnf-id2
33247           in: path
33248           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33249           required: true
33250           type: string
33251           example: __VNF-ID2__
33252         - name: interface-name
33253           in: path
33254           description: Name given to the interface
33255           required: true
33256           type: string
33257           example: __INTERFACE-NAME__
33258         - name: vlan-interface
33259           in: path
33260           description: String that identifies the interface
33261           required: true
33262           type: string
33263           example: __VLAN-INTERFACE__
33264         - name: l3-interface-ipv4-address
33265           in: path
33266           description: IP address
33267           required: true
33268           type: string
33269           example: __L3-INTERFACE-IPV4-ADDRESS__
33270         - name: body
33271           in: body
33272           description: l3-interface-ipv4-address-list object that needs to be updated.
33273           required: true
33274           schema:
33275             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33276     delete:
33277       tags:
33278         - Network
33279       summary: delete an existing l3-interface-ipv4-address-list
33280       description: delete an existing l3-interface-ipv4-address-list
33281       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33282       consumes:
33283         - application/json
33284         - application/xml
33285       produces:
33286         - application/json
33287         - application/xml
33288       responses:
33289         "default":
33290           description: Response codes found in [response codes](https://wiki.onap.org/).
33291       parameters:
33292         - name: vnf-id2
33293           in: path
33294           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33295           required: true
33296           type: string
33297           example: __VNF-ID2__
33298         - name: interface-name
33299           in: path
33300           description: Name given to the interface
33301           required: true
33302           type: string
33303           example: __INTERFACE-NAME__
33304         - name: vlan-interface
33305           in: path
33306           description: String that identifies the interface
33307           required: true
33308           type: string
33309           example: __VLAN-INTERFACE__
33310         - name: l3-interface-ipv4-address
33311           in: path
33312           description: IP address
33313           required: true
33314           type: string
33315           example: __L3-INTERFACE-IPV4-ADDRESS__
33316         - name: resource-version
33317           in: query
33318           description: resource-version for concurrency
33319           required: true
33320           type: string
33321   /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:
33322     put:
33323       tags:
33324         - Network
33325       summary: see node definition for valid relationships
33326       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33327       consumes:
33328         - application/json
33329         - application/xml
33330       produces:
33331         - application/json
33332         - application/xml
33333       responses:
33334         "default":
33335           description: Response codes found in [response codes](https://wiki.onap.org/).
33336       parameters:
33337         - name: vnf-id2
33338           in: path
33339           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33340           required: true
33341           type: string
33342           example: __VNF-ID2__
33343         - name: interface-name
33344           in: path
33345           description: Name given to the interface
33346           required: true
33347           type: string
33348           example: __INTERFACE-NAME__
33349         - name: vlan-interface
33350           in: path
33351           description: String that identifies the interface
33352           required: true
33353           type: string
33354           example: __VLAN-INTERFACE__
33355         - name: l3-interface-ipv6-address
33356           in: path
33357           description: IP address
33358           required: true
33359           type: string
33360           example: __L3-INTERFACE-IPV6-ADDRESS__
33361         - name: body
33362           in: body
33363           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33364           required: true
33365           schema:
33366             $ref: "#/definitions/relationship"
33367     delete:
33368       tags:
33369         - Network
33370       summary: delete an existing relationship
33371       description: delete an existing relationship
33372       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33373       consumes:
33374         - application/json
33375         - application/xml
33376       produces:
33377         - application/json
33378         - application/xml
33379       responses:
33380         "default":
33381           description: Response codes found in [response codes](https://wiki.onap.org/).
33382       parameters:
33383         - name: vnf-id2
33384           in: path
33385           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33386           required: true
33387           type: string
33388           example: __VNF-ID2__
33389         - name: interface-name
33390           in: path
33391           description: Name given to the interface
33392           required: true
33393           type: string
33394           example: __INTERFACE-NAME__
33395         - name: vlan-interface
33396           in: path
33397           description: String that identifies the interface
33398           required: true
33399           type: string
33400           example: __VLAN-INTERFACE__
33401         - name: l3-interface-ipv6-address
33402           in: path
33403           description: IP address
33404           required: true
33405           type: string
33406           example: __L3-INTERFACE-IPV6-ADDRESS__
33407   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33408     get:
33409       tags:
33410         - Network
33411       summary: returns l3-interface-ipv6-address-list
33412       description: returns l3-interface-ipv6-address-list
33413       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33414       produces:
33415         - application/json
33416         - application/xml
33417       responses:
33418         "200":
33419           description: successful operation
33420           schema:
33421               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33422         "default":
33423           description: Response codes found in [response codes](https://wiki.onap.org/).
33424       parameters:
33425         - name: vnf-id2
33426           in: path
33427           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33428           required: true
33429           type: string
33430           example: __VNF-ID2__
33431         - name: interface-name
33432           in: path
33433           description: Name given to the interface
33434           required: true
33435           type: string
33436           example: __INTERFACE-NAME__
33437         - name: vlan-interface
33438           in: path
33439           description: String that identifies the interface
33440           required: true
33441           type: string
33442           example: __VLAN-INTERFACE__
33443         - name: l3-interface-ipv6-address
33444           in: path
33445           description: IP address
33446           required: true
33447           type: string
33448           example: __L3-INTERFACE-IPV6-ADDRESS__
33449     put:
33450       tags:
33451         - Network
33452       summary: create or update an existing l3-interface-ipv6-address-list
33453       description: |
33454         Create or update an existing l3-interface-ipv6-address-list.
33455         #
33456         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33457       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33458       consumes:
33459         - application/json
33460         - application/xml
33461       produces:
33462         - application/json
33463         - application/xml
33464       responses:
33465         "default":
33466           description: Response codes found in [response codes](https://wiki.onap.org/).
33467       parameters:
33468         - name: vnf-id2
33469           in: path
33470           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33471           required: true
33472           type: string
33473           example: __VNF-ID2__
33474         - name: interface-name
33475           in: path
33476           description: Name given to the interface
33477           required: true
33478           type: string
33479           example: __INTERFACE-NAME__
33480         - name: vlan-interface
33481           in: path
33482           description: String that identifies the interface
33483           required: true
33484           type: string
33485           example: __VLAN-INTERFACE__
33486         - name: l3-interface-ipv6-address
33487           in: path
33488           description: IP address
33489           required: true
33490           type: string
33491           example: __L3-INTERFACE-IPV6-ADDRESS__
33492         - name: body
33493           in: body
33494           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33495           required: true
33496           schema:
33497             $ref: "#/definitions/l3-interface-ipv6-address-list"
33498     patch:
33499       tags:
33500         - Network
33501       summary: update an existing l3-interface-ipv6-address-list
33502       description: |
33503         Update an existing l3-interface-ipv6-address-list
33504         #
33505         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33506         The PUT operation will entirely replace an existing object.
33507         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33508         #
33509         Other differences between PUT and PATCH are:
33510         #
33511         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33512         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33513         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33514       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33515       consumes:
33516         - application/json
33517         - application/xml
33518       produces:
33519         - application/json
33520         - application/xml
33521       responses:
33522         "default":
33523           description: Response codes found in [response codes](https://wiki.onap.org/).
33524       parameters:
33525         - name: vnf-id2
33526           in: path
33527           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33528           required: true
33529           type: string
33530           example: __VNF-ID2__
33531         - name: interface-name
33532           in: path
33533           description: Name given to the interface
33534           required: true
33535           type: string
33536           example: __INTERFACE-NAME__
33537         - name: vlan-interface
33538           in: path
33539           description: String that identifies the interface
33540           required: true
33541           type: string
33542           example: __VLAN-INTERFACE__
33543         - name: l3-interface-ipv6-address
33544           in: path
33545           description: IP address
33546           required: true
33547           type: string
33548           example: __L3-INTERFACE-IPV6-ADDRESS__
33549         - name: body
33550           in: body
33551           description: l3-interface-ipv6-address-list object that needs to be updated.
33552           required: true
33553           schema:
33554             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33555     delete:
33556       tags:
33557         - Network
33558       summary: delete an existing l3-interface-ipv6-address-list
33559       description: delete an existing l3-interface-ipv6-address-list
33560       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33561       consumes:
33562         - application/json
33563         - application/xml
33564       produces:
33565         - application/json
33566         - application/xml
33567       responses:
33568         "default":
33569           description: Response codes found in [response codes](https://wiki.onap.org/).
33570       parameters:
33571         - name: vnf-id2
33572           in: path
33573           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33574           required: true
33575           type: string
33576           example: __VNF-ID2__
33577         - name: interface-name
33578           in: path
33579           description: Name given to the interface
33580           required: true
33581           type: string
33582           example: __INTERFACE-NAME__
33583         - name: vlan-interface
33584           in: path
33585           description: String that identifies the interface
33586           required: true
33587           type: string
33588           example: __VLAN-INTERFACE__
33589         - name: l3-interface-ipv6-address
33590           in: path
33591           description: IP address
33592           required: true
33593           type: string
33594           example: __L3-INTERFACE-IPV6-ADDRESS__
33595         - name: resource-version
33596           in: query
33597           description: resource-version for concurrency
33598           required: true
33599           type: string
33600   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33601     get:
33602       tags:
33603         - Network
33604       summary: returns vlan
33605       description: returns vlan
33606       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33607       produces:
33608         - application/json
33609         - application/xml
33610       responses:
33611         "200":
33612           description: successful operation
33613           schema:
33614               $ref: "#/getDefinitions/vlan"
33615         "default":
33616           description: Response codes found in [response codes](https://wiki.onap.org/).
33617       parameters:
33618         - name: vnf-id2
33619           in: path
33620           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33621           required: true
33622           type: string
33623           example: __VNF-ID2__
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: vlan-interface
33631           in: path
33632           description: String that identifies the interface
33633           required: true
33634           type: string
33635           example: __VLAN-INTERFACE__
33636     put:
33637       tags:
33638         - Network
33639       summary: create or update an existing vlan
33640       description: |
33641         Create or update an existing vlan.
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: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
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: vnf-id2
33656           in: path
33657           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33658           required: true
33659           type: string
33660           example: __VNF-ID2__
33661         - name: interface-name
33662           in: path
33663           description: Name given to the interface
33664           required: true
33665           type: string
33666           example: __INTERFACE-NAME__
33667         - name: vlan-interface
33668           in: path
33669           description: String that identifies the interface
33670           required: true
33671           type: string
33672           example: __VLAN-INTERFACE__
33673         - name: body
33674           in: body
33675           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33676           required: true
33677           schema:
33678             $ref: "#/definitions/vlan"
33679     patch:
33680       tags:
33681         - Network
33682       summary: update an existing vlan
33683       description: |
33684         Update an existing vlan
33685         #
33686         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33687         The PUT operation will entirely replace an existing object.
33688         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33689         #
33690         Other differences between PUT and PATCH are:
33691         #
33692         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33693         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33694         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33695       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33696       consumes:
33697         - application/json
33698         - application/xml
33699       produces:
33700         - application/json
33701         - application/xml
33702       responses:
33703         "default":
33704           description: Response codes found in [response codes](https://wiki.onap.org/).
33705       parameters:
33706         - name: vnf-id2
33707           in: path
33708           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33709           required: true
33710           type: string
33711           example: __VNF-ID2__
33712         - name: interface-name
33713           in: path
33714           description: Name given to the interface
33715           required: true
33716           type: string
33717           example: __INTERFACE-NAME__
33718         - name: vlan-interface
33719           in: path
33720           description: String that identifies the interface
33721           required: true
33722           type: string
33723           example: __VLAN-INTERFACE__
33724         - name: body
33725           in: body
33726           description: vlan object that needs to be updated.
33727           required: true
33728           schema:
33729             $ref: "#/patchDefinitions/vlan"
33730     delete:
33731       tags:
33732         - Network
33733       summary: delete an existing vlan
33734       description: delete an existing vlan
33735       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33736       consumes:
33737         - application/json
33738         - application/xml
33739       produces:
33740         - application/json
33741         - application/xml
33742       responses:
33743         "default":
33744           description: Response codes found in [response codes](https://wiki.onap.org/).
33745       parameters:
33746         - name: vnf-id2
33747           in: path
33748           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33749           required: true
33750           type: string
33751           example: __VNF-ID2__
33752         - name: interface-name
33753           in: path
33754           description: Name given to the interface
33755           required: true
33756           type: string
33757           example: __INTERFACE-NAME__
33758         - name: vlan-interface
33759           in: path
33760           description: String that identifies the interface
33761           required: true
33762           type: string
33763           example: __VLAN-INTERFACE__
33764         - name: resource-version
33765           in: query
33766           description: resource-version for concurrency
33767           required: true
33768           type: string
33769   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
33770     get:
33771       tags:
33772         - Network
33773       summary: returns vlans
33774       description: returns vlans
33775       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
33776       produces:
33777         - application/json
33778         - application/xml
33779       responses:
33780         "200":
33781           description: successful operation
33782           schema:
33783               $ref: "#/getDefinitions/vlans"
33784         "default":
33785           description: Response codes found in [response codes](https://wiki.onap.org/).
33786       parameters:
33787         - name: vnf-id2
33788           in: path
33789           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33790           required: true
33791           type: string
33792           example: __VNF-ID2__
33793         - name: interface-name
33794           in: path
33795           description: Name given to the interface
33796           required: true
33797           type: string
33798           example: __INTERFACE-NAME__
33799         - name: vlan-interface
33800           in: query
33801           description:
33802           required: false
33803           type: string
33804         - name: vlan-id-inner
33805           in: query
33806           description:
33807           required: false
33808           type: integer
33809           format: int64
33810         - name: vpn-id
33811           in: query
33812           description:
33813           required: false
33814           type: string
33815   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33816     put:
33817       tags:
33818         - Network
33819       summary: see node definition for valid relationships
33820       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33821       consumes:
33822         - application/json
33823         - application/xml
33824       produces:
33825         - application/json
33826         - application/xml
33827       responses:
33828         "default":
33829           description: Response codes found in [response codes](https://wiki.onap.org/).
33830       parameters:
33831         - name: vnf-id2
33832           in: path
33833           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33834           required: true
33835           type: string
33836           example: __VNF-ID2__
33837         - name: interface-name
33838           in: path
33839           description: Name given to the interface
33840           required: true
33841           type: string
33842           example: __INTERFACE-NAME__
33843         - name: pci-id
33844           in: path
33845           description: PCI ID used to identify the sriov-vf
33846           required: true
33847           type: string
33848           example: __PCI-ID__
33849         - name: body
33850           in: body
33851           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33852           required: true
33853           schema:
33854             $ref: "#/definitions/relationship"
33855     delete:
33856       tags:
33857         - Network
33858       summary: delete an existing relationship
33859       description: delete an existing relationship
33860       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33861       consumes:
33862         - application/json
33863         - application/xml
33864       produces:
33865         - application/json
33866         - application/xml
33867       responses:
33868         "default":
33869           description: Response codes found in [response codes](https://wiki.onap.org/).
33870       parameters:
33871         - name: vnf-id2
33872           in: path
33873           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33874           required: true
33875           type: string
33876           example: __VNF-ID2__
33877         - name: interface-name
33878           in: path
33879           description: Name given to the interface
33880           required: true
33881           type: string
33882           example: __INTERFACE-NAME__
33883         - name: pci-id
33884           in: path
33885           description: PCI ID used to identify the sriov-vf
33886           required: true
33887           type: string
33888           example: __PCI-ID__
33889   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33890     get:
33891       tags:
33892         - Network
33893       summary: returns sriov-vf
33894       description: returns sriov-vf
33895       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33896       produces:
33897         - application/json
33898         - application/xml
33899       responses:
33900         "200":
33901           description: successful operation
33902           schema:
33903               $ref: "#/getDefinitions/sriov-vf"
33904         "default":
33905           description: Response codes found in [response codes](https://wiki.onap.org/).
33906       parameters:
33907         - name: vnf-id2
33908           in: path
33909           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33910           required: true
33911           type: string
33912           example: __VNF-ID2__
33913         - name: interface-name
33914           in: path
33915           description: Name given to the interface
33916           required: true
33917           type: string
33918           example: __INTERFACE-NAME__
33919         - name: pci-id
33920           in: path
33921           description: PCI ID used to identify the sriov-vf
33922           required: true
33923           type: string
33924           example: __PCI-ID__
33925     put:
33926       tags:
33927         - Network
33928       summary: create or update an existing sriov-vf
33929       description: |
33930         Create or update an existing sriov-vf.
33931         #
33932         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33933       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33934       consumes:
33935         - application/json
33936         - application/xml
33937       produces:
33938         - application/json
33939         - application/xml
33940       responses:
33941         "default":
33942           description: Response codes found in [response codes](https://wiki.onap.org/).
33943       parameters:
33944         - name: vnf-id2
33945           in: path
33946           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33947           required: true
33948           type: string
33949           example: __VNF-ID2__
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: pci-id
33957           in: path
33958           description: PCI ID used to identify the sriov-vf
33959           required: true
33960           type: string
33961           example: __PCI-ID__
33962         - name: body
33963           in: body
33964           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33965           required: true
33966           schema:
33967             $ref: "#/definitions/sriov-vf"
33968     patch:
33969       tags:
33970         - Network
33971       summary: update an existing sriov-vf
33972       description: |
33973         Update an existing sriov-vf
33974         #
33975         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33976         The PUT operation will entirely replace an existing object.
33977         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33978         #
33979         Other differences between PUT and PATCH are:
33980         #
33981         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33982         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33983         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33984       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33985       consumes:
33986         - application/json
33987         - application/xml
33988       produces:
33989         - application/json
33990         - application/xml
33991       responses:
33992         "default":
33993           description: Response codes found in [response codes](https://wiki.onap.org/).
33994       parameters:
33995         - name: vnf-id2
33996           in: path
33997           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33998           required: true
33999           type: string
34000           example: __VNF-ID2__
34001         - name: interface-name
34002           in: path
34003           description: Name given to the interface
34004           required: true
34005           type: string
34006           example: __INTERFACE-NAME__
34007         - name: pci-id
34008           in: path
34009           description: PCI ID used to identify the sriov-vf
34010           required: true
34011           type: string
34012           example: __PCI-ID__
34013         - name: body
34014           in: body
34015           description: sriov-vf object that needs to be updated.
34016           required: true
34017           schema:
34018             $ref: "#/patchDefinitions/sriov-vf"
34019     delete:
34020       tags:
34021         - Network
34022       summary: delete an existing sriov-vf
34023       description: delete an existing sriov-vf
34024       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
34025       consumes:
34026         - application/json
34027         - application/xml
34028       produces:
34029         - application/json
34030         - application/xml
34031       responses:
34032         "default":
34033           description: Response codes found in [response codes](https://wiki.onap.org/).
34034       parameters:
34035         - name: vnf-id2
34036           in: path
34037           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34038           required: true
34039           type: string
34040           example: __VNF-ID2__
34041         - name: interface-name
34042           in: path
34043           description: Name given to the interface
34044           required: true
34045           type: string
34046           example: __INTERFACE-NAME__
34047         - name: pci-id
34048           in: path
34049           description: PCI ID used to identify the sriov-vf
34050           required: true
34051           type: string
34052           example: __PCI-ID__
34053         - name: resource-version
34054           in: query
34055           description: resource-version for concurrency
34056           required: true
34057           type: string
34058   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34059     get:
34060       tags:
34061         - Network
34062       summary: returns sriov-vfs
34063       description: returns sriov-vfs
34064       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
34065       produces:
34066         - application/json
34067         - application/xml
34068       responses:
34069         "200":
34070           description: successful operation
34071           schema:
34072               $ref: "#/getDefinitions/sriov-vfs"
34073         "default":
34074           description: Response codes found in [response codes](https://wiki.onap.org/).
34075       parameters:
34076         - name: vnf-id2
34077           in: path
34078           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34079           required: true
34080           type: string
34081           example: __VNF-ID2__
34082         - name: interface-name
34083           in: path
34084           description: Name given to the interface
34085           required: true
34086           type: string
34087           example: __INTERFACE-NAME__
34088         - name: pci-id
34089           in: query
34090           description:
34091           required: false
34092           type: string
34093         - name: vf-vlan-filter
34094           in: query
34095           description:
34096           required: false
34097           type: string
34098         - name: vf-mac-filter
34099           in: query
34100           description:
34101           required: false
34102           type: string
34103         - name: vf-vlan-strip
34104           in: query
34105           description:
34106           required: false
34107           type: boolean
34108         - name: neutron-network-id
34109           in: query
34110           description:
34111           required: false
34112           type: string
34113   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34114     put:
34115       tags:
34116         - Network
34117       summary: see node definition for valid relationships
34118       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
34119       consumes:
34120         - application/json
34121         - application/xml
34122       produces:
34123         - application/json
34124         - application/xml
34125       responses:
34126         "default":
34127           description: Response codes found in [response codes](https://wiki.onap.org/).
34128       parameters:
34129         - name: vnf-id2
34130           in: path
34131           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34132           required: true
34133           type: string
34134           example: __VNF-ID2__
34135         - name: interface-name
34136           in: path
34137           description: Name given to the interface
34138           required: true
34139           type: string
34140           example: __INTERFACE-NAME__
34141         - name: body
34142           in: body
34143           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
34144           required: true
34145           schema:
34146             $ref: "#/definitions/relationship"
34147     delete:
34148       tags:
34149         - Network
34150       summary: delete an existing relationship
34151       description: delete an existing relationship
34152       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
34153       consumes:
34154         - application/json
34155         - application/xml
34156       produces:
34157         - application/json
34158         - application/xml
34159       responses:
34160         "default":
34161           description: Response codes found in [response codes](https://wiki.onap.org/).
34162       parameters:
34163         - name: vnf-id2
34164           in: path
34165           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34166           required: true
34167           type: string
34168           example: __VNF-ID2__
34169         - name: interface-name
34170           in: path
34171           description: Name given to the interface
34172           required: true
34173           type: string
34174           example: __INTERFACE-NAME__
34175   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
34176     put:
34177       tags:
34178         - Network
34179       summary: see node definition for valid relationships
34180       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34181       consumes:
34182         - application/json
34183         - application/xml
34184       produces:
34185         - application/json
34186         - application/xml
34187       responses:
34188         "default":
34189           description: Response codes found in [response codes](https://wiki.onap.org/).
34190       parameters:
34191         - name: vnf-id2
34192           in: path
34193           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34194           required: true
34195           type: string
34196           example: __VNF-ID2__
34197         - name: interface-name
34198           in: path
34199           description: Name given to the interface
34200           required: true
34201           type: string
34202           example: __INTERFACE-NAME__
34203         - name: l3-interface-ipv4-address
34204           in: path
34205           description: IP address
34206           required: true
34207           type: string
34208           example: __L3-INTERFACE-IPV4-ADDRESS__
34209         - name: body
34210           in: body
34211           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34212           required: true
34213           schema:
34214             $ref: "#/definitions/relationship"
34215     delete:
34216       tags:
34217         - Network
34218       summary: delete an existing relationship
34219       description: delete an existing relationship
34220       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34221       consumes:
34222         - application/json
34223         - application/xml
34224       produces:
34225         - application/json
34226         - application/xml
34227       responses:
34228         "default":
34229           description: Response codes found in [response codes](https://wiki.onap.org/).
34230       parameters:
34231         - name: vnf-id2
34232           in: path
34233           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34234           required: true
34235           type: string
34236           example: __VNF-ID2__
34237         - name: interface-name
34238           in: path
34239           description: Name given to the interface
34240           required: true
34241           type: string
34242           example: __INTERFACE-NAME__
34243         - name: l3-interface-ipv4-address
34244           in: path
34245           description: IP address
34246           required: true
34247           type: string
34248           example: __L3-INTERFACE-IPV4-ADDRESS__
34249   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
34250     get:
34251       tags:
34252         - Network
34253       summary: returns l3-interface-ipv4-address-list
34254       description: returns l3-interface-ipv4-address-list
34255       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34256       produces:
34257         - application/json
34258         - application/xml
34259       responses:
34260         "200":
34261           description: successful operation
34262           schema:
34263               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34264         "default":
34265           description: Response codes found in [response codes](https://wiki.onap.org/).
34266       parameters:
34267         - name: vnf-id2
34268           in: path
34269           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34270           required: true
34271           type: string
34272           example: __VNF-ID2__
34273         - name: interface-name
34274           in: path
34275           description: Name given to the interface
34276           required: true
34277           type: string
34278           example: __INTERFACE-NAME__
34279         - name: l3-interface-ipv4-address
34280           in: path
34281           description: IP address
34282           required: true
34283           type: string
34284           example: __L3-INTERFACE-IPV4-ADDRESS__
34285     put:
34286       tags:
34287         - Network
34288       summary: create or update an existing l3-interface-ipv4-address-list
34289       description: |
34290         Create or update an existing l3-interface-ipv4-address-list.
34291         #
34292         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34293       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34294       consumes:
34295         - application/json
34296         - application/xml
34297       produces:
34298         - application/json
34299         - application/xml
34300       responses:
34301         "default":
34302           description: Response codes found in [response codes](https://wiki.onap.org/).
34303       parameters:
34304         - name: vnf-id2
34305           in: path
34306           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34307           required: true
34308           type: string
34309           example: __VNF-ID2__
34310         - name: interface-name
34311           in: path
34312           description: Name given to the interface
34313           required: true
34314           type: string
34315           example: __INTERFACE-NAME__
34316         - name: l3-interface-ipv4-address
34317           in: path
34318           description: IP address
34319           required: true
34320           type: string
34321           example: __L3-INTERFACE-IPV4-ADDRESS__
34322         - name: body
34323           in: body
34324           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34325           required: true
34326           schema:
34327             $ref: "#/definitions/l3-interface-ipv4-address-list"
34328     patch:
34329       tags:
34330         - Network
34331       summary: update an existing l3-interface-ipv4-address-list
34332       description: |
34333         Update an existing l3-interface-ipv4-address-list
34334         #
34335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34336         The PUT operation will entirely replace an existing object.
34337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34338         #
34339         Other differences between PUT and PATCH are:
34340         #
34341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34344       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34345       consumes:
34346         - application/json
34347         - application/xml
34348       produces:
34349         - application/json
34350         - application/xml
34351       responses:
34352         "default":
34353           description: Response codes found in [response codes](https://wiki.onap.org/).
34354       parameters:
34355         - name: vnf-id2
34356           in: path
34357           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34358           required: true
34359           type: string
34360           example: __VNF-ID2__
34361         - name: interface-name
34362           in: path
34363           description: Name given to the interface
34364           required: true
34365           type: string
34366           example: __INTERFACE-NAME__
34367         - name: l3-interface-ipv4-address
34368           in: path
34369           description: IP address
34370           required: true
34371           type: string
34372           example: __L3-INTERFACE-IPV4-ADDRESS__
34373         - name: body
34374           in: body
34375           description: l3-interface-ipv4-address-list object that needs to be updated.
34376           required: true
34377           schema:
34378             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34379     delete:
34380       tags:
34381         - Network
34382       summary: delete an existing l3-interface-ipv4-address-list
34383       description: delete an existing l3-interface-ipv4-address-list
34384       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34385       consumes:
34386         - application/json
34387         - application/xml
34388       produces:
34389         - application/json
34390         - application/xml
34391       responses:
34392         "default":
34393           description: Response codes found in [response codes](https://wiki.onap.org/).
34394       parameters:
34395         - name: vnf-id2
34396           in: path
34397           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34398           required: true
34399           type: string
34400           example: __VNF-ID2__
34401         - name: interface-name
34402           in: path
34403           description: Name given to the interface
34404           required: true
34405           type: string
34406           example: __INTERFACE-NAME__
34407         - name: l3-interface-ipv4-address
34408           in: path
34409           description: IP address
34410           required: true
34411           type: string
34412           example: __L3-INTERFACE-IPV4-ADDRESS__
34413         - name: resource-version
34414           in: query
34415           description: resource-version for concurrency
34416           required: true
34417           type: string
34418   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34419     put:
34420       tags:
34421         - Network
34422       summary: see node definition for valid relationships
34423       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34424       consumes:
34425         - application/json
34426         - application/xml
34427       produces:
34428         - application/json
34429         - application/xml
34430       responses:
34431         "default":
34432           description: Response codes found in [response codes](https://wiki.onap.org/).
34433       parameters:
34434         - name: vnf-id2
34435           in: path
34436           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34437           required: true
34438           type: string
34439           example: __VNF-ID2__
34440         - name: interface-name
34441           in: path
34442           description: Name given to the interface
34443           required: true
34444           type: string
34445           example: __INTERFACE-NAME__
34446         - name: l3-interface-ipv6-address
34447           in: path
34448           description: IP address
34449           required: true
34450           type: string
34451           example: __L3-INTERFACE-IPV6-ADDRESS__
34452         - name: body
34453           in: body
34454           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34455           required: true
34456           schema:
34457             $ref: "#/definitions/relationship"
34458     delete:
34459       tags:
34460         - Network
34461       summary: delete an existing relationship
34462       description: delete an existing relationship
34463       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34464       consumes:
34465         - application/json
34466         - application/xml
34467       produces:
34468         - application/json
34469         - application/xml
34470       responses:
34471         "default":
34472           description: Response codes found in [response codes](https://wiki.onap.org/).
34473       parameters:
34474         - name: vnf-id2
34475           in: path
34476           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34477           required: true
34478           type: string
34479           example: __VNF-ID2__
34480         - name: interface-name
34481           in: path
34482           description: Name given to the interface
34483           required: true
34484           type: string
34485           example: __INTERFACE-NAME__
34486         - name: l3-interface-ipv6-address
34487           in: path
34488           description: IP address
34489           required: true
34490           type: string
34491           example: __L3-INTERFACE-IPV6-ADDRESS__
34492   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34493     get:
34494       tags:
34495         - Network
34496       summary: returns l3-interface-ipv6-address-list
34497       description: returns l3-interface-ipv6-address-list
34498       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34499       produces:
34500         - application/json
34501         - application/xml
34502       responses:
34503         "200":
34504           description: successful operation
34505           schema:
34506               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34507         "default":
34508           description: Response codes found in [response codes](https://wiki.onap.org/).
34509       parameters:
34510         - name: vnf-id2
34511           in: path
34512           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34513           required: true
34514           type: string
34515           example: __VNF-ID2__
34516         - name: interface-name
34517           in: path
34518           description: Name given to the interface
34519           required: true
34520           type: string
34521           example: __INTERFACE-NAME__
34522         - name: l3-interface-ipv6-address
34523           in: path
34524           description: IP address
34525           required: true
34526           type: string
34527           example: __L3-INTERFACE-IPV6-ADDRESS__
34528     put:
34529       tags:
34530         - Network
34531       summary: create or update an existing l3-interface-ipv6-address-list
34532       description: |
34533         Create or update an existing l3-interface-ipv6-address-list.
34534         #
34535         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34536       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34537       consumes:
34538         - application/json
34539         - application/xml
34540       produces:
34541         - application/json
34542         - application/xml
34543       responses:
34544         "default":
34545           description: Response codes found in [response codes](https://wiki.onap.org/).
34546       parameters:
34547         - name: vnf-id2
34548           in: path
34549           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34550           required: true
34551           type: string
34552           example: __VNF-ID2__
34553         - name: interface-name
34554           in: path
34555           description: Name given to the interface
34556           required: true
34557           type: string
34558           example: __INTERFACE-NAME__
34559         - name: l3-interface-ipv6-address
34560           in: path
34561           description: IP address
34562           required: true
34563           type: string
34564           example: __L3-INTERFACE-IPV6-ADDRESS__
34565         - name: body
34566           in: body
34567           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34568           required: true
34569           schema:
34570             $ref: "#/definitions/l3-interface-ipv6-address-list"
34571     patch:
34572       tags:
34573         - Network
34574       summary: update an existing l3-interface-ipv6-address-list
34575       description: |
34576         Update an existing l3-interface-ipv6-address-list
34577         #
34578         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34579         The PUT operation will entirely replace an existing object.
34580         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34581         #
34582         Other differences between PUT and PATCH are:
34583         #
34584         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34585         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34586         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34587       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34588       consumes:
34589         - application/json
34590         - application/xml
34591       produces:
34592         - application/json
34593         - application/xml
34594       responses:
34595         "default":
34596           description: Response codes found in [response codes](https://wiki.onap.org/).
34597       parameters:
34598         - name: vnf-id2
34599           in: path
34600           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34601           required: true
34602           type: string
34603           example: __VNF-ID2__
34604         - name: interface-name
34605           in: path
34606           description: Name given to the interface
34607           required: true
34608           type: string
34609           example: __INTERFACE-NAME__
34610         - name: l3-interface-ipv6-address
34611           in: path
34612           description: IP address
34613           required: true
34614           type: string
34615           example: __L3-INTERFACE-IPV6-ADDRESS__
34616         - name: body
34617           in: body
34618           description: l3-interface-ipv6-address-list object that needs to be updated.
34619           required: true
34620           schema:
34621             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34622     delete:
34623       tags:
34624         - Network
34625       summary: delete an existing l3-interface-ipv6-address-list
34626       description: delete an existing l3-interface-ipv6-address-list
34627       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34628       consumes:
34629         - application/json
34630         - application/xml
34631       produces:
34632         - application/json
34633         - application/xml
34634       responses:
34635         "default":
34636           description: Response codes found in [response codes](https://wiki.onap.org/).
34637       parameters:
34638         - name: vnf-id2
34639           in: path
34640           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34641           required: true
34642           type: string
34643           example: __VNF-ID2__
34644         - name: interface-name
34645           in: path
34646           description: Name given to the interface
34647           required: true
34648           type: string
34649           example: __INTERFACE-NAME__
34650         - name: l3-interface-ipv6-address
34651           in: path
34652           description: IP address
34653           required: true
34654           type: string
34655           example: __L3-INTERFACE-IPV6-ADDRESS__
34656         - name: resource-version
34657           in: query
34658           description: resource-version for concurrency
34659           required: true
34660           type: string
34661   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
34662     get:
34663       tags:
34664         - Network
34665       summary: returns l-interface
34666       description: returns l-interface
34667       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
34668       produces:
34669         - application/json
34670         - application/xml
34671       responses:
34672         "200":
34673           description: successful operation
34674           schema:
34675               $ref: "#/getDefinitions/l-interface"
34676         "default":
34677           description: Response codes found in [response codes](https://wiki.onap.org/).
34678       parameters:
34679         - name: vnf-id2
34680           in: path
34681           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34682           required: true
34683           type: string
34684           example: __VNF-ID2__
34685         - name: interface-name
34686           in: path
34687           description: Name given to the interface
34688           required: true
34689           type: string
34690           example: __INTERFACE-NAME__
34691     put:
34692       tags:
34693         - Network
34694       summary: create or update an existing l-interface
34695       description: |
34696         Create or update an existing l-interface.
34697         #
34698         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34699       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
34700       consumes:
34701         - application/json
34702         - application/xml
34703       produces:
34704         - application/json
34705         - application/xml
34706       responses:
34707         "default":
34708           description: Response codes found in [response codes](https://wiki.onap.org/).
34709       parameters:
34710         - name: vnf-id2
34711           in: path
34712           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34713           required: true
34714           type: string
34715           example: __VNF-ID2__
34716         - name: interface-name
34717           in: path
34718           description: Name given to the interface
34719           required: true
34720           type: string
34721           example: __INTERFACE-NAME__
34722         - name: body
34723           in: body
34724           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
34725           required: true
34726           schema:
34727             $ref: "#/definitions/l-interface"
34728     patch:
34729       tags:
34730         - Network
34731       summary: update an existing l-interface
34732       description: |
34733         Update an existing l-interface
34734         #
34735         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34736         The PUT operation will entirely replace an existing object.
34737         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34738         #
34739         Other differences between PUT and PATCH are:
34740         #
34741         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34742         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34743         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34744       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
34745       consumes:
34746         - application/json
34747         - application/xml
34748       produces:
34749         - application/json
34750         - application/xml
34751       responses:
34752         "default":
34753           description: Response codes found in [response codes](https://wiki.onap.org/).
34754       parameters:
34755         - name: vnf-id2
34756           in: path
34757           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34758           required: true
34759           type: string
34760           example: __VNF-ID2__
34761         - name: interface-name
34762           in: path
34763           description: Name given to the interface
34764           required: true
34765           type: string
34766           example: __INTERFACE-NAME__
34767         - name: body
34768           in: body
34769           description: l-interface object that needs to be updated.
34770           required: true
34771           schema:
34772             $ref: "#/patchDefinitions/l-interface"
34773     delete:
34774       tags:
34775         - Network
34776       summary: delete an existing l-interface
34777       description: delete an existing l-interface
34778       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
34779       consumes:
34780         - application/json
34781         - application/xml
34782       produces:
34783         - application/json
34784         - application/xml
34785       responses:
34786         "default":
34787           description: Response codes found in [response codes](https://wiki.onap.org/).
34788       parameters:
34789         - name: vnf-id2
34790           in: path
34791           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34792           required: true
34793           type: string
34794           example: __VNF-ID2__
34795         - name: interface-name
34796           in: path
34797           description: Name given to the interface
34798           required: true
34799           type: string
34800           example: __INTERFACE-NAME__
34801         - name: resource-version
34802           in: query
34803           description: resource-version for concurrency
34804           required: true
34805           type: string
34806   /network/newvces/newvce/{vnf-id2}/l-interfaces:
34807     get:
34808       tags:
34809         - Network
34810       summary: returns l-interfaces
34811       description: returns l-interfaces
34812       operationId: getNetworkNewvcesNewvceLInterfaces
34813       produces:
34814         - application/json
34815         - application/xml
34816       responses:
34817         "200":
34818           description: successful operation
34819           schema:
34820               $ref: "#/getDefinitions/l-interfaces"
34821         "default":
34822           description: Response codes found in [response codes](https://wiki.onap.org/).
34823       parameters:
34824         - name: vnf-id2
34825           in: path
34826           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34827           required: true
34828           type: string
34829           example: __VNF-ID2__
34830         - name: interface-name
34831           in: query
34832           description:
34833           required: false
34834           type: string
34835         - name: interface-id
34836           in: query
34837           description:
34838           required: false
34839           type: string
34840         - name: macaddr
34841           in: query
34842           description:
34843           required: false
34844           type: string
34845         - name: network-name
34846           in: query
34847           description:
34848           required: false
34849           type: string
34850   /network/newvces/newvce/{vnf-id2}:
34851     get:
34852       tags:
34853         - Network
34854       summary: returns newvce
34855       description: returns newvce
34856       operationId: getNetworkNewvcesNewvce
34857       produces:
34858         - application/json
34859         - application/xml
34860       responses:
34861         "200":
34862           description: successful operation
34863           schema:
34864               $ref: "#/getDefinitions/newvce"
34865         "default":
34866           description: Response codes found in [response codes](https://wiki.onap.org/).
34867       parameters:
34868         - name: vnf-id2
34869           in: path
34870           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34871           required: true
34872           type: string
34873           example: __VNF-ID2__
34874     put:
34875       tags:
34876         - Network
34877       summary: create or update an existing newvce
34878       description: |
34879         Create or update an existing newvce.
34880         #
34881         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34882       operationId: createOrUpdateNetworkNewvcesNewvce
34883       consumes:
34884         - application/json
34885         - application/xml
34886       produces:
34887         - application/json
34888         - application/xml
34889       responses:
34890         "default":
34891           description: Response codes found in [response codes](https://wiki.onap.org/).
34892       parameters:
34893         - name: vnf-id2
34894           in: path
34895           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34896           required: true
34897           type: string
34898           example: __VNF-ID2__
34899         - name: body
34900           in: body
34901           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
34902           required: true
34903           schema:
34904             $ref: "#/definitions/newvce"
34905     patch:
34906       tags:
34907         - Network
34908       summary: update an existing newvce
34909       description: |
34910         Update an existing newvce
34911         #
34912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34913         The PUT operation will entirely replace an existing object.
34914         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34915         #
34916         Other differences between PUT and PATCH are:
34917         #
34918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34921       operationId: UpdateNetworkNewvcesNewvce
34922       consumes:
34923         - application/json
34924         - application/xml
34925       produces:
34926         - application/json
34927         - application/xml
34928       responses:
34929         "default":
34930           description: Response codes found in [response codes](https://wiki.onap.org/).
34931       parameters:
34932         - name: vnf-id2
34933           in: path
34934           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34935           required: true
34936           type: string
34937           example: __VNF-ID2__
34938         - name: body
34939           in: body
34940           description: newvce object that needs to be updated.
34941           required: true
34942           schema:
34943             $ref: "#/patchDefinitions/newvce"
34944     delete:
34945       tags:
34946         - Network
34947       summary: delete an existing newvce
34948       description: delete an existing newvce
34949       operationId: deleteNetworkNewvcesNewvce
34950       consumes:
34951         - application/json
34952         - application/xml
34953       produces:
34954         - application/json
34955         - application/xml
34956       responses:
34957         "default":
34958           description: Response codes found in [response codes](https://wiki.onap.org/).
34959       parameters:
34960         - name: vnf-id2
34961           in: path
34962           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34963           required: true
34964           type: string
34965           example: __VNF-ID2__
34966         - name: resource-version
34967           in: query
34968           description: resource-version for concurrency
34969           required: true
34970           type: string
34971   /network/newvces:
34972     get:
34973       tags:
34974         - Network
34975       summary: returns newvces
34976       description: returns newvces
34977       operationId: getNetworkNewvces
34978       produces:
34979         - application/json
34980         - application/xml
34981       responses:
34982         "200":
34983           description: successful operation
34984           schema:
34985               $ref: "#/getDefinitions/newvces"
34986         "default":
34987           description: Response codes found in [response codes](https://wiki.onap.org/).
34988       parameters:
34989         - name: vnf-id2
34990           in: query
34991           description:
34992           required: false
34993           type: string
34994         - name: vnf-name
34995           in: query
34996           description:
34997           required: false
34998           type: string
34999         - name: vnf-name2
35000           in: query
35001           description:
35002           required: false
35003           type: string
35004         - name: vnf-type
35005           in: query
35006           description:
35007           required: false
35008           type: string
35009         - name: prov-status
35010           in: query
35011           description:
35012           required: false
35013           type: string
35014         - name: heat-stack-id
35015           in: query
35016           description:
35017           required: false
35018           type: string
35019   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
35020     put:
35021       tags:
35022         - Network
35023       summary: see node definition for valid relationships
35024       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
35025       consumes:
35026         - application/json
35027         - application/xml
35028       produces:
35029         - application/json
35030         - application/xml
35031       responses:
35032         "default":
35033           description: Response codes found in [response codes](https://wiki.onap.org/).
35034       parameters:
35035         - name: pnf-name
35036           in: path
35037           description: unique name of Physical Network Function.
35038           required: true
35039           type: string
35040           example: __PNF-NAME__
35041         - name: body
35042           in: body
35043           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
35044           required: true
35045           schema:
35046             $ref: "#/definitions/relationship"
35047     delete:
35048       tags:
35049         - Network
35050       summary: delete an existing relationship
35051       description: delete an existing relationship
35052       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
35053       consumes:
35054         - application/json
35055         - application/xml
35056       produces:
35057         - application/json
35058         - application/xml
35059       responses:
35060         "default":
35061           description: Response codes found in [response codes](https://wiki.onap.org/).
35062       parameters:
35063         - name: pnf-name
35064           in: path
35065           description: unique name of Physical Network Function.
35066           required: true
35067           type: string
35068           example: __PNF-NAME__
35069   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
35070     put:
35071       tags:
35072         - Network
35073       summary: see node definition for valid relationships
35074       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
35075       consumes:
35076         - application/json
35077         - application/xml
35078       produces:
35079         - application/json
35080         - application/xml
35081       responses:
35082         "default":
35083           description: Response codes found in [response codes](https://wiki.onap.org/).
35084       parameters:
35085         - name: pnf-name
35086           in: path
35087           description: unique name of Physical Network Function.
35088           required: true
35089           type: string
35090           example: __PNF-NAME__
35091         - name: interface-name
35092           in: path
35093           description: Name that identifies the physical interface
35094           required: true
35095           type: string
35096           example: __INTERFACE-NAME__
35097         - name: body
35098           in: body
35099           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
35100           required: true
35101           schema:
35102             $ref: "#/definitions/relationship"
35103     delete:
35104       tags:
35105         - Network
35106       summary: delete an existing relationship
35107       description: delete an existing relationship
35108       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
35109       consumes:
35110         - application/json
35111         - application/xml
35112       produces:
35113         - application/json
35114         - application/xml
35115       responses:
35116         "default":
35117           description: Response codes found in [response codes](https://wiki.onap.org/).
35118       parameters:
35119         - name: pnf-name
35120           in: path
35121           description: unique name of Physical Network Function.
35122           required: true
35123           type: string
35124           example: __PNF-NAME__
35125         - name: interface-name
35126           in: path
35127           description: Name that identifies the physical interface
35128           required: true
35129           type: string
35130           example: __INTERFACE-NAME__
35131   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
35132     put:
35133       tags:
35134         - Network
35135       summary: see node definition for valid relationships
35136       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35137       consumes:
35138         - application/json
35139         - application/xml
35140       produces:
35141         - application/json
35142         - application/xml
35143       responses:
35144         "default":
35145           description: Response codes found in [response codes](https://wiki.onap.org/).
35146       parameters:
35147         - name: pnf-name
35148           in: path
35149           description: unique name of Physical Network Function.
35150           required: true
35151           type: string
35152           example: __PNF-NAME__
35153         - name: interface-name
35154           in: path
35155           description: Name that identifies the physical interface
35156           required: true
35157           type: string
35158           example: __INTERFACE-NAME__
35159         - name: interface-name
35160           in: path
35161           description: Name given to the interface
35162           required: true
35163           type: string
35164           example: __INTERFACE-NAME__
35165         - name: vlan-interface
35166           in: path
35167           description: String that identifies the interface
35168           required: true
35169           type: string
35170           example: __VLAN-INTERFACE__
35171         - name: body
35172           in: body
35173           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35174           required: true
35175           schema:
35176             $ref: "#/definitions/relationship"
35177     delete:
35178       tags:
35179         - Network
35180       summary: delete an existing relationship
35181       description: delete an existing relationship
35182       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35183       consumes:
35184         - application/json
35185         - application/xml
35186       produces:
35187         - application/json
35188         - application/xml
35189       responses:
35190         "default":
35191           description: Response codes found in [response codes](https://wiki.onap.org/).
35192       parameters:
35193         - name: pnf-name
35194           in: path
35195           description: unique name of Physical Network Function.
35196           required: true
35197           type: string
35198           example: __PNF-NAME__
35199         - name: interface-name
35200           in: path
35201           description: Name that identifies the physical interface
35202           required: true
35203           type: string
35204           example: __INTERFACE-NAME__
35205         - name: interface-name
35206           in: path
35207           description: Name given to the interface
35208           required: true
35209           type: string
35210           example: __INTERFACE-NAME__
35211         - name: vlan-interface
35212           in: path
35213           description: String that identifies the interface
35214           required: true
35215           type: string
35216           example: __VLAN-INTERFACE__
35217   /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:
35218     put:
35219       tags:
35220         - Network
35221       summary: see node definition for valid relationships
35222       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35223       consumes:
35224         - application/json
35225         - application/xml
35226       produces:
35227         - application/json
35228         - application/xml
35229       responses:
35230         "default":
35231           description: Response codes found in [response codes](https://wiki.onap.org/).
35232       parameters:
35233         - name: pnf-name
35234           in: path
35235           description: unique name of Physical Network Function.
35236           required: true
35237           type: string
35238           example: __PNF-NAME__
35239         - name: interface-name
35240           in: path
35241           description: Name that identifies the physical interface
35242           required: true
35243           type: string
35244           example: __INTERFACE-NAME__
35245         - name: interface-name
35246           in: path
35247           description: Name given to the interface
35248           required: true
35249           type: string
35250           example: __INTERFACE-NAME__
35251         - name: vlan-interface
35252           in: path
35253           description: String that identifies the interface
35254           required: true
35255           type: string
35256           example: __VLAN-INTERFACE__
35257         - name: l3-interface-ipv4-address
35258           in: path
35259           description: IP address
35260           required: true
35261           type: string
35262           example: __L3-INTERFACE-IPV4-ADDRESS__
35263         - name: body
35264           in: body
35265           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35266           required: true
35267           schema:
35268             $ref: "#/definitions/relationship"
35269     delete:
35270       tags:
35271         - Network
35272       summary: delete an existing relationship
35273       description: delete an existing relationship
35274       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35275       consumes:
35276         - application/json
35277         - application/xml
35278       produces:
35279         - application/json
35280         - application/xml
35281       responses:
35282         "default":
35283           description: Response codes found in [response codes](https://wiki.onap.org/).
35284       parameters:
35285         - name: pnf-name
35286           in: path
35287           description: unique name of Physical Network Function.
35288           required: true
35289           type: string
35290           example: __PNF-NAME__
35291         - name: interface-name
35292           in: path
35293           description: Name that identifies the physical interface
35294           required: true
35295           type: string
35296           example: __INTERFACE-NAME__
35297         - name: interface-name
35298           in: path
35299           description: Name given to the interface
35300           required: true
35301           type: string
35302           example: __INTERFACE-NAME__
35303         - name: vlan-interface
35304           in: path
35305           description: String that identifies the interface
35306           required: true
35307           type: string
35308           example: __VLAN-INTERFACE__
35309         - name: l3-interface-ipv4-address
35310           in: path
35311           description: IP address
35312           required: true
35313           type: string
35314           example: __L3-INTERFACE-IPV4-ADDRESS__
35315   /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}:
35316     get:
35317       tags:
35318         - Network
35319       summary: returns l3-interface-ipv4-address-list
35320       description: returns l3-interface-ipv4-address-list
35321       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35322       produces:
35323         - application/json
35324         - application/xml
35325       responses:
35326         "200":
35327           description: successful operation
35328           schema:
35329               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35330         "default":
35331           description: Response codes found in [response codes](https://wiki.onap.org/).
35332       parameters:
35333         - name: pnf-name
35334           in: path
35335           description: unique name of Physical Network Function.
35336           required: true
35337           type: string
35338           example: __PNF-NAME__
35339         - name: interface-name
35340           in: path
35341           description: Name that identifies the physical interface
35342           required: true
35343           type: string
35344           example: __INTERFACE-NAME__
35345         - name: interface-name
35346           in: path
35347           description: Name given to the interface
35348           required: true
35349           type: string
35350           example: __INTERFACE-NAME__
35351         - name: vlan-interface
35352           in: path
35353           description: String that identifies the interface
35354           required: true
35355           type: string
35356           example: __VLAN-INTERFACE__
35357         - name: l3-interface-ipv4-address
35358           in: path
35359           description: IP address
35360           required: true
35361           type: string
35362           example: __L3-INTERFACE-IPV4-ADDRESS__
35363     put:
35364       tags:
35365         - Network
35366       summary: create or update an existing l3-interface-ipv4-address-list
35367       description: |
35368         Create or update an existing l3-interface-ipv4-address-list.
35369         #
35370         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35371       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35372       consumes:
35373         - application/json
35374         - application/xml
35375       produces:
35376         - application/json
35377         - application/xml
35378       responses:
35379         "default":
35380           description: Response codes found in [response codes](https://wiki.onap.org/).
35381       parameters:
35382         - name: pnf-name
35383           in: path
35384           description: unique name of Physical Network Function.
35385           required: true
35386           type: string
35387           example: __PNF-NAME__
35388         - name: interface-name
35389           in: path
35390           description: Name that identifies the physical interface
35391           required: true
35392           type: string
35393           example: __INTERFACE-NAME__
35394         - name: interface-name
35395           in: path
35396           description: Name given to the interface
35397           required: true
35398           type: string
35399           example: __INTERFACE-NAME__
35400         - name: vlan-interface
35401           in: path
35402           description: String that identifies the interface
35403           required: true
35404           type: string
35405           example: __VLAN-INTERFACE__
35406         - name: l3-interface-ipv4-address
35407           in: path
35408           description: IP address
35409           required: true
35410           type: string
35411           example: __L3-INTERFACE-IPV4-ADDRESS__
35412         - name: body
35413           in: body
35414           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35415           required: true
35416           schema:
35417             $ref: "#/definitions/l3-interface-ipv4-address-list"
35418     patch:
35419       tags:
35420         - Network
35421       summary: update an existing l3-interface-ipv4-address-list
35422       description: |
35423         Update an existing l3-interface-ipv4-address-list
35424         #
35425         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35426         The PUT operation will entirely replace an existing object.
35427         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35428         #
35429         Other differences between PUT and PATCH are:
35430         #
35431         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35432         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35433         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35434       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35435       consumes:
35436         - application/json
35437         - application/xml
35438       produces:
35439         - application/json
35440         - application/xml
35441       responses:
35442         "default":
35443           description: Response codes found in [response codes](https://wiki.onap.org/).
35444       parameters:
35445         - name: pnf-name
35446           in: path
35447           description: unique name of Physical Network Function.
35448           required: true
35449           type: string
35450           example: __PNF-NAME__
35451         - name: interface-name
35452           in: path
35453           description: Name that identifies the physical interface
35454           required: true
35455           type: string
35456           example: __INTERFACE-NAME__
35457         - name: interface-name
35458           in: path
35459           description: Name given to the interface
35460           required: true
35461           type: string
35462           example: __INTERFACE-NAME__
35463         - name: vlan-interface
35464           in: path
35465           description: String that identifies the interface
35466           required: true
35467           type: string
35468           example: __VLAN-INTERFACE__
35469         - name: l3-interface-ipv4-address
35470           in: path
35471           description: IP address
35472           required: true
35473           type: string
35474           example: __L3-INTERFACE-IPV4-ADDRESS__
35475         - name: body
35476           in: body
35477           description: l3-interface-ipv4-address-list object that needs to be updated.
35478           required: true
35479           schema:
35480             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35481     delete:
35482       tags:
35483         - Network
35484       summary: delete an existing l3-interface-ipv4-address-list
35485       description: delete an existing l3-interface-ipv4-address-list
35486       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35487       consumes:
35488         - application/json
35489         - application/xml
35490       produces:
35491         - application/json
35492         - application/xml
35493       responses:
35494         "default":
35495           description: Response codes found in [response codes](https://wiki.onap.org/).
35496       parameters:
35497         - name: pnf-name
35498           in: path
35499           description: unique name of Physical Network Function.
35500           required: true
35501           type: string
35502           example: __PNF-NAME__
35503         - name: interface-name
35504           in: path
35505           description: Name that identifies the physical interface
35506           required: true
35507           type: string
35508           example: __INTERFACE-NAME__
35509         - name: interface-name
35510           in: path
35511           description: Name given to the interface
35512           required: true
35513           type: string
35514           example: __INTERFACE-NAME__
35515         - name: vlan-interface
35516           in: path
35517           description: String that identifies the interface
35518           required: true
35519           type: string
35520           example: __VLAN-INTERFACE__
35521         - name: l3-interface-ipv4-address
35522           in: path
35523           description: IP address
35524           required: true
35525           type: string
35526           example: __L3-INTERFACE-IPV4-ADDRESS__
35527         - name: resource-version
35528           in: query
35529           description: resource-version for concurrency
35530           required: true
35531           type: string
35532   /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:
35533     put:
35534       tags:
35535         - Network
35536       summary: see node definition for valid relationships
35537       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35538       consumes:
35539         - application/json
35540         - application/xml
35541       produces:
35542         - application/json
35543         - application/xml
35544       responses:
35545         "default":
35546           description: Response codes found in [response codes](https://wiki.onap.org/).
35547       parameters:
35548         - name: pnf-name
35549           in: path
35550           description: unique name of Physical Network Function.
35551           required: true
35552           type: string
35553           example: __PNF-NAME__
35554         - name: interface-name
35555           in: path
35556           description: Name that identifies the physical interface
35557           required: true
35558           type: string
35559           example: __INTERFACE-NAME__
35560         - name: interface-name
35561           in: path
35562           description: Name given to the interface
35563           required: true
35564           type: string
35565           example: __INTERFACE-NAME__
35566         - name: vlan-interface
35567           in: path
35568           description: String that identifies the interface
35569           required: true
35570           type: string
35571           example: __VLAN-INTERFACE__
35572         - name: l3-interface-ipv6-address
35573           in: path
35574           description: IP address
35575           required: true
35576           type: string
35577           example: __L3-INTERFACE-IPV6-ADDRESS__
35578         - name: body
35579           in: body
35580           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35581           required: true
35582           schema:
35583             $ref: "#/definitions/relationship"
35584     delete:
35585       tags:
35586         - Network
35587       summary: delete an existing relationship
35588       description: delete an existing relationship
35589       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35590       consumes:
35591         - application/json
35592         - application/xml
35593       produces:
35594         - application/json
35595         - application/xml
35596       responses:
35597         "default":
35598           description: Response codes found in [response codes](https://wiki.onap.org/).
35599       parameters:
35600         - name: pnf-name
35601           in: path
35602           description: unique name of Physical Network Function.
35603           required: true
35604           type: string
35605           example: __PNF-NAME__
35606         - name: interface-name
35607           in: path
35608           description: Name that identifies the physical interface
35609           required: true
35610           type: string
35611           example: __INTERFACE-NAME__
35612         - name: interface-name
35613           in: path
35614           description: Name given to the interface
35615           required: true
35616           type: string
35617           example: __INTERFACE-NAME__
35618         - name: vlan-interface
35619           in: path
35620           description: String that identifies the interface
35621           required: true
35622           type: string
35623           example: __VLAN-INTERFACE__
35624         - name: l3-interface-ipv6-address
35625           in: path
35626           description: IP address
35627           required: true
35628           type: string
35629           example: __L3-INTERFACE-IPV6-ADDRESS__
35630   /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}:
35631     get:
35632       tags:
35633         - Network
35634       summary: returns l3-interface-ipv6-address-list
35635       description: returns l3-interface-ipv6-address-list
35636       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35637       produces:
35638         - application/json
35639         - application/xml
35640       responses:
35641         "200":
35642           description: successful operation
35643           schema:
35644               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35645         "default":
35646           description: Response codes found in [response codes](https://wiki.onap.org/).
35647       parameters:
35648         - name: pnf-name
35649           in: path
35650           description: unique name of Physical Network Function.
35651           required: true
35652           type: string
35653           example: __PNF-NAME__
35654         - name: interface-name
35655           in: path
35656           description: Name that identifies the physical interface
35657           required: true
35658           type: string
35659           example: __INTERFACE-NAME__
35660         - name: interface-name
35661           in: path
35662           description: Name given to the interface
35663           required: true
35664           type: string
35665           example: __INTERFACE-NAME__
35666         - name: vlan-interface
35667           in: path
35668           description: String that identifies the interface
35669           required: true
35670           type: string
35671           example: __VLAN-INTERFACE__
35672         - name: l3-interface-ipv6-address
35673           in: path
35674           description: IP address
35675           required: true
35676           type: string
35677           example: __L3-INTERFACE-IPV6-ADDRESS__
35678     put:
35679       tags:
35680         - Network
35681       summary: create or update an existing l3-interface-ipv6-address-list
35682       description: |
35683         Create or update an existing l3-interface-ipv6-address-list.
35684         #
35685         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35686       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35687       consumes:
35688         - application/json
35689         - application/xml
35690       produces:
35691         - application/json
35692         - application/xml
35693       responses:
35694         "default":
35695           description: Response codes found in [response codes](https://wiki.onap.org/).
35696       parameters:
35697         - name: pnf-name
35698           in: path
35699           description: unique name of Physical Network Function.
35700           required: true
35701           type: string
35702           example: __PNF-NAME__
35703         - name: interface-name
35704           in: path
35705           description: Name that identifies the physical interface
35706           required: true
35707           type: string
35708           example: __INTERFACE-NAME__
35709         - name: interface-name
35710           in: path
35711           description: Name given to the interface
35712           required: true
35713           type: string
35714           example: __INTERFACE-NAME__
35715         - name: vlan-interface
35716           in: path
35717           description: String that identifies the interface
35718           required: true
35719           type: string
35720           example: __VLAN-INTERFACE__
35721         - name: l3-interface-ipv6-address
35722           in: path
35723           description: IP address
35724           required: true
35725           type: string
35726           example: __L3-INTERFACE-IPV6-ADDRESS__
35727         - name: body
35728           in: body
35729           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35730           required: true
35731           schema:
35732             $ref: "#/definitions/l3-interface-ipv6-address-list"
35733     patch:
35734       tags:
35735         - Network
35736       summary: update an existing l3-interface-ipv6-address-list
35737       description: |
35738         Update an existing l3-interface-ipv6-address-list
35739         #
35740         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35741         The PUT operation will entirely replace an existing object.
35742         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35743         #
35744         Other differences between PUT and PATCH are:
35745         #
35746         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35747         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35748         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35749       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35750       consumes:
35751         - application/json
35752         - application/xml
35753       produces:
35754         - application/json
35755         - application/xml
35756       responses:
35757         "default":
35758           description: Response codes found in [response codes](https://wiki.onap.org/).
35759       parameters:
35760         - name: pnf-name
35761           in: path
35762           description: unique name of Physical Network Function.
35763           required: true
35764           type: string
35765           example: __PNF-NAME__
35766         - name: interface-name
35767           in: path
35768           description: Name that identifies the physical interface
35769           required: true
35770           type: string
35771           example: __INTERFACE-NAME__
35772         - name: interface-name
35773           in: path
35774           description: Name given to the interface
35775           required: true
35776           type: string
35777           example: __INTERFACE-NAME__
35778         - name: vlan-interface
35779           in: path
35780           description: String that identifies the interface
35781           required: true
35782           type: string
35783           example: __VLAN-INTERFACE__
35784         - name: l3-interface-ipv6-address
35785           in: path
35786           description: IP address
35787           required: true
35788           type: string
35789           example: __L3-INTERFACE-IPV6-ADDRESS__
35790         - name: body
35791           in: body
35792           description: l3-interface-ipv6-address-list object that needs to be updated.
35793           required: true
35794           schema:
35795             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35796     delete:
35797       tags:
35798         - Network
35799       summary: delete an existing l3-interface-ipv6-address-list
35800       description: delete an existing l3-interface-ipv6-address-list
35801       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35802       consumes:
35803         - application/json
35804         - application/xml
35805       produces:
35806         - application/json
35807         - application/xml
35808       responses:
35809         "default":
35810           description: Response codes found in [response codes](https://wiki.onap.org/).
35811       parameters:
35812         - name: pnf-name
35813           in: path
35814           description: unique name of Physical Network Function.
35815           required: true
35816           type: string
35817           example: __PNF-NAME__
35818         - name: interface-name
35819           in: path
35820           description: Name that identifies the physical interface
35821           required: true
35822           type: string
35823           example: __INTERFACE-NAME__
35824         - name: interface-name
35825           in: path
35826           description: Name given to the interface
35827           required: true
35828           type: string
35829           example: __INTERFACE-NAME__
35830         - name: vlan-interface
35831           in: path
35832           description: String that identifies the interface
35833           required: true
35834           type: string
35835           example: __VLAN-INTERFACE__
35836         - name: l3-interface-ipv6-address
35837           in: path
35838           description: IP address
35839           required: true
35840           type: string
35841           example: __L3-INTERFACE-IPV6-ADDRESS__
35842         - name: resource-version
35843           in: query
35844           description: resource-version for concurrency
35845           required: true
35846           type: string
35847   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35848     get:
35849       tags:
35850         - Network
35851       summary: returns vlan
35852       description: returns vlan
35853       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35854       produces:
35855         - application/json
35856         - application/xml
35857       responses:
35858         "200":
35859           description: successful operation
35860           schema:
35861               $ref: "#/getDefinitions/vlan"
35862         "default":
35863           description: Response codes found in [response codes](https://wiki.onap.org/).
35864       parameters:
35865         - name: pnf-name
35866           in: path
35867           description: unique name of Physical Network Function.
35868           required: true
35869           type: string
35870           example: __PNF-NAME__
35871         - name: interface-name
35872           in: path
35873           description: Name that identifies the physical interface
35874           required: true
35875           type: string
35876           example: __INTERFACE-NAME__
35877         - name: interface-name
35878           in: path
35879           description: Name given to the interface
35880           required: true
35881           type: string
35882           example: __INTERFACE-NAME__
35883         - name: vlan-interface
35884           in: path
35885           description: String that identifies the interface
35886           required: true
35887           type: string
35888           example: __VLAN-INTERFACE__
35889     put:
35890       tags:
35891         - Network
35892       summary: create or update an existing vlan
35893       description: |
35894         Create or update an existing vlan.
35895         #
35896         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35897       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35898       consumes:
35899         - application/json
35900         - application/xml
35901       produces:
35902         - application/json
35903         - application/xml
35904       responses:
35905         "default":
35906           description: Response codes found in [response codes](https://wiki.onap.org/).
35907       parameters:
35908         - name: pnf-name
35909           in: path
35910           description: unique name of Physical Network Function.
35911           required: true
35912           type: string
35913           example: __PNF-NAME__
35914         - name: interface-name
35915           in: path
35916           description: Name that identifies the physical interface
35917           required: true
35918           type: string
35919           example: __INTERFACE-NAME__
35920         - name: interface-name
35921           in: path
35922           description: Name given to the interface
35923           required: true
35924           type: string
35925           example: __INTERFACE-NAME__
35926         - name: vlan-interface
35927           in: path
35928           description: String that identifies the interface
35929           required: true
35930           type: string
35931           example: __VLAN-INTERFACE__
35932         - name: body
35933           in: body
35934           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35935           required: true
35936           schema:
35937             $ref: "#/definitions/vlan"
35938     patch:
35939       tags:
35940         - Network
35941       summary: update an existing vlan
35942       description: |
35943         Update an existing vlan
35944         #
35945         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35946         The PUT operation will entirely replace an existing object.
35947         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35948         #
35949         Other differences between PUT and PATCH are:
35950         #
35951         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35952         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35953         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35954       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35955       consumes:
35956         - application/json
35957         - application/xml
35958       produces:
35959         - application/json
35960         - application/xml
35961       responses:
35962         "default":
35963           description: Response codes found in [response codes](https://wiki.onap.org/).
35964       parameters:
35965         - name: pnf-name
35966           in: path
35967           description: unique name of Physical Network Function.
35968           required: true
35969           type: string
35970           example: __PNF-NAME__
35971         - name: interface-name
35972           in: path
35973           description: Name that identifies the physical interface
35974           required: true
35975           type: string
35976           example: __INTERFACE-NAME__
35977         - name: interface-name
35978           in: path
35979           description: Name given to the interface
35980           required: true
35981           type: string
35982           example: __INTERFACE-NAME__
35983         - name: vlan-interface
35984           in: path
35985           description: String that identifies the interface
35986           required: true
35987           type: string
35988           example: __VLAN-INTERFACE__
35989         - name: body
35990           in: body
35991           description: vlan object that needs to be updated.
35992           required: true
35993           schema:
35994             $ref: "#/patchDefinitions/vlan"
35995     delete:
35996       tags:
35997         - Network
35998       summary: delete an existing vlan
35999       description: delete an existing vlan
36000       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
36001       consumes:
36002         - application/json
36003         - application/xml
36004       produces:
36005         - application/json
36006         - application/xml
36007       responses:
36008         "default":
36009           description: Response codes found in [response codes](https://wiki.onap.org/).
36010       parameters:
36011         - name: pnf-name
36012           in: path
36013           description: unique name of Physical Network Function.
36014           required: true
36015           type: string
36016           example: __PNF-NAME__
36017         - name: interface-name
36018           in: path
36019           description: Name that identifies the physical interface
36020           required: true
36021           type: string
36022           example: __INTERFACE-NAME__
36023         - name: interface-name
36024           in: path
36025           description: Name given to the interface
36026           required: true
36027           type: string
36028           example: __INTERFACE-NAME__
36029         - name: vlan-interface
36030           in: path
36031           description: String that identifies the interface
36032           required: true
36033           type: string
36034           example: __VLAN-INTERFACE__
36035         - name: resource-version
36036           in: query
36037           description: resource-version for concurrency
36038           required: true
36039           type: string
36040   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
36041     get:
36042       tags:
36043         - Network
36044       summary: returns vlans
36045       description: returns vlans
36046       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
36047       produces:
36048         - application/json
36049         - application/xml
36050       responses:
36051         "200":
36052           description: successful operation
36053           schema:
36054               $ref: "#/getDefinitions/vlans"
36055         "default":
36056           description: Response codes found in [response codes](https://wiki.onap.org/).
36057       parameters:
36058         - name: pnf-name
36059           in: path
36060           description: unique name of Physical Network Function.
36061           required: true
36062           type: string
36063           example: __PNF-NAME__
36064         - name: interface-name
36065           in: path
36066           description: Name that identifies the physical interface
36067           required: true
36068           type: string
36069           example: __INTERFACE-NAME__
36070         - name: interface-name
36071           in: path
36072           description: Name given to the interface
36073           required: true
36074           type: string
36075           example: __INTERFACE-NAME__
36076         - name: vlan-interface
36077           in: query
36078           description:
36079           required: false
36080           type: string
36081         - name: vlan-id-inner
36082           in: query
36083           description:
36084           required: false
36085           type: integer
36086           format: int64
36087         - name: vpn-id
36088           in: query
36089           description:
36090           required: false
36091           type: string
36092   /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:
36093     put:
36094       tags:
36095         - Network
36096       summary: see node definition for valid relationships
36097       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36098       consumes:
36099         - application/json
36100         - application/xml
36101       produces:
36102         - application/json
36103         - application/xml
36104       responses:
36105         "default":
36106           description: Response codes found in [response codes](https://wiki.onap.org/).
36107       parameters:
36108         - name: pnf-name
36109           in: path
36110           description: unique name of Physical Network Function.
36111           required: true
36112           type: string
36113           example: __PNF-NAME__
36114         - name: interface-name
36115           in: path
36116           description: Name that identifies the physical interface
36117           required: true
36118           type: string
36119           example: __INTERFACE-NAME__
36120         - name: interface-name
36121           in: path
36122           description: Name given to the interface
36123           required: true
36124           type: string
36125           example: __INTERFACE-NAME__
36126         - name: pci-id
36127           in: path
36128           description: PCI ID used to identify the sriov-vf
36129           required: true
36130           type: string
36131           example: __PCI-ID__
36132         - name: body
36133           in: body
36134           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36135           required: true
36136           schema:
36137             $ref: "#/definitions/relationship"
36138     delete:
36139       tags:
36140         - Network
36141       summary: delete an existing relationship
36142       description: delete an existing relationship
36143       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36144       consumes:
36145         - application/json
36146         - application/xml
36147       produces:
36148         - application/json
36149         - application/xml
36150       responses:
36151         "default":
36152           description: Response codes found in [response codes](https://wiki.onap.org/).
36153       parameters:
36154         - name: pnf-name
36155           in: path
36156           description: unique name of Physical Network Function.
36157           required: true
36158           type: string
36159           example: __PNF-NAME__
36160         - name: interface-name
36161           in: path
36162           description: Name that identifies the physical interface
36163           required: true
36164           type: string
36165           example: __INTERFACE-NAME__
36166         - name: interface-name
36167           in: path
36168           description: Name given to the interface
36169           required: true
36170           type: string
36171           example: __INTERFACE-NAME__
36172         - name: pci-id
36173           in: path
36174           description: PCI ID used to identify the sriov-vf
36175           required: true
36176           type: string
36177           example: __PCI-ID__
36178   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36179     get:
36180       tags:
36181         - Network
36182       summary: returns sriov-vf
36183       description: returns sriov-vf
36184       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36185       produces:
36186         - application/json
36187         - application/xml
36188       responses:
36189         "200":
36190           description: successful operation
36191           schema:
36192               $ref: "#/getDefinitions/sriov-vf"
36193         "default":
36194           description: Response codes found in [response codes](https://wiki.onap.org/).
36195       parameters:
36196         - name: pnf-name
36197           in: path
36198           description: unique name of Physical Network Function.
36199           required: true
36200           type: string
36201           example: __PNF-NAME__
36202         - name: interface-name
36203           in: path
36204           description: Name that identifies the physical interface
36205           required: true
36206           type: string
36207           example: __INTERFACE-NAME__
36208         - name: interface-name
36209           in: path
36210           description: Name given to the interface
36211           required: true
36212           type: string
36213           example: __INTERFACE-NAME__
36214         - name: pci-id
36215           in: path
36216           description: PCI ID used to identify the sriov-vf
36217           required: true
36218           type: string
36219           example: __PCI-ID__
36220     put:
36221       tags:
36222         - Network
36223       summary: create or update an existing sriov-vf
36224       description: |
36225         Create or update an existing sriov-vf.
36226         #
36227         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36228       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36229       consumes:
36230         - application/json
36231         - application/xml
36232       produces:
36233         - application/json
36234         - application/xml
36235       responses:
36236         "default":
36237           description: Response codes found in [response codes](https://wiki.onap.org/).
36238       parameters:
36239         - name: pnf-name
36240           in: path
36241           description: unique name of Physical Network Function.
36242           required: true
36243           type: string
36244           example: __PNF-NAME__
36245         - name: interface-name
36246           in: path
36247           description: Name that identifies the physical interface
36248           required: true
36249           type: string
36250           example: __INTERFACE-NAME__
36251         - name: interface-name
36252           in: path
36253           description: Name given to the interface
36254           required: true
36255           type: string
36256           example: __INTERFACE-NAME__
36257         - name: pci-id
36258           in: path
36259           description: PCI ID used to identify the sriov-vf
36260           required: true
36261           type: string
36262           example: __PCI-ID__
36263         - name: body
36264           in: body
36265           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36266           required: true
36267           schema:
36268             $ref: "#/definitions/sriov-vf"
36269     patch:
36270       tags:
36271         - Network
36272       summary: update an existing sriov-vf
36273       description: |
36274         Update an existing sriov-vf
36275         #
36276         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36277         The PUT operation will entirely replace an existing object.
36278         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36279         #
36280         Other differences between PUT and PATCH are:
36281         #
36282         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36283         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36284         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36285       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36286       consumes:
36287         - application/json
36288         - application/xml
36289       produces:
36290         - application/json
36291         - application/xml
36292       responses:
36293         "default":
36294           description: Response codes found in [response codes](https://wiki.onap.org/).
36295       parameters:
36296         - name: pnf-name
36297           in: path
36298           description: unique name of Physical Network Function.
36299           required: true
36300           type: string
36301           example: __PNF-NAME__
36302         - name: interface-name
36303           in: path
36304           description: Name that identifies the physical interface
36305           required: true
36306           type: string
36307           example: __INTERFACE-NAME__
36308         - name: interface-name
36309           in: path
36310           description: Name given to the interface
36311           required: true
36312           type: string
36313           example: __INTERFACE-NAME__
36314         - name: pci-id
36315           in: path
36316           description: PCI ID used to identify the sriov-vf
36317           required: true
36318           type: string
36319           example: __PCI-ID__
36320         - name: body
36321           in: body
36322           description: sriov-vf object that needs to be updated.
36323           required: true
36324           schema:
36325             $ref: "#/patchDefinitions/sriov-vf"
36326     delete:
36327       tags:
36328         - Network
36329       summary: delete an existing sriov-vf
36330       description: delete an existing sriov-vf
36331       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36332       consumes:
36333         - application/json
36334         - application/xml
36335       produces:
36336         - application/json
36337         - application/xml
36338       responses:
36339         "default":
36340           description: Response codes found in [response codes](https://wiki.onap.org/).
36341       parameters:
36342         - name: pnf-name
36343           in: path
36344           description: unique name of Physical Network Function.
36345           required: true
36346           type: string
36347           example: __PNF-NAME__
36348         - name: interface-name
36349           in: path
36350           description: Name that identifies the physical interface
36351           required: true
36352           type: string
36353           example: __INTERFACE-NAME__
36354         - name: interface-name
36355           in: path
36356           description: Name given to the interface
36357           required: true
36358           type: string
36359           example: __INTERFACE-NAME__
36360         - name: pci-id
36361           in: path
36362           description: PCI ID used to identify the sriov-vf
36363           required: true
36364           type: string
36365           example: __PCI-ID__
36366         - name: resource-version
36367           in: query
36368           description: resource-version for concurrency
36369           required: true
36370           type: string
36371   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36372     get:
36373       tags:
36374         - Network
36375       summary: returns sriov-vfs
36376       description: returns sriov-vfs
36377       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
36378       produces:
36379         - application/json
36380         - application/xml
36381       responses:
36382         "200":
36383           description: successful operation
36384           schema:
36385               $ref: "#/getDefinitions/sriov-vfs"
36386         "default":
36387           description: Response codes found in [response codes](https://wiki.onap.org/).
36388       parameters:
36389         - name: pnf-name
36390           in: path
36391           description: unique name of Physical Network Function.
36392           required: true
36393           type: string
36394           example: __PNF-NAME__
36395         - name: interface-name
36396           in: path
36397           description: Name that identifies the physical interface
36398           required: true
36399           type: string
36400           example: __INTERFACE-NAME__
36401         - name: interface-name
36402           in: path
36403           description: Name given to the interface
36404           required: true
36405           type: string
36406           example: __INTERFACE-NAME__
36407         - name: pci-id
36408           in: query
36409           description:
36410           required: false
36411           type: string
36412         - name: vf-vlan-filter
36413           in: query
36414           description:
36415           required: false
36416           type: string
36417         - name: vf-mac-filter
36418           in: query
36419           description:
36420           required: false
36421           type: string
36422         - name: vf-vlan-strip
36423           in: query
36424           description:
36425           required: false
36426           type: boolean
36427         - name: neutron-network-id
36428           in: query
36429           description:
36430           required: false
36431           type: string
36432   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36433     put:
36434       tags:
36435         - Network
36436       summary: see node definition for valid relationships
36437       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36438       consumes:
36439         - application/json
36440         - application/xml
36441       produces:
36442         - application/json
36443         - application/xml
36444       responses:
36445         "default":
36446           description: Response codes found in [response codes](https://wiki.onap.org/).
36447       parameters:
36448         - name: pnf-name
36449           in: path
36450           description: unique name of Physical Network Function.
36451           required: true
36452           type: string
36453           example: __PNF-NAME__
36454         - name: interface-name
36455           in: path
36456           description: Name that identifies the physical interface
36457           required: true
36458           type: string
36459           example: __INTERFACE-NAME__
36460         - name: interface-name
36461           in: path
36462           description: Name given to the interface
36463           required: true
36464           type: string
36465           example: __INTERFACE-NAME__
36466         - name: body
36467           in: body
36468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36469           required: true
36470           schema:
36471             $ref: "#/definitions/relationship"
36472     delete:
36473       tags:
36474         - Network
36475       summary: delete an existing relationship
36476       description: delete an existing relationship
36477       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36478       consumes:
36479         - application/json
36480         - application/xml
36481       produces:
36482         - application/json
36483         - application/xml
36484       responses:
36485         "default":
36486           description: Response codes found in [response codes](https://wiki.onap.org/).
36487       parameters:
36488         - name: pnf-name
36489           in: path
36490           description: unique name of Physical Network Function.
36491           required: true
36492           type: string
36493           example: __PNF-NAME__
36494         - name: interface-name
36495           in: path
36496           description: Name that identifies the physical interface
36497           required: true
36498           type: string
36499           example: __INTERFACE-NAME__
36500         - name: interface-name
36501           in: path
36502           description: Name given to the interface
36503           required: true
36504           type: string
36505           example: __INTERFACE-NAME__
36506   /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:
36507     put:
36508       tags:
36509         - Network
36510       summary: see node definition for valid relationships
36511       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36512       consumes:
36513         - application/json
36514         - application/xml
36515       produces:
36516         - application/json
36517         - application/xml
36518       responses:
36519         "default":
36520           description: Response codes found in [response codes](https://wiki.onap.org/).
36521       parameters:
36522         - name: pnf-name
36523           in: path
36524           description: unique name of Physical Network Function.
36525           required: true
36526           type: string
36527           example: __PNF-NAME__
36528         - name: interface-name
36529           in: path
36530           description: Name that identifies the physical interface
36531           required: true
36532           type: string
36533           example: __INTERFACE-NAME__
36534         - name: interface-name
36535           in: path
36536           description: Name given to the interface
36537           required: true
36538           type: string
36539           example: __INTERFACE-NAME__
36540         - name: l3-interface-ipv4-address
36541           in: path
36542           description: IP address
36543           required: true
36544           type: string
36545           example: __L3-INTERFACE-IPV4-ADDRESS__
36546         - name: body
36547           in: body
36548           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36549           required: true
36550           schema:
36551             $ref: "#/definitions/relationship"
36552     delete:
36553       tags:
36554         - Network
36555       summary: delete an existing relationship
36556       description: delete an existing relationship
36557       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36558       consumes:
36559         - application/json
36560         - application/xml
36561       produces:
36562         - application/json
36563         - application/xml
36564       responses:
36565         "default":
36566           description: Response codes found in [response codes](https://wiki.onap.org/).
36567       parameters:
36568         - name: pnf-name
36569           in: path
36570           description: unique name of Physical Network Function.
36571           required: true
36572           type: string
36573           example: __PNF-NAME__
36574         - name: interface-name
36575           in: path
36576           description: Name that identifies the physical interface
36577           required: true
36578           type: string
36579           example: __INTERFACE-NAME__
36580         - name: interface-name
36581           in: path
36582           description: Name given to the interface
36583           required: true
36584           type: string
36585           example: __INTERFACE-NAME__
36586         - name: l3-interface-ipv4-address
36587           in: path
36588           description: IP address
36589           required: true
36590           type: string
36591           example: __L3-INTERFACE-IPV4-ADDRESS__
36592   /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}:
36593     get:
36594       tags:
36595         - Network
36596       summary: returns l3-interface-ipv4-address-list
36597       description: returns l3-interface-ipv4-address-list
36598       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36599       produces:
36600         - application/json
36601         - application/xml
36602       responses:
36603         "200":
36604           description: successful operation
36605           schema:
36606               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36607         "default":
36608           description: Response codes found in [response codes](https://wiki.onap.org/).
36609       parameters:
36610         - name: pnf-name
36611           in: path
36612           description: unique name of Physical Network Function.
36613           required: true
36614           type: string
36615           example: __PNF-NAME__
36616         - name: interface-name
36617           in: path
36618           description: Name that identifies the physical interface
36619           required: true
36620           type: string
36621           example: __INTERFACE-NAME__
36622         - name: interface-name
36623           in: path
36624           description: Name given to the interface
36625           required: true
36626           type: string
36627           example: __INTERFACE-NAME__
36628         - name: l3-interface-ipv4-address
36629           in: path
36630           description: IP address
36631           required: true
36632           type: string
36633           example: __L3-INTERFACE-IPV4-ADDRESS__
36634     put:
36635       tags:
36636         - Network
36637       summary: create or update an existing l3-interface-ipv4-address-list
36638       description: |
36639         Create or update an existing l3-interface-ipv4-address-list.
36640         #
36641         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36642       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36643       consumes:
36644         - application/json
36645         - application/xml
36646       produces:
36647         - application/json
36648         - application/xml
36649       responses:
36650         "default":
36651           description: Response codes found in [response codes](https://wiki.onap.org/).
36652       parameters:
36653         - name: pnf-name
36654           in: path
36655           description: unique name of Physical Network Function.
36656           required: true
36657           type: string
36658           example: __PNF-NAME__
36659         - name: interface-name
36660           in: path
36661           description: Name that identifies the physical interface
36662           required: true
36663           type: string
36664           example: __INTERFACE-NAME__
36665         - name: interface-name
36666           in: path
36667           description: Name given to the interface
36668           required: true
36669           type: string
36670           example: __INTERFACE-NAME__
36671         - name: l3-interface-ipv4-address
36672           in: path
36673           description: IP address
36674           required: true
36675           type: string
36676           example: __L3-INTERFACE-IPV4-ADDRESS__
36677         - name: body
36678           in: body
36679           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36680           required: true
36681           schema:
36682             $ref: "#/definitions/l3-interface-ipv4-address-list"
36683     patch:
36684       tags:
36685         - Network
36686       summary: update an existing l3-interface-ipv4-address-list
36687       description: |
36688         Update an existing l3-interface-ipv4-address-list
36689         #
36690         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36691         The PUT operation will entirely replace an existing object.
36692         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36693         #
36694         Other differences between PUT and PATCH are:
36695         #
36696         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36697         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36698         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36699       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36700       consumes:
36701         - application/json
36702         - application/xml
36703       produces:
36704         - application/json
36705         - application/xml
36706       responses:
36707         "default":
36708           description: Response codes found in [response codes](https://wiki.onap.org/).
36709       parameters:
36710         - name: pnf-name
36711           in: path
36712           description: unique name of Physical Network Function.
36713           required: true
36714           type: string
36715           example: __PNF-NAME__
36716         - name: interface-name
36717           in: path
36718           description: Name that identifies the physical interface
36719           required: true
36720           type: string
36721           example: __INTERFACE-NAME__
36722         - name: interface-name
36723           in: path
36724           description: Name given to the interface
36725           required: true
36726           type: string
36727           example: __INTERFACE-NAME__
36728         - name: l3-interface-ipv4-address
36729           in: path
36730           description: IP address
36731           required: true
36732           type: string
36733           example: __L3-INTERFACE-IPV4-ADDRESS__
36734         - name: body
36735           in: body
36736           description: l3-interface-ipv4-address-list object that needs to be updated.
36737           required: true
36738           schema:
36739             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36740     delete:
36741       tags:
36742         - Network
36743       summary: delete an existing l3-interface-ipv4-address-list
36744       description: delete an existing l3-interface-ipv4-address-list
36745       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36746       consumes:
36747         - application/json
36748         - application/xml
36749       produces:
36750         - application/json
36751         - application/xml
36752       responses:
36753         "default":
36754           description: Response codes found in [response codes](https://wiki.onap.org/).
36755       parameters:
36756         - name: pnf-name
36757           in: path
36758           description: unique name of Physical Network Function.
36759           required: true
36760           type: string
36761           example: __PNF-NAME__
36762         - name: interface-name
36763           in: path
36764           description: Name that identifies the physical interface
36765           required: true
36766           type: string
36767           example: __INTERFACE-NAME__
36768         - name: interface-name
36769           in: path
36770           description: Name given to the interface
36771           required: true
36772           type: string
36773           example: __INTERFACE-NAME__
36774         - name: l3-interface-ipv4-address
36775           in: path
36776           description: IP address
36777           required: true
36778           type: string
36779           example: __L3-INTERFACE-IPV4-ADDRESS__
36780         - name: resource-version
36781           in: query
36782           description: resource-version for concurrency
36783           required: true
36784           type: string
36785   /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:
36786     put:
36787       tags:
36788         - Network
36789       summary: see node definition for valid relationships
36790       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36791       consumes:
36792         - application/json
36793         - application/xml
36794       produces:
36795         - application/json
36796         - application/xml
36797       responses:
36798         "default":
36799           description: Response codes found in [response codes](https://wiki.onap.org/).
36800       parameters:
36801         - name: pnf-name
36802           in: path
36803           description: unique name of Physical Network Function.
36804           required: true
36805           type: string
36806           example: __PNF-NAME__
36807         - name: interface-name
36808           in: path
36809           description: Name that identifies the physical interface
36810           required: true
36811           type: string
36812           example: __INTERFACE-NAME__
36813         - name: interface-name
36814           in: path
36815           description: Name given to the interface
36816           required: true
36817           type: string
36818           example: __INTERFACE-NAME__
36819         - name: l3-interface-ipv6-address
36820           in: path
36821           description: IP address
36822           required: true
36823           type: string
36824           example: __L3-INTERFACE-IPV6-ADDRESS__
36825         - name: body
36826           in: body
36827           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36828           required: true
36829           schema:
36830             $ref: "#/definitions/relationship"
36831     delete:
36832       tags:
36833         - Network
36834       summary: delete an existing relationship
36835       description: delete an existing relationship
36836       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36837       consumes:
36838         - application/json
36839         - application/xml
36840       produces:
36841         - application/json
36842         - application/xml
36843       responses:
36844         "default":
36845           description: Response codes found in [response codes](https://wiki.onap.org/).
36846       parameters:
36847         - name: pnf-name
36848           in: path
36849           description: unique name of Physical Network Function.
36850           required: true
36851           type: string
36852           example: __PNF-NAME__
36853         - name: interface-name
36854           in: path
36855           description: Name that identifies the physical interface
36856           required: true
36857           type: string
36858           example: __INTERFACE-NAME__
36859         - name: interface-name
36860           in: path
36861           description: Name given to the interface
36862           required: true
36863           type: string
36864           example: __INTERFACE-NAME__
36865         - name: l3-interface-ipv6-address
36866           in: path
36867           description: IP address
36868           required: true
36869           type: string
36870           example: __L3-INTERFACE-IPV6-ADDRESS__
36871   /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}:
36872     get:
36873       tags:
36874         - Network
36875       summary: returns l3-interface-ipv6-address-list
36876       description: returns l3-interface-ipv6-address-list
36877       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36878       produces:
36879         - application/json
36880         - application/xml
36881       responses:
36882         "200":
36883           description: successful operation
36884           schema:
36885               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36886         "default":
36887           description: Response codes found in [response codes](https://wiki.onap.org/).
36888       parameters:
36889         - name: pnf-name
36890           in: path
36891           description: unique name of Physical Network Function.
36892           required: true
36893           type: string
36894           example: __PNF-NAME__
36895         - name: interface-name
36896           in: path
36897           description: Name that identifies the physical interface
36898           required: true
36899           type: string
36900           example: __INTERFACE-NAME__
36901         - name: interface-name
36902           in: path
36903           description: Name given to the interface
36904           required: true
36905           type: string
36906           example: __INTERFACE-NAME__
36907         - name: l3-interface-ipv6-address
36908           in: path
36909           description: IP address
36910           required: true
36911           type: string
36912           example: __L3-INTERFACE-IPV6-ADDRESS__
36913     put:
36914       tags:
36915         - Network
36916       summary: create or update an existing l3-interface-ipv6-address-list
36917       description: |
36918         Create or update an existing l3-interface-ipv6-address-list.
36919         #
36920         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36921       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36922       consumes:
36923         - application/json
36924         - application/xml
36925       produces:
36926         - application/json
36927         - application/xml
36928       responses:
36929         "default":
36930           description: Response codes found in [response codes](https://wiki.onap.org/).
36931       parameters:
36932         - name: pnf-name
36933           in: path
36934           description: unique name of Physical Network Function.
36935           required: true
36936           type: string
36937           example: __PNF-NAME__
36938         - name: interface-name
36939           in: path
36940           description: Name that identifies the physical interface
36941           required: true
36942           type: string
36943           example: __INTERFACE-NAME__
36944         - name: interface-name
36945           in: path
36946           description: Name given to the interface
36947           required: true
36948           type: string
36949           example: __INTERFACE-NAME__
36950         - name: l3-interface-ipv6-address
36951           in: path
36952           description: IP address
36953           required: true
36954           type: string
36955           example: __L3-INTERFACE-IPV6-ADDRESS__
36956         - name: body
36957           in: body
36958           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36959           required: true
36960           schema:
36961             $ref: "#/definitions/l3-interface-ipv6-address-list"
36962     patch:
36963       tags:
36964         - Network
36965       summary: update an existing l3-interface-ipv6-address-list
36966       description: |
36967         Update an existing l3-interface-ipv6-address-list
36968         #
36969         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36970         The PUT operation will entirely replace an existing object.
36971         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36972         #
36973         Other differences between PUT and PATCH are:
36974         #
36975         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36976         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36977         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36978       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36979       consumes:
36980         - application/json
36981         - application/xml
36982       produces:
36983         - application/json
36984         - application/xml
36985       responses:
36986         "default":
36987           description: Response codes found in [response codes](https://wiki.onap.org/).
36988       parameters:
36989         - name: pnf-name
36990           in: path
36991           description: unique name of Physical Network Function.
36992           required: true
36993           type: string
36994           example: __PNF-NAME__
36995         - name: interface-name
36996           in: path
36997           description: Name that identifies the physical interface
36998           required: true
36999           type: string
37000           example: __INTERFACE-NAME__
37001         - name: interface-name
37002           in: path
37003           description: Name given to the interface
37004           required: true
37005           type: string
37006           example: __INTERFACE-NAME__
37007         - name: l3-interface-ipv6-address
37008           in: path
37009           description: IP address
37010           required: true
37011           type: string
37012           example: __L3-INTERFACE-IPV6-ADDRESS__
37013         - name: body
37014           in: body
37015           description: l3-interface-ipv6-address-list object that needs to be updated.
37016           required: true
37017           schema:
37018             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37019     delete:
37020       tags:
37021         - Network
37022       summary: delete an existing l3-interface-ipv6-address-list
37023       description: delete an existing l3-interface-ipv6-address-list
37024       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37025       consumes:
37026         - application/json
37027         - application/xml
37028       produces:
37029         - application/json
37030         - application/xml
37031       responses:
37032         "default":
37033           description: Response codes found in [response codes](https://wiki.onap.org/).
37034       parameters:
37035         - name: pnf-name
37036           in: path
37037           description: unique name of Physical Network Function.
37038           required: true
37039           type: string
37040           example: __PNF-NAME__
37041         - name: interface-name
37042           in: path
37043           description: Name that identifies the physical interface
37044           required: true
37045           type: string
37046           example: __INTERFACE-NAME__
37047         - name: interface-name
37048           in: path
37049           description: Name given to the interface
37050           required: true
37051           type: string
37052           example: __INTERFACE-NAME__
37053         - name: l3-interface-ipv6-address
37054           in: path
37055           description: IP address
37056           required: true
37057           type: string
37058           example: __L3-INTERFACE-IPV6-ADDRESS__
37059         - name: resource-version
37060           in: query
37061           description: resource-version for concurrency
37062           required: true
37063           type: string
37064   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
37065     get:
37066       tags:
37067         - Network
37068       summary: returns l-interface
37069       description: returns l-interface
37070       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37071       produces:
37072         - application/json
37073         - application/xml
37074       responses:
37075         "200":
37076           description: successful operation
37077           schema:
37078               $ref: "#/getDefinitions/l-interface"
37079         "default":
37080           description: Response codes found in [response codes](https://wiki.onap.org/).
37081       parameters:
37082         - name: pnf-name
37083           in: path
37084           description: unique name of Physical Network Function.
37085           required: true
37086           type: string
37087           example: __PNF-NAME__
37088         - name: interface-name
37089           in: path
37090           description: Name that identifies the physical interface
37091           required: true
37092           type: string
37093           example: __INTERFACE-NAME__
37094         - name: interface-name
37095           in: path
37096           description: Name given to the interface
37097           required: true
37098           type: string
37099           example: __INTERFACE-NAME__
37100     put:
37101       tags:
37102         - Network
37103       summary: create or update an existing l-interface
37104       description: |
37105         Create or update an existing l-interface.
37106         #
37107         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37108       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37109       consumes:
37110         - application/json
37111         - application/xml
37112       produces:
37113         - application/json
37114         - application/xml
37115       responses:
37116         "default":
37117           description: Response codes found in [response codes](https://wiki.onap.org/).
37118       parameters:
37119         - name: pnf-name
37120           in: path
37121           description: unique name of Physical Network Function.
37122           required: true
37123           type: string
37124           example: __PNF-NAME__
37125         - name: interface-name
37126           in: path
37127           description: Name that identifies the physical interface
37128           required: true
37129           type: string
37130           example: __INTERFACE-NAME__
37131         - name: interface-name
37132           in: path
37133           description: Name given to the interface
37134           required: true
37135           type: string
37136           example: __INTERFACE-NAME__
37137         - name: body
37138           in: body
37139           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
37140           required: true
37141           schema:
37142             $ref: "#/definitions/l-interface"
37143     patch:
37144       tags:
37145         - Network
37146       summary: update an existing l-interface
37147       description: |
37148         Update an existing l-interface
37149         #
37150         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37151         The PUT operation will entirely replace an existing object.
37152         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37153         #
37154         Other differences between PUT and PATCH are:
37155         #
37156         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37157         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37158         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37159       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37160       consumes:
37161         - application/json
37162         - application/xml
37163       produces:
37164         - application/json
37165         - application/xml
37166       responses:
37167         "default":
37168           description: Response codes found in [response codes](https://wiki.onap.org/).
37169       parameters:
37170         - name: pnf-name
37171           in: path
37172           description: unique name of Physical Network Function.
37173           required: true
37174           type: string
37175           example: __PNF-NAME__
37176         - name: interface-name
37177           in: path
37178           description: Name that identifies the physical interface
37179           required: true
37180           type: string
37181           example: __INTERFACE-NAME__
37182         - name: interface-name
37183           in: path
37184           description: Name given to the interface
37185           required: true
37186           type: string
37187           example: __INTERFACE-NAME__
37188         - name: body
37189           in: body
37190           description: l-interface object that needs to be updated.
37191           required: true
37192           schema:
37193             $ref: "#/patchDefinitions/l-interface"
37194     delete:
37195       tags:
37196         - Network
37197       summary: delete an existing l-interface
37198       description: delete an existing l-interface
37199       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37200       consumes:
37201         - application/json
37202         - application/xml
37203       produces:
37204         - application/json
37205         - application/xml
37206       responses:
37207         "default":
37208           description: Response codes found in [response codes](https://wiki.onap.org/).
37209       parameters:
37210         - name: pnf-name
37211           in: path
37212           description: unique name of Physical Network Function.
37213           required: true
37214           type: string
37215           example: __PNF-NAME__
37216         - name: interface-name
37217           in: path
37218           description: Name that identifies the physical interface
37219           required: true
37220           type: string
37221           example: __INTERFACE-NAME__
37222         - name: interface-name
37223           in: path
37224           description: Name given to the interface
37225           required: true
37226           type: string
37227           example: __INTERFACE-NAME__
37228         - name: resource-version
37229           in: query
37230           description: resource-version for concurrency
37231           required: true
37232           type: string
37233   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
37234     get:
37235       tags:
37236         - Network
37237       summary: returns l-interfaces
37238       description: returns l-interfaces
37239       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
37240       produces:
37241         - application/json
37242         - application/xml
37243       responses:
37244         "200":
37245           description: successful operation
37246           schema:
37247               $ref: "#/getDefinitions/l-interfaces"
37248         "default":
37249           description: Response codes found in [response codes](https://wiki.onap.org/).
37250       parameters:
37251         - name: pnf-name
37252           in: path
37253           description: unique name of Physical Network Function.
37254           required: true
37255           type: string
37256           example: __PNF-NAME__
37257         - name: interface-name
37258           in: path
37259           description: Name that identifies the physical interface
37260           required: true
37261           type: string
37262           example: __INTERFACE-NAME__
37263         - name: interface-name
37264           in: query
37265           description:
37266           required: false
37267           type: string
37268         - name: interface-id
37269           in: query
37270           description:
37271           required: false
37272           type: string
37273         - name: macaddr
37274           in: query
37275           description:
37276           required: false
37277           type: string
37278         - name: network-name
37279           in: query
37280           description:
37281           required: false
37282           type: string
37283   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
37284     get:
37285       tags:
37286         - Network
37287       summary: returns p-interface
37288       description: returns p-interface
37289       operationId: getNetworkPnfsPnfPInterfacesPInterface
37290       produces:
37291         - application/json
37292         - application/xml
37293       responses:
37294         "200":
37295           description: successful operation
37296           schema:
37297               $ref: "#/getDefinitions/p-interface"
37298         "default":
37299           description: Response codes found in [response codes](https://wiki.onap.org/).
37300       parameters:
37301         - name: pnf-name
37302           in: path
37303           description: unique name of Physical Network Function.
37304           required: true
37305           type: string
37306           example: __PNF-NAME__
37307         - name: interface-name
37308           in: path
37309           description: Name that identifies the physical interface
37310           required: true
37311           type: string
37312           example: __INTERFACE-NAME__
37313     put:
37314       tags:
37315         - Network
37316       summary: create or update an existing p-interface
37317       description: |
37318         Create or update an existing p-interface.
37319         #
37320         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37321       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
37322       consumes:
37323         - application/json
37324         - application/xml
37325       produces:
37326         - application/json
37327         - application/xml
37328       responses:
37329         "default":
37330           description: Response codes found in [response codes](https://wiki.onap.org/).
37331       parameters:
37332         - name: pnf-name
37333           in: path
37334           description: unique name of Physical Network Function.
37335           required: true
37336           type: string
37337           example: __PNF-NAME__
37338         - name: interface-name
37339           in: path
37340           description: Name that identifies the physical interface
37341           required: true
37342           type: string
37343           example: __INTERFACE-NAME__
37344         - name: body
37345           in: body
37346           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
37347           required: true
37348           schema:
37349             $ref: "#/definitions/p-interface"
37350     patch:
37351       tags:
37352         - Network
37353       summary: update an existing p-interface
37354       description: |
37355         Update an existing p-interface
37356         #
37357         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37358         The PUT operation will entirely replace an existing object.
37359         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37360         #
37361         Other differences between PUT and PATCH are:
37362         #
37363         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37364         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37365         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37366       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
37367       consumes:
37368         - application/json
37369         - application/xml
37370       produces:
37371         - application/json
37372         - application/xml
37373       responses:
37374         "default":
37375           description: Response codes found in [response codes](https://wiki.onap.org/).
37376       parameters:
37377         - name: pnf-name
37378           in: path
37379           description: unique name of Physical Network Function.
37380           required: true
37381           type: string
37382           example: __PNF-NAME__
37383         - name: interface-name
37384           in: path
37385           description: Name that identifies the physical interface
37386           required: true
37387           type: string
37388           example: __INTERFACE-NAME__
37389         - name: body
37390           in: body
37391           description: p-interface object that needs to be updated.
37392           required: true
37393           schema:
37394             $ref: "#/patchDefinitions/p-interface"
37395     delete:
37396       tags:
37397         - Network
37398       summary: delete an existing p-interface
37399       description: delete an existing p-interface
37400       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
37401       consumes:
37402         - application/json
37403         - application/xml
37404       produces:
37405         - application/json
37406         - application/xml
37407       responses:
37408         "default":
37409           description: Response codes found in [response codes](https://wiki.onap.org/).
37410       parameters:
37411         - name: pnf-name
37412           in: path
37413           description: unique name of Physical Network Function.
37414           required: true
37415           type: string
37416           example: __PNF-NAME__
37417         - name: interface-name
37418           in: path
37419           description: Name that identifies the physical interface
37420           required: true
37421           type: string
37422           example: __INTERFACE-NAME__
37423         - name: resource-version
37424           in: query
37425           description: resource-version for concurrency
37426           required: true
37427           type: string
37428   /network/pnfs/pnf/{pnf-name}/p-interfaces:
37429     get:
37430       tags:
37431         - Network
37432       summary: returns p-interfaces
37433       description: returns p-interfaces
37434       operationId: getNetworkPnfsPnfPInterfaces
37435       produces:
37436         - application/json
37437         - application/xml
37438       responses:
37439         "200":
37440           description: successful operation
37441           schema:
37442               $ref: "#/getDefinitions/p-interfaces"
37443         "default":
37444           description: Response codes found in [response codes](https://wiki.onap.org/).
37445       parameters:
37446         - name: pnf-name
37447           in: path
37448           description: unique name of Physical Network Function.
37449           required: true
37450           type: string
37451           example: __PNF-NAME__
37452         - name: interface-name
37453           in: query
37454           description:
37455           required: false
37456           type: string
37457         - name: prov-status
37458           in: query
37459           description:
37460           required: false
37461           type: string
37462   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
37463     put:
37464       tags:
37465         - Network
37466       summary: see node definition for valid relationships
37467       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37468       consumes:
37469         - application/json
37470         - application/xml
37471       produces:
37472         - application/json
37473         - application/xml
37474       responses:
37475         "default":
37476           description: Response codes found in [response codes](https://wiki.onap.org/).
37477       parameters:
37478         - name: pnf-name
37479           in: path
37480           description: unique name of Physical Network Function.
37481           required: true
37482           type: string
37483           example: __PNF-NAME__
37484         - name: interface-name
37485           in: path
37486           description: Name that identifies the link aggregate interface
37487           required: true
37488           type: string
37489           example: __INTERFACE-NAME__
37490         - name: body
37491           in: body
37492           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
37493           required: true
37494           schema:
37495             $ref: "#/definitions/relationship"
37496     delete:
37497       tags:
37498         - Network
37499       summary: delete an existing relationship
37500       description: delete an existing relationship
37501       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37502       consumes:
37503         - application/json
37504         - application/xml
37505       produces:
37506         - application/json
37507         - application/xml
37508       responses:
37509         "default":
37510           description: Response codes found in [response codes](https://wiki.onap.org/).
37511       parameters:
37512         - name: pnf-name
37513           in: path
37514           description: unique name of Physical Network Function.
37515           required: true
37516           type: string
37517           example: __PNF-NAME__
37518         - name: interface-name
37519           in: path
37520           description: Name that identifies the link aggregate interface
37521           required: true
37522           type: string
37523           example: __INTERFACE-NAME__
37524   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37525     put:
37526       tags:
37527         - Network
37528       summary: see node definition for valid relationships
37529       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37530       consumes:
37531         - application/json
37532         - application/xml
37533       produces:
37534         - application/json
37535         - application/xml
37536       responses:
37537         "default":
37538           description: Response codes found in [response codes](https://wiki.onap.org/).
37539       parameters:
37540         - name: pnf-name
37541           in: path
37542           description: unique name of Physical Network Function.
37543           required: true
37544           type: string
37545           example: __PNF-NAME__
37546         - name: interface-name
37547           in: path
37548           description: Name that identifies the link aggregate interface
37549           required: true
37550           type: string
37551           example: __INTERFACE-NAME__
37552         - name: interface-name
37553           in: path
37554           description: Name given to the interface
37555           required: true
37556           type: string
37557           example: __INTERFACE-NAME__
37558         - name: vlan-interface
37559           in: path
37560           description: String that identifies the interface
37561           required: true
37562           type: string
37563           example: __VLAN-INTERFACE__
37564         - name: body
37565           in: body
37566           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37567           required: true
37568           schema:
37569             $ref: "#/definitions/relationship"
37570     delete:
37571       tags:
37572         - Network
37573       summary: delete an existing relationship
37574       description: delete an existing relationship
37575       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37576       consumes:
37577         - application/json
37578         - application/xml
37579       produces:
37580         - application/json
37581         - application/xml
37582       responses:
37583         "default":
37584           description: Response codes found in [response codes](https://wiki.onap.org/).
37585       parameters:
37586         - name: pnf-name
37587           in: path
37588           description: unique name of Physical Network Function.
37589           required: true
37590           type: string
37591           example: __PNF-NAME__
37592         - name: interface-name
37593           in: path
37594           description: Name that identifies the link aggregate interface
37595           required: true
37596           type: string
37597           example: __INTERFACE-NAME__
37598         - name: interface-name
37599           in: path
37600           description: Name given to the interface
37601           required: true
37602           type: string
37603           example: __INTERFACE-NAME__
37604         - name: vlan-interface
37605           in: path
37606           description: String that identifies the interface
37607           required: true
37608           type: string
37609           example: __VLAN-INTERFACE__
37610   /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:
37611     put:
37612       tags:
37613         - Network
37614       summary: see node definition for valid relationships
37615       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37616       consumes:
37617         - application/json
37618         - application/xml
37619       produces:
37620         - application/json
37621         - application/xml
37622       responses:
37623         "default":
37624           description: Response codes found in [response codes](https://wiki.onap.org/).
37625       parameters:
37626         - name: pnf-name
37627           in: path
37628           description: unique name of Physical Network Function.
37629           required: true
37630           type: string
37631           example: __PNF-NAME__
37632         - name: interface-name
37633           in: path
37634           description: Name that identifies the link aggregate interface
37635           required: true
37636           type: string
37637           example: __INTERFACE-NAME__
37638         - name: interface-name
37639           in: path
37640           description: Name given to the interface
37641           required: true
37642           type: string
37643           example: __INTERFACE-NAME__
37644         - name: vlan-interface
37645           in: path
37646           description: String that identifies the interface
37647           required: true
37648           type: string
37649           example: __VLAN-INTERFACE__
37650         - name: l3-interface-ipv4-address
37651           in: path
37652           description: IP address
37653           required: true
37654           type: string
37655           example: __L3-INTERFACE-IPV4-ADDRESS__
37656         - name: body
37657           in: body
37658           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37659           required: true
37660           schema:
37661             $ref: "#/definitions/relationship"
37662     delete:
37663       tags:
37664         - Network
37665       summary: delete an existing relationship
37666       description: delete an existing relationship
37667       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37668       consumes:
37669         - application/json
37670         - application/xml
37671       produces:
37672         - application/json
37673         - application/xml
37674       responses:
37675         "default":
37676           description: Response codes found in [response codes](https://wiki.onap.org/).
37677       parameters:
37678         - name: pnf-name
37679           in: path
37680           description: unique name of Physical Network Function.
37681           required: true
37682           type: string
37683           example: __PNF-NAME__
37684         - name: interface-name
37685           in: path
37686           description: Name that identifies the link aggregate interface
37687           required: true
37688           type: string
37689           example: __INTERFACE-NAME__
37690         - name: interface-name
37691           in: path
37692           description: Name given to the interface
37693           required: true
37694           type: string
37695           example: __INTERFACE-NAME__
37696         - name: vlan-interface
37697           in: path
37698           description: String that identifies the interface
37699           required: true
37700           type: string
37701           example: __VLAN-INTERFACE__
37702         - name: l3-interface-ipv4-address
37703           in: path
37704           description: IP address
37705           required: true
37706           type: string
37707           example: __L3-INTERFACE-IPV4-ADDRESS__
37708   /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}:
37709     get:
37710       tags:
37711         - Network
37712       summary: returns l3-interface-ipv4-address-list
37713       description: returns l3-interface-ipv4-address-list
37714       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37715       produces:
37716         - application/json
37717         - application/xml
37718       responses:
37719         "200":
37720           description: successful operation
37721           schema:
37722               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37723         "default":
37724           description: Response codes found in [response codes](https://wiki.onap.org/).
37725       parameters:
37726         - name: pnf-name
37727           in: path
37728           description: unique name of Physical Network Function.
37729           required: true
37730           type: string
37731           example: __PNF-NAME__
37732         - name: interface-name
37733           in: path
37734           description: Name that identifies the link aggregate interface
37735           required: true
37736           type: string
37737           example: __INTERFACE-NAME__
37738         - name: interface-name
37739           in: path
37740           description: Name given to the interface
37741           required: true
37742           type: string
37743           example: __INTERFACE-NAME__
37744         - name: vlan-interface
37745           in: path
37746           description: String that identifies the interface
37747           required: true
37748           type: string
37749           example: __VLAN-INTERFACE__
37750         - name: l3-interface-ipv4-address
37751           in: path
37752           description: IP address
37753           required: true
37754           type: string
37755           example: __L3-INTERFACE-IPV4-ADDRESS__
37756     put:
37757       tags:
37758         - Network
37759       summary: create or update an existing l3-interface-ipv4-address-list
37760       description: |
37761         Create or update an existing l3-interface-ipv4-address-list.
37762         #
37763         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37764       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37765       consumes:
37766         - application/json
37767         - application/xml
37768       produces:
37769         - application/json
37770         - application/xml
37771       responses:
37772         "default":
37773           description: Response codes found in [response codes](https://wiki.onap.org/).
37774       parameters:
37775         - name: pnf-name
37776           in: path
37777           description: unique name of Physical Network Function.
37778           required: true
37779           type: string
37780           example: __PNF-NAME__
37781         - name: interface-name
37782           in: path
37783           description: Name that identifies the link aggregate interface
37784           required: true
37785           type: string
37786           example: __INTERFACE-NAME__
37787         - name: interface-name
37788           in: path
37789           description: Name given to the interface
37790           required: true
37791           type: string
37792           example: __INTERFACE-NAME__
37793         - name: vlan-interface
37794           in: path
37795           description: String that identifies the interface
37796           required: true
37797           type: string
37798           example: __VLAN-INTERFACE__
37799         - name: l3-interface-ipv4-address
37800           in: path
37801           description: IP address
37802           required: true
37803           type: string
37804           example: __L3-INTERFACE-IPV4-ADDRESS__
37805         - name: body
37806           in: body
37807           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37808           required: true
37809           schema:
37810             $ref: "#/definitions/l3-interface-ipv4-address-list"
37811     patch:
37812       tags:
37813         - Network
37814       summary: update an existing l3-interface-ipv4-address-list
37815       description: |
37816         Update an existing l3-interface-ipv4-address-list
37817         #
37818         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37819         The PUT operation will entirely replace an existing object.
37820         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37821         #
37822         Other differences between PUT and PATCH are:
37823         #
37824         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37825         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37826         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37827       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37828       consumes:
37829         - application/json
37830         - application/xml
37831       produces:
37832         - application/json
37833         - application/xml
37834       responses:
37835         "default":
37836           description: Response codes found in [response codes](https://wiki.onap.org/).
37837       parameters:
37838         - name: pnf-name
37839           in: path
37840           description: unique name of Physical Network Function.
37841           required: true
37842           type: string
37843           example: __PNF-NAME__
37844         - name: interface-name
37845           in: path
37846           description: Name that identifies the link aggregate interface
37847           required: true
37848           type: string
37849           example: __INTERFACE-NAME__
37850         - name: interface-name
37851           in: path
37852           description: Name given to the interface
37853           required: true
37854           type: string
37855           example: __INTERFACE-NAME__
37856         - name: vlan-interface
37857           in: path
37858           description: String that identifies the interface
37859           required: true
37860           type: string
37861           example: __VLAN-INTERFACE__
37862         - name: l3-interface-ipv4-address
37863           in: path
37864           description: IP address
37865           required: true
37866           type: string
37867           example: __L3-INTERFACE-IPV4-ADDRESS__
37868         - name: body
37869           in: body
37870           description: l3-interface-ipv4-address-list object that needs to be updated.
37871           required: true
37872           schema:
37873             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37874     delete:
37875       tags:
37876         - Network
37877       summary: delete an existing l3-interface-ipv4-address-list
37878       description: delete an existing l3-interface-ipv4-address-list
37879       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37880       consumes:
37881         - application/json
37882         - application/xml
37883       produces:
37884         - application/json
37885         - application/xml
37886       responses:
37887         "default":
37888           description: Response codes found in [response codes](https://wiki.onap.org/).
37889       parameters:
37890         - name: pnf-name
37891           in: path
37892           description: unique name of Physical Network Function.
37893           required: true
37894           type: string
37895           example: __PNF-NAME__
37896         - name: interface-name
37897           in: path
37898           description: Name that identifies the link aggregate interface
37899           required: true
37900           type: string
37901           example: __INTERFACE-NAME__
37902         - name: interface-name
37903           in: path
37904           description: Name given to the interface
37905           required: true
37906           type: string
37907           example: __INTERFACE-NAME__
37908         - name: vlan-interface
37909           in: path
37910           description: String that identifies the interface
37911           required: true
37912           type: string
37913           example: __VLAN-INTERFACE__
37914         - name: l3-interface-ipv4-address
37915           in: path
37916           description: IP address
37917           required: true
37918           type: string
37919           example: __L3-INTERFACE-IPV4-ADDRESS__
37920         - name: resource-version
37921           in: query
37922           description: resource-version for concurrency
37923           required: true
37924           type: string
37925   /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:
37926     put:
37927       tags:
37928         - Network
37929       summary: see node definition for valid relationships
37930       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37931       consumes:
37932         - application/json
37933         - application/xml
37934       produces:
37935         - application/json
37936         - application/xml
37937       responses:
37938         "default":
37939           description: Response codes found in [response codes](https://wiki.onap.org/).
37940       parameters:
37941         - name: pnf-name
37942           in: path
37943           description: unique name of Physical Network Function.
37944           required: true
37945           type: string
37946           example: __PNF-NAME__
37947         - name: interface-name
37948           in: path
37949           description: Name that identifies the link aggregate interface
37950           required: true
37951           type: string
37952           example: __INTERFACE-NAME__
37953         - name: interface-name
37954           in: path
37955           description: Name given to the interface
37956           required: true
37957           type: string
37958           example: __INTERFACE-NAME__
37959         - name: vlan-interface
37960           in: path
37961           description: String that identifies the interface
37962           required: true
37963           type: string
37964           example: __VLAN-INTERFACE__
37965         - name: l3-interface-ipv6-address
37966           in: path
37967           description: IP address
37968           required: true
37969           type: string
37970           example: __L3-INTERFACE-IPV6-ADDRESS__
37971         - name: body
37972           in: body
37973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37974           required: true
37975           schema:
37976             $ref: "#/definitions/relationship"
37977     delete:
37978       tags:
37979         - Network
37980       summary: delete an existing relationship
37981       description: delete an existing relationship
37982       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37983       consumes:
37984         - application/json
37985         - application/xml
37986       produces:
37987         - application/json
37988         - application/xml
37989       responses:
37990         "default":
37991           description: Response codes found in [response codes](https://wiki.onap.org/).
37992       parameters:
37993         - name: pnf-name
37994           in: path
37995           description: unique name of Physical Network Function.
37996           required: true
37997           type: string
37998           example: __PNF-NAME__
37999         - name: interface-name
38000           in: path
38001           description: Name that identifies the link aggregate interface
38002           required: true
38003           type: string
38004           example: __INTERFACE-NAME__
38005         - name: interface-name
38006           in: path
38007           description: Name given to the interface
38008           required: true
38009           type: string
38010           example: __INTERFACE-NAME__
38011         - name: vlan-interface
38012           in: path
38013           description: String that identifies the interface
38014           required: true
38015           type: string
38016           example: __VLAN-INTERFACE__
38017         - name: l3-interface-ipv6-address
38018           in: path
38019           description: IP address
38020           required: true
38021           type: string
38022           example: __L3-INTERFACE-IPV6-ADDRESS__
38023   /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}:
38024     get:
38025       tags:
38026         - Network
38027       summary: returns l3-interface-ipv6-address-list
38028       description: returns l3-interface-ipv6-address-list
38029       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38030       produces:
38031         - application/json
38032         - application/xml
38033       responses:
38034         "200":
38035           description: successful operation
38036           schema:
38037               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38038         "default":
38039           description: Response codes found in [response codes](https://wiki.onap.org/).
38040       parameters:
38041         - name: pnf-name
38042           in: path
38043           description: unique name of Physical Network Function.
38044           required: true
38045           type: string
38046           example: __PNF-NAME__
38047         - name: interface-name
38048           in: path
38049           description: Name that identifies the link aggregate interface
38050           required: true
38051           type: string
38052           example: __INTERFACE-NAME__
38053         - name: interface-name
38054           in: path
38055           description: Name given to the interface
38056           required: true
38057           type: string
38058           example: __INTERFACE-NAME__
38059         - name: vlan-interface
38060           in: path
38061           description: String that identifies the interface
38062           required: true
38063           type: string
38064           example: __VLAN-INTERFACE__
38065         - name: l3-interface-ipv6-address
38066           in: path
38067           description: IP address
38068           required: true
38069           type: string
38070           example: __L3-INTERFACE-IPV6-ADDRESS__
38071     put:
38072       tags:
38073         - Network
38074       summary: create or update an existing l3-interface-ipv6-address-list
38075       description: |
38076         Create or update an existing l3-interface-ipv6-address-list.
38077         #
38078         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38079       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38080       consumes:
38081         - application/json
38082         - application/xml
38083       produces:
38084         - application/json
38085         - application/xml
38086       responses:
38087         "default":
38088           description: Response codes found in [response codes](https://wiki.onap.org/).
38089       parameters:
38090         - name: pnf-name
38091           in: path
38092           description: unique name of Physical Network Function.
38093           required: true
38094           type: string
38095           example: __PNF-NAME__
38096         - name: interface-name
38097           in: path
38098           description: Name that identifies the link aggregate interface
38099           required: true
38100           type: string
38101           example: __INTERFACE-NAME__
38102         - name: interface-name
38103           in: path
38104           description: Name given to the interface
38105           required: true
38106           type: string
38107           example: __INTERFACE-NAME__
38108         - name: vlan-interface
38109           in: path
38110           description: String that identifies the interface
38111           required: true
38112           type: string
38113           example: __VLAN-INTERFACE__
38114         - name: l3-interface-ipv6-address
38115           in: path
38116           description: IP address
38117           required: true
38118           type: string
38119           example: __L3-INTERFACE-IPV6-ADDRESS__
38120         - name: body
38121           in: body
38122           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38123           required: true
38124           schema:
38125             $ref: "#/definitions/l3-interface-ipv6-address-list"
38126     patch:
38127       tags:
38128         - Network
38129       summary: update an existing l3-interface-ipv6-address-list
38130       description: |
38131         Update an existing l3-interface-ipv6-address-list
38132         #
38133         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38134         The PUT operation will entirely replace an existing object.
38135         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38136         #
38137         Other differences between PUT and PATCH are:
38138         #
38139         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38140         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38141         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38142       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38143       consumes:
38144         - application/json
38145         - application/xml
38146       produces:
38147         - application/json
38148         - application/xml
38149       responses:
38150         "default":
38151           description: Response codes found in [response codes](https://wiki.onap.org/).
38152       parameters:
38153         - name: pnf-name
38154           in: path
38155           description: unique name of Physical Network Function.
38156           required: true
38157           type: string
38158           example: __PNF-NAME__
38159         - name: interface-name
38160           in: path
38161           description: Name that identifies the link aggregate interface
38162           required: true
38163           type: string
38164           example: __INTERFACE-NAME__
38165         - name: interface-name
38166           in: path
38167           description: Name given to the interface
38168           required: true
38169           type: string
38170           example: __INTERFACE-NAME__
38171         - name: vlan-interface
38172           in: path
38173           description: String that identifies the interface
38174           required: true
38175           type: string
38176           example: __VLAN-INTERFACE__
38177         - name: l3-interface-ipv6-address
38178           in: path
38179           description: IP address
38180           required: true
38181           type: string
38182           example: __L3-INTERFACE-IPV6-ADDRESS__
38183         - name: body
38184           in: body
38185           description: l3-interface-ipv6-address-list object that needs to be updated.
38186           required: true
38187           schema:
38188             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38189     delete:
38190       tags:
38191         - Network
38192       summary: delete an existing l3-interface-ipv6-address-list
38193       description: delete an existing l3-interface-ipv6-address-list
38194       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38195       consumes:
38196         - application/json
38197         - application/xml
38198       produces:
38199         - application/json
38200         - application/xml
38201       responses:
38202         "default":
38203           description: Response codes found in [response codes](https://wiki.onap.org/).
38204       parameters:
38205         - name: pnf-name
38206           in: path
38207           description: unique name of Physical Network Function.
38208           required: true
38209           type: string
38210           example: __PNF-NAME__
38211         - name: interface-name
38212           in: path
38213           description: Name that identifies the link aggregate interface
38214           required: true
38215           type: string
38216           example: __INTERFACE-NAME__
38217         - name: interface-name
38218           in: path
38219           description: Name given to the interface
38220           required: true
38221           type: string
38222           example: __INTERFACE-NAME__
38223         - name: vlan-interface
38224           in: path
38225           description: String that identifies the interface
38226           required: true
38227           type: string
38228           example: __VLAN-INTERFACE__
38229         - name: l3-interface-ipv6-address
38230           in: path
38231           description: IP address
38232           required: true
38233           type: string
38234           example: __L3-INTERFACE-IPV6-ADDRESS__
38235         - name: resource-version
38236           in: query
38237           description: resource-version for concurrency
38238           required: true
38239           type: string
38240   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38241     get:
38242       tags:
38243         - Network
38244       summary: returns vlan
38245       description: returns vlan
38246       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38247       produces:
38248         - application/json
38249         - application/xml
38250       responses:
38251         "200":
38252           description: successful operation
38253           schema:
38254               $ref: "#/getDefinitions/vlan"
38255         "default":
38256           description: Response codes found in [response codes](https://wiki.onap.org/).
38257       parameters:
38258         - name: pnf-name
38259           in: path
38260           description: unique name of Physical Network Function.
38261           required: true
38262           type: string
38263           example: __PNF-NAME__
38264         - name: interface-name
38265           in: path
38266           description: Name that identifies the link aggregate interface
38267           required: true
38268           type: string
38269           example: __INTERFACE-NAME__
38270         - name: interface-name
38271           in: path
38272           description: Name given to the interface
38273           required: true
38274           type: string
38275           example: __INTERFACE-NAME__
38276         - name: vlan-interface
38277           in: path
38278           description: String that identifies the interface
38279           required: true
38280           type: string
38281           example: __VLAN-INTERFACE__
38282     put:
38283       tags:
38284         - Network
38285       summary: create or update an existing vlan
38286       description: |
38287         Create or update an existing vlan.
38288         #
38289         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38290       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38291       consumes:
38292         - application/json
38293         - application/xml
38294       produces:
38295         - application/json
38296         - application/xml
38297       responses:
38298         "default":
38299           description: Response codes found in [response codes](https://wiki.onap.org/).
38300       parameters:
38301         - name: pnf-name
38302           in: path
38303           description: unique name of Physical Network Function.
38304           required: true
38305           type: string
38306           example: __PNF-NAME__
38307         - name: interface-name
38308           in: path
38309           description: Name that identifies the link aggregate interface
38310           required: true
38311           type: string
38312           example: __INTERFACE-NAME__
38313         - name: interface-name
38314           in: path
38315           description: Name given to the interface
38316           required: true
38317           type: string
38318           example: __INTERFACE-NAME__
38319         - name: vlan-interface
38320           in: path
38321           description: String that identifies the interface
38322           required: true
38323           type: string
38324           example: __VLAN-INTERFACE__
38325         - name: body
38326           in: body
38327           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38328           required: true
38329           schema:
38330             $ref: "#/definitions/vlan"
38331     patch:
38332       tags:
38333         - Network
38334       summary: update an existing vlan
38335       description: |
38336         Update an existing vlan
38337         #
38338         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38339         The PUT operation will entirely replace an existing object.
38340         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38341         #
38342         Other differences between PUT and PATCH are:
38343         #
38344         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38345         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38346         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38347       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38348       consumes:
38349         - application/json
38350         - application/xml
38351       produces:
38352         - application/json
38353         - application/xml
38354       responses:
38355         "default":
38356           description: Response codes found in [response codes](https://wiki.onap.org/).
38357       parameters:
38358         - name: pnf-name
38359           in: path
38360           description: unique name of Physical Network Function.
38361           required: true
38362           type: string
38363           example: __PNF-NAME__
38364         - name: interface-name
38365           in: path
38366           description: Name that identifies the link aggregate interface
38367           required: true
38368           type: string
38369           example: __INTERFACE-NAME__
38370         - name: interface-name
38371           in: path
38372           description: Name given to the interface
38373           required: true
38374           type: string
38375           example: __INTERFACE-NAME__
38376         - name: vlan-interface
38377           in: path
38378           description: String that identifies the interface
38379           required: true
38380           type: string
38381           example: __VLAN-INTERFACE__
38382         - name: body
38383           in: body
38384           description: vlan object that needs to be updated.
38385           required: true
38386           schema:
38387             $ref: "#/patchDefinitions/vlan"
38388     delete:
38389       tags:
38390         - Network
38391       summary: delete an existing vlan
38392       description: delete an existing vlan
38393       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38394       consumes:
38395         - application/json
38396         - application/xml
38397       produces:
38398         - application/json
38399         - application/xml
38400       responses:
38401         "default":
38402           description: Response codes found in [response codes](https://wiki.onap.org/).
38403       parameters:
38404         - name: pnf-name
38405           in: path
38406           description: unique name of Physical Network Function.
38407           required: true
38408           type: string
38409           example: __PNF-NAME__
38410         - name: interface-name
38411           in: path
38412           description: Name that identifies the link aggregate interface
38413           required: true
38414           type: string
38415           example: __INTERFACE-NAME__
38416         - name: interface-name
38417           in: path
38418           description: Name given to the interface
38419           required: true
38420           type: string
38421           example: __INTERFACE-NAME__
38422         - name: vlan-interface
38423           in: path
38424           description: String that identifies the interface
38425           required: true
38426           type: string
38427           example: __VLAN-INTERFACE__
38428         - name: resource-version
38429           in: query
38430           description: resource-version for concurrency
38431           required: true
38432           type: string
38433   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38434     get:
38435       tags:
38436         - Network
38437       summary: returns vlans
38438       description: returns vlans
38439       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38440       produces:
38441         - application/json
38442         - application/xml
38443       responses:
38444         "200":
38445           description: successful operation
38446           schema:
38447               $ref: "#/getDefinitions/vlans"
38448         "default":
38449           description: Response codes found in [response codes](https://wiki.onap.org/).
38450       parameters:
38451         - name: pnf-name
38452           in: path
38453           description: unique name of Physical Network Function.
38454           required: true
38455           type: string
38456           example: __PNF-NAME__
38457         - name: interface-name
38458           in: path
38459           description: Name that identifies the link aggregate interface
38460           required: true
38461           type: string
38462           example: __INTERFACE-NAME__
38463         - name: interface-name
38464           in: path
38465           description: Name given to the interface
38466           required: true
38467           type: string
38468           example: __INTERFACE-NAME__
38469         - name: vlan-interface
38470           in: query
38471           description:
38472           required: false
38473           type: string
38474         - name: vlan-id-inner
38475           in: query
38476           description:
38477           required: false
38478           type: integer
38479           format: int64
38480         - name: vpn-id
38481           in: query
38482           description:
38483           required: false
38484           type: string
38485   /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:
38486     put:
38487       tags:
38488         - Network
38489       summary: see node definition for valid relationships
38490       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38491       consumes:
38492         - application/json
38493         - application/xml
38494       produces:
38495         - application/json
38496         - application/xml
38497       responses:
38498         "default":
38499           description: Response codes found in [response codes](https://wiki.onap.org/).
38500       parameters:
38501         - name: pnf-name
38502           in: path
38503           description: unique name of Physical Network Function.
38504           required: true
38505           type: string
38506           example: __PNF-NAME__
38507         - name: interface-name
38508           in: path
38509           description: Name that identifies the link aggregate interface
38510           required: true
38511           type: string
38512           example: __INTERFACE-NAME__
38513         - name: interface-name
38514           in: path
38515           description: Name given to the interface
38516           required: true
38517           type: string
38518           example: __INTERFACE-NAME__
38519         - name: pci-id
38520           in: path
38521           description: PCI ID used to identify the sriov-vf
38522           required: true
38523           type: string
38524           example: __PCI-ID__
38525         - name: body
38526           in: body
38527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38528           required: true
38529           schema:
38530             $ref: "#/definitions/relationship"
38531     delete:
38532       tags:
38533         - Network
38534       summary: delete an existing relationship
38535       description: delete an existing relationship
38536       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38537       consumes:
38538         - application/json
38539         - application/xml
38540       produces:
38541         - application/json
38542         - application/xml
38543       responses:
38544         "default":
38545           description: Response codes found in [response codes](https://wiki.onap.org/).
38546       parameters:
38547         - name: pnf-name
38548           in: path
38549           description: unique name of Physical Network Function.
38550           required: true
38551           type: string
38552           example: __PNF-NAME__
38553         - name: interface-name
38554           in: path
38555           description: Name that identifies the link aggregate interface
38556           required: true
38557           type: string
38558           example: __INTERFACE-NAME__
38559         - name: interface-name
38560           in: path
38561           description: Name given to the interface
38562           required: true
38563           type: string
38564           example: __INTERFACE-NAME__
38565         - name: pci-id
38566           in: path
38567           description: PCI ID used to identify the sriov-vf
38568           required: true
38569           type: string
38570           example: __PCI-ID__
38571   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38572     get:
38573       tags:
38574         - Network
38575       summary: returns sriov-vf
38576       description: returns sriov-vf
38577       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38578       produces:
38579         - application/json
38580         - application/xml
38581       responses:
38582         "200":
38583           description: successful operation
38584           schema:
38585               $ref: "#/getDefinitions/sriov-vf"
38586         "default":
38587           description: Response codes found in [response codes](https://wiki.onap.org/).
38588       parameters:
38589         - name: pnf-name
38590           in: path
38591           description: unique name of Physical Network Function.
38592           required: true
38593           type: string
38594           example: __PNF-NAME__
38595         - name: interface-name
38596           in: path
38597           description: Name that identifies the link aggregate interface
38598           required: true
38599           type: string
38600           example: __INTERFACE-NAME__
38601         - name: interface-name
38602           in: path
38603           description: Name given to the interface
38604           required: true
38605           type: string
38606           example: __INTERFACE-NAME__
38607         - name: pci-id
38608           in: path
38609           description: PCI ID used to identify the sriov-vf
38610           required: true
38611           type: string
38612           example: __PCI-ID__
38613     put:
38614       tags:
38615         - Network
38616       summary: create or update an existing sriov-vf
38617       description: |
38618         Create or update an existing sriov-vf.
38619         #
38620         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38621       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38622       consumes:
38623         - application/json
38624         - application/xml
38625       produces:
38626         - application/json
38627         - application/xml
38628       responses:
38629         "default":
38630           description: Response codes found in [response codes](https://wiki.onap.org/).
38631       parameters:
38632         - name: pnf-name
38633           in: path
38634           description: unique name of Physical Network Function.
38635           required: true
38636           type: string
38637           example: __PNF-NAME__
38638         - name: interface-name
38639           in: path
38640           description: Name that identifies the link aggregate interface
38641           required: true
38642           type: string
38643           example: __INTERFACE-NAME__
38644         - name: interface-name
38645           in: path
38646           description: Name given to the interface
38647           required: true
38648           type: string
38649           example: __INTERFACE-NAME__
38650         - name: pci-id
38651           in: path
38652           description: PCI ID used to identify the sriov-vf
38653           required: true
38654           type: string
38655           example: __PCI-ID__
38656         - name: body
38657           in: body
38658           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38659           required: true
38660           schema:
38661             $ref: "#/definitions/sriov-vf"
38662     patch:
38663       tags:
38664         - Network
38665       summary: update an existing sriov-vf
38666       description: |
38667         Update an existing sriov-vf
38668         #
38669         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38670         The PUT operation will entirely replace an existing object.
38671         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38672         #
38673         Other differences between PUT and PATCH are:
38674         #
38675         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38676         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38677         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38678       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38679       consumes:
38680         - application/json
38681         - application/xml
38682       produces:
38683         - application/json
38684         - application/xml
38685       responses:
38686         "default":
38687           description: Response codes found in [response codes](https://wiki.onap.org/).
38688       parameters:
38689         - name: pnf-name
38690           in: path
38691           description: unique name of Physical Network Function.
38692           required: true
38693           type: string
38694           example: __PNF-NAME__
38695         - name: interface-name
38696           in: path
38697           description: Name that identifies the link aggregate interface
38698           required: true
38699           type: string
38700           example: __INTERFACE-NAME__
38701         - name: interface-name
38702           in: path
38703           description: Name given to the interface
38704           required: true
38705           type: string
38706           example: __INTERFACE-NAME__
38707         - name: pci-id
38708           in: path
38709           description: PCI ID used to identify the sriov-vf
38710           required: true
38711           type: string
38712           example: __PCI-ID__
38713         - name: body
38714           in: body
38715           description: sriov-vf object that needs to be updated.
38716           required: true
38717           schema:
38718             $ref: "#/patchDefinitions/sriov-vf"
38719     delete:
38720       tags:
38721         - Network
38722       summary: delete an existing sriov-vf
38723       description: delete an existing sriov-vf
38724       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38725       consumes:
38726         - application/json
38727         - application/xml
38728       produces:
38729         - application/json
38730         - application/xml
38731       responses:
38732         "default":
38733           description: Response codes found in [response codes](https://wiki.onap.org/).
38734       parameters:
38735         - name: pnf-name
38736           in: path
38737           description: unique name of Physical Network Function.
38738           required: true
38739           type: string
38740           example: __PNF-NAME__
38741         - name: interface-name
38742           in: path
38743           description: Name that identifies the link aggregate interface
38744           required: true
38745           type: string
38746           example: __INTERFACE-NAME__
38747         - name: interface-name
38748           in: path
38749           description: Name given to the interface
38750           required: true
38751           type: string
38752           example: __INTERFACE-NAME__
38753         - name: pci-id
38754           in: path
38755           description: PCI ID used to identify the sriov-vf
38756           required: true
38757           type: string
38758           example: __PCI-ID__
38759         - name: resource-version
38760           in: query
38761           description: resource-version for concurrency
38762           required: true
38763           type: string
38764   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38765     get:
38766       tags:
38767         - Network
38768       summary: returns sriov-vfs
38769       description: returns sriov-vfs
38770       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38771       produces:
38772         - application/json
38773         - application/xml
38774       responses:
38775         "200":
38776           description: successful operation
38777           schema:
38778               $ref: "#/getDefinitions/sriov-vfs"
38779         "default":
38780           description: Response codes found in [response codes](https://wiki.onap.org/).
38781       parameters:
38782         - name: pnf-name
38783           in: path
38784           description: unique name of Physical Network Function.
38785           required: true
38786           type: string
38787           example: __PNF-NAME__
38788         - name: interface-name
38789           in: path
38790           description: Name that identifies the link aggregate interface
38791           required: true
38792           type: string
38793           example: __INTERFACE-NAME__
38794         - name: interface-name
38795           in: path
38796           description: Name given to the interface
38797           required: true
38798           type: string
38799           example: __INTERFACE-NAME__
38800         - name: pci-id
38801           in: query
38802           description:
38803           required: false
38804           type: string
38805         - name: vf-vlan-filter
38806           in: query
38807           description:
38808           required: false
38809           type: string
38810         - name: vf-mac-filter
38811           in: query
38812           description:
38813           required: false
38814           type: string
38815         - name: vf-vlan-strip
38816           in: query
38817           description:
38818           required: false
38819           type: boolean
38820         - name: neutron-network-id
38821           in: query
38822           description:
38823           required: false
38824           type: string
38825   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38826     put:
38827       tags:
38828         - Network
38829       summary: see node definition for valid relationships
38830       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38831       consumes:
38832         - application/json
38833         - application/xml
38834       produces:
38835         - application/json
38836         - application/xml
38837       responses:
38838         "default":
38839           description: Response codes found in [response codes](https://wiki.onap.org/).
38840       parameters:
38841         - name: pnf-name
38842           in: path
38843           description: unique name of Physical Network Function.
38844           required: true
38845           type: string
38846           example: __PNF-NAME__
38847         - name: interface-name
38848           in: path
38849           description: Name that identifies the link aggregate interface
38850           required: true
38851           type: string
38852           example: __INTERFACE-NAME__
38853         - name: interface-name
38854           in: path
38855           description: Name given to the interface
38856           required: true
38857           type: string
38858           example: __INTERFACE-NAME__
38859         - name: body
38860           in: body
38861           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
38862           required: true
38863           schema:
38864             $ref: "#/definitions/relationship"
38865     delete:
38866       tags:
38867         - Network
38868       summary: delete an existing relationship
38869       description: delete an existing relationship
38870       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38871       consumes:
38872         - application/json
38873         - application/xml
38874       produces:
38875         - application/json
38876         - application/xml
38877       responses:
38878         "default":
38879           description: Response codes found in [response codes](https://wiki.onap.org/).
38880       parameters:
38881         - name: pnf-name
38882           in: path
38883           description: unique name of Physical Network Function.
38884           required: true
38885           type: string
38886           example: __PNF-NAME__
38887         - name: interface-name
38888           in: path
38889           description: Name that identifies the link aggregate interface
38890           required: true
38891           type: string
38892           example: __INTERFACE-NAME__
38893         - name: interface-name
38894           in: path
38895           description: Name given to the interface
38896           required: true
38897           type: string
38898           example: __INTERFACE-NAME__
38899   /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:
38900     put:
38901       tags:
38902         - Network
38903       summary: see node definition for valid relationships
38904       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38905       consumes:
38906         - application/json
38907         - application/xml
38908       produces:
38909         - application/json
38910         - application/xml
38911       responses:
38912         "default":
38913           description: Response codes found in [response codes](https://wiki.onap.org/).
38914       parameters:
38915         - name: pnf-name
38916           in: path
38917           description: unique name of Physical Network Function.
38918           required: true
38919           type: string
38920           example: __PNF-NAME__
38921         - name: interface-name
38922           in: path
38923           description: Name that identifies the link aggregate interface
38924           required: true
38925           type: string
38926           example: __INTERFACE-NAME__
38927         - name: interface-name
38928           in: path
38929           description: Name given to the interface
38930           required: true
38931           type: string
38932           example: __INTERFACE-NAME__
38933         - name: l3-interface-ipv4-address
38934           in: path
38935           description: IP address
38936           required: true
38937           type: string
38938           example: __L3-INTERFACE-IPV4-ADDRESS__
38939         - name: body
38940           in: body
38941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38942           required: true
38943           schema:
38944             $ref: "#/definitions/relationship"
38945     delete:
38946       tags:
38947         - Network
38948       summary: delete an existing relationship
38949       description: delete an existing relationship
38950       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38951       consumes:
38952         - application/json
38953         - application/xml
38954       produces:
38955         - application/json
38956         - application/xml
38957       responses:
38958         "default":
38959           description: Response codes found in [response codes](https://wiki.onap.org/).
38960       parameters:
38961         - name: pnf-name
38962           in: path
38963           description: unique name of Physical Network Function.
38964           required: true
38965           type: string
38966           example: __PNF-NAME__
38967         - name: interface-name
38968           in: path
38969           description: Name that identifies the link aggregate interface
38970           required: true
38971           type: string
38972           example: __INTERFACE-NAME__
38973         - name: interface-name
38974           in: path
38975           description: Name given to the interface
38976           required: true
38977           type: string
38978           example: __INTERFACE-NAME__
38979         - name: l3-interface-ipv4-address
38980           in: path
38981           description: IP address
38982           required: true
38983           type: string
38984           example: __L3-INTERFACE-IPV4-ADDRESS__
38985   /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}:
38986     get:
38987       tags:
38988         - Network
38989       summary: returns l3-interface-ipv4-address-list
38990       description: returns l3-interface-ipv4-address-list
38991       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38992       produces:
38993         - application/json
38994         - application/xml
38995       responses:
38996         "200":
38997           description: successful operation
38998           schema:
38999               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39000         "default":
39001           description: Response codes found in [response codes](https://wiki.onap.org/).
39002       parameters:
39003         - name: pnf-name
39004           in: path
39005           description: unique name of Physical Network Function.
39006           required: true
39007           type: string
39008           example: __PNF-NAME__
39009         - name: interface-name
39010           in: path
39011           description: Name that identifies the link aggregate interface
39012           required: true
39013           type: string
39014           example: __INTERFACE-NAME__
39015         - name: interface-name
39016           in: path
39017           description: Name given to the interface
39018           required: true
39019           type: string
39020           example: __INTERFACE-NAME__
39021         - name: l3-interface-ipv4-address
39022           in: path
39023           description: IP address
39024           required: true
39025           type: string
39026           example: __L3-INTERFACE-IPV4-ADDRESS__
39027     put:
39028       tags:
39029         - Network
39030       summary: create or update an existing l3-interface-ipv4-address-list
39031       description: |
39032         Create or update an existing l3-interface-ipv4-address-list.
39033         #
39034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39035       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39036       consumes:
39037         - application/json
39038         - application/xml
39039       produces:
39040         - application/json
39041         - application/xml
39042       responses:
39043         "default":
39044           description: Response codes found in [response codes](https://wiki.onap.org/).
39045       parameters:
39046         - name: pnf-name
39047           in: path
39048           description: unique name of Physical Network Function.
39049           required: true
39050           type: string
39051           example: __PNF-NAME__
39052         - name: interface-name
39053           in: path
39054           description: Name that identifies the link aggregate interface
39055           required: true
39056           type: string
39057           example: __INTERFACE-NAME__
39058         - name: interface-name
39059           in: path
39060           description: Name given to the interface
39061           required: true
39062           type: string
39063           example: __INTERFACE-NAME__
39064         - name: l3-interface-ipv4-address
39065           in: path
39066           description: IP address
39067           required: true
39068           type: string
39069           example: __L3-INTERFACE-IPV4-ADDRESS__
39070         - name: body
39071           in: body
39072           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39073           required: true
39074           schema:
39075             $ref: "#/definitions/l3-interface-ipv4-address-list"
39076     patch:
39077       tags:
39078         - Network
39079       summary: update an existing l3-interface-ipv4-address-list
39080       description: |
39081         Update an existing l3-interface-ipv4-address-list
39082         #
39083         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39084         The PUT operation will entirely replace an existing object.
39085         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39086         #
39087         Other differences between PUT and PATCH are:
39088         #
39089         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39090         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39091         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39092       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39093       consumes:
39094         - application/json
39095         - application/xml
39096       produces:
39097         - application/json
39098         - application/xml
39099       responses:
39100         "default":
39101           description: Response codes found in [response codes](https://wiki.onap.org/).
39102       parameters:
39103         - name: pnf-name
39104           in: path
39105           description: unique name of Physical Network Function.
39106           required: true
39107           type: string
39108           example: __PNF-NAME__
39109         - name: interface-name
39110           in: path
39111           description: Name that identifies the link aggregate interface
39112           required: true
39113           type: string
39114           example: __INTERFACE-NAME__
39115         - name: interface-name
39116           in: path
39117           description: Name given to the interface
39118           required: true
39119           type: string
39120           example: __INTERFACE-NAME__
39121         - name: l3-interface-ipv4-address
39122           in: path
39123           description: IP address
39124           required: true
39125           type: string
39126           example: __L3-INTERFACE-IPV4-ADDRESS__
39127         - name: body
39128           in: body
39129           description: l3-interface-ipv4-address-list object that needs to be updated.
39130           required: true
39131           schema:
39132             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39133     delete:
39134       tags:
39135         - Network
39136       summary: delete an existing l3-interface-ipv4-address-list
39137       description: delete an existing l3-interface-ipv4-address-list
39138       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39139       consumes:
39140         - application/json
39141         - application/xml
39142       produces:
39143         - application/json
39144         - application/xml
39145       responses:
39146         "default":
39147           description: Response codes found in [response codes](https://wiki.onap.org/).
39148       parameters:
39149         - name: pnf-name
39150           in: path
39151           description: unique name of Physical Network Function.
39152           required: true
39153           type: string
39154           example: __PNF-NAME__
39155         - name: interface-name
39156           in: path
39157           description: Name that identifies the link aggregate interface
39158           required: true
39159           type: string
39160           example: __INTERFACE-NAME__
39161         - name: interface-name
39162           in: path
39163           description: Name given to the interface
39164           required: true
39165           type: string
39166           example: __INTERFACE-NAME__
39167         - name: l3-interface-ipv4-address
39168           in: path
39169           description: IP address
39170           required: true
39171           type: string
39172           example: __L3-INTERFACE-IPV4-ADDRESS__
39173         - name: resource-version
39174           in: query
39175           description: resource-version for concurrency
39176           required: true
39177           type: string
39178   /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:
39179     put:
39180       tags:
39181         - Network
39182       summary: see node definition for valid relationships
39183       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39184       consumes:
39185         - application/json
39186         - application/xml
39187       produces:
39188         - application/json
39189         - application/xml
39190       responses:
39191         "default":
39192           description: Response codes found in [response codes](https://wiki.onap.org/).
39193       parameters:
39194         - name: pnf-name
39195           in: path
39196           description: unique name of Physical Network Function.
39197           required: true
39198           type: string
39199           example: __PNF-NAME__
39200         - name: interface-name
39201           in: path
39202           description: Name that identifies the link aggregate interface
39203           required: true
39204           type: string
39205           example: __INTERFACE-NAME__
39206         - name: interface-name
39207           in: path
39208           description: Name given to the interface
39209           required: true
39210           type: string
39211           example: __INTERFACE-NAME__
39212         - name: l3-interface-ipv6-address
39213           in: path
39214           description: IP address
39215           required: true
39216           type: string
39217           example: __L3-INTERFACE-IPV6-ADDRESS__
39218         - name: body
39219           in: body
39220           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39221           required: true
39222           schema:
39223             $ref: "#/definitions/relationship"
39224     delete:
39225       tags:
39226         - Network
39227       summary: delete an existing relationship
39228       description: delete an existing relationship
39229       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39230       consumes:
39231         - application/json
39232         - application/xml
39233       produces:
39234         - application/json
39235         - application/xml
39236       responses:
39237         "default":
39238           description: Response codes found in [response codes](https://wiki.onap.org/).
39239       parameters:
39240         - name: pnf-name
39241           in: path
39242           description: unique name of Physical Network Function.
39243           required: true
39244           type: string
39245           example: __PNF-NAME__
39246         - name: interface-name
39247           in: path
39248           description: Name that identifies the link aggregate interface
39249           required: true
39250           type: string
39251           example: __INTERFACE-NAME__
39252         - name: interface-name
39253           in: path
39254           description: Name given to the interface
39255           required: true
39256           type: string
39257           example: __INTERFACE-NAME__
39258         - name: l3-interface-ipv6-address
39259           in: path
39260           description: IP address
39261           required: true
39262           type: string
39263           example: __L3-INTERFACE-IPV6-ADDRESS__
39264   /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}:
39265     get:
39266       tags:
39267         - Network
39268       summary: returns l3-interface-ipv6-address-list
39269       description: returns l3-interface-ipv6-address-list
39270       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39271       produces:
39272         - application/json
39273         - application/xml
39274       responses:
39275         "200":
39276           description: successful operation
39277           schema:
39278               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39279         "default":
39280           description: Response codes found in [response codes](https://wiki.onap.org/).
39281       parameters:
39282         - name: pnf-name
39283           in: path
39284           description: unique name of Physical Network Function.
39285           required: true
39286           type: string
39287           example: __PNF-NAME__
39288         - name: interface-name
39289           in: path
39290           description: Name that identifies the link aggregate interface
39291           required: true
39292           type: string
39293           example: __INTERFACE-NAME__
39294         - name: interface-name
39295           in: path
39296           description: Name given to the interface
39297           required: true
39298           type: string
39299           example: __INTERFACE-NAME__
39300         - name: l3-interface-ipv6-address
39301           in: path
39302           description: IP address
39303           required: true
39304           type: string
39305           example: __L3-INTERFACE-IPV6-ADDRESS__
39306     put:
39307       tags:
39308         - Network
39309       summary: create or update an existing l3-interface-ipv6-address-list
39310       description: |
39311         Create or update an existing l3-interface-ipv6-address-list.
39312         #
39313         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39314       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39315       consumes:
39316         - application/json
39317         - application/xml
39318       produces:
39319         - application/json
39320         - application/xml
39321       responses:
39322         "default":
39323           description: Response codes found in [response codes](https://wiki.onap.org/).
39324       parameters:
39325         - name: pnf-name
39326           in: path
39327           description: unique name of Physical Network Function.
39328           required: true
39329           type: string
39330           example: __PNF-NAME__
39331         - name: interface-name
39332           in: path
39333           description: Name that identifies the link aggregate interface
39334           required: true
39335           type: string
39336           example: __INTERFACE-NAME__
39337         - name: interface-name
39338           in: path
39339           description: Name given to the interface
39340           required: true
39341           type: string
39342           example: __INTERFACE-NAME__
39343         - name: l3-interface-ipv6-address
39344           in: path
39345           description: IP address
39346           required: true
39347           type: string
39348           example: __L3-INTERFACE-IPV6-ADDRESS__
39349         - name: body
39350           in: body
39351           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39352           required: true
39353           schema:
39354             $ref: "#/definitions/l3-interface-ipv6-address-list"
39355     patch:
39356       tags:
39357         - Network
39358       summary: update an existing l3-interface-ipv6-address-list
39359       description: |
39360         Update an existing l3-interface-ipv6-address-list
39361         #
39362         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39363         The PUT operation will entirely replace an existing object.
39364         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39365         #
39366         Other differences between PUT and PATCH are:
39367         #
39368         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39369         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39370         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39371       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39372       consumes:
39373         - application/json
39374         - application/xml
39375       produces:
39376         - application/json
39377         - application/xml
39378       responses:
39379         "default":
39380           description: Response codes found in [response codes](https://wiki.onap.org/).
39381       parameters:
39382         - name: pnf-name
39383           in: path
39384           description: unique name of Physical Network Function.
39385           required: true
39386           type: string
39387           example: __PNF-NAME__
39388         - name: interface-name
39389           in: path
39390           description: Name that identifies the link aggregate interface
39391           required: true
39392           type: string
39393           example: __INTERFACE-NAME__
39394         - name: interface-name
39395           in: path
39396           description: Name given to the interface
39397           required: true
39398           type: string
39399           example: __INTERFACE-NAME__
39400         - name: l3-interface-ipv6-address
39401           in: path
39402           description: IP address
39403           required: true
39404           type: string
39405           example: __L3-INTERFACE-IPV6-ADDRESS__
39406         - name: body
39407           in: body
39408           description: l3-interface-ipv6-address-list object that needs to be updated.
39409           required: true
39410           schema:
39411             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39412     delete:
39413       tags:
39414         - Network
39415       summary: delete an existing l3-interface-ipv6-address-list
39416       description: delete an existing l3-interface-ipv6-address-list
39417       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39418       consumes:
39419         - application/json
39420         - application/xml
39421       produces:
39422         - application/json
39423         - application/xml
39424       responses:
39425         "default":
39426           description: Response codes found in [response codes](https://wiki.onap.org/).
39427       parameters:
39428         - name: pnf-name
39429           in: path
39430           description: unique name of Physical Network Function.
39431           required: true
39432           type: string
39433           example: __PNF-NAME__
39434         - name: interface-name
39435           in: path
39436           description: Name that identifies the link aggregate interface
39437           required: true
39438           type: string
39439           example: __INTERFACE-NAME__
39440         - name: interface-name
39441           in: path
39442           description: Name given to the interface
39443           required: true
39444           type: string
39445           example: __INTERFACE-NAME__
39446         - name: l3-interface-ipv6-address
39447           in: path
39448           description: IP address
39449           required: true
39450           type: string
39451           example: __L3-INTERFACE-IPV6-ADDRESS__
39452         - name: resource-version
39453           in: query
39454           description: resource-version for concurrency
39455           required: true
39456           type: string
39457   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39458     get:
39459       tags:
39460         - Network
39461       summary: returns l-interface
39462       description: returns l-interface
39463       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39464       produces:
39465         - application/json
39466         - application/xml
39467       responses:
39468         "200":
39469           description: successful operation
39470           schema:
39471               $ref: "#/getDefinitions/l-interface"
39472         "default":
39473           description: Response codes found in [response codes](https://wiki.onap.org/).
39474       parameters:
39475         - name: pnf-name
39476           in: path
39477           description: unique name of Physical Network Function.
39478           required: true
39479           type: string
39480           example: __PNF-NAME__
39481         - name: interface-name
39482           in: path
39483           description: Name that identifies the link aggregate interface
39484           required: true
39485           type: string
39486           example: __INTERFACE-NAME__
39487         - name: interface-name
39488           in: path
39489           description: Name given to the interface
39490           required: true
39491           type: string
39492           example: __INTERFACE-NAME__
39493     put:
39494       tags:
39495         - Network
39496       summary: create or update an existing l-interface
39497       description: |
39498         Create or update an existing l-interface.
39499         #
39500         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39501       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39502       consumes:
39503         - application/json
39504         - application/xml
39505       produces:
39506         - application/json
39507         - application/xml
39508       responses:
39509         "default":
39510           description: Response codes found in [response codes](https://wiki.onap.org/).
39511       parameters:
39512         - name: pnf-name
39513           in: path
39514           description: unique name of Physical Network Function.
39515           required: true
39516           type: string
39517           example: __PNF-NAME__
39518         - name: interface-name
39519           in: path
39520           description: Name that identifies the link aggregate interface
39521           required: true
39522           type: string
39523           example: __INTERFACE-NAME__
39524         - name: interface-name
39525           in: path
39526           description: Name given to the interface
39527           required: true
39528           type: string
39529           example: __INTERFACE-NAME__
39530         - name: body
39531           in: body
39532           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39533           required: true
39534           schema:
39535             $ref: "#/definitions/l-interface"
39536     patch:
39537       tags:
39538         - Network
39539       summary: update an existing l-interface
39540       description: |
39541         Update an existing l-interface
39542         #
39543         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39544         The PUT operation will entirely replace an existing object.
39545         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39546         #
39547         Other differences between PUT and PATCH are:
39548         #
39549         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39550         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39551         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39552       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39553       consumes:
39554         - application/json
39555         - application/xml
39556       produces:
39557         - application/json
39558         - application/xml
39559       responses:
39560         "default":
39561           description: Response codes found in [response codes](https://wiki.onap.org/).
39562       parameters:
39563         - name: pnf-name
39564           in: path
39565           description: unique name of Physical Network Function.
39566           required: true
39567           type: string
39568           example: __PNF-NAME__
39569         - name: interface-name
39570           in: path
39571           description: Name that identifies the link aggregate interface
39572           required: true
39573           type: string
39574           example: __INTERFACE-NAME__
39575         - name: interface-name
39576           in: path
39577           description: Name given to the interface
39578           required: true
39579           type: string
39580           example: __INTERFACE-NAME__
39581         - name: body
39582           in: body
39583           description: l-interface object that needs to be updated.
39584           required: true
39585           schema:
39586             $ref: "#/patchDefinitions/l-interface"
39587     delete:
39588       tags:
39589         - Network
39590       summary: delete an existing l-interface
39591       description: delete an existing l-interface
39592       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39593       consumes:
39594         - application/json
39595         - application/xml
39596       produces:
39597         - application/json
39598         - application/xml
39599       responses:
39600         "default":
39601           description: Response codes found in [response codes](https://wiki.onap.org/).
39602       parameters:
39603         - name: pnf-name
39604           in: path
39605           description: unique name of Physical Network Function.
39606           required: true
39607           type: string
39608           example: __PNF-NAME__
39609         - name: interface-name
39610           in: path
39611           description: Name that identifies the link aggregate interface
39612           required: true
39613           type: string
39614           example: __INTERFACE-NAME__
39615         - name: interface-name
39616           in: path
39617           description: Name given to the interface
39618           required: true
39619           type: string
39620           example: __INTERFACE-NAME__
39621         - name: resource-version
39622           in: query
39623           description: resource-version for concurrency
39624           required: true
39625           type: string
39626   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
39627     get:
39628       tags:
39629         - Network
39630       summary: returns l-interfaces
39631       description: returns l-interfaces
39632       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
39633       produces:
39634         - application/json
39635         - application/xml
39636       responses:
39637         "200":
39638           description: successful operation
39639           schema:
39640               $ref: "#/getDefinitions/l-interfaces"
39641         "default":
39642           description: Response codes found in [response codes](https://wiki.onap.org/).
39643       parameters:
39644         - name: pnf-name
39645           in: path
39646           description: unique name of Physical Network Function.
39647           required: true
39648           type: string
39649           example: __PNF-NAME__
39650         - name: interface-name
39651           in: path
39652           description: Name that identifies the link aggregate interface
39653           required: true
39654           type: string
39655           example: __INTERFACE-NAME__
39656         - name: interface-name
39657           in: query
39658           description:
39659           required: false
39660           type: string
39661         - name: interface-id
39662           in: query
39663           description:
39664           required: false
39665           type: string
39666         - name: macaddr
39667           in: query
39668           description:
39669           required: false
39670           type: string
39671         - name: network-name
39672           in: query
39673           description:
39674           required: false
39675           type: string
39676   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
39677     get:
39678       tags:
39679         - Network
39680       summary: returns lag-interface
39681       description: returns lag-interface
39682       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
39683       produces:
39684         - application/json
39685         - application/xml
39686       responses:
39687         "200":
39688           description: successful operation
39689           schema:
39690               $ref: "#/getDefinitions/lag-interface"
39691         "default":
39692           description: Response codes found in [response codes](https://wiki.onap.org/).
39693       parameters:
39694         - name: pnf-name
39695           in: path
39696           description: unique name of Physical Network Function.
39697           required: true
39698           type: string
39699           example: __PNF-NAME__
39700         - name: interface-name
39701           in: path
39702           description: Name that identifies the link aggregate interface
39703           required: true
39704           type: string
39705           example: __INTERFACE-NAME__
39706     put:
39707       tags:
39708         - Network
39709       summary: create or update an existing lag-interface
39710       description: |
39711         Create or update an existing lag-interface.
39712         #
39713         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39714       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
39715       consumes:
39716         - application/json
39717         - application/xml
39718       produces:
39719         - application/json
39720         - application/xml
39721       responses:
39722         "default":
39723           description: Response codes found in [response codes](https://wiki.onap.org/).
39724       parameters:
39725         - name: pnf-name
39726           in: path
39727           description: unique name of Physical Network Function.
39728           required: true
39729           type: string
39730           example: __PNF-NAME__
39731         - name: interface-name
39732           in: path
39733           description: Name that identifies the link aggregate interface
39734           required: true
39735           type: string
39736           example: __INTERFACE-NAME__
39737         - name: body
39738           in: body
39739           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
39740           required: true
39741           schema:
39742             $ref: "#/definitions/lag-interface"
39743     patch:
39744       tags:
39745         - Network
39746       summary: update an existing lag-interface
39747       description: |
39748         Update an existing lag-interface
39749         #
39750         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39751         The PUT operation will entirely replace an existing object.
39752         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39753         #
39754         Other differences between PUT and PATCH are:
39755         #
39756         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39757         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39758         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39759       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
39760       consumes:
39761         - application/json
39762         - application/xml
39763       produces:
39764         - application/json
39765         - application/xml
39766       responses:
39767         "default":
39768           description: Response codes found in [response codes](https://wiki.onap.org/).
39769       parameters:
39770         - name: pnf-name
39771           in: path
39772           description: unique name of Physical Network Function.
39773           required: true
39774           type: string
39775           example: __PNF-NAME__
39776         - name: interface-name
39777           in: path
39778           description: Name that identifies the link aggregate interface
39779           required: true
39780           type: string
39781           example: __INTERFACE-NAME__
39782         - name: body
39783           in: body
39784           description: lag-interface object that needs to be updated.
39785           required: true
39786           schema:
39787             $ref: "#/patchDefinitions/lag-interface"
39788     delete:
39789       tags:
39790         - Network
39791       summary: delete an existing lag-interface
39792       description: delete an existing lag-interface
39793       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
39794       consumes:
39795         - application/json
39796         - application/xml
39797       produces:
39798         - application/json
39799         - application/xml
39800       responses:
39801         "default":
39802           description: Response codes found in [response codes](https://wiki.onap.org/).
39803       parameters:
39804         - name: pnf-name
39805           in: path
39806           description: unique name of Physical Network Function.
39807           required: true
39808           type: string
39809           example: __PNF-NAME__
39810         - name: interface-name
39811           in: path
39812           description: Name that identifies the link aggregate interface
39813           required: true
39814           type: string
39815           example: __INTERFACE-NAME__
39816         - name: resource-version
39817           in: query
39818           description: resource-version for concurrency
39819           required: true
39820           type: string
39821   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
39822     get:
39823       tags:
39824         - Network
39825       summary: returns lag-interfaces
39826       description: returns lag-interfaces
39827       operationId: getNetworkPnfsPnfLagInterfaces
39828       produces:
39829         - application/json
39830         - application/xml
39831       responses:
39832         "200":
39833           description: successful operation
39834           schema:
39835               $ref: "#/getDefinitions/lag-interfaces"
39836         "default":
39837           description: Response codes found in [response codes](https://wiki.onap.org/).
39838       parameters:
39839         - name: pnf-name
39840           in: path
39841           description: unique name of Physical Network Function.
39842           required: true
39843           type: string
39844           example: __PNF-NAME__
39845         - name: interface-name
39846           in: query
39847           description:
39848           required: false
39849           type: string
39850         - name: interface-id
39851           in: query
39852           description:
39853           required: false
39854           type: string
39855         - name: interface-role
39856           in: query
39857           description:
39858           required: false
39859           type: string
39860   /network/pnfs/pnf/{pnf-name}:
39861     get:
39862       tags:
39863         - Network
39864       summary: returns pnf
39865       description: returns pnf
39866       operationId: getNetworkPnfsPnf
39867       produces:
39868         - application/json
39869         - application/xml
39870       responses:
39871         "200":
39872           description: successful operation
39873           schema:
39874               $ref: "#/getDefinitions/pnf"
39875         "default":
39876           description: Response codes found in [response codes](https://wiki.onap.org/).
39877       parameters:
39878         - name: pnf-name
39879           in: path
39880           description: unique name of Physical Network Function.
39881           required: true
39882           type: string
39883           example: __PNF-NAME__
39884     put:
39885       tags:
39886         - Network
39887       summary: create or update an existing pnf
39888       description: |
39889         Create or update an existing pnf.
39890         #
39891         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39892       operationId: createOrUpdateNetworkPnfsPnf
39893       consumes:
39894         - application/json
39895         - application/xml
39896       produces:
39897         - application/json
39898         - application/xml
39899       responses:
39900         "default":
39901           description: Response codes found in [response codes](https://wiki.onap.org/).
39902       parameters:
39903         - name: pnf-name
39904           in: path
39905           description: unique name of Physical Network Function.
39906           required: true
39907           type: string
39908           example: __PNF-NAME__
39909         - name: body
39910           in: body
39911           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
39912           required: true
39913           schema:
39914             $ref: "#/definitions/pnf"
39915     patch:
39916       tags:
39917         - Network
39918       summary: update an existing pnf
39919       description: |
39920         Update an existing pnf
39921         #
39922         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39923         The PUT operation will entirely replace an existing object.
39924         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39925         #
39926         Other differences between PUT and PATCH are:
39927         #
39928         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39929         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39930         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39931       operationId: UpdateNetworkPnfsPnf
39932       consumes:
39933         - application/json
39934         - application/xml
39935       produces:
39936         - application/json
39937         - application/xml
39938       responses:
39939         "default":
39940           description: Response codes found in [response codes](https://wiki.onap.org/).
39941       parameters:
39942         - name: pnf-name
39943           in: path
39944           description: unique name of Physical Network Function.
39945           required: true
39946           type: string
39947           example: __PNF-NAME__
39948         - name: body
39949           in: body
39950           description: pnf object that needs to be updated.
39951           required: true
39952           schema:
39953             $ref: "#/patchDefinitions/pnf"
39954     delete:
39955       tags:
39956         - Network
39957       summary: delete an existing pnf
39958       description: delete an existing pnf
39959       operationId: deleteNetworkPnfsPnf
39960       consumes:
39961         - application/json
39962         - application/xml
39963       produces:
39964         - application/json
39965         - application/xml
39966       responses:
39967         "default":
39968           description: Response codes found in [response codes](https://wiki.onap.org/).
39969       parameters:
39970         - name: pnf-name
39971           in: path
39972           description: unique name of Physical Network Function.
39973           required: true
39974           type: string
39975           example: __PNF-NAME__
39976         - name: resource-version
39977           in: query
39978           description: resource-version for concurrency
39979           required: true
39980           type: string
39981   /network/pnfs:
39982     get:
39983       tags:
39984         - Network
39985       summary: returns pnfs
39986       description: returns pnfs
39987       operationId: getNetworkPnfs
39988       produces:
39989         - application/json
39990         - application/xml
39991       responses:
39992         "200":
39993           description: successful operation
39994           schema:
39995               $ref: "#/getDefinitions/pnfs"
39996         "default":
39997           description: Response codes found in [response codes](https://wiki.onap.org/).
39998       parameters:
39999         - name: pnf-name
40000           in: query
40001           description:
40002           required: false
40003           type: string
40004         - name: inv-status
40005           in: query
40006           description:
40007           required: false
40008           type: string
40009   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
40010     put:
40011       tags:
40012         - Network
40013       summary: see node definition for valid relationships
40014       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
40015       consumes:
40016         - application/json
40017         - application/xml
40018       produces:
40019         - application/json
40020         - application/xml
40021       responses:
40022         "default":
40023           description: Response codes found in [response codes](https://wiki.onap.org/).
40024       parameters:
40025         - name: link-name
40026           in: path
40027           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40028           required: true
40029           type: string
40030           example: __LINK-NAME__
40031         - name: body
40032           in: body
40033           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
40034           required: true
40035           schema:
40036             $ref: "#/definitions/relationship"
40037     delete:
40038       tags:
40039         - Network
40040       summary: delete an existing relationship
40041       description: delete an existing relationship
40042       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
40043       consumes:
40044         - application/json
40045         - application/xml
40046       produces:
40047         - application/json
40048         - application/xml
40049       responses:
40050         "default":
40051           description: Response codes found in [response codes](https://wiki.onap.org/).
40052       parameters:
40053         - name: link-name
40054           in: path
40055           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40056           required: true
40057           type: string
40058           example: __LINK-NAME__
40059   /network/physical-links/physical-link/{link-name}:
40060     get:
40061       tags:
40062         - Network
40063       summary: returns physical-link
40064       description: returns physical-link
40065       operationId: getNetworkPhysicalLinksPhysicalLink
40066       produces:
40067         - application/json
40068         - application/xml
40069       responses:
40070         "200":
40071           description: successful operation
40072           schema:
40073               $ref: "#/getDefinitions/physical-link"
40074         "default":
40075           description: Response codes found in [response codes](https://wiki.onap.org/).
40076       parameters:
40077         - name: link-name
40078           in: path
40079           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40080           required: true
40081           type: string
40082           example: __LINK-NAME__
40083     put:
40084       tags:
40085         - Network
40086       summary: create or update an existing physical-link
40087       description: |
40088         Create or update an existing physical-link.
40089         #
40090         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40091       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
40092       consumes:
40093         - application/json
40094         - application/xml
40095       produces:
40096         - application/json
40097         - application/xml
40098       responses:
40099         "default":
40100           description: Response codes found in [response codes](https://wiki.onap.org/).
40101       parameters:
40102         - name: link-name
40103           in: path
40104           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40105           required: true
40106           type: string
40107           example: __LINK-NAME__
40108         - name: body
40109           in: body
40110           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
40111           required: true
40112           schema:
40113             $ref: "#/definitions/physical-link"
40114     patch:
40115       tags:
40116         - Network
40117       summary: update an existing physical-link
40118       description: |
40119         Update an existing physical-link
40120         #
40121         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40122         The PUT operation will entirely replace an existing object.
40123         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40124         #
40125         Other differences between PUT and PATCH are:
40126         #
40127         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40128         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40129         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40130       operationId: UpdateNetworkPhysicalLinksPhysicalLink
40131       consumes:
40132         - application/json
40133         - application/xml
40134       produces:
40135         - application/json
40136         - application/xml
40137       responses:
40138         "default":
40139           description: Response codes found in [response codes](https://wiki.onap.org/).
40140       parameters:
40141         - name: link-name
40142           in: path
40143           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40144           required: true
40145           type: string
40146           example: __LINK-NAME__
40147         - name: body
40148           in: body
40149           description: physical-link object that needs to be updated.
40150           required: true
40151           schema:
40152             $ref: "#/patchDefinitions/physical-link"
40153     delete:
40154       tags:
40155         - Network
40156       summary: delete an existing physical-link
40157       description: delete an existing physical-link
40158       operationId: deleteNetworkPhysicalLinksPhysicalLink
40159       consumes:
40160         - application/json
40161         - application/xml
40162       produces:
40163         - application/json
40164         - application/xml
40165       responses:
40166         "default":
40167           description: Response codes found in [response codes](https://wiki.onap.org/).
40168       parameters:
40169         - name: link-name
40170           in: path
40171           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40172           required: true
40173           type: string
40174           example: __LINK-NAME__
40175         - name: resource-version
40176           in: query
40177           description: resource-version for concurrency
40178           required: true
40179           type: string
40180   /network/physical-links:
40181     get:
40182       tags:
40183         - Network
40184       summary: returns physical-links
40185       description: returns physical-links
40186       operationId: getNetworkPhysicalLinks
40187       produces:
40188         - application/json
40189         - application/xml
40190       responses:
40191         "200":
40192           description: successful operation
40193           schema:
40194               $ref: "#/getDefinitions/physical-links"
40195         "default":
40196           description: Response codes found in [response codes](https://wiki.onap.org/).
40197       parameters:
40198         - name: link-name
40199           in: query
40200           description:
40201           required: false
40202           type: string
40203         - name: circuit-id
40204           in: query
40205           description:
40206           required: false
40207           type: string
40208   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
40209     put:
40210       tags:
40211         - Network
40212       summary: see node definition for valid relationships
40213       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
40214       consumes:
40215         - application/json
40216         - application/xml
40217       produces:
40218         - application/json
40219         - application/xml
40220       responses:
40221         "default":
40222           description: Response codes found in [response codes](https://wiki.onap.org/).
40223       parameters:
40224         - name: ipsec-configuration-id
40225           in: path
40226           description: UUID of this configuration
40227           required: true
40228           type: string
40229           example: __IPSEC-CONFIGURATION-ID__
40230         - name: body
40231           in: body
40232           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
40233           required: true
40234           schema:
40235             $ref: "#/definitions/relationship"
40236     delete:
40237       tags:
40238         - Network
40239       summary: delete an existing relationship
40240       description: delete an existing relationship
40241       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
40242       consumes:
40243         - application/json
40244         - application/xml
40245       produces:
40246         - application/json
40247         - application/xml
40248       responses:
40249         "default":
40250           description: Response codes found in [response codes](https://wiki.onap.org/).
40251       parameters:
40252         - name: ipsec-configuration-id
40253           in: path
40254           description: UUID of this configuration
40255           required: true
40256           type: string
40257           example: __IPSEC-CONFIGURATION-ID__
40258   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
40259     put:
40260       tags:
40261         - Network
40262       summary: see node definition for valid relationships
40263       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40264       consumes:
40265         - application/json
40266         - application/xml
40267       produces:
40268         - application/json
40269         - application/xml
40270       responses:
40271         "default":
40272           description: Response codes found in [response codes](https://wiki.onap.org/).
40273       parameters:
40274         - name: ipsec-configuration-id
40275           in: path
40276           description: UUID of this configuration
40277           required: true
40278           type: string
40279           example: __IPSEC-CONFIGURATION-ID__
40280         - name: vig-address-type
40281           in: path
40282           description: indicates whether the VIG is for AVPN or INTERNET
40283           required: true
40284           type: string
40285           example: __VIG-ADDRESS-TYPE__
40286         - name: body
40287           in: body
40288           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40289           required: true
40290           schema:
40291             $ref: "#/definitions/relationship"
40292     delete:
40293       tags:
40294         - Network
40295       summary: delete an existing relationship
40296       description: delete an existing relationship
40297       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40298       consumes:
40299         - application/json
40300         - application/xml
40301       produces:
40302         - application/json
40303         - application/xml
40304       responses:
40305         "default":
40306           description: Response codes found in [response codes](https://wiki.onap.org/).
40307       parameters:
40308         - name: ipsec-configuration-id
40309           in: path
40310           description: UUID of this configuration
40311           required: true
40312           type: string
40313           example: __IPSEC-CONFIGURATION-ID__
40314         - name: vig-address-type
40315           in: path
40316           description: indicates whether the VIG is for AVPN or INTERNET
40317           required: true
40318           type: string
40319           example: __VIG-ADDRESS-TYPE__
40320   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
40321     get:
40322       tags:
40323         - Network
40324       summary: returns vig-server
40325       description: returns vig-server
40326       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40327       produces:
40328         - application/json
40329         - application/xml
40330       responses:
40331         "200":
40332           description: successful operation
40333           schema:
40334               $ref: "#/getDefinitions/vig-server"
40335         "default":
40336           description: Response codes found in [response codes](https://wiki.onap.org/).
40337       parameters:
40338         - name: ipsec-configuration-id
40339           in: path
40340           description: UUID of this configuration
40341           required: true
40342           type: string
40343           example: __IPSEC-CONFIGURATION-ID__
40344         - name: vig-address-type
40345           in: path
40346           description: indicates whether the VIG is for AVPN or INTERNET
40347           required: true
40348           type: string
40349           example: __VIG-ADDRESS-TYPE__
40350     put:
40351       tags:
40352         - Network
40353       summary: create or update an existing vig-server
40354       description: |
40355         Create or update an existing vig-server.
40356         #
40357         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40358       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40359       consumes:
40360         - application/json
40361         - application/xml
40362       produces:
40363         - application/json
40364         - application/xml
40365       responses:
40366         "default":
40367           description: Response codes found in [response codes](https://wiki.onap.org/).
40368       parameters:
40369         - name: ipsec-configuration-id
40370           in: path
40371           description: UUID of this configuration
40372           required: true
40373           type: string
40374           example: __IPSEC-CONFIGURATION-ID__
40375         - name: vig-address-type
40376           in: path
40377           description: indicates whether the VIG is for AVPN or INTERNET
40378           required: true
40379           type: string
40380           example: __VIG-ADDRESS-TYPE__
40381         - name: body
40382           in: body
40383           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40384           required: true
40385           schema:
40386             $ref: "#/definitions/vig-server"
40387     patch:
40388       tags:
40389         - Network
40390       summary: update an existing vig-server
40391       description: |
40392         Update an existing vig-server
40393         #
40394         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40395         The PUT operation will entirely replace an existing object.
40396         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40397         #
40398         Other differences between PUT and PATCH are:
40399         #
40400         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40401         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40402         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40403       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40404       consumes:
40405         - application/json
40406         - application/xml
40407       produces:
40408         - application/json
40409         - application/xml
40410       responses:
40411         "default":
40412           description: Response codes found in [response codes](https://wiki.onap.org/).
40413       parameters:
40414         - name: ipsec-configuration-id
40415           in: path
40416           description: UUID of this configuration
40417           required: true
40418           type: string
40419           example: __IPSEC-CONFIGURATION-ID__
40420         - name: vig-address-type
40421           in: path
40422           description: indicates whether the VIG is for AVPN or INTERNET
40423           required: true
40424           type: string
40425           example: __VIG-ADDRESS-TYPE__
40426         - name: body
40427           in: body
40428           description: vig-server object that needs to be updated.
40429           required: true
40430           schema:
40431             $ref: "#/patchDefinitions/vig-server"
40432     delete:
40433       tags:
40434         - Network
40435       summary: delete an existing vig-server
40436       description: delete an existing vig-server
40437       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40438       consumes:
40439         - application/json
40440         - application/xml
40441       produces:
40442         - application/json
40443         - application/xml
40444       responses:
40445         "default":
40446           description: Response codes found in [response codes](https://wiki.onap.org/).
40447       parameters:
40448         - name: ipsec-configuration-id
40449           in: path
40450           description: UUID of this configuration
40451           required: true
40452           type: string
40453           example: __IPSEC-CONFIGURATION-ID__
40454         - name: vig-address-type
40455           in: path
40456           description: indicates whether the VIG is for AVPN or INTERNET
40457           required: true
40458           type: string
40459           example: __VIG-ADDRESS-TYPE__
40460         - name: resource-version
40461           in: query
40462           description: resource-version for concurrency
40463           required: true
40464           type: string
40465   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
40466     get:
40467       tags:
40468         - Network
40469       summary: returns vig-servers
40470       description: returns vig-servers
40471       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
40472       produces:
40473         - application/json
40474         - application/xml
40475       responses:
40476         "200":
40477           description: successful operation
40478           schema:
40479               $ref: "#/getDefinitions/vig-servers"
40480         "default":
40481           description: Response codes found in [response codes](https://wiki.onap.org/).
40482       parameters:
40483         - name: ipsec-configuration-id
40484           in: path
40485           description: UUID of this configuration
40486           required: true
40487           type: string
40488           example: __IPSEC-CONFIGURATION-ID__
40489         - name: vig-address-type
40490           in: query
40491           description:
40492           required: false
40493           type: string
40494   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
40495     get:
40496       tags:
40497         - Network
40498       summary: returns ipsec-configuration
40499       description: returns ipsec-configuration
40500       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
40501       produces:
40502         - application/json
40503         - application/xml
40504       responses:
40505         "200":
40506           description: successful operation
40507           schema:
40508               $ref: "#/getDefinitions/ipsec-configuration"
40509         "default":
40510           description: Response codes found in [response codes](https://wiki.onap.org/).
40511       parameters:
40512         - name: ipsec-configuration-id
40513           in: path
40514           description: UUID of this configuration
40515           required: true
40516           type: string
40517           example: __IPSEC-CONFIGURATION-ID__
40518     put:
40519       tags:
40520         - Network
40521       summary: create or update an existing ipsec-configuration
40522       description: |
40523         Create or update an existing ipsec-configuration.
40524         #
40525         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40526       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
40527       consumes:
40528         - application/json
40529         - application/xml
40530       produces:
40531         - application/json
40532         - application/xml
40533       responses:
40534         "default":
40535           description: Response codes found in [response codes](https://wiki.onap.org/).
40536       parameters:
40537         - name: ipsec-configuration-id
40538           in: path
40539           description: UUID of this configuration
40540           required: true
40541           type: string
40542           example: __IPSEC-CONFIGURATION-ID__
40543         - name: body
40544           in: body
40545           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
40546           required: true
40547           schema:
40548             $ref: "#/definitions/ipsec-configuration"
40549     patch:
40550       tags:
40551         - Network
40552       summary: update an existing ipsec-configuration
40553       description: |
40554         Update an existing ipsec-configuration
40555         #
40556         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40557         The PUT operation will entirely replace an existing object.
40558         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40559         #
40560         Other differences between PUT and PATCH are:
40561         #
40562         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40563         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40564         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40565       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
40566       consumes:
40567         - application/json
40568         - application/xml
40569       produces:
40570         - application/json
40571         - application/xml
40572       responses:
40573         "default":
40574           description: Response codes found in [response codes](https://wiki.onap.org/).
40575       parameters:
40576         - name: ipsec-configuration-id
40577           in: path
40578           description: UUID of this configuration
40579           required: true
40580           type: string
40581           example: __IPSEC-CONFIGURATION-ID__
40582         - name: body
40583           in: body
40584           description: ipsec-configuration object that needs to be updated.
40585           required: true
40586           schema:
40587             $ref: "#/patchDefinitions/ipsec-configuration"
40588     delete:
40589       tags:
40590         - Network
40591       summary: delete an existing ipsec-configuration
40592       description: delete an existing ipsec-configuration
40593       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
40594       consumes:
40595         - application/json
40596         - application/xml
40597       produces:
40598         - application/json
40599         - application/xml
40600       responses:
40601         "default":
40602           description: Response codes found in [response codes](https://wiki.onap.org/).
40603       parameters:
40604         - name: ipsec-configuration-id
40605           in: path
40606           description: UUID of this configuration
40607           required: true
40608           type: string
40609           example: __IPSEC-CONFIGURATION-ID__
40610         - name: resource-version
40611           in: query
40612           description: resource-version for concurrency
40613           required: true
40614           type: string
40615   /network/ipsec-configurations:
40616     get:
40617       tags:
40618         - Network
40619       summary: returns ipsec-configurations
40620       description: returns ipsec-configurations
40621       operationId: getNetworkIpsecConfigurations
40622       produces:
40623         - application/json
40624         - application/xml
40625       responses:
40626         "200":
40627           description: successful operation
40628           schema:
40629               $ref: "#/getDefinitions/ipsec-configurations"
40630         "default":
40631           description: Response codes found in [response codes](https://wiki.onap.org/).
40632       parameters:
40633         - name: ipsec-configuration-id
40634           in: query
40635           description:
40636           required: false
40637           type: string
40638   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
40639     put:
40640       tags:
40641         - Network
40642       summary: see node definition for valid relationships
40643       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40644       consumes:
40645         - application/json
40646         - application/xml
40647       produces:
40648         - application/json
40649         - application/xml
40650       responses:
40651         "default":
40652           description: Response codes found in [response codes](https://wiki.onap.org/).
40653       parameters:
40654         - name: route-table-reference-id
40655           in: path
40656           description: Route Table Reference id, UUID assigned to this instance.
40657           required: true
40658           type: string
40659           example: __ROUTE-TABLE-REFERENCE-ID__
40660         - name: body
40661           in: body
40662           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
40663           required: true
40664           schema:
40665             $ref: "#/definitions/relationship"
40666     delete:
40667       tags:
40668         - Network
40669       summary: delete an existing relationship
40670       description: delete an existing relationship
40671       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40672       consumes:
40673         - application/json
40674         - application/xml
40675       produces:
40676         - application/json
40677         - application/xml
40678       responses:
40679         "default":
40680           description: Response codes found in [response codes](https://wiki.onap.org/).
40681       parameters:
40682         - name: route-table-reference-id
40683           in: path
40684           description: Route Table Reference id, UUID assigned to this instance.
40685           required: true
40686           type: string
40687           example: __ROUTE-TABLE-REFERENCE-ID__
40688   /network/route-table-references/route-table-reference/{route-table-reference-id}:
40689     get:
40690       tags:
40691         - Network
40692       summary: returns route-table-reference
40693       description: returns route-table-reference
40694       operationId: getNetworkRouteTableReferencesRouteTableReference
40695       produces:
40696         - application/json
40697         - application/xml
40698       responses:
40699         "200":
40700           description: successful operation
40701           schema:
40702               $ref: "#/getDefinitions/route-table-reference"
40703         "default":
40704           description: Response codes found in [response codes](https://wiki.onap.org/).
40705       parameters:
40706         - name: route-table-reference-id
40707           in: path
40708           description: Route Table Reference id, UUID assigned to this instance.
40709           required: true
40710           type: string
40711           example: __ROUTE-TABLE-REFERENCE-ID__
40712     put:
40713       tags:
40714         - Network
40715       summary: create or update an existing route-table-reference
40716       description: |
40717         Create or update an existing route-table-reference.
40718         #
40719         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40720       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
40721       consumes:
40722         - application/json
40723         - application/xml
40724       produces:
40725         - application/json
40726         - application/xml
40727       responses:
40728         "default":
40729           description: Response codes found in [response codes](https://wiki.onap.org/).
40730       parameters:
40731         - name: route-table-reference-id
40732           in: path
40733           description: Route Table Reference id, UUID assigned to this instance.
40734           required: true
40735           type: string
40736           example: __ROUTE-TABLE-REFERENCE-ID__
40737         - name: body
40738           in: body
40739           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
40740           required: true
40741           schema:
40742             $ref: "#/definitions/route-table-reference"
40743     patch:
40744       tags:
40745         - Network
40746       summary: update an existing route-table-reference
40747       description: |
40748         Update an existing route-table-reference
40749         #
40750         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40751         The PUT operation will entirely replace an existing object.
40752         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40753         #
40754         Other differences between PUT and PATCH are:
40755         #
40756         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40757         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40758         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40759       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
40760       consumes:
40761         - application/json
40762         - application/xml
40763       produces:
40764         - application/json
40765         - application/xml
40766       responses:
40767         "default":
40768           description: Response codes found in [response codes](https://wiki.onap.org/).
40769       parameters:
40770         - name: route-table-reference-id
40771           in: path
40772           description: Route Table Reference id, UUID assigned to this instance.
40773           required: true
40774           type: string
40775           example: __ROUTE-TABLE-REFERENCE-ID__
40776         - name: body
40777           in: body
40778           description: route-table-reference object that needs to be updated.
40779           required: true
40780           schema:
40781             $ref: "#/patchDefinitions/route-table-reference"
40782     delete:
40783       tags:
40784         - Network
40785       summary: delete an existing route-table-reference
40786       description: delete an existing route-table-reference
40787       operationId: deleteNetworkRouteTableReferencesRouteTableReference
40788       consumes:
40789         - application/json
40790         - application/xml
40791       produces:
40792         - application/json
40793         - application/xml
40794       responses:
40795         "default":
40796           description: Response codes found in [response codes](https://wiki.onap.org/).
40797       parameters:
40798         - name: route-table-reference-id
40799           in: path
40800           description: Route Table Reference id, UUID assigned to this instance.
40801           required: true
40802           type: string
40803           example: __ROUTE-TABLE-REFERENCE-ID__
40804         - name: resource-version
40805           in: query
40806           description: resource-version for concurrency
40807           required: true
40808           type: string
40809   /network/route-table-references:
40810     get:
40811       tags:
40812         - Network
40813       summary: returns route-table-references
40814       description: returns route-table-references
40815       operationId: getNetworkRouteTableReferences
40816       produces:
40817         - application/json
40818         - application/xml
40819       responses:
40820         "200":
40821           description: successful operation
40822           schema:
40823               $ref: "#/getDefinitions/route-table-references"
40824         "default":
40825           description: Response codes found in [response codes](https://wiki.onap.org/).
40826       parameters:
40827         - name: route-table-reference-id
40828           in: query
40829           description:
40830           required: false
40831           type: string
40832         - name: route-table-reference-fqdn
40833           in: query
40834           description:
40835           required: false
40836           type: string
40837   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
40838     put:
40839       tags:
40840         - Network
40841       summary: see node definition for valid relationships
40842       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40843       consumes:
40844         - application/json
40845         - application/xml
40846       produces:
40847         - application/json
40848         - application/xml
40849       responses:
40850         "default":
40851           description: Response codes found in [response codes](https://wiki.onap.org/).
40852       parameters:
40853         - name: id
40854           in: path
40855           description: Instance Group ID, UUID assigned to this instance.
40856           required: true
40857           type: string
40858           example: __ID__
40859         - name: body
40860           in: body
40861           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
40862           required: true
40863           schema:
40864             $ref: "#/definitions/relationship"
40865     delete:
40866       tags:
40867         - Network
40868       summary: delete an existing relationship
40869       description: delete an existing relationship
40870       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40871       consumes:
40872         - application/json
40873         - application/xml
40874       produces:
40875         - application/json
40876         - application/xml
40877       responses:
40878         "default":
40879           description: Response codes found in [response codes](https://wiki.onap.org/).
40880       parameters:
40881         - name: id
40882           in: path
40883           description: Instance Group ID, UUID assigned to this instance.
40884           required: true
40885           type: string
40886           example: __ID__
40887   /network/instance-groups/instance-group/{id}:
40888     get:
40889       tags:
40890         - Network
40891       summary: returns instance-group
40892       description: returns instance-group
40893       operationId: getNetworkInstanceGroupsInstanceGroup
40894       produces:
40895         - application/json
40896         - application/xml
40897       responses:
40898         "200":
40899           description: successful operation
40900           schema:
40901               $ref: "#/getDefinitions/instance-group"
40902         "default":
40903           description: Response codes found in [response codes](https://wiki.onap.org/).
40904       parameters:
40905         - name: id
40906           in: path
40907           description: Instance Group ID, UUID assigned to this instance.
40908           required: true
40909           type: string
40910           example: __ID__
40911     put:
40912       tags:
40913         - Network
40914       summary: create or update an existing instance-group
40915       description: |
40916         Create or update an existing instance-group.
40917         #
40918         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40919       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
40920       consumes:
40921         - application/json
40922         - application/xml
40923       produces:
40924         - application/json
40925         - application/xml
40926       responses:
40927         "default":
40928           description: Response codes found in [response codes](https://wiki.onap.org/).
40929       parameters:
40930         - name: id
40931           in: path
40932           description: Instance Group ID, UUID assigned to this instance.
40933           required: true
40934           type: string
40935           example: __ID__
40936         - name: body
40937           in: body
40938           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
40939           required: true
40940           schema:
40941             $ref: "#/definitions/instance-group"
40942     patch:
40943       tags:
40944         - Network
40945       summary: update an existing instance-group
40946       description: |
40947         Update an existing instance-group
40948         #
40949         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40950         The PUT operation will entirely replace an existing object.
40951         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40952         #
40953         Other differences between PUT and PATCH are:
40954         #
40955         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40956         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40957         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40958       operationId: UpdateNetworkInstanceGroupsInstanceGroup
40959       consumes:
40960         - application/json
40961         - application/xml
40962       produces:
40963         - application/json
40964         - application/xml
40965       responses:
40966         "default":
40967           description: Response codes found in [response codes](https://wiki.onap.org/).
40968       parameters:
40969         - name: id
40970           in: path
40971           description: Instance Group ID, UUID assigned to this instance.
40972           required: true
40973           type: string
40974           example: __ID__
40975         - name: body
40976           in: body
40977           description: instance-group object that needs to be updated.
40978           required: true
40979           schema:
40980             $ref: "#/patchDefinitions/instance-group"
40981     delete:
40982       tags:
40983         - Network
40984       summary: delete an existing instance-group
40985       description: delete an existing instance-group
40986       operationId: deleteNetworkInstanceGroupsInstanceGroup
40987       consumes:
40988         - application/json
40989         - application/xml
40990       produces:
40991         - application/json
40992         - application/xml
40993       responses:
40994         "default":
40995           description: Response codes found in [response codes](https://wiki.onap.org/).
40996       parameters:
40997         - name: id
40998           in: path
40999           description: Instance Group ID, UUID assigned to this instance.
41000           required: true
41001           type: string
41002           example: __ID__
41003         - name: resource-version
41004           in: query
41005           description: resource-version for concurrency
41006           required: true
41007           type: string
41008   /network/instance-groups:
41009     get:
41010       tags:
41011         - Network
41012       summary: returns instance-groups
41013       description: returns instance-groups
41014       operationId: getNetworkInstanceGroups
41015       produces:
41016         - application/json
41017         - application/xml
41018       responses:
41019         "200":
41020           description: successful operation
41021           schema:
41022               $ref: "#/getDefinitions/instance-groups"
41023         "default":
41024           description: Response codes found in [response codes](https://wiki.onap.org/).
41025       parameters:
41026         - name: id
41027           in: query
41028           description:
41029           required: false
41030           type: string
41031         - name: description
41032           in: query
41033           description:
41034           required: false
41035           type: string
41036         - name: type
41037           in: query
41038           description:
41039           required: false
41040           type: string
41041         - name: sub-type
41042           in: query
41043           description:
41044           required: false
41045           type: string
41046   /network/zones/zone/{zone-id}/relationship-list/relationship:
41047     put:
41048       tags:
41049         - Network
41050       summary: see node definition for valid relationships
41051       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
41052       consumes:
41053         - application/json
41054         - application/xml
41055       produces:
41056         - application/json
41057         - application/xml
41058       responses:
41059         "default":
41060           description: Response codes found in [response codes](https://wiki.onap.org/).
41061       parameters:
41062         - name: zone-id
41063           in: path
41064           description: Code assigned by AIC to the zone
41065           required: true
41066           type: string
41067           example: __ZONE-ID__
41068         - name: body
41069           in: body
41070           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
41071           required: true
41072           schema:
41073             $ref: "#/definitions/relationship"
41074     delete:
41075       tags:
41076         - Network
41077       summary: delete an existing relationship
41078       description: delete an existing relationship
41079       operationId: deleteNetworkZonesZoneRelationshipListRelationship
41080       consumes:
41081         - application/json
41082         - application/xml
41083       produces:
41084         - application/json
41085         - application/xml
41086       responses:
41087         "default":
41088           description: Response codes found in [response codes](https://wiki.onap.org/).
41089       parameters:
41090         - name: zone-id
41091           in: path
41092           description: Code assigned by AIC to the zone
41093           required: true
41094           type: string
41095           example: __ZONE-ID__
41096   /network/zones/zone/{zone-id}:
41097     get:
41098       tags:
41099         - Network
41100       summary: returns zone
41101       description: returns zone
41102       operationId: getNetworkZonesZone
41103       produces:
41104         - application/json
41105         - application/xml
41106       responses:
41107         "200":
41108           description: successful operation
41109           schema:
41110               $ref: "#/getDefinitions/zone"
41111         "default":
41112           description: Response codes found in [response codes](https://wiki.onap.org/).
41113       parameters:
41114         - name: zone-id
41115           in: path
41116           description: Code assigned by AIC to the zone
41117           required: true
41118           type: string
41119           example: __ZONE-ID__
41120     put:
41121       tags:
41122         - Network
41123       summary: create or update an existing zone
41124       description: |
41125         Create or update an existing zone.
41126         #
41127         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41128       operationId: createOrUpdateNetworkZonesZone
41129       consumes:
41130         - application/json
41131         - application/xml
41132       produces:
41133         - application/json
41134         - application/xml
41135       responses:
41136         "default":
41137           description: Response codes found in [response codes](https://wiki.onap.org/).
41138       parameters:
41139         - name: zone-id
41140           in: path
41141           description: Code assigned by AIC to the zone
41142           required: true
41143           type: string
41144           example: __ZONE-ID__
41145         - name: body
41146           in: body
41147           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
41148           required: true
41149           schema:
41150             $ref: "#/definitions/zone"
41151     patch:
41152       tags:
41153         - Network
41154       summary: update an existing zone
41155       description: |
41156         Update an existing zone
41157         #
41158         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41159         The PUT operation will entirely replace an existing object.
41160         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41161         #
41162         Other differences between PUT and PATCH are:
41163         #
41164         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41165         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41166         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41167       operationId: UpdateNetworkZonesZone
41168       consumes:
41169         - application/json
41170         - application/xml
41171       produces:
41172         - application/json
41173         - application/xml
41174       responses:
41175         "default":
41176           description: Response codes found in [response codes](https://wiki.onap.org/).
41177       parameters:
41178         - name: zone-id
41179           in: path
41180           description: Code assigned by AIC to the zone
41181           required: true
41182           type: string
41183           example: __ZONE-ID__
41184         - name: body
41185           in: body
41186           description: zone object that needs to be updated.
41187           required: true
41188           schema:
41189             $ref: "#/patchDefinitions/zone"
41190     delete:
41191       tags:
41192         - Network
41193       summary: delete an existing zone
41194       description: delete an existing zone
41195       operationId: deleteNetworkZonesZone
41196       consumes:
41197         - application/json
41198         - application/xml
41199       produces:
41200         - application/json
41201         - application/xml
41202       responses:
41203         "default":
41204           description: Response codes found in [response codes](https://wiki.onap.org/).
41205       parameters:
41206         - name: zone-id
41207           in: path
41208           description: Code assigned by AIC to the zone
41209           required: true
41210           type: string
41211           example: __ZONE-ID__
41212         - name: resource-version
41213           in: query
41214           description: resource-version for concurrency
41215           required: true
41216           type: string
41217   /network/zones:
41218     get:
41219       tags:
41220         - Network
41221       summary: returns zones
41222       description: returns zones
41223       operationId: getNetworkZones
41224       produces:
41225         - application/json
41226         - application/xml
41227       responses:
41228         "200":
41229           description: successful operation
41230           schema:
41231               $ref: "#/getDefinitions/zones"
41232         "default":
41233           description: Response codes found in [response codes](https://wiki.onap.org/).
41234       parameters:
41235         - name: zone-id
41236           in: query
41237           description:
41238           required: false
41239           type: string
41240         - name: design-type
41241           in: query
41242           description:
41243           required: false
41244           type: string
41245         - name: zone-context
41246           in: query
41247           description:
41248           required: false
41249           type: string
41250 definitions:
41251   action:
41252     properties:
41253       action-type:
41254         type: string
41255       action-data:
41256         type: array
41257         items:
41258           $ref: "#/definitions/action-data"
41259   action-data:
41260     properties:
41261       property-name:
41262         type: string
41263       property-value:
41264         type: string
41265   actions:
41266     description: |
41267       APIs that are more action related than REST (e.g., notify, update).
41268     properties:
41269       update:
41270         type: object
41271         $ref: "#/definitions/update"
41272       notify:
41273         type: object
41274         $ref: "#/definitions/notify"
41275   allotted-resource:
41276     description: |
41277       Represents a slice or partial piece of a resource that gets separately allotted
41278       ###### Related Nodes
41279       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
41280       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
41281       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
41282       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
41283       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
41284       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
41285       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
41286       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
41287
41288       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
41289       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
41290     required:
41291     - id
41292     properties:
41293       id:
41294         type: string
41295         description: Allotted Resource id UUID assigned to this instance.
41296       description:
41297         type: string
41298         description: The descriptive information assigned to this allotted resource instance
41299       selflink:
41300         type: string
41301         description: Link back to more information in the controller
41302       model-invariant-id:
41303         type: string
41304         description: the ASDC model id for this resource or service model.
41305       model-version-id:
41306         type: string
41307         description: the ASDC model version for this resource or service model.
41308       persona-model-version:
41309         type: string
41310         description: the ASDC model version for this resource or service model.
41311       resource-version:
41312         type: string
41313         description: Concurrency value
41314       orchestration-status:
41315         type: string
41316         description: Orchestration status
41317       operational-status:
41318         type: string
41319         description: Indicator for whether the resource is considered operational
41320       type:
41321         type: string
41322         description: Generic description of the type of allotted resource.
41323       role:
41324         type: string
41325         description: role in the network that this resource will be providing.
41326       tunnel-xconnects:
41327         type: array
41328         items:
41329           $ref: "#/definitions/tunnel-xconnect"
41330       relationship-list:
41331         type: array
41332         items:
41333           $ref: "#/definitions/relationship"
41334   allotted-resources:
41335     description: |
41336       This object is used to store slices of services being offered
41337     properties:
41338       allotted-resource:
41339         type: array
41340         items:
41341           $ref: "#/definitions/allotted-resource"
41342   availability-zone:
41343     description: |
41344       Availability zone, a collection of compute hosts/pservers
41345       ###### Related Nodes
41346       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
41347       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
41348       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
41349       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
41350       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
41351       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
41352       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
41353       - FROM vce( vce Uses availability-zone, MANY2MANY)
41354
41355       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
41356       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
41357
41358     required:
41359     - availability-zone-name
41360     - hypervisor-type
41361     properties:
41362       availability-zone-name:
41363         type: string
41364         description: Name of the availability zone.  Unique across a cloud region
41365       hypervisor-type:
41366         type: string
41367         description: Type of hypervisor.  Source of truth should define valid values.
41368       operational-status:
41369         type: string
41370         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
41371       resource-version:
41372         type: string
41373         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41374       relationship-list:
41375         type: array
41376         items:
41377           $ref: "#/definitions/relationship"
41378   availability-zones:
41379     description: |
41380       Collection of availability zones
41381     properties:
41382       availability-zone:
41383         type: array
41384         items:
41385           $ref: "#/definitions/availability-zone"
41386   az-and-dvs-switches:
41387     properties:
41388       dvs-switches:
41389         type: object
41390         $ref: "#/definitions/dvs-switches"
41391       availability-zone:
41392         type: object
41393         $ref: "#/definitions/availability-zone"
41394   business:
41395     description: |
41396       Namespace for business related constructs
41397     properties:
41398       connectors:
41399         type: array
41400         items:
41401           $ref: "#/definitions/connector"
41402       customers:
41403         type: array
41404         items:
41405           $ref: "#/definitions/customer"
41406   class-of-service:
41407     description: |
41408       ###### Related Nodes
41409       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
41410
41411       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
41412     required:
41413     - cos
41414     properties:
41415       cos:
41416         type: string
41417         description: unique identifier of probe
41418       probe-id:
41419         type: string
41420         description: identifier of probe
41421       probe-type:
41422         type: string
41423         description: type of probe
41424       resource-version:
41425         type: string
41426         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41427       relationship-list:
41428         type: array
41429         items:
41430           $ref: "#/definitions/relationship"
41431   classes-of-service:
41432     description: |
41433       class-of-service of probe
41434     properties:
41435       class-of-service:
41436         type: array
41437         items:
41438           $ref: "#/definitions/class-of-service"
41439   cloud-infrastructure:
41440     description: |
41441       Namespace for cloud infrastructure.
41442     properties:
41443       complexes:
41444         type: array
41445         items:
41446           $ref: "#/definitions/complex"
41447       cloud-regions:
41448         type: array
41449         items:
41450           $ref: "#/definitions/cloud-region"
41451       network-profiles:
41452         type: array
41453         items:
41454           $ref: "#/definitions/network-profile"
41455       pservers:
41456         type: array
41457         items:
41458           $ref: "#/definitions/pserver"
41459       virtual-data-centers:
41460         type: array
41461         items:
41462           $ref: "#/definitions/virtual-data-center"
41463   cloud-region:
41464     description: |
41465       cloud-region designates an installation of a cloud cluster or region or instantiation
41466       ###### Related Nodes
41467       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
41468       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
41469       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
41470       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
41471       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
41472       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
41473       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
41474       - FROM image( image BelongsTo cloud-region, MANY2ONE)
41475       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
41476       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
41477       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
41478       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
41479       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
41480       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
41481
41482       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
41483       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
41484
41485     required:
41486     - cloud-owner
41487     - cloud-region-id
41488     properties:
41489       cloud-owner:
41490         type: string
41491         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
41492       cloud-region-id:
41493         type: string
41494         description: Identifier used by the vendor for the region. Second part of composite key
41495       cloud-type:
41496         type: string
41497         description: Type of the cloud (e.g., openstack)
41498       owner-defined-type:
41499         type: string
41500         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
41501       cloud-region-version:
41502         type: string
41503         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
41504       identity-url:
41505         type: string
41506         description: URL of the keystone identity service
41507       cloud-zone:
41508         type: string
41509         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41510       complex-name:
41511         type: string
41512         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41513       resource-version:
41514         type: string
41515         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41516       volume-groups:
41517         type: array
41518         items:
41519           $ref: "#/definitions/volume-group"
41520       tenants:
41521         type: array
41522         items:
41523           $ref: "#/definitions/tenant"
41524       flavors:
41525         type: array
41526         items:
41527           $ref: "#/definitions/flavor"
41528       group-assignments:
41529         type: array
41530         items:
41531           $ref: "#/definitions/group-assignment"
41532       snapshots:
41533         type: array
41534         items:
41535           $ref: "#/definitions/snapshot"
41536       images:
41537         type: array
41538         items:
41539           $ref: "#/definitions/image"
41540       dvs-switches:
41541         type: array
41542         items:
41543           $ref: "#/definitions/dvs-switch"
41544       oam-networks:
41545         type: array
41546         items:
41547           $ref: "#/definitions/oam-network"
41548       availability-zones:
41549         type: array
41550         items:
41551           $ref: "#/definitions/availability-zone"
41552       relationship-list:
41553         type: array
41554         items:
41555           $ref: "#/definitions/relationship"
41556   cloud-regions:
41557     properties:
41558       cloud-region:
41559         type: array
41560         items:
41561           $ref: "#/definitions/cloud-region"
41562   complex:
41563     description: |
41564       Collection of physical locations that can house cloud-regions.
41565       ###### Related Nodes
41566       - TO l3-network( complex Uses l3-network, MANY2MANY)
41567       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
41568       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
41569       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
41570       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
41571       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
41572       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
41573       - FROM vce( vce LocatedIn complex, MANY2MANY)
41574       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
41575       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
41576       - FROM zone( zone LocatedIn complex, MANY2ONE)
41577
41578       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
41579       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
41580
41581     required:
41582     - physical-location-id
41583     - physical-location-type
41584     - street1
41585     - city
41586     - postal-code
41587     - country
41588     - region
41589     properties:
41590       physical-location-id:
41591         type: string
41592         description: Unique identifier for physical location, e.g., CLLI
41593       data-center-code:
41594         type: string
41595         description: Data center code which can be an alternate way to identify a complex
41596       complex-name:
41597         type: string
41598         description: Gamma complex name for LCP instance.
41599       identity-url:
41600         type: string
41601         description: URL of the keystone identity service
41602       resource-version:
41603         type: string
41604         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41605       physical-location-type:
41606         type: string
41607         description: Type, e.g., central office, data center.
41608       street1:
41609         type: string
41610       street2:
41611         type: string
41612       city:
41613         type: string
41614       state:
41615         type: string
41616       postal-code:
41617         type: string
41618       country:
41619         type: string
41620       region:
41621         type: string
41622       latitude:
41623         type: string
41624       longitude:
41625         type: string
41626       elevation:
41627         type: string
41628       lata:
41629         type: string
41630       ctag-pools:
41631         type: array
41632         items:
41633           $ref: "#/definitions/ctag-pool"
41634       relationship-list:
41635         type: array
41636         items:
41637           $ref: "#/definitions/relationship"
41638   complexes:
41639     description: |
41640       Collection of physical locations that can house cloud-regions.
41641     properties:
41642       complex:
41643         type: array
41644         items:
41645           $ref: "#/definitions/complex"
41646   configuration:
41647     description: |
41648       Port Mirror Configuration.
41649       ###### Related Nodes
41650       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
41651       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
41652       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
41653       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
41654       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
41655
41656       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
41657       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
41658       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
41659     required:
41660     - configuration-id
41661     - configuration-type
41662     - configuration-sub-type
41663     - orchestration-status
41664     - operational-status
41665     - configuration-selflink
41666     - model-customization-id
41667     properties:
41668       configuration-id:
41669         type: string
41670         description: UUID assigned to configuration.
41671       management-option:
41672         type: string
41673         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
41674       configuration-name:
41675         type: string
41676         description: Name of the configuration.
41677       configuration-type:
41678         type: string
41679         description: port-mirroring-configuration.
41680       configuration-sub-type:
41681         type: string
41682         description: vprobe, pprobe.
41683       model-invariant-id:
41684         type: string
41685         description: the ASDC model id for this resource or service model.
41686       model-version-id:
41687         type: string
41688         description: the ASDC model version for this resource or service model.
41689       orchestration-status:
41690         type: string
41691         description: Orchestration status of the configuration.
41692       operational-status:
41693         type: string
41694         description: Indicator for whether the resource is considered operational.
41695       configuration-selflink:
41696         type: string
41697         description: URL to endpoint where AAI can get more details from SDN-GC.
41698       model-customization-id:
41699         type: string
41700         description: id of  the configuration used to customize the resource
41701       resource-version:
41702         type: string
41703         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41704       relationship-list:
41705         type: array
41706         items:
41707           $ref: "#/definitions/relationship"
41708       metadata:
41709         type: array
41710         items:
41711           $ref: "#/definitions/metadatum"
41712   configurations:
41713     description: |
41714       Collection of configurations
41715     properties:
41716       configuration:
41717         type: array
41718         items:
41719           $ref: "#/definitions/configuration"
41720   connector:
41721     description: |
41722       Collection of resource instances used to connect a variety of disparate inventory widgets
41723       ###### Related Nodes
41724       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
41725       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
41726       - FROM service-instance( service-instance Uses connector, MANY2MANY)
41727
41728       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
41729     required:
41730     - resource-instance-id
41731     properties:
41732       resource-instance-id:
41733         type: string
41734         description: Unique id of resource instance.
41735       resource-version:
41736         type: string
41737         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41738       model-invariant-id:
41739         type: string
41740         description: the ASDC model id for this resource or service model.
41741       model-version-id:
41742         type: string
41743         description: the ASDC model version for this resource or service model.
41744       persona-model-version:
41745         type: string
41746         description: the ASDC model version for this resource or service model.
41747       widget-model-id:
41748         type: string
41749         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41750       widget-model-version:
41751         type: string
41752         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41753       relationship-list:
41754         type: array
41755         items:
41756           $ref: "#/definitions/relationship"
41757       metadata:
41758         type: array
41759         items:
41760           $ref: "#/definitions/metadatum"
41761   connectors:
41762     description: |
41763       Collection of resource instances used to connect a variety of disparate inventory widgets
41764     properties:
41765       connector:
41766         type: array
41767         items:
41768           $ref: "#/definitions/connector"
41769   constrained-element-set:
41770     description: |
41771       This is how we would capture constraints defining allowed sets of elements.
41772       ###### Related Nodes
41773       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
41774       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
41775       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
41776
41777       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
41778       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
41779     required:
41780     - constrained-element-set-uuid
41781     - constraint-type
41782     - check-type
41783     properties:
41784       constrained-element-set-uuid:
41785         type: string
41786       constraint-type:
41787         type: string
41788       check-type:
41789         type: string
41790       resource-version:
41791         type: string
41792       element-choice-sets:
41793         type: array
41794         items:
41795           $ref: "#/definitions/element-choice-set"
41796       relationship-list:
41797         type: array
41798         items:
41799           $ref: "#/definitions/relationship"
41800   constrained-element-sets:
41801     properties:
41802       constrained-element-set:
41803         type: array
41804         items:
41805           $ref: "#/definitions/constrained-element-set"
41806   ctag-assignment:
41807     description: |
41808       ###### Related Nodes
41809       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
41810       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
41811
41812       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
41813     required:
41814     - vlan-id-inner
41815     properties:
41816       vlan-id-inner:
41817         type: integer
41818         format: int64
41819         description: id.
41820       resource-version:
41821         type: string
41822         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41823       relationship-list:
41824         type: array
41825         items:
41826           $ref: "#/definitions/relationship"
41827   ctag-assignments:
41828     properties:
41829       ctag-assignment:
41830         type: array
41831         items:
41832           $ref: "#/definitions/ctag-assignment"
41833   ctag-pool:
41834     description: |
41835       A collection of C tags (vlan tags) grouped for a specific purpose.
41836       ###### Related Nodes
41837       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
41838       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
41839       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
41840
41841       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
41842     required:
41843     - target-pe
41844     - availability-zone-name
41845     - ctag-pool-purpose
41846     properties:
41847       target-pe:
41848         type: string
41849         description: The Target provider edge router
41850       availability-zone-name:
41851         type: string
41852         description: Name of the availability zone
41853       ctag-pool-purpose:
41854         type: string
41855         description: Describes what the intended purpose of this pool is.
41856       ctag-values:
41857         type: string
41858         description: Comma separated list of ctags
41859       resource-version:
41860         type: string
41861         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41862       relationship-list:
41863         type: array
41864         items:
41865           $ref: "#/definitions/relationship"
41866   ctag-pools:
41867     properties:
41868       ctag-pool:
41869         type: array
41870         items:
41871           $ref: "#/definitions/ctag-pool"
41872   customer:
41873     description: |
41874       customer identifiers to provide linkage back to BSS information.
41875       ###### Related Nodes
41876       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
41877
41878       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
41879     required:
41880     - global-customer-id
41881     - subscriber-name
41882     - subscriber-type
41883     properties:
41884       global-customer-id:
41885         type: string
41886         description: Global customer id used across ECOMP to uniquely identify customer.
41887       subscriber-name:
41888         type: string
41889         description: Subscriber name, an alternate way to retrieve a customer.
41890       subscriber-type:
41891         type: string
41892         description: Subscriber type, a way to provide VID with only the INFRA customers.
41893       resource-version:
41894         type: string
41895         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41896       service-subscriptions:
41897         type: array
41898         items:
41899           $ref: "#/definitions/service-subscription"
41900       relationship-list:
41901         type: array
41902         items:
41903           $ref: "#/definitions/relationship"
41904   customers:
41905     description: |
41906       Collection of customer identifiers to provide linkage back to BSS information.
41907     properties:
41908       customer:
41909         type: array
41910         items:
41911           $ref: "#/definitions/customer"
41912   cvlan-tag-entry:
41913     required:
41914     - cvlan-tag
41915     properties:
41916       cvlan-tag:
41917         type: integer
41918         format: int64
41919         description: See mis-na-virtualization-platform.yang
41920       resource-version:
41921         type: string
41922         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41923       relationship-list:
41924         type: array
41925         items:
41926           $ref: "#/definitions/relationship"
41927   cvlan-tags:
41928     properties:
41929       cvlan-tag-entry:
41930         type: array
41931         items:
41932           $ref: "#/definitions/cvlan-tag-entry"
41933   dvs-switch:
41934     description: |
41935       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.
41936       ###### Related Nodes
41937       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
41938       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
41939
41940     required:
41941     - switch-name
41942     - vcenter-url
41943     properties:
41944       switch-name:
41945         type: string
41946         description: DVS switch name
41947       vcenter-url:
41948         type: string
41949         description: URL used to reach the vcenter
41950       resource-version:
41951         type: string
41952         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41953       relationship-list:
41954         type: array
41955         items:
41956           $ref: "#/definitions/relationship"
41957   dvs-switches:
41958     description: |
41959       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
41960     properties:
41961       dvs-switch:
41962         type: array
41963         items:
41964           $ref: "#/definitions/dvs-switch"
41965   edge-prop-names:
41966     description: |
41967       Internal map to define the properties of an edge and interpret the map EdgeRules
41968     properties:
41969       edgeLabel:
41970         type: string
41971       direction:
41972         type: string
41973       multiplicityRule:
41974         type: string
41975       isParent:
41976         type: boolean
41977       usesResource:
41978         type: boolean
41979       hasDelTarget:
41980         type: boolean
41981       SVC-INFRA:
41982         type: boolean
41983       SVC-INFRA-REV:
41984         type: boolean
41985   edge-tag-query-request:
41986     properties:
41987       edge-tag:
41988         type: string
41989       result-detail:
41990         type: string
41991       start-node-type:
41992         type: string
41993       start-node-filter:
41994         type: array
41995         items:
41996           $ref: "#/definitions/start-node-filter"
41997       include-node-filter:
41998         type: array
41999         items:
42000           $ref: "#/definitions/include-node-filter"
42001       secondary-filter:
42002         type: array
42003         items:
42004           $ref: "#/definitions/secondary-filter"
42005   edge-tag-query-result:
42006     properties:
42007       tagged-inventory-item-list:
42008         type: array
42009         items:
42010           $ref: "#/definitions/tagged-inventory-item-list"
42011   element-choice-set:
42012     description: |
42013       This is how we would capture constraints defining allowed sets of elements.
42014       ###### Related Nodes
42015       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
42016       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
42017
42018       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
42019       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
42020     required:
42021     - element-choice-set-uuid
42022     - element-choice-set-name
42023     properties:
42024       element-choice-set-uuid:
42025         type: string
42026       element-choice-set-name:
42027         type: string
42028       cardinality:
42029         type: string
42030       resource-version:
42031         type: string
42032       model-elements:
42033         type: array
42034         items:
42035           $ref: "#/definitions/model-element"
42036       relationship-list:
42037         type: array
42038         items:
42039           $ref: "#/definitions/relationship"
42040   element-choice-sets:
42041     properties:
42042       element-choice-set:
42043         type: array
42044         items:
42045           $ref: "#/definitions/element-choice-set"
42046   entitlement:
42047     description: |
42048       Metadata for entitlement group.
42049       ###### Related Nodes
42050       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
42051       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
42052
42053       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
42054     required:
42055     - group-uuid
42056     - resource-uuid
42057     properties:
42058       group-uuid:
42059         type: string
42060         description: Unique ID for the entitlement group the resource comes from, should be uuid.
42061       resource-uuid:
42062         type: string
42063         description: Unique ID of an entitlement resource.
42064       resource-version:
42065         type: string
42066         description: Concurrency value
42067       relationship-list:
42068         type: array
42069         items:
42070           $ref: "#/definitions/relationship"
42071   entitlements:
42072     description: |
42073       Entitlements, keyed by group-uuid and resource-uuid, related to license management
42074     properties:
42075       entitlement:
42076         type: array
42077         items:
42078           $ref: "#/definitions/entitlement"
42079   esr-ems:
42080     description: |
42081       Persist EMS address information used by EMS driver.
42082       ###### Related Nodes
42083       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
42084
42085       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
42086     required:
42087     - ems-id
42088     properties:
42089       ems-id:
42090         type: string
42091         description: Unique ID of EMS.
42092       resource-version:
42093         type: string
42094         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42095       esr-system-info-list:
42096         type: object
42097         $ref: "#/definitions/esr-system-info-list"
42098       relationship-list:
42099         type: object
42100         $ref: "#/definitions/relationship-list"
42101   esr-ems-list:
42102     properties:
42103       esr-ems:
42104         type: array
42105         items:
42106           $ref: "#/definitions/esr-ems"
42107   esr-system-info:
42108     description: |
42109       Persist common address information of external systems.
42110       ###### Related Nodes
42111       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
42112       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
42113       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
42114       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
42115
42116       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
42117     required:
42118     - esr-system-info-id
42119     - user-name
42120     - password
42121     - system-type
42122     properties:
42123       esr-system-info-id:
42124         type: string
42125         description: Unique ID of esr system info.
42126       system-name:
42127         type: string
42128         description: name of external system.
42129       type:
42130         type: string
42131         description: type of external systems.
42132       vendor:
42133         type: string
42134         description: vendor of external systems.
42135       version:
42136         type: string
42137         description: version of external systems.
42138       service-url:
42139         type: string
42140         description: url used to access external systems.
42141       user-name:
42142         type: string
42143         description: username used to access external systems.
42144       password:
42145         type: string
42146         description: password used to access external systems.
42147       system-type:
42148         type: string
42149         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
42150       protocol:
42151         type: string
42152         description: protocol of third party SDNC, for example netconf/snmp.
42153       ssl-cacert:
42154         type: string
42155         description: ca file content if enabled ssl on auth-url.
42156       ssl-insecure:
42157         type: boolean
42158         description: Whether to verify VIM's certificate.
42159       ip-address:
42160         type: string
42161         description: service IP of ftp server.
42162       port:
42163         type: string
42164         description: service port of ftp server.
42165       cloud-domain:
42166         type: string
42167         description: domain info for authentication.
42168       default-tenant:
42169         type: string
42170         description: default tenant of VIM.
42171       passive:
42172         type: boolean
42173         description: ftp passive mode or not.
42174       remote-path:
42175         type: string
42176         description: resource or performance data file path.
42177       system-status:
42178         type: string
42179         description: the status of external system.
42180       resource-version:
42181         type: string
42182         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42183       relationship-list:
42184         type: array
42185         items:
42186           $ref: "#/definitions/relationship"
42187   esr-system-info-list:
42188     description: |
42189       Collection of persistent block-level external system auth info.
42190     properties:
42191       esr-system-info:
42192         type: array
42193         items:
42194           $ref: "#/definitions/esr-system-info"
42195   esr-thirdparty-sdnc:
42196     description: |
42197       Persist SDNC address information used by ONAP SDNC.
42198       ###### Related Nodes
42199       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
42200       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
42201
42202       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
42203     required:
42204     - thirdparty-sdnc-id
42205     properties:
42206       thirdparty-sdnc-id:
42207         type: string
42208         description: Unique ID of SDNC.
42209       location:
42210         type: string
42211         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
42212       product-name:
42213         type: string
42214         description: password used to access SDNC server.
42215       resource-version:
42216         type: string
42217         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42218       esr-system-info-list:
42219         type: object
42220         $ref: "#/definitions/esr-system-info-list"
42221       relationship-list:
42222         type: object
42223         $ref: "#/definitions/relationship-list"
42224   esr-thirdparty-sdnc-list:
42225     properties:
42226       esr-thirdparty-sdnc:
42227         type: array
42228         items:
42229           $ref: "#/definitions/esr-thirdparty-sdnc"
42230   esr-vnfm:
42231     description: |
42232       Persist VNFM address information used by VF-C.
42233       ###### Related Nodes
42234       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
42235
42236       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
42237     required:
42238     - vnfm-id
42239     properties:
42240       vnfm-id:
42241         type: string
42242         description: Unique ID of VNFM.
42243       vim-id:
42244         type: string
42245         description: indecate the VIM to deploy VNF.
42246       certificate-url:
42247         type: string
42248         description: certificate url of VNFM.
42249       resource-version:
42250         type: string
42251         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42252       esr-system-info-list:
42253         type: object
42254         $ref: "#/definitions/esr-system-info-list"
42255       relationship-list:
42256         type: object
42257         $ref: "#/definitions/relationship-list"
42258   esr-vnfm-list:
42259     properties:
42260       esr-vnfm:
42261         type: array
42262         items:
42263           $ref: "#/definitions/esr-vnfm"
42264   evc:
42265     description: |
42266       evc object is an optional child object of the Configuration object.
42267       ###### Related Nodes
42268       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
42269
42270       -(4) IF this TO node is deleted, this EVC is DELETED also
42271     required:
42272     - evc-id
42273     properties:
42274       evc-id:
42275         type: string
42276         description: Unique/key field for the evc object
42277       forwarding-path-topology:
42278         type: string
42279         description: Point-to-Point, Multi-Point
42280       cir-value:
42281         type: string
42282         description: Commited Information Rate
42283       cir-units:
42284         type: string
42285         description: CIR units
42286       connection-diversity-group-id:
42287         type: string
42288         description: Diversity Group ID
42289       service-hours:
42290         type: string
42291         description: formerly Performance Group
42292       esp-evc-circuit-id:
42293         type: string
42294         description: EVC Circuit ID of ESP EVC
42295       esp-evc-cir-value:
42296         type: string
42297         description: Committed Information Rate (For ESP)
42298       esp-evc-cir-units:
42299         type: string
42300         description: CIR units (For ESP)
42301       esp-itu-code:
42302         type: string
42303         description: Identifies ESP
42304       collector-pop-clli:
42305         type: string
42306         description: Collector POP CLLI (from the hostname of the access pnf)
42307       inter-connect-type-ingress:
42308         type: string
42309         description: Interconnect type on ingress side of EVC.
42310       tagmode-access-ingress:
42311         type: string
42312         description: tagode for collector side of EVC
42313       tagmode-access-egress:
42314         type: string
42315         description: tagMode for network side of EVC
42316       relationship-list:
42317         type: array
42318         items:
42319           $ref: "#/definitions/relationship"
42320       resource-version:
42321         type: string
42322         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42323   evcs:
42324     properties:
42325       evc:
42326         type: array
42327         items:
42328           $ref: "#/definitions/evc"
42329   external-system:
42330     description: |
42331       Namespace for external system.
42332     properties:
42333       esr-ems-list:
42334         type: object
42335         $ref: "#/definitions/esr-ems-list"
42336       esr-vnfm-list:
42337         type: object
42338         $ref: "#/definitions/esr-vnfm-list"
42339       esr-thirdparty-sdnc-list:
42340         type: object
42341         $ref: "#/definitions/esr-thirdparty-sdnc-list"
42342   extra-properties:
42343     description: |
42344       Extra properties for inventory item for response list
42345     properties:
42346       extra-property:
42347         type: array
42348         items:
42349           $ref: "#/definitions/extra-property"
42350   extra-property:
42351     properties:
42352       property-name:
42353         type: string
42354       property-value:
42355         type: string
42356   flavor:
42357     description: |
42358       Openstack flavor.
42359       ###### Related Nodes
42360       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
42361       - FROM vserver( vserver Uses flavor, MANY2ONE)
42362
42363       -FLAVOR cannot be deleted if related to VSERVER
42364
42365     required:
42366     - flavor-id
42367     - flavor-name
42368     - flavor-selflink
42369     properties:
42370       flavor-id:
42371         type: string
42372         description: Flavor id, expected to be unique across cloud-region.
42373       flavor-name:
42374         type: string
42375         description: Flavor name
42376       flavor-vcpus:
42377         type: integer
42378         format: int32
42379         description: Number of CPUs
42380       flavor-ram:
42381         type: integer
42382         format: int32
42383         description: Amount of memory
42384       flavor-disk:
42385         type: integer
42386         format: int32
42387         description: Disk space
42388       flavor-ephemeral:
42389         type: integer
42390         format: int32
42391         description: Amount of ephemeral disk space
42392       flavor-swap:
42393         type: string
42394         description: amount of swap space allocation
42395       flavor-is-public:
42396         type: boolean
42397         description: whether flavor is available to all users or private to the tenant it was created in.
42398       flavor-selflink:
42399         type: string
42400         description: URL to endpoint where AAI can get more details
42401       flavor-disabled:
42402         type: boolean
42403         description: Boolean as to whether this flavor is no longer enabled
42404       resource-version:
42405         type: string
42406         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42407       relationship-list:
42408         type: array
42409         items:
42410           $ref: "#/definitions/relationship"
42411   flavors:
42412     description: |
42413       Collection of openstack flavors.
42414     properties:
42415       flavor:
42416         type: array
42417         items:
42418           $ref: "#/definitions/flavor"
42419   forwarder:
42420     description: |
42421       Entity describing a sequenced segment of forwarding path
42422       ###### Related Nodes
42423       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
42424       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
42425       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
42426       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
42427       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
42428
42429       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
42430       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
42431     required:
42432     - sequence
42433     properties:
42434       sequence:
42435         type: integer
42436         format: int32
42437         description: Unique ID of this segmentation
42438       forwarder-role:
42439         type: string
42440         description: ingress, intermediate, egress
42441       relationship-list:
42442         type: array
42443         items:
42444           $ref: "#/definitions/relationship"
42445       resource-version:
42446         type: string
42447         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42448   forwarder-evc:
42449     description: |
42450       forwarder object is an optional child object of the Configuration object.
42451       ###### Related Nodes
42452       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
42453
42454       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
42455     required:
42456     - forwarder-evc-id
42457     properties:
42458       forwarder-evc-id:
42459         type: string
42460         description: Key for forwarder-evc object
42461       circuit-id:
42462         type: string
42463         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
42464       ivlan:
42465         type: string
42466         description: Internal VLAN.
42467       svlan:
42468         type: string
42469         description: SVLAN value for ingress of egress forwarder.
42470       cvlan:
42471         type: string
42472         description: CVLAN value for ingress of egress forwarder.
42473       relationship-list:
42474         type: array
42475         items:
42476           $ref: "#/definitions/relationship"
42477       resource-version:
42478         type: string
42479         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42480   forwarder-evcs:
42481     properties:
42482       forwarder-evc:
42483         type: array
42484         items:
42485           $ref: "#/definitions/forwarder-evc"
42486   forwarders:
42487     properties:
42488       forwarder:
42489         type: array
42490         items:
42491           $ref: "#/definitions/forwarder"
42492   forwarding-path:
42493     description: |
42494       Entity that describes the sequenced forwarding path between interfaces of services or resources
42495       ###### Related Nodes
42496       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
42497       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
42498       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
42499
42500       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
42501       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
42502       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
42503     required:
42504     - forwarding-path-id
42505     - forwarding-path-name
42506     properties:
42507       forwarding-path-id:
42508         type: string
42509         description: Unique ID of this FP
42510       forwarding-path-name:
42511         type: string
42512         description: Name of the FP
42513       relationship-list:
42514         type: array
42515         items:
42516           $ref: "#/definitions/relationship"
42517       resource-version:
42518         type: string
42519         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42520       selflink:
42521         type: string
42522         description: the self link for this FP
42523       forwarders:
42524         type: array
42525         items:
42526           $ref: "#/definitions/forwarder"
42527   forwarding-paths:
42528     properties:
42529       forwarding-path:
42530         type: array
42531         items:
42532           $ref: "#/definitions/forwarding-path"
42533   generic-vnf:
42534     description: |
42535       General purpose VNF
42536       ###### Related Nodes
42537       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
42538       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
42539       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
42540       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
42541       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
42542       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
42543       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
42544       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
42545       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
42546       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42547       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
42548       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
42549       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
42550       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
42551       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
42552       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
42553       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
42554       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
42555       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42556       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
42557       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
42558
42559       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
42560     required:
42561     - vnf-id
42562     - vnf-name
42563     - vnf-type
42564     - in-maint
42565     - is-closed-loop-disabled
42566     properties:
42567       vnf-id:
42568         type: string
42569         description: Unique id of VNF.  This is unique across the graph.
42570       vnf-name:
42571         type: string
42572         description: Name of VNF.
42573       vnf-name2:
42574         type: string
42575         description: Alternate name of VNF.
42576       vnf-type:
42577         type: string
42578         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
42579       service-id:
42580         type: string
42581         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42582       regional-resource-zone:
42583         type: string
42584         description: Regional way of organizing pservers, source of truth should define values
42585       prov-status:
42586         type: string
42587         description: Trigger for operational monitoring of this resource by Service Assurance systems.
42588       operational-status:
42589         type: string
42590         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
42591       license-key:
42592         type: string
42593         description: OBSOLETE -  do not use
42594       equipment-role:
42595         type: string
42596         description: Client should send valid enumerated value
42597       orchestration-status:
42598         type: string
42599         description: Orchestration status of this VNF, used by MSO.
42600       heat-stack-id:
42601         type: string
42602         description: Heat stack id corresponding to this instance, managed by MSO
42603       mso-catalog-key:
42604         type: string
42605         description: Corresponds to the SDN-C catalog id used to configure this VCE
42606       management-option:
42607         type: string
42608         description: identifier of managed by company or customer
42609       ipv4-oam-address:
42610         type: string
42611         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
42612       ipv4-loopback0-address:
42613         type: string
42614         description: v4 Loopback0 address
42615       nm-lan-v6-address:
42616         type: string
42617         description: v6 Loopback address
42618       management-v6-address:
42619         type: string
42620         description: v6 management address
42621       vcpu:
42622         type: integer
42623         format: int64
42624         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42625       vcpu-units:
42626         type: string
42627         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
42628       vmemory:
42629         type: integer
42630         format: int64
42631         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42632       vmemory-units:
42633         type: string
42634         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
42635       vdisk:
42636         type: integer
42637         format: int64
42638         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42639       vdisk-units:
42640         type: string
42641         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
42642       in-maint:
42643         type: boolean
42644         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.
42645       is-closed-loop-disabled:
42646         type: boolean
42647         description: used to indicate whether closed loop function is enabled on this node
42648       resource-version:
42649         type: string
42650         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42651       summary-status:
42652         type: string
42653         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
42654       encrypted-access-flag:
42655         type: boolean
42656         description: indicates whether generic-vnf access uses SSH
42657       entitlement-assignment-group-uuid:
42658         type: string
42659         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
42660       entitlement-resource-uuid:
42661         type: string
42662         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
42663       license-assignment-group-uuid:
42664         type: string
42665         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
42666       license-key-uuid:
42667         type: string
42668         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
42669       model-invariant-id:
42670         type: string
42671         description: the ASDC model id for this resource or service model.
42672       model-version-id:
42673         type: string
42674         description: the ASDC model version for this resource or service model.
42675       persona-model-version:
42676         type: string
42677         description: the ASDC model version for this resource or service model.
42678       model-customization-id:
42679         type: string
42680         description: captures the id of all the configuration used to customize the resource for the service.
42681       widget-model-id:
42682         type: string
42683         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42684       widget-model-version:
42685         type: string
42686         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42687       as-number:
42688         type: string
42689         description: as-number of the VNF
42690       regional-resource-subzone:
42691         type: string
42692         description: represents sub zone of the rr plane
42693       nf-type:
42694         type: string
42695         description: Generic description of the type of NF
42696       nf-function:
42697         type: string
42698         description: English description of Network function that the specific VNF deployment is providing
42699       nf-role:
42700         type: string
42701         description: role in the network that this model will be providing
42702       nf-naming-code:
42703         type: string
42704         description: string assigned to this model used for naming purposes
42705       selflink:
42706         type: string
42707         description: Path to the controller object.
42708       relationship-list:
42709         type: array
42710         items:
42711           $ref: "#/definitions/relationship"
42712       l-interfaces:
42713         type: array
42714         items:
42715           $ref: "#/definitions/l-interface"
42716       lag-interfaces:
42717         type: array
42718         items:
42719           $ref: "#/definitions/lag-interface"
42720       vf-modules:
42721         type: array
42722         items:
42723           $ref: "#/definitions/vf-module"
42724       licenses:
42725         type: array
42726         items:
42727           $ref: "#/definitions/license"
42728       entitlements:
42729         type: array
42730         items:
42731           $ref: "#/definitions/entitlement"
42732   generic-vnfs:
42733     description: |
42734       Collection of VNFs
42735     properties:
42736       generic-vnf:
42737         type: array
42738         items:
42739           $ref: "#/definitions/generic-vnf"
42740   group-assignment:
42741     description: |
42742       Openstack group-assignment used to store exclusivity groups (EG).
42743       ###### Related Nodes
42744       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
42745       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
42746       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
42747
42748     required:
42749     - group-id
42750     - group-type
42751     - group-name
42752     properties:
42753       group-id:
42754         type: string
42755         description: Group id, expected to be unique across cloud-region.
42756       group-type:
42757         type: string
42758         description: Group type - the type of group this instance refers to
42759       group-name:
42760         type: string
42761         description: Group name - name assigned to the group
42762       group-description:
42763         type: string
42764         description: Group description - description of the group
42765       resource-version:
42766         type: string
42767         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42768       relationship-list:
42769         type: array
42770         items:
42771           $ref: "#/definitions/relationship"
42772   group-assignments:
42773     description: |
42774       Collection of openstack group assignments
42775     properties:
42776       group-assignment:
42777         type: array
42778         items:
42779           $ref: "#/definitions/group-assignment"
42780   host-route:
42781     description: |
42782       ###### Related Nodes
42783       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
42784
42785       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
42786     required:
42787     - host-route-id
42788     - route-prefix
42789     - next-hop
42790     properties:
42791       host-route-id:
42792         type: string
42793         description: host-route id
42794       route-prefix:
42795         type: string
42796         description: subnet prefix
42797       next-hop:
42798         type: string
42799         description: Could be ip-address, hostname, or service-instance
42800       next-hop-type:
42801         type: string
42802         description: Should be ip-address, hostname, or service-instance to match next-hop
42803       resource-version:
42804         type: string
42805         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42806       relationship-list:
42807         type: array
42808         items:
42809           $ref: "#/definitions/relationship"
42810   host-routes:
42811     properties:
42812       host-route:
42813         type: array
42814         items:
42815           $ref: "#/definitions/host-route"
42816   hpa-capabilities:
42817     description: |
42818       Collection of HPA Capabilities
42819     properties:
42820       hpa-capability:
42821         type: array
42822         items:
42823           $ref: "#/definitions/hpa-capability"
42824   hpa-capability:
42825     description: |
42826       Represents a HPA capability
42827       ###### Related Nodes
42828       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
42829       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
42830       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
42831
42832       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
42833     required:
42834     - hpa-capability-id
42835     - hpa-feature
42836     properties:
42837       hpa-capability-id:
42838         type: string
42839         description: UUID to uniquely identify a HPA capability
42840       hpa-feature:
42841         type: string
42842         description: Name of the HPACapability
42843       hpa-version:
42844         type: string
42845         description: HPA schema version
42846       architecture:
42847         type: string
42848         description: Hardware architecture
42849       resource-version:
42850         type: string
42851         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42852       relationship-list:
42853         type: array
42854         items:
42855           $ref: "#/definitions/relationship"
42856       hpa-feature-attributes:
42857         type: array
42858         items:
42859           $ref: "#/definitions/hpa-feature-attributes"
42860   hpa-feature-attributes:
42861     description: |
42862       HPA Capability Feature attributes
42863       ###### Related Nodes
42864       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
42865
42866       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
42867     required:
42868     - hpa-attribute-key
42869     properties:
42870       hpa-attribute-key:
42871         type: string
42872         description: name of the specific HPA attribute
42873       hpa-attribute-value:
42874         type: string
42875         description: JSON string specifying the value, unit and type of the specific HPA attribute
42876       resource-version:
42877         type: string
42878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42879       relationship-list:
42880         type: array
42881         items:
42882           $ref: "#/definitions/relationship"
42883   image:
42884     description: |
42885       Openstack image.
42886       ###### Related Nodes
42887       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
42888       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
42889       - FROM vserver( vserver Uses image, MANY2ONE)
42890
42891       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
42892       -IMAGE cannot be deleted if related to VSERVER
42893
42894     required:
42895     - image-id
42896     - image-name
42897     - image-os-distro
42898     - image-os-version
42899     - image-selflink
42900     properties:
42901       image-id:
42902         type: string
42903         description: Image id, expected to be unique across cloud region
42904       image-name:
42905         type: string
42906         description: Image name
42907       image-architecture:
42908         type: string
42909         description: Operating system architecture.
42910       image-os-distro:
42911         type: string
42912         description: The common name of the operating system distribution in lowercase
42913       image-os-version:
42914         type: string
42915         description: The operating system version as specified by the distributor.
42916       application:
42917         type: string
42918         description: The application that the image instantiates.
42919       application-vendor:
42920         type: string
42921         description: The vendor of the application.
42922       application-version:
42923         type: string
42924         description: The version of the application.
42925       image-selflink:
42926         type: string
42927         description: URL to endpoint where AAI can get more details
42928       resource-version:
42929         type: string
42930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42931       relationship-list:
42932         type: array
42933         items:
42934           $ref: "#/definitions/relationship"
42935       metadata:
42936         type: array
42937         items:
42938           $ref: "#/definitions/metadatum"
42939   images:
42940     description: |
42941       Collectio of Openstack images.
42942     properties:
42943       image:
42944         type: array
42945         items:
42946           $ref: "#/definitions/image"
42947   include-node-filter:
42948     properties:
42949       include-node-type:
42950         type: string
42951   instance-filter:
42952     description: |
42953       InstanceFilter for performing a named-query or model query
42954   instance-filters:
42955     description: |
42956       InstanceFilters for performing a named-query or model query
42957     properties:
42958       instance-filter:
42959         type: array
42960         items:
42961           $ref: "#/definitions/instance-filter"
42962   instance-group:
42963     description: |
42964       General mechanism for grouping instances
42965       ###### Related Nodes
42966       - TO model( instance-group Targets model, MANY2MANY)
42967       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
42968       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
42969       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
42970       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
42971       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
42972       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
42973       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
42974
42975     required:
42976     - id
42977     - description
42978     - type
42979     properties:
42980       id:
42981         type: string
42982         description: Instance Group ID, UUID assigned to this instance.
42983       description:
42984         type: string
42985         description: Descriptive text to help identify the usage of this instance-group
42986       type:
42987         type: string
42988         description: Only valid value today is lower case ha for high availability
42989       sub-type:
42990         type: string
42991         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
42992       resource-version:
42993         type: string
42994         description: Concurrency value
42995       relationship-list:
42996         type: array
42997         items:
42998           $ref: "#/definitions/relationship"
42999   instance-groups:
43000     description: |
43001       Collection of openstack route table references
43002     properties:
43003       instance-group:
43004         type: array
43005         items:
43006           $ref: "#/definitions/instance-group"
43007   inventory:
43008     properties:
43009       search:
43010         type: object
43011         $ref: "#/definitions/search"
43012       actions:
43013         type: object
43014         $ref: "#/definitions/actions"
43015       cloud-infrastructure:
43016         type: object
43017         $ref: "#/definitions/cloud-infrastructure"
43018       business:
43019         type: object
43020         $ref: "#/definitions/business"
43021       service-design-and-creation:
43022         type: object
43023         $ref: "#/definitions/service-design-and-creation"
43024       network:
43025         type: object
43026         $ref: "#/definitions/network"
43027       nodes:
43028         type: object
43029         $ref: "#/definitions/nodes"
43030   inventory-item:
43031     properties:
43032       inventory-item-type:
43033         type: string
43034       inventory-item-link:
43035         type: string
43036       inventory-item-data:
43037         type: array
43038         items:
43039           $ref: "#/definitions/inventory-item-data"
43040       tagged-inventory-item-list:
43041         type: array
43042         items:
43043           $ref: "#/definitions/tagged-inventory-item-list"
43044   inventory-item-data:
43045     properties:
43046       property-name:
43047         type: string
43048       property-value:
43049         type: string
43050   inventory-response-item:
43051     description: |
43052       Inventory item for response list
43053     properties:
43054       model-name:
43055         type: string
43056       extra-properties:
43057         type: object
43058         $ref: "#/definitions/extra-properties"
43059       inventory-response-items:
43060         type: object
43061         $ref: "#/definitions/inventory-response-items"
43062   inventory-response-items:
43063     description: |
43064       Container for inventory items in response list
43065     properties:
43066       inventory-response-item:
43067         type: array
43068         items:
43069           $ref: "#/definitions/inventory-response-item"
43070   ipsec-configuration:
43071     description: |
43072       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
43073       ###### Related Nodes
43074       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
43075       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
43076
43077       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
43078     required:
43079     - ipsec-configuration-id
43080     properties:
43081       ipsec-configuration-id:
43082         type: string
43083         description: UUID of this configuration
43084       requested-vig-address-type:
43085         type: string
43086         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
43087       requested-encryption-strength:
43088         type: string
43089         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
43090       requested-dmz-type:
43091         type: string
43092         description: can offer a shared DMZ or a DMZ specific to a customer
43093       shared-dmz-network-address:
43094         type: string
43095         description: Network address of shared DMZ
43096       requested-customer-name:
43097         type: string
43098         description: If the DMZ is a custom DMZ, this field will indicate the customer information
43099       ike-version:
43100         type: string
43101         description: can be 1 or 2
43102       ikev1-authentication:
43103         type: string
43104         description: Contains values like md5, sha1, sha256, sha384
43105       ikev1-encryption:
43106         type: string
43107         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
43108       ikev1-dh-group:
43109         type: string
43110         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
43111       ikev1-am-group-id:
43112         type: string
43113         description: Group name defined in VIG for clients using aggressive mode
43114       ikev1-am-password:
43115         type: string
43116         description: pre-shared key for the above group name
43117       ikev1-sa-lifetime:
43118         type: string
43119         description: Lifetime for IKEv1 SA
43120       ipsec-authentication:
43121         type: string
43122         description: md5, sha1, sha256, sha384
43123       ipsec-encryption:
43124         type: string
43125         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
43126       ipsec-sa-lifetime:
43127         type: string
43128         description: Life time for IPSec SA
43129       ipsec-pfs:
43130         type: string
43131         description: enable PFS or not
43132       xauth-userid:
43133         type: string
43134         description: user ID for xAuth, sm-user, ,nmteHostName
43135       xauth-user-password:
43136         type: string
43137         description: Encrypted using the Juniper $9$ algorithm
43138       dpd-interval:
43139         type: string
43140         description: The time between DPD probe
43141       dpd-frequency:
43142         type: string
43143         description: Maximum number of DPD before claiming the tunnel is down
43144       resource-version:
43145         type: string
43146         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43147       relationship-list:
43148         type: array
43149         items:
43150           $ref: "#/definitions/relationship"
43151       vig-servers:
43152         type: array
43153         items:
43154           $ref: "#/definitions/vig-server"
43155   ipsec-configurations:
43156     properties:
43157       ipsec-configuration:
43158         type: array
43159         items:
43160           $ref: "#/definitions/ipsec-configuration"
43161   key-data:
43162     properties:
43163       key-name:
43164         type: string
43165       key-value:
43166         type: string
43167   l-interface:
43168     description: |
43169       Logical interfaces, e.g., a vnic.
43170       ###### Related Nodes
43171       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
43172       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
43173       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
43174       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
43175       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
43176       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
43177       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
43178       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
43179       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
43180       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
43181       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
43182       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
43183       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
43184
43185       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
43186       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
43187       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
43188     required:
43189     - interface-name
43190     - is-port-mirrored
43191     - in-maint
43192     properties:
43193       interface-name:
43194         type: string
43195         description: Name given to the interface
43196       interface-role:
43197         type: string
43198         description: E.g., CUSTOMER, UPLINK, etc.
43199       v6-wan-link-ip:
43200         type: string
43201         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
43202       selflink:
43203         type: string
43204         description: URL to endpoint where AAI can get more details
43205       interface-id:
43206         type: string
43207         description: ID of interface
43208       macaddr:
43209         type: string
43210         description: MAC address for the interface
43211       network-name:
43212         type: string
43213         description: Name of the network
43214       management-option:
43215         type: string
43216         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
43217       interface-description:
43218         type: string
43219         description: Human friendly text regarding this interface.
43220       is-port-mirrored:
43221         type: boolean
43222         description: boolean indicatating whether or not port is a mirrored.
43223       resource-version:
43224         type: string
43225         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43226       in-maint:
43227         type: boolean
43228         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43229       vlans:
43230         type: array
43231         items:
43232           $ref: "#/definitions/vlan"
43233       sriov-vfs:
43234         type: array
43235         items:
43236           $ref: "#/definitions/sriov-vf"
43237       l-interfaces:
43238         type: array
43239         items:
43240           $ref: "#/definitions/l-interface"
43241       relationship-list:
43242         type: array
43243         items:
43244           $ref: "#/definitions/relationship"
43245       l3-interface-ipv4-address-list:
43246         type: array
43247         items:
43248           $ref: "#/definitions/l3-interface-ipv4-address-list"
43249       l3-interface-ipv6-address-list:
43250         type: array
43251         items:
43252           $ref: "#/definitions/l3-interface-ipv6-address-list"
43253   l-interfaces:
43254     description: |
43255       Collection of logical interfaces.
43256     properties:
43257       l-interface:
43258         type: array
43259         items:
43260           $ref: "#/definitions/l-interface"
43261   l3-interface-ipv4-address-list:
43262     description: |
43263       IPv4 Address Range
43264       ###### Related Nodes
43265       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
43266       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43267       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
43268       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
43269       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
43270
43271       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
43272     required:
43273     - l3-interface-ipv4-address
43274     properties:
43275       l3-interface-ipv4-address:
43276         type: string
43277         description: IP address
43278       l3-interface-ipv4-prefix-length:
43279         type: integer
43280         format: int64
43281         description: Prefix length, 32 for single address
43282       vlan-id-inner:
43283         type: integer
43284         format: int64
43285         description: Inner VLAN tag
43286       vlan-id-outer:
43287         type: integer
43288         format: int64
43289         description: Outer VLAN tag
43290       is-floating:
43291         type: boolean
43292         description: Indicator of fixed or floating address
43293       resource-version:
43294         type: string
43295         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43296       neutron-network-id:
43297         type: string
43298         description: Neutron network id of the interface that address belongs to
43299       neutron-subnet-id:
43300         type: string
43301         description: Neutron id of subnet that address belongs to
43302       relationship-list:
43303         type: array
43304         items:
43305           $ref: "#/definitions/relationship"
43306   l3-interface-ipv6-address-list:
43307     description: |
43308       IPv6 Address Range
43309       ###### Related Nodes
43310       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
43311       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43312       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
43313       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
43314       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
43315
43316       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
43317     required:
43318     - l3-interface-ipv6-address
43319     properties:
43320       l3-interface-ipv6-address:
43321         type: string
43322         description: IP address
43323       l3-interface-ipv6-prefix-length:
43324         type: integer
43325         format: int64
43326         description: Prefix length, 128 for single address
43327       vlan-id-inner:
43328         type: integer
43329         format: int64
43330         description: Inner VLAN tag
43331       vlan-id-outer:
43332         type: integer
43333         format: int64
43334         description: Outer VLAN tag
43335       is-floating:
43336         type: boolean
43337         description: Indicator of fixed or floating address
43338       resource-version:
43339         type: string
43340         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43341       neutron-network-id:
43342         type: string
43343         description: Neutron network id of the interface that address belongs to
43344       neutron-subnet-id:
43345         type: string
43346         description: Neutron id of subnet that address belongs to
43347       relationship-list:
43348         type: array
43349         items:
43350           $ref: "#/definitions/relationship"
43351   l3-network:
43352     description: |
43353       Generic network definition
43354       ###### Related Nodes
43355       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
43356       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
43357       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
43358       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
43359       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
43360       - FROM complex( complex Uses l3-network, MANY2MANY)
43361       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
43362       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43363       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43364       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
43365       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
43366       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
43367       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
43368       - FROM tenant( tenant Uses l3-network, MANY2MANY)
43369       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
43370
43371       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
43372     required:
43373     - network-id
43374     - network-name
43375     - is-bound-to-vpn
43376     - is-provider-network
43377     - is-shared-network
43378     - is-external-network
43379     properties:
43380       network-id:
43381         type: string
43382         description: Network ID, should be uuid. Unique across A&AI.
43383       network-name:
43384         type: string
43385         description: Name of the network, governed by some naming convention..
43386       network-type:
43387         type: string
43388         description: Type of the network - who defines these values?
43389       network-role:
43390         type: string
43391         description: Role the network plans - who defines these values?
43392       network-technology:
43393         type: string
43394         description: Network technology - who defines these values?
43395       neutron-network-id:
43396         type: string
43397         description: Neutron network id of this Interface
43398       is-bound-to-vpn:
43399         type: boolean
43400         description: Set to true if bound to VPN
43401       service-id:
43402         type: string
43403         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
43404       network-role-instance:
43405         type: integer
43406         format: int64
43407         description: network role instance
43408       resource-version:
43409         type: string
43410         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43411       orchestration-status:
43412         type: string
43413         description: Orchestration status of this VNF, mastered by MSO
43414       heat-stack-id:
43415         type: string
43416         description: Heat stack id corresponding to this instance, managed by MSO
43417       mso-catalog-key:
43418         type: string
43419         description: Corresponds to the SDN-C catalog id used to configure this VCE
43420       contrail-network-fqdn:
43421         type: string
43422         description: Contrail FQDN for the network
43423       model-invariant-id:
43424         type: string
43425         description: the ASDC model id for this resource or service model.
43426       model-version-id:
43427         type: string
43428         description: the ASDC model version for this resource or service model.
43429       persona-model-version:
43430         type: string
43431         description: the ASDC model version for this resource or service model.
43432       model-customization-id:
43433         type: string
43434         description: captures the id of all the configuration used to customize the resource for the service.
43435       widget-model-id:
43436         type: string
43437         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43438       widget-model-version:
43439         type: string
43440         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43441       physical-network-name:
43442         type: string
43443         description: Name associated with the physical network.
43444       is-provider-network:
43445         type: boolean
43446         description: boolean indicatating whether or not network is a provider network.
43447       is-shared-network:
43448         type: boolean
43449         description: boolean indicatating whether or not network is a shared network.
43450       is-external-network:
43451         type: boolean
43452         description: boolean indicatating whether or not network is an external network.
43453       selflink:
43454         type: string
43455         description: Path to the controller object.
43456       operational-status:
43457         type: string
43458         description: Indicator for whether the resource is considered operational.
43459       subnets:
43460         type: array
43461         items:
43462           $ref: "#/definitions/subnet"
43463       ctag-assignments:
43464         type: array
43465         items:
43466           $ref: "#/definitions/ctag-assignment"
43467       segmentation-assignments:
43468         type: array
43469         items:
43470           $ref: "#/definitions/segmentation-assignment"
43471       relationship-list:
43472         type: array
43473         items:
43474           $ref: "#/definitions/relationship"
43475         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
43476   l3-networks:
43477     properties:
43478       l3-network:
43479         type: array
43480         items:
43481           $ref: "#/definitions/l3-network"
43482   lag-interface:
43483     description: |
43484       Link aggregate interface
43485       ###### Related Nodes
43486       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
43487       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
43488       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
43489       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
43490       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
43491       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
43492       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
43493       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
43494
43495       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
43496       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
43497       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
43498     required:
43499     - interface-name
43500     - in-maint
43501     properties:
43502       interface-name:
43503         type: string
43504         description: Name that identifies the link aggregate interface
43505       interface-description:
43506         type: string
43507         description: Human friendly text regarding this interface.
43508       resource-version:
43509         type: string
43510         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43511       speed-value:
43512         type: string
43513         description: Captures the numeric part of the speed
43514       speed-units:
43515         type: string
43516         description: Captures the units corresponding to the speed
43517       interface-id:
43518         type: string
43519         description: ID of interface
43520       interface-role:
43521         type: string
43522         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43523       prov-status:
43524         type: string
43525         description: Trigger for operational monitoring of this resource by Service Assurance systems.
43526       in-maint:
43527         type: boolean
43528         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43529       relationship-list:
43530         type: array
43531         items:
43532           $ref: "#/definitions/relationship"
43533       l-interfaces:
43534         type: array
43535         items:
43536           $ref: "#/definitions/l-interface"
43537   lag-interfaces:
43538     description: |
43539       Collection of link aggregate interfaces.
43540     properties:
43541       lag-interface:
43542         type: array
43543         items:
43544           $ref: "#/definitions/lag-interface"
43545   lag-link:
43546     description: |
43547       LAG links can connect lag-interfaces
43548       ###### Related Nodes
43549       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
43550       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
43551
43552       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
43553     required:
43554     - link-name
43555     properties:
43556       link-name:
43557         type: string
43558         description: Alphabetical concatenation of lag-interface names
43559       resource-version:
43560         type: string
43561         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43562       relationship-list:
43563         type: array
43564         items:
43565           $ref: "#/definitions/relationship"
43566   lag-links:
43567     description: |
43568       Collection of link aggregation connections
43569     properties:
43570       lag-link:
43571         type: array
43572         items:
43573           $ref: "#/definitions/lag-link"
43574   license:
43575     description: |
43576       Metadata for license group.
43577       ###### Related Nodes
43578       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
43579       - TO vce( license BelongsTo vce, MANY2ONE)(4)
43580
43581       -(4) IF this TO node is deleted, this LICENSE is DELETED also
43582     required:
43583     - group-uuid
43584     - resource-uuid
43585     properties:
43586       group-uuid:
43587         type: string
43588         description: Unique ID for the license group the resource belongs to, should be uuid.
43589       resource-uuid:
43590         type: string
43591         description: Unique ID of a license resource.
43592       resource-version:
43593         type: string
43594         description: Concurrency value
43595       relationship-list:
43596         type: array
43597         items:
43598           $ref: "#/definitions/relationship"
43599   licenses:
43600     description: |
43601       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
43602     properties:
43603       license:
43604         type: array
43605         items:
43606           $ref: "#/definitions/license"
43607   line-of-business:
43608     description: |
43609       describes a line-of-business
43610       ###### Related Nodes
43611       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
43612
43613     required:
43614     - line-of-business-name
43615     properties:
43616       line-of-business-name:
43617         type: string
43618         description: Name of the line-of-business (product)
43619       resource-version:
43620         type: string
43621         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43622       relationship-list:
43623         type: array
43624         items:
43625           $ref: "#/definitions/relationship"
43626   lines-of-business:
43627     description: |
43628       Collection of lines-of-business
43629     properties:
43630       line-of-business:
43631         type: array
43632         items:
43633           $ref: "#/definitions/line-of-business"
43634   logical-link:
43635     description: |
43636       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
43637       ###### Related Nodes
43638       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
43639       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
43640       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
43641       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
43642       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
43643       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
43644       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
43645       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
43646       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
43647       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
43648       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
43649       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
43650       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
43651       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
43652
43653       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
43654     required:
43655     - link-name
43656     - link-type
43657     properties:
43658       link-name:
43659         type: string
43660         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
43661       link-type:
43662         type: string
43663         description: Type of logical link, e.g., evc
43664       speed-value:
43665         type: string
43666         description: Captures the numeric part of the speed
43667       speed-units:
43668         type: string
43669         description: Captures the units corresponding to the speed
43670       ip-version:
43671         type: string
43672         description: v4, v6, or ds for dual stack
43673       routing-protocol:
43674         type: string
43675         description: For example, static or BGP
43676       resource-version:
43677         type: string
43678         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43679       model-invariant-id:
43680         type: string
43681         description: the ASDC model id for this resource or service model.
43682       model-version-id:
43683         type: string
43684         description: the ASDC model version for this resource or service model.
43685       persona-model-version:
43686         type: string
43687         description: the ASDC model version for this resource or service model.
43688       widget-model-id:
43689         type: string
43690         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43691       widget-model-version:
43692         type: string
43693         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43694       operational-status:
43695         type: string
43696         description: Indication of operational status of the logical link.
43697       prov-status:
43698         type: string
43699         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43700       link-role:
43701         type: string
43702         description: Indication of the network use of the logical link.
43703       link-name2:
43704         type: string
43705         description: Alias or alternate name (CLCI or D1 name).
43706       link-id:
43707         type: string
43708         description: UUID of the logical-link, SDNC generates this.
43709       circuit-id:
43710         type: string
43711         description: Circuit id
43712       purpose:
43713         type: string
43714         description: Reason for this entity, role it is playing
43715       relationship-list:
43716         type: array
43717         items:
43718           $ref: "#/definitions/relationship"
43719   logical-links:
43720     description: |
43721       Collection of logical connections
43722     properties:
43723       logical-link:
43724         type: array
43725         items:
43726           $ref: "#/definitions/logical-link"
43727   metadata:
43728     description: |
43729       Collection of metadatum (key/value pairs)
43730     properties:
43731       metadatum:
43732         type: array
43733         items:
43734           $ref: "#/definitions/metadatum"
43735   metadatum:
43736     description: |
43737       Key/value pairs
43738       ###### Related Nodes
43739       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
43740       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
43741       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
43742       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
43743
43744       -(4) IF this TO node is deleted, this METADATUM is DELETED also
43745     required:
43746     - metaname
43747     - metaval
43748     properties:
43749       metaname:
43750         type: string
43751       metaval:
43752         type: string
43753       resource-version:
43754         type: string
43755         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43756   model:
43757     description: |
43758       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
43759       ###### Related Nodes
43760       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
43761       - FROM instance-group( instance-group Targets model, MANY2MANY)
43762       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
43763       - FROM named-query( named-query AppliesTo model, ONE2MANY)
43764       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
43765
43766       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
43767       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
43768
43769     required:
43770     - model-invariant-id
43771     - model-type
43772     properties:
43773       model-invariant-id:
43774         type: string
43775         description: Unique identifier corresponding to the main definition of a model in ASDC
43776       model-type:
43777         type: string
43778         description: Type of the model, e.g., service, resource, widget, etc.
43779       resource-version:
43780         type: string
43781         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43782       model-vers:
43783         type: array
43784         items:
43785           $ref: "#/definitions/model-ver"
43786       relationship-list:
43787         type: array
43788         items:
43789           $ref: "#/definitions/relationship"
43790   model-and-named-query-search:
43791     description: |
43792       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
43793     properties:
43794       query-parameters:
43795         type: object
43796         $ref: "#/definitions/query-parameters"
43797       instance-filters:
43798         type: object
43799         $ref: "#/definitions/instance-filters"
43800       secondary-filts:
43801         type: object
43802         $ref: "#/definitions/secondary-filts"
43803       top-node-type:
43804         type: string
43805       secondary-filter-cut-point:
43806         type: string
43807   model-constraint:
43808     description: |
43809       This is how we would capture constraints defining allowed sets of elements.
43810       ###### Related Nodes
43811       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
43812       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
43813
43814       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
43815       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
43816     required:
43817     - model-constraint-uuid
43818     - constrained-element-set-uuid-to-replace
43819     properties:
43820       model-constraint-uuid:
43821         type: string
43822       constrained-element-set-uuid-to-replace:
43823         type: string
43824       constrained-element-sets:
43825         type: array
43826         items:
43827           $ref: "#/definitions/constrained-element-set"
43828       resource-version:
43829         type: string
43830         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43831   model-constraints:
43832     properties:
43833       model-constraint:
43834         type: array
43835         items:
43836           $ref: "#/definitions/model-constraint"
43837   model-element:
43838     description: |
43839       Defines how other models combine to make up a higher-level model.
43840       ###### Related Nodes
43841       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
43842       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43843       - TO model-ver( model-element IsA model-ver, MANY2ONE)
43844       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
43845       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
43846       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
43847       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43848
43849       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
43850       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
43851     required:
43852     - model-element-uuid
43853     - new-data-del-flag
43854     - cardinality
43855     properties:
43856       model-element-uuid:
43857         type: string
43858       new-data-del-flag:
43859         type: string
43860         description: Indicates whether this element was created as part of instantiation from this model
43861       cardinality:
43862         type: string
43863         description: How many of this type of element are required/allowed
43864       linkage-points:
43865         type: string
43866       resource-version:
43867         type: string
43868         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43869       model-elements:
43870         type: array
43871         items:
43872           $ref: "#/definitions/model-element"
43873         description: Defines how other models combine to make up a higher-level model
43874       model-constraints:
43875         type: array
43876         items:
43877           $ref: "#/definitions/model-constraint"
43878         description: Describes new constraints on this model element that are not part of that model's definition
43879       relationship-list:
43880         type: array
43881         items:
43882           $ref: "#/definitions/relationship"
43883   model-elements:
43884     properties:
43885       model-element:
43886         type: array
43887         items:
43888           $ref: "#/definitions/model-element"
43889   model-ver:
43890     description: |
43891       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
43892       ###### Related Nodes
43893       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
43894       - FROM model-element( model-element IsA model-ver, MANY2ONE)
43895       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
43896       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
43897
43898       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
43899       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
43900       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
43901
43902     required:
43903     - model-version-id
43904     - model-name
43905     - model-version
43906     properties:
43907       model-version-id:
43908         type: string
43909         description: Unique identifier corresponding to one version of a model in ASDC
43910       model-name:
43911         type: string
43912         description: Name of the model, which can change from version to version.
43913       model-version:
43914         type: string
43915         description: Version
43916       model-description:
43917         type: string
43918         description: Description
43919       resource-version:
43920         type: string
43921         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43922       model-elements:
43923         type: array
43924         items:
43925           $ref: "#/definitions/model-element"
43926       metadata:
43927         type: array
43928         items:
43929           $ref: "#/definitions/metadatum"
43930       relationship-list:
43931         type: array
43932         items:
43933           $ref: "#/definitions/relationship"
43934   model-vers:
43935     properties:
43936       model-ver:
43937         type: array
43938         items:
43939           $ref: "#/definitions/model-ver"
43940   models:
43941     description: |
43942       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
43943     properties:
43944       model:
43945         type: array
43946         items:
43947           $ref: "#/definitions/model"
43948   multicast-configuration:
43949     description: |
43950       ###### Related Nodes
43951       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
43952
43953     required:
43954     - multicast-configuration-id
43955     - multicast-protocol
43956     - rp-type
43957     properties:
43958       multicast-configuration-id:
43959         type: string
43960         description: Unique id of multicast configuration.
43961       multicast-protocol:
43962         type: string
43963         description: protocol of multicast configuration
43964       rp-type:
43965         type: string
43966         description: rp type of multicast configuration
43967       resource-version:
43968         type: string
43969         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43970       relationship-list:
43971         type: array
43972         items:
43973           $ref: "#/definitions/relationship"
43974   multicast-configurations:
43975     description: |
43976       multicast configuration of generic-vnf ip-address
43977     properties:
43978       multicast-configuration:
43979         type: array
43980         items:
43981           $ref: "#/definitions/multicast-configuration"
43982   named-queries:
43983     properties:
43984       named-query:
43985         type: array
43986         items:
43987           $ref: "#/definitions/named-query"
43988   named-query:
43989     description: |
43990       TBD
43991       ###### Related Nodes
43992       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
43993       - TO model( named-query AppliesTo model, ONE2MANY)
43994       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
43995
43996       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
43997     required:
43998     - named-query-uuid
43999     - named-query-name
44000     - named-query-version
44001     properties:
44002       named-query-uuid:
44003         type: string
44004       named-query-name:
44005         type: string
44006       named-query-version:
44007         type: string
44008       required-input-param:
44009         type: string
44010       description:
44011         type: string
44012       resource-version:
44013         type: string
44014       named-query-elements:
44015         type: array
44016         items:
44017           $ref: "#/definitions/named-query-element"
44018       relationship-list:
44019         type: array
44020         items:
44021           $ref: "#/definitions/relationship"
44022   named-query-element:
44023     description: |
44024       TBD
44025       ###### Related Nodes
44026       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
44027       - TO model( named-query-element IsA model, MANY2ONE)
44028       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
44029       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
44030       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
44031       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
44032
44033       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
44034       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
44035     required:
44036     - named-query-element-uuid
44037     properties:
44038       named-query-element-uuid:
44039         type: string
44040       property-collect-list:
44041         type: string
44042       resource-version:
44043         type: string
44044       property-limit-desc:
44045         type: string
44046       do-not-output:
44047         type: string
44048       named-query-elements:
44049         type: array
44050         items:
44051           $ref: "#/definitions/named-query-element"
44052       related-lookups:
44053         type: array
44054         items:
44055           $ref: "#/definitions/related-lookup"
44056       property-constraints:
44057         type: array
44058         items:
44059           $ref: "#/definitions/property-constraint"
44060       relationship-list:
44061         type: array
44062         items:
44063           $ref: "#/definitions/relationship"
44064   named-query-elements:
44065     properties:
44066       named-query-element:
44067         type: array
44068         items:
44069           $ref: "#/definitions/named-query-element"
44070   network:
44071     description: |
44072       Namespace for network inventory resources.
44073     properties:
44074       logical-links:
44075         type: array
44076         items:
44077           $ref: "#/definitions/logical-link"
44078       site-pair-sets:
44079         type: array
44080         items:
44081           $ref: "#/definitions/site-pair-set"
44082       vpn-bindings:
44083         type: array
44084         items:
44085           $ref: "#/definitions/vpn-binding"
44086       vpls-pes:
44087         type: array
44088         items:
44089           $ref: "#/definitions/vpls-pe"
44090       multicast-configurations:
44091         type: array
44092         items:
44093           $ref: "#/definitions/multicast-configuration"
44094       vces:
44095         type: array
44096         items:
44097           $ref: "#/definitions/vce"
44098       vnfcs:
44099         type: array
44100         items:
44101           $ref: "#/definitions/vnfc"
44102       l3-networks:
44103         type: array
44104         items:
44105           $ref: "#/definitions/l3-network"
44106       network-policies:
44107         type: array
44108         items:
44109           $ref: "#/definitions/network-policy"
44110       generic-vnfs:
44111         type: array
44112         items:
44113           $ref: "#/definitions/generic-vnf"
44114       lag-links:
44115         type: array
44116         items:
44117           $ref: "#/definitions/lag-link"
44118       newvces:
44119         type: array
44120         items:
44121           $ref: "#/definitions/newvce"
44122       pnfs:
44123         type: array
44124         items:
44125           $ref: "#/definitions/pnf"
44126       physical-links:
44127         type: array
44128         items:
44129           $ref: "#/definitions/physical-link"
44130       ipsec-configurations:
44131         type: array
44132         items:
44133           $ref: "#/definitions/ipsec-configuration"
44134       route-table-references:
44135         type: array
44136         items:
44137           $ref: "#/definitions/route-table-reference"
44138       instance-groups:
44139         type: array
44140         items:
44141           $ref: "#/definitions/instance-group"
44142       zones:
44143         type: array
44144         items:
44145           $ref: "#/definitions/zone"
44146   network-policies:
44147     properties:
44148       network-policy:
44149         type: array
44150         items:
44151           $ref: "#/definitions/network-policy"
44152   network-policy:
44153     description: |
44154       ###### Related Nodes
44155       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
44156       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
44157
44158     required:
44159     - network-policy-id
44160     properties:
44161       network-policy-id:
44162         type: string
44163         description: UUID representing unique key to this instance
44164       network-policy-fqdn:
44165         type: string
44166         description: Contrail FQDN for the policy
44167       heat-stack-id:
44168         type: string
44169         description: ID for the openStack Heat instance
44170       resource-version:
44171         type: string
44172         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44173       relationship-list:
44174         type: array
44175         items:
44176           $ref: "#/definitions/relationship"
44177   network-profile:
44178     description: |
44179       Network profile populated by SDN-GP for SNMP
44180       ###### Related Nodes
44181       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
44182
44183     required:
44184     - nm-profile-name
44185     properties:
44186       nm-profile-name:
44187         type: string
44188         description: Unique name of network profile.
44189       community-string:
44190         type: string
44191         description: Encrypted SNMP community string
44192       resource-version:
44193         type: string
44194         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44195       relationship-list:
44196         type: array
44197         items:
44198           $ref: "#/definitions/relationship"
44199   network-profiles:
44200     description: |
44201       Collection of network profiles
44202     properties:
44203       network-profile:
44204         type: array
44205         items:
44206           $ref: "#/definitions/network-profile"
44207   newvce:
44208     description: |
44209       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
44210       ###### Related Nodes
44211       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
44212
44213       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
44214     required:
44215     - vnf-id2
44216     - vnf-name
44217     - vnf-type
44218     properties:
44219       vnf-id2:
44220         type: string
44221         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44222       vnf-name:
44223         type: string
44224         description: Name of VNF.
44225       vnf-name2:
44226         type: string
44227         description: Alternate name of VNF.
44228       vnf-type:
44229         type: string
44230         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
44231       prov-status:
44232         type: string
44233         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44234       operational-status:
44235         type: string
44236         description: Indicator for whether the resource is considered operational
44237       license-key:
44238         type: string
44239         description: OBSOLETE -  do not use
44240       ipv4-oam-address:
44241         type: string
44242         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).
44243       equipment-role:
44244         type: string
44245         description: Client should send valid enumerated value.
44246       resource-version:
44247         type: string
44248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44249       ipv4-loopback0-address:
44250         type: string
44251         description: v4 Loopback0 address
44252       orchestration-status:
44253         type: string
44254         description: Orchestration status of this VNF, mastered by MSO.
44255       heat-stack-id:
44256         type: string
44257         description: Heat stack id corresponding to this instance, managed by MSO
44258       mso-catalog-key:
44259         type: string
44260         description: Corresponds to the SDN-C catalog id used to configure this VCE
44261       relationship-list:
44262         type: array
44263         items:
44264           $ref: "#/definitions/relationship"
44265       l-interfaces:
44266         type: array
44267         items:
44268           $ref: "#/definitions/l-interface"
44269   newvces:
44270     description: |
44271       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
44272     properties:
44273       newvce:
44274         type: array
44275         items:
44276           $ref: "#/definitions/newvce"
44277   nodes:
44278     properties:
44279       inventory-item-data:
44280         type: array
44281         items:
44282           $ref: "#/definitions/inventory-item-data"
44283   notification-event:
44284     properties:
44285       cambria.partition:
44286         type: string
44287       notification-event-header:
44288         type: object
44289         $ref: "#/definitions/notification-event-header"
44290   notification-event-header:
44291     properties:
44292       id:
44293         type: string
44294       timestamp:
44295         type: string
44296       source-name:
44297         type: string
44298       domain:
44299         type: string
44300       sequence-number:
44301         type: string
44302       severity:
44303         type: string
44304       event-type:
44305         type: string
44306       version:
44307         type: string
44308       action:
44309         type: string
44310       entity-type:
44311         type: string
44312       top-entity-type:
44313         type: string
44314       entity-link:
44315         type: string
44316       status:
44317         type: string
44318   notify:
44319     required:
44320     - event-id
44321     properties:
44322       event-id:
44323         type: string
44324       node-type:
44325         type: string
44326       event-trigger:
44327         type: string
44328       key-data:
44329         type: array
44330         items:
44331           $ref: "#/definitions/key-data"
44332       selflink:
44333         type: string
44334   oam-network:
44335     description: |
44336       OAM network, to be deprecated shortly.  Do not use for new purposes.
44337       ###### Related Nodes
44338       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
44339       - TO complex( oam-network AppliesTo complex, MANY2MANY)
44340       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
44341
44342     required:
44343     - network-uuid
44344     - network-name
44345     - cvlan-tag
44346     properties:
44347       network-uuid:
44348         type: string
44349         description: UUID of the network. Unique across a cloud-region
44350       network-name:
44351         type: string
44352         description: Name of the network.
44353       cvlan-tag:
44354         type: integer
44355         format: int64
44356         description: cvlan-id
44357       ipv4-oam-gateway-address:
44358         type: string
44359         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44360       ipv4-oam-gateway-address-prefix-length:
44361         type: integer
44362         format: int32
44363         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44364       resource-version:
44365         type: string
44366         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44367       relationship-list:
44368         type: array
44369         items:
44370           $ref: "#/definitions/relationship"
44371   oam-networks:
44372     description: |
44373       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
44374     properties:
44375       oam-network:
44376         type: array
44377         items:
44378           $ref: "#/definitions/oam-network"
44379   operational-environment:
44380     description: |
44381       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
44382       ###### Related Nodes
44383       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44384       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44385
44386     required:
44387     - operational-environment-id
44388     - operational-environment-name
44389     - operational-environment-type
44390     - operational-environment-status
44391     - tenant-context
44392     - workload-context
44393     properties:
44394       operational-environment-id:
44395         type: string
44396         description: UUID of an operational environment
44397       operational-environment-name:
44398         type: string
44399         description: Operational Environment name
44400       operational-environment-type:
44401         type: string
44402         description: Operational Environment Type.
44403       operational-environment-status:
44404         type: string
44405         description: Status
44406       tenant-context:
44407         type: string
44408         description: Tenant Context.
44409       workload-context:
44410         type: string
44411         description: Workload Context.
44412       resource-version:
44413         type: string
44414         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44415       relationship-list:
44416         type: array
44417         items:
44418           $ref: "#/definitions/relationship"
44419   operational-environments:
44420     description: |
44421       a logical partition of the cloud which allows to have multiple environments in the production AIC.
44422     properties:
44423       operational-environment:
44424         type: array
44425         items:
44426           $ref: "#/definitions/operational-environment"
44427   overloaded-model:
44428     description: |
44429       Allows for legacy POST of old-style and new-style models
44430     required:
44431     - model-invariant-id
44432     - model-name-version-id
44433     - model-type
44434     - model-name
44435     - model-id
44436     - model-version
44437     properties:
44438       model-invariant-id:
44439         type: string
44440         description: Unique identifier corresponding to the main definition of a model in ASDC
44441       model-name-version-id:
44442         type: string
44443         description: Unique identifier corresponding to one version of a model in ASDC
44444       model-type:
44445         type: string
44446         description: Type of the model, e.g., service, resource, widget, etc.
44447       model-name:
44448         type: string
44449         description: Name of the model, which can change from version to version.
44450       model-id:
44451         type: string
44452         description: Invariant unique ID which does not change from version to version
44453       model-version:
44454         type: string
44455         description: Version
44456       model-description:
44457         type: string
44458         description: Description
44459       resource-version:
44460         type: string
44461         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44462       model-vers:
44463         type: object
44464         $ref: "#/definitions/model-vers"
44465       relationship-list:
44466         type: object
44467         $ref: "#/definitions/relationship-list"
44468   owning-entities:
44469     description: |
44470       Collection of owning-entities
44471     properties:
44472       owning-entity:
44473         type: array
44474         items:
44475           $ref: "#/definitions/owning-entity"
44476   owning-entity:
44477     description: |
44478       describes an owning-entity
44479       ###### Related Nodes
44480       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
44481
44482     required:
44483     - owning-entity-id
44484     - owning-entity-name
44485     properties:
44486       owning-entity-id:
44487         type: string
44488         description: UUID of an owning entity
44489       owning-entity-name:
44490         type: string
44491         description: Owning entity name
44492       resource-version:
44493         type: string
44494         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44495       relationship-list:
44496         type: array
44497         items:
44498           $ref: "#/definitions/relationship"
44499   p-interface:
44500     description: |
44501       Physical interface (e.g., nic)
44502       ###### Related Nodes
44503       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
44504       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
44505       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
44506       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
44507       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
44508       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
44509       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
44510
44511       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
44512       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
44513       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
44514     required:
44515     - interface-name
44516     - in-maint
44517     properties:
44518       interface-name:
44519         type: string
44520         description: Name that identifies the physical interface
44521       speed-value:
44522         type: string
44523         description: Captures the numeric part of the speed
44524       speed-units:
44525         type: string
44526         description: Captures the units corresponding to the speed
44527       port-description:
44528         type: string
44529         description: Nature of the services and connectivity on this port.
44530       equipment-identifier:
44531         type: string
44532         description: CLEI or other specification for p-interface hardware.
44533       interface-role:
44534         type: string
44535         description: Role specification for p-interface hardware.
44536       interface-type:
44537         type: string
44538         description: Indicates the physical properties of the interface.
44539       prov-status:
44540         type: string
44541         description: Trigger for operational monitoring of this resource by Service Assurance systems.
44542       resource-version:
44543         type: string
44544         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44545       in-maint:
44546         type: boolean
44547         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
44548       relationship-list:
44549         type: array
44550         items:
44551           $ref: "#/definitions/relationship"
44552       l-interfaces:
44553         type: array
44554         items:
44555           $ref: "#/definitions/l-interface"
44556   p-interfaces:
44557     description: |
44558       Collection of physical interfaces.
44559     properties:
44560       p-interface:
44561         type: array
44562         items:
44563           $ref: "#/definitions/p-interface"
44564   physical-link:
44565     description: |
44566       Collection of physical connections, typically between p-interfaces
44567       ###### Related Nodes
44568       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
44569
44570       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
44571     required:
44572     - link-name
44573     properties:
44574       link-name:
44575         type: string
44576         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44577       speed-value:
44578         type: string
44579         description: Captures the numeric part of the speed
44580       speed-units:
44581         type: string
44582         description: Captures the units corresponding to the speed
44583       circuit-id:
44584         type: string
44585         description: Circuit it
44586       dual-mode:
44587         type: string
44588         description: Dual access mode (e.g., primary, secondary
44589       management-option:
44590         type: string
44591         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
44592       service-provider-name:
44593         type: string
44594         description: Name of the service Provider on this link.
44595       resource-version:
44596         type: string
44597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44598       relationship-list:
44599         type: array
44600         items:
44601           $ref: "#/definitions/relationship"
44602   physical-links:
44603     description: |
44604       Collection of physical connections, typically between p-interfaces
44605     properties:
44606       physical-link:
44607         type: array
44608         items:
44609           $ref: "#/definitions/physical-link"
44610   platform:
44611     description: |
44612       describes a platform
44613       ###### Related Nodes
44614       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
44615
44616     required:
44617     - platform-name
44618     properties:
44619       platform-name:
44620         type: string
44621         description: Name of the platform
44622       resource-version:
44623         type: string
44624         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44625       relationship-list:
44626         type: array
44627         items:
44628           $ref: "#/definitions/relationship"
44629   platforms:
44630     description: |
44631       Collection of platforms
44632     properties:
44633       platform:
44634         type: array
44635         items:
44636           $ref: "#/definitions/platform"
44637   pnf:
44638     description: |
44639       PNF represents a physical network function. typically equipment used in the D1 world.
44640       ###### Related Nodes
44641       - TO complex( pnf LocatedIn complex, MANY2ONE)
44642       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
44643       - TO zone( pnf LocatedIn zone, MANY2ONE)
44644       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
44645       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
44646       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
44647       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
44648
44649       -(1) IF this PNF node is deleted, this FROM node is DELETED also
44650     required:
44651     - pnf-name
44652     - in-maint
44653     properties:
44654       pnf-name:
44655         type: string
44656         description: unique name of Physical Network Function.
44657       pnf-name2:
44658         type: string
44659         description: name of Physical Network Function.
44660       pnf-name2-source:
44661         type: string
44662         description: source of name2
44663       pnf-id:
44664         type: string
44665         description: id of pnf
44666       equip-type:
44667         type: string
44668         description: Equipment type.  Source of truth should define valid values.
44669       equip-vendor:
44670         type: string
44671         description: Equipment vendor.  Source of truth should define valid values.
44672       equip-model:
44673         type: string
44674         description: Equipment model.  Source of truth should define valid values.
44675       management-option:
44676         type: string
44677         description: identifier of managed by company or customer
44678       ipaddress-v4-oam:
44679         type: string
44680         description: ipv4-oam-address with new naming convention for IP addresses
44681       sw-version:
44682         type: string
44683         description: sw-version is the version of SW for the hosted application on the PNF.
44684       in-maint:
44685         type: boolean
44686         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.
44687       frame-id:
44688         type: string
44689         description: ID of the physical frame (relay rack) where pnf is installed.
44690       serial-number:
44691         type: string
44692         description: Serial number of the device
44693       ipaddress-v4-loopback-0:
44694         type: string
44695         description: IPV4 Loopback 0 address
44696       ipaddress-v6-loopback-0:
44697         type: string
44698         description: IPV6 Loopback 0 address
44699       ipaddress-v4-aim:
44700         type: string
44701         description: IPV4 AIM address
44702       ipaddress-v6-aim:
44703         type: string
44704         description: IPV6 AIM address
44705       ipaddress-v6-oam:
44706         type: string
44707         description: IPV6 OAM address
44708       inv-status:
44709         type: string
44710         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44711       resource-version:
44712         type: string
44713         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44714       prov-status:
44715         type: string
44716         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44717       nf-role:
44718         type: string
44719         description: Nf Role is the role performed by this instance in the network.
44720       relationship-list:
44721         type: array
44722         items:
44723           $ref: "#/definitions/relationship"
44724       p-interfaces:
44725         type: array
44726         items:
44727           $ref: "#/definitions/p-interface"
44728       lag-interfaces:
44729         type: array
44730         items:
44731           $ref: "#/definitions/lag-interface"
44732   pnfs:
44733     description: |
44734       Collection of Physical Network Functions.
44735     properties:
44736       pnf:
44737         type: array
44738         items:
44739           $ref: "#/definitions/pnf"
44740   port-group:
44741     description: |
44742       Used to capture the network interfaces of this VCE
44743       ###### Related Nodes
44744       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
44745       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
44746
44747       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
44748       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
44749     required:
44750     - interface-id
44751     - orchestration-status
44752     properties:
44753       interface-id:
44754         type: string
44755         description: Unique ID of the interface
44756       neutron-network-id:
44757         type: string
44758         description: Neutron network id of this Interface
44759       neutron-network-name:
44760         type: string
44761         description: Neutron network name of this Interface
44762       interface-role:
44763         type: string
44764         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44765       resource-version:
44766         type: string
44767         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44768       port-group-id:
44769         type: string
44770         description: Unique ID for port group in vmware
44771       port-group-name:
44772         type: string
44773         description: Likely to duplicate value of neutron network name
44774       switch-name:
44775         type: string
44776         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
44777       orchestration-status:
44778         type: string
44779         description: Orchestration status of this VNF, mastered by MSO
44780       heat-stack-id:
44781         type: string
44782         description: Heat stack id corresponding to this instance, managed by MSO
44783       mso-catalog-key:
44784         type: string
44785         description: Corresponds to the SDN-C catalog id used to configure this VCE
44786       cvlan-tags:
44787         type: array
44788         items:
44789           $ref: "#/definitions/cvlan-tag-entry"
44790       relationship-list:
44791         type: array
44792         items:
44793           $ref: "#/definitions/relationship"
44794   port-groups:
44795     properties:
44796       port-group:
44797         type: array
44798         items:
44799           $ref: "#/definitions/port-group"
44800   project:
44801     description: |
44802       describes the project
44803       ###### Related Nodes
44804       - TO service-instance( project Uses service-instance, ONE2MANY)
44805
44806     required:
44807     - project-name
44808     properties:
44809       project-name:
44810         type: string
44811         description: Name of the project deploying a service
44812       resource-version:
44813         type: string
44814         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44815       relationship-list:
44816         type: array
44817         items:
44818           $ref: "#/definitions/relationship"
44819   projects:
44820     description: |
44821       Collection of projects
44822     properties:
44823       project:
44824         type: array
44825         items:
44826           $ref: "#/definitions/project"
44827   properties:
44828     description: |
44829       Property holder for query properties or instance properties
44830     properties:
44831       property-name:
44832         type: string
44833       property-value:
44834         type: string
44835   property-constraint:
44836     description: |
44837       TBD
44838       ###### Related Nodes
44839       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
44840
44841       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
44842     required:
44843     - property-constraint-uuid
44844     - constraint-type
44845     - property-name
44846     - property-value
44847     properties:
44848       property-constraint-uuid:
44849         type: string
44850       constraint-type:
44851         type: string
44852       property-name:
44853         type: string
44854       property-value:
44855         type: string
44856       resource-version:
44857         type: string
44858   property-constraints:
44859     properties:
44860       property-constraint:
44861         type: array
44862         items:
44863           $ref: "#/definitions/property-constraint"
44864   pserver:
44865     description: |
44866       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
44867       ###### Related Nodes
44868       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
44869       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
44870       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
44871       - TO complex( pserver LocatedIn complex, MANY2ONE)
44872       - TO zone( pserver LocatedIn zone, MANY2ONE)
44873       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
44874       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
44875       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
44876       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
44877       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
44878
44879       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
44880       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
44881
44882     required:
44883     - hostname
44884     - in-maint
44885     properties:
44886       hostname:
44887         type: string
44888         description: Value from executing hostname on the compute node.
44889       ptnii-equip-name:
44890         type: string
44891         description: PTNII name
44892       number-of-cpus:
44893         type: integer
44894         format: int32
44895         description: Number of cpus
44896       disk-in-gigabytes:
44897         type: integer
44898         format: int32
44899         description: Disk size, in GBs
44900       ram-in-megabytes:
44901         type: integer
44902         format: int32
44903         description: RAM size, in MBs
44904       equip-type:
44905         type: string
44906         description: Equipment type.  Source of truth should define valid values.
44907       equip-vendor:
44908         type: string
44909         description: Equipment vendor.  Source of truth should define valid values.
44910       equip-model:
44911         type: string
44912         description: Equipment model.  Source of truth should define valid values.
44913       fqdn:
44914         type: string
44915         description: Fully-qualified domain name
44916       pserver-selflink:
44917         type: string
44918         description: URL to endpoint where AAI can get more details
44919       ipv4-oam-address:
44920         type: string
44921         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
44922       serial-number:
44923         type: string
44924         description: Serial number, may be queried
44925       ipaddress-v4-loopback-0:
44926         type: string
44927         description: IPV4 Loopback 0 address
44928       ipaddress-v6-loopback-0:
44929         type: string
44930         description: IPV6 Loopback 0 address
44931       ipaddress-v4-aim:
44932         type: string
44933         description: IPV4 AIM address
44934       ipaddress-v6-aim:
44935         type: string
44936         description: IPV6 AIM address
44937       ipaddress-v6-oam:
44938         type: string
44939         description: IPV6 OAM address
44940       inv-status:
44941         type: string
44942         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44943       pserver-id:
44944         type: string
44945         description: ID of Pserver
44946       internet-topology:
44947         type: string
44948         description: internet topology of Pserver
44949       in-maint:
44950         type: boolean
44951         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.
44952       resource-version:
44953         type: string
44954         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44955       pserver-name2:
44956         type: string
44957         description: alternative pserver name
44958       purpose:
44959         type: string
44960         description: purpose of pserver
44961       prov-status:
44962         type: string
44963         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44964       relationship-list:
44965         type: array
44966         items:
44967           $ref: "#/definitions/relationship"
44968       p-interfaces:
44969         type: array
44970         items:
44971           $ref: "#/definitions/p-interface"
44972       lag-interfaces:
44973         type: array
44974         items:
44975           $ref: "#/definitions/lag-interface"
44976   pservers:
44977     description: |
44978       Collection of compute hosts.
44979     properties:
44980       pserver:
44981         type: array
44982         items:
44983           $ref: "#/definitions/pserver"
44984   query-parameters:
44985     description: |
44986       QueryParameters for performing a named-query or model query
44987     properties:
44988       named-query:
44989         type: object
44990         $ref: "#/definitions/named-query"
44991       overloaded-model:
44992         type: object
44993         $ref: "#/definitions/overloaded-model"
44994   related-lookup:
44995     description: |
44996       TBD
44997       ###### Related Nodes
44998       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
44999
45000       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
45001     required:
45002     - related-lookup-uuid
45003     - source-node-type
45004     - source-node-property
45005     - target-node-type
45006     - target-node-property
45007     properties:
45008       related-lookup-uuid:
45009         type: string
45010       source-node-type:
45011         type: string
45012       source-node-property:
45013         type: string
45014       target-node-type:
45015         type: string
45016       target-node-property:
45017         type: string
45018       property-collect-list:
45019         type: string
45020       resource-version:
45021         type: string
45022       relationship-list:
45023         type: array
45024         items:
45025           $ref: "#/definitions/relationship"
45026   related-lookups:
45027     properties:
45028       related-lookup:
45029         type: array
45030         items:
45031           $ref: "#/definitions/related-lookup"
45032   related-to-property:
45033     properties:
45034       property-key:
45035         type: string
45036         description: Key part of a key/value pair
45037       property-value:
45038         type: string
45039         description: Value part of a key/value pair
45040   relationship:
45041     properties:
45042       related-to:
45043         type: string
45044         description: A keyword provided by A&AI to indicate type of node.
45045       related-link:
45046         type: string
45047         description: URL to the object in A&AI.
45048       relationship-data:
45049         type: array
45050         items:
45051           $ref: "#/definitions/relationship-data"
45052   relationship-data:
45053     required:
45054     - relationship-key
45055     - relationship-value
45056     properties:
45057       relationship-key:
45058         type: string
45059         description: A keyword provided by A&AI to indicate an attribute.
45060       relationship-value:
45061         type: string
45062         description: Value of the attribute.
45063   relationship-list:
45064     properties:
45065       relationship:
45066         type: array
45067         items:
45068           $ref: "#/definitions/relationship"
45069   reserved-prop-names:
45070     description: |
45071       Internal map to define some reserved properties of a vertex
45072     properties:
45073       last-mod-source-of-truth:
45074         type: string
45075       aai-node-type:
45076         type: string
45077       aai-created-ts:
45078         type: integer
45079         format: int64
45080       aai-unique-key:
45081         type: string
45082       aai-last-mod-ts:
45083         type: integer
45084         format: int64
45085       source-of-truth:
45086         type: string
45087       aai-uri:
45088         type: string
45089   response-list:
45090     description: |
45091       Response container for the results of a named-query or model query
45092     properties:
45093       inventory-response-items:
45094         type: object
45095         $ref: "#/definitions/inventory-response-items"
45096   result-data:
45097     properties:
45098       resource-type:
45099         type: string
45100         description: The specific type of node in the A&AI graph
45101       resource-link:
45102         type: string
45103         description: The URL to the specific resource
45104   route-table-reference:
45105     description: |
45106       Openstack route table reference.
45107       ###### Related Nodes
45108       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
45109
45110     required:
45111     - route-table-reference-id
45112     - route-table-reference-fqdn
45113     properties:
45114       route-table-reference-id:
45115         type: string
45116         description: Route Table Reference id, UUID assigned to this instance.
45117       route-table-reference-fqdn:
45118         type: string
45119         description: FQDN entry in the route table.
45120       resource-version:
45121         type: string
45122         description: Concurrency value
45123       relationship-list:
45124         type: array
45125         items:
45126           $ref: "#/definitions/relationship"
45127   route-table-references:
45128     description: |
45129       Collection of openstack route table references
45130     properties:
45131       route-table-reference:
45132         type: array
45133         items:
45134           $ref: "#/definitions/route-table-reference"
45135   route-target:
45136     description: |
45137       Route target information
45138       ###### Related Nodes
45139       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
45140
45141       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
45142     required:
45143     - global-route-target
45144     - route-target-role
45145     properties:
45146       global-route-target:
45147         type: string
45148         description: Number used to identify an RT, globally unique in the network
45149       route-target-role:
45150         type: string
45151         description: Role assigned to this route target
45152       resource-version:
45153         type: string
45154         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45155       relationship-list:
45156         type: array
45157         items:
45158           $ref: "#/definitions/relationship"
45159   route-targets:
45160     description: |
45161       Collection of route target information
45162     properties:
45163       route-target:
45164         type: array
45165         items:
45166           $ref: "#/definitions/route-target"
45167   routing-instance:
45168     description: |
45169       ###### Related Nodes
45170       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
45171       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
45172
45173       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
45174       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
45175     required:
45176     - routing-instance-id
45177     properties:
45178       routing-instance-id:
45179         type: string
45180         description: Unique id of routing instance
45181       rpm-owner:
45182         type: string
45183         description: rpm owner
45184       resource-version:
45185         type: string
45186         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45187       site-pairs:
45188         type: array
45189         items:
45190           $ref: "#/definitions/site-pair"
45191       relationship-list:
45192         type: array
45193         items:
45194           $ref: "#/definitions/relationship"
45195   routing-instances:
45196     description: |
45197       set of probes related to generic-vnf routing instance
45198     properties:
45199       routing-instance:
45200         type: array
45201         items:
45202           $ref: "#/definitions/routing-instance"
45203   sdn-zone-response:
45204     properties:
45205       oam-networks:
45206         type: object
45207         $ref: "#/definitions/oam-networks"
45208       az-and-dvs-switches:
45209         type: array
45210         items:
45211           $ref: "#/definitions/az-and-dvs-switches"
45212   search:
45213     properties:
45214       edge-tag-query-result:
45215         type: object
45216         $ref: "#/definitions/edge-tag-query-result"
45217       edge-tag-query-request:
45218         type: object
45219         $ref: "#/definitions/edge-tag-query-request"
45220       search-results:
45221         type: object
45222         $ref: "#/definitions/search-results"
45223       sdn-zone-response:
45224         type: object
45225         $ref: "#/definitions/sdn-zone-response"
45226   search-results:
45227     properties:
45228       result-data:
45229         type: array
45230         items:
45231           $ref: "#/definitions/result-data"
45232   secondary-filt:
45233     description: |
45234       SecondaryFilt for performing a named-query or model query
45235   secondary-filter:
45236     properties:
45237       property-name:
45238         type: string
45239       filter-type:
45240         type: string
45241       property-value:
45242         type: string
45243   secondary-filts:
45244     description: |
45245       SecondaryFilts for performing a named-query or model query
45246     properties:
45247       secondary-filt:
45248         type: array
45249         items:
45250           $ref: "#/definitions/secondary-filt"
45251   segmentation-assignment:
45252     description: |
45253       Openstack segmentation assignment.
45254       ###### Related Nodes
45255       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
45256
45257       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
45258     required:
45259     - segmentation-id
45260     properties:
45261       segmentation-id:
45262         type: string
45263         description: Route Table Reference id, UUID assigned to this instance.
45264       resource-version:
45265         type: string
45266         description: Concurrency value
45267       relationship-list:
45268         type: array
45269         items:
45270           $ref: "#/definitions/relationship"
45271   segmentation-assignments:
45272     description: |
45273       Collection of openstack segmentation assignments
45274     properties:
45275       segmentation-assignment:
45276         type: array
45277         items:
45278           $ref: "#/definitions/segmentation-assignment"
45279   service:
45280     description: |
45281       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
45282     required:
45283     - service-id
45284     - service-description
45285     properties:
45286       service-id:
45287         type: string
45288         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
45289       service-description:
45290         type: string
45291         description: Description of the service
45292       service-selflink:
45293         type: string
45294         description: URL to endpoint where AAI can get more details
45295       resource-version:
45296         type: string
45297         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45298       service-version:
45299         type: string
45300         description: service version
45301       relationship-list:
45302         type: array
45303         items:
45304           $ref: "#/definitions/relationship"
45305   service-capabilities:
45306     description: |
45307       Collection of service capabilities.
45308     properties:
45309       service-capability:
45310         type: array
45311         items:
45312           $ref: "#/definitions/service-capability"
45313   service-capability:
45314     description: |
45315       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
45316       ###### Related Nodes
45317       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
45318       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
45319
45320       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
45321
45322     required:
45323     - service-type
45324     - vnf-type
45325     properties:
45326       service-type:
45327         type: string
45328         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
45329       vnf-type:
45330         type: string
45331         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
45332       resource-version:
45333         type: string
45334         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45335       relationship-list:
45336         type: array
45337         items:
45338           $ref: "#/definitions/relationship"
45339   service-design-and-creation:
45340     description: |
45341       Namespace for objects managed by ASDC
45342     properties:
45343       vnf-images:
45344         type: array
45345         items:
45346           $ref: "#/definitions/vnf-image"
45347       services:
45348         type: array
45349         items:
45350           $ref: "#/definitions/service"
45351       service-capabilities:
45352         type: array
45353         items:
45354           $ref: "#/definitions/service-capability"
45355       models:
45356         type: array
45357         items:
45358           $ref: "#/definitions/model"
45359       named-queries:
45360         type: array
45361         items:
45362           $ref: "#/definitions/named-query"
45363   service-instance:
45364     description: |
45365       Instance of a service
45366       ###### Related Nodes
45367       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
45368       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
45369       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
45370       - TO connector( service-instance Uses connector, MANY2MANY)
45371       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
45372       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
45373       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
45374       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
45375       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
45376       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45377       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
45378       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
45379       - TO vce( service-instance ComposedOf vce, ONE2MANY)
45380       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
45381       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
45382       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45383
45384       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
45385       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
45386       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
45387     required:
45388     - service-instance-id
45389     properties:
45390       service-instance-id:
45391         type: string
45392         description: Uniquely identifies this instance of a service
45393       service-instance-name:
45394         type: string
45395         description: This field will store a name assigned to the service-instance.
45396       model-invariant-id:
45397         type: string
45398         description: the ASDC model id for this resource or service model.
45399       model-version-id:
45400         type: string
45401         description: the ASDC model version for this resource or service model.
45402       persona-model-version:
45403         type: string
45404         description: the ASDC model version for this resource or service model.
45405       widget-model-id:
45406         type: string
45407         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45408       widget-model-version:
45409         type: string
45410         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45411       bandwidth-total:
45412         type: string
45413         description: Indicates the total bandwidth to be used for this service.
45414       bandwidth-up-wan1:
45415         type: string
45416         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
45417       bandwidth-down-wan1:
45418         type: string
45419         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
45420       bandwidth-up-wan2:
45421         type: string
45422         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
45423       bandwidth-down-wan2:
45424         type: string
45425         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
45426       vhn-portal-url:
45427         type: string
45428         description: URL customers will use to access the vHN Portal.
45429       service-instance-location-id:
45430         type: string
45431         description: An identifier that customers assign to the location where this service is being used.
45432       resource-version:
45433         type: string
45434         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45435       selflink:
45436         type: string
45437         description: Path to the controller object.
45438       orchestration-status:
45439         type: string
45440         description: Orchestration status of this service.
45441       relationship-list:
45442         type: array
45443         items:
45444           $ref: "#/definitions/relationship"
45445       metadata:
45446         type: array
45447         items:
45448           $ref: "#/definitions/metadatum"
45449       allotted-resources:
45450         type: array
45451         items:
45452           $ref: "#/definitions/allotted-resource"
45453   service-instances:
45454     description: |
45455       Collection of service instances
45456     properties:
45457       service-instance:
45458         type: array
45459         items:
45460           $ref: "#/definitions/service-instance"
45461   service-subscription:
45462     description: |
45463       Object that group service instances.
45464       ###### Related Nodes
45465       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
45466       - TO tenant( service-subscription Uses tenant, MANY2MANY)
45467       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
45468
45469       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
45470       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
45471     required:
45472     - service-type
45473     properties:
45474       service-type:
45475         type: string
45476         description: Value defined by orchestration to identify this service across ECOMP.
45477       temp-ub-sub-account-id:
45478         type: string
45479         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
45480       resource-version:
45481         type: string
45482         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45483       service-instances:
45484         type: array
45485         items:
45486           $ref: "#/definitions/service-instance"
45487       relationship-list:
45488         type: array
45489         items:
45490           $ref: "#/definitions/relationship"
45491   service-subscriptions:
45492     description: |
45493       Collection of objects that group service instances.
45494     properties:
45495       service-subscription:
45496         type: array
45497         items:
45498           $ref: "#/definitions/service-subscription"
45499   services:
45500     description: |
45501       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
45502     properties:
45503       service:
45504         type: array
45505         items:
45506           $ref: "#/definitions/service"
45507   site-pair:
45508     description: |
45509       ###### Related Nodes
45510       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
45511       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
45512
45513       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
45514       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
45515     required:
45516     - site-pair-id
45517     properties:
45518       site-pair-id:
45519         type: string
45520         description: unique identifier of probe
45521       source-ip:
45522         type: string
45523         description: Prefix address
45524       destination-ip:
45525         type: string
45526         description: Prefix address
45527       ip-version:
45528         type: string
45529         description: ip version, v4, v6
45530       destination-hostname:
45531         type: string
45532         description: Hostname of the destination equipment to which SLAs are measured against.
45533       destination-equip-type:
45534         type: string
45535         description: The type of destinatination equipment. Could be Router, etc.
45536       resource-version:
45537         type: string
45538         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45539       classes-of-service:
45540         type: array
45541         items:
45542           $ref: "#/definitions/class-of-service"
45543       relationship-list:
45544         type: array
45545         items:
45546           $ref: "#/definitions/relationship"
45547   site-pair-set:
45548     description: |
45549       Set of instances for probes used to measure service level agreements
45550       ###### Related Nodes
45551       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
45552       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
45553
45554       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
45555     required:
45556     - site-pair-set-id
45557     properties:
45558       site-pair-set-id:
45559         type: string
45560         description: Unique id of site pair set.
45561       resource-version:
45562         type: string
45563         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45564       routing-instances:
45565         type: array
45566         items:
45567           $ref: "#/definitions/routing-instance"
45568       relationship-list:
45569         type: array
45570         items:
45571           $ref: "#/definitions/relationship"
45572   site-pair-sets:
45573     description: |
45574       Collection of sets of instances for probes related to generic-vnf
45575     properties:
45576       site-pair-set:
45577         type: array
45578         items:
45579           $ref: "#/definitions/site-pair-set"
45580   site-pairs:
45581     description: |
45582       probe within a set
45583     properties:
45584       site-pair:
45585         type: array
45586         items:
45587           $ref: "#/definitions/site-pair"
45588   snapshot:
45589     description: |
45590       Openstack snapshot
45591       ###### Related Nodes
45592       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
45593       - FROM vserver( vserver Uses snapshot, ONE2ONE)
45594
45595     required:
45596     - snapshot-id
45597     properties:
45598       snapshot-id:
45599         type: string
45600         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
45601       snapshot-name:
45602         type: string
45603         description: Snapshot name
45604       snapshot-architecture:
45605         type: string
45606         description: Operating system architecture
45607       snapshot-os-distro:
45608         type: string
45609         description: The common name of the operating system distribution in lowercase
45610       snapshot-os-version:
45611         type: string
45612         description: The operating system version as specified by the distributor.
45613       application:
45614         type: string
45615         description: The application that the image instantiates.
45616       application-vendor:
45617         type: string
45618         description: The vendor of the application.
45619       application-version:
45620         type: string
45621         description: The version of the application.
45622       snapshot-selflink:
45623         type: string
45624         description: URL to endpoint where AAI can get more details
45625       prev-snapshot-id:
45626         type: string
45627         description: This field contains the UUID of the previous snapshot (if any).
45628       resource-version:
45629         type: string
45630         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45631       relationship-list:
45632         type: array
45633         items:
45634           $ref: "#/definitions/relationship"
45635   snapshots:
45636     description: |
45637       Collection of openstack snapshots
45638     properties:
45639       snapshot:
45640         type: array
45641         items:
45642           $ref: "#/definitions/snapshot"
45643   sriov-pf:
45644     description: |
45645       SR-IOV Physical Function
45646       ###### Related Nodes
45647       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
45648       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
45649
45650       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
45651     required:
45652     - pf-pci-id
45653     properties:
45654       pf-pci-id:
45655         type: string
45656         description: Identifier for the sriov-pf
45657       resource-version:
45658         type: string
45659         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45660       relationship-list:
45661         type: array
45662         items:
45663           $ref: "#/definitions/relationship"
45664   sriov-pfs:
45665     description: |
45666       Collection of SR-IOV Physical Functions.
45667     properties:
45668       sriov-pf:
45669         type: array
45670         items:
45671           $ref: "#/definitions/sriov-pf"
45672   sriov-vf:
45673     description: |
45674       SR-IOV Virtual Function (not to be confused with virtual network function)
45675       ###### Related Nodes
45676       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
45677
45678       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
45679     required:
45680     - pci-id
45681     properties:
45682       pci-id:
45683         type: string
45684         description: PCI ID used to identify the sriov-vf
45685       vf-vlan-filter:
45686         type: string
45687         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45688       vf-mac-filter:
45689         type: string
45690         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45691       vf-vlan-strip:
45692         type: boolean
45693         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45694       vf-vlan-anti-spoof-check:
45695         type: boolean
45696         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.
45697       vf-mac-anti-spoof-check:
45698         type: boolean
45699         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.
45700       vf-mirrors:
45701         type: string
45702         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
45703       vf-broadcast-allow:
45704         type: boolean
45705         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
45706       vf-unknown-multicast-allow:
45707         type: boolean
45708         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
45709       vf-unknown-unicast-allow:
45710         type: boolean
45711         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
45712       vf-insert-stag:
45713         type: boolean
45714         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
45715       vf-link-status:
45716         type: string
45717         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
45718       resource-version:
45719         type: string
45720         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45721       neutron-network-id:
45722         type: string
45723         description: Neutron network id of the interface
45724       relationship-list:
45725         type: array
45726         items:
45727           $ref: "#/definitions/relationship"
45728   sriov-vfs:
45729     description: |
45730       Collection of SR-IOV Virtual Functions.
45731     properties:
45732       sriov-vf:
45733         type: array
45734         items:
45735           $ref: "#/definitions/sriov-vf"
45736   start-node-filter:
45737     properties:
45738       property-name:
45739         type: string
45740       property-value:
45741         type: string
45742   subnet:
45743     description: |
45744       ###### Related Nodes
45745       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
45746       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
45747       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45748
45749       -(4) IF this TO node is deleted, this SUBNET is DELETED also
45750       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
45751
45752     required:
45753     - subnet-id
45754     - dhcp-enabled
45755     properties:
45756       subnet-id:
45757         type: string
45758         description: Subnet ID, should be UUID.
45759       subnet-name:
45760         type: string
45761         description: Name associated with the subnet.
45762       neutron-subnet-id:
45763         type: string
45764         description: Neutron id of this subnet
45765       gateway-address:
45766         type: string
45767         description: gateway ip address
45768       network-start-address:
45769         type: string
45770         description: network start address
45771       cidr-mask:
45772         type: string
45773         description: cidr mask
45774       ip-version:
45775         type: string
45776         description: ip version
45777       orchestration-status:
45778         type: string
45779         description: Orchestration status of this VNF, mastered by MSO
45780       dhcp-enabled:
45781         type: boolean
45782         description: dhcp enabled
45783       dhcp-start:
45784         type: string
45785         description: the start address reserved for use by dhcp
45786       dhcp-end:
45787         type: string
45788         description: the last address reserved for use by dhcp
45789       resource-version:
45790         type: string
45791         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45792       relationship-list:
45793         type: array
45794         items:
45795           $ref: "#/definitions/relationship"
45796   subnets:
45797     properties:
45798       subnet:
45799         type: array
45800         items:
45801           $ref: "#/definitions/subnet"
45802   tagged-inventory-item-list:
45803     properties:
45804       inventory-item:
45805         type: array
45806         items:
45807           $ref: "#/definitions/inventory-item"
45808   tenant:
45809     description: |
45810       Openstack tenant
45811       ###### Related Nodes
45812       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
45813       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
45814       - TO l3-network( tenant Uses l3-network, MANY2MANY)
45815       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
45816       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
45817       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
45818
45819       -TENANT cannot be deleted if related to VSERVER
45820
45821     required:
45822     - tenant-id
45823     - tenant-name
45824     properties:
45825       tenant-id:
45826         type: string
45827         description: Unique id relative to the cloud-region.
45828       tenant-name:
45829         type: string
45830         description: Readable name of tenant
45831       resource-version:
45832         type: string
45833         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45834       vservers:
45835         type: array
45836         items:
45837           $ref: "#/definitions/vserver"
45838       relationship-list:
45839         type: array
45840         items:
45841           $ref: "#/definitions/relationship"
45842   tenants:
45843     description: |
45844       Collection of openstack tenants.
45845     properties:
45846       tenant:
45847         type: array
45848         items:
45849           $ref: "#/definitions/tenant"
45850   tunnel-xconnect:
45851     description: |
45852       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
45853       ###### Related Nodes
45854       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
45855
45856       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
45857     required:
45858     - id
45859     - bandwidth-up-wan1
45860     - bandwidth-down-wan1
45861     - bandwidth-up-wan2
45862     - bandwidth-down-wan2
45863     properties:
45864       id:
45865         type: string
45866         description: Allotted Resource id UUID assigned to this instance.
45867       bandwidth-up-wan1:
45868         type: string
45869         description: The WAN uplink bandwidth for WAN1
45870       bandwidth-down-wan1:
45871         type: string
45872         description: The WAN downlink bandwidth for WAN1
45873       bandwidth-up-wan2:
45874         type: string
45875         description: The WAN uplink bandwidth for WAN2
45876       bandwidth-down-wan2:
45877         type: string
45878         description: The WAN downlink bandwidth for WAN2
45879       resource-version:
45880         type: string
45881         description: Concurrency value
45882       relationship-list:
45883         type: array
45884         items:
45885           $ref: "#/definitions/relationship"
45886   tunnel-xconnects:
45887     description: |
45888       This object is used to store the specific tunnel cross connect aspects of an allotted resource
45889     properties:
45890       tunnel-xconnect:
45891         type: array
45892         items:
45893           $ref: "#/definitions/tunnel-xconnect"
45894   update:
45895     description: |
45896       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
45897     required:
45898     - update-node-type
45899     properties:
45900       update-node-type:
45901         type: string
45902       update-node-key:
45903         type: array
45904         items:
45905           $ref: "#/definitions/update-node-key"
45906       update-node-uri:
45907         type: string
45908       action:
45909         type: array
45910         items:
45911           $ref: "#/definitions/action"
45912   update-node-key:
45913     properties:
45914       key-name:
45915         type: string
45916       key-value:
45917         type: string
45918   vce:
45919     description: |
45920       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
45921       ###### Related Nodes
45922       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
45923       - TO complex( vce LocatedIn complex, MANY2MANY)
45924       - TO vserver( vce HostedOn vserver, ONE2MANY)
45925       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
45926       - FROM license( license BelongsTo vce, MANY2ONE)(1)
45927       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
45928       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
45929
45930       -(1) IF this VCE node is deleted, this FROM node is DELETED also
45931     required:
45932     - vnf-id
45933     - vnf-name
45934     - vnf-type
45935     properties:
45936       vnf-id:
45937         type: string
45938         description: Unique id of VNF.  This is unique across the graph.
45939       vnf-name:
45940         type: string
45941         description: Name of VNF.
45942       vnf-name2:
45943         type: string
45944         description: Alternate name of VNF.
45945       vnf-type:
45946         type: string
45947         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
45948       service-id:
45949         type: string
45950         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
45951       regional-resource-zone:
45952         type: string
45953         description: Regional way of organizing pservers, source of truth should define values
45954       prov-status:
45955         type: string
45956         description: Trigger for operational monitoring of this resource by Service Assurance systems.
45957       operational-status:
45958         type: string
45959         description: Indicator for whether the resource is considered operational
45960       license-key:
45961         type: string
45962         description: OBSOLETE -  do not use
45963       equipment-role:
45964         type: string
45965         description: Network role being played by this VNF
45966       orchestration-status:
45967         type: string
45968         description: Orchestration status of this VNF, mastered by MSO
45969       heat-stack-id:
45970         type: string
45971         description: Heat stack id corresponding to this instance, managed by MSO
45972       mso-catalog-key:
45973         type: string
45974         description: Corresponds to the SDN-C catalog id used to configure this VCE
45975       vpe-id:
45976         type: string
45977         description: Unique ID of VPE connected to this VCE.
45978       v6-vce-wan-address:
45979         type: string
45980         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
45981       ipv4-oam-address:
45982         type: string
45983         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
45984       resource-version:
45985         type: string
45986         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45987       ipv4-loopback0-address:
45988         type: string
45989         description: Loopback0 address
45990       entitlement-resource-uuid:
45991         type: string
45992         description: OBSOLETE -  see child relationships
45993       port-groups:
45994         type: array
45995         items:
45996           $ref: "#/definitions/port-group"
45997       licenses:
45998         type: array
45999         items:
46000           $ref: "#/definitions/license"
46001       entitlements:
46002         type: array
46003         items:
46004           $ref: "#/definitions/entitlement"
46005       relationship-list:
46006         type: array
46007         items:
46008           $ref: "#/definitions/relationship"
46009   vces:
46010     description: |
46011       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
46012     properties:
46013       vce:
46014         type: array
46015         items:
46016           $ref: "#/definitions/vce"
46017   vf-module:
46018     description: |
46019       a deployment unit of VNFCs
46020       ###### Related Nodes
46021       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
46022       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
46023       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
46024       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
46025       - TO vserver( vf-module Uses vserver, ONE2MANY)
46026
46027       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
46028       -VF-MODULE cannot be deleted if related to VNFC
46029
46030     required:
46031     - vf-module-id
46032     - is-base-vf-module
46033     properties:
46034       vf-module-id:
46035         type: string
46036         description: Unique ID of vf-module.
46037       vf-module-name:
46038         type: string
46039         description: Name of vf-module
46040       heat-stack-id:
46041         type: string
46042         description: Heat stack id corresponding to this instance.
46043       orchestration-status:
46044         type: string
46045         description: orchestration status of this vf-module, mastered by MSO
46046       is-base-vf-module:
46047         type: boolean
46048         description: used to indicate whether or not this object is base vf module
46049       resource-version:
46050         type: string
46051         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46052       model-invariant-id:
46053         type: string
46054         description: the ASDC model id for this resource or service model.
46055       model-version-id:
46056         type: string
46057         description: the ASDC model version for this resource or service model.
46058       persona-model-version:
46059         type: string
46060         description: the ASDC model version for this resource or service model.
46061       model-customization-id:
46062         type: string
46063         description: captures the id of all the configuration used to customize the resource for the service.
46064       widget-model-id:
46065         type: string
46066         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46067       widget-model-version:
46068         type: string
46069         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46070       contrail-service-instance-fqdn:
46071         type: string
46072         description: the Contrail unique ID for a service-instance
46073       module-index:
46074         type: integer
46075         format: int32
46076         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
46077       selflink:
46078         type: string
46079         description: Path to the controller object.
46080       relationship-list:
46081         type: array
46082         items:
46083           $ref: "#/definitions/relationship"
46084   vf-modules:
46085     description: |
46086       Collection of vf-modules, a deployment unit of VNFCs
46087     properties:
46088       vf-module:
46089         type: array
46090         items:
46091           $ref: "#/definitions/vf-module"
46092   vig-server:
46093     description: |
46094       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
46095       ###### Related Nodes
46096       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
46097
46098       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
46099     required:
46100     - vig-address-type
46101     properties:
46102       vig-address-type:
46103         type: string
46104         description: indicates whether the VIG is for AVPN or INTERNET
46105       ipaddress-v4-vig:
46106         type: string
46107         description: v4 IP of the vig server
46108       ipaddress-v6-vig:
46109         type: string
46110         description: v6 IP of the vig server
46111       resource-version:
46112         type: string
46113         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46114       relationship-list:
46115         type: array
46116         items:
46117           $ref: "#/definitions/relationship"
46118   vig-servers:
46119     properties:
46120       vig-server:
46121         type: array
46122         items:
46123           $ref: "#/definitions/vig-server"
46124   vip-ipv4-address-list:
46125     description: |
46126       IPv4 Address Range
46127       ###### Related Nodes
46128       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
46129       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
46130       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
46131       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
46132
46133     required:
46134     - vip-ipv4-address
46135     properties:
46136       vip-ipv4-address:
46137         type: string
46138         description: IP address
46139       vip-ipv4-prefix-length:
46140         type: integer
46141         format: int64
46142         description: Prefix length, 32 for single address
46143       vlan-id-inner:
46144         type: integer
46145         format: int64
46146         description: Inner VLAN tag
46147       vlan-id-outer:
46148         type: integer
46149         format: int64
46150         description: Outer VLAN tag
46151       is-floating:
46152         type: boolean
46153         description: Indicator of fixed or floating address
46154       resource-version:
46155         type: string
46156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46157       neutron-network-id:
46158         type: string
46159         description: Neutron network id of the interface that address belongs to
46160       neutron-subnet-id:
46161         type: string
46162         description: Neutron id of subnet that address belongs to
46163       relationship-list:
46164         type: array
46165         items:
46166           $ref: "#/definitions/relationship"
46167   vip-ipv6-address-list:
46168     description: |
46169       IPv6 Address Range
46170       ###### Related Nodes
46171       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
46172       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
46173       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
46174       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
46175
46176     required:
46177     - vip-ipv6-address
46178     properties:
46179       vip-ipv6-address:
46180         type: string
46181         description: IP address
46182       vip-ipv6-prefix-length:
46183         type: integer
46184         format: int64
46185         description: Prefix length, 128 for single address
46186       vlan-id-inner:
46187         type: integer
46188         format: int64
46189         description: Inner VLAN tag
46190       vlan-id-outer:
46191         type: integer
46192         format: int64
46193         description: Outer VLAN tag
46194       is-floating:
46195         type: boolean
46196         description: Indicator of fixed or floating address
46197       resource-version:
46198         type: string
46199         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46200       neutron-network-id:
46201         type: string
46202         description: Neutron network id of the interface that address belongs to
46203       neutron-subnet-id:
46204         type: string
46205         description: Neutron id of subnet that address belongs to
46206       relationship-list:
46207         type: array
46208         items:
46209           $ref: "#/definitions/relationship"
46210   virtual-data-center:
46211     description: |
46212       Virtual organization of cloud infrastructure elements in a data center context
46213       ###### Related Nodes
46214       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
46215       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
46216       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
46217
46218     required:
46219     - vdc-id
46220     - vdc-name
46221     properties:
46222       vdc-id:
46223         type: string
46224         description: Unique ID of the vdc
46225       vdc-name:
46226         type: string
46227         description: Name of the virtual data center
46228       resource-version:
46229         type: string
46230         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46231       relationship-list:
46232         type: array
46233         items:
46234           $ref: "#/definitions/relationship"
46235   virtual-data-centers:
46236     description: |
46237       Virtual organization of cloud infrastructure elements in a data center context
46238     properties:
46239       virtual-data-center:
46240         type: array
46241         items:
46242           $ref: "#/definitions/virtual-data-center"
46243   vlan:
46244     description: |
46245       Definition of vlan
46246       ###### Related Nodes
46247       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
46248       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
46249       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
46250       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
46251       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
46252       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
46253       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
46254
46255       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
46256       -(2) IF this VLAN node is deleted, this TO node is DELETED also
46257       -(4) IF this TO node is deleted, this VLAN is DELETED also
46258     required:
46259     - vlan-interface
46260     - in-maint
46261     properties:
46262       vlan-interface:
46263         type: string
46264         description: String that identifies the interface
46265       vlan-id-inner:
46266         type: integer
46267         format: int64
46268         description: Inner VLAN tag
46269       vlan-id-outer:
46270         type: integer
46271         format: int64
46272         description: Outer VLAN tag
46273       resource-version:
46274         type: string
46275         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46276       speed-value:
46277         type: string
46278         description: Captures the numeric part of the speed
46279       speed-units:
46280         type: string
46281         description: Captures the units corresponding to the speed
46282       vlan-description:
46283         type: string
46284         description: Used to describe (the service associated with) the vlan
46285       backdoor-connection:
46286         type: string
46287         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
46288       vpn-id:
46289         type: string
46290         description: This indicates the customers VPN ID associated with this vlan
46291       orchestration-status:
46292         type: string
46293         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
46294       in-maint:
46295         type: boolean
46296         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46297       relationship-list:
46298         type: array
46299         items:
46300           $ref: "#/definitions/relationship"
46301       l3-interface-ipv4-address-list:
46302         type: array
46303         items:
46304           $ref: "#/definitions/l3-interface-ipv4-address-list"
46305       l3-interface-ipv6-address-list:
46306         type: array
46307         items:
46308           $ref: "#/definitions/l3-interface-ipv6-address-list"
46309   vlans:
46310     properties:
46311       vlan:
46312         type: array
46313         items:
46314           $ref: "#/definitions/vlan"
46315   vnf:
46316     description: |
46317       Abstract vnf class
46318     required:
46319     - vnf-id
46320     properties:
46321       vnf-id:
46322         type: string
46323         description: Unique id of VNF.  This is unique across the graph.
46324   vnf-image:
46325     description: |
46326       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
46327       ###### Related Nodes
46328       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
46329
46330       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
46331
46332     required:
46333     - vnf-image-uuid
46334     - application
46335     - application-vendor
46336     properties:
46337       vnf-image-uuid:
46338         type: string
46339         description: Unique ID of this asset
46340       application:
46341         type: string
46342         description: The application that the image instantiates.
46343       application-vendor:
46344         type: string
46345         description: The vendor of the application.
46346       application-version:
46347         type: string
46348         description: The version of the application.
46349       selflink:
46350         type: string
46351         description: URL to endpoint where AAI can get more details
46352       resource-version:
46353         type: string
46354         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46355       relationship-list:
46356         type: array
46357         items:
46358           $ref: "#/definitions/relationship"
46359   vnf-images:
46360     description: |
46361       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
46362     properties:
46363       vnf-image:
46364         type: array
46365         items:
46366           $ref: "#/definitions/vnf-image"
46367   vnfc:
46368     description: |
46369       ###### Related Nodes
46370       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
46371       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
46372       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
46373
46374       -(4) IF this TO node is deleted, this VNFC is DELETED also
46375     required:
46376     - vnfc-name
46377     - vnfc-function-code
46378     - vnfc-type
46379     - in-maint
46380     - is-closed-loop-disabled
46381     properties:
46382       vnfc-name:
46383         type: string
46384         description: Unique ID of vnfc.
46385       vnfc-function-code:
46386         type: string
46387         description: function code
46388       vnfc-type:
46389         type: string
46390         description: type
46391       prov-status:
46392         type: string
46393         description: prov status of this vnfc
46394       orchestration-status:
46395         type: string
46396         description: Orchestration status of this VNF, mastered by APP-C
46397       ipaddress-v4-oam-vip:
46398         type: string
46399         description: Oam V4 vip address of this vnfc
46400       in-maint:
46401         type: boolean
46402         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46403       is-closed-loop-disabled:
46404         type: boolean
46405         description: used to indicate whether closed loop function is enabled on this node
46406       group-notation:
46407         type: string
46408         description: Group notation of VNFC
46409       resource-version:
46410         type: string
46411         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46412       relationship-list:
46413         type: array
46414         items:
46415           $ref: "#/definitions/relationship"
46416   vnfcs:
46417     description: |
46418       virtual network components associated with a vserver from application controller.
46419     properties:
46420       vnfc:
46421         type: array
46422         items:
46423           $ref: "#/definitions/vnfc"
46424   volume:
46425     description: |
46426       Ephemeral Block storage volume.
46427       ###### Related Nodes
46428       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
46429
46430       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
46431     required:
46432     - volume-id
46433     - volume-selflink
46434     properties:
46435       volume-id:
46436         type: string
46437         description: Unique ID of block storage volume relative to the vserver.
46438       volume-selflink:
46439         type: string
46440         description: URL to endpoint where AAI can get more details
46441       resource-version:
46442         type: string
46443         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46444       relationship-list:
46445         type: array
46446         items:
46447           $ref: "#/definitions/relationship"
46448   volume-group:
46449     description: |
46450       Persistent block-level storage.
46451       ###### Related Nodes
46452       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
46453       - TO complex( volume-group LocatedIn complex, MANY2ONE)
46454       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
46455       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
46456       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
46457
46458     required:
46459     - volume-group-id
46460     - volume-group-name
46461     - vnf-type
46462     properties:
46463       volume-group-id:
46464         type: string
46465         description: Unique ID of volume-group.
46466       volume-group-name:
46467         type: string
46468         description: Name of the volume group.
46469       heat-stack-id:
46470         type: string
46471         description: Heat stack id corresponding to this volume-group
46472       vnf-type:
46473         type: string
46474         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
46475       orchestration-status:
46476         type: string
46477         description: Orchestration status of this volume-group
46478       model-customization-id:
46479         type: string
46480         description: captures the id of all the configuration used to customize the resource for the service.
46481       vf-module-model-customization-id:
46482         type: string
46483         description: helps relate the volume group to the vf-module whose components will require the volume group
46484       resource-version:
46485         type: string
46486         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46487       relationship-list:
46488         type: array
46489         items:
46490           $ref: "#/definitions/relationship"
46491   volume-groups:
46492     description: |
46493       Collection of persistent block-level storage.
46494     properties:
46495       volume-group:
46496         type: array
46497         items:
46498           $ref: "#/definitions/volume-group"
46499   volumes:
46500     description: |
46501       Collection of ephemeral Block storage volumes.
46502     properties:
46503       volume:
46504         type: array
46505         items:
46506           $ref: "#/definitions/volume"
46507   vpls-pe:
46508     description: |
46509       VPLS Provider Edge routers.
46510       ###### Related Nodes
46511       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
46512       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
46513       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
46514       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
46515
46516       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
46517     required:
46518     - equipment-name
46519     properties:
46520       equipment-name:
46521         type: string
46522       prov-status:
46523         type: string
46524         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46525       ipv4-oam-address:
46526         type: string
46527         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).
46528       equipment-role:
46529         type: string
46530         description: Client should send valid enumerated value, e.g., VPLS-PE.
46531       vlan-id-outer:
46532         type: integer
46533         format: int64
46534         description: Temporary location for stag to get to VCE
46535       resource-version:
46536         type: string
46537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46538       relationship-list:
46539         type: array
46540         items:
46541           $ref: "#/definitions/relationship"
46542       p-interfaces:
46543         type: array
46544         items:
46545           $ref: "#/definitions/p-interface"
46546       lag-interfaces:
46547         type: array
46548         items:
46549           $ref: "#/definitions/lag-interface"
46550   vpls-pes:
46551     description: |
46552       Collection of VPLS Provider Edge routers
46553     properties:
46554       vpls-pe:
46555         type: array
46556         items:
46557           $ref: "#/definitions/vpls-pe"
46558   vpn-binding:
46559     description: |
46560       VPN binding
46561       ###### Related Nodes
46562       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
46563       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
46564       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
46565
46566       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
46567       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
46568
46569     required:
46570     - vpn-id
46571     - vpn-name
46572     properties:
46573       vpn-id:
46574         type: string
46575         description: VPN ID, globally unique within A&AI
46576       vpn-name:
46577         type: string
46578         description: VPN Name
46579       vpn-platform:
46580         type: string
46581         description: the platform associated with the VPN example AVPN, Mobility
46582       vpn-type:
46583         type: string
46584         description: Type of the vpn, should be taken from enumerated/valid values
46585       route-distinguisher:
46586         type: string
46587         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
46588       resource-version:
46589         type: string
46590         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46591       route-targets:
46592         type: array
46593         items:
46594           $ref: "#/definitions/route-target"
46595       relationship-list:
46596         type: array
46597         items:
46598           $ref: "#/definitions/relationship"
46599         description: l3-networks relate to vpn-bindings
46600   vpn-bindings:
46601     properties:
46602       vpn-binding:
46603         type: array
46604         items:
46605           $ref: "#/definitions/vpn-binding"
46606   vserver:
46607     description: |
46608       Virtual Servers, aka virtual machine or VM.
46609       ###### Related Nodes
46610       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
46611       - TO flavor( vserver Uses flavor, MANY2ONE)
46612       - TO image( vserver Uses image, MANY2ONE)
46613       - TO pserver( vserver HostedOn pserver, MANY2ONE)
46614       - TO snapshot( vserver Uses snapshot, ONE2ONE)
46615       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
46616       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
46617       - FROM vce( vce HostedOn vserver, ONE2MANY)
46618       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
46619       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
46620       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
46621
46622       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
46623       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
46624     required:
46625     - vserver-id
46626     - vserver-name
46627     - vserver-selflink
46628     - in-maint
46629     - is-closed-loop-disabled
46630     properties:
46631       vserver-id:
46632         type: string
46633         description: Unique identifier for this vserver relative to its tenant
46634       vserver-name:
46635         type: string
46636         description: Name of vserver
46637       vserver-name2:
46638         type: string
46639         description: Alternative name of vserver
46640       prov-status:
46641         type: string
46642         description: Trigger for operational monitoring of this resource by Service Assurance systems.
46643       vserver-selflink:
46644         type: string
46645         description: URL to endpoint where AAI can get more details
46646       in-maint:
46647         type: boolean
46648         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.
46649       is-closed-loop-disabled:
46650         type: boolean
46651         description: Used to indicate whether closed loop function is enabled on this node
46652       resource-version:
46653         type: string
46654         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46655       volumes:
46656         type: array
46657         items:
46658           $ref: "#/definitions/volume"
46659       relationship-list:
46660         type: array
46661         items:
46662           $ref: "#/definitions/relationship"
46663       l-interfaces:
46664         type: array
46665         items:
46666           $ref: "#/definitions/l-interface"
46667   vservers:
46668     description: |
46669       Collection of virtual Servers, aka virtual machines or VMs.
46670     properties:
46671       vserver:
46672         type: array
46673         items:
46674           $ref: "#/definitions/vserver"
46675   zone:
46676     description: |
46677       A zone is a grouping of assets in a location homing to the same connections into the CBB
46678       ###### Related Nodes
46679       - TO complex( zone LocatedIn complex, MANY2ONE)
46680       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
46681       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
46682       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
46683
46684     required:
46685     - zone-id
46686     - zone-name
46687     - design-type
46688     - zone-context
46689     properties:
46690       zone-id:
46691         type: string
46692         description: Code assigned by AIC to the zone
46693       zone-name:
46694         type: string
46695         description: English name associated with the zone
46696       design-type:
46697         type: string
46698         description: Design of zone [Medium/Large?]
46699       zone-context:
46700         type: string
46701         description: Context of zone [production/test]
46702       status:
46703         type: string
46704         description: Status of a zone.
46705       resource-version:
46706         type: string
46707         description: Concurrency value
46708       relationship-list:
46709         type: array
46710         items:
46711           $ref: "#/definitions/relationship"
46712   zones:
46713     description: |
46714       Collection of zones
46715     properties:
46716       zone:
46717         type: array
46718         items:
46719           $ref: "#/definitions/zone"
46720 patchDefinitions:
46721   action:
46722     properties:
46723       action-type:
46724         type: string
46725       action-data:
46726         type: array
46727         items:
46728           $ref: "#/patchDefinitions/action-data"
46729   action-data:
46730     properties:
46731       property-name:
46732         type: string
46733       property-value:
46734         type: string
46735   actions:
46736     description: |
46737       APIs that are more action related than REST (e.g., notify, update).
46738     properties:
46739       update:
46740         type: object
46741         $ref: "#/patchDefinitions/update"
46742       notify:
46743         type: object
46744         $ref: "#/patchDefinitions/notify"
46745   allotted-resource:
46746     description: |
46747       Represents a slice or partial piece of a resource that gets separately allotted
46748       ###### Related Nodes
46749       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46750       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46751       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46752       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
46753       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46754       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46755       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46756       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46757
46758       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46759       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46760     required:
46761     - id
46762     properties:
46763       id:
46764         type: string
46765         description: Allotted Resource id UUID assigned to this instance.
46766       description:
46767         type: string
46768         description: The descriptive information assigned to this allotted resource instance
46769       selflink:
46770         type: string
46771         description: Link back to more information in the controller
46772       model-invariant-id:
46773         type: string
46774         description: the ASDC model id for this resource or service model.
46775       model-version-id:
46776         type: string
46777         description: the ASDC model version for this resource or service model.
46778       persona-model-version:
46779         type: string
46780         description: the ASDC model version for this resource or service model.
46781   allotted-resources:
46782     description: |
46783       This object is used to store slices of services being offered
46784     properties:
46785       allotted-resource:
46786         type: array
46787         items:
46788           $ref: "#/patchDefinitions/allotted-resource"
46789   availability-zone:
46790     description: |
46791       Availability zone, a collection of compute hosts/pservers
46792       ###### Related Nodes
46793       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46794       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46795       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46796       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46797       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46798       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46799       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46800       - FROM vce( vce Uses availability-zone, MANY2MANY)
46801
46802       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46803       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46804
46805     required:
46806     - availability-zone-name
46807     - hypervisor-type
46808     properties:
46809       availability-zone-name:
46810         type: string
46811         description: Name of the availability zone.  Unique across a cloud region
46812       hypervisor-type:
46813         type: string
46814         description: Type of hypervisor.  Source of truth should define valid values.
46815       operational-status:
46816         type: string
46817         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
46818   availability-zones:
46819     description: |
46820       Collection of availability zones
46821     properties:
46822       availability-zone:
46823         type: array
46824         items:
46825           $ref: "#/patchDefinitions/availability-zone"
46826   az-and-dvs-switches:
46827     properties:
46828       dvs-switches:
46829         type: object
46830         $ref: "#/patchDefinitions/dvs-switches"
46831       availability-zone:
46832         type: object
46833         $ref: "#/patchDefinitions/availability-zone"
46834   business:
46835     description: |
46836       Namespace for business related constructs
46837     properties:
46838       connectors:
46839         type: array
46840         items:
46841           $ref: "#/patchDefinitions/connector"
46842       customers:
46843         type: array
46844         items:
46845           $ref: "#/patchDefinitions/customer"
46846   class-of-service:
46847     description: |
46848       ###### Related Nodes
46849       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46850
46851       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46852     required:
46853     - cos
46854     properties:
46855       cos:
46856         type: string
46857         description: unique identifier of probe
46858       probe-id:
46859         type: string
46860         description: identifier of probe
46861       probe-type:
46862         type: string
46863         description: type of probe
46864   classes-of-service:
46865     description: |
46866       class-of-service of probe
46867     properties:
46868       class-of-service:
46869         type: array
46870         items:
46871           $ref: "#/patchDefinitions/class-of-service"
46872   cloud-infrastructure:
46873     description: |
46874       Namespace for cloud infrastructure.
46875     properties:
46876       complexes:
46877         type: array
46878         items:
46879           $ref: "#/patchDefinitions/complex"
46880       cloud-regions:
46881         type: array
46882         items:
46883           $ref: "#/patchDefinitions/cloud-region"
46884       network-profiles:
46885         type: array
46886         items:
46887           $ref: "#/patchDefinitions/network-profile"
46888       pservers:
46889         type: array
46890         items:
46891           $ref: "#/patchDefinitions/pserver"
46892       virtual-data-centers:
46893         type: array
46894         items:
46895           $ref: "#/patchDefinitions/virtual-data-center"
46896   cloud-region:
46897     description: |
46898       cloud-region designates an installation of a cloud cluster or region or instantiation
46899       ###### Related Nodes
46900       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46901       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46902       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46903       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46904       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46905       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46906       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46907       - FROM image( image BelongsTo cloud-region, MANY2ONE)
46908       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
46909       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
46910       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
46911       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
46912       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
46913       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
46914
46915       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
46916       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
46917
46918     required:
46919     - cloud-owner
46920     - cloud-region-id
46921     properties:
46922       cloud-owner:
46923         type: string
46924         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
46925       cloud-region-id:
46926         type: string
46927         description: Identifier used by the vendor for the region. Second part of composite key
46928       cloud-type:
46929         type: string
46930         description: Type of the cloud (e.g., openstack)
46931       owner-defined-type:
46932         type: string
46933         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
46934       cloud-region-version:
46935         type: string
46936         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
46937       identity-url:
46938         type: string
46939         description: URL of the keystone identity service
46940       cloud-zone:
46941         type: string
46942         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46943       complex-name:
46944         type: string
46945         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46946   cloud-regions:
46947     properties:
46948       cloud-region:
46949         type: array
46950         items:
46951           $ref: "#/patchDefinitions/cloud-region"
46952   complex:
46953     description: |
46954       Collection of physical locations that can house cloud-regions.
46955       ###### Related Nodes
46956       - TO l3-network( complex Uses l3-network, MANY2MANY)
46957       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
46958       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
46959       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
46960       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
46961       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
46962       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
46963       - FROM vce( vce LocatedIn complex, MANY2MANY)
46964       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
46965       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
46966       - FROM zone( zone LocatedIn complex, MANY2ONE)
46967
46968       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
46969       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
46970
46971     required:
46972     - physical-location-id
46973     - physical-location-type
46974     - street1
46975     - city
46976     - postal-code
46977     - country
46978     - region
46979     properties:
46980       physical-location-id:
46981         type: string
46982         description: Unique identifier for physical location, e.g., CLLI
46983       data-center-code:
46984         type: string
46985         description: Data center code which can be an alternate way to identify a complex
46986       complex-name:
46987         type: string
46988         description: Gamma complex name for LCP instance.
46989       identity-url:
46990         type: string
46991         description: URL of the keystone identity service
46992   complexes:
46993     description: |
46994       Collection of physical locations that can house cloud-regions.
46995     properties:
46996       complex:
46997         type: array
46998         items:
46999           $ref: "#/patchDefinitions/complex"
47000   configuration:
47001     description: |
47002       Port Mirror Configuration.
47003       ###### Related Nodes
47004       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47005       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47006       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47007       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47008       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47009
47010       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47011       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47012       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47013     required:
47014     - configuration-id
47015     - configuration-type
47016     - configuration-sub-type
47017     - orchestration-status
47018     - operational-status
47019     - configuration-selflink
47020     - model-customization-id
47021     properties:
47022       configuration-id:
47023         type: string
47024         description: UUID assigned to configuration.
47025       management-option:
47026         type: string
47027         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47028       configuration-name:
47029         type: string
47030         description: Name of the configuration.
47031       configuration-type:
47032         type: string
47033         description: port-mirroring-configuration.
47034       configuration-sub-type:
47035         type: string
47036         description: vprobe, pprobe.
47037       model-invariant-id:
47038         type: string
47039         description: the ASDC model id for this resource or service model.
47040       model-version-id:
47041         type: string
47042         description: the ASDC model version for this resource or service model.
47043       orchestration-status:
47044         type: string
47045         description: Orchestration status of the configuration.
47046       operational-status:
47047         type: string
47048         description: Indicator for whether the resource is considered operational.
47049       configuration-selflink:
47050         type: string
47051         description: URL to endpoint where AAI can get more details from SDN-GC.
47052       model-customization-id:
47053         type: string
47054         description: id of  the configuration used to customize the resource
47055   configurations:
47056     description: |
47057       Collection of configurations
47058     properties:
47059       configuration:
47060         type: array
47061         items:
47062           $ref: "#/patchDefinitions/configuration"
47063   connector:
47064     description: |
47065       Collection of resource instances used to connect a variety of disparate inventory widgets
47066       ###### Related Nodes
47067       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47068       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47069       - FROM service-instance( service-instance Uses connector, MANY2MANY)
47070
47071       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47072     required:
47073     - resource-instance-id
47074     properties:
47075       resource-instance-id:
47076         type: string
47077         description: Unique id of resource instance.
47078   connectors:
47079     description: |
47080       Collection of resource instances used to connect a variety of disparate inventory widgets
47081     properties:
47082       connector:
47083         type: array
47084         items:
47085           $ref: "#/patchDefinitions/connector"
47086   constrained-element-set:
47087     description: |
47088       This is how we would capture constraints defining allowed sets of elements.
47089       ###### Related Nodes
47090       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47091       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47092       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47093
47094       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47095       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47096     required:
47097     - constrained-element-set-uuid
47098     - constraint-type
47099     - check-type
47100     properties:
47101       constrained-element-set-uuid:
47102         type: string
47103       constraint-type:
47104         type: string
47105       check-type:
47106         type: string
47107   constrained-element-sets:
47108     properties:
47109       constrained-element-set:
47110         type: array
47111         items:
47112           $ref: "#/patchDefinitions/constrained-element-set"
47113   ctag-assignment:
47114     description: |
47115       ###### Related Nodes
47116       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47117       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47118
47119       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47120     required:
47121     - vlan-id-inner
47122     properties:
47123       vlan-id-inner:
47124         type: integer
47125         format: int64
47126         description: id.
47127   ctag-assignments:
47128     properties:
47129       ctag-assignment:
47130         type: array
47131         items:
47132           $ref: "#/patchDefinitions/ctag-assignment"
47133   ctag-pool:
47134     description: |
47135       A collection of C tags (vlan tags) grouped for a specific purpose.
47136       ###### Related Nodes
47137       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47138       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47139       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47140
47141       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47142     required:
47143     - target-pe
47144     - availability-zone-name
47145     - ctag-pool-purpose
47146     properties:
47147       target-pe:
47148         type: string
47149         description: The Target provider edge router
47150       availability-zone-name:
47151         type: string
47152         description: Name of the availability zone
47153       ctag-pool-purpose:
47154         type: string
47155         description: Describes what the intended purpose of this pool is.
47156       ctag-values:
47157         type: string
47158         description: Comma separated list of ctags
47159   ctag-pools:
47160     properties:
47161       ctag-pool:
47162         type: array
47163         items:
47164           $ref: "#/patchDefinitions/ctag-pool"
47165   customer:
47166     description: |
47167       customer identifiers to provide linkage back to BSS information.
47168       ###### Related Nodes
47169       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47170
47171       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47172     required:
47173     - global-customer-id
47174     - subscriber-name
47175     - subscriber-type
47176     properties:
47177       global-customer-id:
47178         type: string
47179         description: Global customer id used across ECOMP to uniquely identify customer.
47180       subscriber-name:
47181         type: string
47182         description: Subscriber name, an alternate way to retrieve a customer.
47183       subscriber-type:
47184         type: string
47185         description: Subscriber type, a way to provide VID with only the INFRA customers.
47186   customers:
47187     description: |
47188       Collection of customer identifiers to provide linkage back to BSS information.
47189     properties:
47190       customer:
47191         type: array
47192         items:
47193           $ref: "#/patchDefinitions/customer"
47194   cvlan-tag-entry:
47195     required:
47196     - cvlan-tag
47197     properties:
47198       cvlan-tag:
47199         type: integer
47200         format: int64
47201         description: See mis-na-virtualization-platform.yang
47202   cvlan-tags:
47203     properties:
47204       cvlan-tag-entry:
47205         type: array
47206         items:
47207           $ref: "#/patchDefinitions/cvlan-tag-entry"
47208   dvs-switch:
47209     description: |
47210       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.
47211       ###### Related Nodes
47212       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47213       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47214
47215     required:
47216     - switch-name
47217     - vcenter-url
47218     properties:
47219       switch-name:
47220         type: string
47221         description: DVS switch name
47222       vcenter-url:
47223         type: string
47224         description: URL used to reach the vcenter
47225   dvs-switches:
47226     description: |
47227       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47228     properties:
47229       dvs-switch:
47230         type: array
47231         items:
47232           $ref: "#/patchDefinitions/dvs-switch"
47233   edge-prop-names:
47234     description: |
47235       Internal map to define the properties of an edge and interpret the map EdgeRules
47236     properties:
47237       edgeLabel:
47238         type: string
47239       direction:
47240         type: string
47241       multiplicityRule:
47242         type: string
47243       isParent:
47244         type: boolean
47245       usesResource:
47246         type: boolean
47247       hasDelTarget:
47248         type: boolean
47249       SVC-INFRA:
47250         type: boolean
47251       SVC-INFRA-REV:
47252         type: boolean
47253   edge-tag-query-request:
47254     properties:
47255       edge-tag:
47256         type: string
47257       result-detail:
47258         type: string
47259       start-node-type:
47260         type: string
47261       start-node-filter:
47262         type: array
47263         items:
47264           $ref: "#/patchDefinitions/start-node-filter"
47265       include-node-filter:
47266         type: array
47267         items:
47268           $ref: "#/patchDefinitions/include-node-filter"
47269       secondary-filter:
47270         type: array
47271         items:
47272           $ref: "#/patchDefinitions/secondary-filter"
47273   edge-tag-query-result:
47274     properties:
47275       tagged-inventory-item-list:
47276         type: array
47277         items:
47278           $ref: "#/patchDefinitions/tagged-inventory-item-list"
47279   element-choice-set:
47280     description: |
47281       This is how we would capture constraints defining allowed sets of elements.
47282       ###### Related Nodes
47283       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47284       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47285
47286       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47287       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47288     required:
47289     - element-choice-set-uuid
47290     - element-choice-set-name
47291     properties:
47292       element-choice-set-uuid:
47293         type: string
47294       element-choice-set-name:
47295         type: string
47296       cardinality:
47297         type: string
47298   element-choice-sets:
47299     properties:
47300       element-choice-set:
47301         type: array
47302         items:
47303           $ref: "#/patchDefinitions/element-choice-set"
47304   entitlement:
47305     description: |
47306       Metadata for entitlement group.
47307       ###### Related Nodes
47308       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47309       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47310
47311       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47312     required:
47313     - group-uuid
47314     - resource-uuid
47315     properties:
47316       group-uuid:
47317         type: string
47318         description: Unique ID for the entitlement group the resource comes from, should be uuid.
47319       resource-uuid:
47320         type: string
47321         description: Unique ID of an entitlement resource.
47322   entitlements:
47323     description: |
47324       Entitlements, keyed by group-uuid and resource-uuid, related to license management
47325     properties:
47326       entitlement:
47327         type: array
47328         items:
47329           $ref: "#/patchDefinitions/entitlement"
47330   esr-ems:
47331     description: |
47332       Persist EMS address information used by EMS driver.
47333       ###### Related Nodes
47334       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
47335
47336       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
47337     required:
47338     - ems-id
47339     properties:
47340       ems-id:
47341         type: string
47342         description: Unique ID of EMS.
47343   esr-ems-list:
47344     properties:
47345       esr-ems:
47346         type: array
47347         items:
47348           $ref: "#/patchDefinitions/esr-ems"
47349   esr-system-info:
47350     description: |
47351       Persist common address information of external systems.
47352       ###### Related Nodes
47353       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
47354       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
47355       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
47356       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
47357
47358       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
47359     required:
47360     - esr-system-info-id
47361     - user-name
47362     - password
47363     - system-type
47364     properties:
47365       esr-system-info-id:
47366         type: string
47367         description: Unique ID of esr system info.
47368       system-name:
47369         type: string
47370         description: name of external system.
47371       type:
47372         type: string
47373         description: type of external systems.
47374       vendor:
47375         type: string
47376         description: vendor of external systems.
47377       version:
47378         type: string
47379         description: version of external systems.
47380       service-url:
47381         type: string
47382         description: url used to access external systems.
47383       user-name:
47384         type: string
47385         description: username used to access external systems.
47386       password:
47387         type: string
47388         description: password used to access external systems.
47389       system-type:
47390         type: string
47391         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47392       protocol:
47393         type: string
47394         description: protocol of third party SDNC, for example netconf/snmp.
47395       ssl-cacert:
47396         type: string
47397         description: ca file content if enabled ssl on auth-url.
47398       ssl-insecure:
47399         type: boolean
47400         description: Whether to verify VIM's certificate.
47401       ip-address:
47402         type: string
47403         description: service IP of ftp server.
47404       port:
47405         type: string
47406         description: service port of ftp server.
47407       cloud-domain:
47408         type: string
47409         description: domain info for authentication.
47410       default-tenant:
47411         type: string
47412         description: default tenant of VIM.
47413       passive:
47414         type: boolean
47415         description: ftp passive mode or not.
47416       remote-path:
47417         type: string
47418         description: resource or performance data file path.
47419       system-status:
47420         type: string
47421         description: the status of external system.
47422   esr-system-info-list:
47423     description: |
47424       Collection of persistent block-level external system auth info.
47425     properties:
47426       esr-system-info:
47427         type: array
47428         items:
47429           $ref: "#/patchDefinitions/esr-system-info"
47430   esr-thirdparty-sdnc:
47431     description: |
47432       Persist SDNC address information used by ONAP SDNC.
47433       ###### Related Nodes
47434       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
47435       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
47436
47437       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
47438     required:
47439     - thirdparty-sdnc-id
47440     properties:
47441       thirdparty-sdnc-id:
47442         type: string
47443         description: Unique ID of SDNC.
47444       location:
47445         type: string
47446         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47447       product-name:
47448         type: string
47449         description: password used to access SDNC server.
47450   esr-thirdparty-sdnc-list:
47451     properties:
47452       esr-thirdparty-sdnc:
47453         type: array
47454         items:
47455           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
47456   esr-vnfm:
47457     description: |
47458       Persist VNFM address information used by VF-C.
47459       ###### Related Nodes
47460       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
47461
47462       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
47463     required:
47464     - vnfm-id
47465     properties:
47466       vnfm-id:
47467         type: string
47468         description: Unique ID of VNFM.
47469       vim-id:
47470         type: string
47471         description: indecate the VIM to deploy VNF.
47472       certificate-url:
47473         type: string
47474         description: certificate url of VNFM.
47475   esr-vnfm-list:
47476     properties:
47477       esr-vnfm:
47478         type: array
47479         items:
47480           $ref: "#/patchDefinitions/esr-vnfm"
47481   evc:
47482     description: |
47483       evc object is an optional child object of the Configuration object.
47484       ###### Related Nodes
47485       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47486
47487       -(4) IF this TO node is deleted, this EVC is DELETED also
47488     required:
47489     - evc-id
47490     properties:
47491       evc-id:
47492         type: string
47493         description: Unique/key field for the evc object
47494       forwarding-path-topology:
47495         type: string
47496         description: Point-to-Point, Multi-Point
47497       cir-value:
47498         type: string
47499         description: Commited Information Rate
47500       cir-units:
47501         type: string
47502         description: CIR units
47503       connection-diversity-group-id:
47504         type: string
47505         description: Diversity Group ID
47506       service-hours:
47507         type: string
47508         description: formerly Performance Group
47509       esp-evc-circuit-id:
47510         type: string
47511         description: EVC Circuit ID of ESP EVC
47512       esp-evc-cir-value:
47513         type: string
47514         description: Committed Information Rate (For ESP)
47515       esp-evc-cir-units:
47516         type: string
47517         description: CIR units (For ESP)
47518       esp-itu-code:
47519         type: string
47520         description: Identifies ESP
47521       collector-pop-clli:
47522         type: string
47523         description: Collector POP CLLI (from the hostname of the access pnf)
47524       inter-connect-type-ingress:
47525         type: string
47526         description: Interconnect type on ingress side of EVC.
47527       tagmode-access-ingress:
47528         type: string
47529         description: tagode for collector side of EVC
47530       tagmode-access-egress:
47531         type: string
47532         description: tagMode for network side of EVC
47533   evcs:
47534     properties:
47535       evc:
47536         type: array
47537         items:
47538           $ref: "#/patchDefinitions/evc"
47539   external-system:
47540     description: |
47541       Namespace for external system.
47542     properties:
47543       esr-ems-list:
47544         type: object
47545         $ref: "#/patchDefinitions/esr-ems-list"
47546       esr-vnfm-list:
47547         type: object
47548         $ref: "#/patchDefinitions/esr-vnfm-list"
47549       esr-thirdparty-sdnc-list:
47550         type: object
47551         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
47552   extra-properties:
47553     description: |
47554       Extra properties for inventory item for response list
47555     properties:
47556       extra-property:
47557         type: array
47558         items:
47559           $ref: "#/patchDefinitions/extra-property"
47560   extra-property:
47561     properties:
47562       property-name:
47563         type: string
47564       property-value:
47565         type: string
47566   flavor:
47567     description: |
47568       Openstack flavor.
47569       ###### Related Nodes
47570       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47571       - FROM vserver( vserver Uses flavor, MANY2ONE)
47572
47573       -FLAVOR cannot be deleted if related to VSERVER
47574
47575     required:
47576     - flavor-id
47577     - flavor-name
47578     - flavor-selflink
47579     properties:
47580       flavor-id:
47581         type: string
47582         description: Flavor id, expected to be unique across cloud-region.
47583       flavor-name:
47584         type: string
47585         description: Flavor name
47586       flavor-vcpus:
47587         type: integer
47588         format: int32
47589         description: Number of CPUs
47590       flavor-ram:
47591         type: integer
47592         format: int32
47593         description: Amount of memory
47594       flavor-disk:
47595         type: integer
47596         format: int32
47597         description: Disk space
47598       flavor-ephemeral:
47599         type: integer
47600         format: int32
47601         description: Amount of ephemeral disk space
47602       flavor-swap:
47603         type: string
47604         description: amount of swap space allocation
47605       flavor-is-public:
47606         type: boolean
47607         description: whether flavor is available to all users or private to the tenant it was created in.
47608       flavor-selflink:
47609         type: string
47610         description: URL to endpoint where AAI can get more details
47611       flavor-disabled:
47612         type: boolean
47613         description: Boolean as to whether this flavor is no longer enabled
47614   flavors:
47615     description: |
47616       Collection of openstack flavors.
47617     properties:
47618       flavor:
47619         type: array
47620         items:
47621           $ref: "#/patchDefinitions/flavor"
47622   forwarder:
47623     description: |
47624       Entity describing a sequenced segment of forwarding path
47625       ###### Related Nodes
47626       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
47627       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
47628       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
47629       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
47630       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
47631
47632       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
47633       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
47634     required:
47635     - sequence
47636     properties:
47637       sequence:
47638         type: integer
47639         format: int32
47640         description: Unique ID of this segmentation
47641       forwarder-role:
47642         type: string
47643         description: ingress, intermediate, egress
47644   forwarder-evc:
47645     description: |
47646       forwarder object is an optional child object of the Configuration object.
47647       ###### Related Nodes
47648       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
47649
47650       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
47651     required:
47652     - forwarder-evc-id
47653     properties:
47654       forwarder-evc-id:
47655         type: string
47656         description: Key for forwarder-evc object
47657       circuit-id:
47658         type: string
47659         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
47660       ivlan:
47661         type: string
47662         description: Internal VLAN.
47663       svlan:
47664         type: string
47665         description: SVLAN value for ingress of egress forwarder.
47666       cvlan:
47667         type: string
47668         description: CVLAN value for ingress of egress forwarder.
47669   forwarder-evcs:
47670     properties:
47671       forwarder-evc:
47672         type: array
47673         items:
47674           $ref: "#/patchDefinitions/forwarder-evc"
47675   forwarders:
47676     properties:
47677       forwarder:
47678         type: array
47679         items:
47680           $ref: "#/patchDefinitions/forwarder"
47681   forwarding-path:
47682     description: |
47683       Entity that describes the sequenced forwarding path between interfaces of services or resources
47684       ###### Related Nodes
47685       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
47686       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
47687       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
47688
47689       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
47690       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
47691       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
47692     required:
47693     - forwarding-path-id
47694     - forwarding-path-name
47695     properties:
47696       forwarding-path-id:
47697         type: string
47698         description: Unique ID of this FP
47699       forwarding-path-name:
47700         type: string
47701         description: Name of the FP
47702   forwarding-paths:
47703     properties:
47704       forwarding-path:
47705         type: array
47706         items:
47707           $ref: "#/patchDefinitions/forwarding-path"
47708   generic-vnf:
47709     description: |
47710       General purpose VNF
47711       ###### Related Nodes
47712       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
47713       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
47714       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
47715       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
47716       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
47717       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
47718       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
47719       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
47720       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
47721       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47722       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
47723       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
47724       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
47725       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
47726       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
47727       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
47728       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
47729       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
47730       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
47731       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
47732       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
47733
47734       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
47735     required:
47736     - vnf-id
47737     - vnf-name
47738     - vnf-type
47739     - in-maint
47740     - is-closed-loop-disabled
47741     properties:
47742       vnf-id:
47743         type: string
47744         description: Unique id of VNF.  This is unique across the graph.
47745       vnf-name:
47746         type: string
47747         description: Name of VNF.
47748       vnf-name2:
47749         type: string
47750         description: Alternate name of VNF.
47751       vnf-type:
47752         type: string
47753         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
47754       service-id:
47755         type: string
47756         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
47757       regional-resource-zone:
47758         type: string
47759         description: Regional way of organizing pservers, source of truth should define values
47760       prov-status:
47761         type: string
47762         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47763       operational-status:
47764         type: string
47765         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
47766       license-key:
47767         type: string
47768         description: OBSOLETE -  do not use
47769       equipment-role:
47770         type: string
47771         description: Client should send valid enumerated value
47772       orchestration-status:
47773         type: string
47774         description: Orchestration status of this VNF, used by MSO.
47775       heat-stack-id:
47776         type: string
47777         description: Heat stack id corresponding to this instance, managed by MSO
47778       mso-catalog-key:
47779         type: string
47780         description: Corresponds to the SDN-C catalog id used to configure this VCE
47781       management-option:
47782         type: string
47783         description: identifier of managed by company or customer
47784       ipv4-oam-address:
47785         type: string
47786         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
47787       ipv4-loopback0-address:
47788         type: string
47789         description: v4 Loopback0 address
47790       nm-lan-v6-address:
47791         type: string
47792         description: v6 Loopback address
47793       management-v6-address:
47794         type: string
47795         description: v6 management address
47796       vcpu:
47797         type: integer
47798         format: int64
47799         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47800       vcpu-units:
47801         type: string
47802         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
47803       vmemory:
47804         type: integer
47805         format: int64
47806         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47807       vmemory-units:
47808         type: string
47809         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
47810       vdisk:
47811         type: integer
47812         format: int64
47813         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47814       vdisk-units:
47815         type: string
47816         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
47817       in-maint:
47818         type: boolean
47819         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.
47820       is-closed-loop-disabled:
47821         type: boolean
47822         description: used to indicate whether closed loop function is enabled on this node
47823   generic-vnfs:
47824     description: |
47825       Collection of VNFs
47826     properties:
47827       generic-vnf:
47828         type: array
47829         items:
47830           $ref: "#/patchDefinitions/generic-vnf"
47831   group-assignment:
47832     description: |
47833       Openstack group-assignment used to store exclusivity groups (EG).
47834       ###### Related Nodes
47835       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
47836       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
47837       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
47838
47839     required:
47840     - group-id
47841     - group-type
47842     - group-name
47843     properties:
47844       group-id:
47845         type: string
47846         description: Group id, expected to be unique across cloud-region.
47847       group-type:
47848         type: string
47849         description: Group type - the type of group this instance refers to
47850       group-name:
47851         type: string
47852         description: Group name - name assigned to the group
47853       group-description:
47854         type: string
47855         description: Group description - description of the group
47856   group-assignments:
47857     description: |
47858       Collection of openstack group assignments
47859     properties:
47860       group-assignment:
47861         type: array
47862         items:
47863           $ref: "#/patchDefinitions/group-assignment"
47864   host-route:
47865     description: |
47866       ###### Related Nodes
47867       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
47868
47869       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
47870     required:
47871     - host-route-id
47872     - route-prefix
47873     - next-hop
47874     properties:
47875       host-route-id:
47876         type: string
47877         description: host-route id
47878       route-prefix:
47879         type: string
47880         description: subnet prefix
47881       next-hop:
47882         type: string
47883         description: Could be ip-address, hostname, or service-instance
47884       next-hop-type:
47885         type: string
47886         description: Should be ip-address, hostname, or service-instance to match next-hop
47887   host-routes:
47888     properties:
47889       host-route:
47890         type: array
47891         items:
47892           $ref: "#/patchDefinitions/host-route"
47893   hpa-capabilities:
47894     description: |
47895       Collection of HPA Capabilities
47896     properties:
47897       hpa-capability:
47898         type: array
47899         items:
47900           $ref: "#/patchDefinitions/hpa-capability"
47901   hpa-capability:
47902     description: |
47903       Represents a HPA capability
47904       ###### Related Nodes
47905       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
47906       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
47907       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
47908
47909       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
47910     required:
47911     - hpa-capability-id
47912     - hpa-feature
47913     properties:
47914       hpa-capability-id:
47915         type: string
47916         description: UUID to uniquely identify a HPA capability
47917       hpa-feature:
47918         type: string
47919         description: Name of the HPACapability
47920       hpa-version:
47921         type: string
47922         description: HPA schema version
47923       architecture:
47924         type: string
47925         description: Hardware architecture
47926   hpa-feature-attributes:
47927     description: |
47928       HPA Capability Feature attributes
47929       ###### Related Nodes
47930       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
47931
47932       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
47933     required:
47934     - hpa-attribute-key
47935     properties:
47936       hpa-attribute-key:
47937         type: string
47938         description: name of the specific HPA attribute
47939       hpa-attribute-value:
47940         type: string
47941         description: JSON string specifying the value, unit and type of the specific HPA attribute
47942   image:
47943     description: |
47944       Openstack image.
47945       ###### Related Nodes
47946       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
47947       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
47948       - FROM vserver( vserver Uses image, MANY2ONE)
47949
47950       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
47951       -IMAGE cannot be deleted if related to VSERVER
47952
47953     required:
47954     - image-id
47955     - image-name
47956     - image-os-distro
47957     - image-os-version
47958     - image-selflink
47959     properties:
47960       image-id:
47961         type: string
47962         description: Image id, expected to be unique across cloud region
47963       image-name:
47964         type: string
47965         description: Image name
47966       image-architecture:
47967         type: string
47968         description: Operating system architecture.
47969       image-os-distro:
47970         type: string
47971         description: The common name of the operating system distribution in lowercase
47972       image-os-version:
47973         type: string
47974         description: The operating system version as specified by the distributor.
47975       application:
47976         type: string
47977         description: The application that the image instantiates.
47978       application-vendor:
47979         type: string
47980         description: The vendor of the application.
47981       application-version:
47982         type: string
47983         description: The version of the application.
47984       image-selflink:
47985         type: string
47986         description: URL to endpoint where AAI can get more details
47987   images:
47988     description: |
47989       Collectio of Openstack images.
47990     properties:
47991       image:
47992         type: array
47993         items:
47994           $ref: "#/patchDefinitions/image"
47995   include-node-filter:
47996     properties:
47997       include-node-type:
47998         type: string
47999   instance-filter:
48000     description: |
48001       InstanceFilter for performing a named-query or model query
48002   instance-filters:
48003     description: |
48004       InstanceFilters for performing a named-query or model query
48005     properties:
48006       instance-filter:
48007         type: array
48008         items:
48009           $ref: "#/patchDefinitions/instance-filter"
48010   instance-group:
48011     description: |
48012       General mechanism for grouping instances
48013       ###### Related Nodes
48014       - TO model( instance-group Targets model, MANY2MANY)
48015       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48016       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48017       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48018       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48019       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48020       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48021       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48022
48023     required:
48024     - id
48025     - description
48026     - type
48027     properties:
48028       id:
48029         type: string
48030         description: Instance Group ID, UUID assigned to this instance.
48031       description:
48032         type: string
48033         description: Descriptive text to help identify the usage of this instance-group
48034       type:
48035         type: string
48036         description: Only valid value today is lower case ha for high availability
48037       sub-type:
48038         type: string
48039         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48040   instance-groups:
48041     description: |
48042       Collection of openstack route table references
48043     properties:
48044       instance-group:
48045         type: array
48046         items:
48047           $ref: "#/patchDefinitions/instance-group"
48048   inventory:
48049     properties:
48050       search:
48051         type: object
48052         $ref: "#/patchDefinitions/search"
48053       actions:
48054         type: object
48055         $ref: "#/patchDefinitions/actions"
48056       cloud-infrastructure:
48057         type: object
48058         $ref: "#/patchDefinitions/cloud-infrastructure"
48059       business:
48060         type: object
48061         $ref: "#/patchDefinitions/business"
48062       service-design-and-creation:
48063         type: object
48064         $ref: "#/patchDefinitions/service-design-and-creation"
48065       network:
48066         type: object
48067         $ref: "#/patchDefinitions/network"
48068       nodes:
48069         type: object
48070         $ref: "#/patchDefinitions/nodes"
48071   inventory-item:
48072     properties:
48073       inventory-item-type:
48074         type: string
48075       inventory-item-link:
48076         type: string
48077       inventory-item-data:
48078         type: array
48079         items:
48080           $ref: "#/patchDefinitions/inventory-item-data"
48081       tagged-inventory-item-list:
48082         type: array
48083         items:
48084           $ref: "#/patchDefinitions/tagged-inventory-item-list"
48085   inventory-item-data:
48086     properties:
48087       property-name:
48088         type: string
48089       property-value:
48090         type: string
48091   inventory-response-item:
48092     description: |
48093       Inventory item for response list
48094     properties:
48095       model-name:
48096         type: string
48097       extra-properties:
48098         type: object
48099         $ref: "#/patchDefinitions/extra-properties"
48100       inventory-response-items:
48101         type: object
48102         $ref: "#/patchDefinitions/inventory-response-items"
48103   inventory-response-items:
48104     description: |
48105       Container for inventory items in response list
48106     properties:
48107       inventory-response-item:
48108         type: array
48109         items:
48110           $ref: "#/patchDefinitions/inventory-response-item"
48111   ipsec-configuration:
48112     description: |
48113       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
48114       ###### Related Nodes
48115       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
48116       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
48117
48118       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
48119     required:
48120     - ipsec-configuration-id
48121     properties:
48122       ipsec-configuration-id:
48123         type: string
48124         description: UUID of this configuration
48125       requested-vig-address-type:
48126         type: string
48127         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
48128       requested-encryption-strength:
48129         type: string
48130         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
48131       requested-dmz-type:
48132         type: string
48133         description: can offer a shared DMZ or a DMZ specific to a customer
48134       shared-dmz-network-address:
48135         type: string
48136         description: Network address of shared DMZ
48137       requested-customer-name:
48138         type: string
48139         description: If the DMZ is a custom DMZ, this field will indicate the customer information
48140       ike-version:
48141         type: string
48142         description: can be 1 or 2
48143       ikev1-authentication:
48144         type: string
48145         description: Contains values like md5, sha1, sha256, sha384
48146       ikev1-encryption:
48147         type: string
48148         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
48149       ikev1-dh-group:
48150         type: string
48151         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
48152       ikev1-am-group-id:
48153         type: string
48154         description: Group name defined in VIG for clients using aggressive mode
48155       ikev1-am-password:
48156         type: string
48157         description: pre-shared key for the above group name
48158       ikev1-sa-lifetime:
48159         type: string
48160         description: Lifetime for IKEv1 SA
48161       ipsec-authentication:
48162         type: string
48163         description: md5, sha1, sha256, sha384
48164       ipsec-encryption:
48165         type: string
48166         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
48167       ipsec-sa-lifetime:
48168         type: string
48169         description: Life time for IPSec SA
48170       ipsec-pfs:
48171         type: string
48172         description: enable PFS or not
48173       xauth-userid:
48174         type: string
48175         description: user ID for xAuth, sm-user, ,nmteHostName
48176       xauth-user-password:
48177         type: string
48178         description: Encrypted using the Juniper $9$ algorithm
48179       dpd-interval:
48180         type: string
48181         description: The time between DPD probe
48182       dpd-frequency:
48183         type: string
48184         description: Maximum number of DPD before claiming the tunnel is down
48185   ipsec-configurations:
48186     properties:
48187       ipsec-configuration:
48188         type: array
48189         items:
48190           $ref: "#/patchDefinitions/ipsec-configuration"
48191   key-data:
48192     properties:
48193       key-name:
48194         type: string
48195       key-value:
48196         type: string
48197   l-interface:
48198     description: |
48199       Logical interfaces, e.g., a vnic.
48200       ###### Related Nodes
48201       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
48202       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
48203       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
48204       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48205       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
48206       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
48207       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
48208       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
48209       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
48210       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
48211       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
48212       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
48213       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48214
48215       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
48216       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
48217       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
48218     required:
48219     - interface-name
48220     - is-port-mirrored
48221     - in-maint
48222     properties:
48223       interface-name:
48224         type: string
48225         description: Name given to the interface
48226       interface-role:
48227         type: string
48228         description: E.g., CUSTOMER, UPLINK, etc.
48229       v6-wan-link-ip:
48230         type: string
48231         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
48232       selflink:
48233         type: string
48234         description: URL to endpoint where AAI can get more details
48235       interface-id:
48236         type: string
48237         description: ID of interface
48238       macaddr:
48239         type: string
48240         description: MAC address for the interface
48241       network-name:
48242         type: string
48243         description: Name of the network
48244       management-option:
48245         type: string
48246         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
48247       interface-description:
48248         type: string
48249         description: Human friendly text regarding this interface.
48250       is-port-mirrored:
48251         type: boolean
48252         description: boolean indicatating whether or not port is a mirrored.
48253   l-interfaces:
48254     description: |
48255       Collection of logical interfaces.
48256     properties:
48257       l-interface:
48258         type: array
48259         items:
48260           $ref: "#/patchDefinitions/l-interface"
48261   l3-interface-ipv4-address-list:
48262     description: |
48263       IPv4 Address Range
48264       ###### Related Nodes
48265       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48266       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48267       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
48268       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
48269       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
48270
48271       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
48272     required:
48273     - l3-interface-ipv4-address
48274     properties:
48275       l3-interface-ipv4-address:
48276         type: string
48277         description: IP address
48278       l3-interface-ipv4-prefix-length:
48279         type: integer
48280         format: int64
48281         description: Prefix length, 32 for single address
48282       vlan-id-inner:
48283         type: integer
48284         format: int64
48285         description: Inner VLAN tag
48286       vlan-id-outer:
48287         type: integer
48288         format: int64
48289         description: Outer VLAN tag
48290       is-floating:
48291         type: boolean
48292         description: Indicator of fixed or floating address
48293   l3-interface-ipv6-address-list:
48294     description: |
48295       IPv6 Address Range
48296       ###### Related Nodes
48297       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48298       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48299       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
48300       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
48301       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
48302
48303       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
48304     required:
48305     - l3-interface-ipv6-address
48306     properties:
48307       l3-interface-ipv6-address:
48308         type: string
48309         description: IP address
48310       l3-interface-ipv6-prefix-length:
48311         type: integer
48312         format: int64
48313         description: Prefix length, 128 for single address
48314       vlan-id-inner:
48315         type: integer
48316         format: int64
48317         description: Inner VLAN tag
48318       vlan-id-outer:
48319         type: integer
48320         format: int64
48321         description: Outer VLAN tag
48322       is-floating:
48323         type: boolean
48324         description: Indicator of fixed or floating address
48325   l3-network:
48326     description: |
48327       Generic network definition
48328       ###### Related Nodes
48329       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
48330       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
48331       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
48332       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
48333       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
48334       - FROM complex( complex Uses l3-network, MANY2MANY)
48335       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
48336       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48337       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48338       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
48339       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
48340       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
48341       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
48342       - FROM tenant( tenant Uses l3-network, MANY2MANY)
48343       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
48344
48345       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
48346     required:
48347     - network-id
48348     - network-name
48349     - is-bound-to-vpn
48350     - is-provider-network
48351     - is-shared-network
48352     - is-external-network
48353     properties:
48354       network-id:
48355         type: string
48356         description: Network ID, should be uuid. Unique across A&AI.
48357       network-name:
48358         type: string
48359         description: Name of the network, governed by some naming convention..
48360       network-type:
48361         type: string
48362         description: Type of the network - who defines these values?
48363       network-role:
48364         type: string
48365         description: Role the network plans - who defines these values?
48366       network-technology:
48367         type: string
48368         description: Network technology - who defines these values?
48369       neutron-network-id:
48370         type: string
48371         description: Neutron network id of this Interface
48372       is-bound-to-vpn:
48373         type: boolean
48374         description: Set to true if bound to VPN
48375       service-id:
48376         type: string
48377         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
48378       network-role-instance:
48379         type: integer
48380         format: int64
48381         description: network role instance
48382   l3-networks:
48383     properties:
48384       l3-network:
48385         type: array
48386         items:
48387           $ref: "#/patchDefinitions/l3-network"
48388   lag-interface:
48389     description: |
48390       Link aggregate interface
48391       ###### Related Nodes
48392       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
48393       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
48394       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
48395       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
48396       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
48397       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
48398       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
48399       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
48400
48401       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
48402       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
48403       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
48404     required:
48405     - interface-name
48406     - in-maint
48407     properties:
48408       interface-name:
48409         type: string
48410         description: Name that identifies the link aggregate interface
48411       interface-description:
48412         type: string
48413         description: Human friendly text regarding this interface.
48414   lag-interfaces:
48415     description: |
48416       Collection of link aggregate interfaces.
48417     properties:
48418       lag-interface:
48419         type: array
48420         items:
48421           $ref: "#/patchDefinitions/lag-interface"
48422   lag-link:
48423     description: |
48424       LAG links can connect lag-interfaces
48425       ###### Related Nodes
48426       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
48427       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
48428
48429       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
48430     required:
48431     - link-name
48432     properties:
48433       link-name:
48434         type: string
48435         description: Alphabetical concatenation of lag-interface names
48436   lag-links:
48437     description: |
48438       Collection of link aggregation connections
48439     properties:
48440       lag-link:
48441         type: array
48442         items:
48443           $ref: "#/patchDefinitions/lag-link"
48444   license:
48445     description: |
48446       Metadata for license group.
48447       ###### Related Nodes
48448       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
48449       - TO vce( license BelongsTo vce, MANY2ONE)(4)
48450
48451       -(4) IF this TO node is deleted, this LICENSE is DELETED also
48452     required:
48453     - group-uuid
48454     - resource-uuid
48455     properties:
48456       group-uuid:
48457         type: string
48458         description: Unique ID for the license group the resource belongs to, should be uuid.
48459       resource-uuid:
48460         type: string
48461         description: Unique ID of a license resource.
48462   licenses:
48463     description: |
48464       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
48465     properties:
48466       license:
48467         type: array
48468         items:
48469           $ref: "#/patchDefinitions/license"
48470   line-of-business:
48471     description: |
48472       describes a line-of-business
48473       ###### Related Nodes
48474       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
48475
48476     required:
48477     - line-of-business-name
48478     properties:
48479       line-of-business-name:
48480         type: string
48481         description: Name of the line-of-business (product)
48482   lines-of-business:
48483     description: |
48484       Collection of lines-of-business
48485     properties:
48486       line-of-business:
48487         type: array
48488         items:
48489           $ref: "#/patchDefinitions/line-of-business"
48490   logical-link:
48491     description: |
48492       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
48493       ###### Related Nodes
48494       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
48495       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
48496       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
48497       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
48498       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
48499       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
48500       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
48501       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
48502       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
48503       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
48504       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
48505       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
48506       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
48507       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
48508
48509       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
48510     required:
48511     - link-name
48512     - link-type
48513     properties:
48514       link-name:
48515         type: string
48516         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
48517       link-type:
48518         type: string
48519         description: Type of logical link, e.g., evc
48520       speed-value:
48521         type: string
48522         description: Captures the numeric part of the speed
48523       speed-units:
48524         type: string
48525         description: Captures the units corresponding to the speed
48526       ip-version:
48527         type: string
48528         description: v4, v6, or ds for dual stack
48529       routing-protocol:
48530         type: string
48531         description: For example, static or BGP
48532   logical-links:
48533     description: |
48534       Collection of logical connections
48535     properties:
48536       logical-link:
48537         type: array
48538         items:
48539           $ref: "#/patchDefinitions/logical-link"
48540   metadata:
48541     description: |
48542       Collection of metadatum (key/value pairs)
48543     properties:
48544       metadatum:
48545         type: array
48546         items:
48547           $ref: "#/patchDefinitions/metadatum"
48548   metadatum:
48549     description: |
48550       Key/value pairs
48551       ###### Related Nodes
48552       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
48553       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
48554       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
48555       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
48556
48557       -(4) IF this TO node is deleted, this METADATUM is DELETED also
48558     required:
48559     - metaname
48560     - metaval
48561     properties:
48562       metaname:
48563         type: string
48564       metaval:
48565         type: string
48566   model:
48567     description: |
48568       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
48569       ###### Related Nodes
48570       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
48571       - FROM instance-group( instance-group Targets model, MANY2MANY)
48572       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
48573       - FROM named-query( named-query AppliesTo model, ONE2MANY)
48574       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
48575
48576       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
48577       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
48578
48579     required:
48580     - model-invariant-id
48581     - model-type
48582     properties:
48583       model-invariant-id:
48584         type: string
48585         description: Unique identifier corresponding to the main definition of a model in ASDC
48586       model-type:
48587         type: string
48588         description: Type of the model, e.g., service, resource, widget, etc.
48589   model-and-named-query-search:
48590     description: |
48591       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
48592     properties:
48593       query-parameters:
48594         type: object
48595         $ref: "#/patchDefinitions/query-parameters"
48596       instance-filters:
48597         type: object
48598         $ref: "#/patchDefinitions/instance-filters"
48599       secondary-filts:
48600         type: object
48601         $ref: "#/patchDefinitions/secondary-filts"
48602       top-node-type:
48603         type: string
48604       secondary-filter-cut-point:
48605         type: string
48606   model-constraint:
48607     description: |
48608       This is how we would capture constraints defining allowed sets of elements.
48609       ###### Related Nodes
48610       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
48611       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
48612
48613       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
48614       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
48615     required:
48616     - model-constraint-uuid
48617     - constrained-element-set-uuid-to-replace
48618     properties:
48619       model-constraint-uuid:
48620         type: string
48621       constrained-element-set-uuid-to-replace:
48622         type: string
48623       constrained-element-sets:
48624         type: array
48625         items:
48626           $ref: "#/patchDefinitions/constrained-element-set"
48627   model-constraints:
48628     properties:
48629       model-constraint:
48630         type: array
48631         items:
48632           $ref: "#/patchDefinitions/model-constraint"
48633   model-element:
48634     description: |
48635       Defines how other models combine to make up a higher-level model.
48636       ###### Related Nodes
48637       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
48638       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48639       - TO model-ver( model-element IsA model-ver, MANY2ONE)
48640       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
48641       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
48642       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
48643       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48644
48645       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
48646       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
48647     required:
48648     - model-element-uuid
48649     - new-data-del-flag
48650     - cardinality
48651     properties:
48652       model-element-uuid:
48653         type: string
48654       new-data-del-flag:
48655         type: string
48656         description: Indicates whether this element was created as part of instantiation from this model
48657       cardinality:
48658         type: string
48659         description: How many of this type of element are required/allowed
48660       linkage-points:
48661         type: string
48662   model-elements:
48663     properties:
48664       model-element:
48665         type: array
48666         items:
48667           $ref: "#/patchDefinitions/model-element"
48668   model-ver:
48669     description: |
48670       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
48671       ###### Related Nodes
48672       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
48673       - FROM model-element( model-element IsA model-ver, MANY2ONE)
48674       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
48675       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
48676
48677       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
48678       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
48679       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
48680
48681     required:
48682     - model-version-id
48683     - model-name
48684     - model-version
48685     properties:
48686       model-version-id:
48687         type: string
48688         description: Unique identifier corresponding to one version of a model in ASDC
48689       model-name:
48690         type: string
48691         description: Name of the model, which can change from version to version.
48692       model-version:
48693         type: string
48694         description: Version
48695       model-description:
48696         type: string
48697         description: Description
48698   model-vers:
48699     properties:
48700       model-ver:
48701         type: array
48702         items:
48703           $ref: "#/patchDefinitions/model-ver"
48704   models:
48705     description: |
48706       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
48707     properties:
48708       model:
48709         type: array
48710         items:
48711           $ref: "#/patchDefinitions/model"
48712   multicast-configuration:
48713     description: |
48714       ###### Related Nodes
48715       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
48716
48717     required:
48718     - multicast-configuration-id
48719     - multicast-protocol
48720     - rp-type
48721     properties:
48722       multicast-configuration-id:
48723         type: string
48724         description: Unique id of multicast configuration.
48725       multicast-protocol:
48726         type: string
48727         description: protocol of multicast configuration
48728       rp-type:
48729         type: string
48730         description: rp type of multicast configuration
48731   multicast-configurations:
48732     description: |
48733       multicast configuration of generic-vnf ip-address
48734     properties:
48735       multicast-configuration:
48736         type: array
48737         items:
48738           $ref: "#/patchDefinitions/multicast-configuration"
48739   named-queries:
48740     properties:
48741       named-query:
48742         type: array
48743         items:
48744           $ref: "#/patchDefinitions/named-query"
48745   named-query:
48746     description: |
48747       TBD
48748       ###### Related Nodes
48749       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
48750       - TO model( named-query AppliesTo model, ONE2MANY)
48751       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
48752
48753       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
48754     required:
48755     - named-query-uuid
48756     - named-query-name
48757     - named-query-version
48758     properties:
48759       named-query-uuid:
48760         type: string
48761       named-query-name:
48762         type: string
48763       named-query-version:
48764         type: string
48765       required-input-param:
48766         type: string
48767       description:
48768         type: string
48769   named-query-element:
48770     description: |
48771       TBD
48772       ###### Related Nodes
48773       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
48774       - TO model( named-query-element IsA model, MANY2ONE)
48775       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48776       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
48777       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
48778       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48779
48780       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
48781       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
48782     required:
48783     - named-query-element-uuid
48784     properties:
48785       named-query-element-uuid:
48786         type: string
48787       property-collect-list:
48788         type: string
48789   named-query-elements:
48790     properties:
48791       named-query-element:
48792         type: array
48793         items:
48794           $ref: "#/patchDefinitions/named-query-element"
48795   network:
48796     description: |
48797       Namespace for network inventory resources.
48798     properties:
48799       logical-links:
48800         type: array
48801         items:
48802           $ref: "#/patchDefinitions/logical-link"
48803       site-pair-sets:
48804         type: array
48805         items:
48806           $ref: "#/patchDefinitions/site-pair-set"
48807       vpn-bindings:
48808         type: array
48809         items:
48810           $ref: "#/patchDefinitions/vpn-binding"
48811       vpls-pes:
48812         type: array
48813         items:
48814           $ref: "#/patchDefinitions/vpls-pe"
48815       multicast-configurations:
48816         type: array
48817         items:
48818           $ref: "#/patchDefinitions/multicast-configuration"
48819       vces:
48820         type: array
48821         items:
48822           $ref: "#/patchDefinitions/vce"
48823       vnfcs:
48824         type: array
48825         items:
48826           $ref: "#/patchDefinitions/vnfc"
48827       l3-networks:
48828         type: array
48829         items:
48830           $ref: "#/patchDefinitions/l3-network"
48831       network-policies:
48832         type: array
48833         items:
48834           $ref: "#/patchDefinitions/network-policy"
48835       generic-vnfs:
48836         type: array
48837         items:
48838           $ref: "#/patchDefinitions/generic-vnf"
48839       lag-links:
48840         type: array
48841         items:
48842           $ref: "#/patchDefinitions/lag-link"
48843       newvces:
48844         type: array
48845         items:
48846           $ref: "#/patchDefinitions/newvce"
48847       pnfs:
48848         type: array
48849         items:
48850           $ref: "#/patchDefinitions/pnf"
48851       physical-links:
48852         type: array
48853         items:
48854           $ref: "#/patchDefinitions/physical-link"
48855       ipsec-configurations:
48856         type: array
48857         items:
48858           $ref: "#/patchDefinitions/ipsec-configuration"
48859       route-table-references:
48860         type: array
48861         items:
48862           $ref: "#/patchDefinitions/route-table-reference"
48863       instance-groups:
48864         type: array
48865         items:
48866           $ref: "#/patchDefinitions/instance-group"
48867       zones:
48868         type: array
48869         items:
48870           $ref: "#/patchDefinitions/zone"
48871   network-policies:
48872     properties:
48873       network-policy:
48874         type: array
48875         items:
48876           $ref: "#/patchDefinitions/network-policy"
48877   network-policy:
48878     description: |
48879       ###### Related Nodes
48880       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
48881       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
48882
48883     required:
48884     - network-policy-id
48885     properties:
48886       network-policy-id:
48887         type: string
48888         description: UUID representing unique key to this instance
48889       network-policy-fqdn:
48890         type: string
48891         description: Contrail FQDN for the policy
48892       heat-stack-id:
48893         type: string
48894         description: ID for the openStack Heat instance
48895   network-profile:
48896     description: |
48897       Network profile populated by SDN-GP for SNMP
48898       ###### Related Nodes
48899       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
48900
48901     required:
48902     - nm-profile-name
48903     properties:
48904       nm-profile-name:
48905         type: string
48906         description: Unique name of network profile.
48907       community-string:
48908         type: string
48909         description: Encrypted SNMP community string
48910   network-profiles:
48911     description: |
48912       Collection of network profiles
48913     properties:
48914       network-profile:
48915         type: array
48916         items:
48917           $ref: "#/patchDefinitions/network-profile"
48918   newvce:
48919     description: |
48920       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
48921       ###### Related Nodes
48922       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
48923
48924       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
48925     required:
48926     - vnf-id2
48927     - vnf-name
48928     - vnf-type
48929     properties:
48930       vnf-id2:
48931         type: string
48932         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
48933       vnf-name:
48934         type: string
48935         description: Name of VNF.
48936       vnf-name2:
48937         type: string
48938         description: Alternate name of VNF.
48939       vnf-type:
48940         type: string
48941         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48942       prov-status:
48943         type: string
48944         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48945       operational-status:
48946         type: string
48947         description: Indicator for whether the resource is considered operational
48948       license-key:
48949         type: string
48950         description: OBSOLETE -  do not use
48951       ipv4-oam-address:
48952         type: string
48953         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).
48954       equipment-role:
48955         type: string
48956         description: Client should send valid enumerated value.
48957   newvces:
48958     description: |
48959       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
48960     properties:
48961       newvce:
48962         type: array
48963         items:
48964           $ref: "#/patchDefinitions/newvce"
48965   nodes:
48966     properties:
48967       inventory-item-data:
48968         type: array
48969         items:
48970           $ref: "#/patchDefinitions/inventory-item-data"
48971   notification-event:
48972     properties:
48973       cambria.partition:
48974         type: string
48975       notification-event-header:
48976         type: object
48977         $ref: "#/patchDefinitions/notification-event-header"
48978   notification-event-header:
48979     properties:
48980       id:
48981         type: string
48982       timestamp:
48983         type: string
48984       source-name:
48985         type: string
48986       domain:
48987         type: string
48988       sequence-number:
48989         type: string
48990       severity:
48991         type: string
48992       event-type:
48993         type: string
48994       version:
48995         type: string
48996       action:
48997         type: string
48998       entity-type:
48999         type: string
49000       top-entity-type:
49001         type: string
49002       entity-link:
49003         type: string
49004       status:
49005         type: string
49006   notify:
49007     required:
49008     - event-id
49009     properties:
49010       event-id:
49011         type: string
49012       node-type:
49013         type: string
49014       event-trigger:
49015         type: string
49016       key-data:
49017         type: array
49018         items:
49019           $ref: "#/patchDefinitions/key-data"
49020       selflink:
49021         type: string
49022   oam-network:
49023     description: |
49024       OAM network, to be deprecated shortly.  Do not use for new purposes.
49025       ###### Related Nodes
49026       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
49027       - TO complex( oam-network AppliesTo complex, MANY2MANY)
49028       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
49029
49030     required:
49031     - network-uuid
49032     - network-name
49033     - cvlan-tag
49034     properties:
49035       network-uuid:
49036         type: string
49037         description: UUID of the network. Unique across a cloud-region
49038       network-name:
49039         type: string
49040         description: Name of the network.
49041       cvlan-tag:
49042         type: integer
49043         format: int64
49044         description: cvlan-id
49045       ipv4-oam-gateway-address:
49046         type: string
49047         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
49048       ipv4-oam-gateway-address-prefix-length:
49049         type: integer
49050         format: int32
49051         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
49052   oam-networks:
49053     description: |
49054       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
49055     properties:
49056       oam-network:
49057         type: array
49058         items:
49059           $ref: "#/patchDefinitions/oam-network"
49060   operational-environment:
49061     description: |
49062       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
49063       ###### Related Nodes
49064       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
49065       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
49066
49067     required:
49068     - operational-environment-id
49069     - operational-environment-name
49070     - operational-environment-type
49071     - operational-environment-status
49072     - tenant-context
49073     - workload-context
49074     properties:
49075       operational-environment-id:
49076         type: string
49077         description: UUID of an operational environment
49078       operational-environment-name:
49079         type: string
49080         description: Operational Environment name
49081       operational-environment-type:
49082         type: string
49083         description: Operational Environment Type.
49084       operational-environment-status:
49085         type: string
49086         description: Status
49087       tenant-context:
49088         type: string
49089         description: Tenant Context.
49090       workload-context:
49091         type: string
49092         description: Workload Context.
49093   operational-environments:
49094     description: |
49095       a logical partition of the cloud which allows to have multiple environments in the production AIC.
49096     properties:
49097       operational-environment:
49098         type: array
49099         items:
49100           $ref: "#/patchDefinitions/operational-environment"
49101   overloaded-model:
49102     description: |
49103       Allows for legacy POST of old-style and new-style models
49104     required:
49105     - model-invariant-id
49106     - model-name-version-id
49107     - model-type
49108     - model-name
49109     - model-id
49110     - model-version
49111     properties:
49112       model-invariant-id:
49113         type: string
49114         description: Unique identifier corresponding to the main definition of a model in ASDC
49115       model-name-version-id:
49116         type: string
49117         description: Unique identifier corresponding to one version of a model in ASDC
49118       model-type:
49119         type: string
49120         description: Type of the model, e.g., service, resource, widget, etc.
49121       model-name:
49122         type: string
49123         description: Name of the model, which can change from version to version.
49124       model-id:
49125         type: string
49126         description: Invariant unique ID which does not change from version to version
49127       model-version:
49128         type: string
49129         description: Version
49130       model-description:
49131         type: string
49132         description: Description
49133   owning-entities:
49134     description: |
49135       Collection of owning-entities
49136     properties:
49137       owning-entity:
49138         type: array
49139         items:
49140           $ref: "#/patchDefinitions/owning-entity"
49141   owning-entity:
49142     description: |
49143       describes an owning-entity
49144       ###### Related Nodes
49145       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
49146
49147     required:
49148     - owning-entity-id
49149     - owning-entity-name
49150     properties:
49151       owning-entity-id:
49152         type: string
49153         description: UUID of an owning entity
49154       owning-entity-name:
49155         type: string
49156         description: Owning entity name
49157   p-interface:
49158     description: |
49159       Physical interface (e.g., nic)
49160       ###### Related Nodes
49161       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
49162       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
49163       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
49164       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
49165       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
49166       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
49167       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
49168
49169       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
49170       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
49171       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
49172     required:
49173     - interface-name
49174     - in-maint
49175     properties:
49176       interface-name:
49177         type: string
49178         description: Name that identifies the physical interface
49179       speed-value:
49180         type: string
49181         description: Captures the numeric part of the speed
49182       speed-units:
49183         type: string
49184         description: Captures the units corresponding to the speed
49185       port-description:
49186         type: string
49187         description: Nature of the services and connectivity on this port.
49188       equipment-identifier:
49189         type: string
49190         description: CLEI or other specification for p-interface hardware.
49191       interface-role:
49192         type: string
49193         description: Role specification for p-interface hardware.
49194       interface-type:
49195         type: string
49196         description: Indicates the physical properties of the interface.
49197       prov-status:
49198         type: string
49199         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49200   p-interfaces:
49201     description: |
49202       Collection of physical interfaces.
49203     properties:
49204       p-interface:
49205         type: array
49206         items:
49207           $ref: "#/patchDefinitions/p-interface"
49208   physical-link:
49209     description: |
49210       Collection of physical connections, typically between p-interfaces
49211       ###### Related Nodes
49212       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
49213
49214       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
49215     required:
49216     - link-name
49217     properties:
49218       link-name:
49219         type: string
49220         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
49221       speed-value:
49222         type: string
49223         description: Captures the numeric part of the speed
49224       speed-units:
49225         type: string
49226         description: Captures the units corresponding to the speed
49227       circuit-id:
49228         type: string
49229         description: Circuit it
49230       dual-mode:
49231         type: string
49232         description: Dual access mode (e.g., primary, secondary
49233       management-option:
49234         type: string
49235         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
49236       service-provider-name:
49237         type: string
49238         description: Name of the service Provider on this link.
49239   physical-links:
49240     description: |
49241       Collection of physical connections, typically between p-interfaces
49242     properties:
49243       physical-link:
49244         type: array
49245         items:
49246           $ref: "#/patchDefinitions/physical-link"
49247   platform:
49248     description: |
49249       describes a platform
49250       ###### Related Nodes
49251       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
49252
49253     required:
49254     - platform-name
49255     properties:
49256       platform-name:
49257         type: string
49258         description: Name of the platform
49259   platforms:
49260     description: |
49261       Collection of platforms
49262     properties:
49263       platform:
49264         type: array
49265         items:
49266           $ref: "#/patchDefinitions/platform"
49267   pnf:
49268     description: |
49269       PNF represents a physical network function. typically equipment used in the D1 world.
49270       ###### Related Nodes
49271       - TO complex( pnf LocatedIn complex, MANY2ONE)
49272       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
49273       - TO zone( pnf LocatedIn zone, MANY2ONE)
49274       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
49275       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
49276       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
49277       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
49278
49279       -(1) IF this PNF node is deleted, this FROM node is DELETED also
49280     required:
49281     - pnf-name
49282     - in-maint
49283     properties:
49284       pnf-name:
49285         type: string
49286         description: unique name of Physical Network Function.
49287       pnf-name2:
49288         type: string
49289         description: name of Physical Network Function.
49290       pnf-name2-source:
49291         type: string
49292         description: source of name2
49293       pnf-id:
49294         type: string
49295         description: id of pnf
49296       equip-type:
49297         type: string
49298         description: Equipment type.  Source of truth should define valid values.
49299       equip-vendor:
49300         type: string
49301         description: Equipment vendor.  Source of truth should define valid values.
49302       equip-model:
49303         type: string
49304         description: Equipment model.  Source of truth should define valid values.
49305       management-option:
49306         type: string
49307         description: identifier of managed by company or customer
49308       ipaddress-v4-oam:
49309         type: string
49310         description: ipv4-oam-address with new naming convention for IP addresses
49311       sw-version:
49312         type: string
49313         description: sw-version is the version of SW for the hosted application on the PNF.
49314       in-maint:
49315         type: boolean
49316         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.
49317       frame-id:
49318         type: string
49319         description: ID of the physical frame (relay rack) where pnf is installed.
49320       serial-number:
49321         type: string
49322         description: Serial number of the device
49323       ipaddress-v4-loopback-0:
49324         type: string
49325         description: IPV4 Loopback 0 address
49326       ipaddress-v6-loopback-0:
49327         type: string
49328         description: IPV6 Loopback 0 address
49329       ipaddress-v4-aim:
49330         type: string
49331         description: IPV4 AIM address
49332       ipaddress-v6-aim:
49333         type: string
49334         description: IPV6 AIM address
49335       ipaddress-v6-oam:
49336         type: string
49337         description: IPV6 OAM address
49338       inv-status:
49339         type: string
49340         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49341   pnfs:
49342     description: |
49343       Collection of Physical Network Functions.
49344     properties:
49345       pnf:
49346         type: array
49347         items:
49348           $ref: "#/patchDefinitions/pnf"
49349   port-group:
49350     description: |
49351       Used to capture the network interfaces of this VCE
49352       ###### Related Nodes
49353       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
49354       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
49355
49356       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
49357       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
49358     required:
49359     - interface-id
49360     - orchestration-status
49361     properties:
49362       interface-id:
49363         type: string
49364         description: Unique ID of the interface
49365       neutron-network-id:
49366         type: string
49367         description: Neutron network id of this Interface
49368       neutron-network-name:
49369         type: string
49370         description: Neutron network name of this Interface
49371       interface-role:
49372         type: string
49373         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49374   port-groups:
49375     properties:
49376       port-group:
49377         type: array
49378         items:
49379           $ref: "#/patchDefinitions/port-group"
49380   project:
49381     description: |
49382       describes the project
49383       ###### Related Nodes
49384       - TO service-instance( project Uses service-instance, ONE2MANY)
49385
49386     required:
49387     - project-name
49388     properties:
49389       project-name:
49390         type: string
49391         description: Name of the project deploying a service
49392   projects:
49393     description: |
49394       Collection of projects
49395     properties:
49396       project:
49397         type: array
49398         items:
49399           $ref: "#/patchDefinitions/project"
49400   properties:
49401     description: |
49402       Property holder for query properties or instance properties
49403     properties:
49404       property-name:
49405         type: string
49406       property-value:
49407         type: string
49408   property-constraint:
49409     description: |
49410       TBD
49411       ###### Related Nodes
49412       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
49413
49414       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
49415     required:
49416     - property-constraint-uuid
49417     - constraint-type
49418     - property-name
49419     - property-value
49420     properties:
49421       property-constraint-uuid:
49422         type: string
49423       constraint-type:
49424         type: string
49425       property-name:
49426         type: string
49427       property-value:
49428         type: string
49429   property-constraints:
49430     properties:
49431       property-constraint:
49432         type: array
49433         items:
49434           $ref: "#/patchDefinitions/property-constraint"
49435   pserver:
49436     description: |
49437       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
49438       ###### Related Nodes
49439       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
49440       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
49441       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
49442       - TO complex( pserver LocatedIn complex, MANY2ONE)
49443       - TO zone( pserver LocatedIn zone, MANY2ONE)
49444       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
49445       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
49446       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
49447       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
49448       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
49449
49450       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
49451       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
49452
49453     required:
49454     - hostname
49455     - in-maint
49456     properties:
49457       hostname:
49458         type: string
49459         description: Value from executing hostname on the compute node.
49460       ptnii-equip-name:
49461         type: string
49462         description: PTNII name
49463       number-of-cpus:
49464         type: integer
49465         format: int32
49466         description: Number of cpus
49467       disk-in-gigabytes:
49468         type: integer
49469         format: int32
49470         description: Disk size, in GBs
49471       ram-in-megabytes:
49472         type: integer
49473         format: int32
49474         description: RAM size, in MBs
49475       equip-type:
49476         type: string
49477         description: Equipment type.  Source of truth should define valid values.
49478       equip-vendor:
49479         type: string
49480         description: Equipment vendor.  Source of truth should define valid values.
49481       equip-model:
49482         type: string
49483         description: Equipment model.  Source of truth should define valid values.
49484       fqdn:
49485         type: string
49486         description: Fully-qualified domain name
49487       pserver-selflink:
49488         type: string
49489         description: URL to endpoint where AAI can get more details
49490       ipv4-oam-address:
49491         type: string
49492         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
49493       serial-number:
49494         type: string
49495         description: Serial number, may be queried
49496       ipaddress-v4-loopback-0:
49497         type: string
49498         description: IPV4 Loopback 0 address
49499       ipaddress-v6-loopback-0:
49500         type: string
49501         description: IPV6 Loopback 0 address
49502       ipaddress-v4-aim:
49503         type: string
49504         description: IPV4 AIM address
49505       ipaddress-v6-aim:
49506         type: string
49507         description: IPV6 AIM address
49508       ipaddress-v6-oam:
49509         type: string
49510         description: IPV6 OAM address
49511       inv-status:
49512         type: string
49513         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49514       pserver-id:
49515         type: string
49516         description: ID of Pserver
49517       internet-topology:
49518         type: string
49519         description: internet topology of Pserver
49520       in-maint:
49521         type: boolean
49522         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.
49523   pservers:
49524     description: |
49525       Collection of compute hosts.
49526     properties:
49527       pserver:
49528         type: array
49529         items:
49530           $ref: "#/patchDefinitions/pserver"
49531   query-parameters:
49532     description: |
49533       QueryParameters for performing a named-query or model query
49534     properties:
49535       named-query:
49536         type: object
49537         $ref: "#/patchDefinitions/named-query"
49538       overloaded-model:
49539         type: object
49540         $ref: "#/patchDefinitions/overloaded-model"
49541   related-lookup:
49542     description: |
49543       TBD
49544       ###### Related Nodes
49545       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
49546
49547       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
49548     required:
49549     - related-lookup-uuid
49550     - source-node-type
49551     - source-node-property
49552     - target-node-type
49553     - target-node-property
49554     properties:
49555       related-lookup-uuid:
49556         type: string
49557       source-node-type:
49558         type: string
49559       source-node-property:
49560         type: string
49561       target-node-type:
49562         type: string
49563       target-node-property:
49564         type: string
49565       property-collect-list:
49566         type: string
49567   related-lookups:
49568     properties:
49569       related-lookup:
49570         type: array
49571         items:
49572           $ref: "#/patchDefinitions/related-lookup"
49573   related-to-property:
49574     properties:
49575       property-key:
49576         type: string
49577         description: Key part of a key/value pair
49578       property-value:
49579         type: string
49580         description: Value part of a key/value pair
49581   relationship:
49582     properties:
49583       related-to:
49584         type: string
49585         description: A keyword provided by A&AI to indicate type of node.
49586       related-link:
49587         type: string
49588         description: URL to the object in A&AI.
49589       relationship-data:
49590         type: array
49591         items:
49592           $ref: "#/patchDefinitions/relationship-data"
49593       related-to-property:
49594         type: array
49595         items:
49596           $ref: "#/patchDefinitions/related-to-property"
49597   relationship-data:
49598     required:
49599     - relationship-key
49600     - relationship-value
49601     properties:
49602       relationship-key:
49603         type: string
49604         description: A keyword provided by A&AI to indicate an attribute.
49605       relationship-value:
49606         type: string
49607         description: Value of the attribute.
49608   reserved-prop-names:
49609     description: |
49610       Internal map to define some reserved properties of a vertex
49611     properties:
49612       last-mod-source-of-truth:
49613         type: string
49614       aai-node-type:
49615         type: string
49616       aai-created-ts:
49617         type: integer
49618         format: int64
49619       aai-unique-key:
49620         type: string
49621       aai-last-mod-ts:
49622         type: integer
49623         format: int64
49624       source-of-truth:
49625         type: string
49626       aai-uri:
49627         type: string
49628   response-list:
49629     description: |
49630       Response container for the results of a named-query or model query
49631     properties:
49632       inventory-response-items:
49633         type: object
49634         $ref: "#/patchDefinitions/inventory-response-items"
49635   result-data:
49636     properties:
49637       resource-type:
49638         type: string
49639         description: The specific type of node in the A&AI graph
49640       resource-link:
49641         type: string
49642         description: The URL to the specific resource
49643   route-table-reference:
49644     description: |
49645       Openstack route table reference.
49646       ###### Related Nodes
49647       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
49648
49649     required:
49650     - route-table-reference-id
49651     - route-table-reference-fqdn
49652     properties:
49653       route-table-reference-id:
49654         type: string
49655         description: Route Table Reference id, UUID assigned to this instance.
49656       route-table-reference-fqdn:
49657         type: string
49658         description: FQDN entry in the route table.
49659   route-table-references:
49660     description: |
49661       Collection of openstack route table references
49662     properties:
49663       route-table-reference:
49664         type: array
49665         items:
49666           $ref: "#/patchDefinitions/route-table-reference"
49667   route-target:
49668     description: |
49669       Route target information
49670       ###### Related Nodes
49671       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
49672
49673       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
49674     required:
49675     - global-route-target
49676     - route-target-role
49677     properties:
49678       global-route-target:
49679         type: string
49680         description: Number used to identify an RT, globally unique in the network
49681       route-target-role:
49682         type: string
49683         description: Role assigned to this route target
49684   route-targets:
49685     description: |
49686       Collection of route target information
49687     properties:
49688       route-target:
49689         type: array
49690         items:
49691           $ref: "#/patchDefinitions/route-target"
49692   routing-instance:
49693     description: |
49694       ###### Related Nodes
49695       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
49696       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
49697
49698       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
49699       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
49700     required:
49701     - routing-instance-id
49702     properties:
49703       routing-instance-id:
49704         type: string
49705         description: Unique id of routing instance
49706       rpm-owner:
49707         type: string
49708         description: rpm owner
49709   routing-instances:
49710     description: |
49711       set of probes related to generic-vnf routing instance
49712     properties:
49713       routing-instance:
49714         type: array
49715         items:
49716           $ref: "#/patchDefinitions/routing-instance"
49717   sdn-zone-response:
49718     properties:
49719       oam-networks:
49720         type: object
49721         $ref: "#/patchDefinitions/oam-networks"
49722       az-and-dvs-switches:
49723         type: array
49724         items:
49725           $ref: "#/patchDefinitions/az-and-dvs-switches"
49726   search:
49727     properties:
49728       edge-tag-query-result:
49729         type: object
49730         $ref: "#/patchDefinitions/edge-tag-query-result"
49731       edge-tag-query-request:
49732         type: object
49733         $ref: "#/patchDefinitions/edge-tag-query-request"
49734       search-results:
49735         type: object
49736         $ref: "#/patchDefinitions/search-results"
49737       sdn-zone-response:
49738         type: object
49739         $ref: "#/patchDefinitions/sdn-zone-response"
49740   search-results:
49741     properties:
49742       result-data:
49743         type: array
49744         items:
49745           $ref: "#/patchDefinitions/result-data"
49746   secondary-filt:
49747     description: |
49748       SecondaryFilt for performing a named-query or model query
49749   secondary-filter:
49750     properties:
49751       property-name:
49752         type: string
49753       filter-type:
49754         type: string
49755       property-value:
49756         type: string
49757   secondary-filts:
49758     description: |
49759       SecondaryFilts for performing a named-query or model query
49760     properties:
49761       secondary-filt:
49762         type: array
49763         items:
49764           $ref: "#/patchDefinitions/secondary-filt"
49765   segmentation-assignment:
49766     description: |
49767       Openstack segmentation assignment.
49768       ###### Related Nodes
49769       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
49770
49771       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
49772     required:
49773     - segmentation-id
49774     properties:
49775       segmentation-id:
49776         type: string
49777         description: Route Table Reference id, UUID assigned to this instance.
49778   segmentation-assignments:
49779     description: |
49780       Collection of openstack segmentation assignments
49781     properties:
49782       segmentation-assignment:
49783         type: array
49784         items:
49785           $ref: "#/patchDefinitions/segmentation-assignment"
49786   service:
49787     description: |
49788       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
49789     required:
49790     - service-id
49791     - service-description
49792     properties:
49793       service-id:
49794         type: string
49795         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49796       service-description:
49797         type: string
49798         description: Description of the service
49799       service-selflink:
49800         type: string
49801         description: URL to endpoint where AAI can get more details
49802   service-capabilities:
49803     description: |
49804       Collection of service capabilities.
49805     properties:
49806       service-capability:
49807         type: array
49808         items:
49809           $ref: "#/patchDefinitions/service-capability"
49810   service-capability:
49811     description: |
49812       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
49813       ###### Related Nodes
49814       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
49815       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
49816
49817       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
49818
49819     required:
49820     - service-type
49821     - vnf-type
49822     properties:
49823       service-type:
49824         type: string
49825         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49826       vnf-type:
49827         type: string
49828         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
49829   service-design-and-creation:
49830     description: |
49831       Namespace for objects managed by ASDC
49832     properties:
49833       vnf-images:
49834         type: array
49835         items:
49836           $ref: "#/patchDefinitions/vnf-image"
49837       services:
49838         type: array
49839         items:
49840           $ref: "#/patchDefinitions/service"
49841       service-capabilities:
49842         type: array
49843         items:
49844           $ref: "#/patchDefinitions/service-capability"
49845       models:
49846         type: array
49847         items:
49848           $ref: "#/patchDefinitions/model"
49849       named-queries:
49850         type: array
49851         items:
49852           $ref: "#/patchDefinitions/named-query"
49853   service-instance:
49854     description: |
49855       Instance of a service
49856       ###### Related Nodes
49857       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49858       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49859       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49860       - TO connector( service-instance Uses connector, MANY2MANY)
49861       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49862       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49863       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49864       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49865       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49866       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49867       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49868       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49869       - TO vce( service-instance ComposedOf vce, ONE2MANY)
49870       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49871       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49872       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49873
49874       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49875       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49876       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49877     required:
49878     - service-instance-id
49879     properties:
49880       service-instance-id:
49881         type: string
49882         description: Uniquely identifies this instance of a service
49883       service-instance-name:
49884         type: string
49885         description: This field will store a name assigned to the service-instance.
49886       model-invariant-id:
49887         type: string
49888         description: the ASDC model id for this resource or service model.
49889       model-version-id:
49890         type: string
49891         description: the ASDC model version for this resource or service model.
49892       persona-model-version:
49893         type: string
49894         description: the ASDC model version for this resource or service model.
49895       widget-model-id:
49896         type: string
49897         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49898       widget-model-version:
49899         type: string
49900         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49901       bandwidth-total:
49902         type: string
49903         description: Indicates the total bandwidth to be used for this service.
49904       bandwidth-up-wan1:
49905         type: string
49906         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49907       bandwidth-down-wan1:
49908         type: string
49909         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49910       bandwidth-up-wan2:
49911         type: string
49912         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49913       bandwidth-down-wan2:
49914         type: string
49915         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49916       vhn-portal-url:
49917         type: string
49918         description: URL customers will use to access the vHN Portal.
49919       service-instance-location-id:
49920         type: string
49921         description: An identifier that customers assign to the location where this service is being used.
49922   service-instances:
49923     description: |
49924       Collection of service instances
49925     properties:
49926       service-instance:
49927         type: array
49928         items:
49929           $ref: "#/patchDefinitions/service-instance"
49930   service-subscription:
49931     description: |
49932       Object that group service instances.
49933       ###### Related Nodes
49934       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49935       - TO tenant( service-subscription Uses tenant, MANY2MANY)
49936       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49937
49938       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49939       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49940     required:
49941     - service-type
49942     properties:
49943       service-type:
49944         type: string
49945         description: Value defined by orchestration to identify this service across ECOMP.
49946       temp-ub-sub-account-id:
49947         type: string
49948         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49949   service-subscriptions:
49950     description: |
49951       Collection of objects that group service instances.
49952     properties:
49953       service-subscription:
49954         type: array
49955         items:
49956           $ref: "#/patchDefinitions/service-subscription"
49957   services:
49958     description: |
49959       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
49960     properties:
49961       service:
49962         type: array
49963         items:
49964           $ref: "#/patchDefinitions/service"
49965   site-pair:
49966     description: |
49967       ###### Related Nodes
49968       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49969       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49970
49971       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49972       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49973     required:
49974     - site-pair-id
49975     properties:
49976       site-pair-id:
49977         type: string
49978         description: unique identifier of probe
49979       source-ip:
49980         type: string
49981         description: Prefix address
49982       destination-ip:
49983         type: string
49984         description: Prefix address
49985       ip-version:
49986         type: string
49987         description: ip version, v4, v6
49988       destination-hostname:
49989         type: string
49990         description: Hostname of the destination equipment to which SLAs are measured against.
49991       destination-equip-type:
49992         type: string
49993         description: The type of destinatination equipment. Could be Router, etc.
49994   site-pair-set:
49995     description: |
49996       Set of instances for probes used to measure service level agreements
49997       ###### Related Nodes
49998       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49999       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
50000
50001       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
50002     required:
50003     - site-pair-set-id
50004     properties:
50005       site-pair-set-id:
50006         type: string
50007         description: Unique id of site pair set.
50008   site-pair-sets:
50009     description: |
50010       Collection of sets of instances for probes related to generic-vnf
50011     properties:
50012       site-pair-set:
50013         type: array
50014         items:
50015           $ref: "#/patchDefinitions/site-pair-set"
50016   site-pairs:
50017     description: |
50018       probe within a set
50019     properties:
50020       site-pair:
50021         type: array
50022         items:
50023           $ref: "#/patchDefinitions/site-pair"
50024   snapshot:
50025     description: |
50026       Openstack snapshot
50027       ###### Related Nodes
50028       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
50029       - FROM vserver( vserver Uses snapshot, ONE2ONE)
50030
50031     required:
50032     - snapshot-id
50033     properties:
50034       snapshot-id:
50035         type: string
50036         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
50037       snapshot-name:
50038         type: string
50039         description: Snapshot name
50040       snapshot-architecture:
50041         type: string
50042         description: Operating system architecture
50043       snapshot-os-distro:
50044         type: string
50045         description: The common name of the operating system distribution in lowercase
50046       snapshot-os-version:
50047         type: string
50048         description: The operating system version as specified by the distributor.
50049       application:
50050         type: string
50051         description: The application that the image instantiates.
50052       application-vendor:
50053         type: string
50054         description: The vendor of the application.
50055       application-version:
50056         type: string
50057         description: The version of the application.
50058       snapshot-selflink:
50059         type: string
50060         description: URL to endpoint where AAI can get more details
50061       prev-snapshot-id:
50062         type: string
50063         description: This field contains the UUID of the previous snapshot (if any).
50064   snapshots:
50065     description: |
50066       Collection of openstack snapshots
50067     properties:
50068       snapshot:
50069         type: array
50070         items:
50071           $ref: "#/patchDefinitions/snapshot"
50072   sriov-pf:
50073     description: |
50074       SR-IOV Physical Function
50075       ###### Related Nodes
50076       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
50077       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
50078
50079       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
50080     required:
50081     - pf-pci-id
50082     properties:
50083       pf-pci-id:
50084         type: string
50085         description: Identifier for the sriov-pf
50086   sriov-pfs:
50087     description: |
50088       Collection of SR-IOV Physical Functions.
50089     properties:
50090       sriov-pf:
50091         type: array
50092         items:
50093           $ref: "#/patchDefinitions/sriov-pf"
50094   sriov-vf:
50095     description: |
50096       SR-IOV Virtual Function (not to be confused with virtual network function)
50097       ###### Related Nodes
50098       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
50099
50100       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
50101     required:
50102     - pci-id
50103     properties:
50104       pci-id:
50105         type: string
50106         description: PCI ID used to identify the sriov-vf
50107       vf-vlan-filter:
50108         type: string
50109         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
50110       vf-mac-filter:
50111         type: string
50112         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
50113       vf-vlan-strip:
50114         type: boolean
50115         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
50116       vf-vlan-anti-spoof-check:
50117         type: boolean
50118         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.
50119       vf-mac-anti-spoof-check:
50120         type: boolean
50121         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.
50122       vf-mirrors:
50123         type: string
50124         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
50125       vf-broadcast-allow:
50126         type: boolean
50127         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
50128       vf-unknown-multicast-allow:
50129         type: boolean
50130         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
50131       vf-unknown-unicast-allow:
50132         type: boolean
50133         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
50134       vf-insert-stag:
50135         type: boolean
50136         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
50137       vf-link-status:
50138         type: string
50139         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
50140   sriov-vfs:
50141     description: |
50142       Collection of SR-IOV Virtual Functions.
50143     properties:
50144       sriov-vf:
50145         type: array
50146         items:
50147           $ref: "#/patchDefinitions/sriov-vf"
50148   start-node-filter:
50149     properties:
50150       property-name:
50151         type: string
50152       property-value:
50153         type: string
50154   subnet:
50155     description: |
50156       ###### Related Nodes
50157       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
50158       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
50159       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
50160
50161       -(4) IF this TO node is deleted, this SUBNET is DELETED also
50162       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
50163
50164     required:
50165     - subnet-id
50166     - dhcp-enabled
50167     properties:
50168       subnet-id:
50169         type: string
50170         description: Subnet ID, should be UUID.
50171       subnet-name:
50172         type: string
50173         description: Name associated with the subnet.
50174       neutron-subnet-id:
50175         type: string
50176         description: Neutron id of this subnet
50177       gateway-address:
50178         type: string
50179         description: gateway ip address
50180       network-start-address:
50181         type: string
50182         description: network start address
50183       cidr-mask:
50184         type: string
50185         description: cidr mask
50186       ip-version:
50187         type: string
50188         description: ip version
50189       orchestration-status:
50190         type: string
50191         description: Orchestration status of this VNF, mastered by MSO
50192       dhcp-enabled:
50193         type: boolean
50194         description: dhcp enabled
50195       dhcp-start:
50196         type: string
50197         description: the start address reserved for use by dhcp
50198       dhcp-end:
50199         type: string
50200         description: the last address reserved for use by dhcp
50201   subnets:
50202     properties:
50203       subnet:
50204         type: array
50205         items:
50206           $ref: "#/patchDefinitions/subnet"
50207   tagged-inventory-item-list:
50208     properties:
50209       inventory-item:
50210         type: array
50211         items:
50212           $ref: "#/patchDefinitions/inventory-item"
50213   tenant:
50214     description: |
50215       Openstack tenant
50216       ###### Related Nodes
50217       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
50218       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
50219       - TO l3-network( tenant Uses l3-network, MANY2MANY)
50220       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
50221       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
50222       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
50223
50224       -TENANT cannot be deleted if related to VSERVER
50225
50226     required:
50227     - tenant-id
50228     - tenant-name
50229     properties:
50230       tenant-id:
50231         type: string
50232         description: Unique id relative to the cloud-region.
50233       tenant-name:
50234         type: string
50235         description: Readable name of tenant
50236   tenants:
50237     description: |
50238       Collection of openstack tenants.
50239     properties:
50240       tenant:
50241         type: array
50242         items:
50243           $ref: "#/patchDefinitions/tenant"
50244   tunnel-xconnect:
50245     description: |
50246       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
50247       ###### Related Nodes
50248       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
50249
50250       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
50251     required:
50252     - id
50253     - bandwidth-up-wan1
50254     - bandwidth-down-wan1
50255     - bandwidth-up-wan2
50256     - bandwidth-down-wan2
50257     properties:
50258       id:
50259         type: string
50260         description: Allotted Resource id UUID assigned to this instance.
50261       bandwidth-up-wan1:
50262         type: string
50263         description: The WAN uplink bandwidth for WAN1
50264       bandwidth-down-wan1:
50265         type: string
50266         description: The WAN downlink bandwidth for WAN1
50267       bandwidth-up-wan2:
50268         type: string
50269         description: The WAN uplink bandwidth for WAN2
50270       bandwidth-down-wan2:
50271         type: string
50272         description: The WAN downlink bandwidth for WAN2
50273   tunnel-xconnects:
50274     description: |
50275       This object is used to store the specific tunnel cross connect aspects of an allotted resource
50276     properties:
50277       tunnel-xconnect:
50278         type: array
50279         items:
50280           $ref: "#/patchDefinitions/tunnel-xconnect"
50281   update:
50282     description: |
50283       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
50284     required:
50285     - update-node-type
50286     properties:
50287       update-node-type:
50288         type: string
50289       update-node-key:
50290         type: array
50291         items:
50292           $ref: "#/patchDefinitions/update-node-key"
50293       update-node-uri:
50294         type: string
50295       action:
50296         type: array
50297         items:
50298           $ref: "#/patchDefinitions/action"
50299   update-node-key:
50300     properties:
50301       key-name:
50302         type: string
50303       key-value:
50304         type: string
50305   vce:
50306     description: |
50307       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
50308       ###### Related Nodes
50309       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
50310       - TO complex( vce LocatedIn complex, MANY2MANY)
50311       - TO vserver( vce HostedOn vserver, ONE2MANY)
50312       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
50313       - FROM license( license BelongsTo vce, MANY2ONE)(1)
50314       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
50315       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
50316
50317       -(1) IF this VCE node is deleted, this FROM node is DELETED also
50318     required:
50319     - vnf-id
50320     - vnf-name
50321     - vnf-type
50322     properties:
50323       vnf-id:
50324         type: string
50325         description: Unique id of VNF.  This is unique across the graph.
50326       vnf-name:
50327         type: string
50328         description: Name of VNF.
50329       vnf-name2:
50330         type: string
50331         description: Alternate name of VNF.
50332       vnf-type:
50333         type: string
50334         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50335       service-id:
50336         type: string
50337         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
50338       regional-resource-zone:
50339         type: string
50340         description: Regional way of organizing pservers, source of truth should define values
50341       prov-status:
50342         type: string
50343         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50344       operational-status:
50345         type: string
50346         description: Indicator for whether the resource is considered operational
50347       license-key:
50348         type: string
50349         description: OBSOLETE -  do not use
50350       equipment-role:
50351         type: string
50352         description: Network role being played by this VNF
50353       orchestration-status:
50354         type: string
50355         description: Orchestration status of this VNF, mastered by MSO
50356       heat-stack-id:
50357         type: string
50358         description: Heat stack id corresponding to this instance, managed by MSO
50359       mso-catalog-key:
50360         type: string
50361         description: Corresponds to the SDN-C catalog id used to configure this VCE
50362       vpe-id:
50363         type: string
50364         description: Unique ID of VPE connected to this VCE.
50365       v6-vce-wan-address:
50366         type: string
50367         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
50368       ipv4-oam-address:
50369         type: string
50370         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
50371   vces:
50372     description: |
50373       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
50374     properties:
50375       vce:
50376         type: array
50377         items:
50378           $ref: "#/patchDefinitions/vce"
50379   vf-module:
50380     description: |
50381       a deployment unit of VNFCs
50382       ###### Related Nodes
50383       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
50384       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
50385       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
50386       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
50387       - TO vserver( vf-module Uses vserver, ONE2MANY)
50388
50389       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
50390       -VF-MODULE cannot be deleted if related to VNFC
50391
50392     required:
50393     - vf-module-id
50394     - is-base-vf-module
50395     properties:
50396       vf-module-id:
50397         type: string
50398         description: Unique ID of vf-module.
50399       vf-module-name:
50400         type: string
50401         description: Name of vf-module
50402       heat-stack-id:
50403         type: string
50404         description: Heat stack id corresponding to this instance.
50405       orchestration-status:
50406         type: string
50407         description: orchestration status of this vf-module, mastered by MSO
50408       is-base-vf-module:
50409         type: boolean
50410         description: used to indicate whether or not this object is base vf module
50411   vf-modules:
50412     description: |
50413       Collection of vf-modules, a deployment unit of VNFCs
50414     properties:
50415       vf-module:
50416         type: array
50417         items:
50418           $ref: "#/patchDefinitions/vf-module"
50419   vig-server:
50420     description: |
50421       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
50422       ###### Related Nodes
50423       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
50424
50425       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
50426     required:
50427     - vig-address-type
50428     properties:
50429       vig-address-type:
50430         type: string
50431         description: indicates whether the VIG is for AVPN or INTERNET
50432       ipaddress-v4-vig:
50433         type: string
50434         description: v4 IP of the vig server
50435       ipaddress-v6-vig:
50436         type: string
50437         description: v6 IP of the vig server
50438   vig-servers:
50439     properties:
50440       vig-server:
50441         type: array
50442         items:
50443           $ref: "#/patchDefinitions/vig-server"
50444   vip-ipv4-address-list:
50445     description: |
50446       IPv4 Address Range
50447       ###### Related Nodes
50448       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50449       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
50450       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
50451       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50452
50453     required:
50454     - vip-ipv4-address
50455     properties:
50456       vip-ipv4-address:
50457         type: string
50458         description: IP address
50459       vip-ipv4-prefix-length:
50460         type: integer
50461         format: int64
50462         description: Prefix length, 32 for single address
50463       vlan-id-inner:
50464         type: integer
50465         format: int64
50466         description: Inner VLAN tag
50467       vlan-id-outer:
50468         type: integer
50469         format: int64
50470         description: Outer VLAN tag
50471       is-floating:
50472         type: boolean
50473         description: Indicator of fixed or floating address
50474   vip-ipv6-address-list:
50475     description: |
50476       IPv6 Address Range
50477       ###### Related Nodes
50478       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50479       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
50480       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
50481       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50482
50483     required:
50484     - vip-ipv6-address
50485     properties:
50486       vip-ipv6-address:
50487         type: string
50488         description: IP address
50489       vip-ipv6-prefix-length:
50490         type: integer
50491         format: int64
50492         description: Prefix length, 128 for single address
50493       vlan-id-inner:
50494         type: integer
50495         format: int64
50496         description: Inner VLAN tag
50497       vlan-id-outer:
50498         type: integer
50499         format: int64
50500         description: Outer VLAN tag
50501       is-floating:
50502         type: boolean
50503         description: Indicator of fixed or floating address
50504   virtual-data-center:
50505     description: |
50506       Virtual organization of cloud infrastructure elements in a data center context
50507       ###### Related Nodes
50508       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
50509       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
50510       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
50511
50512     required:
50513     - vdc-id
50514     - vdc-name
50515     properties:
50516       vdc-id:
50517         type: string
50518         description: Unique ID of the vdc
50519       vdc-name:
50520         type: string
50521         description: Name of the virtual data center
50522   virtual-data-centers:
50523     description: |
50524       Virtual organization of cloud infrastructure elements in a data center context
50525     properties:
50526       virtual-data-center:
50527         type: array
50528         items:
50529           $ref: "#/patchDefinitions/virtual-data-center"
50530   vlan:
50531     description: |
50532       Definition of vlan
50533       ###### Related Nodes
50534       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
50535       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
50536       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
50537       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
50538       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
50539       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
50540       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
50541
50542       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
50543       -(2) IF this VLAN node is deleted, this TO node is DELETED also
50544       -(4) IF this TO node is deleted, this VLAN is DELETED also
50545     required:
50546     - vlan-interface
50547     - in-maint
50548     properties:
50549       vlan-interface:
50550         type: string
50551         description: String that identifies the interface
50552       vlan-id-inner:
50553         type: integer
50554         format: int64
50555         description: Inner VLAN tag
50556       vlan-id-outer:
50557         type: integer
50558         format: int64
50559         description: Outer VLAN tag
50560   vlans:
50561     properties:
50562       vlan:
50563         type: array
50564         items:
50565           $ref: "#/patchDefinitions/vlan"
50566   vnf:
50567     description: |
50568       Abstract vnf class
50569     required:
50570     - vnf-id
50571     properties:
50572       vnf-id:
50573         type: string
50574         description: Unique id of VNF.  This is unique across the graph.
50575   vnf-image:
50576     description: |
50577       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50578       ###### Related Nodes
50579       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50580
50581       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50582
50583     required:
50584     - vnf-image-uuid
50585     - application
50586     - application-vendor
50587     properties:
50588       vnf-image-uuid:
50589         type: string
50590         description: Unique ID of this asset
50591       application:
50592         type: string
50593         description: The application that the image instantiates.
50594       application-vendor:
50595         type: string
50596         description: The vendor of the application.
50597       application-version:
50598         type: string
50599         description: The version of the application.
50600       selflink:
50601         type: string
50602         description: URL to endpoint where AAI can get more details
50603   vnf-images:
50604     description: |
50605       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50606     properties:
50607       vnf-image:
50608         type: array
50609         items:
50610           $ref: "#/patchDefinitions/vnf-image"
50611   vnfc:
50612     description: |
50613       ###### Related Nodes
50614       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50615       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50616       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50617
50618       -(4) IF this TO node is deleted, this VNFC is DELETED also
50619     required:
50620     - vnfc-name
50621     - vnfc-function-code
50622     - vnfc-type
50623     - in-maint
50624     - is-closed-loop-disabled
50625     properties:
50626       vnfc-name:
50627         type: string
50628         description: Unique ID of vnfc.
50629       vnfc-function-code:
50630         type: string
50631         description: function code
50632       vnfc-type:
50633         type: string
50634         description: type
50635       prov-status:
50636         type: string
50637         description: prov status of this vnfc
50638       orchestration-status:
50639         type: string
50640         description: Orchestration status of this VNF, mastered by APP-C
50641       ipaddress-v4-oam-vip:
50642         type: string
50643         description: Oam V4 vip address of this vnfc
50644       in-maint:
50645         type: boolean
50646         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50647       is-closed-loop-disabled:
50648         type: boolean
50649         description: used to indicate whether closed loop function is enabled on this node
50650       group-notation:
50651         type: string
50652         description: Group notation of VNFC
50653   vnfcs:
50654     description: |
50655       virtual network components associated with a vserver from application controller.
50656     properties:
50657       vnfc:
50658         type: array
50659         items:
50660           $ref: "#/patchDefinitions/vnfc"
50661   volume:
50662     description: |
50663       Ephemeral Block storage volume.
50664       ###### Related Nodes
50665       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50666
50667       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50668     required:
50669     - volume-id
50670     - volume-selflink
50671     properties:
50672       volume-id:
50673         type: string
50674         description: Unique ID of block storage volume relative to the vserver.
50675       volume-selflink:
50676         type: string
50677         description: URL to endpoint where AAI can get more details
50678   volume-group:
50679     description: |
50680       Persistent block-level storage.
50681       ###### Related Nodes
50682       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50683       - TO complex( volume-group LocatedIn complex, MANY2ONE)
50684       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50685       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50686       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50687
50688     required:
50689     - volume-group-id
50690     - volume-group-name
50691     - vnf-type
50692     properties:
50693       volume-group-id:
50694         type: string
50695         description: Unique ID of volume-group.
50696       volume-group-name:
50697         type: string
50698         description: Name of the volume group.
50699       heat-stack-id:
50700         type: string
50701         description: Heat stack id corresponding to this volume-group
50702       vnf-type:
50703         type: string
50704         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50705       orchestration-status:
50706         type: string
50707         description: Orchestration status of this volume-group
50708       model-customization-id:
50709         type: string
50710         description: captures the id of all the configuration used to customize the resource for the service.
50711       vf-module-model-customization-id:
50712         type: string
50713         description: helps relate the volume group to the vf-module whose components will require the volume group
50714   volume-groups:
50715     description: |
50716       Collection of persistent block-level storage.
50717     properties:
50718       volume-group:
50719         type: array
50720         items:
50721           $ref: "#/patchDefinitions/volume-group"
50722   volumes:
50723     description: |
50724       Collection of ephemeral Block storage volumes.
50725     properties:
50726       volume:
50727         type: array
50728         items:
50729           $ref: "#/patchDefinitions/volume"
50730   vpls-pe:
50731     description: |
50732       VPLS Provider Edge routers.
50733       ###### Related Nodes
50734       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50735       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50736       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50737       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50738
50739       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50740     required:
50741     - equipment-name
50742     properties:
50743       equipment-name:
50744         type: string
50745       prov-status:
50746         type: string
50747         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50748       ipv4-oam-address:
50749         type: string
50750         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).
50751       equipment-role:
50752         type: string
50753         description: Client should send valid enumerated value, e.g., VPLS-PE.
50754       vlan-id-outer:
50755         type: integer
50756         format: int64
50757         description: Temporary location for stag to get to VCE
50758   vpls-pes:
50759     description: |
50760       Collection of VPLS Provider Edge routers
50761     properties:
50762       vpls-pe:
50763         type: array
50764         items:
50765           $ref: "#/patchDefinitions/vpls-pe"
50766   vpn-binding:
50767     description: |
50768       VPN binding
50769       ###### Related Nodes
50770       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50771       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50772       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
50773
50774       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
50775       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
50776
50777     required:
50778     - vpn-id
50779     - vpn-name
50780     properties:
50781       vpn-id:
50782         type: string
50783         description: VPN ID, globally unique within A&AI
50784       vpn-name:
50785         type: string
50786         description: VPN Name
50787       vpn-platform:
50788         type: string
50789         description: the platform associated with the VPN example AVPN, Mobility
50790       vpn-type:
50791         type: string
50792         description: Type of the vpn, should be taken from enumerated/valid values
50793       route-distinguisher:
50794         type: string
50795         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50796   vpn-bindings:
50797     properties:
50798       vpn-binding:
50799         type: array
50800         items:
50801           $ref: "#/patchDefinitions/vpn-binding"
50802   vserver:
50803     description: |
50804       Virtual Servers, aka virtual machine or VM.
50805       ###### Related Nodes
50806       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50807       - TO flavor( vserver Uses flavor, MANY2ONE)
50808       - TO image( vserver Uses image, MANY2ONE)
50809       - TO pserver( vserver HostedOn pserver, MANY2ONE)
50810       - TO snapshot( vserver Uses snapshot, ONE2ONE)
50811       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50812       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50813       - FROM vce( vce HostedOn vserver, ONE2MANY)
50814       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50815       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50816       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50817
50818       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50819       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50820     required:
50821     - vserver-id
50822     - vserver-name
50823     - vserver-selflink
50824     - in-maint
50825     - is-closed-loop-disabled
50826     properties:
50827       vserver-id:
50828         type: string
50829         description: Unique identifier for this vserver relative to its tenant
50830       vserver-name:
50831         type: string
50832         description: Name of vserver
50833       vserver-name2:
50834         type: string
50835         description: Alternative name of vserver
50836       prov-status:
50837         type: string
50838         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50839       vserver-selflink:
50840         type: string
50841         description: URL to endpoint where AAI can get more details
50842       in-maint:
50843         type: boolean
50844         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.
50845       is-closed-loop-disabled:
50846         type: boolean
50847         description: Used to indicate whether closed loop function is enabled on this node
50848   vservers:
50849     description: |
50850       Collection of virtual Servers, aka virtual machines or VMs.
50851     properties:
50852       vserver:
50853         type: array
50854         items:
50855           $ref: "#/patchDefinitions/vserver"
50856   zone:
50857     description: |
50858       A zone is a grouping of assets in a location homing to the same connections into the CBB
50859       ###### Related Nodes
50860       - TO complex( zone LocatedIn complex, MANY2ONE)
50861       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50862       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50863       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50864
50865     required:
50866     - zone-id
50867     - zone-name
50868     - design-type
50869     - zone-context
50870     properties:
50871       zone-id:
50872         type: string
50873         description: Code assigned by AIC to the zone
50874       zone-name:
50875         type: string
50876         description: English name associated with the zone
50877       design-type:
50878         type: string
50879         description: Design of zone [Medium/Large?]
50880       zone-context:
50881         type: string
50882         description: Context of zone [production/test]
50883       status:
50884         type: string
50885         description: Status of a zone.
50886   zones:
50887     description: |
50888       Collection of zones
50889     properties:
50890       zone:
50891         type: array
50892         items:
50893           $ref: "#/patchDefinitions/zone"
50894 getDefinitions:
50895   action:
50896     properties:
50897       action-type:
50898         type: string
50899       action-data:
50900         type: array
50901         items:
50902           $ref: "#/getDefinitions/action-data"
50903   action-data:
50904     properties:
50905       property-name:
50906         type: string
50907       property-value:
50908         type: string
50909   actions:
50910     description: |
50911       APIs that are more action related than REST (e.g., notify, update).
50912     properties:
50913       update:
50914         type: object
50915         $ref: "#/getDefinitions/update"
50916       notify:
50917         type: object
50918         $ref: "#/getDefinitions/notify"
50919   allotted-resource:
50920     description: |
50921       Represents a slice or partial piece of a resource that gets separately allotted
50922       ###### Related Nodes
50923       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50924       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50925       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50926       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
50927       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50928       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50929       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50930       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50931
50932       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50933       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50934     required:
50935     - id
50936     properties:
50937       id:
50938         type: string
50939         description: Allotted Resource id UUID assigned to this instance.
50940       description:
50941         type: string
50942         description: The descriptive information assigned to this allotted resource instance
50943       selflink:
50944         type: string
50945         description: Link back to more information in the controller
50946       model-invariant-id:
50947         type: string
50948         description: the ASDC model id for this resource or service model.
50949       model-version-id:
50950         type: string
50951         description: the ASDC model version for this resource or service model.
50952       persona-model-version:
50953         type: string
50954         description: the ASDC model version for this resource or service model.
50955       resource-version:
50956         type: string
50957         description: Concurrency value
50958       orchestration-status:
50959         type: string
50960         description: Orchestration status
50961       operational-status:
50962         type: string
50963         description: Indicator for whether the resource is considered operational
50964       type:
50965         type: string
50966         description: Generic description of the type of allotted resource.
50967       role:
50968         type: string
50969         description: role in the network that this resource will be providing.
50970       tunnel-xconnects:
50971         type: array
50972         items:
50973           $ref: "#/getDefinitions/tunnel-xconnect"
50974       relationship-list:
50975         type: array
50976         items:
50977           $ref: "#/getDefinitions/relationship"
50978   allotted-resources:
50979     description: |
50980       This object is used to store slices of services being offered
50981     properties:
50982       allotted-resource:
50983         type: array
50984         items:
50985           $ref: "#/getDefinitions/allotted-resource"
50986   availability-zone:
50987     description: |
50988       Availability zone, a collection of compute hosts/pservers
50989       ###### Related Nodes
50990       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50991       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50992       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50993       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50994       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50995       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50996       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50997       - FROM vce( vce Uses availability-zone, MANY2MANY)
50998
50999       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
51000       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
51001
51002     required:
51003     - availability-zone-name
51004     - hypervisor-type
51005     properties:
51006       availability-zone-name:
51007         type: string
51008         description: Name of the availability zone.  Unique across a cloud region
51009       hypervisor-type:
51010         type: string
51011         description: Type of hypervisor.  Source of truth should define valid values.
51012       operational-status:
51013         type: string
51014         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
51015       resource-version:
51016         type: string
51017         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51018       relationship-list:
51019         type: array
51020         items:
51021           $ref: "#/getDefinitions/relationship"
51022   availability-zones:
51023     description: |
51024       Collection of availability zones
51025     properties:
51026       availability-zone:
51027         type: array
51028         items:
51029           $ref: "#/getDefinitions/availability-zone"
51030   az-and-dvs-switches:
51031     properties:
51032       dvs-switches:
51033         type: object
51034         $ref: "#/getDefinitions/dvs-switches"
51035       availability-zone:
51036         type: object
51037         $ref: "#/getDefinitions/availability-zone"
51038   business:
51039     description: |
51040       Namespace for business related constructs
51041     properties:
51042       connectors:
51043         type: array
51044         items:
51045           $ref: "#/getDefinitions/connector"
51046       customers:
51047         type: array
51048         items:
51049           $ref: "#/getDefinitions/customer"
51050   class-of-service:
51051     description: |
51052       ###### Related Nodes
51053       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
51054
51055       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
51056     required:
51057     - cos
51058     properties:
51059       cos:
51060         type: string
51061         description: unique identifier of probe
51062       probe-id:
51063         type: string
51064         description: identifier of probe
51065       probe-type:
51066         type: string
51067         description: type of probe
51068       resource-version:
51069         type: string
51070         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51071       relationship-list:
51072         type: array
51073         items:
51074           $ref: "#/getDefinitions/relationship"
51075   classes-of-service:
51076     description: |
51077       class-of-service of probe
51078     properties:
51079       class-of-service:
51080         type: array
51081         items:
51082           $ref: "#/getDefinitions/class-of-service"
51083   cloud-infrastructure:
51084     description: |
51085       Namespace for cloud infrastructure.
51086     properties:
51087       complexes:
51088         type: array
51089         items:
51090           $ref: "#/getDefinitions/complex"
51091       cloud-regions:
51092         type: array
51093         items:
51094           $ref: "#/getDefinitions/cloud-region"
51095       network-profiles:
51096         type: array
51097         items:
51098           $ref: "#/getDefinitions/network-profile"
51099       pservers:
51100         type: array
51101         items:
51102           $ref: "#/getDefinitions/pserver"
51103       virtual-data-centers:
51104         type: array
51105         items:
51106           $ref: "#/getDefinitions/virtual-data-center"
51107   cloud-region:
51108     description: |
51109       cloud-region designates an installation of a cloud cluster or region or instantiation
51110       ###### Related Nodes
51111       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
51112       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
51113       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
51114       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
51115       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
51116       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
51117       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
51118       - FROM image( image BelongsTo cloud-region, MANY2ONE)
51119       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
51120       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
51121       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
51122       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
51123       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
51124       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
51125
51126       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
51127       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
51128
51129     required:
51130     - cloud-owner
51131     - cloud-region-id
51132     properties:
51133       cloud-owner:
51134         type: string
51135         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
51136       cloud-region-id:
51137         type: string
51138         description: Identifier used by the vendor for the region. Second part of composite key
51139       cloud-type:
51140         type: string
51141         description: Type of the cloud (e.g., openstack)
51142       owner-defined-type:
51143         type: string
51144         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
51145       cloud-region-version:
51146         type: string
51147         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
51148       identity-url:
51149         type: string
51150         description: URL of the keystone identity service
51151       cloud-zone:
51152         type: string
51153         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
51154       complex-name:
51155         type: string
51156         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
51157       resource-version:
51158         type: string
51159         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51160       volume-groups:
51161         type: array
51162         items:
51163           $ref: "#/getDefinitions/volume-group"
51164       tenants:
51165         type: array
51166         items:
51167           $ref: "#/getDefinitions/tenant"
51168       flavors:
51169         type: array
51170         items:
51171           $ref: "#/getDefinitions/flavor"
51172       group-assignments:
51173         type: array
51174         items:
51175           $ref: "#/getDefinitions/group-assignment"
51176       snapshots:
51177         type: array
51178         items:
51179           $ref: "#/getDefinitions/snapshot"
51180       images:
51181         type: array
51182         items:
51183           $ref: "#/getDefinitions/image"
51184       dvs-switches:
51185         type: array
51186         items:
51187           $ref: "#/getDefinitions/dvs-switch"
51188       oam-networks:
51189         type: array
51190         items:
51191           $ref: "#/getDefinitions/oam-network"
51192       availability-zones:
51193         type: array
51194         items:
51195           $ref: "#/getDefinitions/availability-zone"
51196       relationship-list:
51197         type: array
51198         items:
51199           $ref: "#/getDefinitions/relationship"
51200   cloud-regions:
51201     properties:
51202       cloud-region:
51203         type: array
51204         items:
51205           $ref: "#/getDefinitions/cloud-region"
51206   complex:
51207     description: |
51208       Collection of physical locations that can house cloud-regions.
51209       ###### Related Nodes
51210       - TO l3-network( complex Uses l3-network, MANY2MANY)
51211       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
51212       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
51213       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
51214       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
51215       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
51216       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
51217       - FROM vce( vce LocatedIn complex, MANY2MANY)
51218       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
51219       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
51220       - FROM zone( zone LocatedIn complex, MANY2ONE)
51221
51222       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
51223       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
51224
51225     required:
51226     - physical-location-id
51227     - physical-location-type
51228     - street1
51229     - city
51230     - postal-code
51231     - country
51232     - region
51233     properties:
51234       physical-location-id:
51235         type: string
51236         description: Unique identifier for physical location, e.g., CLLI
51237       data-center-code:
51238         type: string
51239         description: Data center code which can be an alternate way to identify a complex
51240       complex-name:
51241         type: string
51242         description: Gamma complex name for LCP instance.
51243       identity-url:
51244         type: string
51245         description: URL of the keystone identity service
51246       resource-version:
51247         type: string
51248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51249       physical-location-type:
51250         type: string
51251         description: Type, e.g., central office, data center.
51252       street1:
51253         type: string
51254       street2:
51255         type: string
51256       city:
51257         type: string
51258       state:
51259         type: string
51260       postal-code:
51261         type: string
51262       country:
51263         type: string
51264       region:
51265         type: string
51266       latitude:
51267         type: string
51268       longitude:
51269         type: string
51270       elevation:
51271         type: string
51272       lata:
51273         type: string
51274       ctag-pools:
51275         type: array
51276         items:
51277           $ref: "#/getDefinitions/ctag-pool"
51278       relationship-list:
51279         type: array
51280         items:
51281           $ref: "#/getDefinitions/relationship"
51282   complexes:
51283     description: |
51284       Collection of physical locations that can house cloud-regions.
51285     properties:
51286       complex:
51287         type: array
51288         items:
51289           $ref: "#/getDefinitions/complex"
51290   configuration:
51291     description: |
51292       Port Mirror Configuration.
51293       ###### Related Nodes
51294       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
51295       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
51296       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
51297       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
51298       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
51299
51300       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
51301       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
51302       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
51303     required:
51304     - configuration-id
51305     - configuration-type
51306     - configuration-sub-type
51307     - orchestration-status
51308     - operational-status
51309     - configuration-selflink
51310     - model-customization-id
51311     properties:
51312       configuration-id:
51313         type: string
51314         description: UUID assigned to configuration.
51315       management-option:
51316         type: string
51317         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
51318       configuration-name:
51319         type: string
51320         description: Name of the configuration.
51321       configuration-type:
51322         type: string
51323         description: port-mirroring-configuration.
51324       configuration-sub-type:
51325         type: string
51326         description: vprobe, pprobe.
51327       model-invariant-id:
51328         type: string
51329         description: the ASDC model id for this resource or service model.
51330       model-version-id:
51331         type: string
51332         description: the ASDC model version for this resource or service model.
51333       orchestration-status:
51334         type: string
51335         description: Orchestration status of the configuration.
51336       operational-status:
51337         type: string
51338         description: Indicator for whether the resource is considered operational.
51339       configuration-selflink:
51340         type: string
51341         description: URL to endpoint where AAI can get more details from SDN-GC.
51342       model-customization-id:
51343         type: string
51344         description: id of  the configuration used to customize the resource
51345       resource-version:
51346         type: string
51347         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51348       relationship-list:
51349         type: array
51350         items:
51351           $ref: "#/getDefinitions/relationship"
51352       metadata:
51353         type: array
51354         items:
51355           $ref: "#/getDefinitions/metadatum"
51356   configurations:
51357     description: |
51358       Collection of configurations
51359     properties:
51360       configuration:
51361         type: array
51362         items:
51363           $ref: "#/getDefinitions/configuration"
51364   connector:
51365     description: |
51366       Collection of resource instances used to connect a variety of disparate inventory widgets
51367       ###### Related Nodes
51368       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
51369       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
51370       - FROM service-instance( service-instance Uses connector, MANY2MANY)
51371
51372       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
51373     required:
51374     - resource-instance-id
51375     properties:
51376       resource-instance-id:
51377         type: string
51378         description: Unique id of resource instance.
51379       resource-version:
51380         type: string
51381         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51382       model-invariant-id:
51383         type: string
51384         description: the ASDC model id for this resource or service model.
51385       model-version-id:
51386         type: string
51387         description: the ASDC model version for this resource or service model.
51388       persona-model-version:
51389         type: string
51390         description: the ASDC model version for this resource or service model.
51391       widget-model-id:
51392         type: string
51393         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51394       widget-model-version:
51395         type: string
51396         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51397       relationship-list:
51398         type: array
51399         items:
51400           $ref: "#/getDefinitions/relationship"
51401       metadata:
51402         type: array
51403         items:
51404           $ref: "#/getDefinitions/metadatum"
51405   connectors:
51406     description: |
51407       Collection of resource instances used to connect a variety of disparate inventory widgets
51408     properties:
51409       connector:
51410         type: array
51411         items:
51412           $ref: "#/getDefinitions/connector"
51413   constrained-element-set:
51414     description: |
51415       This is how we would capture constraints defining allowed sets of elements.
51416       ###### Related Nodes
51417       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
51418       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
51419       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
51420
51421       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
51422       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
51423     required:
51424     - constrained-element-set-uuid
51425     - constraint-type
51426     - check-type
51427     properties:
51428       constrained-element-set-uuid:
51429         type: string
51430       constraint-type:
51431         type: string
51432       check-type:
51433         type: string
51434       resource-version:
51435         type: string
51436       element-choice-sets:
51437         type: array
51438         items:
51439           $ref: "#/getDefinitions/element-choice-set"
51440       relationship-list:
51441         type: array
51442         items:
51443           $ref: "#/getDefinitions/relationship"
51444   constrained-element-sets:
51445     properties:
51446       constrained-element-set:
51447         type: array
51448         items:
51449           $ref: "#/getDefinitions/constrained-element-set"
51450   ctag-assignment:
51451     description: |
51452       ###### Related Nodes
51453       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
51454       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
51455
51456       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
51457     required:
51458     - vlan-id-inner
51459     properties:
51460       vlan-id-inner:
51461         type: integer
51462         format: int64
51463         description: id.
51464       resource-version:
51465         type: string
51466         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51467       relationship-list:
51468         type: array
51469         items:
51470           $ref: "#/getDefinitions/relationship"
51471   ctag-assignments:
51472     properties:
51473       ctag-assignment:
51474         type: array
51475         items:
51476           $ref: "#/getDefinitions/ctag-assignment"
51477   ctag-pool:
51478     description: |
51479       A collection of C tags (vlan tags) grouped for a specific purpose.
51480       ###### Related Nodes
51481       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
51482       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
51483       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
51484
51485       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
51486     required:
51487     - target-pe
51488     - availability-zone-name
51489     - ctag-pool-purpose
51490     properties:
51491       target-pe:
51492         type: string
51493         description: The Target provider edge router
51494       availability-zone-name:
51495         type: string
51496         description: Name of the availability zone
51497       ctag-pool-purpose:
51498         type: string
51499         description: Describes what the intended purpose of this pool is.
51500       ctag-values:
51501         type: string
51502         description: Comma separated list of ctags
51503       resource-version:
51504         type: string
51505         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51506       relationship-list:
51507         type: array
51508         items:
51509           $ref: "#/getDefinitions/relationship"
51510   ctag-pools:
51511     properties:
51512       ctag-pool:
51513         type: array
51514         items:
51515           $ref: "#/getDefinitions/ctag-pool"
51516   customer:
51517     description: |
51518       customer identifiers to provide linkage back to BSS information.
51519       ###### Related Nodes
51520       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
51521
51522       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
51523     required:
51524     - global-customer-id
51525     - subscriber-name
51526     - subscriber-type
51527     properties:
51528       global-customer-id:
51529         type: string
51530         description: Global customer id used across ECOMP to uniquely identify customer.
51531       subscriber-name:
51532         type: string
51533         description: Subscriber name, an alternate way to retrieve a customer.
51534       subscriber-type:
51535         type: string
51536         description: Subscriber type, a way to provide VID with only the INFRA customers.
51537       resource-version:
51538         type: string
51539         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51540       service-subscriptions:
51541         type: array
51542         items:
51543           $ref: "#/getDefinitions/service-subscription"
51544       relationship-list:
51545         type: array
51546         items:
51547           $ref: "#/getDefinitions/relationship"
51548   customers:
51549     description: |
51550       Collection of customer identifiers to provide linkage back to BSS information.
51551     properties:
51552       customer:
51553         type: array
51554         items:
51555           $ref: "#/getDefinitions/customer"
51556   cvlan-tag-entry:
51557     required:
51558     - cvlan-tag
51559     properties:
51560       cvlan-tag:
51561         type: integer
51562         format: int64
51563         description: See mis-na-virtualization-platform.yang
51564       resource-version:
51565         type: string
51566         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51567       relationship-list:
51568         type: array
51569         items:
51570           $ref: "#/getDefinitions/relationship"
51571   cvlan-tags:
51572     properties:
51573       cvlan-tag-entry:
51574         type: array
51575         items:
51576           $ref: "#/getDefinitions/cvlan-tag-entry"
51577   dvs-switch:
51578     description: |
51579       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.
51580       ###### Related Nodes
51581       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
51582       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
51583
51584     required:
51585     - switch-name
51586     - vcenter-url
51587     properties:
51588       switch-name:
51589         type: string
51590         description: DVS switch name
51591       vcenter-url:
51592         type: string
51593         description: URL used to reach the vcenter
51594       resource-version:
51595         type: string
51596         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51597       relationship-list:
51598         type: array
51599         items:
51600           $ref: "#/getDefinitions/relationship"
51601   dvs-switches:
51602     description: |
51603       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
51604     properties:
51605       dvs-switch:
51606         type: array
51607         items:
51608           $ref: "#/getDefinitions/dvs-switch"
51609   edge-prop-names:
51610     description: |
51611       Internal map to define the properties of an edge and interpret the map EdgeRules
51612     properties:
51613       edgeLabel:
51614         type: string
51615       direction:
51616         type: string
51617       multiplicityRule:
51618         type: string
51619       isParent:
51620         type: boolean
51621       usesResource:
51622         type: boolean
51623       hasDelTarget:
51624         type: boolean
51625       SVC-INFRA:
51626         type: boolean
51627       SVC-INFRA-REV:
51628         type: boolean
51629   edge-tag-query-request:
51630     properties:
51631       edge-tag:
51632         type: string
51633       result-detail:
51634         type: string
51635       start-node-type:
51636         type: string
51637       start-node-filter:
51638         type: array
51639         items:
51640           $ref: "#/getDefinitions/start-node-filter"
51641       include-node-filter:
51642         type: array
51643         items:
51644           $ref: "#/getDefinitions/include-node-filter"
51645       secondary-filter:
51646         type: array
51647         items:
51648           $ref: "#/getDefinitions/secondary-filter"
51649   edge-tag-query-result:
51650     properties:
51651       tagged-inventory-item-list:
51652         type: array
51653         items:
51654           $ref: "#/getDefinitions/tagged-inventory-item-list"
51655   element-choice-set:
51656     description: |
51657       This is how we would capture constraints defining allowed sets of elements.
51658       ###### Related Nodes
51659       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51660       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51661
51662       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51663       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51664     required:
51665     - element-choice-set-uuid
51666     - element-choice-set-name
51667     properties:
51668       element-choice-set-uuid:
51669         type: string
51670       element-choice-set-name:
51671         type: string
51672       cardinality:
51673         type: string
51674       resource-version:
51675         type: string
51676       model-elements:
51677         type: array
51678         items:
51679           $ref: "#/getDefinitions/model-element"
51680       relationship-list:
51681         type: array
51682         items:
51683           $ref: "#/getDefinitions/relationship"
51684   element-choice-sets:
51685     properties:
51686       element-choice-set:
51687         type: array
51688         items:
51689           $ref: "#/getDefinitions/element-choice-set"
51690   entitlement:
51691     description: |
51692       Metadata for entitlement group.
51693       ###### Related Nodes
51694       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51695       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51696
51697       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51698     required:
51699     - group-uuid
51700     - resource-uuid
51701     properties:
51702       group-uuid:
51703         type: string
51704         description: Unique ID for the entitlement group the resource comes from, should be uuid.
51705       resource-uuid:
51706         type: string
51707         description: Unique ID of an entitlement resource.
51708       resource-version:
51709         type: string
51710         description: Concurrency value
51711       relationship-list:
51712         type: array
51713         items:
51714           $ref: "#/getDefinitions/relationship"
51715   entitlements:
51716     description: |
51717       Entitlements, keyed by group-uuid and resource-uuid, related to license management
51718     properties:
51719       entitlement:
51720         type: array
51721         items:
51722           $ref: "#/getDefinitions/entitlement"
51723   esr-ems:
51724     description: |
51725       Persist EMS address information used by EMS driver.
51726       ###### Related Nodes
51727       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
51728
51729       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
51730     required:
51731     - ems-id
51732     properties:
51733       ems-id:
51734         type: string
51735         description: Unique ID of EMS.
51736       resource-version:
51737         type: string
51738         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51739       esr-system-info-list:
51740         type: object
51741         $ref: "#/getDefinitions/esr-system-info-list"
51742       relationship-list:
51743         type: object
51744         $ref: "#/getDefinitions/relationship-list"
51745   esr-ems-list:
51746     properties:
51747       esr-ems:
51748         type: array
51749         items:
51750           $ref: "#/getDefinitions/esr-ems"
51751   esr-system-info:
51752     description: |
51753       Persist common address information of external systems.
51754       ###### Related Nodes
51755       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
51756       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
51757       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
51758       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
51759
51760       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
51761     required:
51762     - esr-system-info-id
51763     - user-name
51764     - password
51765     - system-type
51766     properties:
51767       esr-system-info-id:
51768         type: string
51769         description: Unique ID of esr system info.
51770       system-name:
51771         type: string
51772         description: name of external system.
51773       type:
51774         type: string
51775         description: type of external systems.
51776       vendor:
51777         type: string
51778         description: vendor of external systems.
51779       version:
51780         type: string
51781         description: version of external systems.
51782       service-url:
51783         type: string
51784         description: url used to access external systems.
51785       user-name:
51786         type: string
51787         description: username used to access external systems.
51788       password:
51789         type: string
51790         description: password used to access external systems.
51791       system-type:
51792         type: string
51793         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51794       protocol:
51795         type: string
51796         description: protocol of third party SDNC, for example netconf/snmp.
51797       ssl-cacert:
51798         type: string
51799         description: ca file content if enabled ssl on auth-url.
51800       ssl-insecure:
51801         type: boolean
51802         description: Whether to verify VIM's certificate.
51803       ip-address:
51804         type: string
51805         description: service IP of ftp server.
51806       port:
51807         type: string
51808         description: service port of ftp server.
51809       cloud-domain:
51810         type: string
51811         description: domain info for authentication.
51812       default-tenant:
51813         type: string
51814         description: default tenant of VIM.
51815       passive:
51816         type: boolean
51817         description: ftp passive mode or not.
51818       remote-path:
51819         type: string
51820         description: resource or performance data file path.
51821       system-status:
51822         type: string
51823         description: the status of external system.
51824       resource-version:
51825         type: string
51826         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51827       relationship-list:
51828         type: array
51829         items:
51830           $ref: "#/getDefinitions/relationship"
51831   esr-system-info-list:
51832     description: |
51833       Collection of persistent block-level external system auth info.
51834     properties:
51835       esr-system-info:
51836         type: array
51837         items:
51838           $ref: "#/getDefinitions/esr-system-info"
51839   esr-thirdparty-sdnc:
51840     description: |
51841       Persist SDNC address information used by ONAP SDNC.
51842       ###### Related Nodes
51843       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
51844       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
51845
51846       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
51847     required:
51848     - thirdparty-sdnc-id
51849     properties:
51850       thirdparty-sdnc-id:
51851         type: string
51852         description: Unique ID of SDNC.
51853       location:
51854         type: string
51855         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51856       product-name:
51857         type: string
51858         description: password used to access SDNC server.
51859       resource-version:
51860         type: string
51861         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51862       esr-system-info-list:
51863         type: object
51864         $ref: "#/getDefinitions/esr-system-info-list"
51865       relationship-list:
51866         type: object
51867         $ref: "#/getDefinitions/relationship-list"
51868   esr-thirdparty-sdnc-list:
51869     properties:
51870       esr-thirdparty-sdnc:
51871         type: array
51872         items:
51873           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
51874   esr-vnfm:
51875     description: |
51876       Persist VNFM address information used by VF-C.
51877       ###### Related Nodes
51878       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
51879
51880       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
51881     required:
51882     - vnfm-id
51883     properties:
51884       vnfm-id:
51885         type: string
51886         description: Unique ID of VNFM.
51887       vim-id:
51888         type: string
51889         description: indecate the VIM to deploy VNF.
51890       certificate-url:
51891         type: string
51892         description: certificate url of VNFM.
51893       resource-version:
51894         type: string
51895         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51896       esr-system-info-list:
51897         type: object
51898         $ref: "#/getDefinitions/esr-system-info-list"
51899       relationship-list:
51900         type: object
51901         $ref: "#/getDefinitions/relationship-list"
51902   esr-vnfm-list:
51903     properties:
51904       esr-vnfm:
51905         type: array
51906         items:
51907           $ref: "#/getDefinitions/esr-vnfm"
51908   evc:
51909     description: |
51910       evc object is an optional child object of the Configuration object.
51911       ###### Related Nodes
51912       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51913
51914       -(4) IF this TO node is deleted, this EVC is DELETED also
51915     required:
51916     - evc-id
51917     properties:
51918       evc-id:
51919         type: string
51920         description: Unique/key field for the evc object
51921       forwarding-path-topology:
51922         type: string
51923         description: Point-to-Point, Multi-Point
51924       cir-value:
51925         type: string
51926         description: Commited Information Rate
51927       cir-units:
51928         type: string
51929         description: CIR units
51930       connection-diversity-group-id:
51931         type: string
51932         description: Diversity Group ID
51933       service-hours:
51934         type: string
51935         description: formerly Performance Group
51936       esp-evc-circuit-id:
51937         type: string
51938         description: EVC Circuit ID of ESP EVC
51939       esp-evc-cir-value:
51940         type: string
51941         description: Committed Information Rate (For ESP)
51942       esp-evc-cir-units:
51943         type: string
51944         description: CIR units (For ESP)
51945       esp-itu-code:
51946         type: string
51947         description: Identifies ESP
51948       collector-pop-clli:
51949         type: string
51950         description: Collector POP CLLI (from the hostname of the access pnf)
51951       inter-connect-type-ingress:
51952         type: string
51953         description: Interconnect type on ingress side of EVC.
51954       tagmode-access-ingress:
51955         type: string
51956         description: tagode for collector side of EVC
51957       tagmode-access-egress:
51958         type: string
51959         description: tagMode for network side of EVC
51960       relationship-list:
51961         type: array
51962         items:
51963           $ref: "#/getDefinitions/relationship"
51964       resource-version:
51965         type: string
51966         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51967   evcs:
51968     properties:
51969       evc:
51970         type: array
51971         items:
51972           $ref: "#/getDefinitions/evc"
51973   external-system:
51974     description: |
51975       Namespace for external system.
51976     properties:
51977       esr-ems-list:
51978         type: object
51979         $ref: "#/getDefinitions/esr-ems-list"
51980       esr-vnfm-list:
51981         type: object
51982         $ref: "#/getDefinitions/esr-vnfm-list"
51983       esr-thirdparty-sdnc-list:
51984         type: object
51985         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
51986   extra-properties:
51987     description: |
51988       Extra properties for inventory item for response list
51989     properties:
51990       extra-property:
51991         type: array
51992         items:
51993           $ref: "#/getDefinitions/extra-property"
51994   extra-property:
51995     properties:
51996       property-name:
51997         type: string
51998       property-value:
51999         type: string
52000   flavor:
52001     description: |
52002       Openstack flavor.
52003       ###### Related Nodes
52004       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
52005       - FROM vserver( vserver Uses flavor, MANY2ONE)
52006
52007       -FLAVOR cannot be deleted if related to VSERVER
52008
52009     required:
52010     - flavor-id
52011     - flavor-name
52012     - flavor-selflink
52013     properties:
52014       flavor-id:
52015         type: string
52016         description: Flavor id, expected to be unique across cloud-region.
52017       flavor-name:
52018         type: string
52019         description: Flavor name
52020       flavor-vcpus:
52021         type: integer
52022         format: int32
52023         description: Number of CPUs
52024       flavor-ram:
52025         type: integer
52026         format: int32
52027         description: Amount of memory
52028       flavor-disk:
52029         type: integer
52030         format: int32
52031         description: Disk space
52032       flavor-ephemeral:
52033         type: integer
52034         format: int32
52035         description: Amount of ephemeral disk space
52036       flavor-swap:
52037         type: string
52038         description: amount of swap space allocation
52039       flavor-is-public:
52040         type: boolean
52041         description: whether flavor is available to all users or private to the tenant it was created in.
52042       flavor-selflink:
52043         type: string
52044         description: URL to endpoint where AAI can get more details
52045       flavor-disabled:
52046         type: boolean
52047         description: Boolean as to whether this flavor is no longer enabled
52048       resource-version:
52049         type: string
52050         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52051       relationship-list:
52052         type: array
52053         items:
52054           $ref: "#/getDefinitions/relationship"
52055   flavors:
52056     description: |
52057       Collection of openstack flavors.
52058     properties:
52059       flavor:
52060         type: array
52061         items:
52062           $ref: "#/getDefinitions/flavor"
52063   forwarder:
52064     description: |
52065       Entity describing a sequenced segment of forwarding path
52066       ###### Related Nodes
52067       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
52068       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
52069       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
52070       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
52071       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
52072
52073       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
52074       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
52075     required:
52076     - sequence
52077     properties:
52078       sequence:
52079         type: integer
52080         format: int32
52081         description: Unique ID of this segmentation
52082       forwarder-role:
52083         type: string
52084         description: ingress, intermediate, egress
52085       relationship-list:
52086         type: array
52087         items:
52088           $ref: "#/getDefinitions/relationship"
52089       resource-version:
52090         type: string
52091         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52092   forwarder-evc:
52093     description: |
52094       forwarder object is an optional child object of the Configuration object.
52095       ###### Related Nodes
52096       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
52097
52098       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
52099     required:
52100     - forwarder-evc-id
52101     properties:
52102       forwarder-evc-id:
52103         type: string
52104         description: Key for forwarder-evc object
52105       circuit-id:
52106         type: string
52107         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
52108       ivlan:
52109         type: string
52110         description: Internal VLAN.
52111       svlan:
52112         type: string
52113         description: SVLAN value for ingress of egress forwarder.
52114       cvlan:
52115         type: string
52116         description: CVLAN value for ingress of egress forwarder.
52117       relationship-list:
52118         type: array
52119         items:
52120           $ref: "#/getDefinitions/relationship"
52121       resource-version:
52122         type: string
52123         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52124   forwarder-evcs:
52125     properties:
52126       forwarder-evc:
52127         type: array
52128         items:
52129           $ref: "#/getDefinitions/forwarder-evc"
52130   forwarders:
52131     properties:
52132       forwarder:
52133         type: array
52134         items:
52135           $ref: "#/getDefinitions/forwarder"
52136   forwarding-path:
52137     description: |
52138       Entity that describes the sequenced forwarding path between interfaces of services or resources
52139       ###### Related Nodes
52140       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
52141       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
52142       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
52143
52144       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
52145       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
52146       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
52147     required:
52148     - forwarding-path-id
52149     - forwarding-path-name
52150     properties:
52151       forwarding-path-id:
52152         type: string
52153         description: Unique ID of this FP
52154       forwarding-path-name:
52155         type: string
52156         description: Name of the FP
52157       relationship-list:
52158         type: array
52159         items:
52160           $ref: "#/getDefinitions/relationship"
52161       resource-version:
52162         type: string
52163         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52164       selflink:
52165         type: string
52166         description: the self link for this FP
52167       forwarders:
52168         type: array
52169         items:
52170           $ref: "#/getDefinitions/forwarder"
52171   forwarding-paths:
52172     properties:
52173       forwarding-path:
52174         type: array
52175         items:
52176           $ref: "#/getDefinitions/forwarding-path"
52177   generic-vnf:
52178     description: |
52179       General purpose VNF
52180       ###### Related Nodes
52181       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
52182       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
52183       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
52184       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
52185       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
52186       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
52187       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
52188       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
52189       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
52190       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52191       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
52192       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
52193       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
52194       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
52195       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
52196       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
52197       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
52198       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
52199       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
52200       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
52201       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
52202
52203       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
52204     required:
52205     - vnf-id
52206     - vnf-name
52207     - vnf-type
52208     - in-maint
52209     - is-closed-loop-disabled
52210     properties:
52211       vnf-id:
52212         type: string
52213         description: Unique id of VNF.  This is unique across the graph.
52214       vnf-name:
52215         type: string
52216         description: Name of VNF.
52217       vnf-name2:
52218         type: string
52219         description: Alternate name of VNF.
52220       vnf-type:
52221         type: string
52222         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52223       service-id:
52224         type: string
52225         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
52226       regional-resource-zone:
52227         type: string
52228         description: Regional way of organizing pservers, source of truth should define values
52229       prov-status:
52230         type: string
52231         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52232       operational-status:
52233         type: string
52234         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
52235       license-key:
52236         type: string
52237         description: OBSOLETE -  do not use
52238       equipment-role:
52239         type: string
52240         description: Client should send valid enumerated value
52241       orchestration-status:
52242         type: string
52243         description: Orchestration status of this VNF, used by MSO.
52244       heat-stack-id:
52245         type: string
52246         description: Heat stack id corresponding to this instance, managed by MSO
52247       mso-catalog-key:
52248         type: string
52249         description: Corresponds to the SDN-C catalog id used to configure this VCE
52250       management-option:
52251         type: string
52252         description: identifier of managed by company or customer
52253       ipv4-oam-address:
52254         type: string
52255         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
52256       ipv4-loopback0-address:
52257         type: string
52258         description: v4 Loopback0 address
52259       nm-lan-v6-address:
52260         type: string
52261         description: v6 Loopback address
52262       management-v6-address:
52263         type: string
52264         description: v6 management address
52265       vcpu:
52266         type: integer
52267         format: int64
52268         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52269       vcpu-units:
52270         type: string
52271         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
52272       vmemory:
52273         type: integer
52274         format: int64
52275         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52276       vmemory-units:
52277         type: string
52278         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
52279       vdisk:
52280         type: integer
52281         format: int64
52282         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52283       vdisk-units:
52284         type: string
52285         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
52286       in-maint:
52287         type: boolean
52288         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.
52289       is-closed-loop-disabled:
52290         type: boolean
52291         description: used to indicate whether closed loop function is enabled on this node
52292       resource-version:
52293         type: string
52294         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52295       summary-status:
52296         type: string
52297         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
52298       encrypted-access-flag:
52299         type: boolean
52300         description: indicates whether generic-vnf access uses SSH
52301       entitlement-assignment-group-uuid:
52302         type: string
52303         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
52304       entitlement-resource-uuid:
52305         type: string
52306         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
52307       license-assignment-group-uuid:
52308         type: string
52309         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
52310       license-key-uuid:
52311         type: string
52312         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
52313       model-invariant-id:
52314         type: string
52315         description: the ASDC model id for this resource or service model.
52316       model-version-id:
52317         type: string
52318         description: the ASDC model version for this resource or service model.
52319       persona-model-version:
52320         type: string
52321         description: the ASDC model version for this resource or service model.
52322       model-customization-id:
52323         type: string
52324         description: captures the id of all the configuration used to customize the resource for the service.
52325       widget-model-id:
52326         type: string
52327         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52328       widget-model-version:
52329         type: string
52330         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52331       as-number:
52332         type: string
52333         description: as-number of the VNF
52334       regional-resource-subzone:
52335         type: string
52336         description: represents sub zone of the rr plane
52337       nf-type:
52338         type: string
52339         description: Generic description of the type of NF
52340       nf-function:
52341         type: string
52342         description: English description of Network function that the specific VNF deployment is providing
52343       nf-role:
52344         type: string
52345         description: role in the network that this model will be providing
52346       nf-naming-code:
52347         type: string
52348         description: string assigned to this model used for naming purposes
52349       selflink:
52350         type: string
52351         description: Path to the controller object.
52352       relationship-list:
52353         type: array
52354         items:
52355           $ref: "#/getDefinitions/relationship"
52356       l-interfaces:
52357         type: array
52358         items:
52359           $ref: "#/getDefinitions/l-interface"
52360       lag-interfaces:
52361         type: array
52362         items:
52363           $ref: "#/getDefinitions/lag-interface"
52364       vf-modules:
52365         type: array
52366         items:
52367           $ref: "#/getDefinitions/vf-module"
52368       licenses:
52369         type: array
52370         items:
52371           $ref: "#/getDefinitions/license"
52372       entitlements:
52373         type: array
52374         items:
52375           $ref: "#/getDefinitions/entitlement"
52376   generic-vnfs:
52377     description: |
52378       Collection of VNFs
52379     properties:
52380       generic-vnf:
52381         type: array
52382         items:
52383           $ref: "#/getDefinitions/generic-vnf"
52384   group-assignment:
52385     description: |
52386       Openstack group-assignment used to store exclusivity groups (EG).
52387       ###### Related Nodes
52388       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
52389       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
52390       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
52391
52392     required:
52393     - group-id
52394     - group-type
52395     - group-name
52396     properties:
52397       group-id:
52398         type: string
52399         description: Group id, expected to be unique across cloud-region.
52400       group-type:
52401         type: string
52402         description: Group type - the type of group this instance refers to
52403       group-name:
52404         type: string
52405         description: Group name - name assigned to the group
52406       group-description:
52407         type: string
52408         description: Group description - description of the group
52409       resource-version:
52410         type: string
52411         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52412       relationship-list:
52413         type: array
52414         items:
52415           $ref: "#/getDefinitions/relationship"
52416   group-assignments:
52417     description: |
52418       Collection of openstack group assignments
52419     properties:
52420       group-assignment:
52421         type: array
52422         items:
52423           $ref: "#/getDefinitions/group-assignment"
52424   host-route:
52425     description: |
52426       ###### Related Nodes
52427       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
52428
52429       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
52430     required:
52431     - host-route-id
52432     - route-prefix
52433     - next-hop
52434     properties:
52435       host-route-id:
52436         type: string
52437         description: host-route id
52438       route-prefix:
52439         type: string
52440         description: subnet prefix
52441       next-hop:
52442         type: string
52443         description: Could be ip-address, hostname, or service-instance
52444       next-hop-type:
52445         type: string
52446         description: Should be ip-address, hostname, or service-instance to match next-hop
52447       resource-version:
52448         type: string
52449         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52450       relationship-list:
52451         type: array
52452         items:
52453           $ref: "#/getDefinitions/relationship"
52454   host-routes:
52455     properties:
52456       host-route:
52457         type: array
52458         items:
52459           $ref: "#/getDefinitions/host-route"
52460   hpa-capabilities:
52461     description: |
52462       Collection of HPA Capabilities
52463     properties:
52464       hpa-capability:
52465         type: array
52466         items:
52467           $ref: "#/getDefinitions/hpa-capability"
52468   hpa-capability:
52469     description: |
52470       Represents a HPA capability
52471       ###### Related Nodes
52472       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
52473       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
52474       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
52475
52476       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
52477     required:
52478     - hpa-capability-id
52479     - hpa-feature
52480     properties:
52481       hpa-capability-id:
52482         type: string
52483         description: UUID to uniquely identify a HPA capability
52484       hpa-feature:
52485         type: string
52486         description: Name of the HPACapability
52487       hpa-version:
52488         type: string
52489         description: HPA schema version
52490       architecture:
52491         type: string
52492         description: Hardware architecture
52493       resource-version:
52494         type: string
52495         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52496       relationship-list:
52497         type: array
52498         items:
52499           $ref: "#/getDefinitions/relationship"
52500       hpa-feature-attributes:
52501         type: array
52502         items:
52503           $ref: "#/getDefinitions/hpa-feature-attributes"
52504   hpa-feature-attributes:
52505     description: |
52506       HPA Capability Feature attributes
52507       ###### Related Nodes
52508       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
52509
52510       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
52511     required:
52512     - hpa-attribute-key
52513     properties:
52514       hpa-attribute-key:
52515         type: string
52516         description: name of the specific HPA attribute
52517       hpa-attribute-value:
52518         type: string
52519         description: JSON string specifying the value, unit and type of the specific HPA attribute
52520       resource-version:
52521         type: string
52522         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52523       relationship-list:
52524         type: array
52525         items:
52526           $ref: "#/getDefinitions/relationship"
52527   image:
52528     description: |
52529       Openstack image.
52530       ###### Related Nodes
52531       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
52532       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
52533       - FROM vserver( vserver Uses image, MANY2ONE)
52534
52535       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
52536       -IMAGE cannot be deleted if related to VSERVER
52537
52538     required:
52539     - image-id
52540     - image-name
52541     - image-os-distro
52542     - image-os-version
52543     - image-selflink
52544     properties:
52545       image-id:
52546         type: string
52547         description: Image id, expected to be unique across cloud region
52548       image-name:
52549         type: string
52550         description: Image name
52551       image-architecture:
52552         type: string
52553         description: Operating system architecture.
52554       image-os-distro:
52555         type: string
52556         description: The common name of the operating system distribution in lowercase
52557       image-os-version:
52558         type: string
52559         description: The operating system version as specified by the distributor.
52560       application:
52561         type: string
52562         description: The application that the image instantiates.
52563       application-vendor:
52564         type: string
52565         description: The vendor of the application.
52566       application-version:
52567         type: string
52568         description: The version of the application.
52569       image-selflink:
52570         type: string
52571         description: URL to endpoint where AAI can get more details
52572       resource-version:
52573         type: string
52574         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52575       relationship-list:
52576         type: array
52577         items:
52578           $ref: "#/getDefinitions/relationship"
52579       metadata:
52580         type: array
52581         items:
52582           $ref: "#/getDefinitions/metadatum"
52583   images:
52584     description: |
52585       Collectio of Openstack images.
52586     properties:
52587       image:
52588         type: array
52589         items:
52590           $ref: "#/getDefinitions/image"
52591   include-node-filter:
52592     properties:
52593       include-node-type:
52594         type: string
52595   instance-filter:
52596     description: |
52597       InstanceFilter for performing a named-query or model query
52598   instance-filters:
52599     description: |
52600       InstanceFilters for performing a named-query or model query
52601     properties:
52602       instance-filter:
52603         type: array
52604         items:
52605           $ref: "#/getDefinitions/instance-filter"
52606   instance-group:
52607     description: |
52608       General mechanism for grouping instances
52609       ###### Related Nodes
52610       - TO model( instance-group Targets model, MANY2MANY)
52611       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
52612       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
52613       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52614       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52615       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
52616       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
52617       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
52618
52619     required:
52620     - id
52621     - description
52622     - type
52623     properties:
52624       id:
52625         type: string
52626         description: Instance Group ID, UUID assigned to this instance.
52627       description:
52628         type: string
52629         description: Descriptive text to help identify the usage of this instance-group
52630       type:
52631         type: string
52632         description: Only valid value today is lower case ha for high availability
52633       sub-type:
52634         type: string
52635         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52636       resource-version:
52637         type: string
52638         description: Concurrency value
52639       relationship-list:
52640         type: array
52641         items:
52642           $ref: "#/getDefinitions/relationship"
52643   instance-groups:
52644     description: |
52645       Collection of openstack route table references
52646     properties:
52647       instance-group:
52648         type: array
52649         items:
52650           $ref: "#/getDefinitions/instance-group"
52651   inventory:
52652     properties:
52653       search:
52654         type: object
52655         $ref: "#/getDefinitions/search"
52656       actions:
52657         type: object
52658         $ref: "#/getDefinitions/actions"
52659       cloud-infrastructure:
52660         type: object
52661         $ref: "#/getDefinitions/cloud-infrastructure"
52662       business:
52663         type: object
52664         $ref: "#/getDefinitions/business"
52665       service-design-and-creation:
52666         type: object
52667         $ref: "#/getDefinitions/service-design-and-creation"
52668       network:
52669         type: object
52670         $ref: "#/getDefinitions/network"
52671       nodes:
52672         type: object
52673         $ref: "#/getDefinitions/nodes"
52674   inventory-item:
52675     properties:
52676       inventory-item-type:
52677         type: string
52678       inventory-item-link:
52679         type: string
52680       inventory-item-data:
52681         type: array
52682         items:
52683           $ref: "#/getDefinitions/inventory-item-data"
52684       tagged-inventory-item-list:
52685         type: array
52686         items:
52687           $ref: "#/getDefinitions/tagged-inventory-item-list"
52688   inventory-item-data:
52689     properties:
52690       property-name:
52691         type: string
52692       property-value:
52693         type: string
52694   inventory-response-item:
52695     description: |
52696       Inventory item for response list
52697     properties:
52698       model-name:
52699         type: string
52700       extra-properties:
52701         type: object
52702         $ref: "#/getDefinitions/extra-properties"
52703       inventory-response-items:
52704         type: object
52705         $ref: "#/getDefinitions/inventory-response-items"
52706   inventory-response-items:
52707     description: |
52708       Container for inventory items in response list
52709     properties:
52710       inventory-response-item:
52711         type: array
52712         items:
52713           $ref: "#/getDefinitions/inventory-response-item"
52714   ipsec-configuration:
52715     description: |
52716       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
52717       ###### Related Nodes
52718       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
52719       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
52720
52721       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
52722     required:
52723     - ipsec-configuration-id
52724     properties:
52725       ipsec-configuration-id:
52726         type: string
52727         description: UUID of this configuration
52728       requested-vig-address-type:
52729         type: string
52730         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
52731       requested-encryption-strength:
52732         type: string
52733         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
52734       requested-dmz-type:
52735         type: string
52736         description: can offer a shared DMZ or a DMZ specific to a customer
52737       shared-dmz-network-address:
52738         type: string
52739         description: Network address of shared DMZ
52740       requested-customer-name:
52741         type: string
52742         description: If the DMZ is a custom DMZ, this field will indicate the customer information
52743       ike-version:
52744         type: string
52745         description: can be 1 or 2
52746       ikev1-authentication:
52747         type: string
52748         description: Contains values like md5, sha1, sha256, sha384
52749       ikev1-encryption:
52750         type: string
52751         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52752       ikev1-dh-group:
52753         type: string
52754         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
52755       ikev1-am-group-id:
52756         type: string
52757         description: Group name defined in VIG for clients using aggressive mode
52758       ikev1-am-password:
52759         type: string
52760         description: pre-shared key for the above group name
52761       ikev1-sa-lifetime:
52762         type: string
52763         description: Lifetime for IKEv1 SA
52764       ipsec-authentication:
52765         type: string
52766         description: md5, sha1, sha256, sha384
52767       ipsec-encryption:
52768         type: string
52769         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52770       ipsec-sa-lifetime:
52771         type: string
52772         description: Life time for IPSec SA
52773       ipsec-pfs:
52774         type: string
52775         description: enable PFS or not
52776       xauth-userid:
52777         type: string
52778         description: user ID for xAuth, sm-user, ,nmteHostName
52779       xauth-user-password:
52780         type: string
52781         description: Encrypted using the Juniper $9$ algorithm
52782       dpd-interval:
52783         type: string
52784         description: The time between DPD probe
52785       dpd-frequency:
52786         type: string
52787         description: Maximum number of DPD before claiming the tunnel is down
52788       resource-version:
52789         type: string
52790         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52791       relationship-list:
52792         type: array
52793         items:
52794           $ref: "#/getDefinitions/relationship"
52795       vig-servers:
52796         type: array
52797         items:
52798           $ref: "#/getDefinitions/vig-server"
52799   ipsec-configurations:
52800     properties:
52801       ipsec-configuration:
52802         type: array
52803         items:
52804           $ref: "#/getDefinitions/ipsec-configuration"
52805   key-data:
52806     properties:
52807       key-name:
52808         type: string
52809       key-value:
52810         type: string
52811   l-interface:
52812     description: |
52813       Logical interfaces, e.g., a vnic.
52814       ###### Related Nodes
52815       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
52816       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
52817       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
52818       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52819       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52820       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52821       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52822       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52823       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52824       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52825       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52826       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52827       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52828
52829       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52830       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52831       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52832     required:
52833     - interface-name
52834     - is-port-mirrored
52835     - in-maint
52836     properties:
52837       interface-name:
52838         type: string
52839         description: Name given to the interface
52840       interface-role:
52841         type: string
52842         description: E.g., CUSTOMER, UPLINK, etc.
52843       v6-wan-link-ip:
52844         type: string
52845         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52846       selflink:
52847         type: string
52848         description: URL to endpoint where AAI can get more details
52849       interface-id:
52850         type: string
52851         description: ID of interface
52852       macaddr:
52853         type: string
52854         description: MAC address for the interface
52855       network-name:
52856         type: string
52857         description: Name of the network
52858       management-option:
52859         type: string
52860         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52861       interface-description:
52862         type: string
52863         description: Human friendly text regarding this interface.
52864       is-port-mirrored:
52865         type: boolean
52866         description: boolean indicatating whether or not port is a mirrored.
52867       resource-version:
52868         type: string
52869         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52870       in-maint:
52871         type: boolean
52872         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52873       vlans:
52874         type: array
52875         items:
52876           $ref: "#/getDefinitions/vlan"
52877       sriov-vfs:
52878         type: array
52879         items:
52880           $ref: "#/getDefinitions/sriov-vf"
52881       l-interfaces:
52882         type: array
52883         items:
52884           $ref: "#/getDefinitions/l-interface"
52885       relationship-list:
52886         type: array
52887         items:
52888           $ref: "#/getDefinitions/relationship"
52889       l3-interface-ipv4-address-list:
52890         type: array
52891         items:
52892           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52893       l3-interface-ipv6-address-list:
52894         type: array
52895         items:
52896           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52897   l-interfaces:
52898     description: |
52899       Collection of logical interfaces.
52900     properties:
52901       l-interface:
52902         type: array
52903         items:
52904           $ref: "#/getDefinitions/l-interface"
52905   l3-interface-ipv4-address-list:
52906     description: |
52907       IPv4 Address Range
52908       ###### Related Nodes
52909       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52910       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52911       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52912       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52913       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52914
52915       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52916     required:
52917     - l3-interface-ipv4-address
52918     properties:
52919       l3-interface-ipv4-address:
52920         type: string
52921         description: IP address
52922       l3-interface-ipv4-prefix-length:
52923         type: integer
52924         format: int64
52925         description: Prefix length, 32 for single address
52926       vlan-id-inner:
52927         type: integer
52928         format: int64
52929         description: Inner VLAN tag
52930       vlan-id-outer:
52931         type: integer
52932         format: int64
52933         description: Outer VLAN tag
52934       is-floating:
52935         type: boolean
52936         description: Indicator of fixed or floating address
52937       resource-version:
52938         type: string
52939         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52940       neutron-network-id:
52941         type: string
52942         description: Neutron network id of the interface that address belongs to
52943       neutron-subnet-id:
52944         type: string
52945         description: Neutron id of subnet that address belongs to
52946       relationship-list:
52947         type: array
52948         items:
52949           $ref: "#/getDefinitions/relationship"
52950   l3-interface-ipv6-address-list:
52951     description: |
52952       IPv6 Address Range
52953       ###### Related Nodes
52954       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52955       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52956       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52957       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52958       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52959
52960       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52961     required:
52962     - l3-interface-ipv6-address
52963     properties:
52964       l3-interface-ipv6-address:
52965         type: string
52966         description: IP address
52967       l3-interface-ipv6-prefix-length:
52968         type: integer
52969         format: int64
52970         description: Prefix length, 128 for single address
52971       vlan-id-inner:
52972         type: integer
52973         format: int64
52974         description: Inner VLAN tag
52975       vlan-id-outer:
52976         type: integer
52977         format: int64
52978         description: Outer VLAN tag
52979       is-floating:
52980         type: boolean
52981         description: Indicator of fixed or floating address
52982       resource-version:
52983         type: string
52984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52985       neutron-network-id:
52986         type: string
52987         description: Neutron network id of the interface that address belongs to
52988       neutron-subnet-id:
52989         type: string
52990         description: Neutron id of subnet that address belongs to
52991       relationship-list:
52992         type: array
52993         items:
52994           $ref: "#/getDefinitions/relationship"
52995   l3-network:
52996     description: |
52997       Generic network definition
52998       ###### Related Nodes
52999       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
53000       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
53001       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
53002       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
53003       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
53004       - FROM complex( complex Uses l3-network, MANY2MANY)
53005       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
53006       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
53007       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
53008       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
53009       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
53010       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
53011       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
53012       - FROM tenant( tenant Uses l3-network, MANY2MANY)
53013       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
53014
53015       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
53016     required:
53017     - network-id
53018     - network-name
53019     - is-bound-to-vpn
53020     - is-provider-network
53021     - is-shared-network
53022     - is-external-network
53023     properties:
53024       network-id:
53025         type: string
53026         description: Network ID, should be uuid. Unique across A&AI.
53027       network-name:
53028         type: string
53029         description: Name of the network, governed by some naming convention..
53030       network-type:
53031         type: string
53032         description: Type of the network - who defines these values?
53033       network-role:
53034         type: string
53035         description: Role the network plans - who defines these values?
53036       network-technology:
53037         type: string
53038         description: Network technology - who defines these values?
53039       neutron-network-id:
53040         type: string
53041         description: Neutron network id of this Interface
53042       is-bound-to-vpn:
53043         type: boolean
53044         description: Set to true if bound to VPN
53045       service-id:
53046         type: string
53047         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
53048       network-role-instance:
53049         type: integer
53050         format: int64
53051         description: network role instance
53052       resource-version:
53053         type: string
53054         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53055       orchestration-status:
53056         type: string
53057         description: Orchestration status of this VNF, mastered by MSO
53058       heat-stack-id:
53059         type: string
53060         description: Heat stack id corresponding to this instance, managed by MSO
53061       mso-catalog-key:
53062         type: string
53063         description: Corresponds to the SDN-C catalog id used to configure this VCE
53064       contrail-network-fqdn:
53065         type: string
53066         description: Contrail FQDN for the network
53067       model-invariant-id:
53068         type: string
53069         description: the ASDC model id for this resource or service model.
53070       model-version-id:
53071         type: string
53072         description: the ASDC model version for this resource or service model.
53073       persona-model-version:
53074         type: string
53075         description: the ASDC model version for this resource or service model.
53076       model-customization-id:
53077         type: string
53078         description: captures the id of all the configuration used to customize the resource for the service.
53079       widget-model-id:
53080         type: string
53081         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53082       widget-model-version:
53083         type: string
53084         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53085       physical-network-name:
53086         type: string
53087         description: Name associated with the physical network.
53088       is-provider-network:
53089         type: boolean
53090         description: boolean indicatating whether or not network is a provider network.
53091       is-shared-network:
53092         type: boolean
53093         description: boolean indicatating whether or not network is a shared network.
53094       is-external-network:
53095         type: boolean
53096         description: boolean indicatating whether or not network is an external network.
53097       selflink:
53098         type: string
53099         description: Path to the controller object.
53100       operational-status:
53101         type: string
53102         description: Indicator for whether the resource is considered operational.
53103       subnets:
53104         type: array
53105         items:
53106           $ref: "#/getDefinitions/subnet"
53107       ctag-assignments:
53108         type: array
53109         items:
53110           $ref: "#/getDefinitions/ctag-assignment"
53111       segmentation-assignments:
53112         type: array
53113         items:
53114           $ref: "#/getDefinitions/segmentation-assignment"
53115       relationship-list:
53116         type: array
53117         items:
53118           $ref: "#/getDefinitions/relationship"
53119         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
53120   l3-networks:
53121     properties:
53122       l3-network:
53123         type: array
53124         items:
53125           $ref: "#/getDefinitions/l3-network"
53126   lag-interface:
53127     description: |
53128       Link aggregate interface
53129       ###### Related Nodes
53130       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
53131       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
53132       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
53133       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
53134       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
53135       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
53136       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
53137       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
53138
53139       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
53140       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
53141       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
53142     required:
53143     - interface-name
53144     - in-maint
53145     properties:
53146       interface-name:
53147         type: string
53148         description: Name that identifies the link aggregate interface
53149       interface-description:
53150         type: string
53151         description: Human friendly text regarding this interface.
53152       resource-version:
53153         type: string
53154         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53155       speed-value:
53156         type: string
53157         description: Captures the numeric part of the speed
53158       speed-units:
53159         type: string
53160         description: Captures the units corresponding to the speed
53161       interface-id:
53162         type: string
53163         description: ID of interface
53164       interface-role:
53165         type: string
53166         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53167       prov-status:
53168         type: string
53169         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53170       in-maint:
53171         type: boolean
53172         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
53173       relationship-list:
53174         type: array
53175         items:
53176           $ref: "#/getDefinitions/relationship"
53177       l-interfaces:
53178         type: array
53179         items:
53180           $ref: "#/getDefinitions/l-interface"
53181   lag-interfaces:
53182     description: |
53183       Collection of link aggregate interfaces.
53184     properties:
53185       lag-interface:
53186         type: array
53187         items:
53188           $ref: "#/getDefinitions/lag-interface"
53189   lag-link:
53190     description: |
53191       LAG links can connect lag-interfaces
53192       ###### Related Nodes
53193       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
53194       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
53195
53196       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
53197     required:
53198     - link-name
53199     properties:
53200       link-name:
53201         type: string
53202         description: Alphabetical concatenation of lag-interface names
53203       resource-version:
53204         type: string
53205         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53206       relationship-list:
53207         type: array
53208         items:
53209           $ref: "#/getDefinitions/relationship"
53210   lag-links:
53211     description: |
53212       Collection of link aggregation connections
53213     properties:
53214       lag-link:
53215         type: array
53216         items:
53217           $ref: "#/getDefinitions/lag-link"
53218   license:
53219     description: |
53220       Metadata for license group.
53221       ###### Related Nodes
53222       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
53223       - TO vce( license BelongsTo vce, MANY2ONE)(4)
53224
53225       -(4) IF this TO node is deleted, this LICENSE is DELETED also
53226     required:
53227     - group-uuid
53228     - resource-uuid
53229     properties:
53230       group-uuid:
53231         type: string
53232         description: Unique ID for the license group the resource belongs to, should be uuid.
53233       resource-uuid:
53234         type: string
53235         description: Unique ID of a license resource.
53236       resource-version:
53237         type: string
53238         description: Concurrency value
53239       relationship-list:
53240         type: array
53241         items:
53242           $ref: "#/getDefinitions/relationship"
53243   licenses:
53244     description: |
53245       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
53246     properties:
53247       license:
53248         type: array
53249         items:
53250           $ref: "#/getDefinitions/license"
53251   line-of-business:
53252     description: |
53253       describes a line-of-business
53254       ###### Related Nodes
53255       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
53256
53257     required:
53258     - line-of-business-name
53259     properties:
53260       line-of-business-name:
53261         type: string
53262         description: Name of the line-of-business (product)
53263       resource-version:
53264         type: string
53265         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53266       relationship-list:
53267         type: array
53268         items:
53269           $ref: "#/getDefinitions/relationship"
53270   lines-of-business:
53271     description: |
53272       Collection of lines-of-business
53273     properties:
53274       line-of-business:
53275         type: array
53276         items:
53277           $ref: "#/getDefinitions/line-of-business"
53278   logical-link:
53279     description: |
53280       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
53281       ###### Related Nodes
53282       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
53283       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
53284       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
53285       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
53286       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
53287       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
53288       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
53289       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
53290       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
53291       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
53292       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
53293       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
53294       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
53295       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
53296
53297       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
53298     required:
53299     - link-name
53300     - link-type
53301     properties:
53302       link-name:
53303         type: string
53304         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
53305       link-type:
53306         type: string
53307         description: Type of logical link, e.g., evc
53308       speed-value:
53309         type: string
53310         description: Captures the numeric part of the speed
53311       speed-units:
53312         type: string
53313         description: Captures the units corresponding to the speed
53314       ip-version:
53315         type: string
53316         description: v4, v6, or ds for dual stack
53317       routing-protocol:
53318         type: string
53319         description: For example, static or BGP
53320       resource-version:
53321         type: string
53322         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53323       model-invariant-id:
53324         type: string
53325         description: the ASDC model id for this resource or service model.
53326       model-version-id:
53327         type: string
53328         description: the ASDC model version for this resource or service model.
53329       persona-model-version:
53330         type: string
53331         description: the ASDC model version for this resource or service model.
53332       widget-model-id:
53333         type: string
53334         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53335       widget-model-version:
53336         type: string
53337         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53338       operational-status:
53339         type: string
53340         description: Indication of operational status of the logical link.
53341       prov-status:
53342         type: string
53343         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53344       link-role:
53345         type: string
53346         description: Indication of the network use of the logical link.
53347       link-name2:
53348         type: string
53349         description: Alias or alternate name (CLCI or D1 name).
53350       link-id:
53351         type: string
53352         description: UUID of the logical-link, SDNC generates this.
53353       circuit-id:
53354         type: string
53355         description: Circuit id
53356       purpose:
53357         type: string
53358         description: Reason for this entity, role it is playing
53359       relationship-list:
53360         type: array
53361         items:
53362           $ref: "#/getDefinitions/relationship"
53363   logical-links:
53364     description: |
53365       Collection of logical connections
53366     properties:
53367       logical-link:
53368         type: array
53369         items:
53370           $ref: "#/getDefinitions/logical-link"
53371   metadata:
53372     description: |
53373       Collection of metadatum (key/value pairs)
53374     properties:
53375       metadatum:
53376         type: array
53377         items:
53378           $ref: "#/getDefinitions/metadatum"
53379   metadatum:
53380     description: |
53381       Key/value pairs
53382       ###### Related Nodes
53383       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
53384       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
53385       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
53386       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
53387
53388       -(4) IF this TO node is deleted, this METADATUM is DELETED also
53389     required:
53390     - metaname
53391     - metaval
53392     properties:
53393       metaname:
53394         type: string
53395       metaval:
53396         type: string
53397       resource-version:
53398         type: string
53399         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53400   model:
53401     description: |
53402       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
53403       ###### Related Nodes
53404       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
53405       - FROM instance-group( instance-group Targets model, MANY2MANY)
53406       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
53407       - FROM named-query( named-query AppliesTo model, ONE2MANY)
53408       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
53409
53410       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
53411       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
53412
53413     required:
53414     - model-invariant-id
53415     - model-type
53416     properties:
53417       model-invariant-id:
53418         type: string
53419         description: Unique identifier corresponding to the main definition of a model in ASDC
53420       model-type:
53421         type: string
53422         description: Type of the model, e.g., service, resource, widget, etc.
53423       resource-version:
53424         type: string
53425         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53426       model-vers:
53427         type: array
53428         items:
53429           $ref: "#/getDefinitions/model-ver"
53430       relationship-list:
53431         type: array
53432         items:
53433           $ref: "#/getDefinitions/relationship"
53434   model-and-named-query-search:
53435     description: |
53436       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
53437     properties:
53438       query-parameters:
53439         type: object
53440         $ref: "#/getDefinitions/query-parameters"
53441       instance-filters:
53442         type: object
53443         $ref: "#/getDefinitions/instance-filters"
53444       secondary-filts:
53445         type: object
53446         $ref: "#/getDefinitions/secondary-filts"
53447       top-node-type:
53448         type: string
53449       secondary-filter-cut-point:
53450         type: string
53451   model-constraint:
53452     description: |
53453       This is how we would capture constraints defining allowed sets of elements.
53454       ###### Related Nodes
53455       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
53456       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
53457
53458       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
53459       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
53460     required:
53461     - model-constraint-uuid
53462     - constrained-element-set-uuid-to-replace
53463     properties:
53464       model-constraint-uuid:
53465         type: string
53466       constrained-element-set-uuid-to-replace:
53467         type: string
53468       constrained-element-sets:
53469         type: array
53470         items:
53471           $ref: "#/getDefinitions/constrained-element-set"
53472       resource-version:
53473         type: string
53474         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53475   model-constraints:
53476     properties:
53477       model-constraint:
53478         type: array
53479         items:
53480           $ref: "#/getDefinitions/model-constraint"
53481   model-element:
53482     description: |
53483       Defines how other models combine to make up a higher-level model.
53484       ###### Related Nodes
53485       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
53486       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53487       - TO model-ver( model-element IsA model-ver, MANY2ONE)
53488       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
53489       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
53490       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
53491       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53492
53493       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
53494       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
53495     required:
53496     - model-element-uuid
53497     - new-data-del-flag
53498     - cardinality
53499     properties:
53500       model-element-uuid:
53501         type: string
53502       new-data-del-flag:
53503         type: string
53504         description: Indicates whether this element was created as part of instantiation from this model
53505       cardinality:
53506         type: string
53507         description: How many of this type of element are required/allowed
53508       linkage-points:
53509         type: string
53510       resource-version:
53511         type: string
53512         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53513       model-elements:
53514         type: array
53515         items:
53516           $ref: "#/getDefinitions/model-element"
53517         description: Defines how other models combine to make up a higher-level model
53518       model-constraints:
53519         type: array
53520         items:
53521           $ref: "#/getDefinitions/model-constraint"
53522         description: Describes new constraints on this model element that are not part of that model's definition
53523       relationship-list:
53524         type: array
53525         items:
53526           $ref: "#/getDefinitions/relationship"
53527   model-elements:
53528     properties:
53529       model-element:
53530         type: array
53531         items:
53532           $ref: "#/getDefinitions/model-element"
53533   model-ver:
53534     description: |
53535       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
53536       ###### Related Nodes
53537       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
53538       - FROM model-element( model-element IsA model-ver, MANY2ONE)
53539       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
53540       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
53541
53542       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
53543       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
53544       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
53545
53546     required:
53547     - model-version-id
53548     - model-name
53549     - model-version
53550     properties:
53551       model-version-id:
53552         type: string
53553         description: Unique identifier corresponding to one version of a model in ASDC
53554       model-name:
53555         type: string
53556         description: Name of the model, which can change from version to version.
53557       model-version:
53558         type: string
53559         description: Version
53560       model-description:
53561         type: string
53562         description: Description
53563       resource-version:
53564         type: string
53565         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53566       model-elements:
53567         type: array
53568         items:
53569           $ref: "#/getDefinitions/model-element"
53570       metadata:
53571         type: array
53572         items:
53573           $ref: "#/getDefinitions/metadatum"
53574       relationship-list:
53575         type: array
53576         items:
53577           $ref: "#/getDefinitions/relationship"
53578   model-vers:
53579     properties:
53580       model-ver:
53581         type: array
53582         items:
53583           $ref: "#/getDefinitions/model-ver"
53584   models:
53585     description: |
53586       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
53587     properties:
53588       model:
53589         type: array
53590         items:
53591           $ref: "#/getDefinitions/model"
53592   multicast-configuration:
53593     description: |
53594       ###### Related Nodes
53595       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
53596
53597     required:
53598     - multicast-configuration-id
53599     - multicast-protocol
53600     - rp-type
53601     properties:
53602       multicast-configuration-id:
53603         type: string
53604         description: Unique id of multicast configuration.
53605       multicast-protocol:
53606         type: string
53607         description: protocol of multicast configuration
53608       rp-type:
53609         type: string
53610         description: rp type of multicast configuration
53611       resource-version:
53612         type: string
53613         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53614       relationship-list:
53615         type: array
53616         items:
53617           $ref: "#/getDefinitions/relationship"
53618   multicast-configurations:
53619     description: |
53620       multicast configuration of generic-vnf ip-address
53621     properties:
53622       multicast-configuration:
53623         type: array
53624         items:
53625           $ref: "#/getDefinitions/multicast-configuration"
53626   named-queries:
53627     properties:
53628       named-query:
53629         type: array
53630         items:
53631           $ref: "#/getDefinitions/named-query"
53632   named-query:
53633     description: |
53634       TBD
53635       ###### Related Nodes
53636       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
53637       - TO model( named-query AppliesTo model, ONE2MANY)
53638       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
53639
53640       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
53641     required:
53642     - named-query-uuid
53643     - named-query-name
53644     - named-query-version
53645     properties:
53646       named-query-uuid:
53647         type: string
53648       named-query-name:
53649         type: string
53650       named-query-version:
53651         type: string
53652       required-input-param:
53653         type: string
53654       description:
53655         type: string
53656       resource-version:
53657         type: string
53658       named-query-elements:
53659         type: array
53660         items:
53661           $ref: "#/getDefinitions/named-query-element"
53662       relationship-list:
53663         type: array
53664         items:
53665           $ref: "#/getDefinitions/relationship"
53666   named-query-element:
53667     description: |
53668       TBD
53669       ###### Related Nodes
53670       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
53671       - TO model( named-query-element IsA model, MANY2ONE)
53672       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53673       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
53674       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
53675       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53676
53677       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
53678       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
53679     required:
53680     - named-query-element-uuid
53681     properties:
53682       named-query-element-uuid:
53683         type: string
53684       property-collect-list:
53685         type: string
53686       resource-version:
53687         type: string
53688       property-limit-desc:
53689         type: string
53690       do-not-output:
53691         type: string
53692       named-query-elements:
53693         type: array
53694         items:
53695           $ref: "#/getDefinitions/named-query-element"
53696       related-lookups:
53697         type: array
53698         items:
53699           $ref: "#/getDefinitions/related-lookup"
53700       property-constraints:
53701         type: array
53702         items:
53703           $ref: "#/getDefinitions/property-constraint"
53704       relationship-list:
53705         type: array
53706         items:
53707           $ref: "#/getDefinitions/relationship"
53708   named-query-elements:
53709     properties:
53710       named-query-element:
53711         type: array
53712         items:
53713           $ref: "#/getDefinitions/named-query-element"
53714   network:
53715     description: |
53716       Namespace for network inventory resources.
53717     properties:
53718       logical-links:
53719         type: array
53720         items:
53721           $ref: "#/getDefinitions/logical-link"
53722       site-pair-sets:
53723         type: array
53724         items:
53725           $ref: "#/getDefinitions/site-pair-set"
53726       vpn-bindings:
53727         type: array
53728         items:
53729           $ref: "#/getDefinitions/vpn-binding"
53730       vpls-pes:
53731         type: array
53732         items:
53733           $ref: "#/getDefinitions/vpls-pe"
53734       multicast-configurations:
53735         type: array
53736         items:
53737           $ref: "#/getDefinitions/multicast-configuration"
53738       vces:
53739         type: array
53740         items:
53741           $ref: "#/getDefinitions/vce"
53742       vnfcs:
53743         type: array
53744         items:
53745           $ref: "#/getDefinitions/vnfc"
53746       l3-networks:
53747         type: array
53748         items:
53749           $ref: "#/getDefinitions/l3-network"
53750       network-policies:
53751         type: array
53752         items:
53753           $ref: "#/getDefinitions/network-policy"
53754       generic-vnfs:
53755         type: array
53756         items:
53757           $ref: "#/getDefinitions/generic-vnf"
53758       lag-links:
53759         type: array
53760         items:
53761           $ref: "#/getDefinitions/lag-link"
53762       newvces:
53763         type: array
53764         items:
53765           $ref: "#/getDefinitions/newvce"
53766       pnfs:
53767         type: array
53768         items:
53769           $ref: "#/getDefinitions/pnf"
53770       physical-links:
53771         type: array
53772         items:
53773           $ref: "#/getDefinitions/physical-link"
53774       ipsec-configurations:
53775         type: array
53776         items:
53777           $ref: "#/getDefinitions/ipsec-configuration"
53778       route-table-references:
53779         type: array
53780         items:
53781           $ref: "#/getDefinitions/route-table-reference"
53782       instance-groups:
53783         type: array
53784         items:
53785           $ref: "#/getDefinitions/instance-group"
53786       zones:
53787         type: array
53788         items:
53789           $ref: "#/getDefinitions/zone"
53790   network-policies:
53791     properties:
53792       network-policy:
53793         type: array
53794         items:
53795           $ref: "#/getDefinitions/network-policy"
53796   network-policy:
53797     description: |
53798       ###### Related Nodes
53799       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
53800       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
53801
53802     required:
53803     - network-policy-id
53804     properties:
53805       network-policy-id:
53806         type: string
53807         description: UUID representing unique key to this instance
53808       network-policy-fqdn:
53809         type: string
53810         description: Contrail FQDN for the policy
53811       heat-stack-id:
53812         type: string
53813         description: ID for the openStack Heat instance
53814       resource-version:
53815         type: string
53816         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53817       relationship-list:
53818         type: array
53819         items:
53820           $ref: "#/getDefinitions/relationship"
53821   network-profile:
53822     description: |
53823       Network profile populated by SDN-GP for SNMP
53824       ###### Related Nodes
53825       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
53826
53827     required:
53828     - nm-profile-name
53829     properties:
53830       nm-profile-name:
53831         type: string
53832         description: Unique name of network profile.
53833       community-string:
53834         type: string
53835         description: Encrypted SNMP community string
53836       resource-version:
53837         type: string
53838         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53839       relationship-list:
53840         type: array
53841         items:
53842           $ref: "#/getDefinitions/relationship"
53843   network-profiles:
53844     description: |
53845       Collection of network profiles
53846     properties:
53847       network-profile:
53848         type: array
53849         items:
53850           $ref: "#/getDefinitions/network-profile"
53851   newvce:
53852     description: |
53853       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
53854       ###### Related Nodes
53855       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
53856
53857       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
53858     required:
53859     - vnf-id2
53860     - vnf-name
53861     - vnf-type
53862     properties:
53863       vnf-id2:
53864         type: string
53865         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
53866       vnf-name:
53867         type: string
53868         description: Name of VNF.
53869       vnf-name2:
53870         type: string
53871         description: Alternate name of VNF.
53872       vnf-type:
53873         type: string
53874         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53875       prov-status:
53876         type: string
53877         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53878       operational-status:
53879         type: string
53880         description: Indicator for whether the resource is considered operational
53881       license-key:
53882         type: string
53883         description: OBSOLETE -  do not use
53884       ipv4-oam-address:
53885         type: string
53886         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).
53887       equipment-role:
53888         type: string
53889         description: Client should send valid enumerated value.
53890       resource-version:
53891         type: string
53892         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53893       ipv4-loopback0-address:
53894         type: string
53895         description: v4 Loopback0 address
53896       orchestration-status:
53897         type: string
53898         description: Orchestration status of this VNF, mastered by MSO.
53899       heat-stack-id:
53900         type: string
53901         description: Heat stack id corresponding to this instance, managed by MSO
53902       mso-catalog-key:
53903         type: string
53904         description: Corresponds to the SDN-C catalog id used to configure this VCE
53905       relationship-list:
53906         type: array
53907         items:
53908           $ref: "#/getDefinitions/relationship"
53909       l-interfaces:
53910         type: array
53911         items:
53912           $ref: "#/getDefinitions/l-interface"
53913   newvces:
53914     description: |
53915       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
53916     properties:
53917       newvce:
53918         type: array
53919         items:
53920           $ref: "#/getDefinitions/newvce"
53921   nodes:
53922     properties:
53923       inventory-item-data:
53924         type: array
53925         items:
53926           $ref: "#/getDefinitions/inventory-item-data"
53927   notification-event:
53928     properties:
53929       cambria.partition:
53930         type: string
53931       notification-event-header:
53932         type: object
53933         $ref: "#/getDefinitions/notification-event-header"
53934   notification-event-header:
53935     properties:
53936       id:
53937         type: string
53938       timestamp:
53939         type: string
53940       source-name:
53941         type: string
53942       domain:
53943         type: string
53944       sequence-number:
53945         type: string
53946       severity:
53947         type: string
53948       event-type:
53949         type: string
53950       version:
53951         type: string
53952       action:
53953         type: string
53954       entity-type:
53955         type: string
53956       top-entity-type:
53957         type: string
53958       entity-link:
53959         type: string
53960       status:
53961         type: string
53962   notify:
53963     required:
53964     - event-id
53965     properties:
53966       event-id:
53967         type: string
53968       node-type:
53969         type: string
53970       event-trigger:
53971         type: string
53972       key-data:
53973         type: array
53974         items:
53975           $ref: "#/getDefinitions/key-data"
53976       selflink:
53977         type: string
53978   oam-network:
53979     description: |
53980       OAM network, to be deprecated shortly.  Do not use for new purposes.
53981       ###### Related Nodes
53982       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
53983       - TO complex( oam-network AppliesTo complex, MANY2MANY)
53984       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
53985
53986     required:
53987     - network-uuid
53988     - network-name
53989     - cvlan-tag
53990     properties:
53991       network-uuid:
53992         type: string
53993         description: UUID of the network. Unique across a cloud-region
53994       network-name:
53995         type: string
53996         description: Name of the network.
53997       cvlan-tag:
53998         type: integer
53999         format: int64
54000         description: cvlan-id
54001       ipv4-oam-gateway-address:
54002         type: string
54003         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54004       ipv4-oam-gateway-address-prefix-length:
54005         type: integer
54006         format: int32
54007         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54008       resource-version:
54009         type: string
54010         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54011       relationship-list:
54012         type: array
54013         items:
54014           $ref: "#/getDefinitions/relationship"
54015   oam-networks:
54016     description: |
54017       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
54018     properties:
54019       oam-network:
54020         type: array
54021         items:
54022           $ref: "#/getDefinitions/oam-network"
54023   operational-environment:
54024     description: |
54025       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
54026       ###### Related Nodes
54027       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
54028       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
54029
54030     required:
54031     - operational-environment-id
54032     - operational-environment-name
54033     - operational-environment-type
54034     - operational-environment-status
54035     - tenant-context
54036     - workload-context
54037     properties:
54038       operational-environment-id:
54039         type: string
54040         description: UUID of an operational environment
54041       operational-environment-name:
54042         type: string
54043         description: Operational Environment name
54044       operational-environment-type:
54045         type: string
54046         description: Operational Environment Type.
54047       operational-environment-status:
54048         type: string
54049         description: Status
54050       tenant-context:
54051         type: string
54052         description: Tenant Context.
54053       workload-context:
54054         type: string
54055         description: Workload Context.
54056       resource-version:
54057         type: string
54058         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54059       relationship-list:
54060         type: array
54061         items:
54062           $ref: "#/getDefinitions/relationship"
54063   operational-environments:
54064     description: |
54065       a logical partition of the cloud which allows to have multiple environments in the production AIC.
54066     properties:
54067       operational-environment:
54068         type: array
54069         items:
54070           $ref: "#/getDefinitions/operational-environment"
54071   overloaded-model:
54072     description: |
54073       Allows for legacy POST of old-style and new-style models
54074     required:
54075     - model-invariant-id
54076     - model-name-version-id
54077     - model-type
54078     - model-name
54079     - model-id
54080     - model-version
54081     properties:
54082       model-invariant-id:
54083         type: string
54084         description: Unique identifier corresponding to the main definition of a model in ASDC
54085       model-name-version-id:
54086         type: string
54087         description: Unique identifier corresponding to one version of a model in ASDC
54088       model-type:
54089         type: string
54090         description: Type of the model, e.g., service, resource, widget, etc.
54091       model-name:
54092         type: string
54093         description: Name of the model, which can change from version to version.
54094       model-id:
54095         type: string
54096         description: Invariant unique ID which does not change from version to version
54097       model-version:
54098         type: string
54099         description: Version
54100       model-description:
54101         type: string
54102         description: Description
54103       resource-version:
54104         type: string
54105         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54106       model-vers:
54107         type: object
54108         $ref: "#/getDefinitions/model-vers"
54109       relationship-list:
54110         type: object
54111         $ref: "#/getDefinitions/relationship-list"
54112   owning-entities:
54113     description: |
54114       Collection of owning-entities
54115     properties:
54116       owning-entity:
54117         type: array
54118         items:
54119           $ref: "#/getDefinitions/owning-entity"
54120   owning-entity:
54121     description: |
54122       describes an owning-entity
54123       ###### Related Nodes
54124       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
54125
54126     required:
54127     - owning-entity-id
54128     - owning-entity-name
54129     properties:
54130       owning-entity-id:
54131         type: string
54132         description: UUID of an owning entity
54133       owning-entity-name:
54134         type: string
54135         description: Owning entity name
54136       resource-version:
54137         type: string
54138         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54139       relationship-list:
54140         type: array
54141         items:
54142           $ref: "#/getDefinitions/relationship"
54143   p-interface:
54144     description: |
54145       Physical interface (e.g., nic)
54146       ###### Related Nodes
54147       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
54148       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
54149       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
54150       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
54151       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
54152       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
54153       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
54154
54155       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
54156       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
54157       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
54158     required:
54159     - interface-name
54160     - in-maint
54161     properties:
54162       interface-name:
54163         type: string
54164         description: Name that identifies the physical interface
54165       speed-value:
54166         type: string
54167         description: Captures the numeric part of the speed
54168       speed-units:
54169         type: string
54170         description: Captures the units corresponding to the speed
54171       port-description:
54172         type: string
54173         description: Nature of the services and connectivity on this port.
54174       equipment-identifier:
54175         type: string
54176         description: CLEI or other specification for p-interface hardware.
54177       interface-role:
54178         type: string
54179         description: Role specification for p-interface hardware.
54180       interface-type:
54181         type: string
54182         description: Indicates the physical properties of the interface.
54183       prov-status:
54184         type: string
54185         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54186       resource-version:
54187         type: string
54188         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54189       in-maint:
54190         type: boolean
54191         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
54192       relationship-list:
54193         type: array
54194         items:
54195           $ref: "#/getDefinitions/relationship"
54196       l-interfaces:
54197         type: array
54198         items:
54199           $ref: "#/getDefinitions/l-interface"
54200   p-interfaces:
54201     description: |
54202       Collection of physical interfaces.
54203     properties:
54204       p-interface:
54205         type: array
54206         items:
54207           $ref: "#/getDefinitions/p-interface"
54208   physical-link:
54209     description: |
54210       Collection of physical connections, typically between p-interfaces
54211       ###### Related Nodes
54212       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
54213
54214       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
54215     required:
54216     - link-name
54217     properties:
54218       link-name:
54219         type: string
54220         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
54221       speed-value:
54222         type: string
54223         description: Captures the numeric part of the speed
54224       speed-units:
54225         type: string
54226         description: Captures the units corresponding to the speed
54227       circuit-id:
54228         type: string
54229         description: Circuit it
54230       dual-mode:
54231         type: string
54232         description: Dual access mode (e.g., primary, secondary
54233       management-option:
54234         type: string
54235         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
54236       service-provider-name:
54237         type: string
54238         description: Name of the service Provider on this link.
54239       resource-version:
54240         type: string
54241         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54242       relationship-list:
54243         type: array
54244         items:
54245           $ref: "#/getDefinitions/relationship"
54246   physical-links:
54247     description: |
54248       Collection of physical connections, typically between p-interfaces
54249     properties:
54250       physical-link:
54251         type: array
54252         items:
54253           $ref: "#/getDefinitions/physical-link"
54254   platform:
54255     description: |
54256       describes a platform
54257       ###### Related Nodes
54258       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
54259
54260     required:
54261     - platform-name
54262     properties:
54263       platform-name:
54264         type: string
54265         description: Name of the platform
54266       resource-version:
54267         type: string
54268         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54269       relationship-list:
54270         type: array
54271         items:
54272           $ref: "#/getDefinitions/relationship"
54273   platforms:
54274     description: |
54275       Collection of platforms
54276     properties:
54277       platform:
54278         type: array
54279         items:
54280           $ref: "#/getDefinitions/platform"
54281   pnf:
54282     description: |
54283       PNF represents a physical network function. typically equipment used in the D1 world.
54284       ###### Related Nodes
54285       - TO complex( pnf LocatedIn complex, MANY2ONE)
54286       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
54287       - TO zone( pnf LocatedIn zone, MANY2ONE)
54288       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
54289       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
54290       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
54291       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
54292
54293       -(1) IF this PNF node is deleted, this FROM node is DELETED also
54294     required:
54295     - pnf-name
54296     - in-maint
54297     properties:
54298       pnf-name:
54299         type: string
54300         description: unique name of Physical Network Function.
54301       pnf-name2:
54302         type: string
54303         description: name of Physical Network Function.
54304       pnf-name2-source:
54305         type: string
54306         description: source of name2
54307       pnf-id:
54308         type: string
54309         description: id of pnf
54310       equip-type:
54311         type: string
54312         description: Equipment type.  Source of truth should define valid values.
54313       equip-vendor:
54314         type: string
54315         description: Equipment vendor.  Source of truth should define valid values.
54316       equip-model:
54317         type: string
54318         description: Equipment model.  Source of truth should define valid values.
54319       management-option:
54320         type: string
54321         description: identifier of managed by company or customer
54322       ipaddress-v4-oam:
54323         type: string
54324         description: ipv4-oam-address with new naming convention for IP addresses
54325       sw-version:
54326         type: string
54327         description: sw-version is the version of SW for the hosted application on the PNF.
54328       in-maint:
54329         type: boolean
54330         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.
54331       frame-id:
54332         type: string
54333         description: ID of the physical frame (relay rack) where pnf is installed.
54334       serial-number:
54335         type: string
54336         description: Serial number of the device
54337       ipaddress-v4-loopback-0:
54338         type: string
54339         description: IPV4 Loopback 0 address
54340       ipaddress-v6-loopback-0:
54341         type: string
54342         description: IPV6 Loopback 0 address
54343       ipaddress-v4-aim:
54344         type: string
54345         description: IPV4 AIM address
54346       ipaddress-v6-aim:
54347         type: string
54348         description: IPV6 AIM address
54349       ipaddress-v6-oam:
54350         type: string
54351         description: IPV6 OAM address
54352       inv-status:
54353         type: string
54354         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
54355       resource-version:
54356         type: string
54357         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54358       prov-status:
54359         type: string
54360         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54361       nf-role:
54362         type: string
54363         description: Nf Role is the role performed by this instance in the network.
54364       relationship-list:
54365         type: array
54366         items:
54367           $ref: "#/getDefinitions/relationship"
54368       p-interfaces:
54369         type: array
54370         items:
54371           $ref: "#/getDefinitions/p-interface"
54372       lag-interfaces:
54373         type: array
54374         items:
54375           $ref: "#/getDefinitions/lag-interface"
54376   pnfs:
54377     description: |
54378       Collection of Physical Network Functions.
54379     properties:
54380       pnf:
54381         type: array
54382         items:
54383           $ref: "#/getDefinitions/pnf"
54384   port-group:
54385     description: |
54386       Used to capture the network interfaces of this VCE
54387       ###### Related Nodes
54388       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
54389       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
54390
54391       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
54392       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
54393     required:
54394     - interface-id
54395     - orchestration-status
54396     properties:
54397       interface-id:
54398         type: string
54399         description: Unique ID of the interface
54400       neutron-network-id:
54401         type: string
54402         description: Neutron network id of this Interface
54403       neutron-network-name:
54404         type: string
54405         description: Neutron network name of this Interface
54406       interface-role:
54407         type: string
54408         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
54409       resource-version:
54410         type: string
54411         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54412       port-group-id:
54413         type: string
54414         description: Unique ID for port group in vmware
54415       port-group-name:
54416         type: string
54417         description: Likely to duplicate value of neutron network name
54418       switch-name:
54419         type: string
54420         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
54421       orchestration-status:
54422         type: string
54423         description: Orchestration status of this VNF, mastered by MSO
54424       heat-stack-id:
54425         type: string
54426         description: Heat stack id corresponding to this instance, managed by MSO
54427       mso-catalog-key:
54428         type: string
54429         description: Corresponds to the SDN-C catalog id used to configure this VCE
54430       cvlan-tags:
54431         type: array
54432         items:
54433           $ref: "#/getDefinitions/cvlan-tag-entry"
54434       relationship-list:
54435         type: array
54436         items:
54437           $ref: "#/getDefinitions/relationship"
54438   port-groups:
54439     properties:
54440       port-group:
54441         type: array
54442         items:
54443           $ref: "#/getDefinitions/port-group"
54444   project:
54445     description: |
54446       describes the project
54447       ###### Related Nodes
54448       - TO service-instance( project Uses service-instance, ONE2MANY)
54449
54450     required:
54451     - project-name
54452     properties:
54453       project-name:
54454         type: string
54455         description: Name of the project deploying a service
54456       resource-version:
54457         type: string
54458         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54459       relationship-list:
54460         type: array
54461         items:
54462           $ref: "#/getDefinitions/relationship"
54463   projects:
54464     description: |
54465       Collection of projects
54466     properties:
54467       project:
54468         type: array
54469         items:
54470           $ref: "#/getDefinitions/project"
54471   properties:
54472     description: |
54473       Property holder for query properties or instance properties
54474     properties:
54475       property-name:
54476         type: string
54477       property-value:
54478         type: string
54479   property-constraint:
54480     description: |
54481       TBD
54482       ###### Related Nodes
54483       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
54484
54485       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
54486     required:
54487     - property-constraint-uuid
54488     - constraint-type
54489     - property-name
54490     - property-value
54491     properties:
54492       property-constraint-uuid:
54493         type: string
54494       constraint-type:
54495         type: string
54496       property-name:
54497         type: string
54498       property-value:
54499         type: string
54500       resource-version:
54501         type: string
54502   property-constraints:
54503     properties:
54504       property-constraint:
54505         type: array
54506         items:
54507           $ref: "#/getDefinitions/property-constraint"
54508   pserver:
54509     description: |
54510       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
54511       ###### Related Nodes
54512       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
54513       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
54514       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
54515       - TO complex( pserver LocatedIn complex, MANY2ONE)
54516       - TO zone( pserver LocatedIn zone, MANY2ONE)
54517       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
54518       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
54519       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
54520       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
54521       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
54522
54523       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
54524       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
54525
54526     required:
54527     - hostname
54528     - in-maint
54529     properties:
54530       hostname:
54531         type: string
54532         description: Value from executing hostname on the compute node.
54533       ptnii-equip-name:
54534         type: string
54535         description: PTNII name
54536       number-of-cpus:
54537         type: integer
54538         format: int32
54539         description: Number of cpus
54540       disk-in-gigabytes:
54541         type: integer
54542         format: int32
54543         description: Disk size, in GBs
54544       ram-in-megabytes:
54545         type: integer
54546         format: int32
54547         description: RAM size, in MBs
54548       equip-type:
54549         type: string
54550         description: Equipment type.  Source of truth should define valid values.
54551       equip-vendor:
54552         type: string
54553         description: Equipment vendor.  Source of truth should define valid values.
54554       equip-model:
54555         type: string
54556         description: Equipment model.  Source of truth should define valid values.
54557       fqdn:
54558         type: string
54559         description: Fully-qualified domain name
54560       pserver-selflink:
54561         type: string
54562         description: URL to endpoint where AAI can get more details
54563       ipv4-oam-address:
54564         type: string
54565         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
54566       serial-number:
54567         type: string
54568         description: Serial number, may be queried
54569       ipaddress-v4-loopback-0:
54570         type: string
54571         description: IPV4 Loopback 0 address
54572       ipaddress-v6-loopback-0:
54573         type: string
54574         description: IPV6 Loopback 0 address
54575       ipaddress-v4-aim:
54576         type: string
54577         description: IPV4 AIM address
54578       ipaddress-v6-aim:
54579         type: string
54580         description: IPV6 AIM address
54581       ipaddress-v6-oam:
54582         type: string
54583         description: IPV6 OAM address
54584       inv-status:
54585         type: string
54586         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
54587       pserver-id:
54588         type: string
54589         description: ID of Pserver
54590       internet-topology:
54591         type: string
54592         description: internet topology of Pserver
54593       in-maint:
54594         type: boolean
54595         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.
54596       resource-version:
54597         type: string
54598         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54599       pserver-name2:
54600         type: string
54601         description: alternative pserver name
54602       purpose:
54603         type: string
54604         description: purpose of pserver
54605       prov-status:
54606         type: string
54607         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54608       relationship-list:
54609         type: array
54610         items:
54611           $ref: "#/getDefinitions/relationship"
54612       p-interfaces:
54613         type: array
54614         items:
54615           $ref: "#/getDefinitions/p-interface"
54616       lag-interfaces:
54617         type: array
54618         items:
54619           $ref: "#/getDefinitions/lag-interface"
54620   pservers:
54621     description: |
54622       Collection of compute hosts.
54623     properties:
54624       pserver:
54625         type: array
54626         items:
54627           $ref: "#/getDefinitions/pserver"
54628   query-parameters:
54629     description: |
54630       QueryParameters for performing a named-query or model query
54631     properties:
54632       named-query:
54633         type: object
54634         $ref: "#/getDefinitions/named-query"
54635       overloaded-model:
54636         type: object
54637         $ref: "#/getDefinitions/overloaded-model"
54638   related-lookup:
54639     description: |
54640       TBD
54641       ###### Related Nodes
54642       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
54643
54644       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
54645     required:
54646     - related-lookup-uuid
54647     - source-node-type
54648     - source-node-property
54649     - target-node-type
54650     - target-node-property
54651     properties:
54652       related-lookup-uuid:
54653         type: string
54654       source-node-type:
54655         type: string
54656       source-node-property:
54657         type: string
54658       target-node-type:
54659         type: string
54660       target-node-property:
54661         type: string
54662       property-collect-list:
54663         type: string
54664       resource-version:
54665         type: string
54666       relationship-list:
54667         type: array
54668         items:
54669           $ref: "#/getDefinitions/relationship"
54670   related-lookups:
54671     properties:
54672       related-lookup:
54673         type: array
54674         items:
54675           $ref: "#/getDefinitions/related-lookup"
54676   related-to-property:
54677     properties:
54678       property-key:
54679         type: string
54680         description: Key part of a key/value pair
54681       property-value:
54682         type: string
54683         description: Value part of a key/value pair
54684   relationship:
54685     properties:
54686       related-to:
54687         type: string
54688         description: A keyword provided by A&AI to indicate type of node.
54689       related-link:
54690         type: string
54691         description: URL to the object in A&AI.
54692       relationship-data:
54693         type: array
54694         items:
54695           $ref: "#/getDefinitions/relationship-data"
54696       related-to-property:
54697         type: array
54698         items:
54699           $ref: "#/getDefinitions/related-to-property"
54700   relationship-data:
54701     required:
54702     - relationship-key
54703     - relationship-value
54704     properties:
54705       relationship-key:
54706         type: string
54707         description: A keyword provided by A&AI to indicate an attribute.
54708       relationship-value:
54709         type: string
54710         description: Value of the attribute.
54711   relationship-list:
54712     properties:
54713       relationship:
54714         type: array
54715         items:
54716           $ref: "#/getDefinitions/relationship"
54717   reserved-prop-names:
54718     description: |
54719       Internal map to define some reserved properties of a vertex
54720     properties:
54721       last-mod-source-of-truth:
54722         type: string
54723       aai-node-type:
54724         type: string
54725       aai-created-ts:
54726         type: integer
54727         format: int64
54728       aai-unique-key:
54729         type: string
54730       aai-last-mod-ts:
54731         type: integer
54732         format: int64
54733       source-of-truth:
54734         type: string
54735       aai-uri:
54736         type: string
54737   response-list:
54738     description: |
54739       Response container for the results of a named-query or model query
54740     properties:
54741       inventory-response-items:
54742         type: object
54743         $ref: "#/getDefinitions/inventory-response-items"
54744   result-data:
54745     properties:
54746       resource-type:
54747         type: string
54748         description: The specific type of node in the A&AI graph
54749       resource-link:
54750         type: string
54751         description: The URL to the specific resource
54752   route-table-reference:
54753     description: |
54754       Openstack route table reference.
54755       ###### Related Nodes
54756       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
54757
54758     required:
54759     - route-table-reference-id
54760     - route-table-reference-fqdn
54761     properties:
54762       route-table-reference-id:
54763         type: string
54764         description: Route Table Reference id, UUID assigned to this instance.
54765       route-table-reference-fqdn:
54766         type: string
54767         description: FQDN entry in the route table.
54768       resource-version:
54769         type: string
54770         description: Concurrency value
54771       relationship-list:
54772         type: array
54773         items:
54774           $ref: "#/getDefinitions/relationship"
54775   route-table-references:
54776     description: |
54777       Collection of openstack route table references
54778     properties:
54779       route-table-reference:
54780         type: array
54781         items:
54782           $ref: "#/getDefinitions/route-table-reference"
54783   route-target:
54784     description: |
54785       Route target information
54786       ###### Related Nodes
54787       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
54788
54789       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
54790     required:
54791     - global-route-target
54792     - route-target-role
54793     properties:
54794       global-route-target:
54795         type: string
54796         description: Number used to identify an RT, globally unique in the network
54797       route-target-role:
54798         type: string
54799         description: Role assigned to this route target
54800       resource-version:
54801         type: string
54802         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54803       relationship-list:
54804         type: array
54805         items:
54806           $ref: "#/getDefinitions/relationship"
54807   route-targets:
54808     description: |
54809       Collection of route target information
54810     properties:
54811       route-target:
54812         type: array
54813         items:
54814           $ref: "#/getDefinitions/route-target"
54815   routing-instance:
54816     description: |
54817       ###### Related Nodes
54818       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
54819       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
54820
54821       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
54822       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
54823     required:
54824     - routing-instance-id
54825     properties:
54826       routing-instance-id:
54827         type: string
54828         description: Unique id of routing instance
54829       rpm-owner:
54830         type: string
54831         description: rpm owner
54832       resource-version:
54833         type: string
54834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54835       site-pairs:
54836         type: array
54837         items:
54838           $ref: "#/getDefinitions/site-pair"
54839       relationship-list:
54840         type: array
54841         items:
54842           $ref: "#/getDefinitions/relationship"
54843   routing-instances:
54844     description: |
54845       set of probes related to generic-vnf routing instance
54846     properties:
54847       routing-instance:
54848         type: array
54849         items:
54850           $ref: "#/getDefinitions/routing-instance"
54851   sdn-zone-response:
54852     properties:
54853       oam-networks:
54854         type: object
54855         $ref: "#/getDefinitions/oam-networks"
54856       az-and-dvs-switches:
54857         type: array
54858         items:
54859           $ref: "#/getDefinitions/az-and-dvs-switches"
54860   search:
54861     properties:
54862       edge-tag-query-result:
54863         type: object
54864         $ref: "#/getDefinitions/edge-tag-query-result"
54865       edge-tag-query-request:
54866         type: object
54867         $ref: "#/getDefinitions/edge-tag-query-request"
54868       search-results:
54869         type: object
54870         $ref: "#/getDefinitions/search-results"
54871       sdn-zone-response:
54872         type: object
54873         $ref: "#/getDefinitions/sdn-zone-response"
54874   search-results:
54875     properties:
54876       result-data:
54877         type: array
54878         items:
54879           $ref: "#/getDefinitions/result-data"
54880   secondary-filt:
54881     description: |
54882       SecondaryFilt for performing a named-query or model query
54883   secondary-filter:
54884     properties:
54885       property-name:
54886         type: string
54887       filter-type:
54888         type: string
54889       property-value:
54890         type: string
54891   secondary-filts:
54892     description: |
54893       SecondaryFilts for performing a named-query or model query
54894     properties:
54895       secondary-filt:
54896         type: array
54897         items:
54898           $ref: "#/getDefinitions/secondary-filt"
54899   segmentation-assignment:
54900     description: |
54901       Openstack segmentation assignment.
54902       ###### Related Nodes
54903       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
54904
54905       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
54906     required:
54907     - segmentation-id
54908     properties:
54909       segmentation-id:
54910         type: string
54911         description: Route Table Reference id, UUID assigned to this instance.
54912       resource-version:
54913         type: string
54914         description: Concurrency value
54915       relationship-list:
54916         type: array
54917         items:
54918           $ref: "#/getDefinitions/relationship"
54919   segmentation-assignments:
54920     description: |
54921       Collection of openstack segmentation assignments
54922     properties:
54923       segmentation-assignment:
54924         type: array
54925         items:
54926           $ref: "#/getDefinitions/segmentation-assignment"
54927   service:
54928     description: |
54929       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
54930     required:
54931     - service-id
54932     - service-description
54933     properties:
54934       service-id:
54935         type: string
54936         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54937       service-description:
54938         type: string
54939         description: Description of the service
54940       service-selflink:
54941         type: string
54942         description: URL to endpoint where AAI can get more details
54943       resource-version:
54944         type: string
54945         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54946       service-version:
54947         type: string
54948         description: service version
54949       relationship-list:
54950         type: array
54951         items:
54952           $ref: "#/getDefinitions/relationship"
54953   service-capabilities:
54954     description: |
54955       Collection of service capabilities.
54956     properties:
54957       service-capability:
54958         type: array
54959         items:
54960           $ref: "#/getDefinitions/service-capability"
54961   service-capability:
54962     description: |
54963       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
54964       ###### Related Nodes
54965       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
54966       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
54967
54968       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
54969
54970     required:
54971     - service-type
54972     - vnf-type
54973     properties:
54974       service-type:
54975         type: string
54976         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54977       vnf-type:
54978         type: string
54979         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54980       resource-version:
54981         type: string
54982         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54983       relationship-list:
54984         type: array
54985         items:
54986           $ref: "#/getDefinitions/relationship"
54987   service-design-and-creation:
54988     description: |
54989       Namespace for objects managed by ASDC
54990     properties:
54991       vnf-images:
54992         type: array
54993         items:
54994           $ref: "#/getDefinitions/vnf-image"
54995       services:
54996         type: array
54997         items:
54998           $ref: "#/getDefinitions/service"
54999       service-capabilities:
55000         type: array
55001         items:
55002           $ref: "#/getDefinitions/service-capability"
55003       models:
55004         type: array
55005         items:
55006           $ref: "#/getDefinitions/model"
55007       named-queries:
55008         type: array
55009         items:
55010           $ref: "#/getDefinitions/named-query"
55011   service-instance:
55012     description: |
55013       Instance of a service
55014       ###### Related Nodes
55015       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
55016       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
55017       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
55018       - TO connector( service-instance Uses connector, MANY2MANY)
55019       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
55020       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
55021       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
55022       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
55023       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
55024       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55025       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
55026       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
55027       - TO vce( service-instance ComposedOf vce, ONE2MANY)
55028       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
55029       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
55030       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55031
55032       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
55033       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
55034       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
55035     required:
55036     - service-instance-id
55037     properties:
55038       service-instance-id:
55039         type: string
55040         description: Uniquely identifies this instance of a service
55041       service-instance-name:
55042         type: string
55043         description: This field will store a name assigned to the service-instance.
55044       model-invariant-id:
55045         type: string
55046         description: the ASDC model id for this resource or service model.
55047       model-version-id:
55048         type: string
55049         description: the ASDC model version for this resource or service model.
55050       persona-model-version:
55051         type: string
55052         description: the ASDC model version for this resource or service model.
55053       widget-model-id:
55054         type: string
55055         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55056       widget-model-version:
55057         type: string
55058         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55059       bandwidth-total:
55060         type: string
55061         description: Indicates the total bandwidth to be used for this service.
55062       bandwidth-up-wan1:
55063         type: string
55064         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55065       bandwidth-down-wan1:
55066         type: string
55067         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55068       bandwidth-up-wan2:
55069         type: string
55070         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55071       bandwidth-down-wan2:
55072         type: string
55073         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55074       vhn-portal-url:
55075         type: string
55076         description: URL customers will use to access the vHN Portal.
55077       service-instance-location-id:
55078         type: string
55079         description: An identifier that customers assign to the location where this service is being used.
55080       resource-version:
55081         type: string
55082         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55083       selflink:
55084         type: string
55085         description: Path to the controller object.
55086       orchestration-status:
55087         type: string
55088         description: Orchestration status of this service.
55089       relationship-list:
55090         type: array
55091         items:
55092           $ref: "#/getDefinitions/relationship"
55093       metadata:
55094         type: array
55095         items:
55096           $ref: "#/getDefinitions/metadatum"
55097       allotted-resources:
55098         type: array
55099         items:
55100           $ref: "#/getDefinitions/allotted-resource"
55101   service-instances:
55102     description: |
55103       Collection of service instances
55104     properties:
55105       service-instance:
55106         type: array
55107         items:
55108           $ref: "#/getDefinitions/service-instance"
55109   service-subscription:
55110     description: |
55111       Object that group service instances.
55112       ###### Related Nodes
55113       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
55114       - TO tenant( service-subscription Uses tenant, MANY2MANY)
55115       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
55116
55117       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
55118       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
55119     required:
55120     - service-type
55121     properties:
55122       service-type:
55123         type: string
55124         description: Value defined by orchestration to identify this service across ECOMP.
55125       temp-ub-sub-account-id:
55126         type: string
55127         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55128       resource-version:
55129         type: string
55130         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55131       service-instances:
55132         type: array
55133         items:
55134           $ref: "#/getDefinitions/service-instance"
55135       relationship-list:
55136         type: array
55137         items:
55138           $ref: "#/getDefinitions/relationship"
55139   service-subscriptions:
55140     description: |
55141       Collection of objects that group service instances.
55142     properties:
55143       service-subscription:
55144         type: array
55145         items:
55146           $ref: "#/getDefinitions/service-subscription"
55147   services:
55148     description: |
55149       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
55150     properties:
55151       service:
55152         type: array
55153         items:
55154           $ref: "#/getDefinitions/service"
55155   site-pair:
55156     description: |
55157       ###### Related Nodes
55158       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
55159       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
55160
55161       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
55162       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
55163     required:
55164     - site-pair-id
55165     properties:
55166       site-pair-id:
55167         type: string
55168         description: unique identifier of probe
55169       source-ip:
55170         type: string
55171         description: Prefix address
55172       destination-ip:
55173         type: string
55174         description: Prefix address
55175       ip-version:
55176         type: string
55177         description: ip version, v4, v6
55178       destination-hostname:
55179         type: string
55180         description: Hostname of the destination equipment to which SLAs are measured against.
55181       destination-equip-type:
55182         type: string
55183         description: The type of destinatination equipment. Could be Router, etc.
55184       resource-version:
55185         type: string
55186         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55187       classes-of-service:
55188         type: array
55189         items:
55190           $ref: "#/getDefinitions/class-of-service"
55191       relationship-list:
55192         type: array
55193         items:
55194           $ref: "#/getDefinitions/relationship"
55195   site-pair-set:
55196     description: |
55197       Set of instances for probes used to measure service level agreements
55198       ###### Related Nodes
55199       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
55200       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
55201
55202       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
55203     required:
55204     - site-pair-set-id
55205     properties:
55206       site-pair-set-id:
55207         type: string
55208         description: Unique id of site pair set.
55209       resource-version:
55210         type: string
55211         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55212       routing-instances:
55213         type: array
55214         items:
55215           $ref: "#/getDefinitions/routing-instance"
55216       relationship-list:
55217         type: array
55218         items:
55219           $ref: "#/getDefinitions/relationship"
55220   site-pair-sets:
55221     description: |
55222       Collection of sets of instances for probes related to generic-vnf
55223     properties:
55224       site-pair-set:
55225         type: array
55226         items:
55227           $ref: "#/getDefinitions/site-pair-set"
55228   site-pairs:
55229     description: |
55230       probe within a set
55231     properties:
55232       site-pair:
55233         type: array
55234         items:
55235           $ref: "#/getDefinitions/site-pair"
55236   snapshot:
55237     description: |
55238       Openstack snapshot
55239       ###### Related Nodes
55240       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
55241       - FROM vserver( vserver Uses snapshot, ONE2ONE)
55242
55243     required:
55244     - snapshot-id
55245     properties:
55246       snapshot-id:
55247         type: string
55248         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
55249       snapshot-name:
55250         type: string
55251         description: Snapshot name
55252       snapshot-architecture:
55253         type: string
55254         description: Operating system architecture
55255       snapshot-os-distro:
55256         type: string
55257         description: The common name of the operating system distribution in lowercase
55258       snapshot-os-version:
55259         type: string
55260         description: The operating system version as specified by the distributor.
55261       application:
55262         type: string
55263         description: The application that the image instantiates.
55264       application-vendor:
55265         type: string
55266         description: The vendor of the application.
55267       application-version:
55268         type: string
55269         description: The version of the application.
55270       snapshot-selflink:
55271         type: string
55272         description: URL to endpoint where AAI can get more details
55273       prev-snapshot-id:
55274         type: string
55275         description: This field contains the UUID of the previous snapshot (if any).
55276       resource-version:
55277         type: string
55278         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55279       relationship-list:
55280         type: array
55281         items:
55282           $ref: "#/getDefinitions/relationship"
55283   snapshots:
55284     description: |
55285       Collection of openstack snapshots
55286     properties:
55287       snapshot:
55288         type: array
55289         items:
55290           $ref: "#/getDefinitions/snapshot"
55291   sriov-pf:
55292     description: |
55293       SR-IOV Physical Function
55294       ###### Related Nodes
55295       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
55296       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
55297
55298       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
55299     required:
55300     - pf-pci-id
55301     properties:
55302       pf-pci-id:
55303         type: string
55304         description: Identifier for the sriov-pf
55305       resource-version:
55306         type: string
55307         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55308       relationship-list:
55309         type: array
55310         items:
55311           $ref: "#/getDefinitions/relationship"
55312   sriov-pfs:
55313     description: |
55314       Collection of SR-IOV Physical Functions.
55315     properties:
55316       sriov-pf:
55317         type: array
55318         items:
55319           $ref: "#/getDefinitions/sriov-pf"
55320   sriov-vf:
55321     description: |
55322       SR-IOV Virtual Function (not to be confused with virtual network function)
55323       ###### Related Nodes
55324       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
55325
55326       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
55327     required:
55328     - pci-id
55329     properties:
55330       pci-id:
55331         type: string
55332         description: PCI ID used to identify the sriov-vf
55333       vf-vlan-filter:
55334         type: string
55335         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
55336       vf-mac-filter:
55337         type: string
55338         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
55339       vf-vlan-strip:
55340         type: boolean
55341         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
55342       vf-vlan-anti-spoof-check:
55343         type: boolean
55344         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.
55345       vf-mac-anti-spoof-check:
55346         type: boolean
55347         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.
55348       vf-mirrors:
55349         type: string
55350         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
55351       vf-broadcast-allow:
55352         type: boolean
55353         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
55354       vf-unknown-multicast-allow:
55355         type: boolean
55356         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
55357       vf-unknown-unicast-allow:
55358         type: boolean
55359         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
55360       vf-insert-stag:
55361         type: boolean
55362         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
55363       vf-link-status:
55364         type: string
55365         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
55366       resource-version:
55367         type: string
55368         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55369       neutron-network-id:
55370         type: string
55371         description: Neutron network id of the interface
55372       relationship-list:
55373         type: array
55374         items:
55375           $ref: "#/getDefinitions/relationship"
55376   sriov-vfs:
55377     description: |
55378       Collection of SR-IOV Virtual Functions.
55379     properties:
55380       sriov-vf:
55381         type: array
55382         items:
55383           $ref: "#/getDefinitions/sriov-vf"
55384   start-node-filter:
55385     properties:
55386       property-name:
55387         type: string
55388       property-value:
55389         type: string
55390   subnet:
55391     description: |
55392       ###### Related Nodes
55393       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
55394       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
55395       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
55396
55397       -(4) IF this TO node is deleted, this SUBNET is DELETED also
55398       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
55399
55400     required:
55401     - subnet-id
55402     - dhcp-enabled
55403     properties:
55404       subnet-id:
55405         type: string
55406         description: Subnet ID, should be UUID.
55407       subnet-name:
55408         type: string
55409         description: Name associated with the subnet.
55410       neutron-subnet-id:
55411         type: string
55412         description: Neutron id of this subnet
55413       gateway-address:
55414         type: string
55415         description: gateway ip address
55416       network-start-address:
55417         type: string
55418         description: network start address
55419       cidr-mask:
55420         type: string
55421         description: cidr mask
55422       ip-version:
55423         type: string
55424         description: ip version
55425       orchestration-status:
55426         type: string
55427         description: Orchestration status of this VNF, mastered by MSO
55428       dhcp-enabled:
55429         type: boolean
55430         description: dhcp enabled
55431       dhcp-start:
55432         type: string
55433         description: the start address reserved for use by dhcp
55434       dhcp-end:
55435         type: string
55436         description: the last address reserved for use by dhcp
55437       resource-version:
55438         type: string
55439         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55440       relationship-list:
55441         type: array
55442         items:
55443           $ref: "#/getDefinitions/relationship"
55444   subnets:
55445     properties:
55446       subnet:
55447         type: array
55448         items:
55449           $ref: "#/getDefinitions/subnet"
55450   tagged-inventory-item-list:
55451     properties:
55452       inventory-item:
55453         type: array
55454         items:
55455           $ref: "#/getDefinitions/inventory-item"
55456   tenant:
55457     description: |
55458       Openstack tenant
55459       ###### Related Nodes
55460       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
55461       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
55462       - TO l3-network( tenant Uses l3-network, MANY2MANY)
55463       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
55464       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
55465       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
55466
55467       -TENANT cannot be deleted if related to VSERVER
55468
55469     required:
55470     - tenant-id
55471     - tenant-name
55472     properties:
55473       tenant-id:
55474         type: string
55475         description: Unique id relative to the cloud-region.
55476       tenant-name:
55477         type: string
55478         description: Readable name of tenant
55479       resource-version:
55480         type: string
55481         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55482       vservers:
55483         type: array
55484         items:
55485           $ref: "#/getDefinitions/vserver"
55486       relationship-list:
55487         type: array
55488         items:
55489           $ref: "#/getDefinitions/relationship"
55490   tenants:
55491     description: |
55492       Collection of openstack tenants.
55493     properties:
55494       tenant:
55495         type: array
55496         items:
55497           $ref: "#/getDefinitions/tenant"
55498   tunnel-xconnect:
55499     description: |
55500       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
55501       ###### Related Nodes
55502       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
55503
55504       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
55505     required:
55506     - id
55507     - bandwidth-up-wan1
55508     - bandwidth-down-wan1
55509     - bandwidth-up-wan2
55510     - bandwidth-down-wan2
55511     properties:
55512       id:
55513         type: string
55514         description: Allotted Resource id UUID assigned to this instance.
55515       bandwidth-up-wan1:
55516         type: string
55517         description: The WAN uplink bandwidth for WAN1
55518       bandwidth-down-wan1:
55519         type: string
55520         description: The WAN downlink bandwidth for WAN1
55521       bandwidth-up-wan2:
55522         type: string
55523         description: The WAN uplink bandwidth for WAN2
55524       bandwidth-down-wan2:
55525         type: string
55526         description: The WAN downlink bandwidth for WAN2
55527       resource-version:
55528         type: string
55529         description: Concurrency value
55530       relationship-list:
55531         type: array
55532         items:
55533           $ref: "#/getDefinitions/relationship"
55534   tunnel-xconnects:
55535     description: |
55536       This object is used to store the specific tunnel cross connect aspects of an allotted resource
55537     properties:
55538       tunnel-xconnect:
55539         type: array
55540         items:
55541           $ref: "#/getDefinitions/tunnel-xconnect"
55542   update:
55543     description: |
55544       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
55545     required:
55546     - update-node-type
55547     properties:
55548       update-node-type:
55549         type: string
55550       update-node-key:
55551         type: array
55552         items:
55553           $ref: "#/getDefinitions/update-node-key"
55554       update-node-uri:
55555         type: string
55556       action:
55557         type: array
55558         items:
55559           $ref: "#/getDefinitions/action"
55560   update-node-key:
55561     properties:
55562       key-name:
55563         type: string
55564       key-value:
55565         type: string
55566   vce:
55567     description: |
55568       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
55569       ###### Related Nodes
55570       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
55571       - TO complex( vce LocatedIn complex, MANY2MANY)
55572       - TO vserver( vce HostedOn vserver, ONE2MANY)
55573       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
55574       - FROM license( license BelongsTo vce, MANY2ONE)(1)
55575       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
55576       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
55577
55578       -(1) IF this VCE node is deleted, this FROM node is DELETED also
55579     required:
55580     - vnf-id
55581     - vnf-name
55582     - vnf-type
55583     properties:
55584       vnf-id:
55585         type: string
55586         description: Unique id of VNF.  This is unique across the graph.
55587       vnf-name:
55588         type: string
55589         description: Name of VNF.
55590       vnf-name2:
55591         type: string
55592         description: Alternate name of VNF.
55593       vnf-type:
55594         type: string
55595         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55596       service-id:
55597         type: string
55598         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
55599       regional-resource-zone:
55600         type: string
55601         description: Regional way of organizing pservers, source of truth should define values
55602       prov-status:
55603         type: string
55604         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55605       operational-status:
55606         type: string
55607         description: Indicator for whether the resource is considered operational
55608       license-key:
55609         type: string
55610         description: OBSOLETE -  do not use
55611       equipment-role:
55612         type: string
55613         description: Network role being played by this VNF
55614       orchestration-status:
55615         type: string
55616         description: Orchestration status of this VNF, mastered by MSO
55617       heat-stack-id:
55618         type: string
55619         description: Heat stack id corresponding to this instance, managed by MSO
55620       mso-catalog-key:
55621         type: string
55622         description: Corresponds to the SDN-C catalog id used to configure this VCE
55623       vpe-id:
55624         type: string
55625         description: Unique ID of VPE connected to this VCE.
55626       v6-vce-wan-address:
55627         type: string
55628         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
55629       ipv4-oam-address:
55630         type: string
55631         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
55632       resource-version:
55633         type: string
55634         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55635       ipv4-loopback0-address:
55636         type: string
55637         description: Loopback0 address
55638       entitlement-resource-uuid:
55639         type: string
55640         description: OBSOLETE -  see child relationships
55641       port-groups:
55642         type: array
55643         items:
55644           $ref: "#/getDefinitions/port-group"
55645       licenses:
55646         type: array
55647         items:
55648           $ref: "#/getDefinitions/license"
55649       entitlements:
55650         type: array
55651         items:
55652           $ref: "#/getDefinitions/entitlement"
55653       relationship-list:
55654         type: array
55655         items:
55656           $ref: "#/getDefinitions/relationship"
55657   vces:
55658     description: |
55659       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
55660     properties:
55661       vce:
55662         type: array
55663         items:
55664           $ref: "#/getDefinitions/vce"
55665   vf-module:
55666     description: |
55667       a deployment unit of VNFCs
55668       ###### Related Nodes
55669       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
55670       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
55671       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
55672       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
55673       - TO vserver( vf-module Uses vserver, ONE2MANY)
55674
55675       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
55676       -VF-MODULE cannot be deleted if related to VNFC
55677
55678     required:
55679     - vf-module-id
55680     - is-base-vf-module
55681     properties:
55682       vf-module-id:
55683         type: string
55684         description: Unique ID of vf-module.
55685       vf-module-name:
55686         type: string
55687         description: Name of vf-module
55688       heat-stack-id:
55689         type: string
55690         description: Heat stack id corresponding to this instance.
55691       orchestration-status:
55692         type: string
55693         description: orchestration status of this vf-module, mastered by MSO
55694       is-base-vf-module:
55695         type: boolean
55696         description: used to indicate whether or not this object is base vf module
55697       resource-version:
55698         type: string
55699         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55700       model-invariant-id:
55701         type: string
55702         description: the ASDC model id for this resource or service model.
55703       model-version-id:
55704         type: string
55705         description: the ASDC model version for this resource or service model.
55706       persona-model-version:
55707         type: string
55708         description: the ASDC model version for this resource or service model.
55709       model-customization-id:
55710         type: string
55711         description: captures the id of all the configuration used to customize the resource for the service.
55712       widget-model-id:
55713         type: string
55714         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55715       widget-model-version:
55716         type: string
55717         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55718       contrail-service-instance-fqdn:
55719         type: string
55720         description: the Contrail unique ID for a service-instance
55721       module-index:
55722         type: integer
55723         format: int32
55724         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
55725       selflink:
55726         type: string
55727         description: Path to the controller object.
55728       relationship-list:
55729         type: array
55730         items:
55731           $ref: "#/getDefinitions/relationship"
55732   vf-modules:
55733     description: |
55734       Collection of vf-modules, a deployment unit of VNFCs
55735     properties:
55736       vf-module:
55737         type: array
55738         items:
55739           $ref: "#/getDefinitions/vf-module"
55740   vig-server:
55741     description: |
55742       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
55743       ###### Related Nodes
55744       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
55745
55746       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
55747     required:
55748     - vig-address-type
55749     properties:
55750       vig-address-type:
55751         type: string
55752         description: indicates whether the VIG is for AVPN or INTERNET
55753       ipaddress-v4-vig:
55754         type: string
55755         description: v4 IP of the vig server
55756       ipaddress-v6-vig:
55757         type: string
55758         description: v6 IP of the vig server
55759       resource-version:
55760         type: string
55761         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55762       relationship-list:
55763         type: array
55764         items:
55765           $ref: "#/getDefinitions/relationship"
55766   vig-servers:
55767     properties:
55768       vig-server:
55769         type: array
55770         items:
55771           $ref: "#/getDefinitions/vig-server"
55772   vip-ipv4-address-list:
55773     description: |
55774       IPv4 Address Range
55775       ###### Related Nodes
55776       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55777       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
55778       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
55779       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
55780
55781     required:
55782     - vip-ipv4-address
55783     properties:
55784       vip-ipv4-address:
55785         type: string
55786         description: IP address
55787       vip-ipv4-prefix-length:
55788         type: integer
55789         format: int64
55790         description: Prefix length, 32 for single address
55791       vlan-id-inner:
55792         type: integer
55793         format: int64
55794         description: Inner VLAN tag
55795       vlan-id-outer:
55796         type: integer
55797         format: int64
55798         description: Outer VLAN tag
55799       is-floating:
55800         type: boolean
55801         description: Indicator of fixed or floating address
55802       resource-version:
55803         type: string
55804         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55805       neutron-network-id:
55806         type: string
55807         description: Neutron network id of the interface that address belongs to
55808       neutron-subnet-id:
55809         type: string
55810         description: Neutron id of subnet that address belongs to
55811       relationship-list:
55812         type: array
55813         items:
55814           $ref: "#/getDefinitions/relationship"
55815   vip-ipv6-address-list:
55816     description: |
55817       IPv6 Address Range
55818       ###### Related Nodes
55819       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55820       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
55821       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
55822       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
55823
55824     required:
55825     - vip-ipv6-address
55826     properties:
55827       vip-ipv6-address:
55828         type: string
55829         description: IP address
55830       vip-ipv6-prefix-length:
55831         type: integer
55832         format: int64
55833         description: Prefix length, 128 for single address
55834       vlan-id-inner:
55835         type: integer
55836         format: int64
55837         description: Inner VLAN tag
55838       vlan-id-outer:
55839         type: integer
55840         format: int64
55841         description: Outer VLAN tag
55842       is-floating:
55843         type: boolean
55844         description: Indicator of fixed or floating address
55845       resource-version:
55846         type: string
55847         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55848       neutron-network-id:
55849         type: string
55850         description: Neutron network id of the interface that address belongs to
55851       neutron-subnet-id:
55852         type: string
55853         description: Neutron id of subnet that address belongs to
55854       relationship-list:
55855         type: array
55856         items:
55857           $ref: "#/getDefinitions/relationship"
55858   virtual-data-center:
55859     description: |
55860       Virtual organization of cloud infrastructure elements in a data center context
55861       ###### Related Nodes
55862       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
55863       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
55864       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
55865
55866     required:
55867     - vdc-id
55868     - vdc-name
55869     properties:
55870       vdc-id:
55871         type: string
55872         description: Unique ID of the vdc
55873       vdc-name:
55874         type: string
55875         description: Name of the virtual data center
55876       resource-version:
55877         type: string
55878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55879       relationship-list:
55880         type: array
55881         items:
55882           $ref: "#/getDefinitions/relationship"
55883   virtual-data-centers:
55884     description: |
55885       Virtual organization of cloud infrastructure elements in a data center context
55886     properties:
55887       virtual-data-center:
55888         type: array
55889         items:
55890           $ref: "#/getDefinitions/virtual-data-center"
55891   vlan:
55892     description: |
55893       Definition of vlan
55894       ###### Related Nodes
55895       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
55896       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
55897       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
55898       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
55899       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
55900       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
55901       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
55902
55903       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
55904       -(2) IF this VLAN node is deleted, this TO node is DELETED also
55905       -(4) IF this TO node is deleted, this VLAN is DELETED also
55906     required:
55907     - vlan-interface
55908     - in-maint
55909     properties:
55910       vlan-interface:
55911         type: string
55912         description: String that identifies the interface
55913       vlan-id-inner:
55914         type: integer
55915         format: int64
55916         description: Inner VLAN tag
55917       vlan-id-outer:
55918         type: integer
55919         format: int64
55920         description: Outer VLAN tag
55921       resource-version:
55922         type: string
55923         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55924       speed-value:
55925         type: string
55926         description: Captures the numeric part of the speed
55927       speed-units:
55928         type: string
55929         description: Captures the units corresponding to the speed
55930       vlan-description:
55931         type: string
55932         description: Used to describe (the service associated with) the vlan
55933       backdoor-connection:
55934         type: string
55935         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
55936       vpn-id:
55937         type: string
55938         description: This indicates the customers VPN ID associated with this vlan
55939       orchestration-status:
55940         type: string
55941         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
55942       in-maint:
55943         type: boolean
55944         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
55945       relationship-list:
55946         type: array
55947         items:
55948           $ref: "#/getDefinitions/relationship"
55949       l3-interface-ipv4-address-list:
55950         type: array
55951         items:
55952           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
55953       l3-interface-ipv6-address-list:
55954         type: array
55955         items:
55956           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
55957   vlans:
55958     properties:
55959       vlan:
55960         type: array
55961         items:
55962           $ref: "#/getDefinitions/vlan"
55963   vnf:
55964     description: |
55965       Abstract vnf class
55966     required:
55967     - vnf-id
55968     properties:
55969       vnf-id:
55970         type: string
55971         description: Unique id of VNF.  This is unique across the graph.
55972   vnf-image:
55973     description: |
55974       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
55975       ###### Related Nodes
55976       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
55977
55978       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
55979
55980     required:
55981     - vnf-image-uuid
55982     - application
55983     - application-vendor
55984     properties:
55985       vnf-image-uuid:
55986         type: string
55987         description: Unique ID of this asset
55988       application:
55989         type: string
55990         description: The application that the image instantiates.
55991       application-vendor:
55992         type: string
55993         description: The vendor of the application.
55994       application-version:
55995         type: string
55996         description: The version of the application.
55997       selflink:
55998         type: string
55999         description: URL to endpoint where AAI can get more details
56000       resource-version:
56001         type: string
56002         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56003       relationship-list:
56004         type: array
56005         items:
56006           $ref: "#/getDefinitions/relationship"
56007   vnf-images:
56008     description: |
56009       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56010     properties:
56011       vnf-image:
56012         type: array
56013         items:
56014           $ref: "#/getDefinitions/vnf-image"
56015   vnfc:
56016     description: |
56017       ###### Related Nodes
56018       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56019       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56020       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56021
56022       -(4) IF this TO node is deleted, this VNFC is DELETED also
56023     required:
56024     - vnfc-name
56025     - vnfc-function-code
56026     - vnfc-type
56027     - in-maint
56028     - is-closed-loop-disabled
56029     properties:
56030       vnfc-name:
56031         type: string
56032         description: Unique ID of vnfc.
56033       vnfc-function-code:
56034         type: string
56035         description: function code
56036       vnfc-type:
56037         type: string
56038         description: type
56039       prov-status:
56040         type: string
56041         description: prov status of this vnfc
56042       orchestration-status:
56043         type: string
56044         description: Orchestration status of this VNF, mastered by APP-C
56045       ipaddress-v4-oam-vip:
56046         type: string
56047         description: Oam V4 vip address of this vnfc
56048       in-maint:
56049         type: boolean
56050         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56051       is-closed-loop-disabled:
56052         type: boolean
56053         description: used to indicate whether closed loop function is enabled on this node
56054       group-notation:
56055         type: string
56056         description: Group notation of VNFC
56057       resource-version:
56058         type: string
56059         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56060       relationship-list:
56061         type: array
56062         items:
56063           $ref: "#/getDefinitions/relationship"
56064   vnfcs:
56065     description: |
56066       virtual network components associated with a vserver from application controller.
56067     properties:
56068       vnfc:
56069         type: array
56070         items:
56071           $ref: "#/getDefinitions/vnfc"
56072   volume:
56073     description: |
56074       Ephemeral Block storage volume.
56075       ###### Related Nodes
56076       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56077
56078       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
56079     required:
56080     - volume-id
56081     - volume-selflink
56082     properties:
56083       volume-id:
56084         type: string
56085         description: Unique ID of block storage volume relative to the vserver.
56086       volume-selflink:
56087         type: string
56088         description: URL to endpoint where AAI can get more details
56089       resource-version:
56090         type: string
56091         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56092       relationship-list:
56093         type: array
56094         items:
56095           $ref: "#/getDefinitions/relationship"
56096   volume-group:
56097     description: |
56098       Persistent block-level storage.
56099       ###### Related Nodes
56100       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
56101       - TO complex( volume-group LocatedIn complex, MANY2ONE)
56102       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
56103       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
56104       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
56105
56106     required:
56107     - volume-group-id
56108     - volume-group-name
56109     - vnf-type
56110     properties:
56111       volume-group-id:
56112         type: string
56113         description: Unique ID of volume-group.
56114       volume-group-name:
56115         type: string
56116         description: Name of the volume group.
56117       heat-stack-id:
56118         type: string
56119         description: Heat stack id corresponding to this volume-group
56120       vnf-type:
56121         type: string
56122         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56123       orchestration-status:
56124         type: string
56125         description: Orchestration status of this volume-group
56126       model-customization-id:
56127         type: string
56128         description: captures the id of all the configuration used to customize the resource for the service.
56129       vf-module-model-customization-id:
56130         type: string
56131         description: helps relate the volume group to the vf-module whose components will require the volume group
56132       resource-version:
56133         type: string
56134         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56135       relationship-list:
56136         type: array
56137         items:
56138           $ref: "#/getDefinitions/relationship"
56139   volume-groups:
56140     description: |
56141       Collection of persistent block-level storage.
56142     properties:
56143       volume-group:
56144         type: array
56145         items:
56146           $ref: "#/getDefinitions/volume-group"
56147   volumes:
56148     description: |
56149       Collection of ephemeral Block storage volumes.
56150     properties:
56151       volume:
56152         type: array
56153         items:
56154           $ref: "#/getDefinitions/volume"
56155   vpls-pe:
56156     description: |
56157       VPLS Provider Edge routers.
56158       ###### Related Nodes
56159       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
56160       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
56161       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
56162       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
56163
56164       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
56165     required:
56166     - equipment-name
56167     properties:
56168       equipment-name:
56169         type: string
56170       prov-status:
56171         type: string
56172         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56173       ipv4-oam-address:
56174         type: string
56175         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).
56176       equipment-role:
56177         type: string
56178         description: Client should send valid enumerated value, e.g., VPLS-PE.
56179       vlan-id-outer:
56180         type: integer
56181         format: int64
56182         description: Temporary location for stag to get to VCE
56183       resource-version:
56184         type: string
56185         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56186       relationship-list:
56187         type: array
56188         items:
56189           $ref: "#/getDefinitions/relationship"
56190       p-interfaces:
56191         type: array
56192         items:
56193           $ref: "#/getDefinitions/p-interface"
56194       lag-interfaces:
56195         type: array
56196         items:
56197           $ref: "#/getDefinitions/lag-interface"
56198   vpls-pes:
56199     description: |
56200       Collection of VPLS Provider Edge routers
56201     properties:
56202       vpls-pe:
56203         type: array
56204         items:
56205           $ref: "#/getDefinitions/vpls-pe"
56206   vpn-binding:
56207     description: |
56208       VPN binding
56209       ###### Related Nodes
56210       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
56211       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
56212       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
56213
56214       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
56215       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
56216
56217     required:
56218     - vpn-id
56219     - vpn-name
56220     properties:
56221       vpn-id:
56222         type: string
56223         description: VPN ID, globally unique within A&AI
56224       vpn-name:
56225         type: string
56226         description: VPN Name
56227       vpn-platform:
56228         type: string
56229         description: the platform associated with the VPN example AVPN, Mobility
56230       vpn-type:
56231         type: string
56232         description: Type of the vpn, should be taken from enumerated/valid values
56233       route-distinguisher:
56234         type: string
56235         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56236       resource-version:
56237         type: string
56238         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56239       route-targets:
56240         type: array
56241         items:
56242           $ref: "#/getDefinitions/route-target"
56243       relationship-list:
56244         type: array
56245         items:
56246           $ref: "#/getDefinitions/relationship"
56247         description: l3-networks relate to vpn-bindings
56248   vpn-bindings:
56249     properties:
56250       vpn-binding:
56251         type: array
56252         items:
56253           $ref: "#/getDefinitions/vpn-binding"
56254   vserver:
56255     description: |
56256       Virtual Servers, aka virtual machine or VM.
56257       ###### Related Nodes
56258       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
56259       - TO flavor( vserver Uses flavor, MANY2ONE)
56260       - TO image( vserver Uses image, MANY2ONE)
56261       - TO pserver( vserver HostedOn pserver, MANY2ONE)
56262       - TO snapshot( vserver Uses snapshot, ONE2ONE)
56263       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
56264       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
56265       - FROM vce( vce HostedOn vserver, ONE2MANY)
56266       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
56267       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
56268       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
56269
56270       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
56271       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
56272     required:
56273     - vserver-id
56274     - vserver-name
56275     - vserver-selflink
56276     - in-maint
56277     - is-closed-loop-disabled
56278     properties:
56279       vserver-id:
56280         type: string
56281         description: Unique identifier for this vserver relative to its tenant
56282       vserver-name:
56283         type: string
56284         description: Name of vserver
56285       vserver-name2:
56286         type: string
56287         description: Alternative name of vserver
56288       prov-status:
56289         type: string
56290         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56291       vserver-selflink:
56292         type: string
56293         description: URL to endpoint where AAI can get more details
56294       in-maint:
56295         type: boolean
56296         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.
56297       is-closed-loop-disabled:
56298         type: boolean
56299         description: Used to indicate whether closed loop function is enabled on this node
56300       resource-version:
56301         type: string
56302         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56303       volumes:
56304         type: array
56305         items:
56306           $ref: "#/getDefinitions/volume"
56307       relationship-list:
56308         type: array
56309         items:
56310           $ref: "#/getDefinitions/relationship"
56311       l-interfaces:
56312         type: array
56313         items:
56314           $ref: "#/getDefinitions/l-interface"
56315   vservers:
56316     description: |
56317       Collection of virtual Servers, aka virtual machines or VMs.
56318     properties:
56319       vserver:
56320         type: array
56321         items:
56322           $ref: "#/getDefinitions/vserver"
56323   zone:
56324     description: |
56325       A zone is a grouping of assets in a location homing to the same connections into the CBB
56326       ###### Related Nodes
56327       - TO complex( zone LocatedIn complex, MANY2ONE)
56328       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
56329       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
56330       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
56331
56332     required:
56333     - zone-id
56334     - zone-name
56335     - design-type
56336     - zone-context
56337     properties:
56338       zone-id:
56339         type: string
56340         description: Code assigned by AIC to the zone
56341       zone-name:
56342         type: string
56343         description: English name associated with the zone
56344       design-type:
56345         type: string
56346         description: Design of zone [Medium/Large?]
56347       zone-context:
56348         type: string
56349         description: Context of zone [production/test]
56350       status:
56351         type: string
56352         description: Status of a zone.
56353       resource-version:
56354         type: string
56355         description: Concurrency value
56356       relationship-list:
56357         type: array
56358         items:
56359           $ref: "#/getDefinitions/relationship"
56360   zones:
56361     description: |
56362       Collection of zones
56363     properties:
56364       zone:
56365         type: array
56366         items:
56367           $ref: "#/getDefinitions/zone"