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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v11.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v11"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v11
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144     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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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-key
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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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         - name: tenant-context
4491           in: query
4492           description:
4493           required: false
4494           type: string
4495   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4496     put:
4497       tags:
4498         - CloudInfrastructure
4499       summary: see node definition for valid relationships
4500       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4501       consumes:
4502         - application/json
4503         - application/xml
4504       produces:
4505         - application/json
4506         - application/xml
4507       responses:
4508         "default":
4509           description: Response codes found in [response codes](https://wiki.onap.org/).
4510       parameters:
4511         - name: cloud-owner
4512           in: path
4513           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4514           required: true
4515           type: string
4516           example: __CLOUD-OWNER__
4517         - name: cloud-region-id
4518           in: path
4519           description: Identifier used by the vendor for the region. Second part of composite key
4520           required: true
4521           type: string
4522           example: __CLOUD-REGION-ID__
4523         - name: flavor-id
4524           in: path
4525           description: Flavor id, expected to be unique across cloud-region.
4526           required: true
4527           type: string
4528           example: __FLAVOR-ID__
4529         - name: body
4530           in: body
4531           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4532           required: true
4533           schema:
4534             $ref: "#/definitions/relationship"
4535     delete:
4536       tags:
4537         - CloudInfrastructure
4538       summary: delete an existing relationship
4539       description: delete an existing relationship
4540       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4541       consumes:
4542         - application/json
4543         - application/xml
4544       produces:
4545         - application/json
4546         - application/xml
4547       responses:
4548         "default":
4549           description: Response codes found in [response codes](https://wiki.onap.org/).
4550       parameters:
4551         - name: cloud-owner
4552           in: path
4553           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4554           required: true
4555           type: string
4556           example: __CLOUD-OWNER__
4557         - name: cloud-region-id
4558           in: path
4559           description: Identifier used by the vendor for the region. Second part of composite key
4560           required: true
4561           type: string
4562           example: __CLOUD-REGION-ID__
4563         - name: flavor-id
4564           in: path
4565           description: Flavor id, expected to be unique across cloud-region.
4566           required: true
4567           type: string
4568           example: __FLAVOR-ID__
4569   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4570     get:
4571       tags:
4572         - CloudInfrastructure
4573       summary: returns flavor
4574       description: returns flavor
4575       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4576       produces:
4577         - application/json
4578         - application/xml
4579       responses:
4580         "200":
4581           description: successful operation
4582           schema:
4583               $ref: "#/getDefinitions/flavor"
4584         "default":
4585           description: Response codes found in [response codes](https://wiki.onap.org/).
4586       parameters:
4587         - name: cloud-owner
4588           in: path
4589           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4590           required: true
4591           type: string
4592           example: __CLOUD-OWNER__
4593         - name: cloud-region-id
4594           in: path
4595           description: Identifier used by the vendor for the region. Second part of composite key
4596           required: true
4597           type: string
4598           example: __CLOUD-REGION-ID__
4599         - name: flavor-id
4600           in: path
4601           description: Flavor id, expected to be unique across cloud-region.
4602           required: true
4603           type: string
4604           example: __FLAVOR-ID__
4605     put:
4606       tags:
4607         - CloudInfrastructure
4608       summary: create or update an existing flavor
4609       description: |
4610         Create or update an existing flavor.
4611         #
4612         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4613       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4614       consumes:
4615         - application/json
4616         - application/xml
4617       produces:
4618         - application/json
4619         - application/xml
4620       responses:
4621         "default":
4622           description: Response codes found in [response codes](https://wiki.onap.org/).
4623       parameters:
4624         - name: cloud-owner
4625           in: path
4626           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4627           required: true
4628           type: string
4629           example: __CLOUD-OWNER__
4630         - name: cloud-region-id
4631           in: path
4632           description: Identifier used by the vendor for the region. Second part of composite key
4633           required: true
4634           type: string
4635           example: __CLOUD-REGION-ID__
4636         - name: flavor-id
4637           in: path
4638           description: Flavor id, expected to be unique across cloud-region.
4639           required: true
4640           type: string
4641           example: __FLAVOR-ID__
4642         - name: body
4643           in: body
4644           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4645           required: true
4646           schema:
4647             $ref: "#/definitions/flavor"
4648     patch:
4649       tags:
4650         - CloudInfrastructure
4651       summary: update an existing flavor
4652       description: |
4653         Update an existing flavor
4654         #
4655         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4656         The PUT operation will entirely replace an existing object.
4657         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4658         #
4659         Other differences between PUT and PATCH are:
4660         #
4661         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4662         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4663         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4664       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4665       consumes:
4666         - application/json
4667         - application/xml
4668       produces:
4669         - application/json
4670         - application/xml
4671       responses:
4672         "default":
4673           description: Response codes found in [response codes](https://wiki.onap.org/).
4674       parameters:
4675         - name: cloud-owner
4676           in: path
4677           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4678           required: true
4679           type: string
4680           example: __CLOUD-OWNER__
4681         - name: cloud-region-id
4682           in: path
4683           description: Identifier used by the vendor for the region. Second part of composite key
4684           required: true
4685           type: string
4686           example: __CLOUD-REGION-ID__
4687         - name: flavor-id
4688           in: path
4689           description: Flavor id, expected to be unique across cloud-region.
4690           required: true
4691           type: string
4692           example: __FLAVOR-ID__
4693         - name: body
4694           in: body
4695           description: flavor object that needs to be updated.
4696           required: true
4697           schema:
4698             $ref: "#/patchDefinitions/flavor"
4699     delete:
4700       tags:
4701         - CloudInfrastructure
4702       summary: delete an existing flavor
4703       description: delete an existing flavor
4704       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4705       consumes:
4706         - application/json
4707         - application/xml
4708       produces:
4709         - application/json
4710         - application/xml
4711       responses:
4712         "default":
4713           description: Response codes found in [response codes](https://wiki.onap.org/).
4714       parameters:
4715         - name: cloud-owner
4716           in: path
4717           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4718           required: true
4719           type: string
4720           example: __CLOUD-OWNER__
4721         - name: cloud-region-id
4722           in: path
4723           description: Identifier used by the vendor for the region. Second part of composite key
4724           required: true
4725           type: string
4726           example: __CLOUD-REGION-ID__
4727         - name: flavor-id
4728           in: path
4729           description: Flavor id, expected to be unique across cloud-region.
4730           required: true
4731           type: string
4732           example: __FLAVOR-ID__
4733         - name: resource-version
4734           in: query
4735           description: resource-version for concurrency
4736           required: true
4737           type: string
4738   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4739     get:
4740       tags:
4741         - CloudInfrastructure
4742       summary: returns flavors
4743       description: returns flavors
4744       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4745       produces:
4746         - application/json
4747         - application/xml
4748       responses:
4749         "200":
4750           description: successful operation
4751           schema:
4752               $ref: "#/getDefinitions/flavors"
4753         "default":
4754           description: Response codes found in [response codes](https://wiki.onap.org/).
4755       parameters:
4756         - name: cloud-owner
4757           in: path
4758           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4759           required: true
4760           type: string
4761           example: __CLOUD-OWNER__
4762         - name: cloud-region-id
4763           in: path
4764           description: Identifier used by the vendor for the region. Second part of composite key
4765           required: true
4766           type: string
4767           example: __CLOUD-REGION-ID__
4768         - name: flavor-id
4769           in: query
4770           description:
4771           required: false
4772           type: string
4773         - name: flavor-name
4774           in: query
4775           description:
4776           required: false
4777           type: string
4778   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4779     put:
4780       tags:
4781         - CloudInfrastructure
4782       summary: see node definition for valid relationships
4783       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4784       consumes:
4785         - application/json
4786         - application/xml
4787       produces:
4788         - application/json
4789         - application/xml
4790       responses:
4791         "default":
4792           description: Response codes found in [response codes](https://wiki.onap.org/).
4793       parameters:
4794         - name: cloud-owner
4795           in: path
4796           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4797           required: true
4798           type: string
4799           example: __CLOUD-OWNER__
4800         - name: cloud-region-id
4801           in: path
4802           description: Identifier used by the vendor for the region. Second part of composite key
4803           required: true
4804           type: string
4805           example: __CLOUD-REGION-ID__
4806         - name: group-id
4807           in: path
4808           description: Group id, expected to be unique across cloud-region.
4809           required: true
4810           type: string
4811           example: __GROUP-ID__
4812         - name: body
4813           in: body
4814           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4815           required: true
4816           schema:
4817             $ref: "#/definitions/relationship"
4818     delete:
4819       tags:
4820         - CloudInfrastructure
4821       summary: delete an existing relationship
4822       description: delete an existing relationship
4823       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4824       consumes:
4825         - application/json
4826         - application/xml
4827       produces:
4828         - application/json
4829         - application/xml
4830       responses:
4831         "default":
4832           description: Response codes found in [response codes](https://wiki.onap.org/).
4833       parameters:
4834         - name: cloud-owner
4835           in: path
4836           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4837           required: true
4838           type: string
4839           example: __CLOUD-OWNER__
4840         - name: cloud-region-id
4841           in: path
4842           description: Identifier used by the vendor for the region. Second part of composite key
4843           required: true
4844           type: string
4845           example: __CLOUD-REGION-ID__
4846         - name: group-id
4847           in: path
4848           description: Group id, expected to be unique across cloud-region.
4849           required: true
4850           type: string
4851           example: __GROUP-ID__
4852   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4853     get:
4854       tags:
4855         - CloudInfrastructure
4856       summary: returns group-assignment
4857       description: returns group-assignment
4858       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4859       produces:
4860         - application/json
4861         - application/xml
4862       responses:
4863         "200":
4864           description: successful operation
4865           schema:
4866               $ref: "#/getDefinitions/group-assignment"
4867         "default":
4868           description: Response codes found in [response codes](https://wiki.onap.org/).
4869       parameters:
4870         - name: cloud-owner
4871           in: path
4872           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4873           required: true
4874           type: string
4875           example: __CLOUD-OWNER__
4876         - name: cloud-region-id
4877           in: path
4878           description: Identifier used by the vendor for the region. Second part of composite key
4879           required: true
4880           type: string
4881           example: __CLOUD-REGION-ID__
4882         - name: group-id
4883           in: path
4884           description: Group id, expected to be unique across cloud-region.
4885           required: true
4886           type: string
4887           example: __GROUP-ID__
4888     put:
4889       tags:
4890         - CloudInfrastructure
4891       summary: create or update an existing group-assignment
4892       description: |
4893         Create or update an existing group-assignment.
4894         #
4895         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4896       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4897       consumes:
4898         - application/json
4899         - application/xml
4900       produces:
4901         - application/json
4902         - application/xml
4903       responses:
4904         "default":
4905           description: Response codes found in [response codes](https://wiki.onap.org/).
4906       parameters:
4907         - name: cloud-owner
4908           in: path
4909           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4910           required: true
4911           type: string
4912           example: __CLOUD-OWNER__
4913         - name: cloud-region-id
4914           in: path
4915           description: Identifier used by the vendor for the region. Second part of composite key
4916           required: true
4917           type: string
4918           example: __CLOUD-REGION-ID__
4919         - name: group-id
4920           in: path
4921           description: Group id, expected to be unique across cloud-region.
4922           required: true
4923           type: string
4924           example: __GROUP-ID__
4925         - name: body
4926           in: body
4927           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4928           required: true
4929           schema:
4930             $ref: "#/definitions/group-assignment"
4931     patch:
4932       tags:
4933         - CloudInfrastructure
4934       summary: update an existing group-assignment
4935       description: |
4936         Update an existing group-assignment
4937         #
4938         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4939         The PUT operation will entirely replace an existing object.
4940         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4941         #
4942         Other differences between PUT and PATCH are:
4943         #
4944         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4945         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4946         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4947       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4948       consumes:
4949         - application/json
4950         - application/xml
4951       produces:
4952         - application/json
4953         - application/xml
4954       responses:
4955         "default":
4956           description: Response codes found in [response codes](https://wiki.onap.org/).
4957       parameters:
4958         - name: cloud-owner
4959           in: path
4960           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4961           required: true
4962           type: string
4963           example: __CLOUD-OWNER__
4964         - name: cloud-region-id
4965           in: path
4966           description: Identifier used by the vendor for the region. Second part of composite key
4967           required: true
4968           type: string
4969           example: __CLOUD-REGION-ID__
4970         - name: group-id
4971           in: path
4972           description: Group id, expected to be unique across cloud-region.
4973           required: true
4974           type: string
4975           example: __GROUP-ID__
4976         - name: body
4977           in: body
4978           description: group-assignment object that needs to be updated.
4979           required: true
4980           schema:
4981             $ref: "#/patchDefinitions/group-assignment"
4982     delete:
4983       tags:
4984         - CloudInfrastructure
4985       summary: delete an existing group-assignment
4986       description: delete an existing group-assignment
4987       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4988       consumes:
4989         - application/json
4990         - application/xml
4991       produces:
4992         - application/json
4993         - application/xml
4994       responses:
4995         "default":
4996           description: Response codes found in [response codes](https://wiki.onap.org/).
4997       parameters:
4998         - name: cloud-owner
4999           in: path
5000           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5001           required: true
5002           type: string
5003           example: __CLOUD-OWNER__
5004         - name: cloud-region-id
5005           in: path
5006           description: Identifier used by the vendor for the region. Second part of composite key
5007           required: true
5008           type: string
5009           example: __CLOUD-REGION-ID__
5010         - name: group-id
5011           in: path
5012           description: Group id, expected to be unique across cloud-region.
5013           required: true
5014           type: string
5015           example: __GROUP-ID__
5016         - name: resource-version
5017           in: query
5018           description: resource-version for concurrency
5019           required: true
5020           type: string
5021   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5022     get:
5023       tags:
5024         - CloudInfrastructure
5025       summary: returns group-assignments
5026       description: returns group-assignments
5027       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5028       produces:
5029         - application/json
5030         - application/xml
5031       responses:
5032         "200":
5033           description: successful operation
5034           schema:
5035               $ref: "#/getDefinitions/group-assignments"
5036         "default":
5037           description: Response codes found in [response codes](https://wiki.onap.org/).
5038       parameters:
5039         - name: cloud-owner
5040           in: path
5041           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5042           required: true
5043           type: string
5044           example: __CLOUD-OWNER__
5045         - name: cloud-region-id
5046           in: path
5047           description: Identifier used by the vendor for the region. Second part of composite key
5048           required: true
5049           type: string
5050           example: __CLOUD-REGION-ID__
5051         - name: group-id
5052           in: query
5053           description:
5054           required: false
5055           type: string
5056         - name: group-type
5057           in: query
5058           description:
5059           required: false
5060           type: string
5061         - name: group-name
5062           in: query
5063           description:
5064           required: false
5065           type: string
5066   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5067     put:
5068       tags:
5069         - CloudInfrastructure
5070       summary: see node definition for valid relationships
5071       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5072       consumes:
5073         - application/json
5074         - application/xml
5075       produces:
5076         - application/json
5077         - application/xml
5078       responses:
5079         "default":
5080           description: Response codes found in [response codes](https://wiki.onap.org/).
5081       parameters:
5082         - name: cloud-owner
5083           in: path
5084           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5085           required: true
5086           type: string
5087           example: __CLOUD-OWNER__
5088         - name: cloud-region-id
5089           in: path
5090           description: Identifier used by the vendor for the region. Second part of composite key
5091           required: true
5092           type: string
5093           example: __CLOUD-REGION-ID__
5094         - name: snapshot-id
5095           in: path
5096           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5097           required: true
5098           type: string
5099           example: __SNAPSHOT-ID__
5100         - name: body
5101           in: body
5102           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5103           required: true
5104           schema:
5105             $ref: "#/definitions/relationship"
5106     delete:
5107       tags:
5108         - CloudInfrastructure
5109       summary: delete an existing relationship
5110       description: delete an existing relationship
5111       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5112       consumes:
5113         - application/json
5114         - application/xml
5115       produces:
5116         - application/json
5117         - application/xml
5118       responses:
5119         "default":
5120           description: Response codes found in [response codes](https://wiki.onap.org/).
5121       parameters:
5122         - name: cloud-owner
5123           in: path
5124           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5125           required: true
5126           type: string
5127           example: __CLOUD-OWNER__
5128         - name: cloud-region-id
5129           in: path
5130           description: Identifier used by the vendor for the region. Second part of composite key
5131           required: true
5132           type: string
5133           example: __CLOUD-REGION-ID__
5134         - name: snapshot-id
5135           in: path
5136           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5137           required: true
5138           type: string
5139           example: __SNAPSHOT-ID__
5140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5141     get:
5142       tags:
5143         - CloudInfrastructure
5144       summary: returns snapshot
5145       description: returns snapshot
5146       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5147       produces:
5148         - application/json
5149         - application/xml
5150       responses:
5151         "200":
5152           description: successful operation
5153           schema:
5154               $ref: "#/getDefinitions/snapshot"
5155         "default":
5156           description: Response codes found in [response codes](https://wiki.onap.org/).
5157       parameters:
5158         - name: cloud-owner
5159           in: path
5160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5161           required: true
5162           type: string
5163           example: __CLOUD-OWNER__
5164         - name: cloud-region-id
5165           in: path
5166           description: Identifier used by the vendor for the region. Second part of composite key
5167           required: true
5168           type: string
5169           example: __CLOUD-REGION-ID__
5170         - name: snapshot-id
5171           in: path
5172           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5173           required: true
5174           type: string
5175           example: __SNAPSHOT-ID__
5176     put:
5177       tags:
5178         - CloudInfrastructure
5179       summary: create or update an existing snapshot
5180       description: |
5181         Create or update an existing snapshot.
5182         #
5183         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5184       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5185       consumes:
5186         - application/json
5187         - application/xml
5188       produces:
5189         - application/json
5190         - application/xml
5191       responses:
5192         "default":
5193           description: Response codes found in [response codes](https://wiki.onap.org/).
5194       parameters:
5195         - name: cloud-owner
5196           in: path
5197           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5198           required: true
5199           type: string
5200           example: __CLOUD-OWNER__
5201         - name: cloud-region-id
5202           in: path
5203           description: Identifier used by the vendor for the region. Second part of composite key
5204           required: true
5205           type: string
5206           example: __CLOUD-REGION-ID__
5207         - name: snapshot-id
5208           in: path
5209           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5210           required: true
5211           type: string
5212           example: __SNAPSHOT-ID__
5213         - name: body
5214           in: body
5215           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5216           required: true
5217           schema:
5218             $ref: "#/definitions/snapshot"
5219     patch:
5220       tags:
5221         - CloudInfrastructure
5222       summary: update an existing snapshot
5223       description: |
5224         Update an existing snapshot
5225         #
5226         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5227         The PUT operation will entirely replace an existing object.
5228         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5229         #
5230         Other differences between PUT and PATCH are:
5231         #
5232         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5233         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5234         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5235       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5236       consumes:
5237         - application/json
5238         - application/xml
5239       produces:
5240         - application/json
5241         - application/xml
5242       responses:
5243         "default":
5244           description: Response codes found in [response codes](https://wiki.onap.org/).
5245       parameters:
5246         - name: cloud-owner
5247           in: path
5248           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5249           required: true
5250           type: string
5251           example: __CLOUD-OWNER__
5252         - name: cloud-region-id
5253           in: path
5254           description: Identifier used by the vendor for the region. Second part of composite key
5255           required: true
5256           type: string
5257           example: __CLOUD-REGION-ID__
5258         - name: snapshot-id
5259           in: path
5260           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5261           required: true
5262           type: string
5263           example: __SNAPSHOT-ID__
5264         - name: body
5265           in: body
5266           description: snapshot object that needs to be updated.
5267           required: true
5268           schema:
5269             $ref: "#/patchDefinitions/snapshot"
5270     delete:
5271       tags:
5272         - CloudInfrastructure
5273       summary: delete an existing snapshot
5274       description: delete an existing snapshot
5275       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5276       consumes:
5277         - application/json
5278         - application/xml
5279       produces:
5280         - application/json
5281         - application/xml
5282       responses:
5283         "default":
5284           description: Response codes found in [response codes](https://wiki.onap.org/).
5285       parameters:
5286         - name: cloud-owner
5287           in: path
5288           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5289           required: true
5290           type: string
5291           example: __CLOUD-OWNER__
5292         - name: cloud-region-id
5293           in: path
5294           description: Identifier used by the vendor for the region. Second part of composite key
5295           required: true
5296           type: string
5297           example: __CLOUD-REGION-ID__
5298         - name: snapshot-id
5299           in: path
5300           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5301           required: true
5302           type: string
5303           example: __SNAPSHOT-ID__
5304         - name: resource-version
5305           in: query
5306           description: resource-version for concurrency
5307           required: true
5308           type: string
5309   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5310     get:
5311       tags:
5312         - CloudInfrastructure
5313       summary: returns snapshots
5314       description: returns snapshots
5315       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5316       produces:
5317         - application/json
5318         - application/xml
5319       responses:
5320         "200":
5321           description: successful operation
5322           schema:
5323               $ref: "#/getDefinitions/snapshots"
5324         "default":
5325           description: Response codes found in [response codes](https://wiki.onap.org/).
5326       parameters:
5327         - name: cloud-owner
5328           in: path
5329           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5330           required: true
5331           type: string
5332           example: __CLOUD-OWNER__
5333         - name: cloud-region-id
5334           in: path
5335           description: Identifier used by the vendor for the region. Second part of composite key
5336           required: true
5337           type: string
5338           example: __CLOUD-REGION-ID__
5339         - name: snapshot-id
5340           in: query
5341           description:
5342           required: false
5343           type: string
5344         - name: snapshot-name
5345           in: query
5346           description:
5347           required: false
5348           type: string
5349         - name: application
5350           in: query
5351           description:
5352           required: false
5353           type: string
5354         - name: application-vendor
5355           in: query
5356           description:
5357           required: false
5358           type: string
5359         - name: application-version
5360           in: query
5361           description:
5362           required: false
5363           type: string
5364         - name: prev-snapshot-id
5365           in: query
5366           description:
5367           required: false
5368           type: string
5369   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5370     put:
5371       tags:
5372         - CloudInfrastructure
5373       summary: see node definition for valid relationships
5374       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5375       consumes:
5376         - application/json
5377         - application/xml
5378       produces:
5379         - application/json
5380         - application/xml
5381       responses:
5382         "default":
5383           description: Response codes found in [response codes](https://wiki.onap.org/).
5384       parameters:
5385         - name: cloud-owner
5386           in: path
5387           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5388           required: true
5389           type: string
5390           example: __CLOUD-OWNER__
5391         - name: cloud-region-id
5392           in: path
5393           description: Identifier used by the vendor for the region. Second part of composite key
5394           required: true
5395           type: string
5396           example: __CLOUD-REGION-ID__
5397         - name: image-id
5398           in: path
5399           description: Image id, expected to be unique across cloud region
5400           required: true
5401           type: string
5402           example: __IMAGE-ID__
5403         - name: body
5404           in: body
5405           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5406           required: true
5407           schema:
5408             $ref: "#/definitions/relationship"
5409     delete:
5410       tags:
5411         - CloudInfrastructure
5412       summary: delete an existing relationship
5413       description: delete an existing relationship
5414       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5415       consumes:
5416         - application/json
5417         - application/xml
5418       produces:
5419         - application/json
5420         - application/xml
5421       responses:
5422         "default":
5423           description: Response codes found in [response codes](https://wiki.onap.org/).
5424       parameters:
5425         - name: cloud-owner
5426           in: path
5427           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5428           required: true
5429           type: string
5430           example: __CLOUD-OWNER__
5431         - name: cloud-region-id
5432           in: path
5433           description: Identifier used by the vendor for the region. Second part of composite key
5434           required: true
5435           type: string
5436           example: __CLOUD-REGION-ID__
5437         - name: image-id
5438           in: path
5439           description: Image id, expected to be unique across cloud region
5440           required: true
5441           type: string
5442           example: __IMAGE-ID__
5443   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5444     get:
5445       tags:
5446         - CloudInfrastructure
5447       summary: returns metadatum
5448       description: returns metadatum
5449       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5450       produces:
5451         - application/json
5452         - application/xml
5453       responses:
5454         "200":
5455           description: successful operation
5456           schema:
5457               $ref: "#/getDefinitions/metadatum"
5458         "default":
5459           description: Response codes found in [response codes](https://wiki.onap.org/).
5460       parameters:
5461         - name: cloud-owner
5462           in: path
5463           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5464           required: true
5465           type: string
5466           example: __CLOUD-OWNER__
5467         - name: cloud-region-id
5468           in: path
5469           description: Identifier used by the vendor for the region. Second part of composite key
5470           required: true
5471           type: string
5472           example: __CLOUD-REGION-ID__
5473         - name: image-id
5474           in: path
5475           description: Image id, expected to be unique across cloud region
5476           required: true
5477           type: string
5478           example: __IMAGE-ID__
5479         - name: metaname
5480           in: path
5481           required: true
5482           type: string
5483           example: __METANAME__
5484     put:
5485       tags:
5486         - CloudInfrastructure
5487       summary: create or update an existing metadatum
5488       description: |
5489         Create or update an existing metadatum.
5490         #
5491         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5492       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5493       consumes:
5494         - application/json
5495         - application/xml
5496       produces:
5497         - application/json
5498         - application/xml
5499       responses:
5500         "default":
5501           description: Response codes found in [response codes](https://wiki.onap.org/).
5502       parameters:
5503         - name: cloud-owner
5504           in: path
5505           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5506           required: true
5507           type: string
5508           example: __CLOUD-OWNER__
5509         - name: cloud-region-id
5510           in: path
5511           description: Identifier used by the vendor for the region. Second part of composite key
5512           required: true
5513           type: string
5514           example: __CLOUD-REGION-ID__
5515         - name: image-id
5516           in: path
5517           description: Image id, expected to be unique across cloud region
5518           required: true
5519           type: string
5520           example: __IMAGE-ID__
5521         - name: metaname
5522           in: path
5523           required: true
5524           type: string
5525           example: __METANAME__
5526         - name: body
5527           in: body
5528           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5529           required: true
5530           schema:
5531             $ref: "#/definitions/metadatum"
5532     patch:
5533       tags:
5534         - CloudInfrastructure
5535       summary: update an existing metadatum
5536       description: |
5537         Update an existing metadatum
5538         #
5539         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5540         The PUT operation will entirely replace an existing object.
5541         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5542         #
5543         Other differences between PUT and PATCH are:
5544         #
5545         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5546         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5547         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5548       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5549       consumes:
5550         - application/json
5551         - application/xml
5552       produces:
5553         - application/json
5554         - application/xml
5555       responses:
5556         "default":
5557           description: Response codes found in [response codes](https://wiki.onap.org/).
5558       parameters:
5559         - name: cloud-owner
5560           in: path
5561           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5562           required: true
5563           type: string
5564           example: __CLOUD-OWNER__
5565         - name: cloud-region-id
5566           in: path
5567           description: Identifier used by the vendor for the region. Second part of composite key
5568           required: true
5569           type: string
5570           example: __CLOUD-REGION-ID__
5571         - name: image-id
5572           in: path
5573           description: Image id, expected to be unique across cloud region
5574           required: true
5575           type: string
5576           example: __IMAGE-ID__
5577         - name: metaname
5578           in: path
5579           required: true
5580           type: string
5581           example: __METANAME__
5582         - name: body
5583           in: body
5584           description: metadatum object that needs to be updated.
5585           required: true
5586           schema:
5587             $ref: "#/patchDefinitions/metadatum"
5588     delete:
5589       tags:
5590         - CloudInfrastructure
5591       summary: delete an existing metadatum
5592       description: delete an existing metadatum
5593       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5594       consumes:
5595         - application/json
5596         - application/xml
5597       produces:
5598         - application/json
5599         - application/xml
5600       responses:
5601         "default":
5602           description: Response codes found in [response codes](https://wiki.onap.org/).
5603       parameters:
5604         - name: cloud-owner
5605           in: path
5606           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5607           required: true
5608           type: string
5609           example: __CLOUD-OWNER__
5610         - name: cloud-region-id
5611           in: path
5612           description: Identifier used by the vendor for the region. Second part of composite key
5613           required: true
5614           type: string
5615           example: __CLOUD-REGION-ID__
5616         - name: image-id
5617           in: path
5618           description: Image id, expected to be unique across cloud region
5619           required: true
5620           type: string
5621           example: __IMAGE-ID__
5622         - name: metaname
5623           in: path
5624           required: true
5625           type: string
5626           example: __METANAME__
5627         - name: resource-version
5628           in: query
5629           description: resource-version for concurrency
5630           required: true
5631           type: string
5632   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5633     get:
5634       tags:
5635         - CloudInfrastructure
5636       summary: returns metadata
5637       description: returns metadata
5638       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5639       produces:
5640         - application/json
5641         - application/xml
5642       responses:
5643         "200":
5644           description: successful operation
5645           schema:
5646               $ref: "#/getDefinitions/metadata"
5647         "default":
5648           description: Response codes found in [response codes](https://wiki.onap.org/).
5649       parameters:
5650         - name: cloud-owner
5651           in: path
5652           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5653           required: true
5654           type: string
5655           example: __CLOUD-OWNER__
5656         - name: cloud-region-id
5657           in: path
5658           description: Identifier used by the vendor for the region. Second part of composite key
5659           required: true
5660           type: string
5661           example: __CLOUD-REGION-ID__
5662         - name: image-id
5663           in: path
5664           description: Image id, expected to be unique across cloud region
5665           required: true
5666           type: string
5667           example: __IMAGE-ID__
5668         - name: metaname
5669           in: query
5670           description:
5671           required: false
5672           type: string
5673   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5674     get:
5675       tags:
5676         - CloudInfrastructure
5677       summary: returns image
5678       description: returns image
5679       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5680       produces:
5681         - application/json
5682         - application/xml
5683       responses:
5684         "200":
5685           description: successful operation
5686           schema:
5687               $ref: "#/getDefinitions/image"
5688         "default":
5689           description: Response codes found in [response codes](https://wiki.onap.org/).
5690       parameters:
5691         - name: cloud-owner
5692           in: path
5693           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5694           required: true
5695           type: string
5696           example: __CLOUD-OWNER__
5697         - name: cloud-region-id
5698           in: path
5699           description: Identifier used by the vendor for the region. Second part of composite key
5700           required: true
5701           type: string
5702           example: __CLOUD-REGION-ID__
5703         - name: image-id
5704           in: path
5705           description: Image id, expected to be unique across cloud region
5706           required: true
5707           type: string
5708           example: __IMAGE-ID__
5709     put:
5710       tags:
5711         - CloudInfrastructure
5712       summary: create or update an existing image
5713       description: |
5714         Create or update an existing image.
5715         #
5716         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5717       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5718       consumes:
5719         - application/json
5720         - application/xml
5721       produces:
5722         - application/json
5723         - application/xml
5724       responses:
5725         "default":
5726           description: Response codes found in [response codes](https://wiki.onap.org/).
5727       parameters:
5728         - name: cloud-owner
5729           in: path
5730           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5731           required: true
5732           type: string
5733           example: __CLOUD-OWNER__
5734         - name: cloud-region-id
5735           in: path
5736           description: Identifier used by the vendor for the region. Second part of composite key
5737           required: true
5738           type: string
5739           example: __CLOUD-REGION-ID__
5740         - name: image-id
5741           in: path
5742           description: Image id, expected to be unique across cloud region
5743           required: true
5744           type: string
5745           example: __IMAGE-ID__
5746         - name: body
5747           in: body
5748           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5749           required: true
5750           schema:
5751             $ref: "#/definitions/image"
5752     patch:
5753       tags:
5754         - CloudInfrastructure
5755       summary: update an existing image
5756       description: |
5757         Update an existing image
5758         #
5759         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5760         The PUT operation will entirely replace an existing object.
5761         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5762         #
5763         Other differences between PUT and PATCH are:
5764         #
5765         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5766         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5767         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5768       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5769       consumes:
5770         - application/json
5771         - application/xml
5772       produces:
5773         - application/json
5774         - application/xml
5775       responses:
5776         "default":
5777           description: Response codes found in [response codes](https://wiki.onap.org/).
5778       parameters:
5779         - name: cloud-owner
5780           in: path
5781           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5782           required: true
5783           type: string
5784           example: __CLOUD-OWNER__
5785         - name: cloud-region-id
5786           in: path
5787           description: Identifier used by the vendor for the region. Second part of composite key
5788           required: true
5789           type: string
5790           example: __CLOUD-REGION-ID__
5791         - name: image-id
5792           in: path
5793           description: Image id, expected to be unique across cloud region
5794           required: true
5795           type: string
5796           example: __IMAGE-ID__
5797         - name: body
5798           in: body
5799           description: image object that needs to be updated.
5800           required: true
5801           schema:
5802             $ref: "#/patchDefinitions/image"
5803     delete:
5804       tags:
5805         - CloudInfrastructure
5806       summary: delete an existing image
5807       description: delete an existing image
5808       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5809       consumes:
5810         - application/json
5811         - application/xml
5812       produces:
5813         - application/json
5814         - application/xml
5815       responses:
5816         "default":
5817           description: Response codes found in [response codes](https://wiki.onap.org/).
5818       parameters:
5819         - name: cloud-owner
5820           in: path
5821           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5822           required: true
5823           type: string
5824           example: __CLOUD-OWNER__
5825         - name: cloud-region-id
5826           in: path
5827           description: Identifier used by the vendor for the region. Second part of composite key
5828           required: true
5829           type: string
5830           example: __CLOUD-REGION-ID__
5831         - name: image-id
5832           in: path
5833           description: Image id, expected to be unique across cloud region
5834           required: true
5835           type: string
5836           example: __IMAGE-ID__
5837         - name: resource-version
5838           in: query
5839           description: resource-version for concurrency
5840           required: true
5841           type: string
5842   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5843     get:
5844       tags:
5845         - CloudInfrastructure
5846       summary: returns images
5847       description: returns images
5848       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5849       produces:
5850         - application/json
5851         - application/xml
5852       responses:
5853         "200":
5854           description: successful operation
5855           schema:
5856               $ref: "#/getDefinitions/images"
5857         "default":
5858           description: Response codes found in [response codes](https://wiki.onap.org/).
5859       parameters:
5860         - name: cloud-owner
5861           in: path
5862           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5863           required: true
5864           type: string
5865           example: __CLOUD-OWNER__
5866         - name: cloud-region-id
5867           in: path
5868           description: Identifier used by the vendor for the region. Second part of composite key
5869           required: true
5870           type: string
5871           example: __CLOUD-REGION-ID__
5872         - name: image-id
5873           in: query
5874           description:
5875           required: false
5876           type: string
5877         - name: image-name
5878           in: query
5879           description:
5880           required: false
5881           type: string
5882         - name: application
5883           in: query
5884           description:
5885           required: false
5886           type: string
5887         - name: application-vendor
5888           in: query
5889           description:
5890           required: false
5891           type: string
5892         - name: application-version
5893           in: query
5894           description:
5895           required: false
5896           type: string
5897   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5898     put:
5899       tags:
5900         - CloudInfrastructure
5901       summary: see node definition for valid relationships
5902       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5903       consumes:
5904         - application/json
5905         - application/xml
5906       produces:
5907         - application/json
5908         - application/xml
5909       responses:
5910         "default":
5911           description: Response codes found in [response codes](https://wiki.onap.org/).
5912       parameters:
5913         - name: cloud-owner
5914           in: path
5915           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5916           required: true
5917           type: string
5918           example: __CLOUD-OWNER__
5919         - name: cloud-region-id
5920           in: path
5921           description: Identifier used by the vendor for the region. Second part of composite key
5922           required: true
5923           type: string
5924           example: __CLOUD-REGION-ID__
5925         - name: switch-name
5926           in: path
5927           description: DVS switch name
5928           required: true
5929           type: string
5930           example: __SWITCH-NAME__
5931         - name: body
5932           in: body
5933           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5934           required: true
5935           schema:
5936             $ref: "#/definitions/relationship"
5937     delete:
5938       tags:
5939         - CloudInfrastructure
5940       summary: delete an existing relationship
5941       description: delete an existing relationship
5942       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5943       consumes:
5944         - application/json
5945         - application/xml
5946       produces:
5947         - application/json
5948         - application/xml
5949       responses:
5950         "default":
5951           description: Response codes found in [response codes](https://wiki.onap.org/).
5952       parameters:
5953         - name: cloud-owner
5954           in: path
5955           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5956           required: true
5957           type: string
5958           example: __CLOUD-OWNER__
5959         - name: cloud-region-id
5960           in: path
5961           description: Identifier used by the vendor for the region. Second part of composite key
5962           required: true
5963           type: string
5964           example: __CLOUD-REGION-ID__
5965         - name: switch-name
5966           in: path
5967           description: DVS switch name
5968           required: true
5969           type: string
5970           example: __SWITCH-NAME__
5971   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5972     get:
5973       tags:
5974         - CloudInfrastructure
5975       summary: returns dvs-switch
5976       description: returns dvs-switch
5977       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5978       produces:
5979         - application/json
5980         - application/xml
5981       responses:
5982         "200":
5983           description: successful operation
5984           schema:
5985               $ref: "#/getDefinitions/dvs-switch"
5986         "default":
5987           description: Response codes found in [response codes](https://wiki.onap.org/).
5988       parameters:
5989         - name: cloud-owner
5990           in: path
5991           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5992           required: true
5993           type: string
5994           example: __CLOUD-OWNER__
5995         - name: cloud-region-id
5996           in: path
5997           description: Identifier used by the vendor for the region. Second part of composite key
5998           required: true
5999           type: string
6000           example: __CLOUD-REGION-ID__
6001         - name: switch-name
6002           in: path
6003           description: DVS switch name
6004           required: true
6005           type: string
6006           example: __SWITCH-NAME__
6007     put:
6008       tags:
6009         - CloudInfrastructure
6010       summary: create or update an existing dvs-switch
6011       description: |
6012         Create or update an existing dvs-switch.
6013         #
6014         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6015       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6016       consumes:
6017         - application/json
6018         - application/xml
6019       produces:
6020         - application/json
6021         - application/xml
6022       responses:
6023         "default":
6024           description: Response codes found in [response codes](https://wiki.onap.org/).
6025       parameters:
6026         - name: cloud-owner
6027           in: path
6028           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6029           required: true
6030           type: string
6031           example: __CLOUD-OWNER__
6032         - name: cloud-region-id
6033           in: path
6034           description: Identifier used by the vendor for the region. Second part of composite key
6035           required: true
6036           type: string
6037           example: __CLOUD-REGION-ID__
6038         - name: switch-name
6039           in: path
6040           description: DVS switch name
6041           required: true
6042           type: string
6043           example: __SWITCH-NAME__
6044         - name: body
6045           in: body
6046           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6047           required: true
6048           schema:
6049             $ref: "#/definitions/dvs-switch"
6050     patch:
6051       tags:
6052         - CloudInfrastructure
6053       summary: update an existing dvs-switch
6054       description: |
6055         Update an existing dvs-switch
6056         #
6057         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6058         The PUT operation will entirely replace an existing object.
6059         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6060         #
6061         Other differences between PUT and PATCH are:
6062         #
6063         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6064         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6065         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6066       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6067       consumes:
6068         - application/json
6069         - application/xml
6070       produces:
6071         - application/json
6072         - application/xml
6073       responses:
6074         "default":
6075           description: Response codes found in [response codes](https://wiki.onap.org/).
6076       parameters:
6077         - name: cloud-owner
6078           in: path
6079           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6080           required: true
6081           type: string
6082           example: __CLOUD-OWNER__
6083         - name: cloud-region-id
6084           in: path
6085           description: Identifier used by the vendor for the region. Second part of composite key
6086           required: true
6087           type: string
6088           example: __CLOUD-REGION-ID__
6089         - name: switch-name
6090           in: path
6091           description: DVS switch name
6092           required: true
6093           type: string
6094           example: __SWITCH-NAME__
6095         - name: body
6096           in: body
6097           description: dvs-switch object that needs to be updated.
6098           required: true
6099           schema:
6100             $ref: "#/patchDefinitions/dvs-switch"
6101     delete:
6102       tags:
6103         - CloudInfrastructure
6104       summary: delete an existing dvs-switch
6105       description: delete an existing dvs-switch
6106       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6107       consumes:
6108         - application/json
6109         - application/xml
6110       produces:
6111         - application/json
6112         - application/xml
6113       responses:
6114         "default":
6115           description: Response codes found in [response codes](https://wiki.onap.org/).
6116       parameters:
6117         - name: cloud-owner
6118           in: path
6119           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6120           required: true
6121           type: string
6122           example: __CLOUD-OWNER__
6123         - name: cloud-region-id
6124           in: path
6125           description: Identifier used by the vendor for the region. Second part of composite key
6126           required: true
6127           type: string
6128           example: __CLOUD-REGION-ID__
6129         - name: switch-name
6130           in: path
6131           description: DVS switch name
6132           required: true
6133           type: string
6134           example: __SWITCH-NAME__
6135         - name: resource-version
6136           in: query
6137           description: resource-version for concurrency
6138           required: true
6139           type: string
6140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6141     get:
6142       tags:
6143         - CloudInfrastructure
6144       summary: returns dvs-switches
6145       description: returns dvs-switches
6146       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6147       produces:
6148         - application/json
6149         - application/xml
6150       responses:
6151         "200":
6152           description: successful operation
6153           schema:
6154               $ref: "#/getDefinitions/dvs-switches"
6155         "default":
6156           description: Response codes found in [response codes](https://wiki.onap.org/).
6157       parameters:
6158         - name: cloud-owner
6159           in: path
6160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6161           required: true
6162           type: string
6163           example: __CLOUD-OWNER__
6164         - name: cloud-region-id
6165           in: path
6166           description: Identifier used by the vendor for the region. Second part of composite key
6167           required: true
6168           type: string
6169           example: __CLOUD-REGION-ID__
6170         - name: switch-name
6171           in: query
6172           description:
6173           required: false
6174           type: string
6175         - name: vcenter-url
6176           in: query
6177           description:
6178           required: false
6179           type: string
6180   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6181     put:
6182       tags:
6183         - CloudInfrastructure
6184       summary: see node definition for valid relationships
6185       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6186       consumes:
6187         - application/json
6188         - application/xml
6189       produces:
6190         - application/json
6191         - application/xml
6192       responses:
6193         "default":
6194           description: Response codes found in [response codes](https://wiki.onap.org/).
6195       parameters:
6196         - name: cloud-owner
6197           in: path
6198           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6199           required: true
6200           type: string
6201           example: __CLOUD-OWNER__
6202         - name: cloud-region-id
6203           in: path
6204           description: Identifier used by the vendor for the region. Second part of composite key
6205           required: true
6206           type: string
6207           example: __CLOUD-REGION-ID__
6208         - name: network-uuid
6209           in: path
6210           description: UUID of the network. Unique across a cloud-region
6211           required: true
6212           type: string
6213           example: __NETWORK-UUID__
6214         - name: body
6215           in: body
6216           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6217           required: true
6218           schema:
6219             $ref: "#/definitions/relationship"
6220     delete:
6221       tags:
6222         - CloudInfrastructure
6223       summary: delete an existing relationship
6224       description: delete an existing relationship
6225       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6226       consumes:
6227         - application/json
6228         - application/xml
6229       produces:
6230         - application/json
6231         - application/xml
6232       responses:
6233         "default":
6234           description: Response codes found in [response codes](https://wiki.onap.org/).
6235       parameters:
6236         - name: cloud-owner
6237           in: path
6238           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6239           required: true
6240           type: string
6241           example: __CLOUD-OWNER__
6242         - name: cloud-region-id
6243           in: path
6244           description: Identifier used by the vendor for the region. Second part of composite key
6245           required: true
6246           type: string
6247           example: __CLOUD-REGION-ID__
6248         - name: network-uuid
6249           in: path
6250           description: UUID of the network. Unique across a cloud-region
6251           required: true
6252           type: string
6253           example: __NETWORK-UUID__
6254   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6255     get:
6256       tags:
6257         - CloudInfrastructure
6258       summary: returns oam-network
6259       description: returns oam-network
6260       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6261       produces:
6262         - application/json
6263         - application/xml
6264       responses:
6265         "200":
6266           description: successful operation
6267           schema:
6268               $ref: "#/getDefinitions/oam-network"
6269         "default":
6270           description: Response codes found in [response codes](https://wiki.onap.org/).
6271       parameters:
6272         - name: cloud-owner
6273           in: path
6274           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6275           required: true
6276           type: string
6277           example: __CLOUD-OWNER__
6278         - name: cloud-region-id
6279           in: path
6280           description: Identifier used by the vendor for the region. Second part of composite key
6281           required: true
6282           type: string
6283           example: __CLOUD-REGION-ID__
6284         - name: network-uuid
6285           in: path
6286           description: UUID of the network. Unique across a cloud-region
6287           required: true
6288           type: string
6289           example: __NETWORK-UUID__
6290     put:
6291       tags:
6292         - CloudInfrastructure
6293       summary: create or update an existing oam-network
6294       description: |
6295         Create or update an existing oam-network.
6296         #
6297         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6298       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6299       consumes:
6300         - application/json
6301         - application/xml
6302       produces:
6303         - application/json
6304         - application/xml
6305       responses:
6306         "default":
6307           description: Response codes found in [response codes](https://wiki.onap.org/).
6308       parameters:
6309         - name: cloud-owner
6310           in: path
6311           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6312           required: true
6313           type: string
6314           example: __CLOUD-OWNER__
6315         - name: cloud-region-id
6316           in: path
6317           description: Identifier used by the vendor for the region. Second part of composite key
6318           required: true
6319           type: string
6320           example: __CLOUD-REGION-ID__
6321         - name: network-uuid
6322           in: path
6323           description: UUID of the network. Unique across a cloud-region
6324           required: true
6325           type: string
6326           example: __NETWORK-UUID__
6327         - name: body
6328           in: body
6329           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6330           required: true
6331           schema:
6332             $ref: "#/definitions/oam-network"
6333     patch:
6334       tags:
6335         - CloudInfrastructure
6336       summary: update an existing oam-network
6337       description: |
6338         Update an existing oam-network
6339         #
6340         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6341         The PUT operation will entirely replace an existing object.
6342         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6343         #
6344         Other differences between PUT and PATCH are:
6345         #
6346         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6347         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6348         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6349       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6350       consumes:
6351         - application/json
6352         - application/xml
6353       produces:
6354         - application/json
6355         - application/xml
6356       responses:
6357         "default":
6358           description: Response codes found in [response codes](https://wiki.onap.org/).
6359       parameters:
6360         - name: cloud-owner
6361           in: path
6362           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6363           required: true
6364           type: string
6365           example: __CLOUD-OWNER__
6366         - name: cloud-region-id
6367           in: path
6368           description: Identifier used by the vendor for the region. Second part of composite key
6369           required: true
6370           type: string
6371           example: __CLOUD-REGION-ID__
6372         - name: network-uuid
6373           in: path
6374           description: UUID of the network. Unique across a cloud-region
6375           required: true
6376           type: string
6377           example: __NETWORK-UUID__
6378         - name: body
6379           in: body
6380           description: oam-network object that needs to be updated.
6381           required: true
6382           schema:
6383             $ref: "#/patchDefinitions/oam-network"
6384     delete:
6385       tags:
6386         - CloudInfrastructure
6387       summary: delete an existing oam-network
6388       description: delete an existing oam-network
6389       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6390       consumes:
6391         - application/json
6392         - application/xml
6393       produces:
6394         - application/json
6395         - application/xml
6396       responses:
6397         "default":
6398           description: Response codes found in [response codes](https://wiki.onap.org/).
6399       parameters:
6400         - name: cloud-owner
6401           in: path
6402           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6403           required: true
6404           type: string
6405           example: __CLOUD-OWNER__
6406         - name: cloud-region-id
6407           in: path
6408           description: Identifier used by the vendor for the region. Second part of composite key
6409           required: true
6410           type: string
6411           example: __CLOUD-REGION-ID__
6412         - name: network-uuid
6413           in: path
6414           description: UUID of the network. Unique across a cloud-region
6415           required: true
6416           type: string
6417           example: __NETWORK-UUID__
6418         - name: resource-version
6419           in: query
6420           description: resource-version for concurrency
6421           required: true
6422           type: string
6423   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6424     get:
6425       tags:
6426         - CloudInfrastructure
6427       summary: returns oam-networks
6428       description: returns oam-networks
6429       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6430       produces:
6431         - application/json
6432         - application/xml
6433       responses:
6434         "200":
6435           description: successful operation
6436           schema:
6437               $ref: "#/getDefinitions/oam-networks"
6438         "default":
6439           description: Response codes found in [response codes](https://wiki.onap.org/).
6440       parameters:
6441         - name: cloud-owner
6442           in: path
6443           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6444           required: true
6445           type: string
6446           example: __CLOUD-OWNER__
6447         - name: cloud-region-id
6448           in: path
6449           description: Identifier used by the vendor for the region. Second part of composite key
6450           required: true
6451           type: string
6452           example: __CLOUD-REGION-ID__
6453         - name: network-uuid
6454           in: query
6455           description:
6456           required: false
6457           type: string
6458         - name: network-name
6459           in: query
6460           description:
6461           required: false
6462           type: string
6463         - name: cvlan-tag
6464           in: query
6465           description:
6466           required: false
6467           type: integer
6468           format: int64
6469   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6470     put:
6471       tags:
6472         - CloudInfrastructure
6473       summary: see node definition for valid relationships
6474       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6475       consumes:
6476         - application/json
6477         - application/xml
6478       produces:
6479         - application/json
6480         - application/xml
6481       responses:
6482         "default":
6483           description: Response codes found in [response codes](https://wiki.onap.org/).
6484       parameters:
6485         - name: cloud-owner
6486           in: path
6487           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6488           required: true
6489           type: string
6490           example: __CLOUD-OWNER__
6491         - name: cloud-region-id
6492           in: path
6493           description: Identifier used by the vendor for the region. Second part of composite key
6494           required: true
6495           type: string
6496           example: __CLOUD-REGION-ID__
6497         - name: availability-zone-name
6498           in: path
6499           description: Name of the availability zone.  Unique across a cloud region
6500           required: true
6501           type: string
6502           example: __AVAILABILITY-ZONE-NAME__
6503         - name: body
6504           in: body
6505           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6506           required: true
6507           schema:
6508             $ref: "#/definitions/relationship"
6509     delete:
6510       tags:
6511         - CloudInfrastructure
6512       summary: delete an existing relationship
6513       description: delete an existing relationship
6514       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6515       consumes:
6516         - application/json
6517         - application/xml
6518       produces:
6519         - application/json
6520         - application/xml
6521       responses:
6522         "default":
6523           description: Response codes found in [response codes](https://wiki.onap.org/).
6524       parameters:
6525         - name: cloud-owner
6526           in: path
6527           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6528           required: true
6529           type: string
6530           example: __CLOUD-OWNER__
6531         - name: cloud-region-id
6532           in: path
6533           description: Identifier used by the vendor for the region. Second part of composite key
6534           required: true
6535           type: string
6536           example: __CLOUD-REGION-ID__
6537         - name: availability-zone-name
6538           in: path
6539           description: Name of the availability zone.  Unique across a cloud region
6540           required: true
6541           type: string
6542           example: __AVAILABILITY-ZONE-NAME__
6543   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6544     get:
6545       tags:
6546         - CloudInfrastructure
6547       summary: returns availability-zone
6548       description: returns availability-zone
6549       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6550       produces:
6551         - application/json
6552         - application/xml
6553       responses:
6554         "200":
6555           description: successful operation
6556           schema:
6557               $ref: "#/getDefinitions/availability-zone"
6558         "default":
6559           description: Response codes found in [response codes](https://wiki.onap.org/).
6560       parameters:
6561         - name: cloud-owner
6562           in: path
6563           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6564           required: true
6565           type: string
6566           example: __CLOUD-OWNER__
6567         - name: cloud-region-id
6568           in: path
6569           description: Identifier used by the vendor for the region. Second part of composite key
6570           required: true
6571           type: string
6572           example: __CLOUD-REGION-ID__
6573         - name: availability-zone-name
6574           in: path
6575           description: Name of the availability zone.  Unique across a cloud region
6576           required: true
6577           type: string
6578           example: __AVAILABILITY-ZONE-NAME__
6579     put:
6580       tags:
6581         - CloudInfrastructure
6582       summary: create or update an existing availability-zone
6583       description: |
6584         Create or update an existing availability-zone.
6585         #
6586         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6587       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6588       consumes:
6589         - application/json
6590         - application/xml
6591       produces:
6592         - application/json
6593         - application/xml
6594       responses:
6595         "default":
6596           description: Response codes found in [response codes](https://wiki.onap.org/).
6597       parameters:
6598         - name: cloud-owner
6599           in: path
6600           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6601           required: true
6602           type: string
6603           example: __CLOUD-OWNER__
6604         - name: cloud-region-id
6605           in: path
6606           description: Identifier used by the vendor for the region. Second part of composite key
6607           required: true
6608           type: string
6609           example: __CLOUD-REGION-ID__
6610         - name: availability-zone-name
6611           in: path
6612           description: Name of the availability zone.  Unique across a cloud region
6613           required: true
6614           type: string
6615           example: __AVAILABILITY-ZONE-NAME__
6616         - name: body
6617           in: body
6618           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6619           required: true
6620           schema:
6621             $ref: "#/definitions/availability-zone"
6622     patch:
6623       tags:
6624         - CloudInfrastructure
6625       summary: update an existing availability-zone
6626       description: |
6627         Update an existing availability-zone
6628         #
6629         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6630         The PUT operation will entirely replace an existing object.
6631         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6632         #
6633         Other differences between PUT and PATCH are:
6634         #
6635         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6636         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6637         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6638       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6639       consumes:
6640         - application/json
6641         - application/xml
6642       produces:
6643         - application/json
6644         - application/xml
6645       responses:
6646         "default":
6647           description: Response codes found in [response codes](https://wiki.onap.org/).
6648       parameters:
6649         - name: cloud-owner
6650           in: path
6651           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6652           required: true
6653           type: string
6654           example: __CLOUD-OWNER__
6655         - name: cloud-region-id
6656           in: path
6657           description: Identifier used by the vendor for the region. Second part of composite key
6658           required: true
6659           type: string
6660           example: __CLOUD-REGION-ID__
6661         - name: availability-zone-name
6662           in: path
6663           description: Name of the availability zone.  Unique across a cloud region
6664           required: true
6665           type: string
6666           example: __AVAILABILITY-ZONE-NAME__
6667         - name: body
6668           in: body
6669           description: availability-zone object that needs to be updated.
6670           required: true
6671           schema:
6672             $ref: "#/patchDefinitions/availability-zone"
6673     delete:
6674       tags:
6675         - CloudInfrastructure
6676       summary: delete an existing availability-zone
6677       description: delete an existing availability-zone
6678       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6679       consumes:
6680         - application/json
6681         - application/xml
6682       produces:
6683         - application/json
6684         - application/xml
6685       responses:
6686         "default":
6687           description: Response codes found in [response codes](https://wiki.onap.org/).
6688       parameters:
6689         - name: cloud-owner
6690           in: path
6691           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6692           required: true
6693           type: string
6694           example: __CLOUD-OWNER__
6695         - name: cloud-region-id
6696           in: path
6697           description: Identifier used by the vendor for the region. Second part of composite key
6698           required: true
6699           type: string
6700           example: __CLOUD-REGION-ID__
6701         - name: availability-zone-name
6702           in: path
6703           description: Name of the availability zone.  Unique across a cloud region
6704           required: true
6705           type: string
6706           example: __AVAILABILITY-ZONE-NAME__
6707         - name: resource-version
6708           in: query
6709           description: resource-version for concurrency
6710           required: true
6711           type: string
6712   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6713     get:
6714       tags:
6715         - CloudInfrastructure
6716       summary: returns availability-zones
6717       description: returns availability-zones
6718       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6719       produces:
6720         - application/json
6721         - application/xml
6722       responses:
6723         "200":
6724           description: successful operation
6725           schema:
6726               $ref: "#/getDefinitions/availability-zones"
6727         "default":
6728           description: Response codes found in [response codes](https://wiki.onap.org/).
6729       parameters:
6730         - name: cloud-owner
6731           in: path
6732           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6733           required: true
6734           type: string
6735           example: __CLOUD-OWNER__
6736         - name: cloud-region-id
6737           in: path
6738           description: Identifier used by the vendor for the region. Second part of composite key
6739           required: true
6740           type: string
6741           example: __CLOUD-REGION-ID__
6742         - name: availability-zone-name
6743           in: query
6744           description:
6745           required: false
6746           type: string
6747   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6748     put:
6749       tags:
6750         - CloudInfrastructure
6751       summary: see node definition for valid relationships
6752       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6753       consumes:
6754         - application/json
6755         - application/xml
6756       produces:
6757         - application/json
6758         - application/xml
6759       responses:
6760         "default":
6761           description: Response codes found in [response codes](https://wiki.onap.org/).
6762       parameters:
6763         - name: cloud-owner
6764           in: path
6765           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6766           required: true
6767           type: string
6768           example: __CLOUD-OWNER__
6769         - name: cloud-region-id
6770           in: path
6771           description: Identifier used by the vendor for the region. Second part of composite key
6772           required: true
6773           type: string
6774           example: __CLOUD-REGION-ID__
6775         - name: body
6776           in: body
6777           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
6778           required: true
6779           schema:
6780             $ref: "#/definitions/relationship"
6781     delete:
6782       tags:
6783         - CloudInfrastructure
6784       summary: delete an existing relationship
6785       description: delete an existing relationship
6786       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6787       consumes:
6788         - application/json
6789         - application/xml
6790       produces:
6791         - application/json
6792         - application/xml
6793       responses:
6794         "default":
6795           description: Response codes found in [response codes](https://wiki.onap.org/).
6796       parameters:
6797         - name: cloud-owner
6798           in: path
6799           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6800           required: true
6801           type: string
6802           example: __CLOUD-OWNER__
6803         - name: cloud-region-id
6804           in: path
6805           description: Identifier used by the vendor for the region. Second part of composite key
6806           required: true
6807           type: string
6808           example: __CLOUD-REGION-ID__
6809   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
6810     put:
6811       tags:
6812         - CloudInfrastructure
6813       summary: see node definition for valid relationships
6814       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
6815       consumes:
6816         - application/json
6817         - application/xml
6818       produces:
6819         - application/json
6820         - application/xml
6821       responses:
6822         "default":
6823           description: Response codes found in [response codes](https://wiki.onap.org/).
6824       parameters:
6825         - name: cloud-owner
6826           in: path
6827           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6828           required: true
6829           type: string
6830           example: __CLOUD-OWNER__
6831         - name: cloud-region-id
6832           in: path
6833           description: Identifier used by the vendor for the region. Second part of composite key
6834           required: true
6835           type: string
6836           example: __CLOUD-REGION-ID__
6837         - name: esr-system-info-id
6838           in: path
6839           description: Unique ID of esr system info.
6840           required: true
6841           type: string
6842           example: __ESR-SYSTEM-INFO-ID__
6843         - name: body
6844           in: body
6845           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
6846           required: true
6847           schema:
6848             $ref: "#/definitions/relationship"
6849     delete:
6850       tags:
6851         - CloudInfrastructure
6852       summary: delete an existing relationship
6853       description: delete an existing relationship
6854       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
6855       consumes:
6856         - application/json
6857         - application/xml
6858       produces:
6859         - application/json
6860         - application/xml
6861       responses:
6862         "default":
6863           description: Response codes found in [response codes](https://wiki.onap.org/).
6864       parameters:
6865         - name: cloud-owner
6866           in: path
6867           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6868           required: true
6869           type: string
6870           example: __CLOUD-OWNER__
6871         - name: cloud-region-id
6872           in: path
6873           description: Identifier used by the vendor for the region. Second part of composite key
6874           required: true
6875           type: string
6876           example: __CLOUD-REGION-ID__
6877         - name: esr-system-info-id
6878           in: path
6879           description: Unique ID of esr system info.
6880           required: true
6881           type: string
6882           example: __ESR-SYSTEM-INFO-ID__
6883   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
6884     get:
6885       tags:
6886         - CloudInfrastructure
6887       summary: returns esr-system-info
6888       description: returns esr-system-info
6889       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6890       produces:
6891         - application/json
6892         - application/xml
6893       responses:
6894         "200":
6895           description: successful operation
6896           schema:
6897               $ref: "#/getDefinitions/esr-system-info"
6898         "default":
6899           description: Response codes found in [response codes](https://wiki.onap.org/).
6900       parameters:
6901         - name: cloud-owner
6902           in: path
6903           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6904           required: true
6905           type: string
6906           example: __CLOUD-OWNER__
6907         - name: cloud-region-id
6908           in: path
6909           description: Identifier used by the vendor for the region. Second part of composite key
6910           required: true
6911           type: string
6912           example: __CLOUD-REGION-ID__
6913         - name: esr-system-info-id
6914           in: path
6915           description: Unique ID of esr system info.
6916           required: true
6917           type: string
6918           example: __ESR-SYSTEM-INFO-ID__
6919     put:
6920       tags:
6921         - CloudInfrastructure
6922       summary: create or update an existing esr-system-info
6923       description: |
6924         Create or update an existing esr-system-info.
6925         #
6926         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6927       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6928       consumes:
6929         - application/json
6930         - application/xml
6931       produces:
6932         - application/json
6933         - application/xml
6934       responses:
6935         "default":
6936           description: Response codes found in [response codes](https://wiki.onap.org/).
6937       parameters:
6938         - name: cloud-owner
6939           in: path
6940           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6941           required: true
6942           type: string
6943           example: __CLOUD-OWNER__
6944         - name: cloud-region-id
6945           in: path
6946           description: Identifier used by the vendor for the region. Second part of composite key
6947           required: true
6948           type: string
6949           example: __CLOUD-REGION-ID__
6950         - name: esr-system-info-id
6951           in: path
6952           description: Unique ID of esr system info.
6953           required: true
6954           type: string
6955           example: __ESR-SYSTEM-INFO-ID__
6956         - name: body
6957           in: body
6958           description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
6959           required: true
6960           schema:
6961             $ref: "#/definitions/esr-system-info"
6962     patch:
6963       tags:
6964         - CloudInfrastructure
6965       summary: update an existing esr-system-info
6966       description: |
6967         Update an existing esr-system-info
6968         #
6969         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6970         The PUT operation will entirely replace an existing object.
6971         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6972         #
6973         Other differences between PUT and PATCH are:
6974         #
6975         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6976         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6977         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6978       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6979       consumes:
6980         - application/json
6981         - application/xml
6982       produces:
6983         - application/json
6984         - application/xml
6985       responses:
6986         "default":
6987           description: Response codes found in [response codes](https://wiki.onap.org/).
6988       parameters:
6989         - name: cloud-owner
6990           in: path
6991           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6992           required: true
6993           type: string
6994           example: __CLOUD-OWNER__
6995         - name: cloud-region-id
6996           in: path
6997           description: Identifier used by the vendor for the region. Second part of composite key
6998           required: true
6999           type: string
7000           example: __CLOUD-REGION-ID__
7001         - name: esr-system-info-id
7002           in: path
7003           description: Unique ID of esr system info.
7004           required: true
7005           type: string
7006           example: __ESR-SYSTEM-INFO-ID__
7007         - name: body
7008           in: body
7009           description: esr-system-info object that needs to be updated.
7010           required: true
7011           schema:
7012             $ref: "#/patchDefinitions/esr-system-info"
7013     delete:
7014       tags:
7015         - CloudInfrastructure
7016       summary: delete an existing esr-system-info
7017       description: delete an existing esr-system-info
7018       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7019       consumes:
7020         - application/json
7021         - application/xml
7022       produces:
7023         - application/json
7024         - application/xml
7025       responses:
7026         "default":
7027           description: Response codes found in [response codes](https://wiki.onap.org/).
7028       parameters:
7029         - name: cloud-owner
7030           in: path
7031           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7032           required: true
7033           type: string
7034           example: __CLOUD-OWNER__
7035         - name: cloud-region-id
7036           in: path
7037           description: Identifier used by the vendor for the region. Second part of composite key
7038           required: true
7039           type: string
7040           example: __CLOUD-REGION-ID__
7041         - name: esr-system-info-id
7042           in: path
7043           description: Unique ID of esr system info.
7044           required: true
7045           type: string
7046           example: __ESR-SYSTEM-INFO-ID__
7047         - name: resource-version
7048           in: query
7049           description: resource-version for concurrency
7050           required: true
7051           type: string
7052   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
7053     get:
7054       tags:
7055         - CloudInfrastructure
7056       summary: returns esr-system-info-list
7057       description: returns esr-system-info-list
7058       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
7059       produces:
7060         - application/json
7061         - application/xml
7062       responses:
7063         "200":
7064           description: successful operation
7065           schema:
7066               $ref: "#/getDefinitions/esr-system-info-list"
7067         "default":
7068           description: Response codes found in [response codes](https://wiki.onap.org/).
7069       parameters:
7070         - name: cloud-owner
7071           in: path
7072           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7073           required: true
7074           type: string
7075           example: __CLOUD-OWNER__
7076         - name: cloud-region-id
7077           in: path
7078           description: Identifier used by the vendor for the region. Second part of composite key
7079           required: true
7080           type: string
7081           example: __CLOUD-REGION-ID__
7082         - name: esr-system-info-id
7083           in: query
7084           description:
7085           required: false
7086           type: string
7087         - name: system-name
7088           in: query
7089           description:
7090           required: false
7091           type: string
7092         - name: system-type
7093           in: query
7094           description:
7095           required: false
7096           type: string
7097   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7098     put:
7099       tags:
7100         - CloudInfrastructure
7101       summary: see node definition for valid relationships
7102       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7103       consumes:
7104         - application/json
7105         - application/xml
7106       produces:
7107         - application/json
7108         - application/xml
7109       responses:
7110         "default":
7111           description: Response codes found in [response codes](https://wiki.onap.org/).
7112       parameters:
7113         - name: cloud-owner
7114           in: path
7115           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7116           required: true
7117           type: string
7118           example: __CLOUD-OWNER__
7119         - name: cloud-region-id
7120           in: path
7121           description: Identifier used by the vendor for the region. Second part of composite key
7122           required: true
7123           type: string
7124           example: __CLOUD-REGION-ID__
7125         - name: vip-ipv4-address
7126           in: path
7127           description: IP address
7128           required: true
7129           type: string
7130           example: __VIP-IPV4-ADDRESS__
7131         - name: body
7132           in: body
7133           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7134           required: true
7135           schema:
7136             $ref: "#/definitions/relationship"
7137     delete:
7138       tags:
7139         - CloudInfrastructure
7140       summary: delete an existing relationship
7141       description: delete an existing relationship
7142       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7143       consumes:
7144         - application/json
7145         - application/xml
7146       produces:
7147         - application/json
7148         - application/xml
7149       responses:
7150         "default":
7151           description: Response codes found in [response codes](https://wiki.onap.org/).
7152       parameters:
7153         - name: cloud-owner
7154           in: path
7155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7156           required: true
7157           type: string
7158           example: __CLOUD-OWNER__
7159         - name: cloud-region-id
7160           in: path
7161           description: Identifier used by the vendor for the region. Second part of composite key
7162           required: true
7163           type: string
7164           example: __CLOUD-REGION-ID__
7165         - name: vip-ipv4-address
7166           in: path
7167           description: IP address
7168           required: true
7169           type: string
7170           example: __VIP-IPV4-ADDRESS__
7171   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7172     get:
7173       tags:
7174         - CloudInfrastructure
7175       summary: returns vip-ipv4-address-list
7176       description: returns vip-ipv4-address-list
7177       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7178       produces:
7179         - application/json
7180         - application/xml
7181       responses:
7182         "200":
7183           description: successful operation
7184           schema:
7185               $ref: "#/getDefinitions/vip-ipv4-address-list"
7186         "default":
7187           description: Response codes found in [response codes](https://wiki.onap.org/).
7188       parameters:
7189         - name: cloud-owner
7190           in: path
7191           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7192           required: true
7193           type: string
7194           example: __CLOUD-OWNER__
7195         - name: cloud-region-id
7196           in: path
7197           description: Identifier used by the vendor for the region. Second part of composite key
7198           required: true
7199           type: string
7200           example: __CLOUD-REGION-ID__
7201         - name: vip-ipv4-address
7202           in: path
7203           description: IP address
7204           required: true
7205           type: string
7206           example: __VIP-IPV4-ADDRESS__
7207     put:
7208       tags:
7209         - CloudInfrastructure
7210       summary: create or update an existing vip-ipv4-address-list
7211       description: |
7212         Create or update an existing vip-ipv4-address-list.
7213         #
7214         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7215       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7216       consumes:
7217         - application/json
7218         - application/xml
7219       produces:
7220         - application/json
7221         - application/xml
7222       responses:
7223         "default":
7224           description: Response codes found in [response codes](https://wiki.onap.org/).
7225       parameters:
7226         - name: cloud-owner
7227           in: path
7228           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7229           required: true
7230           type: string
7231           example: __CLOUD-OWNER__
7232         - name: cloud-region-id
7233           in: path
7234           description: Identifier used by the vendor for the region. Second part of composite key
7235           required: true
7236           type: string
7237           example: __CLOUD-REGION-ID__
7238         - name: vip-ipv4-address
7239           in: path
7240           description: IP address
7241           required: true
7242           type: string
7243           example: __VIP-IPV4-ADDRESS__
7244         - name: body
7245           in: body
7246           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7247           required: true
7248           schema:
7249             $ref: "#/definitions/vip-ipv4-address-list"
7250     patch:
7251       tags:
7252         - CloudInfrastructure
7253       summary: update an existing vip-ipv4-address-list
7254       description: |
7255         Update an existing vip-ipv4-address-list
7256         #
7257         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7258         The PUT operation will entirely replace an existing object.
7259         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7260         #
7261         Other differences between PUT and PATCH are:
7262         #
7263         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7264         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7265         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7266       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7267       consumes:
7268         - application/json
7269         - application/xml
7270       produces:
7271         - application/json
7272         - application/xml
7273       responses:
7274         "default":
7275           description: Response codes found in [response codes](https://wiki.onap.org/).
7276       parameters:
7277         - name: cloud-owner
7278           in: path
7279           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7280           required: true
7281           type: string
7282           example: __CLOUD-OWNER__
7283         - name: cloud-region-id
7284           in: path
7285           description: Identifier used by the vendor for the region. Second part of composite key
7286           required: true
7287           type: string
7288           example: __CLOUD-REGION-ID__
7289         - name: vip-ipv4-address
7290           in: path
7291           description: IP address
7292           required: true
7293           type: string
7294           example: __VIP-IPV4-ADDRESS__
7295         - name: body
7296           in: body
7297           description: vip-ipv4-address-list object that needs to be updated.
7298           required: true
7299           schema:
7300             $ref: "#/patchDefinitions/vip-ipv4-address-list"
7301     delete:
7302       tags:
7303         - CloudInfrastructure
7304       summary: delete an existing vip-ipv4-address-list
7305       description: delete an existing vip-ipv4-address-list
7306       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7307       consumes:
7308         - application/json
7309         - application/xml
7310       produces:
7311         - application/json
7312         - application/xml
7313       responses:
7314         "default":
7315           description: Response codes found in [response codes](https://wiki.onap.org/).
7316       parameters:
7317         - name: cloud-owner
7318           in: path
7319           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7320           required: true
7321           type: string
7322           example: __CLOUD-OWNER__
7323         - name: cloud-region-id
7324           in: path
7325           description: Identifier used by the vendor for the region. Second part of composite key
7326           required: true
7327           type: string
7328           example: __CLOUD-REGION-ID__
7329         - name: vip-ipv4-address
7330           in: path
7331           description: IP address
7332           required: true
7333           type: string
7334           example: __VIP-IPV4-ADDRESS__
7335         - name: resource-version
7336           in: query
7337           description: resource-version for concurrency
7338           required: true
7339           type: string
7340   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7341     put:
7342       tags:
7343         - CloudInfrastructure
7344       summary: see node definition for valid relationships
7345       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7346       consumes:
7347         - application/json
7348         - application/xml
7349       produces:
7350         - application/json
7351         - application/xml
7352       responses:
7353         "default":
7354           description: Response codes found in [response codes](https://wiki.onap.org/).
7355       parameters:
7356         - name: cloud-owner
7357           in: path
7358           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7359           required: true
7360           type: string
7361           example: __CLOUD-OWNER__
7362         - name: cloud-region-id
7363           in: path
7364           description: Identifier used by the vendor for the region. Second part of composite key
7365           required: true
7366           type: string
7367           example: __CLOUD-REGION-ID__
7368         - name: vip-ipv6-address
7369           in: path
7370           description: IP address
7371           required: true
7372           type: string
7373           example: __VIP-IPV6-ADDRESS__
7374         - name: body
7375           in: body
7376           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7377           required: true
7378           schema:
7379             $ref: "#/definitions/relationship"
7380     delete:
7381       tags:
7382         - CloudInfrastructure
7383       summary: delete an existing relationship
7384       description: delete an existing relationship
7385       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7386       consumes:
7387         - application/json
7388         - application/xml
7389       produces:
7390         - application/json
7391         - application/xml
7392       responses:
7393         "default":
7394           description: Response codes found in [response codes](https://wiki.onap.org/).
7395       parameters:
7396         - name: cloud-owner
7397           in: path
7398           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7399           required: true
7400           type: string
7401           example: __CLOUD-OWNER__
7402         - name: cloud-region-id
7403           in: path
7404           description: Identifier used by the vendor for the region. Second part of composite key
7405           required: true
7406           type: string
7407           example: __CLOUD-REGION-ID__
7408         - name: vip-ipv6-address
7409           in: path
7410           description: IP address
7411           required: true
7412           type: string
7413           example: __VIP-IPV6-ADDRESS__
7414   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7415     get:
7416       tags:
7417         - CloudInfrastructure
7418       summary: returns vip-ipv6-address-list
7419       description: returns vip-ipv6-address-list
7420       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7421       produces:
7422         - application/json
7423         - application/xml
7424       responses:
7425         "200":
7426           description: successful operation
7427           schema:
7428               $ref: "#/getDefinitions/vip-ipv6-address-list"
7429         "default":
7430           description: Response codes found in [response codes](https://wiki.onap.org/).
7431       parameters:
7432         - name: cloud-owner
7433           in: path
7434           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7435           required: true
7436           type: string
7437           example: __CLOUD-OWNER__
7438         - name: cloud-region-id
7439           in: path
7440           description: Identifier used by the vendor for the region. Second part of composite key
7441           required: true
7442           type: string
7443           example: __CLOUD-REGION-ID__
7444         - name: vip-ipv6-address
7445           in: path
7446           description: IP address
7447           required: true
7448           type: string
7449           example: __VIP-IPV6-ADDRESS__
7450     put:
7451       tags:
7452         - CloudInfrastructure
7453       summary: create or update an existing vip-ipv6-address-list
7454       description: |
7455         Create or update an existing vip-ipv6-address-list.
7456         #
7457         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7458       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7459       consumes:
7460         - application/json
7461         - application/xml
7462       produces:
7463         - application/json
7464         - application/xml
7465       responses:
7466         "default":
7467           description: Response codes found in [response codes](https://wiki.onap.org/).
7468       parameters:
7469         - name: cloud-owner
7470           in: path
7471           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7472           required: true
7473           type: string
7474           example: __CLOUD-OWNER__
7475         - name: cloud-region-id
7476           in: path
7477           description: Identifier used by the vendor for the region. Second part of composite key
7478           required: true
7479           type: string
7480           example: __CLOUD-REGION-ID__
7481         - name: vip-ipv6-address
7482           in: path
7483           description: IP address
7484           required: true
7485           type: string
7486           example: __VIP-IPV6-ADDRESS__
7487         - name: body
7488           in: body
7489           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7490           required: true
7491           schema:
7492             $ref: "#/definitions/vip-ipv6-address-list"
7493     patch:
7494       tags:
7495         - CloudInfrastructure
7496       summary: update an existing vip-ipv6-address-list
7497       description: |
7498         Update an existing vip-ipv6-address-list
7499         #
7500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7501         The PUT operation will entirely replace an existing object.
7502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7503         #
7504         Other differences between PUT and PATCH are:
7505         #
7506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7509       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7510       consumes:
7511         - application/json
7512         - application/xml
7513       produces:
7514         - application/json
7515         - application/xml
7516       responses:
7517         "default":
7518           description: Response codes found in [response codes](https://wiki.onap.org/).
7519       parameters:
7520         - name: cloud-owner
7521           in: path
7522           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7523           required: true
7524           type: string
7525           example: __CLOUD-OWNER__
7526         - name: cloud-region-id
7527           in: path
7528           description: Identifier used by the vendor for the region. Second part of composite key
7529           required: true
7530           type: string
7531           example: __CLOUD-REGION-ID__
7532         - name: vip-ipv6-address
7533           in: path
7534           description: IP address
7535           required: true
7536           type: string
7537           example: __VIP-IPV6-ADDRESS__
7538         - name: body
7539           in: body
7540           description: vip-ipv6-address-list object that needs to be updated.
7541           required: true
7542           schema:
7543             $ref: "#/patchDefinitions/vip-ipv6-address-list"
7544     delete:
7545       tags:
7546         - CloudInfrastructure
7547       summary: delete an existing vip-ipv6-address-list
7548       description: delete an existing vip-ipv6-address-list
7549       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7550       consumes:
7551         - application/json
7552         - application/xml
7553       produces:
7554         - application/json
7555         - application/xml
7556       responses:
7557         "default":
7558           description: Response codes found in [response codes](https://wiki.onap.org/).
7559       parameters:
7560         - name: cloud-owner
7561           in: path
7562           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7563           required: true
7564           type: string
7565           example: __CLOUD-OWNER__
7566         - name: cloud-region-id
7567           in: path
7568           description: Identifier used by the vendor for the region. Second part of composite key
7569           required: true
7570           type: string
7571           example: __CLOUD-REGION-ID__
7572         - name: vip-ipv6-address
7573           in: path
7574           description: IP address
7575           required: true
7576           type: string
7577           example: __VIP-IPV6-ADDRESS__
7578         - name: resource-version
7579           in: query
7580           description: resource-version for concurrency
7581           required: true
7582           type: string
7583   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
7584     get:
7585       tags:
7586         - CloudInfrastructure
7587       summary: returns cloud-region
7588       description: returns cloud-region
7589       operationId: getCloudInfrastructureCloudRegionsCloudRegion
7590       produces:
7591         - application/json
7592         - application/xml
7593       responses:
7594         "200":
7595           description: successful operation
7596           schema:
7597               $ref: "#/getDefinitions/cloud-region"
7598         "default":
7599           description: Response codes found in [response codes](https://wiki.onap.org/).
7600       parameters:
7601         - name: cloud-owner
7602           in: path
7603           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7604           required: true
7605           type: string
7606           example: __CLOUD-OWNER__
7607         - name: cloud-region-id
7608           in: path
7609           description: Identifier used by the vendor for the region. Second part of composite key
7610           required: true
7611           type: string
7612           example: __CLOUD-REGION-ID__
7613     put:
7614       tags:
7615         - CloudInfrastructure
7616       summary: create or update an existing cloud-region
7617       description: |
7618         Create or update an existing cloud-region.
7619         #
7620         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7621       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
7622       consumes:
7623         - application/json
7624         - application/xml
7625       produces:
7626         - application/json
7627         - application/xml
7628       responses:
7629         "default":
7630           description: Response codes found in [response codes](https://wiki.onap.org/).
7631       parameters:
7632         - name: cloud-owner
7633           in: path
7634           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7635           required: true
7636           type: string
7637           example: __CLOUD-OWNER__
7638         - name: cloud-region-id
7639           in: path
7640           description: Identifier used by the vendor for the region. Second part of composite key
7641           required: true
7642           type: string
7643           example: __CLOUD-REGION-ID__
7644         - name: body
7645           in: body
7646           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
7647           required: true
7648           schema:
7649             $ref: "#/definitions/cloud-region"
7650     patch:
7651       tags:
7652         - CloudInfrastructure
7653       summary: update an existing cloud-region
7654       description: |
7655         Update an existing cloud-region
7656         #
7657         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7658         The PUT operation will entirely replace an existing object.
7659         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7660         #
7661         Other differences between PUT and PATCH are:
7662         #
7663         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7664         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7665         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7666       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
7667       consumes:
7668         - application/json
7669         - application/xml
7670       produces:
7671         - application/json
7672         - application/xml
7673       responses:
7674         "default":
7675           description: Response codes found in [response codes](https://wiki.onap.org/).
7676       parameters:
7677         - name: cloud-owner
7678           in: path
7679           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7680           required: true
7681           type: string
7682           example: __CLOUD-OWNER__
7683         - name: cloud-region-id
7684           in: path
7685           description: Identifier used by the vendor for the region. Second part of composite key
7686           required: true
7687           type: string
7688           example: __CLOUD-REGION-ID__
7689         - name: body
7690           in: body
7691           description: cloud-region object that needs to be updated.
7692           required: true
7693           schema:
7694             $ref: "#/patchDefinitions/cloud-region"
7695     delete:
7696       tags:
7697         - CloudInfrastructure
7698       summary: delete an existing cloud-region
7699       description: delete an existing cloud-region
7700       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
7701       consumes:
7702         - application/json
7703         - application/xml
7704       produces:
7705         - application/json
7706         - application/xml
7707       responses:
7708         "default":
7709           description: Response codes found in [response codes](https://wiki.onap.org/).
7710       parameters:
7711         - name: cloud-owner
7712           in: path
7713           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7714           required: true
7715           type: string
7716           example: __CLOUD-OWNER__
7717         - name: cloud-region-id
7718           in: path
7719           description: Identifier used by the vendor for the region. Second part of composite key
7720           required: true
7721           type: string
7722           example: __CLOUD-REGION-ID__
7723         - name: resource-version
7724           in: query
7725           description: resource-version for concurrency
7726           required: true
7727           type: string
7728   /cloud-infrastructure/cloud-regions:
7729     get:
7730       tags:
7731         - CloudInfrastructure
7732       summary: returns cloud-regions
7733       description: returns cloud-regions
7734       operationId: getCloudInfrastructureCloudRegions
7735       produces:
7736         - application/json
7737         - application/xml
7738       responses:
7739         "200":
7740           description: successful operation
7741           schema:
7742               $ref: "#/getDefinitions/cloud-regions"
7743         "default":
7744           description: Response codes found in [response codes](https://wiki.onap.org/).
7745       parameters:
7746         - name: cloud-owner
7747           in: query
7748           description:
7749           required: false
7750           type: string
7751         - name: cloud-region-id
7752           in: query
7753           description:
7754           required: false
7755           type: string
7756         - name: cloud-type
7757           in: query
7758           description:
7759           required: false
7760           type: string
7761         - name: owner-defined-type
7762           in: query
7763           description:
7764           required: false
7765           type: string
7766   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
7767     put:
7768       tags:
7769         - CloudInfrastructure
7770       summary: see node definition for valid relationships
7771       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7772       consumes:
7773         - application/json
7774         - application/xml
7775       produces:
7776         - application/json
7777         - application/xml
7778       responses:
7779         "default":
7780           description: Response codes found in [response codes](https://wiki.onap.org/).
7781       parameters:
7782         - name: nm-profile-name
7783           in: path
7784           description: Unique name of network profile.
7785           required: true
7786           type: string
7787           example: __NM-PROFILE-NAME__
7788         - name: body
7789           in: body
7790           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7791           required: true
7792           schema:
7793             $ref: "#/definitions/relationship"
7794     delete:
7795       tags:
7796         - CloudInfrastructure
7797       summary: delete an existing relationship
7798       description: delete an existing relationship
7799       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7800       consumes:
7801         - application/json
7802         - application/xml
7803       produces:
7804         - application/json
7805         - application/xml
7806       responses:
7807         "default":
7808           description: Response codes found in [response codes](https://wiki.onap.org/).
7809       parameters:
7810         - name: nm-profile-name
7811           in: path
7812           description: Unique name of network profile.
7813           required: true
7814           type: string
7815           example: __NM-PROFILE-NAME__
7816   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7817     get:
7818       tags:
7819         - CloudInfrastructure
7820       summary: returns network-profile
7821       description: returns network-profile
7822       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7823       produces:
7824         - application/json
7825         - application/xml
7826       responses:
7827         "200":
7828           description: successful operation
7829           schema:
7830               $ref: "#/getDefinitions/network-profile"
7831         "default":
7832           description: Response codes found in [response codes](https://wiki.onap.org/).
7833       parameters:
7834         - name: nm-profile-name
7835           in: path
7836           description: Unique name of network profile.
7837           required: true
7838           type: string
7839           example: __NM-PROFILE-NAME__
7840     put:
7841       tags:
7842         - CloudInfrastructure
7843       summary: create or update an existing network-profile
7844       description: |
7845         Create or update an existing network-profile.
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: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
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: nm-profile-name
7860           in: path
7861           description: Unique name of network profile.
7862           required: true
7863           type: string
7864           example: __NM-PROFILE-NAME__
7865         - name: body
7866           in: body
7867           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7868           required: true
7869           schema:
7870             $ref: "#/definitions/network-profile"
7871     patch:
7872       tags:
7873         - CloudInfrastructure
7874       summary: update an existing network-profile
7875       description: |
7876         Update an existing network-profile
7877         #
7878         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7879         The PUT operation will entirely replace an existing object.
7880         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7881         #
7882         Other differences between PUT and PATCH are:
7883         #
7884         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7885         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7886         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7887       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7888       consumes:
7889         - application/json
7890         - application/xml
7891       produces:
7892         - application/json
7893         - application/xml
7894       responses:
7895         "default":
7896           description: Response codes found in [response codes](https://wiki.onap.org/).
7897       parameters:
7898         - name: nm-profile-name
7899           in: path
7900           description: Unique name of network profile.
7901           required: true
7902           type: string
7903           example: __NM-PROFILE-NAME__
7904         - name: body
7905           in: body
7906           description: network-profile object that needs to be updated.
7907           required: true
7908           schema:
7909             $ref: "#/patchDefinitions/network-profile"
7910     delete:
7911       tags:
7912         - CloudInfrastructure
7913       summary: delete an existing network-profile
7914       description: delete an existing network-profile
7915       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7916       consumes:
7917         - application/json
7918         - application/xml
7919       produces:
7920         - application/json
7921         - application/xml
7922       responses:
7923         "default":
7924           description: Response codes found in [response codes](https://wiki.onap.org/).
7925       parameters:
7926         - name: nm-profile-name
7927           in: path
7928           description: Unique name of network profile.
7929           required: true
7930           type: string
7931           example: __NM-PROFILE-NAME__
7932         - name: resource-version
7933           in: query
7934           description: resource-version for concurrency
7935           required: true
7936           type: string
7937   /cloud-infrastructure/network-profiles:
7938     get:
7939       tags:
7940         - CloudInfrastructure
7941       summary: returns network-profiles
7942       description: returns network-profiles
7943       operationId: getCloudInfrastructureNetworkProfiles
7944       produces:
7945         - application/json
7946         - application/xml
7947       responses:
7948         "200":
7949           description: successful operation
7950           schema:
7951               $ref: "#/getDefinitions/network-profiles"
7952         "default":
7953           description: Response codes found in [response codes](https://wiki.onap.org/).
7954       parameters:
7955         - name: nm-profile-name
7956           in: query
7957           description:
7958           required: false
7959           type: string
7960   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7961     put:
7962       tags:
7963         - CloudInfrastructure
7964       summary: see node definition for valid relationships
7965       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7966       consumes:
7967         - application/json
7968         - application/xml
7969       produces:
7970         - application/json
7971         - application/xml
7972       responses:
7973         "default":
7974           description: Response codes found in [response codes](https://wiki.onap.org/).
7975       parameters:
7976         - name: hostname
7977           in: path
7978           description: Value from executing hostname on the compute node.
7979           required: true
7980           type: string
7981           example: __HOSTNAME__
7982         - name: body
7983           in: body
7984           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
7985           required: true
7986           schema:
7987             $ref: "#/definitions/relationship"
7988     delete:
7989       tags:
7990         - CloudInfrastructure
7991       summary: delete an existing relationship
7992       description: delete an existing relationship
7993       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7994       consumes:
7995         - application/json
7996         - application/xml
7997       produces:
7998         - application/json
7999         - application/xml
8000       responses:
8001         "default":
8002           description: Response codes found in [response codes](https://wiki.onap.org/).
8003       parameters:
8004         - name: hostname
8005           in: path
8006           description: Value from executing hostname on the compute node.
8007           required: true
8008           type: string
8009           example: __HOSTNAME__
8010   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8011     put:
8012       tags:
8013         - CloudInfrastructure
8014       summary: see node definition for valid relationships
8015       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8016       consumes:
8017         - application/json
8018         - application/xml
8019       produces:
8020         - application/json
8021         - application/xml
8022       responses:
8023         "default":
8024           description: Response codes found in [response codes](https://wiki.onap.org/).
8025       parameters:
8026         - name: hostname
8027           in: path
8028           description: Value from executing hostname on the compute node.
8029           required: true
8030           type: string
8031           example: __HOSTNAME__
8032         - name: interface-name
8033           in: path
8034           description: Name that identifies the physical interface
8035           required: true
8036           type: string
8037           example: __INTERFACE-NAME__
8038         - name: body
8039           in: body
8040           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8041           required: true
8042           schema:
8043             $ref: "#/definitions/relationship"
8044     delete:
8045       tags:
8046         - CloudInfrastructure
8047       summary: delete an existing relationship
8048       description: delete an existing relationship
8049       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8050       consumes:
8051         - application/json
8052         - application/xml
8053       produces:
8054         - application/json
8055         - application/xml
8056       responses:
8057         "default":
8058           description: Response codes found in [response codes](https://wiki.onap.org/).
8059       parameters:
8060         - name: hostname
8061           in: path
8062           description: Value from executing hostname on the compute node.
8063           required: true
8064           type: string
8065           example: __HOSTNAME__
8066         - name: interface-name
8067           in: path
8068           description: Name that identifies the physical interface
8069           required: true
8070           type: string
8071           example: __INTERFACE-NAME__
8072   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
8073     put:
8074       tags:
8075         - CloudInfrastructure
8076       summary: see node definition for valid relationships
8077       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8078       consumes:
8079         - application/json
8080         - application/xml
8081       produces:
8082         - application/json
8083         - application/xml
8084       responses:
8085         "default":
8086           description: Response codes found in [response codes](https://wiki.onap.org/).
8087       parameters:
8088         - name: hostname
8089           in: path
8090           description: Value from executing hostname on the compute node.
8091           required: true
8092           type: string
8093           example: __HOSTNAME__
8094         - name: interface-name
8095           in: path
8096           description: Name that identifies the physical interface
8097           required: true
8098           type: string
8099           example: __INTERFACE-NAME__
8100         - name: pf-pci-id
8101           in: path
8102           description: Identifier for the sriov-pf
8103           required: true
8104           type: string
8105           example: __PF-PCI-ID__
8106         - name: body
8107           in: body
8108           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8109           required: true
8110           schema:
8111             $ref: "#/definitions/relationship"
8112     delete:
8113       tags:
8114         - CloudInfrastructure
8115       summary: delete an existing relationship
8116       description: delete an existing relationship
8117       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8118       consumes:
8119         - application/json
8120         - application/xml
8121       produces:
8122         - application/json
8123         - application/xml
8124       responses:
8125         "default":
8126           description: Response codes found in [response codes](https://wiki.onap.org/).
8127       parameters:
8128         - name: hostname
8129           in: path
8130           description: Value from executing hostname on the compute node.
8131           required: true
8132           type: string
8133           example: __HOSTNAME__
8134         - name: interface-name
8135           in: path
8136           description: Name that identifies the physical interface
8137           required: true
8138           type: string
8139           example: __INTERFACE-NAME__
8140         - name: pf-pci-id
8141           in: path
8142           description: Identifier for the sriov-pf
8143           required: true
8144           type: string
8145           example: __PF-PCI-ID__
8146   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
8147     get:
8148       tags:
8149         - CloudInfrastructure
8150       summary: returns sriov-pf
8151       description: returns sriov-pf
8152       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8153       produces:
8154         - application/json
8155         - application/xml
8156       responses:
8157         "200":
8158           description: successful operation
8159           schema:
8160               $ref: "#/getDefinitions/sriov-pf"
8161         "default":
8162           description: Response codes found in [response codes](https://wiki.onap.org/).
8163       parameters:
8164         - name: hostname
8165           in: path
8166           description: Value from executing hostname on the compute node.
8167           required: true
8168           type: string
8169           example: __HOSTNAME__
8170         - name: interface-name
8171           in: path
8172           description: Name that identifies the physical interface
8173           required: true
8174           type: string
8175           example: __INTERFACE-NAME__
8176         - name: pf-pci-id
8177           in: path
8178           description: Identifier for the sriov-pf
8179           required: true
8180           type: string
8181           example: __PF-PCI-ID__
8182     put:
8183       tags:
8184         - CloudInfrastructure
8185       summary: create or update an existing sriov-pf
8186       description: |
8187         Create or update an existing sriov-pf.
8188         #
8189         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8190       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8191       consumes:
8192         - application/json
8193         - application/xml
8194       produces:
8195         - application/json
8196         - application/xml
8197       responses:
8198         "default":
8199           description: Response codes found in [response codes](https://wiki.onap.org/).
8200       parameters:
8201         - name: hostname
8202           in: path
8203           description: Value from executing hostname on the compute node.
8204           required: true
8205           type: string
8206           example: __HOSTNAME__
8207         - name: interface-name
8208           in: path
8209           description: Name that identifies the physical interface
8210           required: true
8211           type: string
8212           example: __INTERFACE-NAME__
8213         - name: pf-pci-id
8214           in: path
8215           description: Identifier for the sriov-pf
8216           required: true
8217           type: string
8218           example: __PF-PCI-ID__
8219         - name: body
8220           in: body
8221           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8222           required: true
8223           schema:
8224             $ref: "#/definitions/sriov-pf"
8225     patch:
8226       tags:
8227         - CloudInfrastructure
8228       summary: update an existing sriov-pf
8229       description: |
8230         Update an existing sriov-pf
8231         #
8232         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8233         The PUT operation will entirely replace an existing object.
8234         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8235         #
8236         Other differences between PUT and PATCH are:
8237         #
8238         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8239         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8240         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8241       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8242       consumes:
8243         - application/json
8244         - application/xml
8245       produces:
8246         - application/json
8247         - application/xml
8248       responses:
8249         "default":
8250           description: Response codes found in [response codes](https://wiki.onap.org/).
8251       parameters:
8252         - name: hostname
8253           in: path
8254           description: Value from executing hostname on the compute node.
8255           required: true
8256           type: string
8257           example: __HOSTNAME__
8258         - name: interface-name
8259           in: path
8260           description: Name that identifies the physical interface
8261           required: true
8262           type: string
8263           example: __INTERFACE-NAME__
8264         - name: pf-pci-id
8265           in: path
8266           description: Identifier for the sriov-pf
8267           required: true
8268           type: string
8269           example: __PF-PCI-ID__
8270         - name: body
8271           in: body
8272           description: sriov-pf object that needs to be updated.
8273           required: true
8274           schema:
8275             $ref: "#/patchDefinitions/sriov-pf"
8276     delete:
8277       tags:
8278         - CloudInfrastructure
8279       summary: delete an existing sriov-pf
8280       description: delete an existing sriov-pf
8281       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8282       consumes:
8283         - application/json
8284         - application/xml
8285       produces:
8286         - application/json
8287         - application/xml
8288       responses:
8289         "default":
8290           description: Response codes found in [response codes](https://wiki.onap.org/).
8291       parameters:
8292         - name: hostname
8293           in: path
8294           description: Value from executing hostname on the compute node.
8295           required: true
8296           type: string
8297           example: __HOSTNAME__
8298         - name: interface-name
8299           in: path
8300           description: Name that identifies the physical interface
8301           required: true
8302           type: string
8303           example: __INTERFACE-NAME__
8304         - name: pf-pci-id
8305           in: path
8306           description: Identifier for the sriov-pf
8307           required: true
8308           type: string
8309           example: __PF-PCI-ID__
8310         - name: resource-version
8311           in: query
8312           description: resource-version for concurrency
8313           required: true
8314           type: string
8315   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
8316     get:
8317       tags:
8318         - CloudInfrastructure
8319       summary: returns sriov-pfs
8320       description: returns sriov-pfs
8321       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
8322       produces:
8323         - application/json
8324         - application/xml
8325       responses:
8326         "200":
8327           description: successful operation
8328           schema:
8329               $ref: "#/getDefinitions/sriov-pfs"
8330         "default":
8331           description: Response codes found in [response codes](https://wiki.onap.org/).
8332       parameters:
8333         - name: hostname
8334           in: path
8335           description: Value from executing hostname on the compute node.
8336           required: true
8337           type: string
8338           example: __HOSTNAME__
8339         - name: interface-name
8340           in: path
8341           description: Name that identifies the physical interface
8342           required: true
8343           type: string
8344           example: __INTERFACE-NAME__
8345         - name: pf-pci-id
8346           in: query
8347           description:
8348           required: false
8349           type: string
8350   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
8351     put:
8352       tags:
8353         - CloudInfrastructure
8354       summary: see node definition for valid relationships
8355       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8356       consumes:
8357         - application/json
8358         - application/xml
8359       produces:
8360         - application/json
8361         - application/xml
8362       responses:
8363         "default":
8364           description: Response codes found in [response codes](https://wiki.onap.org/).
8365       parameters:
8366         - name: hostname
8367           in: path
8368           description: Value from executing hostname on the compute node.
8369           required: true
8370           type: string
8371           example: __HOSTNAME__
8372         - name: interface-name
8373           in: path
8374           description: Name that identifies the physical interface
8375           required: true
8376           type: string
8377           example: __INTERFACE-NAME__
8378         - name: interface-name
8379           in: path
8380           description: Name given to the interface
8381           required: true
8382           type: string
8383           example: __INTERFACE-NAME__
8384         - name: vlan-interface
8385           in: path
8386           description: String that identifies the interface
8387           required: true
8388           type: string
8389           example: __VLAN-INTERFACE__
8390         - name: body
8391           in: body
8392           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8393           required: true
8394           schema:
8395             $ref: "#/definitions/relationship"
8396     delete:
8397       tags:
8398         - CloudInfrastructure
8399       summary: delete an existing relationship
8400       description: delete an existing relationship
8401       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8402       consumes:
8403         - application/json
8404         - application/xml
8405       produces:
8406         - application/json
8407         - application/xml
8408       responses:
8409         "default":
8410           description: Response codes found in [response codes](https://wiki.onap.org/).
8411       parameters:
8412         - name: hostname
8413           in: path
8414           description: Value from executing hostname on the compute node.
8415           required: true
8416           type: string
8417           example: __HOSTNAME__
8418         - name: interface-name
8419           in: path
8420           description: Name that identifies the physical interface
8421           required: true
8422           type: string
8423           example: __INTERFACE-NAME__
8424         - name: interface-name
8425           in: path
8426           description: Name given to the interface
8427           required: true
8428           type: string
8429           example: __INTERFACE-NAME__
8430         - name: vlan-interface
8431           in: path
8432           description: String that identifies the interface
8433           required: true
8434           type: string
8435           example: __VLAN-INTERFACE__
8436   /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:
8437     put:
8438       tags:
8439         - CloudInfrastructure
8440       summary: see node definition for valid relationships
8441       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8442       consumes:
8443         - application/json
8444         - application/xml
8445       produces:
8446         - application/json
8447         - application/xml
8448       responses:
8449         "default":
8450           description: Response codes found in [response codes](https://wiki.onap.org/).
8451       parameters:
8452         - name: hostname
8453           in: path
8454           description: Value from executing hostname on the compute node.
8455           required: true
8456           type: string
8457           example: __HOSTNAME__
8458         - name: interface-name
8459           in: path
8460           description: Name that identifies the physical interface
8461           required: true
8462           type: string
8463           example: __INTERFACE-NAME__
8464         - name: interface-name
8465           in: path
8466           description: Name given to the interface
8467           required: true
8468           type: string
8469           example: __INTERFACE-NAME__
8470         - name: vlan-interface
8471           in: path
8472           description: String that identifies the interface
8473           required: true
8474           type: string
8475           example: __VLAN-INTERFACE__
8476         - name: l3-interface-ipv4-address
8477           in: path
8478           description: IP address
8479           required: true
8480           type: string
8481           example: __L3-INTERFACE-IPV4-ADDRESS__
8482         - name: body
8483           in: body
8484           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8485           required: true
8486           schema:
8487             $ref: "#/definitions/relationship"
8488     delete:
8489       tags:
8490         - CloudInfrastructure
8491       summary: delete an existing relationship
8492       description: delete an existing relationship
8493       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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: vlan-interface
8523           in: path
8524           description: String that identifies the interface
8525           required: true
8526           type: string
8527           example: __VLAN-INTERFACE__
8528         - name: l3-interface-ipv4-address
8529           in: path
8530           description: IP address
8531           required: true
8532           type: string
8533           example: __L3-INTERFACE-IPV4-ADDRESS__
8534   /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}:
8535     get:
8536       tags:
8537         - CloudInfrastructure
8538       summary: returns l3-interface-ipv4-address-list
8539       description: returns l3-interface-ipv4-address-list
8540       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8541       produces:
8542         - application/json
8543         - application/xml
8544       responses:
8545         "200":
8546           description: successful operation
8547           schema:
8548               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8549         "default":
8550           description: Response codes found in [response codes](https://wiki.onap.org/).
8551       parameters:
8552         - name: hostname
8553           in: path
8554           description: Value from executing hostname on the compute node.
8555           required: true
8556           type: string
8557           example: __HOSTNAME__
8558         - name: interface-name
8559           in: path
8560           description: Name that identifies the physical interface
8561           required: true
8562           type: string
8563           example: __INTERFACE-NAME__
8564         - name: interface-name
8565           in: path
8566           description: Name given to the interface
8567           required: true
8568           type: string
8569           example: __INTERFACE-NAME__
8570         - name: vlan-interface
8571           in: path
8572           description: String that identifies the interface
8573           required: true
8574           type: string
8575           example: __VLAN-INTERFACE__
8576         - name: l3-interface-ipv4-address
8577           in: path
8578           description: IP address
8579           required: true
8580           type: string
8581           example: __L3-INTERFACE-IPV4-ADDRESS__
8582     put:
8583       tags:
8584         - CloudInfrastructure
8585       summary: create or update an existing l3-interface-ipv4-address-list
8586       description: |
8587         Create or update an existing l3-interface-ipv4-address-list.
8588         #
8589         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8590       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8591       consumes:
8592         - application/json
8593         - application/xml
8594       produces:
8595         - application/json
8596         - application/xml
8597       responses:
8598         "default":
8599           description: Response codes found in [response codes](https://wiki.onap.org/).
8600       parameters:
8601         - name: hostname
8602           in: path
8603           description: Value from executing hostname on the compute node.
8604           required: true
8605           type: string
8606           example: __HOSTNAME__
8607         - name: interface-name
8608           in: path
8609           description: Name that identifies the physical interface
8610           required: true
8611           type: string
8612           example: __INTERFACE-NAME__
8613         - name: interface-name
8614           in: path
8615           description: Name given to the interface
8616           required: true
8617           type: string
8618           example: __INTERFACE-NAME__
8619         - name: vlan-interface
8620           in: path
8621           description: String that identifies the interface
8622           required: true
8623           type: string
8624           example: __VLAN-INTERFACE__
8625         - name: l3-interface-ipv4-address
8626           in: path
8627           description: IP address
8628           required: true
8629           type: string
8630           example: __L3-INTERFACE-IPV4-ADDRESS__
8631         - name: body
8632           in: body
8633           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8634           required: true
8635           schema:
8636             $ref: "#/definitions/l3-interface-ipv4-address-list"
8637     patch:
8638       tags:
8639         - CloudInfrastructure
8640       summary: update an existing l3-interface-ipv4-address-list
8641       description: |
8642         Update an existing l3-interface-ipv4-address-list
8643         #
8644         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8645         The PUT operation will entirely replace an existing object.
8646         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8647         #
8648         Other differences between PUT and PATCH are:
8649         #
8650         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8651         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8652         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8653       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8654       consumes:
8655         - application/json
8656         - application/xml
8657       produces:
8658         - application/json
8659         - application/xml
8660       responses:
8661         "default":
8662           description: Response codes found in [response codes](https://wiki.onap.org/).
8663       parameters:
8664         - name: hostname
8665           in: path
8666           description: Value from executing hostname on the compute node.
8667           required: true
8668           type: string
8669           example: __HOSTNAME__
8670         - name: interface-name
8671           in: path
8672           description: Name that identifies the physical interface
8673           required: true
8674           type: string
8675           example: __INTERFACE-NAME__
8676         - name: interface-name
8677           in: path
8678           description: Name given to the interface
8679           required: true
8680           type: string
8681           example: __INTERFACE-NAME__
8682         - name: vlan-interface
8683           in: path
8684           description: String that identifies the interface
8685           required: true
8686           type: string
8687           example: __VLAN-INTERFACE__
8688         - name: l3-interface-ipv4-address
8689           in: path
8690           description: IP address
8691           required: true
8692           type: string
8693           example: __L3-INTERFACE-IPV4-ADDRESS__
8694         - name: body
8695           in: body
8696           description: l3-interface-ipv4-address-list object that needs to be updated.
8697           required: true
8698           schema:
8699             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8700     delete:
8701       tags:
8702         - CloudInfrastructure
8703       summary: delete an existing l3-interface-ipv4-address-list
8704       description: delete an existing l3-interface-ipv4-address-list
8705       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8706       consumes:
8707         - application/json
8708         - application/xml
8709       produces:
8710         - application/json
8711         - application/xml
8712       responses:
8713         "default":
8714           description: Response codes found in [response codes](https://wiki.onap.org/).
8715       parameters:
8716         - name: hostname
8717           in: path
8718           description: Value from executing hostname on the compute node.
8719           required: true
8720           type: string
8721           example: __HOSTNAME__
8722         - name: interface-name
8723           in: path
8724           description: Name that identifies the physical interface
8725           required: true
8726           type: string
8727           example: __INTERFACE-NAME__
8728         - name: interface-name
8729           in: path
8730           description: Name given to the interface
8731           required: true
8732           type: string
8733           example: __INTERFACE-NAME__
8734         - name: vlan-interface
8735           in: path
8736           description: String that identifies the interface
8737           required: true
8738           type: string
8739           example: __VLAN-INTERFACE__
8740         - name: l3-interface-ipv4-address
8741           in: path
8742           description: IP address
8743           required: true
8744           type: string
8745           example: __L3-INTERFACE-IPV4-ADDRESS__
8746         - name: resource-version
8747           in: query
8748           description: resource-version for concurrency
8749           required: true
8750           type: string
8751   /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:
8752     put:
8753       tags:
8754         - CloudInfrastructure
8755       summary: see node definition for valid relationships
8756       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8757       consumes:
8758         - application/json
8759         - application/xml
8760       produces:
8761         - application/json
8762         - application/xml
8763       responses:
8764         "default":
8765           description: Response codes found in [response codes](https://wiki.onap.org/).
8766       parameters:
8767         - name: hostname
8768           in: path
8769           description: Value from executing hostname on the compute node.
8770           required: true
8771           type: string
8772           example: __HOSTNAME__
8773         - name: interface-name
8774           in: path
8775           description: Name that identifies the physical interface
8776           required: true
8777           type: string
8778           example: __INTERFACE-NAME__
8779         - name: interface-name
8780           in: path
8781           description: Name given to the interface
8782           required: true
8783           type: string
8784           example: __INTERFACE-NAME__
8785         - name: vlan-interface
8786           in: path
8787           description: String that identifies the interface
8788           required: true
8789           type: string
8790           example: __VLAN-INTERFACE__
8791         - name: l3-interface-ipv6-address
8792           in: path
8793           description: IP address
8794           required: true
8795           type: string
8796           example: __L3-INTERFACE-IPV6-ADDRESS__
8797         - name: body
8798           in: body
8799           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8800           required: true
8801           schema:
8802             $ref: "#/definitions/relationship"
8803     delete:
8804       tags:
8805         - CloudInfrastructure
8806       summary: delete an existing relationship
8807       description: delete an existing relationship
8808       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8809       consumes:
8810         - application/json
8811         - application/xml
8812       produces:
8813         - application/json
8814         - application/xml
8815       responses:
8816         "default":
8817           description: Response codes found in [response codes](https://wiki.onap.org/).
8818       parameters:
8819         - name: hostname
8820           in: path
8821           description: Value from executing hostname on the compute node.
8822           required: true
8823           type: string
8824           example: __HOSTNAME__
8825         - name: interface-name
8826           in: path
8827           description: Name that identifies the physical interface
8828           required: true
8829           type: string
8830           example: __INTERFACE-NAME__
8831         - name: interface-name
8832           in: path
8833           description: Name given to the interface
8834           required: true
8835           type: string
8836           example: __INTERFACE-NAME__
8837         - name: vlan-interface
8838           in: path
8839           description: String that identifies the interface
8840           required: true
8841           type: string
8842           example: __VLAN-INTERFACE__
8843         - name: l3-interface-ipv6-address
8844           in: path
8845           description: IP address
8846           required: true
8847           type: string
8848           example: __L3-INTERFACE-IPV6-ADDRESS__
8849   /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}:
8850     get:
8851       tags:
8852         - CloudInfrastructure
8853       summary: returns l3-interface-ipv6-address-list
8854       description: returns l3-interface-ipv6-address-list
8855       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8856       produces:
8857         - application/json
8858         - application/xml
8859       responses:
8860         "200":
8861           description: successful operation
8862           schema:
8863               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8864         "default":
8865           description: Response codes found in [response codes](https://wiki.onap.org/).
8866       parameters:
8867         - name: hostname
8868           in: path
8869           description: Value from executing hostname on the compute node.
8870           required: true
8871           type: string
8872           example: __HOSTNAME__
8873         - name: interface-name
8874           in: path
8875           description: Name that identifies the physical interface
8876           required: true
8877           type: string
8878           example: __INTERFACE-NAME__
8879         - name: interface-name
8880           in: path
8881           description: Name given to the interface
8882           required: true
8883           type: string
8884           example: __INTERFACE-NAME__
8885         - name: vlan-interface
8886           in: path
8887           description: String that identifies the interface
8888           required: true
8889           type: string
8890           example: __VLAN-INTERFACE__
8891         - name: l3-interface-ipv6-address
8892           in: path
8893           description: IP address
8894           required: true
8895           type: string
8896           example: __L3-INTERFACE-IPV6-ADDRESS__
8897     put:
8898       tags:
8899         - CloudInfrastructure
8900       summary: create or update an existing l3-interface-ipv6-address-list
8901       description: |
8902         Create or update an existing l3-interface-ipv6-address-list.
8903         #
8904         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8905       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8906       consumes:
8907         - application/json
8908         - application/xml
8909       produces:
8910         - application/json
8911         - application/xml
8912       responses:
8913         "default":
8914           description: Response codes found in [response codes](https://wiki.onap.org/).
8915       parameters:
8916         - name: hostname
8917           in: path
8918           description: Value from executing hostname on the compute node.
8919           required: true
8920           type: string
8921           example: __HOSTNAME__
8922         - name: interface-name
8923           in: path
8924           description: Name that identifies the physical interface
8925           required: true
8926           type: string
8927           example: __INTERFACE-NAME__
8928         - name: interface-name
8929           in: path
8930           description: Name given to the interface
8931           required: true
8932           type: string
8933           example: __INTERFACE-NAME__
8934         - name: vlan-interface
8935           in: path
8936           description: String that identifies the interface
8937           required: true
8938           type: string
8939           example: __VLAN-INTERFACE__
8940         - name: l3-interface-ipv6-address
8941           in: path
8942           description: IP address
8943           required: true
8944           type: string
8945           example: __L3-INTERFACE-IPV6-ADDRESS__
8946         - name: body
8947           in: body
8948           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8949           required: true
8950           schema:
8951             $ref: "#/definitions/l3-interface-ipv6-address-list"
8952     patch:
8953       tags:
8954         - CloudInfrastructure
8955       summary: update an existing l3-interface-ipv6-address-list
8956       description: |
8957         Update an existing l3-interface-ipv6-address-list
8958         #
8959         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8960         The PUT operation will entirely replace an existing object.
8961         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8962         #
8963         Other differences between PUT and PATCH are:
8964         #
8965         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8966         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8967         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8968       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8969       consumes:
8970         - application/json
8971         - application/xml
8972       produces:
8973         - application/json
8974         - application/xml
8975       responses:
8976         "default":
8977           description: Response codes found in [response codes](https://wiki.onap.org/).
8978       parameters:
8979         - name: hostname
8980           in: path
8981           description: Value from executing hostname on the compute node.
8982           required: true
8983           type: string
8984           example: __HOSTNAME__
8985         - name: interface-name
8986           in: path
8987           description: Name that identifies the physical interface
8988           required: true
8989           type: string
8990           example: __INTERFACE-NAME__
8991         - name: interface-name
8992           in: path
8993           description: Name given to the interface
8994           required: true
8995           type: string
8996           example: __INTERFACE-NAME__
8997         - name: vlan-interface
8998           in: path
8999           description: String that identifies the interface
9000           required: true
9001           type: string
9002           example: __VLAN-INTERFACE__
9003         - name: l3-interface-ipv6-address
9004           in: path
9005           description: IP address
9006           required: true
9007           type: string
9008           example: __L3-INTERFACE-IPV6-ADDRESS__
9009         - name: body
9010           in: body
9011           description: l3-interface-ipv6-address-list object that needs to be updated.
9012           required: true
9013           schema:
9014             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9015     delete:
9016       tags:
9017         - CloudInfrastructure
9018       summary: delete an existing l3-interface-ipv6-address-list
9019       description: delete an existing l3-interface-ipv6-address-list
9020       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9021       consumes:
9022         - application/json
9023         - application/xml
9024       produces:
9025         - application/json
9026         - application/xml
9027       responses:
9028         "default":
9029           description: Response codes found in [response codes](https://wiki.onap.org/).
9030       parameters:
9031         - name: hostname
9032           in: path
9033           description: Value from executing hostname on the compute node.
9034           required: true
9035           type: string
9036           example: __HOSTNAME__
9037         - name: interface-name
9038           in: path
9039           description: Name that identifies the physical interface
9040           required: true
9041           type: string
9042           example: __INTERFACE-NAME__
9043         - name: interface-name
9044           in: path
9045           description: Name given to the interface
9046           required: true
9047           type: string
9048           example: __INTERFACE-NAME__
9049         - name: vlan-interface
9050           in: path
9051           description: String that identifies the interface
9052           required: true
9053           type: string
9054           example: __VLAN-INTERFACE__
9055         - name: l3-interface-ipv6-address
9056           in: path
9057           description: IP address
9058           required: true
9059           type: string
9060           example: __L3-INTERFACE-IPV6-ADDRESS__
9061         - name: resource-version
9062           in: query
9063           description: resource-version for concurrency
9064           required: true
9065           type: string
9066   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9067     get:
9068       tags:
9069         - CloudInfrastructure
9070       summary: returns vlan
9071       description: returns vlan
9072       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9073       produces:
9074         - application/json
9075         - application/xml
9076       responses:
9077         "200":
9078           description: successful operation
9079           schema:
9080               $ref: "#/getDefinitions/vlan"
9081         "default":
9082           description: Response codes found in [response codes](https://wiki.onap.org/).
9083       parameters:
9084         - name: hostname
9085           in: path
9086           description: Value from executing hostname on the compute node.
9087           required: true
9088           type: string
9089           example: __HOSTNAME__
9090         - name: interface-name
9091           in: path
9092           description: Name that identifies the physical interface
9093           required: true
9094           type: string
9095           example: __INTERFACE-NAME__
9096         - name: interface-name
9097           in: path
9098           description: Name given to the interface
9099           required: true
9100           type: string
9101           example: __INTERFACE-NAME__
9102         - name: vlan-interface
9103           in: path
9104           description: String that identifies the interface
9105           required: true
9106           type: string
9107           example: __VLAN-INTERFACE__
9108     put:
9109       tags:
9110         - CloudInfrastructure
9111       summary: create or update an existing vlan
9112       description: |
9113         Create or update an existing vlan.
9114         #
9115         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9116       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9117       consumes:
9118         - application/json
9119         - application/xml
9120       produces:
9121         - application/json
9122         - application/xml
9123       responses:
9124         "default":
9125           description: Response codes found in [response codes](https://wiki.onap.org/).
9126       parameters:
9127         - name: hostname
9128           in: path
9129           description: Value from executing hostname on the compute node.
9130           required: true
9131           type: string
9132           example: __HOSTNAME__
9133         - name: interface-name
9134           in: path
9135           description: Name that identifies the physical interface
9136           required: true
9137           type: string
9138           example: __INTERFACE-NAME__
9139         - name: interface-name
9140           in: path
9141           description: Name given to the interface
9142           required: true
9143           type: string
9144           example: __INTERFACE-NAME__
9145         - name: vlan-interface
9146           in: path
9147           description: String that identifies the interface
9148           required: true
9149           type: string
9150           example: __VLAN-INTERFACE__
9151         - name: body
9152           in: body
9153           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9154           required: true
9155           schema:
9156             $ref: "#/definitions/vlan"
9157     patch:
9158       tags:
9159         - CloudInfrastructure
9160       summary: update an existing vlan
9161       description: |
9162         Update an existing vlan
9163         #
9164         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9165         The PUT operation will entirely replace an existing object.
9166         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9167         #
9168         Other differences between PUT and PATCH are:
9169         #
9170         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9171         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9172         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9173       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9174       consumes:
9175         - application/json
9176         - application/xml
9177       produces:
9178         - application/json
9179         - application/xml
9180       responses:
9181         "default":
9182           description: Response codes found in [response codes](https://wiki.onap.org/).
9183       parameters:
9184         - name: hostname
9185           in: path
9186           description: Value from executing hostname on the compute node.
9187           required: true
9188           type: string
9189           example: __HOSTNAME__
9190         - name: interface-name
9191           in: path
9192           description: Name that identifies the physical interface
9193           required: true
9194           type: string
9195           example: __INTERFACE-NAME__
9196         - name: interface-name
9197           in: path
9198           description: Name given to the interface
9199           required: true
9200           type: string
9201           example: __INTERFACE-NAME__
9202         - name: vlan-interface
9203           in: path
9204           description: String that identifies the interface
9205           required: true
9206           type: string
9207           example: __VLAN-INTERFACE__
9208         - name: body
9209           in: body
9210           description: vlan object that needs to be updated.
9211           required: true
9212           schema:
9213             $ref: "#/patchDefinitions/vlan"
9214     delete:
9215       tags:
9216         - CloudInfrastructure
9217       summary: delete an existing vlan
9218       description: delete an existing vlan
9219       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9220       consumes:
9221         - application/json
9222         - application/xml
9223       produces:
9224         - application/json
9225         - application/xml
9226       responses:
9227         "default":
9228           description: Response codes found in [response codes](https://wiki.onap.org/).
9229       parameters:
9230         - name: hostname
9231           in: path
9232           description: Value from executing hostname on the compute node.
9233           required: true
9234           type: string
9235           example: __HOSTNAME__
9236         - name: interface-name
9237           in: path
9238           description: Name that identifies the physical interface
9239           required: true
9240           type: string
9241           example: __INTERFACE-NAME__
9242         - name: interface-name
9243           in: path
9244           description: Name given to the interface
9245           required: true
9246           type: string
9247           example: __INTERFACE-NAME__
9248         - name: vlan-interface
9249           in: path
9250           description: String that identifies the interface
9251           required: true
9252           type: string
9253           example: __VLAN-INTERFACE__
9254         - name: resource-version
9255           in: query
9256           description: resource-version for concurrency
9257           required: true
9258           type: string
9259   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9260     get:
9261       tags:
9262         - CloudInfrastructure
9263       summary: returns vlans
9264       description: returns vlans
9265       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9266       produces:
9267         - application/json
9268         - application/xml
9269       responses:
9270         "200":
9271           description: successful operation
9272           schema:
9273               $ref: "#/getDefinitions/vlans"
9274         "default":
9275           description: Response codes found in [response codes](https://wiki.onap.org/).
9276       parameters:
9277         - name: hostname
9278           in: path
9279           description: Value from executing hostname on the compute node.
9280           required: true
9281           type: string
9282           example: __HOSTNAME__
9283         - name: interface-name
9284           in: path
9285           description: Name that identifies the physical interface
9286           required: true
9287           type: string
9288           example: __INTERFACE-NAME__
9289         - name: interface-name
9290           in: path
9291           description: Name given to the interface
9292           required: true
9293           type: string
9294           example: __INTERFACE-NAME__
9295         - name: vlan-interface
9296           in: query
9297           description:
9298           required: false
9299           type: string
9300         - name: vlan-id-inner
9301           in: query
9302           description:
9303           required: false
9304           type: integer
9305           format: int64
9306         - name: vpn-key
9307           in: query
9308           description:
9309           required: false
9310           type: string
9311   /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:
9312     put:
9313       tags:
9314         - CloudInfrastructure
9315       summary: see node definition for valid relationships
9316       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9317       consumes:
9318         - application/json
9319         - application/xml
9320       produces:
9321         - application/json
9322         - application/xml
9323       responses:
9324         "default":
9325           description: Response codes found in [response codes](https://wiki.onap.org/).
9326       parameters:
9327         - name: hostname
9328           in: path
9329           description: Value from executing hostname on the compute node.
9330           required: true
9331           type: string
9332           example: __HOSTNAME__
9333         - name: interface-name
9334           in: path
9335           description: Name that identifies the physical interface
9336           required: true
9337           type: string
9338           example: __INTERFACE-NAME__
9339         - name: interface-name
9340           in: path
9341           description: Name given to the interface
9342           required: true
9343           type: string
9344           example: __INTERFACE-NAME__
9345         - name: pci-id
9346           in: path
9347           description: PCI ID used to identify the sriov-vf
9348           required: true
9349           type: string
9350           example: __PCI-ID__
9351         - name: body
9352           in: body
9353           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9354           required: true
9355           schema:
9356             $ref: "#/definitions/relationship"
9357     delete:
9358       tags:
9359         - CloudInfrastructure
9360       summary: delete an existing relationship
9361       description: delete an existing relationship
9362       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9363       consumes:
9364         - application/json
9365         - application/xml
9366       produces:
9367         - application/json
9368         - application/xml
9369       responses:
9370         "default":
9371           description: Response codes found in [response codes](https://wiki.onap.org/).
9372       parameters:
9373         - name: hostname
9374           in: path
9375           description: Value from executing hostname on the compute node.
9376           required: true
9377           type: string
9378           example: __HOSTNAME__
9379         - name: interface-name
9380           in: path
9381           description: Name that identifies the physical interface
9382           required: true
9383           type: string
9384           example: __INTERFACE-NAME__
9385         - name: interface-name
9386           in: path
9387           description: Name given to the interface
9388           required: true
9389           type: string
9390           example: __INTERFACE-NAME__
9391         - name: pci-id
9392           in: path
9393           description: PCI ID used to identify the sriov-vf
9394           required: true
9395           type: string
9396           example: __PCI-ID__
9397   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9398     get:
9399       tags:
9400         - CloudInfrastructure
9401       summary: returns sriov-vf
9402       description: returns sriov-vf
9403       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9404       produces:
9405         - application/json
9406         - application/xml
9407       responses:
9408         "200":
9409           description: successful operation
9410           schema:
9411               $ref: "#/getDefinitions/sriov-vf"
9412         "default":
9413           description: Response codes found in [response codes](https://wiki.onap.org/).
9414       parameters:
9415         - name: hostname
9416           in: path
9417           description: Value from executing hostname on the compute node.
9418           required: true
9419           type: string
9420           example: __HOSTNAME__
9421         - name: interface-name
9422           in: path
9423           description: Name that identifies the physical interface
9424           required: true
9425           type: string
9426           example: __INTERFACE-NAME__
9427         - name: interface-name
9428           in: path
9429           description: Name given to the interface
9430           required: true
9431           type: string
9432           example: __INTERFACE-NAME__
9433         - name: pci-id
9434           in: path
9435           description: PCI ID used to identify the sriov-vf
9436           required: true
9437           type: string
9438           example: __PCI-ID__
9439     put:
9440       tags:
9441         - CloudInfrastructure
9442       summary: create or update an existing sriov-vf
9443       description: |
9444         Create or update an existing sriov-vf.
9445         #
9446         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9447       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9448       consumes:
9449         - application/json
9450         - application/xml
9451       produces:
9452         - application/json
9453         - application/xml
9454       responses:
9455         "default":
9456           description: Response codes found in [response codes](https://wiki.onap.org/).
9457       parameters:
9458         - name: hostname
9459           in: path
9460           description: Value from executing hostname on the compute node.
9461           required: true
9462           type: string
9463           example: __HOSTNAME__
9464         - name: interface-name
9465           in: path
9466           description: Name that identifies the physical interface
9467           required: true
9468           type: string
9469           example: __INTERFACE-NAME__
9470         - name: interface-name
9471           in: path
9472           description: Name given to the interface
9473           required: true
9474           type: string
9475           example: __INTERFACE-NAME__
9476         - name: pci-id
9477           in: path
9478           description: PCI ID used to identify the sriov-vf
9479           required: true
9480           type: string
9481           example: __PCI-ID__
9482         - name: body
9483           in: body
9484           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9485           required: true
9486           schema:
9487             $ref: "#/definitions/sriov-vf"
9488     patch:
9489       tags:
9490         - CloudInfrastructure
9491       summary: update an existing sriov-vf
9492       description: |
9493         Update an existing sriov-vf
9494         #
9495         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9496         The PUT operation will entirely replace an existing object.
9497         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9498         #
9499         Other differences between PUT and PATCH are:
9500         #
9501         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9502         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9503         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9504       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9505       consumes:
9506         - application/json
9507         - application/xml
9508       produces:
9509         - application/json
9510         - application/xml
9511       responses:
9512         "default":
9513           description: Response codes found in [response codes](https://wiki.onap.org/).
9514       parameters:
9515         - name: hostname
9516           in: path
9517           description: Value from executing hostname on the compute node.
9518           required: true
9519           type: string
9520           example: __HOSTNAME__
9521         - name: interface-name
9522           in: path
9523           description: Name that identifies the physical interface
9524           required: true
9525           type: string
9526           example: __INTERFACE-NAME__
9527         - name: interface-name
9528           in: path
9529           description: Name given to the interface
9530           required: true
9531           type: string
9532           example: __INTERFACE-NAME__
9533         - name: pci-id
9534           in: path
9535           description: PCI ID used to identify the sriov-vf
9536           required: true
9537           type: string
9538           example: __PCI-ID__
9539         - name: body
9540           in: body
9541           description: sriov-vf object that needs to be updated.
9542           required: true
9543           schema:
9544             $ref: "#/patchDefinitions/sriov-vf"
9545     delete:
9546       tags:
9547         - CloudInfrastructure
9548       summary: delete an existing sriov-vf
9549       description: delete an existing sriov-vf
9550       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9551       consumes:
9552         - application/json
9553         - application/xml
9554       produces:
9555         - application/json
9556         - application/xml
9557       responses:
9558         "default":
9559           description: Response codes found in [response codes](https://wiki.onap.org/).
9560       parameters:
9561         - name: hostname
9562           in: path
9563           description: Value from executing hostname on the compute node.
9564           required: true
9565           type: string
9566           example: __HOSTNAME__
9567         - name: interface-name
9568           in: path
9569           description: Name that identifies the physical interface
9570           required: true
9571           type: string
9572           example: __INTERFACE-NAME__
9573         - name: interface-name
9574           in: path
9575           description: Name given to the interface
9576           required: true
9577           type: string
9578           example: __INTERFACE-NAME__
9579         - name: pci-id
9580           in: path
9581           description: PCI ID used to identify the sriov-vf
9582           required: true
9583           type: string
9584           example: __PCI-ID__
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/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9591     get:
9592       tags:
9593         - CloudInfrastructure
9594       summary: returns sriov-vfs
9595       description: returns sriov-vfs
9596       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9597       produces:
9598         - application/json
9599         - application/xml
9600       responses:
9601         "200":
9602           description: successful operation
9603           schema:
9604               $ref: "#/getDefinitions/sriov-vfs"
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: path
9616           description: Name that identifies the physical interface
9617           required: true
9618           type: string
9619           example: __INTERFACE-NAME__
9620         - name: interface-name
9621           in: path
9622           description: Name given to the interface
9623           required: true
9624           type: string
9625           example: __INTERFACE-NAME__
9626         - name: pci-id
9627           in: query
9628           description:
9629           required: false
9630           type: string
9631         - name: vf-vlan-filter
9632           in: query
9633           description:
9634           required: false
9635           type: string
9636         - name: vf-mac-filter
9637           in: query
9638           description:
9639           required: false
9640           type: string
9641         - name: vf-vlan-strip
9642           in: query
9643           description:
9644           required: false
9645           type: boolean
9646         - name: neutron-network-id
9647           in: query
9648           description:
9649           required: false
9650           type: string
9651   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9652     put:
9653       tags:
9654         - CloudInfrastructure
9655       summary: see node definition for valid relationships
9656       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9657       consumes:
9658         - application/json
9659         - application/xml
9660       produces:
9661         - application/json
9662         - application/xml
9663       responses:
9664         "default":
9665           description: Response codes found in [response codes](https://wiki.onap.org/).
9666       parameters:
9667         - name: hostname
9668           in: path
9669           description: Value from executing hostname on the compute node.
9670           required: true
9671           type: string
9672           example: __HOSTNAME__
9673         - name: interface-name
9674           in: path
9675           description: Name that identifies the physical interface
9676           required: true
9677           type: string
9678           example: __INTERFACE-NAME__
9679         - name: interface-name
9680           in: path
9681           description: Name given to the interface
9682           required: true
9683           type: string
9684           example: __INTERFACE-NAME__
9685         - name: body
9686           in: body
9687           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9688           required: true
9689           schema:
9690             $ref: "#/definitions/relationship"
9691     delete:
9692       tags:
9693         - CloudInfrastructure
9694       summary: delete an existing relationship
9695       description: delete an existing relationship
9696       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9697       consumes:
9698         - application/json
9699         - application/xml
9700       produces:
9701         - application/json
9702         - application/xml
9703       responses:
9704         "default":
9705           description: Response codes found in [response codes](https://wiki.onap.org/).
9706       parameters:
9707         - name: hostname
9708           in: path
9709           description: Value from executing hostname on the compute node.
9710           required: true
9711           type: string
9712           example: __HOSTNAME__
9713         - name: interface-name
9714           in: path
9715           description: Name that identifies the physical interface
9716           required: true
9717           type: string
9718           example: __INTERFACE-NAME__
9719         - name: interface-name
9720           in: path
9721           description: Name given to the interface
9722           required: true
9723           type: string
9724           example: __INTERFACE-NAME__
9725   /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:
9726     put:
9727       tags:
9728         - CloudInfrastructure
9729       summary: see node definition for valid relationships
9730       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9731       consumes:
9732         - application/json
9733         - application/xml
9734       produces:
9735         - application/json
9736         - application/xml
9737       responses:
9738         "default":
9739           description: Response codes found in [response codes](https://wiki.onap.org/).
9740       parameters:
9741         - name: hostname
9742           in: path
9743           description: Value from executing hostname on the compute node.
9744           required: true
9745           type: string
9746           example: __HOSTNAME__
9747         - name: interface-name
9748           in: path
9749           description: Name that identifies the physical interface
9750           required: true
9751           type: string
9752           example: __INTERFACE-NAME__
9753         - name: interface-name
9754           in: path
9755           description: Name given to the interface
9756           required: true
9757           type: string
9758           example: __INTERFACE-NAME__
9759         - name: l3-interface-ipv4-address
9760           in: path
9761           description: IP address
9762           required: true
9763           type: string
9764           example: __L3-INTERFACE-IPV4-ADDRESS__
9765         - name: body
9766           in: body
9767           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9768           required: true
9769           schema:
9770             $ref: "#/definitions/relationship"
9771     delete:
9772       tags:
9773         - CloudInfrastructure
9774       summary: delete an existing relationship
9775       description: delete an existing relationship
9776       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9777       consumes:
9778         - application/json
9779         - application/xml
9780       produces:
9781         - application/json
9782         - application/xml
9783       responses:
9784         "default":
9785           description: Response codes found in [response codes](https://wiki.onap.org/).
9786       parameters:
9787         - name: hostname
9788           in: path
9789           description: Value from executing hostname on the compute node.
9790           required: true
9791           type: string
9792           example: __HOSTNAME__
9793         - name: interface-name
9794           in: path
9795           description: Name that identifies the physical interface
9796           required: true
9797           type: string
9798           example: __INTERFACE-NAME__
9799         - name: interface-name
9800           in: path
9801           description: Name given to the interface
9802           required: true
9803           type: string
9804           example: __INTERFACE-NAME__
9805         - name: l3-interface-ipv4-address
9806           in: path
9807           description: IP address
9808           required: true
9809           type: string
9810           example: __L3-INTERFACE-IPV4-ADDRESS__
9811   /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}:
9812     get:
9813       tags:
9814         - CloudInfrastructure
9815       summary: returns l3-interface-ipv4-address-list
9816       description: returns l3-interface-ipv4-address-list
9817       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9818       produces:
9819         - application/json
9820         - application/xml
9821       responses:
9822         "200":
9823           description: successful operation
9824           schema:
9825               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9826         "default":
9827           description: Response codes found in [response codes](https://wiki.onap.org/).
9828       parameters:
9829         - name: hostname
9830           in: path
9831           description: Value from executing hostname on the compute node.
9832           required: true
9833           type: string
9834           example: __HOSTNAME__
9835         - name: interface-name
9836           in: path
9837           description: Name that identifies the physical interface
9838           required: true
9839           type: string
9840           example: __INTERFACE-NAME__
9841         - name: interface-name
9842           in: path
9843           description: Name given to the interface
9844           required: true
9845           type: string
9846           example: __INTERFACE-NAME__
9847         - name: l3-interface-ipv4-address
9848           in: path
9849           description: IP address
9850           required: true
9851           type: string
9852           example: __L3-INTERFACE-IPV4-ADDRESS__
9853     put:
9854       tags:
9855         - CloudInfrastructure
9856       summary: create or update an existing l3-interface-ipv4-address-list
9857       description: |
9858         Create or update an existing l3-interface-ipv4-address-list.
9859         #
9860         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9861       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9862       consumes:
9863         - application/json
9864         - application/xml
9865       produces:
9866         - application/json
9867         - application/xml
9868       responses:
9869         "default":
9870           description: Response codes found in [response codes](https://wiki.onap.org/).
9871       parameters:
9872         - name: hostname
9873           in: path
9874           description: Value from executing hostname on the compute node.
9875           required: true
9876           type: string
9877           example: __HOSTNAME__
9878         - name: interface-name
9879           in: path
9880           description: Name that identifies the physical interface
9881           required: true
9882           type: string
9883           example: __INTERFACE-NAME__
9884         - name: interface-name
9885           in: path
9886           description: Name given to the interface
9887           required: true
9888           type: string
9889           example: __INTERFACE-NAME__
9890         - name: l3-interface-ipv4-address
9891           in: path
9892           description: IP address
9893           required: true
9894           type: string
9895           example: __L3-INTERFACE-IPV4-ADDRESS__
9896         - name: body
9897           in: body
9898           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9899           required: true
9900           schema:
9901             $ref: "#/definitions/l3-interface-ipv4-address-list"
9902     patch:
9903       tags:
9904         - CloudInfrastructure
9905       summary: update an existing l3-interface-ipv4-address-list
9906       description: |
9907         Update an existing l3-interface-ipv4-address-list
9908         #
9909         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9910         The PUT operation will entirely replace an existing object.
9911         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9912         #
9913         Other differences between PUT and PATCH are:
9914         #
9915         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9916         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9917         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9918       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9919       consumes:
9920         - application/json
9921         - application/xml
9922       produces:
9923         - application/json
9924         - application/xml
9925       responses:
9926         "default":
9927           description: Response codes found in [response codes](https://wiki.onap.org/).
9928       parameters:
9929         - name: hostname
9930           in: path
9931           description: Value from executing hostname on the compute node.
9932           required: true
9933           type: string
9934           example: __HOSTNAME__
9935         - name: interface-name
9936           in: path
9937           description: Name that identifies the physical interface
9938           required: true
9939           type: string
9940           example: __INTERFACE-NAME__
9941         - name: interface-name
9942           in: path
9943           description: Name given to the interface
9944           required: true
9945           type: string
9946           example: __INTERFACE-NAME__
9947         - name: l3-interface-ipv4-address
9948           in: path
9949           description: IP address
9950           required: true
9951           type: string
9952           example: __L3-INTERFACE-IPV4-ADDRESS__
9953         - name: body
9954           in: body
9955           description: l3-interface-ipv4-address-list object that needs to be updated.
9956           required: true
9957           schema:
9958             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9959     delete:
9960       tags:
9961         - CloudInfrastructure
9962       summary: delete an existing l3-interface-ipv4-address-list
9963       description: delete an existing l3-interface-ipv4-address-list
9964       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9965       consumes:
9966         - application/json
9967         - application/xml
9968       produces:
9969         - application/json
9970         - application/xml
9971       responses:
9972         "default":
9973           description: Response codes found in [response codes](https://wiki.onap.org/).
9974       parameters:
9975         - name: hostname
9976           in: path
9977           description: Value from executing hostname on the compute node.
9978           required: true
9979           type: string
9980           example: __HOSTNAME__
9981         - name: interface-name
9982           in: path
9983           description: Name that identifies the physical interface
9984           required: true
9985           type: string
9986           example: __INTERFACE-NAME__
9987         - name: interface-name
9988           in: path
9989           description: Name given to the interface
9990           required: true
9991           type: string
9992           example: __INTERFACE-NAME__
9993         - name: l3-interface-ipv4-address
9994           in: path
9995           description: IP address
9996           required: true
9997           type: string
9998           example: __L3-INTERFACE-IPV4-ADDRESS__
9999         - name: resource-version
10000           in: query
10001           description: resource-version for concurrency
10002           required: true
10003           type: string
10004   /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:
10005     put:
10006       tags:
10007         - CloudInfrastructure
10008       summary: see node definition for valid relationships
10009       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10010       consumes:
10011         - application/json
10012         - application/xml
10013       produces:
10014         - application/json
10015         - application/xml
10016       responses:
10017         "default":
10018           description: Response codes found in [response codes](https://wiki.onap.org/).
10019       parameters:
10020         - name: hostname
10021           in: path
10022           description: Value from executing hostname on the compute node.
10023           required: true
10024           type: string
10025           example: __HOSTNAME__
10026         - name: interface-name
10027           in: path
10028           description: Name that identifies the physical interface
10029           required: true
10030           type: string
10031           example: __INTERFACE-NAME__
10032         - name: interface-name
10033           in: path
10034           description: Name given to the interface
10035           required: true
10036           type: string
10037           example: __INTERFACE-NAME__
10038         - name: l3-interface-ipv6-address
10039           in: path
10040           description: IP address
10041           required: true
10042           type: string
10043           example: __L3-INTERFACE-IPV6-ADDRESS__
10044         - name: body
10045           in: body
10046           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10047           required: true
10048           schema:
10049             $ref: "#/definitions/relationship"
10050     delete:
10051       tags:
10052         - CloudInfrastructure
10053       summary: delete an existing relationship
10054       description: delete an existing relationship
10055       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10056       consumes:
10057         - application/json
10058         - application/xml
10059       produces:
10060         - application/json
10061         - application/xml
10062       responses:
10063         "default":
10064           description: Response codes found in [response codes](https://wiki.onap.org/).
10065       parameters:
10066         - name: hostname
10067           in: path
10068           description: Value from executing hostname on the compute node.
10069           required: true
10070           type: string
10071           example: __HOSTNAME__
10072         - name: interface-name
10073           in: path
10074           description: Name that identifies the physical interface
10075           required: true
10076           type: string
10077           example: __INTERFACE-NAME__
10078         - name: interface-name
10079           in: path
10080           description: Name given to the interface
10081           required: true
10082           type: string
10083           example: __INTERFACE-NAME__
10084         - name: l3-interface-ipv6-address
10085           in: path
10086           description: IP address
10087           required: true
10088           type: string
10089           example: __L3-INTERFACE-IPV6-ADDRESS__
10090   /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}:
10091     get:
10092       tags:
10093         - CloudInfrastructure
10094       summary: returns l3-interface-ipv6-address-list
10095       description: returns l3-interface-ipv6-address-list
10096       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10097       produces:
10098         - application/json
10099         - application/xml
10100       responses:
10101         "200":
10102           description: successful operation
10103           schema:
10104               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10105         "default":
10106           description: Response codes found in [response codes](https://wiki.onap.org/).
10107       parameters:
10108         - name: hostname
10109           in: path
10110           description: Value from executing hostname on the compute node.
10111           required: true
10112           type: string
10113           example: __HOSTNAME__
10114         - name: interface-name
10115           in: path
10116           description: Name that identifies the physical interface
10117           required: true
10118           type: string
10119           example: __INTERFACE-NAME__
10120         - name: interface-name
10121           in: path
10122           description: Name given to the interface
10123           required: true
10124           type: string
10125           example: __INTERFACE-NAME__
10126         - name: l3-interface-ipv6-address
10127           in: path
10128           description: IP address
10129           required: true
10130           type: string
10131           example: __L3-INTERFACE-IPV6-ADDRESS__
10132     put:
10133       tags:
10134         - CloudInfrastructure
10135       summary: create or update an existing l3-interface-ipv6-address-list
10136       description: |
10137         Create or update an existing l3-interface-ipv6-address-list.
10138         #
10139         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10140       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10141       consumes:
10142         - application/json
10143         - application/xml
10144       produces:
10145         - application/json
10146         - application/xml
10147       responses:
10148         "default":
10149           description: Response codes found in [response codes](https://wiki.onap.org/).
10150       parameters:
10151         - name: hostname
10152           in: path
10153           description: Value from executing hostname on the compute node.
10154           required: true
10155           type: string
10156           example: __HOSTNAME__
10157         - name: interface-name
10158           in: path
10159           description: Name that identifies the physical interface
10160           required: true
10161           type: string
10162           example: __INTERFACE-NAME__
10163         - name: interface-name
10164           in: path
10165           description: Name given to the interface
10166           required: true
10167           type: string
10168           example: __INTERFACE-NAME__
10169         - name: l3-interface-ipv6-address
10170           in: path
10171           description: IP address
10172           required: true
10173           type: string
10174           example: __L3-INTERFACE-IPV6-ADDRESS__
10175         - name: body
10176           in: body
10177           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10178           required: true
10179           schema:
10180             $ref: "#/definitions/l3-interface-ipv6-address-list"
10181     patch:
10182       tags:
10183         - CloudInfrastructure
10184       summary: update an existing l3-interface-ipv6-address-list
10185       description: |
10186         Update an existing l3-interface-ipv6-address-list
10187         #
10188         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10189         The PUT operation will entirely replace an existing object.
10190         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10191         #
10192         Other differences between PUT and PATCH are:
10193         #
10194         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10195         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10196         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10197       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10198       consumes:
10199         - application/json
10200         - application/xml
10201       produces:
10202         - application/json
10203         - application/xml
10204       responses:
10205         "default":
10206           description: Response codes found in [response codes](https://wiki.onap.org/).
10207       parameters:
10208         - name: hostname
10209           in: path
10210           description: Value from executing hostname on the compute node.
10211           required: true
10212           type: string
10213           example: __HOSTNAME__
10214         - name: interface-name
10215           in: path
10216           description: Name that identifies the physical interface
10217           required: true
10218           type: string
10219           example: __INTERFACE-NAME__
10220         - name: interface-name
10221           in: path
10222           description: Name given to the interface
10223           required: true
10224           type: string
10225           example: __INTERFACE-NAME__
10226         - name: l3-interface-ipv6-address
10227           in: path
10228           description: IP address
10229           required: true
10230           type: string
10231           example: __L3-INTERFACE-IPV6-ADDRESS__
10232         - name: body
10233           in: body
10234           description: l3-interface-ipv6-address-list object that needs to be updated.
10235           required: true
10236           schema:
10237             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10238     delete:
10239       tags:
10240         - CloudInfrastructure
10241       summary: delete an existing l3-interface-ipv6-address-list
10242       description: delete an existing l3-interface-ipv6-address-list
10243       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10244       consumes:
10245         - application/json
10246         - application/xml
10247       produces:
10248         - application/json
10249         - application/xml
10250       responses:
10251         "default":
10252           description: Response codes found in [response codes](https://wiki.onap.org/).
10253       parameters:
10254         - name: hostname
10255           in: path
10256           description: Value from executing hostname on the compute node.
10257           required: true
10258           type: string
10259           example: __HOSTNAME__
10260         - name: interface-name
10261           in: path
10262           description: Name that identifies the physical interface
10263           required: true
10264           type: string
10265           example: __INTERFACE-NAME__
10266         - name: interface-name
10267           in: path
10268           description: Name given to the interface
10269           required: true
10270           type: string
10271           example: __INTERFACE-NAME__
10272         - name: l3-interface-ipv6-address
10273           in: path
10274           description: IP address
10275           required: true
10276           type: string
10277           example: __L3-INTERFACE-IPV6-ADDRESS__
10278         - name: resource-version
10279           in: query
10280           description: resource-version for concurrency
10281           required: true
10282           type: string
10283   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10284     get:
10285       tags:
10286         - CloudInfrastructure
10287       summary: returns l-interface
10288       description: returns l-interface
10289       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10290       produces:
10291         - application/json
10292         - application/xml
10293       responses:
10294         "200":
10295           description: successful operation
10296           schema:
10297               $ref: "#/getDefinitions/l-interface"
10298         "default":
10299           description: Response codes found in [response codes](https://wiki.onap.org/).
10300       parameters:
10301         - name: hostname
10302           in: path
10303           description: Value from executing hostname on the compute node.
10304           required: true
10305           type: string
10306           example: __HOSTNAME__
10307         - name: interface-name
10308           in: path
10309           description: Name that identifies the physical interface
10310           required: true
10311           type: string
10312           example: __INTERFACE-NAME__
10313         - name: interface-name
10314           in: path
10315           description: Name given to the interface
10316           required: true
10317           type: string
10318           example: __INTERFACE-NAME__
10319     put:
10320       tags:
10321         - CloudInfrastructure
10322       summary: create or update an existing l-interface
10323       description: |
10324         Create or update an existing l-interface.
10325         #
10326         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10327       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10328       consumes:
10329         - application/json
10330         - application/xml
10331       produces:
10332         - application/json
10333         - application/xml
10334       responses:
10335         "default":
10336           description: Response codes found in [response codes](https://wiki.onap.org/).
10337       parameters:
10338         - name: hostname
10339           in: path
10340           description: Value from executing hostname on the compute node.
10341           required: true
10342           type: string
10343           example: __HOSTNAME__
10344         - name: interface-name
10345           in: path
10346           description: Name that identifies the physical interface
10347           required: true
10348           type: string
10349           example: __INTERFACE-NAME__
10350         - name: interface-name
10351           in: path
10352           description: Name given to the interface
10353           required: true
10354           type: string
10355           example: __INTERFACE-NAME__
10356         - name: body
10357           in: body
10358           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10359           required: true
10360           schema:
10361             $ref: "#/definitions/l-interface"
10362     patch:
10363       tags:
10364         - CloudInfrastructure
10365       summary: update an existing l-interface
10366       description: |
10367         Update an existing l-interface
10368         #
10369         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10370         The PUT operation will entirely replace an existing object.
10371         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10372         #
10373         Other differences between PUT and PATCH are:
10374         #
10375         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10376         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10377         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10378       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10379       consumes:
10380         - application/json
10381         - application/xml
10382       produces:
10383         - application/json
10384         - application/xml
10385       responses:
10386         "default":
10387           description: Response codes found in [response codes](https://wiki.onap.org/).
10388       parameters:
10389         - name: hostname
10390           in: path
10391           description: Value from executing hostname on the compute node.
10392           required: true
10393           type: string
10394           example: __HOSTNAME__
10395         - name: interface-name
10396           in: path
10397           description: Name that identifies the physical interface
10398           required: true
10399           type: string
10400           example: __INTERFACE-NAME__
10401         - name: interface-name
10402           in: path
10403           description: Name given to the interface
10404           required: true
10405           type: string
10406           example: __INTERFACE-NAME__
10407         - name: body
10408           in: body
10409           description: l-interface object that needs to be updated.
10410           required: true
10411           schema:
10412             $ref: "#/patchDefinitions/l-interface"
10413     delete:
10414       tags:
10415         - CloudInfrastructure
10416       summary: delete an existing l-interface
10417       description: delete an existing l-interface
10418       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10419       consumes:
10420         - application/json
10421         - application/xml
10422       produces:
10423         - application/json
10424         - application/xml
10425       responses:
10426         "default":
10427           description: Response codes found in [response codes](https://wiki.onap.org/).
10428       parameters:
10429         - name: hostname
10430           in: path
10431           description: Value from executing hostname on the compute node.
10432           required: true
10433           type: string
10434           example: __HOSTNAME__
10435         - name: interface-name
10436           in: path
10437           description: Name that identifies the physical interface
10438           required: true
10439           type: string
10440           example: __INTERFACE-NAME__
10441         - name: interface-name
10442           in: path
10443           description: Name given to the interface
10444           required: true
10445           type: string
10446           example: __INTERFACE-NAME__
10447         - name: resource-version
10448           in: query
10449           description: resource-version for concurrency
10450           required: true
10451           type: string
10452   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10453     get:
10454       tags:
10455         - CloudInfrastructure
10456       summary: returns l-interfaces
10457       description: returns l-interfaces
10458       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10459       produces:
10460         - application/json
10461         - application/xml
10462       responses:
10463         "200":
10464           description: successful operation
10465           schema:
10466               $ref: "#/getDefinitions/l-interfaces"
10467         "default":
10468           description: Response codes found in [response codes](https://wiki.onap.org/).
10469       parameters:
10470         - name: hostname
10471           in: path
10472           description: Value from executing hostname on the compute node.
10473           required: true
10474           type: string
10475           example: __HOSTNAME__
10476         - name: interface-name
10477           in: path
10478           description: Name that identifies the physical interface
10479           required: true
10480           type: string
10481           example: __INTERFACE-NAME__
10482         - name: interface-name
10483           in: query
10484           description:
10485           required: false
10486           type: string
10487         - name: interface-id
10488           in: query
10489           description:
10490           required: false
10491           type: string
10492         - name: macaddr
10493           in: query
10494           description:
10495           required: false
10496           type: string
10497         - name: network-name
10498           in: query
10499           description:
10500           required: false
10501           type: string
10502   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10503     get:
10504       tags:
10505         - CloudInfrastructure
10506       summary: returns p-interface
10507       description: returns p-interface
10508       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10509       produces:
10510         - application/json
10511         - application/xml
10512       responses:
10513         "200":
10514           description: successful operation
10515           schema:
10516               $ref: "#/getDefinitions/p-interface"
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 physical interface
10529           required: true
10530           type: string
10531           example: __INTERFACE-NAME__
10532     put:
10533       tags:
10534         - CloudInfrastructure
10535       summary: create or update an existing p-interface
10536       description: |
10537         Create or update an existing p-interface.
10538         #
10539         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10540       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10541       consumes:
10542         - application/json
10543         - application/xml
10544       produces:
10545         - application/json
10546         - application/xml
10547       responses:
10548         "default":
10549           description: Response codes found in [response codes](https://wiki.onap.org/).
10550       parameters:
10551         - name: hostname
10552           in: path
10553           description: Value from executing hostname on the compute node.
10554           required: true
10555           type: string
10556           example: __HOSTNAME__
10557         - name: interface-name
10558           in: path
10559           description: Name that identifies the physical interface
10560           required: true
10561           type: string
10562           example: __INTERFACE-NAME__
10563         - name: body
10564           in: body
10565           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10566           required: true
10567           schema:
10568             $ref: "#/definitions/p-interface"
10569     patch:
10570       tags:
10571         - CloudInfrastructure
10572       summary: update an existing p-interface
10573       description: |
10574         Update an existing p-interface
10575         #
10576         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10577         The PUT operation will entirely replace an existing object.
10578         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10579         #
10580         Other differences between PUT and PATCH are:
10581         #
10582         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10583         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10584         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10585       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10586       consumes:
10587         - application/json
10588         - application/xml
10589       produces:
10590         - application/json
10591         - application/xml
10592       responses:
10593         "default":
10594           description: Response codes found in [response codes](https://wiki.onap.org/).
10595       parameters:
10596         - name: hostname
10597           in: path
10598           description: Value from executing hostname on the compute node.
10599           required: true
10600           type: string
10601           example: __HOSTNAME__
10602         - name: interface-name
10603           in: path
10604           description: Name that identifies the physical interface
10605           required: true
10606           type: string
10607           example: __INTERFACE-NAME__
10608         - name: body
10609           in: body
10610           description: p-interface object that needs to be updated.
10611           required: true
10612           schema:
10613             $ref: "#/patchDefinitions/p-interface"
10614     delete:
10615       tags:
10616         - CloudInfrastructure
10617       summary: delete an existing p-interface
10618       description: delete an existing p-interface
10619       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10620       consumes:
10621         - application/json
10622         - application/xml
10623       produces:
10624         - application/json
10625         - application/xml
10626       responses:
10627         "default":
10628           description: Response codes found in [response codes](https://wiki.onap.org/).
10629       parameters:
10630         - name: hostname
10631           in: path
10632           description: Value from executing hostname on the compute node.
10633           required: true
10634           type: string
10635           example: __HOSTNAME__
10636         - name: interface-name
10637           in: path
10638           description: Name that identifies the physical interface
10639           required: true
10640           type: string
10641           example: __INTERFACE-NAME__
10642         - name: resource-version
10643           in: query
10644           description: resource-version for concurrency
10645           required: true
10646           type: string
10647   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10648     get:
10649       tags:
10650         - CloudInfrastructure
10651       summary: returns p-interfaces
10652       description: returns p-interfaces
10653       operationId: getCloudInfrastructurePserversPserverPInterfaces
10654       produces:
10655         - application/json
10656         - application/xml
10657       responses:
10658         "200":
10659           description: successful operation
10660           schema:
10661               $ref: "#/getDefinitions/p-interfaces"
10662         "default":
10663           description: Response codes found in [response codes](https://wiki.onap.org/).
10664       parameters:
10665         - name: hostname
10666           in: path
10667           description: Value from executing hostname on the compute node.
10668           required: true
10669           type: string
10670           example: __HOSTNAME__
10671         - name: interface-name
10672           in: query
10673           description:
10674           required: false
10675           type: string
10676         - name: prov-status
10677           in: query
10678           description:
10679           required: false
10680           type: string
10681   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10682     put:
10683       tags:
10684         - CloudInfrastructure
10685       summary: see node definition for valid relationships
10686       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10687       consumes:
10688         - application/json
10689         - application/xml
10690       produces:
10691         - application/json
10692         - application/xml
10693       responses:
10694         "default":
10695           description: Response codes found in [response codes](https://wiki.onap.org/).
10696       parameters:
10697         - name: hostname
10698           in: path
10699           description: Value from executing hostname on the compute node.
10700           required: true
10701           type: string
10702           example: __HOSTNAME__
10703         - name: interface-name
10704           in: path
10705           description: Name that identifies the link aggregate interface
10706           required: true
10707           type: string
10708           example: __INTERFACE-NAME__
10709         - name: body
10710           in: body
10711           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10712           required: true
10713           schema:
10714             $ref: "#/definitions/relationship"
10715     delete:
10716       tags:
10717         - CloudInfrastructure
10718       summary: delete an existing relationship
10719       description: delete an existing relationship
10720       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10721       consumes:
10722         - application/json
10723         - application/xml
10724       produces:
10725         - application/json
10726         - application/xml
10727       responses:
10728         "default":
10729           description: Response codes found in [response codes](https://wiki.onap.org/).
10730       parameters:
10731         - name: hostname
10732           in: path
10733           description: Value from executing hostname on the compute node.
10734           required: true
10735           type: string
10736           example: __HOSTNAME__
10737         - name: interface-name
10738           in: path
10739           description: Name that identifies the link aggregate interface
10740           required: true
10741           type: string
10742           example: __INTERFACE-NAME__
10743   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10744     put:
10745       tags:
10746         - CloudInfrastructure
10747       summary: see node definition for valid relationships
10748       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10749       consumes:
10750         - application/json
10751         - application/xml
10752       produces:
10753         - application/json
10754         - application/xml
10755       responses:
10756         "default":
10757           description: Response codes found in [response codes](https://wiki.onap.org/).
10758       parameters:
10759         - name: hostname
10760           in: path
10761           description: Value from executing hostname on the compute node.
10762           required: true
10763           type: string
10764           example: __HOSTNAME__
10765         - name: interface-name
10766           in: path
10767           description: Name that identifies the link aggregate interface
10768           required: true
10769           type: string
10770           example: __INTERFACE-NAME__
10771         - name: interface-name
10772           in: path
10773           description: Name given to the interface
10774           required: true
10775           type: string
10776           example: __INTERFACE-NAME__
10777         - name: vlan-interface
10778           in: path
10779           description: String that identifies the interface
10780           required: true
10781           type: string
10782           example: __VLAN-INTERFACE__
10783         - name: body
10784           in: body
10785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10786           required: true
10787           schema:
10788             $ref: "#/definitions/relationship"
10789     delete:
10790       tags:
10791         - CloudInfrastructure
10792       summary: delete an existing relationship
10793       description: delete an existing relationship
10794       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10795       consumes:
10796         - application/json
10797         - application/xml
10798       produces:
10799         - application/json
10800         - application/xml
10801       responses:
10802         "default":
10803           description: Response codes found in [response codes](https://wiki.onap.org/).
10804       parameters:
10805         - name: hostname
10806           in: path
10807           description: Value from executing hostname on the compute node.
10808           required: true
10809           type: string
10810           example: __HOSTNAME__
10811         - name: interface-name
10812           in: path
10813           description: Name that identifies the link aggregate interface
10814           required: true
10815           type: string
10816           example: __INTERFACE-NAME__
10817         - name: interface-name
10818           in: path
10819           description: Name given to the interface
10820           required: true
10821           type: string
10822           example: __INTERFACE-NAME__
10823         - name: vlan-interface
10824           in: path
10825           description: String that identifies the interface
10826           required: true
10827           type: string
10828           example: __VLAN-INTERFACE__
10829   /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:
10830     put:
10831       tags:
10832         - CloudInfrastructure
10833       summary: see node definition for valid relationships
10834       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10835       consumes:
10836         - application/json
10837         - application/xml
10838       produces:
10839         - application/json
10840         - application/xml
10841       responses:
10842         "default":
10843           description: Response codes found in [response codes](https://wiki.onap.org/).
10844       parameters:
10845         - name: hostname
10846           in: path
10847           description: Value from executing hostname on the compute node.
10848           required: true
10849           type: string
10850           example: __HOSTNAME__
10851         - name: interface-name
10852           in: path
10853           description: Name that identifies the link aggregate interface
10854           required: true
10855           type: string
10856           example: __INTERFACE-NAME__
10857         - name: interface-name
10858           in: path
10859           description: Name given to the interface
10860           required: true
10861           type: string
10862           example: __INTERFACE-NAME__
10863         - name: vlan-interface
10864           in: path
10865           description: String that identifies the interface
10866           required: true
10867           type: string
10868           example: __VLAN-INTERFACE__
10869         - name: l3-interface-ipv4-address
10870           in: path
10871           description: IP address
10872           required: true
10873           type: string
10874           example: __L3-INTERFACE-IPV4-ADDRESS__
10875         - name: body
10876           in: body
10877           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10878           required: true
10879           schema:
10880             $ref: "#/definitions/relationship"
10881     delete:
10882       tags:
10883         - CloudInfrastructure
10884       summary: delete an existing relationship
10885       description: delete an existing relationship
10886       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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: vlan-interface
10916           in: path
10917           description: String that identifies the interface
10918           required: true
10919           type: string
10920           example: __VLAN-INTERFACE__
10921         - name: l3-interface-ipv4-address
10922           in: path
10923           description: IP address
10924           required: true
10925           type: string
10926           example: __L3-INTERFACE-IPV4-ADDRESS__
10927   /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}:
10928     get:
10929       tags:
10930         - CloudInfrastructure
10931       summary: returns l3-interface-ipv4-address-list
10932       description: returns l3-interface-ipv4-address-list
10933       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10934       produces:
10935         - application/json
10936         - application/xml
10937       responses:
10938         "200":
10939           description: successful operation
10940           schema:
10941               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10942         "default":
10943           description: Response codes found in [response codes](https://wiki.onap.org/).
10944       parameters:
10945         - name: hostname
10946           in: path
10947           description: Value from executing hostname on the compute node.
10948           required: true
10949           type: string
10950           example: __HOSTNAME__
10951         - name: interface-name
10952           in: path
10953           description: Name that identifies the link aggregate interface
10954           required: true
10955           type: string
10956           example: __INTERFACE-NAME__
10957         - name: interface-name
10958           in: path
10959           description: Name given to the interface
10960           required: true
10961           type: string
10962           example: __INTERFACE-NAME__
10963         - name: vlan-interface
10964           in: path
10965           description: String that identifies the interface
10966           required: true
10967           type: string
10968           example: __VLAN-INTERFACE__
10969         - name: l3-interface-ipv4-address
10970           in: path
10971           description: IP address
10972           required: true
10973           type: string
10974           example: __L3-INTERFACE-IPV4-ADDRESS__
10975     put:
10976       tags:
10977         - CloudInfrastructure
10978       summary: create or update an existing l3-interface-ipv4-address-list
10979       description: |
10980         Create or update an existing l3-interface-ipv4-address-list.
10981         #
10982         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10983       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10984       consumes:
10985         - application/json
10986         - application/xml
10987       produces:
10988         - application/json
10989         - application/xml
10990       responses:
10991         "default":
10992           description: Response codes found in [response codes](https://wiki.onap.org/).
10993       parameters:
10994         - name: hostname
10995           in: path
10996           description: Value from executing hostname on the compute node.
10997           required: true
10998           type: string
10999           example: __HOSTNAME__
11000         - name: interface-name
11001           in: path
11002           description: Name that identifies the link aggregate interface
11003           required: true
11004           type: string
11005           example: __INTERFACE-NAME__
11006         - name: interface-name
11007           in: path
11008           description: Name given to the interface
11009           required: true
11010           type: string
11011           example: __INTERFACE-NAME__
11012         - name: vlan-interface
11013           in: path
11014           description: String that identifies the interface
11015           required: true
11016           type: string
11017           example: __VLAN-INTERFACE__
11018         - name: l3-interface-ipv4-address
11019           in: path
11020           description: IP address
11021           required: true
11022           type: string
11023           example: __L3-INTERFACE-IPV4-ADDRESS__
11024         - name: body
11025           in: body
11026           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11027           required: true
11028           schema:
11029             $ref: "#/definitions/l3-interface-ipv4-address-list"
11030     patch:
11031       tags:
11032         - CloudInfrastructure
11033       summary: update an existing l3-interface-ipv4-address-list
11034       description: |
11035         Update an existing l3-interface-ipv4-address-list
11036         #
11037         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11038         The PUT operation will entirely replace an existing object.
11039         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11040         #
11041         Other differences between PUT and PATCH are:
11042         #
11043         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11044         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11045         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11046       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11047       consumes:
11048         - application/json
11049         - application/xml
11050       produces:
11051         - application/json
11052         - application/xml
11053       responses:
11054         "default":
11055           description: Response codes found in [response codes](https://wiki.onap.org/).
11056       parameters:
11057         - name: hostname
11058           in: path
11059           description: Value from executing hostname on the compute node.
11060           required: true
11061           type: string
11062           example: __HOSTNAME__
11063         - name: interface-name
11064           in: path
11065           description: Name that identifies the link aggregate interface
11066           required: true
11067           type: string
11068           example: __INTERFACE-NAME__
11069         - name: interface-name
11070           in: path
11071           description: Name given to the interface
11072           required: true
11073           type: string
11074           example: __INTERFACE-NAME__
11075         - name: vlan-interface
11076           in: path
11077           description: String that identifies the interface
11078           required: true
11079           type: string
11080           example: __VLAN-INTERFACE__
11081         - name: l3-interface-ipv4-address
11082           in: path
11083           description: IP address
11084           required: true
11085           type: string
11086           example: __L3-INTERFACE-IPV4-ADDRESS__
11087         - name: body
11088           in: body
11089           description: l3-interface-ipv4-address-list object that needs to be updated.
11090           required: true
11091           schema:
11092             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11093     delete:
11094       tags:
11095         - CloudInfrastructure
11096       summary: delete an existing l3-interface-ipv4-address-list
11097       description: delete an existing l3-interface-ipv4-address-list
11098       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11099       consumes:
11100         - application/json
11101         - application/xml
11102       produces:
11103         - application/json
11104         - application/xml
11105       responses:
11106         "default":
11107           description: Response codes found in [response codes](https://wiki.onap.org/).
11108       parameters:
11109         - name: hostname
11110           in: path
11111           description: Value from executing hostname on the compute node.
11112           required: true
11113           type: string
11114           example: __HOSTNAME__
11115         - name: interface-name
11116           in: path
11117           description: Name that identifies the link aggregate interface
11118           required: true
11119           type: string
11120           example: __INTERFACE-NAME__
11121         - name: interface-name
11122           in: path
11123           description: Name given to the interface
11124           required: true
11125           type: string
11126           example: __INTERFACE-NAME__
11127         - name: vlan-interface
11128           in: path
11129           description: String that identifies the interface
11130           required: true
11131           type: string
11132           example: __VLAN-INTERFACE__
11133         - name: l3-interface-ipv4-address
11134           in: path
11135           description: IP address
11136           required: true
11137           type: string
11138           example: __L3-INTERFACE-IPV4-ADDRESS__
11139         - name: resource-version
11140           in: query
11141           description: resource-version for concurrency
11142           required: true
11143           type: string
11144   /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:
11145     put:
11146       tags:
11147         - CloudInfrastructure
11148       summary: see node definition for valid relationships
11149       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11150       consumes:
11151         - application/json
11152         - application/xml
11153       produces:
11154         - application/json
11155         - application/xml
11156       responses:
11157         "default":
11158           description: Response codes found in [response codes](https://wiki.onap.org/).
11159       parameters:
11160         - name: hostname
11161           in: path
11162           description: Value from executing hostname on the compute node.
11163           required: true
11164           type: string
11165           example: __HOSTNAME__
11166         - name: interface-name
11167           in: path
11168           description: Name that identifies the link aggregate interface
11169           required: true
11170           type: string
11171           example: __INTERFACE-NAME__
11172         - name: interface-name
11173           in: path
11174           description: Name given to the interface
11175           required: true
11176           type: string
11177           example: __INTERFACE-NAME__
11178         - name: vlan-interface
11179           in: path
11180           description: String that identifies the interface
11181           required: true
11182           type: string
11183           example: __VLAN-INTERFACE__
11184         - name: l3-interface-ipv6-address
11185           in: path
11186           description: IP address
11187           required: true
11188           type: string
11189           example: __L3-INTERFACE-IPV6-ADDRESS__
11190         - name: body
11191           in: body
11192           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11193           required: true
11194           schema:
11195             $ref: "#/definitions/relationship"
11196     delete:
11197       tags:
11198         - CloudInfrastructure
11199       summary: delete an existing relationship
11200       description: delete an existing relationship
11201       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11202       consumes:
11203         - application/json
11204         - application/xml
11205       produces:
11206         - application/json
11207         - application/xml
11208       responses:
11209         "default":
11210           description: Response codes found in [response codes](https://wiki.onap.org/).
11211       parameters:
11212         - name: hostname
11213           in: path
11214           description: Value from executing hostname on the compute node.
11215           required: true
11216           type: string
11217           example: __HOSTNAME__
11218         - name: interface-name
11219           in: path
11220           description: Name that identifies the link aggregate interface
11221           required: true
11222           type: string
11223           example: __INTERFACE-NAME__
11224         - name: interface-name
11225           in: path
11226           description: Name given to the interface
11227           required: true
11228           type: string
11229           example: __INTERFACE-NAME__
11230         - name: vlan-interface
11231           in: path
11232           description: String that identifies the interface
11233           required: true
11234           type: string
11235           example: __VLAN-INTERFACE__
11236         - name: l3-interface-ipv6-address
11237           in: path
11238           description: IP address
11239           required: true
11240           type: string
11241           example: __L3-INTERFACE-IPV6-ADDRESS__
11242   /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}:
11243     get:
11244       tags:
11245         - CloudInfrastructure
11246       summary: returns l3-interface-ipv6-address-list
11247       description: returns l3-interface-ipv6-address-list
11248       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11249       produces:
11250         - application/json
11251         - application/xml
11252       responses:
11253         "200":
11254           description: successful operation
11255           schema:
11256               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11257         "default":
11258           description: Response codes found in [response codes](https://wiki.onap.org/).
11259       parameters:
11260         - name: hostname
11261           in: path
11262           description: Value from executing hostname on the compute node.
11263           required: true
11264           type: string
11265           example: __HOSTNAME__
11266         - name: interface-name
11267           in: path
11268           description: Name that identifies the link aggregate interface
11269           required: true
11270           type: string
11271           example: __INTERFACE-NAME__
11272         - name: interface-name
11273           in: path
11274           description: Name given to the interface
11275           required: true
11276           type: string
11277           example: __INTERFACE-NAME__
11278         - name: vlan-interface
11279           in: path
11280           description: String that identifies the interface
11281           required: true
11282           type: string
11283           example: __VLAN-INTERFACE__
11284         - name: l3-interface-ipv6-address
11285           in: path
11286           description: IP address
11287           required: true
11288           type: string
11289           example: __L3-INTERFACE-IPV6-ADDRESS__
11290     put:
11291       tags:
11292         - CloudInfrastructure
11293       summary: create or update an existing l3-interface-ipv6-address-list
11294       description: |
11295         Create or update an existing l3-interface-ipv6-address-list.
11296         #
11297         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11298       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11299       consumes:
11300         - application/json
11301         - application/xml
11302       produces:
11303         - application/json
11304         - application/xml
11305       responses:
11306         "default":
11307           description: Response codes found in [response codes](https://wiki.onap.org/).
11308       parameters:
11309         - name: hostname
11310           in: path
11311           description: Value from executing hostname on the compute node.
11312           required: true
11313           type: string
11314           example: __HOSTNAME__
11315         - name: interface-name
11316           in: path
11317           description: Name that identifies the link aggregate interface
11318           required: true
11319           type: string
11320           example: __INTERFACE-NAME__
11321         - name: interface-name
11322           in: path
11323           description: Name given to the interface
11324           required: true
11325           type: string
11326           example: __INTERFACE-NAME__
11327         - name: vlan-interface
11328           in: path
11329           description: String that identifies the interface
11330           required: true
11331           type: string
11332           example: __VLAN-INTERFACE__
11333         - name: l3-interface-ipv6-address
11334           in: path
11335           description: IP address
11336           required: true
11337           type: string
11338           example: __L3-INTERFACE-IPV6-ADDRESS__
11339         - name: body
11340           in: body
11341           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11342           required: true
11343           schema:
11344             $ref: "#/definitions/l3-interface-ipv6-address-list"
11345     patch:
11346       tags:
11347         - CloudInfrastructure
11348       summary: update an existing l3-interface-ipv6-address-list
11349       description: |
11350         Update an existing l3-interface-ipv6-address-list
11351         #
11352         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11353         The PUT operation will entirely replace an existing object.
11354         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11355         #
11356         Other differences between PUT and PATCH are:
11357         #
11358         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11359         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11360         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11361       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11362       consumes:
11363         - application/json
11364         - application/xml
11365       produces:
11366         - application/json
11367         - application/xml
11368       responses:
11369         "default":
11370           description: Response codes found in [response codes](https://wiki.onap.org/).
11371       parameters:
11372         - name: hostname
11373           in: path
11374           description: Value from executing hostname on the compute node.
11375           required: true
11376           type: string
11377           example: __HOSTNAME__
11378         - name: interface-name
11379           in: path
11380           description: Name that identifies the link aggregate interface
11381           required: true
11382           type: string
11383           example: __INTERFACE-NAME__
11384         - name: interface-name
11385           in: path
11386           description: Name given to the interface
11387           required: true
11388           type: string
11389           example: __INTERFACE-NAME__
11390         - name: vlan-interface
11391           in: path
11392           description: String that identifies the interface
11393           required: true
11394           type: string
11395           example: __VLAN-INTERFACE__
11396         - name: l3-interface-ipv6-address
11397           in: path
11398           description: IP address
11399           required: true
11400           type: string
11401           example: __L3-INTERFACE-IPV6-ADDRESS__
11402         - name: body
11403           in: body
11404           description: l3-interface-ipv6-address-list object that needs to be updated.
11405           required: true
11406           schema:
11407             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11408     delete:
11409       tags:
11410         - CloudInfrastructure
11411       summary: delete an existing l3-interface-ipv6-address-list
11412       description: delete an existing l3-interface-ipv6-address-list
11413       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11414       consumes:
11415         - application/json
11416         - application/xml
11417       produces:
11418         - application/json
11419         - application/xml
11420       responses:
11421         "default":
11422           description: Response codes found in [response codes](https://wiki.onap.org/).
11423       parameters:
11424         - name: hostname
11425           in: path
11426           description: Value from executing hostname on the compute node.
11427           required: true
11428           type: string
11429           example: __HOSTNAME__
11430         - name: interface-name
11431           in: path
11432           description: Name that identifies the link aggregate interface
11433           required: true
11434           type: string
11435           example: __INTERFACE-NAME__
11436         - name: interface-name
11437           in: path
11438           description: Name given to the interface
11439           required: true
11440           type: string
11441           example: __INTERFACE-NAME__
11442         - name: vlan-interface
11443           in: path
11444           description: String that identifies the interface
11445           required: true
11446           type: string
11447           example: __VLAN-INTERFACE__
11448         - name: l3-interface-ipv6-address
11449           in: path
11450           description: IP address
11451           required: true
11452           type: string
11453           example: __L3-INTERFACE-IPV6-ADDRESS__
11454         - name: resource-version
11455           in: query
11456           description: resource-version for concurrency
11457           required: true
11458           type: string
11459   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11460     get:
11461       tags:
11462         - CloudInfrastructure
11463       summary: returns vlan
11464       description: returns vlan
11465       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11466       produces:
11467         - application/json
11468         - application/xml
11469       responses:
11470         "200":
11471           description: successful operation
11472           schema:
11473               $ref: "#/getDefinitions/vlan"
11474         "default":
11475           description: Response codes found in [response codes](https://wiki.onap.org/).
11476       parameters:
11477         - name: hostname
11478           in: path
11479           description: Value from executing hostname on the compute node.
11480           required: true
11481           type: string
11482           example: __HOSTNAME__
11483         - name: interface-name
11484           in: path
11485           description: Name that identifies the link aggregate interface
11486           required: true
11487           type: string
11488           example: __INTERFACE-NAME__
11489         - name: interface-name
11490           in: path
11491           description: Name given to the interface
11492           required: true
11493           type: string
11494           example: __INTERFACE-NAME__
11495         - name: vlan-interface
11496           in: path
11497           description: String that identifies the interface
11498           required: true
11499           type: string
11500           example: __VLAN-INTERFACE__
11501     put:
11502       tags:
11503         - CloudInfrastructure
11504       summary: create or update an existing vlan
11505       description: |
11506         Create or update an existing vlan.
11507         #
11508         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11509       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11510       consumes:
11511         - application/json
11512         - application/xml
11513       produces:
11514         - application/json
11515         - application/xml
11516       responses:
11517         "default":
11518           description: Response codes found in [response codes](https://wiki.onap.org/).
11519       parameters:
11520         - name: hostname
11521           in: path
11522           description: Value from executing hostname on the compute node.
11523           required: true
11524           type: string
11525           example: __HOSTNAME__
11526         - name: interface-name
11527           in: path
11528           description: Name that identifies the link aggregate interface
11529           required: true
11530           type: string
11531           example: __INTERFACE-NAME__
11532         - name: interface-name
11533           in: path
11534           description: Name given to the interface
11535           required: true
11536           type: string
11537           example: __INTERFACE-NAME__
11538         - name: vlan-interface
11539           in: path
11540           description: String that identifies the interface
11541           required: true
11542           type: string
11543           example: __VLAN-INTERFACE__
11544         - name: body
11545           in: body
11546           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11547           required: true
11548           schema:
11549             $ref: "#/definitions/vlan"
11550     patch:
11551       tags:
11552         - CloudInfrastructure
11553       summary: update an existing vlan
11554       description: |
11555         Update an existing vlan
11556         #
11557         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11558         The PUT operation will entirely replace an existing object.
11559         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11560         #
11561         Other differences between PUT and PATCH are:
11562         #
11563         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11564         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11565         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11566       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11567       consumes:
11568         - application/json
11569         - application/xml
11570       produces:
11571         - application/json
11572         - application/xml
11573       responses:
11574         "default":
11575           description: Response codes found in [response codes](https://wiki.onap.org/).
11576       parameters:
11577         - name: hostname
11578           in: path
11579           description: Value from executing hostname on the compute node.
11580           required: true
11581           type: string
11582           example: __HOSTNAME__
11583         - name: interface-name
11584           in: path
11585           description: Name that identifies the link aggregate interface
11586           required: true
11587           type: string
11588           example: __INTERFACE-NAME__
11589         - name: interface-name
11590           in: path
11591           description: Name given to the interface
11592           required: true
11593           type: string
11594           example: __INTERFACE-NAME__
11595         - name: vlan-interface
11596           in: path
11597           description: String that identifies the interface
11598           required: true
11599           type: string
11600           example: __VLAN-INTERFACE__
11601         - name: body
11602           in: body
11603           description: vlan object that needs to be updated.
11604           required: true
11605           schema:
11606             $ref: "#/patchDefinitions/vlan"
11607     delete:
11608       tags:
11609         - CloudInfrastructure
11610       summary: delete an existing vlan
11611       description: delete an existing vlan
11612       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11613       consumes:
11614         - application/json
11615         - application/xml
11616       produces:
11617         - application/json
11618         - application/xml
11619       responses:
11620         "default":
11621           description: Response codes found in [response codes](https://wiki.onap.org/).
11622       parameters:
11623         - name: hostname
11624           in: path
11625           description: Value from executing hostname on the compute node.
11626           required: true
11627           type: string
11628           example: __HOSTNAME__
11629         - name: interface-name
11630           in: path
11631           description: Name that identifies the link aggregate interface
11632           required: true
11633           type: string
11634           example: __INTERFACE-NAME__
11635         - name: interface-name
11636           in: path
11637           description: Name given to the interface
11638           required: true
11639           type: string
11640           example: __INTERFACE-NAME__
11641         - name: vlan-interface
11642           in: path
11643           description: String that identifies the interface
11644           required: true
11645           type: string
11646           example: __VLAN-INTERFACE__
11647         - name: resource-version
11648           in: query
11649           description: resource-version for concurrency
11650           required: true
11651           type: string
11652   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11653     get:
11654       tags:
11655         - CloudInfrastructure
11656       summary: returns vlans
11657       description: returns vlans
11658       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
11659       produces:
11660         - application/json
11661         - application/xml
11662       responses:
11663         "200":
11664           description: successful operation
11665           schema:
11666               $ref: "#/getDefinitions/vlans"
11667         "default":
11668           description: Response codes found in [response codes](https://wiki.onap.org/).
11669       parameters:
11670         - name: hostname
11671           in: path
11672           description: Value from executing hostname on the compute node.
11673           required: true
11674           type: string
11675           example: __HOSTNAME__
11676         - name: interface-name
11677           in: path
11678           description: Name that identifies the link aggregate interface
11679           required: true
11680           type: string
11681           example: __INTERFACE-NAME__
11682         - name: interface-name
11683           in: path
11684           description: Name given to the interface
11685           required: true
11686           type: string
11687           example: __INTERFACE-NAME__
11688         - name: vlan-interface
11689           in: query
11690           description:
11691           required: false
11692           type: string
11693         - name: vlan-id-inner
11694           in: query
11695           description:
11696           required: false
11697           type: integer
11698           format: int64
11699         - name: vpn-key
11700           in: query
11701           description:
11702           required: false
11703           type: string
11704   /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:
11705     put:
11706       tags:
11707         - CloudInfrastructure
11708       summary: see node definition for valid relationships
11709       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11710       consumes:
11711         - application/json
11712         - application/xml
11713       produces:
11714         - application/json
11715         - application/xml
11716       responses:
11717         "default":
11718           description: Response codes found in [response codes](https://wiki.onap.org/).
11719       parameters:
11720         - name: hostname
11721           in: path
11722           description: Value from executing hostname on the compute node.
11723           required: true
11724           type: string
11725           example: __HOSTNAME__
11726         - name: interface-name
11727           in: path
11728           description: Name that identifies the link aggregate interface
11729           required: true
11730           type: string
11731           example: __INTERFACE-NAME__
11732         - name: interface-name
11733           in: path
11734           description: Name given to the interface
11735           required: true
11736           type: string
11737           example: __INTERFACE-NAME__
11738         - name: pci-id
11739           in: path
11740           description: PCI ID used to identify the sriov-vf
11741           required: true
11742           type: string
11743           example: __PCI-ID__
11744         - name: body
11745           in: body
11746           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11747           required: true
11748           schema:
11749             $ref: "#/definitions/relationship"
11750     delete:
11751       tags:
11752         - CloudInfrastructure
11753       summary: delete an existing relationship
11754       description: delete an existing relationship
11755       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11756       consumes:
11757         - application/json
11758         - application/xml
11759       produces:
11760         - application/json
11761         - application/xml
11762       responses:
11763         "default":
11764           description: Response codes found in [response codes](https://wiki.onap.org/).
11765       parameters:
11766         - name: hostname
11767           in: path
11768           description: Value from executing hostname on the compute node.
11769           required: true
11770           type: string
11771           example: __HOSTNAME__
11772         - name: interface-name
11773           in: path
11774           description: Name that identifies the link aggregate interface
11775           required: true
11776           type: string
11777           example: __INTERFACE-NAME__
11778         - name: interface-name
11779           in: path
11780           description: Name given to the interface
11781           required: true
11782           type: string
11783           example: __INTERFACE-NAME__
11784         - name: pci-id
11785           in: path
11786           description: PCI ID used to identify the sriov-vf
11787           required: true
11788           type: string
11789           example: __PCI-ID__
11790   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
11791     get:
11792       tags:
11793         - CloudInfrastructure
11794       summary: returns sriov-vf
11795       description: returns sriov-vf
11796       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11797       produces:
11798         - application/json
11799         - application/xml
11800       responses:
11801         "200":
11802           description: successful operation
11803           schema:
11804               $ref: "#/getDefinitions/sriov-vf"
11805         "default":
11806           description: Response codes found in [response codes](https://wiki.onap.org/).
11807       parameters:
11808         - name: hostname
11809           in: path
11810           description: Value from executing hostname on the compute node.
11811           required: true
11812           type: string
11813           example: __HOSTNAME__
11814         - name: interface-name
11815           in: path
11816           description: Name that identifies the link aggregate interface
11817           required: true
11818           type: string
11819           example: __INTERFACE-NAME__
11820         - name: interface-name
11821           in: path
11822           description: Name given to the interface
11823           required: true
11824           type: string
11825           example: __INTERFACE-NAME__
11826         - name: pci-id
11827           in: path
11828           description: PCI ID used to identify the sriov-vf
11829           required: true
11830           type: string
11831           example: __PCI-ID__
11832     put:
11833       tags:
11834         - CloudInfrastructure
11835       summary: create or update an existing sriov-vf
11836       description: |
11837         Create or update an existing sriov-vf.
11838         #
11839         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11840       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11841       consumes:
11842         - application/json
11843         - application/xml
11844       produces:
11845         - application/json
11846         - application/xml
11847       responses:
11848         "default":
11849           description: Response codes found in [response codes](https://wiki.onap.org/).
11850       parameters:
11851         - name: hostname
11852           in: path
11853           description: Value from executing hostname on the compute node.
11854           required: true
11855           type: string
11856           example: __HOSTNAME__
11857         - name: interface-name
11858           in: path
11859           description: Name that identifies the link aggregate interface
11860           required: true
11861           type: string
11862           example: __INTERFACE-NAME__
11863         - name: interface-name
11864           in: path
11865           description: Name given to the interface
11866           required: true
11867           type: string
11868           example: __INTERFACE-NAME__
11869         - name: pci-id
11870           in: path
11871           description: PCI ID used to identify the sriov-vf
11872           required: true
11873           type: string
11874           example: __PCI-ID__
11875         - name: body
11876           in: body
11877           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11878           required: true
11879           schema:
11880             $ref: "#/definitions/sriov-vf"
11881     patch:
11882       tags:
11883         - CloudInfrastructure
11884       summary: update an existing sriov-vf
11885       description: |
11886         Update an existing sriov-vf
11887         #
11888         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11889         The PUT operation will entirely replace an existing object.
11890         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11891         #
11892         Other differences between PUT and PATCH are:
11893         #
11894         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11895         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11896         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11897       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11898       consumes:
11899         - application/json
11900         - application/xml
11901       produces:
11902         - application/json
11903         - application/xml
11904       responses:
11905         "default":
11906           description: Response codes found in [response codes](https://wiki.onap.org/).
11907       parameters:
11908         - name: hostname
11909           in: path
11910           description: Value from executing hostname on the compute node.
11911           required: true
11912           type: string
11913           example: __HOSTNAME__
11914         - name: interface-name
11915           in: path
11916           description: Name that identifies the link aggregate interface
11917           required: true
11918           type: string
11919           example: __INTERFACE-NAME__
11920         - name: interface-name
11921           in: path
11922           description: Name given to the interface
11923           required: true
11924           type: string
11925           example: __INTERFACE-NAME__
11926         - name: pci-id
11927           in: path
11928           description: PCI ID used to identify the sriov-vf
11929           required: true
11930           type: string
11931           example: __PCI-ID__
11932         - name: body
11933           in: body
11934           description: sriov-vf object that needs to be updated.
11935           required: true
11936           schema:
11937             $ref: "#/patchDefinitions/sriov-vf"
11938     delete:
11939       tags:
11940         - CloudInfrastructure
11941       summary: delete an existing sriov-vf
11942       description: delete an existing sriov-vf
11943       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11944       consumes:
11945         - application/json
11946         - application/xml
11947       produces:
11948         - application/json
11949         - application/xml
11950       responses:
11951         "default":
11952           description: Response codes found in [response codes](https://wiki.onap.org/).
11953       parameters:
11954         - name: hostname
11955           in: path
11956           description: Value from executing hostname on the compute node.
11957           required: true
11958           type: string
11959           example: __HOSTNAME__
11960         - name: interface-name
11961           in: path
11962           description: Name that identifies the link aggregate interface
11963           required: true
11964           type: string
11965           example: __INTERFACE-NAME__
11966         - name: interface-name
11967           in: path
11968           description: Name given to the interface
11969           required: true
11970           type: string
11971           example: __INTERFACE-NAME__
11972         - name: pci-id
11973           in: path
11974           description: PCI ID used to identify the sriov-vf
11975           required: true
11976           type: string
11977           example: __PCI-ID__
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/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
11984     get:
11985       tags:
11986         - CloudInfrastructure
11987       summary: returns sriov-vfs
11988       description: returns sriov-vfs
11989       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
11990       produces:
11991         - application/json
11992         - application/xml
11993       responses:
11994         "200":
11995           description: successful operation
11996           schema:
11997               $ref: "#/getDefinitions/sriov-vfs"
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: path
12009           description: Name that identifies the link aggregate interface
12010           required: true
12011           type: string
12012           example: __INTERFACE-NAME__
12013         - name: interface-name
12014           in: path
12015           description: Name given to the interface
12016           required: true
12017           type: string
12018           example: __INTERFACE-NAME__
12019         - name: pci-id
12020           in: query
12021           description:
12022           required: false
12023           type: string
12024         - name: vf-vlan-filter
12025           in: query
12026           description:
12027           required: false
12028           type: string
12029         - name: vf-mac-filter
12030           in: query
12031           description:
12032           required: false
12033           type: string
12034         - name: vf-vlan-strip
12035           in: query
12036           description:
12037           required: false
12038           type: boolean
12039         - name: neutron-network-id
12040           in: query
12041           description:
12042           required: false
12043           type: string
12044   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12045     put:
12046       tags:
12047         - CloudInfrastructure
12048       summary: see node definition for valid relationships
12049       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12050       consumes:
12051         - application/json
12052         - application/xml
12053       produces:
12054         - application/json
12055         - application/xml
12056       responses:
12057         "default":
12058           description: Response codes found in [response codes](https://wiki.onap.org/).
12059       parameters:
12060         - name: hostname
12061           in: path
12062           description: Value from executing hostname on the compute node.
12063           required: true
12064           type: string
12065           example: __HOSTNAME__
12066         - name: interface-name
12067           in: path
12068           description: Name that identifies the link aggregate interface
12069           required: true
12070           type: string
12071           example: __INTERFACE-NAME__
12072         - name: interface-name
12073           in: path
12074           description: Name given to the interface
12075           required: true
12076           type: string
12077           example: __INTERFACE-NAME__
12078         - name: body
12079           in: body
12080           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12081           required: true
12082           schema:
12083             $ref: "#/definitions/relationship"
12084     delete:
12085       tags:
12086         - CloudInfrastructure
12087       summary: delete an existing relationship
12088       description: delete an existing relationship
12089       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12090       consumes:
12091         - application/json
12092         - application/xml
12093       produces:
12094         - application/json
12095         - application/xml
12096       responses:
12097         "default":
12098           description: Response codes found in [response codes](https://wiki.onap.org/).
12099       parameters:
12100         - name: hostname
12101           in: path
12102           description: Value from executing hostname on the compute node.
12103           required: true
12104           type: string
12105           example: __HOSTNAME__
12106         - name: interface-name
12107           in: path
12108           description: Name that identifies the link aggregate interface
12109           required: true
12110           type: string
12111           example: __INTERFACE-NAME__
12112         - name: interface-name
12113           in: path
12114           description: Name given to the interface
12115           required: true
12116           type: string
12117           example: __INTERFACE-NAME__
12118   /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:
12119     put:
12120       tags:
12121         - CloudInfrastructure
12122       summary: see node definition for valid relationships
12123       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12124       consumes:
12125         - application/json
12126         - application/xml
12127       produces:
12128         - application/json
12129         - application/xml
12130       responses:
12131         "default":
12132           description: Response codes found in [response codes](https://wiki.onap.org/).
12133       parameters:
12134         - name: hostname
12135           in: path
12136           description: Value from executing hostname on the compute node.
12137           required: true
12138           type: string
12139           example: __HOSTNAME__
12140         - name: interface-name
12141           in: path
12142           description: Name that identifies the link aggregate interface
12143           required: true
12144           type: string
12145           example: __INTERFACE-NAME__
12146         - name: interface-name
12147           in: path
12148           description: Name given to the interface
12149           required: true
12150           type: string
12151           example: __INTERFACE-NAME__
12152         - name: l3-interface-ipv4-address
12153           in: path
12154           description: IP address
12155           required: true
12156           type: string
12157           example: __L3-INTERFACE-IPV4-ADDRESS__
12158         - name: body
12159           in: body
12160           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12161           required: true
12162           schema:
12163             $ref: "#/definitions/relationship"
12164     delete:
12165       tags:
12166         - CloudInfrastructure
12167       summary: delete an existing relationship
12168       description: delete an existing relationship
12169       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12170       consumes:
12171         - application/json
12172         - application/xml
12173       produces:
12174         - application/json
12175         - application/xml
12176       responses:
12177         "default":
12178           description: Response codes found in [response codes](https://wiki.onap.org/).
12179       parameters:
12180         - name: hostname
12181           in: path
12182           description: Value from executing hostname on the compute node.
12183           required: true
12184           type: string
12185           example: __HOSTNAME__
12186         - name: interface-name
12187           in: path
12188           description: Name that identifies the link aggregate interface
12189           required: true
12190           type: string
12191           example: __INTERFACE-NAME__
12192         - name: interface-name
12193           in: path
12194           description: Name given to the interface
12195           required: true
12196           type: string
12197           example: __INTERFACE-NAME__
12198         - name: l3-interface-ipv4-address
12199           in: path
12200           description: IP address
12201           required: true
12202           type: string
12203           example: __L3-INTERFACE-IPV4-ADDRESS__
12204   /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}:
12205     get:
12206       tags:
12207         - CloudInfrastructure
12208       summary: returns l3-interface-ipv4-address-list
12209       description: returns l3-interface-ipv4-address-list
12210       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12211       produces:
12212         - application/json
12213         - application/xml
12214       responses:
12215         "200":
12216           description: successful operation
12217           schema:
12218               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12219         "default":
12220           description: Response codes found in [response codes](https://wiki.onap.org/).
12221       parameters:
12222         - name: hostname
12223           in: path
12224           description: Value from executing hostname on the compute node.
12225           required: true
12226           type: string
12227           example: __HOSTNAME__
12228         - name: interface-name
12229           in: path
12230           description: Name that identifies the link aggregate interface
12231           required: true
12232           type: string
12233           example: __INTERFACE-NAME__
12234         - name: interface-name
12235           in: path
12236           description: Name given to the interface
12237           required: true
12238           type: string
12239           example: __INTERFACE-NAME__
12240         - name: l3-interface-ipv4-address
12241           in: path
12242           description: IP address
12243           required: true
12244           type: string
12245           example: __L3-INTERFACE-IPV4-ADDRESS__
12246     put:
12247       tags:
12248         - CloudInfrastructure
12249       summary: create or update an existing l3-interface-ipv4-address-list
12250       description: |
12251         Create or update an existing l3-interface-ipv4-address-list.
12252         #
12253         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12254       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12255       consumes:
12256         - application/json
12257         - application/xml
12258       produces:
12259         - application/json
12260         - application/xml
12261       responses:
12262         "default":
12263           description: Response codes found in [response codes](https://wiki.onap.org/).
12264       parameters:
12265         - name: hostname
12266           in: path
12267           description: Value from executing hostname on the compute node.
12268           required: true
12269           type: string
12270           example: __HOSTNAME__
12271         - name: interface-name
12272           in: path
12273           description: Name that identifies the link aggregate interface
12274           required: true
12275           type: string
12276           example: __INTERFACE-NAME__
12277         - name: interface-name
12278           in: path
12279           description: Name given to the interface
12280           required: true
12281           type: string
12282           example: __INTERFACE-NAME__
12283         - name: l3-interface-ipv4-address
12284           in: path
12285           description: IP address
12286           required: true
12287           type: string
12288           example: __L3-INTERFACE-IPV4-ADDRESS__
12289         - name: body
12290           in: body
12291           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12292           required: true
12293           schema:
12294             $ref: "#/definitions/l3-interface-ipv4-address-list"
12295     patch:
12296       tags:
12297         - CloudInfrastructure
12298       summary: update an existing l3-interface-ipv4-address-list
12299       description: |
12300         Update an existing l3-interface-ipv4-address-list
12301         #
12302         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12303         The PUT operation will entirely replace an existing object.
12304         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12305         #
12306         Other differences between PUT and PATCH are:
12307         #
12308         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12309         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12310         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12311       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12312       consumes:
12313         - application/json
12314         - application/xml
12315       produces:
12316         - application/json
12317         - application/xml
12318       responses:
12319         "default":
12320           description: Response codes found in [response codes](https://wiki.onap.org/).
12321       parameters:
12322         - name: hostname
12323           in: path
12324           description: Value from executing hostname on the compute node.
12325           required: true
12326           type: string
12327           example: __HOSTNAME__
12328         - name: interface-name
12329           in: path
12330           description: Name that identifies the link aggregate interface
12331           required: true
12332           type: string
12333           example: __INTERFACE-NAME__
12334         - name: interface-name
12335           in: path
12336           description: Name given to the interface
12337           required: true
12338           type: string
12339           example: __INTERFACE-NAME__
12340         - name: l3-interface-ipv4-address
12341           in: path
12342           description: IP address
12343           required: true
12344           type: string
12345           example: __L3-INTERFACE-IPV4-ADDRESS__
12346         - name: body
12347           in: body
12348           description: l3-interface-ipv4-address-list object that needs to be updated.
12349           required: true
12350           schema:
12351             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12352     delete:
12353       tags:
12354         - CloudInfrastructure
12355       summary: delete an existing l3-interface-ipv4-address-list
12356       description: delete an existing l3-interface-ipv4-address-list
12357       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12358       consumes:
12359         - application/json
12360         - application/xml
12361       produces:
12362         - application/json
12363         - application/xml
12364       responses:
12365         "default":
12366           description: Response codes found in [response codes](https://wiki.onap.org/).
12367       parameters:
12368         - name: hostname
12369           in: path
12370           description: Value from executing hostname on the compute node.
12371           required: true
12372           type: string
12373           example: __HOSTNAME__
12374         - name: interface-name
12375           in: path
12376           description: Name that identifies the link aggregate interface
12377           required: true
12378           type: string
12379           example: __INTERFACE-NAME__
12380         - name: interface-name
12381           in: path
12382           description: Name given to the interface
12383           required: true
12384           type: string
12385           example: __INTERFACE-NAME__
12386         - name: l3-interface-ipv4-address
12387           in: path
12388           description: IP address
12389           required: true
12390           type: string
12391           example: __L3-INTERFACE-IPV4-ADDRESS__
12392         - name: resource-version
12393           in: query
12394           description: resource-version for concurrency
12395           required: true
12396           type: string
12397   /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:
12398     put:
12399       tags:
12400         - CloudInfrastructure
12401       summary: see node definition for valid relationships
12402       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12403       consumes:
12404         - application/json
12405         - application/xml
12406       produces:
12407         - application/json
12408         - application/xml
12409       responses:
12410         "default":
12411           description: Response codes found in [response codes](https://wiki.onap.org/).
12412       parameters:
12413         - name: hostname
12414           in: path
12415           description: Value from executing hostname on the compute node.
12416           required: true
12417           type: string
12418           example: __HOSTNAME__
12419         - name: interface-name
12420           in: path
12421           description: Name that identifies the link aggregate interface
12422           required: true
12423           type: string
12424           example: __INTERFACE-NAME__
12425         - name: interface-name
12426           in: path
12427           description: Name given to the interface
12428           required: true
12429           type: string
12430           example: __INTERFACE-NAME__
12431         - name: l3-interface-ipv6-address
12432           in: path
12433           description: IP address
12434           required: true
12435           type: string
12436           example: __L3-INTERFACE-IPV6-ADDRESS__
12437         - name: body
12438           in: body
12439           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12440           required: true
12441           schema:
12442             $ref: "#/definitions/relationship"
12443     delete:
12444       tags:
12445         - CloudInfrastructure
12446       summary: delete an existing relationship
12447       description: delete an existing relationship
12448       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12449       consumes:
12450         - application/json
12451         - application/xml
12452       produces:
12453         - application/json
12454         - application/xml
12455       responses:
12456         "default":
12457           description: Response codes found in [response codes](https://wiki.onap.org/).
12458       parameters:
12459         - name: hostname
12460           in: path
12461           description: Value from executing hostname on the compute node.
12462           required: true
12463           type: string
12464           example: __HOSTNAME__
12465         - name: interface-name
12466           in: path
12467           description: Name that identifies the link aggregate interface
12468           required: true
12469           type: string
12470           example: __INTERFACE-NAME__
12471         - name: interface-name
12472           in: path
12473           description: Name given to the interface
12474           required: true
12475           type: string
12476           example: __INTERFACE-NAME__
12477         - name: l3-interface-ipv6-address
12478           in: path
12479           description: IP address
12480           required: true
12481           type: string
12482           example: __L3-INTERFACE-IPV6-ADDRESS__
12483   /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}:
12484     get:
12485       tags:
12486         - CloudInfrastructure
12487       summary: returns l3-interface-ipv6-address-list
12488       description: returns l3-interface-ipv6-address-list
12489       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12490       produces:
12491         - application/json
12492         - application/xml
12493       responses:
12494         "200":
12495           description: successful operation
12496           schema:
12497               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12498         "default":
12499           description: Response codes found in [response codes](https://wiki.onap.org/).
12500       parameters:
12501         - name: hostname
12502           in: path
12503           description: Value from executing hostname on the compute node.
12504           required: true
12505           type: string
12506           example: __HOSTNAME__
12507         - name: interface-name
12508           in: path
12509           description: Name that identifies the link aggregate interface
12510           required: true
12511           type: string
12512           example: __INTERFACE-NAME__
12513         - name: interface-name
12514           in: path
12515           description: Name given to the interface
12516           required: true
12517           type: string
12518           example: __INTERFACE-NAME__
12519         - name: l3-interface-ipv6-address
12520           in: path
12521           description: IP address
12522           required: true
12523           type: string
12524           example: __L3-INTERFACE-IPV6-ADDRESS__
12525     put:
12526       tags:
12527         - CloudInfrastructure
12528       summary: create or update an existing l3-interface-ipv6-address-list
12529       description: |
12530         Create or update an existing l3-interface-ipv6-address-list.
12531         #
12532         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12533       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12534       consumes:
12535         - application/json
12536         - application/xml
12537       produces:
12538         - application/json
12539         - application/xml
12540       responses:
12541         "default":
12542           description: Response codes found in [response codes](https://wiki.onap.org/).
12543       parameters:
12544         - name: hostname
12545           in: path
12546           description: Value from executing hostname on the compute node.
12547           required: true
12548           type: string
12549           example: __HOSTNAME__
12550         - name: interface-name
12551           in: path
12552           description: Name that identifies the link aggregate interface
12553           required: true
12554           type: string
12555           example: __INTERFACE-NAME__
12556         - name: interface-name
12557           in: path
12558           description: Name given to the interface
12559           required: true
12560           type: string
12561           example: __INTERFACE-NAME__
12562         - name: l3-interface-ipv6-address
12563           in: path
12564           description: IP address
12565           required: true
12566           type: string
12567           example: __L3-INTERFACE-IPV6-ADDRESS__
12568         - name: body
12569           in: body
12570           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12571           required: true
12572           schema:
12573             $ref: "#/definitions/l3-interface-ipv6-address-list"
12574     patch:
12575       tags:
12576         - CloudInfrastructure
12577       summary: update an existing l3-interface-ipv6-address-list
12578       description: |
12579         Update an existing l3-interface-ipv6-address-list
12580         #
12581         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12582         The PUT operation will entirely replace an existing object.
12583         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12584         #
12585         Other differences between PUT and PATCH are:
12586         #
12587         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12588         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12589         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12590       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12591       consumes:
12592         - application/json
12593         - application/xml
12594       produces:
12595         - application/json
12596         - application/xml
12597       responses:
12598         "default":
12599           description: Response codes found in [response codes](https://wiki.onap.org/).
12600       parameters:
12601         - name: hostname
12602           in: path
12603           description: Value from executing hostname on the compute node.
12604           required: true
12605           type: string
12606           example: __HOSTNAME__
12607         - name: interface-name
12608           in: path
12609           description: Name that identifies the link aggregate interface
12610           required: true
12611           type: string
12612           example: __INTERFACE-NAME__
12613         - name: interface-name
12614           in: path
12615           description: Name given to the interface
12616           required: true
12617           type: string
12618           example: __INTERFACE-NAME__
12619         - name: l3-interface-ipv6-address
12620           in: path
12621           description: IP address
12622           required: true
12623           type: string
12624           example: __L3-INTERFACE-IPV6-ADDRESS__
12625         - name: body
12626           in: body
12627           description: l3-interface-ipv6-address-list object that needs to be updated.
12628           required: true
12629           schema:
12630             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12631     delete:
12632       tags:
12633         - CloudInfrastructure
12634       summary: delete an existing l3-interface-ipv6-address-list
12635       description: delete an existing l3-interface-ipv6-address-list
12636       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12637       consumes:
12638         - application/json
12639         - application/xml
12640       produces:
12641         - application/json
12642         - application/xml
12643       responses:
12644         "default":
12645           description: Response codes found in [response codes](https://wiki.onap.org/).
12646       parameters:
12647         - name: hostname
12648           in: path
12649           description: Value from executing hostname on the compute node.
12650           required: true
12651           type: string
12652           example: __HOSTNAME__
12653         - name: interface-name
12654           in: path
12655           description: Name that identifies the link aggregate interface
12656           required: true
12657           type: string
12658           example: __INTERFACE-NAME__
12659         - name: interface-name
12660           in: path
12661           description: Name given to the interface
12662           required: true
12663           type: string
12664           example: __INTERFACE-NAME__
12665         - name: l3-interface-ipv6-address
12666           in: path
12667           description: IP address
12668           required: true
12669           type: string
12670           example: __L3-INTERFACE-IPV6-ADDRESS__
12671         - name: resource-version
12672           in: query
12673           description: resource-version for concurrency
12674           required: true
12675           type: string
12676   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
12677     get:
12678       tags:
12679         - CloudInfrastructure
12680       summary: returns l-interface
12681       description: returns l-interface
12682       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12683       produces:
12684         - application/json
12685         - application/xml
12686       responses:
12687         "200":
12688           description: successful operation
12689           schema:
12690               $ref: "#/getDefinitions/l-interface"
12691         "default":
12692           description: Response codes found in [response codes](https://wiki.onap.org/).
12693       parameters:
12694         - name: hostname
12695           in: path
12696           description: Value from executing hostname on the compute node.
12697           required: true
12698           type: string
12699           example: __HOSTNAME__
12700         - name: interface-name
12701           in: path
12702           description: Name that identifies the link aggregate interface
12703           required: true
12704           type: string
12705           example: __INTERFACE-NAME__
12706         - name: interface-name
12707           in: path
12708           description: Name given to the interface
12709           required: true
12710           type: string
12711           example: __INTERFACE-NAME__
12712     put:
12713       tags:
12714         - CloudInfrastructure
12715       summary: create or update an existing l-interface
12716       description: |
12717         Create or update an existing l-interface.
12718         #
12719         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12720       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12721       consumes:
12722         - application/json
12723         - application/xml
12724       produces:
12725         - application/json
12726         - application/xml
12727       responses:
12728         "default":
12729           description: Response codes found in [response codes](https://wiki.onap.org/).
12730       parameters:
12731         - name: hostname
12732           in: path
12733           description: Value from executing hostname on the compute node.
12734           required: true
12735           type: string
12736           example: __HOSTNAME__
12737         - name: interface-name
12738           in: path
12739           description: Name that identifies the link aggregate interface
12740           required: true
12741           type: string
12742           example: __INTERFACE-NAME__
12743         - name: interface-name
12744           in: path
12745           description: Name given to the interface
12746           required: true
12747           type: string
12748           example: __INTERFACE-NAME__
12749         - name: body
12750           in: body
12751           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12752           required: true
12753           schema:
12754             $ref: "#/definitions/l-interface"
12755     patch:
12756       tags:
12757         - CloudInfrastructure
12758       summary: update an existing l-interface
12759       description: |
12760         Update an existing l-interface
12761         #
12762         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12763         The PUT operation will entirely replace an existing object.
12764         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12765         #
12766         Other differences between PUT and PATCH are:
12767         #
12768         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12769         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12770         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12771       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12772       consumes:
12773         - application/json
12774         - application/xml
12775       produces:
12776         - application/json
12777         - application/xml
12778       responses:
12779         "default":
12780           description: Response codes found in [response codes](https://wiki.onap.org/).
12781       parameters:
12782         - name: hostname
12783           in: path
12784           description: Value from executing hostname on the compute node.
12785           required: true
12786           type: string
12787           example: __HOSTNAME__
12788         - name: interface-name
12789           in: path
12790           description: Name that identifies the link aggregate interface
12791           required: true
12792           type: string
12793           example: __INTERFACE-NAME__
12794         - name: interface-name
12795           in: path
12796           description: Name given to the interface
12797           required: true
12798           type: string
12799           example: __INTERFACE-NAME__
12800         - name: body
12801           in: body
12802           description: l-interface object that needs to be updated.
12803           required: true
12804           schema:
12805             $ref: "#/patchDefinitions/l-interface"
12806     delete:
12807       tags:
12808         - CloudInfrastructure
12809       summary: delete an existing l-interface
12810       description: delete an existing l-interface
12811       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12812       consumes:
12813         - application/json
12814         - application/xml
12815       produces:
12816         - application/json
12817         - application/xml
12818       responses:
12819         "default":
12820           description: Response codes found in [response codes](https://wiki.onap.org/).
12821       parameters:
12822         - name: hostname
12823           in: path
12824           description: Value from executing hostname on the compute node.
12825           required: true
12826           type: string
12827           example: __HOSTNAME__
12828         - name: interface-name
12829           in: path
12830           description: Name that identifies the link aggregate interface
12831           required: true
12832           type: string
12833           example: __INTERFACE-NAME__
12834         - name: interface-name
12835           in: path
12836           description: Name given to the interface
12837           required: true
12838           type: string
12839           example: __INTERFACE-NAME__
12840         - name: resource-version
12841           in: query
12842           description: resource-version for concurrency
12843           required: true
12844           type: string
12845   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
12846     get:
12847       tags:
12848         - CloudInfrastructure
12849       summary: returns l-interfaces
12850       description: returns l-interfaces
12851       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
12852       produces:
12853         - application/json
12854         - application/xml
12855       responses:
12856         "200":
12857           description: successful operation
12858           schema:
12859               $ref: "#/getDefinitions/l-interfaces"
12860         "default":
12861           description: Response codes found in [response codes](https://wiki.onap.org/).
12862       parameters:
12863         - name: hostname
12864           in: path
12865           description: Value from executing hostname on the compute node.
12866           required: true
12867           type: string
12868           example: __HOSTNAME__
12869         - name: interface-name
12870           in: path
12871           description: Name that identifies the link aggregate interface
12872           required: true
12873           type: string
12874           example: __INTERFACE-NAME__
12875         - name: interface-name
12876           in: query
12877           description:
12878           required: false
12879           type: string
12880         - name: interface-id
12881           in: query
12882           description:
12883           required: false
12884           type: string
12885         - name: macaddr
12886           in: query
12887           description:
12888           required: false
12889           type: string
12890         - name: network-name
12891           in: query
12892           description:
12893           required: false
12894           type: string
12895   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
12896     get:
12897       tags:
12898         - CloudInfrastructure
12899       summary: returns lag-interface
12900       description: returns lag-interface
12901       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
12902       produces:
12903         - application/json
12904         - application/xml
12905       responses:
12906         "200":
12907           description: successful operation
12908           schema:
12909               $ref: "#/getDefinitions/lag-interface"
12910         "default":
12911           description: Response codes found in [response codes](https://wiki.onap.org/).
12912       parameters:
12913         - name: hostname
12914           in: path
12915           description: Value from executing hostname on the compute node.
12916           required: true
12917           type: string
12918           example: __HOSTNAME__
12919         - name: interface-name
12920           in: path
12921           description: Name that identifies the link aggregate interface
12922           required: true
12923           type: string
12924           example: __INTERFACE-NAME__
12925     put:
12926       tags:
12927         - CloudInfrastructure
12928       summary: create or update an existing lag-interface
12929       description: |
12930         Create or update an existing lag-interface.
12931         #
12932         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12933       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
12934       consumes:
12935         - application/json
12936         - application/xml
12937       produces:
12938         - application/json
12939         - application/xml
12940       responses:
12941         "default":
12942           description: Response codes found in [response codes](https://wiki.onap.org/).
12943       parameters:
12944         - name: hostname
12945           in: path
12946           description: Value from executing hostname on the compute node.
12947           required: true
12948           type: string
12949           example: __HOSTNAME__
12950         - name: interface-name
12951           in: path
12952           description: Name that identifies the link aggregate interface
12953           required: true
12954           type: string
12955           example: __INTERFACE-NAME__
12956         - name: body
12957           in: body
12958           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
12959           required: true
12960           schema:
12961             $ref: "#/definitions/lag-interface"
12962     patch:
12963       tags:
12964         - CloudInfrastructure
12965       summary: update an existing lag-interface
12966       description: |
12967         Update an existing lag-interface
12968         #
12969         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12970         The PUT operation will entirely replace an existing object.
12971         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12972         #
12973         Other differences between PUT and PATCH are:
12974         #
12975         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12976         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12977         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12978       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
12979       consumes:
12980         - application/json
12981         - application/xml
12982       produces:
12983         - application/json
12984         - application/xml
12985       responses:
12986         "default":
12987           description: Response codes found in [response codes](https://wiki.onap.org/).
12988       parameters:
12989         - name: hostname
12990           in: path
12991           description: Value from executing hostname on the compute node.
12992           required: true
12993           type: string
12994           example: __HOSTNAME__
12995         - name: interface-name
12996           in: path
12997           description: Name that identifies the link aggregate interface
12998           required: true
12999           type: string
13000           example: __INTERFACE-NAME__
13001         - name: body
13002           in: body
13003           description: lag-interface object that needs to be updated.
13004           required: true
13005           schema:
13006             $ref: "#/patchDefinitions/lag-interface"
13007     delete:
13008       tags:
13009         - CloudInfrastructure
13010       summary: delete an existing lag-interface
13011       description: delete an existing lag-interface
13012       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13013       consumes:
13014         - application/json
13015         - application/xml
13016       produces:
13017         - application/json
13018         - application/xml
13019       responses:
13020         "default":
13021           description: Response codes found in [response codes](https://wiki.onap.org/).
13022       parameters:
13023         - name: hostname
13024           in: path
13025           description: Value from executing hostname on the compute node.
13026           required: true
13027           type: string
13028           example: __HOSTNAME__
13029         - name: interface-name
13030           in: path
13031           description: Name that identifies the link aggregate interface
13032           required: true
13033           type: string
13034           example: __INTERFACE-NAME__
13035         - name: resource-version
13036           in: query
13037           description: resource-version for concurrency
13038           required: true
13039           type: string
13040   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13041     get:
13042       tags:
13043         - CloudInfrastructure
13044       summary: returns lag-interfaces
13045       description: returns lag-interfaces
13046       operationId: getCloudInfrastructurePserversPserverLagInterfaces
13047       produces:
13048         - application/json
13049         - application/xml
13050       responses:
13051         "200":
13052           description: successful operation
13053           schema:
13054               $ref: "#/getDefinitions/lag-interfaces"
13055         "default":
13056           description: Response codes found in [response codes](https://wiki.onap.org/).
13057       parameters:
13058         - name: hostname
13059           in: path
13060           description: Value from executing hostname on the compute node.
13061           required: true
13062           type: string
13063           example: __HOSTNAME__
13064         - name: interface-name
13065           in: query
13066           description:
13067           required: false
13068           type: string
13069         - name: interface-id
13070           in: query
13071           description:
13072           required: false
13073           type: string
13074         - name: interface-role
13075           in: query
13076           description:
13077           required: false
13078           type: string
13079   /cloud-infrastructure/pservers/pserver/{hostname}:
13080     get:
13081       tags:
13082         - CloudInfrastructure
13083       summary: returns pserver
13084       description: returns pserver
13085       operationId: getCloudInfrastructurePserversPserver
13086       produces:
13087         - application/json
13088         - application/xml
13089       responses:
13090         "200":
13091           description: successful operation
13092           schema:
13093               $ref: "#/getDefinitions/pserver"
13094         "default":
13095           description: Response codes found in [response codes](https://wiki.onap.org/).
13096       parameters:
13097         - name: hostname
13098           in: path
13099           description: Value from executing hostname on the compute node.
13100           required: true
13101           type: string
13102           example: __HOSTNAME__
13103     put:
13104       tags:
13105         - CloudInfrastructure
13106       summary: create or update an existing pserver
13107       description: |
13108         Create or update an existing pserver.
13109         #
13110         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13111       operationId: createOrUpdateCloudInfrastructurePserversPserver
13112       consumes:
13113         - application/json
13114         - application/xml
13115       produces:
13116         - application/json
13117         - application/xml
13118       responses:
13119         "default":
13120           description: Response codes found in [response codes](https://wiki.onap.org/).
13121       parameters:
13122         - name: hostname
13123           in: path
13124           description: Value from executing hostname on the compute node.
13125           required: true
13126           type: string
13127           example: __HOSTNAME__
13128         - name: body
13129           in: body
13130           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
13131           required: true
13132           schema:
13133             $ref: "#/definitions/pserver"
13134     patch:
13135       tags:
13136         - CloudInfrastructure
13137       summary: update an existing pserver
13138       description: |
13139         Update an existing pserver
13140         #
13141         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13142         The PUT operation will entirely replace an existing object.
13143         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13144         #
13145         Other differences between PUT and PATCH are:
13146         #
13147         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13148         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13149         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13150       operationId: UpdateCloudInfrastructurePserversPserver
13151       consumes:
13152         - application/json
13153         - application/xml
13154       produces:
13155         - application/json
13156         - application/xml
13157       responses:
13158         "default":
13159           description: Response codes found in [response codes](https://wiki.onap.org/).
13160       parameters:
13161         - name: hostname
13162           in: path
13163           description: Value from executing hostname on the compute node.
13164           required: true
13165           type: string
13166           example: __HOSTNAME__
13167         - name: body
13168           in: body
13169           description: pserver object that needs to be updated.
13170           required: true
13171           schema:
13172             $ref: "#/patchDefinitions/pserver"
13173     delete:
13174       tags:
13175         - CloudInfrastructure
13176       summary: delete an existing pserver
13177       description: delete an existing pserver
13178       operationId: deleteCloudInfrastructurePserversPserver
13179       consumes:
13180         - application/json
13181         - application/xml
13182       produces:
13183         - application/json
13184         - application/xml
13185       responses:
13186         "default":
13187           description: Response codes found in [response codes](https://wiki.onap.org/).
13188       parameters:
13189         - name: hostname
13190           in: path
13191           description: Value from executing hostname on the compute node.
13192           required: true
13193           type: string
13194           example: __HOSTNAME__
13195         - name: resource-version
13196           in: query
13197           description: resource-version for concurrency
13198           required: true
13199           type: string
13200   /cloud-infrastructure/pservers:
13201     get:
13202       tags:
13203         - CloudInfrastructure
13204       summary: returns pservers
13205       description: returns pservers
13206       operationId: getCloudInfrastructurePservers
13207       produces:
13208         - application/json
13209         - application/xml
13210       responses:
13211         "200":
13212           description: successful operation
13213           schema:
13214               $ref: "#/getDefinitions/pservers"
13215         "default":
13216           description: Response codes found in [response codes](https://wiki.onap.org/).
13217       parameters:
13218         - name: hostname
13219           in: query
13220           description:
13221           required: false
13222           type: string
13223         - name: inv-status
13224           in: query
13225           description:
13226           required: false
13227           type: string
13228         - name: pserver-id
13229           in: query
13230           description:
13231           required: false
13232           type: string
13233         - name: in-maint
13234           in: query
13235           description:
13236           required: false
13237           type: boolean
13238         - name: pserver-name2
13239           in: query
13240           description:
13241           required: false
13242           type: string
13243   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
13244     put:
13245       tags:
13246         - CloudInfrastructure
13247       summary: see node definition for valid relationships
13248       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13249       consumes:
13250         - application/json
13251         - application/xml
13252       produces:
13253         - application/json
13254         - application/xml
13255       responses:
13256         "default":
13257           description: Response codes found in [response codes](https://wiki.onap.org/).
13258       parameters:
13259         - name: vdc-id
13260           in: path
13261           description: Unique ID of the vdc
13262           required: true
13263           type: string
13264           example: __VDC-ID__
13265         - name: body
13266           in: body
13267           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13268           required: true
13269           schema:
13270             $ref: "#/definitions/relationship"
13271     delete:
13272       tags:
13273         - CloudInfrastructure
13274       summary: delete an existing relationship
13275       description: delete an existing relationship
13276       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13277       consumes:
13278         - application/json
13279         - application/xml
13280       produces:
13281         - application/json
13282         - application/xml
13283       responses:
13284         "default":
13285           description: Response codes found in [response codes](https://wiki.onap.org/).
13286       parameters:
13287         - name: vdc-id
13288           in: path
13289           description: Unique ID of the vdc
13290           required: true
13291           type: string
13292           example: __VDC-ID__
13293   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
13294     get:
13295       tags:
13296         - CloudInfrastructure
13297       summary: returns virtual-data-center
13298       description: returns virtual-data-center
13299       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
13300       produces:
13301         - application/json
13302         - application/xml
13303       responses:
13304         "200":
13305           description: successful operation
13306           schema:
13307               $ref: "#/getDefinitions/virtual-data-center"
13308         "default":
13309           description: Response codes found in [response codes](https://wiki.onap.org/).
13310       parameters:
13311         - name: vdc-id
13312           in: path
13313           description: Unique ID of the vdc
13314           required: true
13315           type: string
13316           example: __VDC-ID__
13317     put:
13318       tags:
13319         - CloudInfrastructure
13320       summary: create or update an existing virtual-data-center
13321       description: |
13322         Create or update an existing virtual-data-center.
13323         #
13324         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13325       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13326       consumes:
13327         - application/json
13328         - application/xml
13329       produces:
13330         - application/json
13331         - application/xml
13332       responses:
13333         "default":
13334           description: Response codes found in [response codes](https://wiki.onap.org/).
13335       parameters:
13336         - name: vdc-id
13337           in: path
13338           description: Unique ID of the vdc
13339           required: true
13340           type: string
13341           example: __VDC-ID__
13342         - name: body
13343           in: body
13344           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13345           required: true
13346           schema:
13347             $ref: "#/definitions/virtual-data-center"
13348     patch:
13349       tags:
13350         - CloudInfrastructure
13351       summary: update an existing virtual-data-center
13352       description: |
13353         Update an existing virtual-data-center
13354         #
13355         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13356         The PUT operation will entirely replace an existing object.
13357         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13358         #
13359         Other differences between PUT and PATCH are:
13360         #
13361         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13362         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13363         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13364       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13365       consumes:
13366         - application/json
13367         - application/xml
13368       produces:
13369         - application/json
13370         - application/xml
13371       responses:
13372         "default":
13373           description: Response codes found in [response codes](https://wiki.onap.org/).
13374       parameters:
13375         - name: vdc-id
13376           in: path
13377           description: Unique ID of the vdc
13378           required: true
13379           type: string
13380           example: __VDC-ID__
13381         - name: body
13382           in: body
13383           description: virtual-data-center object that needs to be updated.
13384           required: true
13385           schema:
13386             $ref: "#/patchDefinitions/virtual-data-center"
13387     delete:
13388       tags:
13389         - CloudInfrastructure
13390       summary: delete an existing virtual-data-center
13391       description: delete an existing virtual-data-center
13392       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
13393       consumes:
13394         - application/json
13395         - application/xml
13396       produces:
13397         - application/json
13398         - application/xml
13399       responses:
13400         "default":
13401           description: Response codes found in [response codes](https://wiki.onap.org/).
13402       parameters:
13403         - name: vdc-id
13404           in: path
13405           description: Unique ID of the vdc
13406           required: true
13407           type: string
13408           example: __VDC-ID__
13409         - name: resource-version
13410           in: query
13411           description: resource-version for concurrency
13412           required: true
13413           type: string
13414   /cloud-infrastructure/virtual-data-centers:
13415     get:
13416       tags:
13417         - CloudInfrastructure
13418       summary: returns virtual-data-centers
13419       description: returns virtual-data-centers
13420       operationId: getCloudInfrastructureVirtualDataCenters
13421       produces:
13422         - application/json
13423         - application/xml
13424       responses:
13425         "200":
13426           description: successful operation
13427           schema:
13428               $ref: "#/getDefinitions/virtual-data-centers"
13429         "default":
13430           description: Response codes found in [response codes](https://wiki.onap.org/).
13431       parameters:
13432         - name: vdc-id
13433           in: query
13434           description:
13435           required: false
13436           type: string
13437         - name: vdc-name
13438           in: query
13439           description:
13440           required: false
13441           type: string
13442   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
13443     put:
13444       tags:
13445         - Business
13446       summary: see node definition for valid relationships
13447       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
13448       consumes:
13449         - application/json
13450         - application/xml
13451       produces:
13452         - application/json
13453         - application/xml
13454       responses:
13455         "default":
13456           description: Response codes found in [response codes](https://wiki.onap.org/).
13457       parameters:
13458         - name: resource-instance-id
13459           in: path
13460           description: Unique id of resource instance.
13461           required: true
13462           type: string
13463           example: __RESOURCE-INSTANCE-ID__
13464         - name: body
13465           in: body
13466           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
13467           required: true
13468           schema:
13469             $ref: "#/definitions/relationship"
13470     delete:
13471       tags:
13472         - Business
13473       summary: delete an existing relationship
13474       description: delete an existing relationship
13475       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
13476       consumes:
13477         - application/json
13478         - application/xml
13479       produces:
13480         - application/json
13481         - application/xml
13482       responses:
13483         "default":
13484           description: Response codes found in [response codes](https://wiki.onap.org/).
13485       parameters:
13486         - name: resource-instance-id
13487           in: path
13488           description: Unique id of resource instance.
13489           required: true
13490           type: string
13491           example: __RESOURCE-INSTANCE-ID__
13492   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
13493     get:
13494       tags:
13495         - Business
13496       summary: returns metadatum
13497       description: returns metadatum
13498       operationId: getBusinessConnectorsConnectorMetadataMetadatum
13499       produces:
13500         - application/json
13501         - application/xml
13502       responses:
13503         "200":
13504           description: successful operation
13505           schema:
13506               $ref: "#/getDefinitions/metadatum"
13507         "default":
13508           description: Response codes found in [response codes](https://wiki.onap.org/).
13509       parameters:
13510         - name: resource-instance-id
13511           in: path
13512           description: Unique id of resource instance.
13513           required: true
13514           type: string
13515           example: __RESOURCE-INSTANCE-ID__
13516         - name: metaname
13517           in: path
13518           required: true
13519           type: string
13520           example: __METANAME__
13521     put:
13522       tags:
13523         - Business
13524       summary: create or update an existing metadatum
13525       description: |
13526         Create or update an existing metadatum.
13527         #
13528         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13529       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
13530       consumes:
13531         - application/json
13532         - application/xml
13533       produces:
13534         - application/json
13535         - application/xml
13536       responses:
13537         "default":
13538           description: Response codes found in [response codes](https://wiki.onap.org/).
13539       parameters:
13540         - name: resource-instance-id
13541           in: path
13542           description: Unique id of resource instance.
13543           required: true
13544           type: string
13545           example: __RESOURCE-INSTANCE-ID__
13546         - name: metaname
13547           in: path
13548           required: true
13549           type: string
13550           example: __METANAME__
13551         - name: body
13552           in: body
13553           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)
13554           required: true
13555           schema:
13556             $ref: "#/definitions/metadatum"
13557     patch:
13558       tags:
13559         - Business
13560       summary: update an existing metadatum
13561       description: |
13562         Update an existing metadatum
13563         #
13564         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13565         The PUT operation will entirely replace an existing object.
13566         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13567         #
13568         Other differences between PUT and PATCH are:
13569         #
13570         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13571         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13572         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13573       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
13574       consumes:
13575         - application/json
13576         - application/xml
13577       produces:
13578         - application/json
13579         - application/xml
13580       responses:
13581         "default":
13582           description: Response codes found in [response codes](https://wiki.onap.org/).
13583       parameters:
13584         - name: resource-instance-id
13585           in: path
13586           description: Unique id of resource instance.
13587           required: true
13588           type: string
13589           example: __RESOURCE-INSTANCE-ID__
13590         - name: metaname
13591           in: path
13592           required: true
13593           type: string
13594           example: __METANAME__
13595         - name: body
13596           in: body
13597           description: metadatum object that needs to be updated.
13598           required: true
13599           schema:
13600             $ref: "#/patchDefinitions/metadatum"
13601     delete:
13602       tags:
13603         - Business
13604       summary: delete an existing metadatum
13605       description: delete an existing metadatum
13606       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
13607       consumes:
13608         - application/json
13609         - application/xml
13610       produces:
13611         - application/json
13612         - application/xml
13613       responses:
13614         "default":
13615           description: Response codes found in [response codes](https://wiki.onap.org/).
13616       parameters:
13617         - name: resource-instance-id
13618           in: path
13619           description: Unique id of resource instance.
13620           required: true
13621           type: string
13622           example: __RESOURCE-INSTANCE-ID__
13623         - name: metaname
13624           in: path
13625           required: true
13626           type: string
13627           example: __METANAME__
13628         - name: resource-version
13629           in: query
13630           description: resource-version for concurrency
13631           required: true
13632           type: string
13633   /business/connectors/connector/{resource-instance-id}/metadata:
13634     get:
13635       tags:
13636         - Business
13637       summary: returns metadata
13638       description: returns metadata
13639       operationId: getBusinessConnectorsConnectorMetadata
13640       produces:
13641         - application/json
13642         - application/xml
13643       responses:
13644         "200":
13645           description: successful operation
13646           schema:
13647               $ref: "#/getDefinitions/metadata"
13648         "default":
13649           description: Response codes found in [response codes](https://wiki.onap.org/).
13650       parameters:
13651         - name: resource-instance-id
13652           in: path
13653           description: Unique id of resource instance.
13654           required: true
13655           type: string
13656           example: __RESOURCE-INSTANCE-ID__
13657         - name: metaname
13658           in: query
13659           description:
13660           required: false
13661           type: string
13662   /business/connectors/connector/{resource-instance-id}:
13663     get:
13664       tags:
13665         - Business
13666       summary: returns connector
13667       description: returns connector
13668       operationId: getBusinessConnectorsConnector
13669       produces:
13670         - application/json
13671         - application/xml
13672       responses:
13673         "200":
13674           description: successful operation
13675           schema:
13676               $ref: "#/getDefinitions/connector"
13677         "default":
13678           description: Response codes found in [response codes](https://wiki.onap.org/).
13679       parameters:
13680         - name: resource-instance-id
13681           in: path
13682           description: Unique id of resource instance.
13683           required: true
13684           type: string
13685           example: __RESOURCE-INSTANCE-ID__
13686     put:
13687       tags:
13688         - Business
13689       summary: create or update an existing connector
13690       description: |
13691         Create or update an existing connector.
13692         #
13693         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13694       operationId: createOrUpdateBusinessConnectorsConnector
13695       consumes:
13696         - application/json
13697         - application/xml
13698       produces:
13699         - application/json
13700         - application/xml
13701       responses:
13702         "default":
13703           description: Response codes found in [response codes](https://wiki.onap.org/).
13704       parameters:
13705         - name: resource-instance-id
13706           in: path
13707           description: Unique id of resource instance.
13708           required: true
13709           type: string
13710           example: __RESOURCE-INSTANCE-ID__
13711         - name: body
13712           in: body
13713           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
13714           required: true
13715           schema:
13716             $ref: "#/definitions/connector"
13717     patch:
13718       tags:
13719         - Business
13720       summary: update an existing connector
13721       description: |
13722         Update an existing connector
13723         #
13724         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13725         The PUT operation will entirely replace an existing object.
13726         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13727         #
13728         Other differences between PUT and PATCH are:
13729         #
13730         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13731         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13732         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13733       operationId: UpdateBusinessConnectorsConnector
13734       consumes:
13735         - application/json
13736         - application/xml
13737       produces:
13738         - application/json
13739         - application/xml
13740       responses:
13741         "default":
13742           description: Response codes found in [response codes](https://wiki.onap.org/).
13743       parameters:
13744         - name: resource-instance-id
13745           in: path
13746           description: Unique id of resource instance.
13747           required: true
13748           type: string
13749           example: __RESOURCE-INSTANCE-ID__
13750         - name: body
13751           in: body
13752           description: connector object that needs to be updated.
13753           required: true
13754           schema:
13755             $ref: "#/patchDefinitions/connector"
13756     delete:
13757       tags:
13758         - Business
13759       summary: delete an existing connector
13760       description: delete an existing connector
13761       operationId: deleteBusinessConnectorsConnector
13762       consumes:
13763         - application/json
13764         - application/xml
13765       produces:
13766         - application/json
13767         - application/xml
13768       responses:
13769         "default":
13770           description: Response codes found in [response codes](https://wiki.onap.org/).
13771       parameters:
13772         - name: resource-instance-id
13773           in: path
13774           description: Unique id of resource instance.
13775           required: true
13776           type: string
13777           example: __RESOURCE-INSTANCE-ID__
13778         - name: resource-version
13779           in: query
13780           description: resource-version for concurrency
13781           required: true
13782           type: string
13783   /business/connectors:
13784     get:
13785       tags:
13786         - Business
13787       summary: returns connectors
13788       description: returns connectors
13789       operationId: getBusinessConnectors
13790       produces:
13791         - application/json
13792         - application/xml
13793       responses:
13794         "200":
13795           description: successful operation
13796           schema:
13797               $ref: "#/getDefinitions/connectors"
13798         "default":
13799           description: Response codes found in [response codes](https://wiki.onap.org/).
13800       parameters:
13801         - name: resource-instance-id
13802           in: query
13803           description:
13804           required: false
13805           type: string
13806         - name: model-invariant-id
13807           in: query
13808           description:
13809           required: false
13810           type: string
13811         - name: model-version-id
13812           in: query
13813           description:
13814           required: false
13815           type: string
13816         - name: widget-model-id
13817           in: query
13818           description:
13819           required: false
13820           type: string
13821         - name: widget-model-version
13822           in: query
13823           description:
13824           required: false
13825           type: string
13826   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
13827     put:
13828       tags:
13829         - Business
13830       summary: see node definition for valid relationships
13831       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
13832       consumes:
13833         - application/json
13834         - application/xml
13835       produces:
13836         - application/json
13837         - application/xml
13838       responses:
13839         "default":
13840           description: Response codes found in [response codes](https://wiki.onap.org/).
13841       parameters:
13842         - name: global-customer-id
13843           in: path
13844           description: Global customer id used across ECOMP to uniquely identify customer.
13845           required: true
13846           type: string
13847           example: __GLOBAL-CUSTOMER-ID__
13848         - name: service-type
13849           in: path
13850           description: Value defined by orchestration to identify this service across ECOMP.
13851           required: true
13852           type: string
13853           example: __SERVICE-TYPE__
13854         - name: service-instance-id
13855           in: path
13856           description: Uniquely identifies this instance of a service
13857           required: true
13858           type: string
13859           example: __SERVICE-INSTANCE-ID__
13860         - name: body
13861           in: body
13862           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13863           required: true
13864           schema:
13865             $ref: "#/definitions/relationship"
13866     delete:
13867       tags:
13868         - Business
13869       summary: delete an existing relationship
13870       description: delete an existing relationship
13871       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
13872       consumes:
13873         - application/json
13874         - application/xml
13875       produces:
13876         - application/json
13877         - application/xml
13878       responses:
13879         "default":
13880           description: Response codes found in [response codes](https://wiki.onap.org/).
13881       parameters:
13882         - name: global-customer-id
13883           in: path
13884           description: Global customer id used across ECOMP to uniquely identify customer.
13885           required: true
13886           type: string
13887           example: __GLOBAL-CUSTOMER-ID__
13888         - name: service-type
13889           in: path
13890           description: Value defined by orchestration to identify this service across ECOMP.
13891           required: true
13892           type: string
13893           example: __SERVICE-TYPE__
13894         - name: service-instance-id
13895           in: path
13896           description: Uniquely identifies this instance of a service
13897           required: true
13898           type: string
13899           example: __SERVICE-INSTANCE-ID__
13900   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
13901     get:
13902       tags:
13903         - Business
13904       summary: returns metadatum
13905       description: returns metadatum
13906       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13907       produces:
13908         - application/json
13909         - application/xml
13910       responses:
13911         "200":
13912           description: successful operation
13913           schema:
13914               $ref: "#/getDefinitions/metadatum"
13915         "default":
13916           description: Response codes found in [response codes](https://wiki.onap.org/).
13917       parameters:
13918         - name: global-customer-id
13919           in: path
13920           description: Global customer id used across ECOMP to uniquely identify customer.
13921           required: true
13922           type: string
13923           example: __GLOBAL-CUSTOMER-ID__
13924         - name: service-type
13925           in: path
13926           description: Value defined by orchestration to identify this service across ECOMP.
13927           required: true
13928           type: string
13929           example: __SERVICE-TYPE__
13930         - name: service-instance-id
13931           in: path
13932           description: Uniquely identifies this instance of a service
13933           required: true
13934           type: string
13935           example: __SERVICE-INSTANCE-ID__
13936         - name: metaname
13937           in: path
13938           required: true
13939           type: string
13940           example: __METANAME__
13941     put:
13942       tags:
13943         - Business
13944       summary: create or update an existing metadatum
13945       description: |
13946         Create or update an existing metadatum.
13947         #
13948         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13949       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13950       consumes:
13951         - application/json
13952         - application/xml
13953       produces:
13954         - application/json
13955         - application/xml
13956       responses:
13957         "default":
13958           description: Response codes found in [response codes](https://wiki.onap.org/).
13959       parameters:
13960         - name: global-customer-id
13961           in: path
13962           description: Global customer id used across ECOMP to uniquely identify customer.
13963           required: true
13964           type: string
13965           example: __GLOBAL-CUSTOMER-ID__
13966         - name: service-type
13967           in: path
13968           description: Value defined by orchestration to identify this service across ECOMP.
13969           required: true
13970           type: string
13971           example: __SERVICE-TYPE__
13972         - name: service-instance-id
13973           in: path
13974           description: Uniquely identifies this instance of a service
13975           required: true
13976           type: string
13977           example: __SERVICE-INSTANCE-ID__
13978         - name: metaname
13979           in: path
13980           required: true
13981           type: string
13982           example: __METANAME__
13983         - name: body
13984           in: body
13985           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
13986           required: true
13987           schema:
13988             $ref: "#/definitions/metadatum"
13989     patch:
13990       tags:
13991         - Business
13992       summary: update an existing metadatum
13993       description: |
13994         Update an existing metadatum
13995         #
13996         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13997         The PUT operation will entirely replace an existing object.
13998         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13999         #
14000         Other differences between PUT and PATCH are:
14001         #
14002         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14003         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14004         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14005       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14006       consumes:
14007         - application/json
14008         - application/xml
14009       produces:
14010         - application/json
14011         - application/xml
14012       responses:
14013         "default":
14014           description: Response codes found in [response codes](https://wiki.onap.org/).
14015       parameters:
14016         - name: global-customer-id
14017           in: path
14018           description: Global customer id used across ECOMP to uniquely identify customer.
14019           required: true
14020           type: string
14021           example: __GLOBAL-CUSTOMER-ID__
14022         - name: service-type
14023           in: path
14024           description: Value defined by orchestration to identify this service across ECOMP.
14025           required: true
14026           type: string
14027           example: __SERVICE-TYPE__
14028         - name: service-instance-id
14029           in: path
14030           description: Uniquely identifies this instance of a service
14031           required: true
14032           type: string
14033           example: __SERVICE-INSTANCE-ID__
14034         - name: metaname
14035           in: path
14036           required: true
14037           type: string
14038           example: __METANAME__
14039         - name: body
14040           in: body
14041           description: metadatum object that needs to be updated.
14042           required: true
14043           schema:
14044             $ref: "#/patchDefinitions/metadatum"
14045     delete:
14046       tags:
14047         - Business
14048       summary: delete an existing metadatum
14049       description: delete an existing metadatum
14050       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14051       consumes:
14052         - application/json
14053         - application/xml
14054       produces:
14055         - application/json
14056         - application/xml
14057       responses:
14058         "default":
14059           description: Response codes found in [response codes](https://wiki.onap.org/).
14060       parameters:
14061         - name: global-customer-id
14062           in: path
14063           description: Global customer id used across ECOMP to uniquely identify customer.
14064           required: true
14065           type: string
14066           example: __GLOBAL-CUSTOMER-ID__
14067         - name: service-type
14068           in: path
14069           description: Value defined by orchestration to identify this service across ECOMP.
14070           required: true
14071           type: string
14072           example: __SERVICE-TYPE__
14073         - name: service-instance-id
14074           in: path
14075           description: Uniquely identifies this instance of a service
14076           required: true
14077           type: string
14078           example: __SERVICE-INSTANCE-ID__
14079         - name: metaname
14080           in: path
14081           required: true
14082           type: string
14083           example: __METANAME__
14084         - name: resource-version
14085           in: query
14086           description: resource-version for concurrency
14087           required: true
14088           type: string
14089   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14090     get:
14091       tags:
14092         - Business
14093       summary: returns metadata
14094       description: returns metadata
14095       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14096       produces:
14097         - application/json
14098         - application/xml
14099       responses:
14100         "200":
14101           description: successful operation
14102           schema:
14103               $ref: "#/getDefinitions/metadata"
14104         "default":
14105           description: Response codes found in [response codes](https://wiki.onap.org/).
14106       parameters:
14107         - name: global-customer-id
14108           in: path
14109           description: Global customer id used across ECOMP to uniquely identify customer.
14110           required: true
14111           type: string
14112           example: __GLOBAL-CUSTOMER-ID__
14113         - name: service-type
14114           in: path
14115           description: Value defined by orchestration to identify this service across ECOMP.
14116           required: true
14117           type: string
14118           example: __SERVICE-TYPE__
14119         - name: service-instance-id
14120           in: path
14121           description: Uniquely identifies this instance of a service
14122           required: true
14123           type: string
14124           example: __SERVICE-INSTANCE-ID__
14125         - name: metaname
14126           in: query
14127           description:
14128           required: false
14129           type: string
14130   /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:
14131     put:
14132       tags:
14133         - Business
14134       summary: see node definition for valid relationships
14135       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
14136       consumes:
14137         - application/json
14138         - application/xml
14139       produces:
14140         - application/json
14141         - application/xml
14142       responses:
14143         "default":
14144           description: Response codes found in [response codes](https://wiki.onap.org/).
14145       parameters:
14146         - name: global-customer-id
14147           in: path
14148           description: Global customer id used across ECOMP to uniquely identify customer.
14149           required: true
14150           type: string
14151           example: __GLOBAL-CUSTOMER-ID__
14152         - name: service-type
14153           in: path
14154           description: Value defined by orchestration to identify this service across ECOMP.
14155           required: true
14156           type: string
14157           example: __SERVICE-TYPE__
14158         - name: service-instance-id
14159           in: path
14160           description: Uniquely identifies this instance of a service
14161           required: true
14162           type: string
14163           example: __SERVICE-INSTANCE-ID__
14164         - name: id
14165           in: path
14166           description: Allotted Resource id UUID assigned to this instance.
14167           required: true
14168           type: string
14169           example: __ID__
14170         - name: id
14171           in: path
14172           description: Allotted Resource id UUID assigned to this instance.
14173           required: true
14174           type: string
14175           example: __ID__
14176         - name: body
14177           in: body
14178           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
14179           required: true
14180           schema:
14181             $ref: "#/definitions/relationship"
14182     delete:
14183       tags:
14184         - Business
14185       summary: delete an existing relationship
14186       description: delete an existing relationship
14187       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
14188       consumes:
14189         - application/json
14190         - application/xml
14191       produces:
14192         - application/json
14193         - application/xml
14194       responses:
14195         "default":
14196           description: Response codes found in [response codes](https://wiki.onap.org/).
14197       parameters:
14198         - name: global-customer-id
14199           in: path
14200           description: Global customer id used across ECOMP to uniquely identify customer.
14201           required: true
14202           type: string
14203           example: __GLOBAL-CUSTOMER-ID__
14204         - name: service-type
14205           in: path
14206           description: Value defined by orchestration to identify this service across ECOMP.
14207           required: true
14208           type: string
14209           example: __SERVICE-TYPE__
14210         - name: service-instance-id
14211           in: path
14212           description: Uniquely identifies this instance of a service
14213           required: true
14214           type: string
14215           example: __SERVICE-INSTANCE-ID__
14216         - name: id
14217           in: path
14218           description: Allotted Resource id UUID assigned to this instance.
14219           required: true
14220           type: string
14221           example: __ID__
14222         - name: id
14223           in: path
14224           description: Allotted Resource id UUID assigned to this instance.
14225           required: true
14226           type: string
14227           example: __ID__
14228   /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}:
14229     get:
14230       tags:
14231         - Business
14232       summary: returns tunnel-xconnect
14233       description: returns tunnel-xconnect
14234       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14235       produces:
14236         - application/json
14237         - application/xml
14238       responses:
14239         "200":
14240           description: successful operation
14241           schema:
14242               $ref: "#/getDefinitions/tunnel-xconnect"
14243         "default":
14244           description: Response codes found in [response codes](https://wiki.onap.org/).
14245       parameters:
14246         - name: global-customer-id
14247           in: path
14248           description: Global customer id used across ECOMP to uniquely identify customer.
14249           required: true
14250           type: string
14251           example: __GLOBAL-CUSTOMER-ID__
14252         - name: service-type
14253           in: path
14254           description: Value defined by orchestration to identify this service across ECOMP.
14255           required: true
14256           type: string
14257           example: __SERVICE-TYPE__
14258         - name: service-instance-id
14259           in: path
14260           description: Uniquely identifies this instance of a service
14261           required: true
14262           type: string
14263           example: __SERVICE-INSTANCE-ID__
14264         - name: id
14265           in: path
14266           description: Allotted Resource id UUID assigned to this instance.
14267           required: true
14268           type: string
14269           example: __ID__
14270         - name: id
14271           in: path
14272           description: Allotted Resource id UUID assigned to this instance.
14273           required: true
14274           type: string
14275           example: __ID__
14276     put:
14277       tags:
14278         - Business
14279       summary: create or update an existing tunnel-xconnect
14280       description: |
14281         Create or update an existing tunnel-xconnect.
14282         #
14283         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14284       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14285       consumes:
14286         - application/json
14287         - application/xml
14288       produces:
14289         - application/json
14290         - application/xml
14291       responses:
14292         "default":
14293           description: Response codes found in [response codes](https://wiki.onap.org/).
14294       parameters:
14295         - name: global-customer-id
14296           in: path
14297           description: Global customer id used across ECOMP to uniquely identify customer.
14298           required: true
14299           type: string
14300           example: __GLOBAL-CUSTOMER-ID__
14301         - name: service-type
14302           in: path
14303           description: Value defined by orchestration to identify this service across ECOMP.
14304           required: true
14305           type: string
14306           example: __SERVICE-TYPE__
14307         - name: service-instance-id
14308           in: path
14309           description: Uniquely identifies this instance of a service
14310           required: true
14311           type: string
14312           example: __SERVICE-INSTANCE-ID__
14313         - name: id
14314           in: path
14315           description: Allotted Resource id UUID assigned to this instance.
14316           required: true
14317           type: string
14318           example: __ID__
14319         - name: id
14320           in: path
14321           description: Allotted Resource id UUID assigned to this instance.
14322           required: true
14323           type: string
14324           example: __ID__
14325         - name: body
14326           in: body
14327           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
14328           required: true
14329           schema:
14330             $ref: "#/definitions/tunnel-xconnect"
14331     patch:
14332       tags:
14333         - Business
14334       summary: update an existing tunnel-xconnect
14335       description: |
14336         Update an existing tunnel-xconnect
14337         #
14338         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14339         The PUT operation will entirely replace an existing object.
14340         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14341         #
14342         Other differences between PUT and PATCH are:
14343         #
14344         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14345         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14346         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14347       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14348       consumes:
14349         - application/json
14350         - application/xml
14351       produces:
14352         - application/json
14353         - application/xml
14354       responses:
14355         "default":
14356           description: Response codes found in [response codes](https://wiki.onap.org/).
14357       parameters:
14358         - name: global-customer-id
14359           in: path
14360           description: Global customer id used across ECOMP to uniquely identify customer.
14361           required: true
14362           type: string
14363           example: __GLOBAL-CUSTOMER-ID__
14364         - name: service-type
14365           in: path
14366           description: Value defined by orchestration to identify this service across ECOMP.
14367           required: true
14368           type: string
14369           example: __SERVICE-TYPE__
14370         - name: service-instance-id
14371           in: path
14372           description: Uniquely identifies this instance of a service
14373           required: true
14374           type: string
14375           example: __SERVICE-INSTANCE-ID__
14376         - name: id
14377           in: path
14378           description: Allotted Resource id UUID assigned to this instance.
14379           required: true
14380           type: string
14381           example: __ID__
14382         - name: id
14383           in: path
14384           description: Allotted Resource id UUID assigned to this instance.
14385           required: true
14386           type: string
14387           example: __ID__
14388         - name: body
14389           in: body
14390           description: tunnel-xconnect object that needs to be updated.
14391           required: true
14392           schema:
14393             $ref: "#/patchDefinitions/tunnel-xconnect"
14394     delete:
14395       tags:
14396         - Business
14397       summary: delete an existing tunnel-xconnect
14398       description: delete an existing tunnel-xconnect
14399       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
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: service-type
14417           in: path
14418           description: Value defined by orchestration to identify this service across ECOMP.
14419           required: true
14420           type: string
14421           example: __SERVICE-TYPE__
14422         - name: service-instance-id
14423           in: path
14424           description: Uniquely identifies this instance of a service
14425           required: true
14426           type: string
14427           example: __SERVICE-INSTANCE-ID__
14428         - name: id
14429           in: path
14430           description: Allotted Resource id UUID assigned to this instance.
14431           required: true
14432           type: string
14433           example: __ID__
14434         - name: id
14435           in: path
14436           description: Allotted Resource id UUID assigned to this instance.
14437           required: true
14438           type: string
14439           example: __ID__
14440         - name: resource-version
14441           in: query
14442           description: resource-version for concurrency
14443           required: true
14444           type: string
14445   /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:
14446     get:
14447       tags:
14448         - Business
14449       summary: returns tunnel-xconnects
14450       description: returns tunnel-xconnects
14451       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
14452       produces:
14453         - application/json
14454         - application/xml
14455       responses:
14456         "200":
14457           description: successful operation
14458           schema:
14459               $ref: "#/getDefinitions/tunnel-xconnects"
14460         "default":
14461           description: Response codes found in [response codes](https://wiki.onap.org/).
14462       parameters:
14463         - name: global-customer-id
14464           in: path
14465           description: Global customer id used across ECOMP to uniquely identify customer.
14466           required: true
14467           type: string
14468           example: __GLOBAL-CUSTOMER-ID__
14469         - name: service-type
14470           in: path
14471           description: Value defined by orchestration to identify this service across ECOMP.
14472           required: true
14473           type: string
14474           example: __SERVICE-TYPE__
14475         - name: service-instance-id
14476           in: path
14477           description: Uniquely identifies this instance of a service
14478           required: true
14479           type: string
14480           example: __SERVICE-INSTANCE-ID__
14481         - name: id
14482           in: path
14483           description: Allotted Resource id UUID assigned to this instance.
14484           required: true
14485           type: string
14486           example: __ID__
14487         - name: id
14488           in: query
14489           description:
14490           required: false
14491           type: string
14492   /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:
14493     put:
14494       tags:
14495         - Business
14496       summary: see node definition for valid relationships
14497       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
14498       consumes:
14499         - application/json
14500         - application/xml
14501       produces:
14502         - application/json
14503         - application/xml
14504       responses:
14505         "default":
14506           description: Response codes found in [response codes](https://wiki.onap.org/).
14507       parameters:
14508         - name: global-customer-id
14509           in: path
14510           description: Global customer id used across ECOMP to uniquely identify customer.
14511           required: true
14512           type: string
14513           example: __GLOBAL-CUSTOMER-ID__
14514         - name: service-type
14515           in: path
14516           description: Value defined by orchestration to identify this service across ECOMP.
14517           required: true
14518           type: string
14519           example: __SERVICE-TYPE__
14520         - name: service-instance-id
14521           in: path
14522           description: Uniquely identifies this instance of a service
14523           required: true
14524           type: string
14525           example: __SERVICE-INSTANCE-ID__
14526         - name: id
14527           in: path
14528           description: Allotted Resource id UUID assigned to this instance.
14529           required: true
14530           type: string
14531           example: __ID__
14532         - name: body
14533           in: body
14534           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
14535           required: true
14536           schema:
14537             $ref: "#/definitions/relationship"
14538     delete:
14539       tags:
14540         - Business
14541       summary: delete an existing relationship
14542       description: delete an existing relationship
14543       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
14544       consumes:
14545         - application/json
14546         - application/xml
14547       produces:
14548         - application/json
14549         - application/xml
14550       responses:
14551         "default":
14552           description: Response codes found in [response codes](https://wiki.onap.org/).
14553       parameters:
14554         - name: global-customer-id
14555           in: path
14556           description: Global customer id used across ECOMP to uniquely identify customer.
14557           required: true
14558           type: string
14559           example: __GLOBAL-CUSTOMER-ID__
14560         - name: service-type
14561           in: path
14562           description: Value defined by orchestration to identify this service across ECOMP.
14563           required: true
14564           type: string
14565           example: __SERVICE-TYPE__
14566         - name: service-instance-id
14567           in: path
14568           description: Uniquely identifies this instance of a service
14569           required: true
14570           type: string
14571           example: __SERVICE-INSTANCE-ID__
14572         - name: id
14573           in: path
14574           description: Allotted Resource id UUID assigned to this instance.
14575           required: true
14576           type: string
14577           example: __ID__
14578   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
14579     get:
14580       tags:
14581         - Business
14582       summary: returns allotted-resource
14583       description: returns allotted-resource
14584       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14585       produces:
14586         - application/json
14587         - application/xml
14588       responses:
14589         "200":
14590           description: successful operation
14591           schema:
14592               $ref: "#/getDefinitions/allotted-resource"
14593         "default":
14594           description: Response codes found in [response codes](https://wiki.onap.org/).
14595       parameters:
14596         - name: global-customer-id
14597           in: path
14598           description: Global customer id used across ECOMP to uniquely identify customer.
14599           required: true
14600           type: string
14601           example: __GLOBAL-CUSTOMER-ID__
14602         - name: service-type
14603           in: path
14604           description: Value defined by orchestration to identify this service across ECOMP.
14605           required: true
14606           type: string
14607           example: __SERVICE-TYPE__
14608         - name: service-instance-id
14609           in: path
14610           description: Uniquely identifies this instance of a service
14611           required: true
14612           type: string
14613           example: __SERVICE-INSTANCE-ID__
14614         - name: id
14615           in: path
14616           description: Allotted Resource id UUID assigned to this instance.
14617           required: true
14618           type: string
14619           example: __ID__
14620     put:
14621       tags:
14622         - Business
14623       summary: create or update an existing allotted-resource
14624       description: |
14625         Create or update an existing allotted-resource.
14626         #
14627         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14628       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14629       consumes:
14630         - application/json
14631         - application/xml
14632       produces:
14633         - application/json
14634         - application/xml
14635       responses:
14636         "default":
14637           description: Response codes found in [response codes](https://wiki.onap.org/).
14638       parameters:
14639         - name: global-customer-id
14640           in: path
14641           description: Global customer id used across ECOMP to uniquely identify customer.
14642           required: true
14643           type: string
14644           example: __GLOBAL-CUSTOMER-ID__
14645         - name: service-type
14646           in: path
14647           description: Value defined by orchestration to identify this service across ECOMP.
14648           required: true
14649           type: string
14650           example: __SERVICE-TYPE__
14651         - name: service-instance-id
14652           in: path
14653           description: Uniquely identifies this instance of a service
14654           required: true
14655           type: string
14656           example: __SERVICE-INSTANCE-ID__
14657         - name: id
14658           in: path
14659           description: Allotted Resource id UUID assigned to this instance.
14660           required: true
14661           type: string
14662           example: __ID__
14663         - name: body
14664           in: body
14665           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
14666           required: true
14667           schema:
14668             $ref: "#/definitions/allotted-resource"
14669     patch:
14670       tags:
14671         - Business
14672       summary: update an existing allotted-resource
14673       description: |
14674         Update an existing allotted-resource
14675         #
14676         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14677         The PUT operation will entirely replace an existing object.
14678         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14679         #
14680         Other differences between PUT and PATCH are:
14681         #
14682         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14683         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14684         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14685       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14686       consumes:
14687         - application/json
14688         - application/xml
14689       produces:
14690         - application/json
14691         - application/xml
14692       responses:
14693         "default":
14694           description: Response codes found in [response codes](https://wiki.onap.org/).
14695       parameters:
14696         - name: global-customer-id
14697           in: path
14698           description: Global customer id used across ECOMP to uniquely identify customer.
14699           required: true
14700           type: string
14701           example: __GLOBAL-CUSTOMER-ID__
14702         - name: service-type
14703           in: path
14704           description: Value defined by orchestration to identify this service across ECOMP.
14705           required: true
14706           type: string
14707           example: __SERVICE-TYPE__
14708         - name: service-instance-id
14709           in: path
14710           description: Uniquely identifies this instance of a service
14711           required: true
14712           type: string
14713           example: __SERVICE-INSTANCE-ID__
14714         - name: id
14715           in: path
14716           description: Allotted Resource id UUID assigned to this instance.
14717           required: true
14718           type: string
14719           example: __ID__
14720         - name: body
14721           in: body
14722           description: allotted-resource object that needs to be updated.
14723           required: true
14724           schema:
14725             $ref: "#/patchDefinitions/allotted-resource"
14726     delete:
14727       tags:
14728         - Business
14729       summary: delete an existing allotted-resource
14730       description: delete an existing allotted-resource
14731       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14732       consumes:
14733         - application/json
14734         - application/xml
14735       produces:
14736         - application/json
14737         - application/xml
14738       responses:
14739         "default":
14740           description: Response codes found in [response codes](https://wiki.onap.org/).
14741       parameters:
14742         - name: global-customer-id
14743           in: path
14744           description: Global customer id used across ECOMP to uniquely identify customer.
14745           required: true
14746           type: string
14747           example: __GLOBAL-CUSTOMER-ID__
14748         - name: service-type
14749           in: path
14750           description: Value defined by orchestration to identify this service across ECOMP.
14751           required: true
14752           type: string
14753           example: __SERVICE-TYPE__
14754         - name: service-instance-id
14755           in: path
14756           description: Uniquely identifies this instance of a service
14757           required: true
14758           type: string
14759           example: __SERVICE-INSTANCE-ID__
14760         - name: id
14761           in: path
14762           description: Allotted Resource id UUID assigned to this instance.
14763           required: true
14764           type: string
14765           example: __ID__
14766         - name: resource-version
14767           in: query
14768           description: resource-version for concurrency
14769           required: true
14770           type: string
14771   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
14772     get:
14773       tags:
14774         - Business
14775       summary: returns allotted-resources
14776       description: returns allotted-resources
14777       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
14778       produces:
14779         - application/json
14780         - application/xml
14781       responses:
14782         "200":
14783           description: successful operation
14784           schema:
14785               $ref: "#/getDefinitions/allotted-resources"
14786         "default":
14787           description: Response codes found in [response codes](https://wiki.onap.org/).
14788       parameters:
14789         - name: global-customer-id
14790           in: path
14791           description: Global customer id used across ECOMP to uniquely identify customer.
14792           required: true
14793           type: string
14794           example: __GLOBAL-CUSTOMER-ID__
14795         - name: service-type
14796           in: path
14797           description: Value defined by orchestration to identify this service across ECOMP.
14798           required: true
14799           type: string
14800           example: __SERVICE-TYPE__
14801         - name: service-instance-id
14802           in: path
14803           description: Uniquely identifies this instance of a service
14804           required: true
14805           type: string
14806           example: __SERVICE-INSTANCE-ID__
14807         - name: id
14808           in: query
14809           description:
14810           required: false
14811           type: string
14812         - name: model-invariant-id
14813           in: query
14814           description:
14815           required: false
14816           type: string
14817         - name: model-version-id
14818           in: query
14819           description:
14820           required: false
14821           type: string
14822         - name: type
14823           in: query
14824           description:
14825           required: false
14826           type: string
14827         - name: role
14828           in: query
14829           description:
14830           required: false
14831           type: string
14832   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
14833     get:
14834       tags:
14835         - Business
14836       summary: returns service-instance
14837       description: returns service-instance
14838       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14839       produces:
14840         - application/json
14841         - application/xml
14842       responses:
14843         "200":
14844           description: successful operation
14845           schema:
14846               $ref: "#/getDefinitions/service-instance"
14847         "default":
14848           description: Response codes found in [response codes](https://wiki.onap.org/).
14849       parameters:
14850         - name: global-customer-id
14851           in: path
14852           description: Global customer id used across ECOMP to uniquely identify customer.
14853           required: true
14854           type: string
14855           example: __GLOBAL-CUSTOMER-ID__
14856         - name: service-type
14857           in: path
14858           description: Value defined by orchestration to identify this service across ECOMP.
14859           required: true
14860           type: string
14861           example: __SERVICE-TYPE__
14862         - name: service-instance-id
14863           in: path
14864           description: Uniquely identifies this instance of a service
14865           required: true
14866           type: string
14867           example: __SERVICE-INSTANCE-ID__
14868     put:
14869       tags:
14870         - Business
14871       summary: create or update an existing service-instance
14872       description: |
14873         Create or update an existing service-instance.
14874         #
14875         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14876       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14877       consumes:
14878         - application/json
14879         - application/xml
14880       produces:
14881         - application/json
14882         - application/xml
14883       responses:
14884         "default":
14885           description: Response codes found in [response codes](https://wiki.onap.org/).
14886       parameters:
14887         - name: global-customer-id
14888           in: path
14889           description: Global customer id used across ECOMP to uniquely identify customer.
14890           required: true
14891           type: string
14892           example: __GLOBAL-CUSTOMER-ID__
14893         - name: service-type
14894           in: path
14895           description: Value defined by orchestration to identify this service across ECOMP.
14896           required: true
14897           type: string
14898           example: __SERVICE-TYPE__
14899         - name: service-instance-id
14900           in: path
14901           description: Uniquely identifies this instance of a service
14902           required: true
14903           type: string
14904           example: __SERVICE-INSTANCE-ID__
14905         - name: body
14906           in: body
14907           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14908           required: true
14909           schema:
14910             $ref: "#/definitions/service-instance"
14911     patch:
14912       tags:
14913         - Business
14914       summary: update an existing service-instance
14915       description: |
14916         Update an existing service-instance
14917         #
14918         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14919         The PUT operation will entirely replace an existing object.
14920         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14921         #
14922         Other differences between PUT and PATCH are:
14923         #
14924         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14925         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14926         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14927       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14928       consumes:
14929         - application/json
14930         - application/xml
14931       produces:
14932         - application/json
14933         - application/xml
14934       responses:
14935         "default":
14936           description: Response codes found in [response codes](https://wiki.onap.org/).
14937       parameters:
14938         - name: global-customer-id
14939           in: path
14940           description: Global customer id used across ECOMP to uniquely identify customer.
14941           required: true
14942           type: string
14943           example: __GLOBAL-CUSTOMER-ID__
14944         - name: service-type
14945           in: path
14946           description: Value defined by orchestration to identify this service across ECOMP.
14947           required: true
14948           type: string
14949           example: __SERVICE-TYPE__
14950         - name: service-instance-id
14951           in: path
14952           description: Uniquely identifies this instance of a service
14953           required: true
14954           type: string
14955           example: __SERVICE-INSTANCE-ID__
14956         - name: body
14957           in: body
14958           description: service-instance object that needs to be updated.
14959           required: true
14960           schema:
14961             $ref: "#/patchDefinitions/service-instance"
14962     delete:
14963       tags:
14964         - Business
14965       summary: delete an existing service-instance
14966       description: delete an existing service-instance
14967       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14968       consumes:
14969         - application/json
14970         - application/xml
14971       produces:
14972         - application/json
14973         - application/xml
14974       responses:
14975         "default":
14976           description: Response codes found in [response codes](https://wiki.onap.org/).
14977       parameters:
14978         - name: global-customer-id
14979           in: path
14980           description: Global customer id used across ECOMP to uniquely identify customer.
14981           required: true
14982           type: string
14983           example: __GLOBAL-CUSTOMER-ID__
14984         - name: service-type
14985           in: path
14986           description: Value defined by orchestration to identify this service across ECOMP.
14987           required: true
14988           type: string
14989           example: __SERVICE-TYPE__
14990         - name: service-instance-id
14991           in: path
14992           description: Uniquely identifies this instance of a service
14993           required: true
14994           type: string
14995           example: __SERVICE-INSTANCE-ID__
14996         - name: resource-version
14997           in: query
14998           description: resource-version for concurrency
14999           required: true
15000           type: string
15001   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
15002     get:
15003       tags:
15004         - Business
15005       summary: returns service-instances
15006       description: returns service-instances
15007       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
15008       produces:
15009         - application/json
15010         - application/xml
15011       responses:
15012         "200":
15013           description: successful operation
15014           schema:
15015               $ref: "#/getDefinitions/service-instances"
15016         "default":
15017           description: Response codes found in [response codes](https://wiki.onap.org/).
15018       parameters:
15019         - name: global-customer-id
15020           in: path
15021           description: Global customer id used across ECOMP to uniquely identify customer.
15022           required: true
15023           type: string
15024           example: __GLOBAL-CUSTOMER-ID__
15025         - name: service-type
15026           in: path
15027           description: Value defined by orchestration to identify this service across ECOMP.
15028           required: true
15029           type: string
15030           example: __SERVICE-TYPE__
15031         - name: service-instance-id
15032           in: query
15033           description:
15034           required: false
15035           type: string
15036         - name: service-instance-name
15037           in: query
15038           description:
15039           required: false
15040           type: string
15041         - name: environment-context
15042           in: query
15043           description:
15044           required: false
15045           type: string
15046         - name: workload-context
15047           in: query
15048           description:
15049           required: false
15050           type: string
15051         - name: model-invariant-id
15052           in: query
15053           description:
15054           required: false
15055           type: string
15056         - name: model-version-id
15057           in: query
15058           description:
15059           required: false
15060           type: string
15061         - name: widget-model-id
15062           in: query
15063           description:
15064           required: false
15065           type: string
15066         - name: widget-model-version
15067           in: query
15068           description:
15069           required: false
15070           type: string
15071         - name: service-instance-location-id
15072           in: query
15073           description:
15074           required: false
15075           type: string
15076         - name: orchestration-status
15077           in: query
15078           description:
15079           required: false
15080           type: string
15081   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
15082     put:
15083       tags:
15084         - Business
15085       summary: see node definition for valid relationships
15086       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
15087       consumes:
15088         - application/json
15089         - application/xml
15090       produces:
15091         - application/json
15092         - application/xml
15093       responses:
15094         "default":
15095           description: Response codes found in [response codes](https://wiki.onap.org/).
15096       parameters:
15097         - name: global-customer-id
15098           in: path
15099           description: Global customer id used across ECOMP to uniquely identify customer.
15100           required: true
15101           type: string
15102           example: __GLOBAL-CUSTOMER-ID__
15103         - name: service-type
15104           in: path
15105           description: Value defined by orchestration to identify this service across ECOMP.
15106           required: true
15107           type: string
15108           example: __SERVICE-TYPE__
15109         - name: body
15110           in: body
15111           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15112           required: true
15113           schema:
15114             $ref: "#/definitions/relationship"
15115     delete:
15116       tags:
15117         - Business
15118       summary: delete an existing relationship
15119       description: delete an existing relationship
15120       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
15121       consumes:
15122         - application/json
15123         - application/xml
15124       produces:
15125         - application/json
15126         - application/xml
15127       responses:
15128         "default":
15129           description: Response codes found in [response codes](https://wiki.onap.org/).
15130       parameters:
15131         - name: global-customer-id
15132           in: path
15133           description: Global customer id used across ECOMP to uniquely identify customer.
15134           required: true
15135           type: string
15136           example: __GLOBAL-CUSTOMER-ID__
15137         - name: service-type
15138           in: path
15139           description: Value defined by orchestration to identify this service across ECOMP.
15140           required: true
15141           type: string
15142           example: __SERVICE-TYPE__
15143   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
15144     get:
15145       tags:
15146         - Business
15147       summary: returns service-subscription
15148       description: returns service-subscription
15149       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15150       produces:
15151         - application/json
15152         - application/xml
15153       responses:
15154         "200":
15155           description: successful operation
15156           schema:
15157               $ref: "#/getDefinitions/service-subscription"
15158         "default":
15159           description: Response codes found in [response codes](https://wiki.onap.org/).
15160       parameters:
15161         - name: global-customer-id
15162           in: path
15163           description: Global customer id used across ECOMP to uniquely identify customer.
15164           required: true
15165           type: string
15166           example: __GLOBAL-CUSTOMER-ID__
15167         - name: service-type
15168           in: path
15169           description: Value defined by orchestration to identify this service across ECOMP.
15170           required: true
15171           type: string
15172           example: __SERVICE-TYPE__
15173     put:
15174       tags:
15175         - Business
15176       summary: create or update an existing service-subscription
15177       description: |
15178         Create or update an existing service-subscription.
15179         #
15180         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15181       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15182       consumes:
15183         - application/json
15184         - application/xml
15185       produces:
15186         - application/json
15187         - application/xml
15188       responses:
15189         "default":
15190           description: Response codes found in [response codes](https://wiki.onap.org/).
15191       parameters:
15192         - name: global-customer-id
15193           in: path
15194           description: Global customer id used across ECOMP to uniquely identify customer.
15195           required: true
15196           type: string
15197           example: __GLOBAL-CUSTOMER-ID__
15198         - name: service-type
15199           in: path
15200           description: Value defined by orchestration to identify this service across ECOMP.
15201           required: true
15202           type: string
15203           example: __SERVICE-TYPE__
15204         - name: body
15205           in: body
15206           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15207           required: true
15208           schema:
15209             $ref: "#/definitions/service-subscription"
15210     patch:
15211       tags:
15212         - Business
15213       summary: update an existing service-subscription
15214       description: |
15215         Update an existing service-subscription
15216         #
15217         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15218         The PUT operation will entirely replace an existing object.
15219         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15220         #
15221         Other differences between PUT and PATCH are:
15222         #
15223         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15224         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15225         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15226       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15227       consumes:
15228         - application/json
15229         - application/xml
15230       produces:
15231         - application/json
15232         - application/xml
15233       responses:
15234         "default":
15235           description: Response codes found in [response codes](https://wiki.onap.org/).
15236       parameters:
15237         - name: global-customer-id
15238           in: path
15239           description: Global customer id used across ECOMP to uniquely identify customer.
15240           required: true
15241           type: string
15242           example: __GLOBAL-CUSTOMER-ID__
15243         - name: service-type
15244           in: path
15245           description: Value defined by orchestration to identify this service across ECOMP.
15246           required: true
15247           type: string
15248           example: __SERVICE-TYPE__
15249         - name: body
15250           in: body
15251           description: service-subscription object that needs to be updated.
15252           required: true
15253           schema:
15254             $ref: "#/patchDefinitions/service-subscription"
15255     delete:
15256       tags:
15257         - Business
15258       summary: delete an existing service-subscription
15259       description: delete an existing service-subscription
15260       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15261       consumes:
15262         - application/json
15263         - application/xml
15264       produces:
15265         - application/json
15266         - application/xml
15267       responses:
15268         "default":
15269           description: Response codes found in [response codes](https://wiki.onap.org/).
15270       parameters:
15271         - name: global-customer-id
15272           in: path
15273           description: Global customer id used across ECOMP to uniquely identify customer.
15274           required: true
15275           type: string
15276           example: __GLOBAL-CUSTOMER-ID__
15277         - name: service-type
15278           in: path
15279           description: Value defined by orchestration to identify this service across ECOMP.
15280           required: true
15281           type: string
15282           example: __SERVICE-TYPE__
15283         - name: resource-version
15284           in: query
15285           description: resource-version for concurrency
15286           required: true
15287           type: string
15288   /business/customers/customer/{global-customer-id}/service-subscriptions:
15289     get:
15290       tags:
15291         - Business
15292       summary: returns service-subscriptions
15293       description: returns service-subscriptions
15294       operationId: getBusinessCustomersCustomerServiceSubscriptions
15295       produces:
15296         - application/json
15297         - application/xml
15298       responses:
15299         "200":
15300           description: successful operation
15301           schema:
15302               $ref: "#/getDefinitions/service-subscriptions"
15303         "default":
15304           description: Response codes found in [response codes](https://wiki.onap.org/).
15305       parameters:
15306         - name: global-customer-id
15307           in: path
15308           description: Global customer id used across ECOMP to uniquely identify customer.
15309           required: true
15310           type: string
15311           example: __GLOBAL-CUSTOMER-ID__
15312         - name: service-type
15313           in: query
15314           description:
15315           required: false
15316           type: string
15317   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
15318     put:
15319       tags:
15320         - Business
15321       summary: see node definition for valid relationships
15322       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
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: global-customer-id
15334           in: path
15335           description: Global customer id used across ECOMP to uniquely identify customer.
15336           required: true
15337           type: string
15338           example: __GLOBAL-CUSTOMER-ID__
15339         - name: body
15340           in: body
15341           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
15342           required: true
15343           schema:
15344             $ref: "#/definitions/relationship"
15345     delete:
15346       tags:
15347         - Business
15348       summary: delete an existing relationship
15349       description: delete an existing relationship
15350       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
15351       consumes:
15352         - application/json
15353         - application/xml
15354       produces:
15355         - application/json
15356         - application/xml
15357       responses:
15358         "default":
15359           description: Response codes found in [response codes](https://wiki.onap.org/).
15360       parameters:
15361         - name: global-customer-id
15362           in: path
15363           description: Global customer id used across ECOMP to uniquely identify customer.
15364           required: true
15365           type: string
15366           example: __GLOBAL-CUSTOMER-ID__
15367   /business/customers/customer/{global-customer-id}:
15368     get:
15369       tags:
15370         - Business
15371       summary: returns customer
15372       description: returns customer
15373       operationId: getBusinessCustomersCustomer
15374       produces:
15375         - application/json
15376         - application/xml
15377       responses:
15378         "200":
15379           description: successful operation
15380           schema:
15381               $ref: "#/getDefinitions/customer"
15382         "default":
15383           description: Response codes found in [response codes](https://wiki.onap.org/).
15384       parameters:
15385         - name: global-customer-id
15386           in: path
15387           description: Global customer id used across ECOMP to uniquely identify customer.
15388           required: true
15389           type: string
15390           example: __GLOBAL-CUSTOMER-ID__
15391     put:
15392       tags:
15393         - Business
15394       summary: create or update an existing customer
15395       description: |
15396         Create or update an existing customer.
15397         #
15398         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15399       operationId: createOrUpdateBusinessCustomersCustomer
15400       consumes:
15401         - application/json
15402         - application/xml
15403       produces:
15404         - application/json
15405         - application/xml
15406       responses:
15407         "default":
15408           description: Response codes found in [response codes](https://wiki.onap.org/).
15409       parameters:
15410         - name: global-customer-id
15411           in: path
15412           description: Global customer id used across ECOMP to uniquely identify customer.
15413           required: true
15414           type: string
15415           example: __GLOBAL-CUSTOMER-ID__
15416         - name: body
15417           in: body
15418           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
15419           required: true
15420           schema:
15421             $ref: "#/definitions/customer"
15422     patch:
15423       tags:
15424         - Business
15425       summary: update an existing customer
15426       description: |
15427         Update an existing customer
15428         #
15429         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15430         The PUT operation will entirely replace an existing object.
15431         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15432         #
15433         Other differences between PUT and PATCH are:
15434         #
15435         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15436         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15437         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15438       operationId: UpdateBusinessCustomersCustomer
15439       consumes:
15440         - application/json
15441         - application/xml
15442       produces:
15443         - application/json
15444         - application/xml
15445       responses:
15446         "default":
15447           description: Response codes found in [response codes](https://wiki.onap.org/).
15448       parameters:
15449         - name: global-customer-id
15450           in: path
15451           description: Global customer id used across ECOMP to uniquely identify customer.
15452           required: true
15453           type: string
15454           example: __GLOBAL-CUSTOMER-ID__
15455         - name: body
15456           in: body
15457           description: customer object that needs to be updated.
15458           required: true
15459           schema:
15460             $ref: "#/patchDefinitions/customer"
15461     delete:
15462       tags:
15463         - Business
15464       summary: delete an existing customer
15465       description: delete an existing customer
15466       operationId: deleteBusinessCustomersCustomer
15467       consumes:
15468         - application/json
15469         - application/xml
15470       produces:
15471         - application/json
15472         - application/xml
15473       responses:
15474         "default":
15475           description: Response codes found in [response codes](https://wiki.onap.org/).
15476       parameters:
15477         - name: global-customer-id
15478           in: path
15479           description: Global customer id used across ECOMP to uniquely identify customer.
15480           required: true
15481           type: string
15482           example: __GLOBAL-CUSTOMER-ID__
15483         - name: resource-version
15484           in: query
15485           description: resource-version for concurrency
15486           required: true
15487           type: string
15488   /business/customers:
15489     get:
15490       tags:
15491         - Business
15492       summary: returns customers
15493       description: returns customers
15494       operationId: getBusinessCustomers
15495       produces:
15496         - application/json
15497         - application/xml
15498       responses:
15499         "200":
15500           description: successful operation
15501           schema:
15502               $ref: "#/getDefinitions/customers"
15503         "default":
15504           description: Response codes found in [response codes](https://wiki.onap.org/).
15505       parameters:
15506         - name: global-customer-id
15507           in: query
15508           description:
15509           required: false
15510           type: string
15511         - name: subscriber-name
15512           in: query
15513           description:
15514           required: false
15515           type: string
15516         - name: subscriber-type
15517           in: query
15518           description:
15519           required: false
15520           type: string
15521   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
15522     put:
15523       tags:
15524         - Business
15525       summary: see node definition for valid relationships
15526       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
15527       consumes:
15528         - application/json
15529         - application/xml
15530       produces:
15531         - application/json
15532         - application/xml
15533       responses:
15534         "default":
15535           description: Response codes found in [response codes](https://wiki.onap.org/).
15536       parameters:
15537         - name: line-of-business-name
15538           in: path
15539           description: Name of the line-of-business (product)
15540           required: true
15541           type: string
15542           example: __LINE-OF-BUSINESS-NAME__
15543         - name: body
15544           in: body
15545           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
15546           required: true
15547           schema:
15548             $ref: "#/definitions/relationship"
15549     delete:
15550       tags:
15551         - Business
15552       summary: delete an existing relationship
15553       description: delete an existing relationship
15554       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
15555       consumes:
15556         - application/json
15557         - application/xml
15558       produces:
15559         - application/json
15560         - application/xml
15561       responses:
15562         "default":
15563           description: Response codes found in [response codes](https://wiki.onap.org/).
15564       parameters:
15565         - name: line-of-business-name
15566           in: path
15567           description: Name of the line-of-business (product)
15568           required: true
15569           type: string
15570           example: __LINE-OF-BUSINESS-NAME__
15571   /business/lines-of-business/line-of-business/{line-of-business-name}:
15572     get:
15573       tags:
15574         - Business
15575       summary: returns line-of-business
15576       description: returns line-of-business
15577       operationId: getBusinessLinesOfBusinessLineOfBusiness
15578       produces:
15579         - application/json
15580         - application/xml
15581       responses:
15582         "200":
15583           description: successful operation
15584           schema:
15585               $ref: "#/getDefinitions/line-of-business"
15586         "default":
15587           description: Response codes found in [response codes](https://wiki.onap.org/).
15588       parameters:
15589         - name: line-of-business-name
15590           in: path
15591           description: Name of the line-of-business (product)
15592           required: true
15593           type: string
15594           example: __LINE-OF-BUSINESS-NAME__
15595     put:
15596       tags:
15597         - Business
15598       summary: create or update an existing line-of-business
15599       description: |
15600         Create or update an existing line-of-business.
15601         #
15602         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15603       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
15604       consumes:
15605         - application/json
15606         - application/xml
15607       produces:
15608         - application/json
15609         - application/xml
15610       responses:
15611         "default":
15612           description: Response codes found in [response codes](https://wiki.onap.org/).
15613       parameters:
15614         - name: line-of-business-name
15615           in: path
15616           description: Name of the line-of-business (product)
15617           required: true
15618           type: string
15619           example: __LINE-OF-BUSINESS-NAME__
15620         - name: body
15621           in: body
15622           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
15623           required: true
15624           schema:
15625             $ref: "#/definitions/line-of-business"
15626     patch:
15627       tags:
15628         - Business
15629       summary: update an existing line-of-business
15630       description: |
15631         Update an existing line-of-business
15632         #
15633         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15634         The PUT operation will entirely replace an existing object.
15635         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15636         #
15637         Other differences between PUT and PATCH are:
15638         #
15639         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15640         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15641         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15642       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
15643       consumes:
15644         - application/json
15645         - application/xml
15646       produces:
15647         - application/json
15648         - application/xml
15649       responses:
15650         "default":
15651           description: Response codes found in [response codes](https://wiki.onap.org/).
15652       parameters:
15653         - name: line-of-business-name
15654           in: path
15655           description: Name of the line-of-business (product)
15656           required: true
15657           type: string
15658           example: __LINE-OF-BUSINESS-NAME__
15659         - name: body
15660           in: body
15661           description: line-of-business object that needs to be updated.
15662           required: true
15663           schema:
15664             $ref: "#/patchDefinitions/line-of-business"
15665     delete:
15666       tags:
15667         - Business
15668       summary: delete an existing line-of-business
15669       description: delete an existing line-of-business
15670       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
15671       consumes:
15672         - application/json
15673         - application/xml
15674       produces:
15675         - application/json
15676         - application/xml
15677       responses:
15678         "default":
15679           description: Response codes found in [response codes](https://wiki.onap.org/).
15680       parameters:
15681         - name: line-of-business-name
15682           in: path
15683           description: Name of the line-of-business (product)
15684           required: true
15685           type: string
15686           example: __LINE-OF-BUSINESS-NAME__
15687         - name: resource-version
15688           in: query
15689           description: resource-version for concurrency
15690           required: true
15691           type: string
15692   /business/lines-of-business:
15693     get:
15694       tags:
15695         - Business
15696       summary: returns lines-of-business
15697       description: returns lines-of-business
15698       operationId: getBusinessLinesOfBusiness
15699       produces:
15700         - application/json
15701         - application/xml
15702       responses:
15703         "200":
15704           description: successful operation
15705           schema:
15706               $ref: "#/getDefinitions/lines-of-business"
15707         "default":
15708           description: Response codes found in [response codes](https://wiki.onap.org/).
15709       parameters:
15710         - name: line-of-business-name
15711           in: query
15712           description:
15713           required: false
15714           type: string
15715   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
15716     put:
15717       tags:
15718         - Business
15719       summary: see node definition for valid relationships
15720       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
15721       consumes:
15722         - application/json
15723         - application/xml
15724       produces:
15725         - application/json
15726         - application/xml
15727       responses:
15728         "default":
15729           description: Response codes found in [response codes](https://wiki.onap.org/).
15730       parameters:
15731         - name: owning-entity-id
15732           in: path
15733           description: UUID of an owning entity
15734           required: true
15735           type: string
15736           example: __OWNING-ENTITY-ID__
15737         - name: body
15738           in: body
15739           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
15740           required: true
15741           schema:
15742             $ref: "#/definitions/relationship"
15743     delete:
15744       tags:
15745         - Business
15746       summary: delete an existing relationship
15747       description: delete an existing relationship
15748       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
15749       consumes:
15750         - application/json
15751         - application/xml
15752       produces:
15753         - application/json
15754         - application/xml
15755       responses:
15756         "default":
15757           description: Response codes found in [response codes](https://wiki.onap.org/).
15758       parameters:
15759         - name: owning-entity-id
15760           in: path
15761           description: UUID of an owning entity
15762           required: true
15763           type: string
15764           example: __OWNING-ENTITY-ID__
15765   /business/owning-entities/owning-entity/{owning-entity-id}:
15766     get:
15767       tags:
15768         - Business
15769       summary: returns owning-entity
15770       description: returns owning-entity
15771       operationId: getBusinessOwningEntitiesOwningEntity
15772       produces:
15773         - application/json
15774         - application/xml
15775       responses:
15776         "200":
15777           description: successful operation
15778           schema:
15779               $ref: "#/getDefinitions/owning-entity"
15780         "default":
15781           description: Response codes found in [response codes](https://wiki.onap.org/).
15782       parameters:
15783         - name: owning-entity-id
15784           in: path
15785           description: UUID of an owning entity
15786           required: true
15787           type: string
15788           example: __OWNING-ENTITY-ID__
15789     put:
15790       tags:
15791         - Business
15792       summary: create or update an existing owning-entity
15793       description: |
15794         Create or update an existing owning-entity.
15795         #
15796         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15797       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
15798       consumes:
15799         - application/json
15800         - application/xml
15801       produces:
15802         - application/json
15803         - application/xml
15804       responses:
15805         "default":
15806           description: Response codes found in [response codes](https://wiki.onap.org/).
15807       parameters:
15808         - name: owning-entity-id
15809           in: path
15810           description: UUID of an owning entity
15811           required: true
15812           type: string
15813           example: __OWNING-ENTITY-ID__
15814         - name: body
15815           in: body
15816           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
15817           required: true
15818           schema:
15819             $ref: "#/definitions/owning-entity"
15820     patch:
15821       tags:
15822         - Business
15823       summary: update an existing owning-entity
15824       description: |
15825         Update an existing owning-entity
15826         #
15827         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15828         The PUT operation will entirely replace an existing object.
15829         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15830         #
15831         Other differences between PUT and PATCH are:
15832         #
15833         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15834         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15835         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15836       operationId: UpdateBusinessOwningEntitiesOwningEntity
15837       consumes:
15838         - application/json
15839         - application/xml
15840       produces:
15841         - application/json
15842         - application/xml
15843       responses:
15844         "default":
15845           description: Response codes found in [response codes](https://wiki.onap.org/).
15846       parameters:
15847         - name: owning-entity-id
15848           in: path
15849           description: UUID of an owning entity
15850           required: true
15851           type: string
15852           example: __OWNING-ENTITY-ID__
15853         - name: body
15854           in: body
15855           description: owning-entity object that needs to be updated.
15856           required: true
15857           schema:
15858             $ref: "#/patchDefinitions/owning-entity"
15859     delete:
15860       tags:
15861         - Business
15862       summary: delete an existing owning-entity
15863       description: delete an existing owning-entity
15864       operationId: deleteBusinessOwningEntitiesOwningEntity
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: owning-entity-id
15876           in: path
15877           description: UUID of an owning entity
15878           required: true
15879           type: string
15880           example: __OWNING-ENTITY-ID__
15881         - name: resource-version
15882           in: query
15883           description: resource-version for concurrency
15884           required: true
15885           type: string
15886   /business/owning-entities:
15887     get:
15888       tags:
15889         - Business
15890       summary: returns owning-entities
15891       description: returns owning-entities
15892       operationId: getBusinessOwningEntities
15893       produces:
15894         - application/json
15895         - application/xml
15896       responses:
15897         "200":
15898           description: successful operation
15899           schema:
15900               $ref: "#/getDefinitions/owning-entities"
15901         "default":
15902           description: Response codes found in [response codes](https://wiki.onap.org/).
15903       parameters:
15904         - name: owning-entity-id
15905           in: query
15906           description:
15907           required: false
15908           type: string
15909   /business/platforms/platform/{platform-name}/relationship-list/relationship:
15910     put:
15911       tags:
15912         - Business
15913       summary: see node definition for valid relationships
15914       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
15915       consumes:
15916         - application/json
15917         - application/xml
15918       produces:
15919         - application/json
15920         - application/xml
15921       responses:
15922         "default":
15923           description: Response codes found in [response codes](https://wiki.onap.org/).
15924       parameters:
15925         - name: platform-name
15926           in: path
15927           description: Name of the platform
15928           required: true
15929           type: string
15930           example: __PLATFORM-NAME__
15931         - name: body
15932           in: body
15933           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
15934           required: true
15935           schema:
15936             $ref: "#/definitions/relationship"
15937     delete:
15938       tags:
15939         - Business
15940       summary: delete an existing relationship
15941       description: delete an existing relationship
15942       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
15943       consumes:
15944         - application/json
15945         - application/xml
15946       produces:
15947         - application/json
15948         - application/xml
15949       responses:
15950         "default":
15951           description: Response codes found in [response codes](https://wiki.onap.org/).
15952       parameters:
15953         - name: platform-name
15954           in: path
15955           description: Name of the platform
15956           required: true
15957           type: string
15958           example: __PLATFORM-NAME__
15959   /business/platforms/platform/{platform-name}:
15960     get:
15961       tags:
15962         - Business
15963       summary: returns platform
15964       description: returns platform
15965       operationId: getBusinessPlatformsPlatform
15966       produces:
15967         - application/json
15968         - application/xml
15969       responses:
15970         "200":
15971           description: successful operation
15972           schema:
15973               $ref: "#/getDefinitions/platform"
15974         "default":
15975           description: Response codes found in [response codes](https://wiki.onap.org/).
15976       parameters:
15977         - name: platform-name
15978           in: path
15979           description: Name of the platform
15980           required: true
15981           type: string
15982           example: __PLATFORM-NAME__
15983     put:
15984       tags:
15985         - Business
15986       summary: create or update an existing platform
15987       description: |
15988         Create or update an existing platform.
15989         #
15990         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15991       operationId: createOrUpdateBusinessPlatformsPlatform
15992       consumes:
15993         - application/json
15994         - application/xml
15995       produces:
15996         - application/json
15997         - application/xml
15998       responses:
15999         "default":
16000           description: Response codes found in [response codes](https://wiki.onap.org/).
16001       parameters:
16002         - name: platform-name
16003           in: path
16004           description: Name of the platform
16005           required: true
16006           type: string
16007           example: __PLATFORM-NAME__
16008         - name: body
16009           in: body
16010           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
16011           required: true
16012           schema:
16013             $ref: "#/definitions/platform"
16014     patch:
16015       tags:
16016         - Business
16017       summary: update an existing platform
16018       description: |
16019         Update an existing platform
16020         #
16021         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16022         The PUT operation will entirely replace an existing object.
16023         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16024         #
16025         Other differences between PUT and PATCH are:
16026         #
16027         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16028         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16029         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16030       operationId: UpdateBusinessPlatformsPlatform
16031       consumes:
16032         - application/json
16033         - application/xml
16034       produces:
16035         - application/json
16036         - application/xml
16037       responses:
16038         "default":
16039           description: Response codes found in [response codes](https://wiki.onap.org/).
16040       parameters:
16041         - name: platform-name
16042           in: path
16043           description: Name of the platform
16044           required: true
16045           type: string
16046           example: __PLATFORM-NAME__
16047         - name: body
16048           in: body
16049           description: platform object that needs to be updated.
16050           required: true
16051           schema:
16052             $ref: "#/patchDefinitions/platform"
16053     delete:
16054       tags:
16055         - Business
16056       summary: delete an existing platform
16057       description: delete an existing platform
16058       operationId: deleteBusinessPlatformsPlatform
16059       consumes:
16060         - application/json
16061         - application/xml
16062       produces:
16063         - application/json
16064         - application/xml
16065       responses:
16066         "default":
16067           description: Response codes found in [response codes](https://wiki.onap.org/).
16068       parameters:
16069         - name: platform-name
16070           in: path
16071           description: Name of the platform
16072           required: true
16073           type: string
16074           example: __PLATFORM-NAME__
16075         - name: resource-version
16076           in: query
16077           description: resource-version for concurrency
16078           required: true
16079           type: string
16080   /business/platforms:
16081     get:
16082       tags:
16083         - Business
16084       summary: returns platforms
16085       description: returns platforms
16086       operationId: getBusinessPlatforms
16087       produces:
16088         - application/json
16089         - application/xml
16090       responses:
16091         "200":
16092           description: successful operation
16093           schema:
16094               $ref: "#/getDefinitions/platforms"
16095         "default":
16096           description: Response codes found in [response codes](https://wiki.onap.org/).
16097       parameters:
16098         - name: platform-name
16099           in: query
16100           description:
16101           required: false
16102           type: string
16103   /business/projects/project/{project-name}/relationship-list/relationship:
16104     put:
16105       tags:
16106         - Business
16107       summary: see node definition for valid relationships
16108       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
16109       consumes:
16110         - application/json
16111         - application/xml
16112       produces:
16113         - application/json
16114         - application/xml
16115       responses:
16116         "default":
16117           description: Response codes found in [response codes](https://wiki.onap.org/).
16118       parameters:
16119         - name: project-name
16120           in: path
16121           description: Name of the project deploying a service
16122           required: true
16123           type: string
16124           example: __PROJECT-NAME__
16125         - name: body
16126           in: body
16127           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
16128           required: true
16129           schema:
16130             $ref: "#/definitions/relationship"
16131     delete:
16132       tags:
16133         - Business
16134       summary: delete an existing relationship
16135       description: delete an existing relationship
16136       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
16137       consumes:
16138         - application/json
16139         - application/xml
16140       produces:
16141         - application/json
16142         - application/xml
16143       responses:
16144         "default":
16145           description: Response codes found in [response codes](https://wiki.onap.org/).
16146       parameters:
16147         - name: project-name
16148           in: path
16149           description: Name of the project deploying a service
16150           required: true
16151           type: string
16152           example: __PROJECT-NAME__
16153   /business/projects/project/{project-name}:
16154     get:
16155       tags:
16156         - Business
16157       summary: returns project
16158       description: returns project
16159       operationId: getBusinessProjectsProject
16160       produces:
16161         - application/json
16162         - application/xml
16163       responses:
16164         "200":
16165           description: successful operation
16166           schema:
16167               $ref: "#/getDefinitions/project"
16168         "default":
16169           description: Response codes found in [response codes](https://wiki.onap.org/).
16170       parameters:
16171         - name: project-name
16172           in: path
16173           description: Name of the project deploying a service
16174           required: true
16175           type: string
16176           example: __PROJECT-NAME__
16177     put:
16178       tags:
16179         - Business
16180       summary: create or update an existing project
16181       description: |
16182         Create or update an existing project.
16183         #
16184         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16185       operationId: createOrUpdateBusinessProjectsProject
16186       consumes:
16187         - application/json
16188         - application/xml
16189       produces:
16190         - application/json
16191         - application/xml
16192       responses:
16193         "default":
16194           description: Response codes found in [response codes](https://wiki.onap.org/).
16195       parameters:
16196         - name: project-name
16197           in: path
16198           description: Name of the project deploying a service
16199           required: true
16200           type: string
16201           example: __PROJECT-NAME__
16202         - name: body
16203           in: body
16204           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
16205           required: true
16206           schema:
16207             $ref: "#/definitions/project"
16208     patch:
16209       tags:
16210         - Business
16211       summary: update an existing project
16212       description: |
16213         Update an existing project
16214         #
16215         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16216         The PUT operation will entirely replace an existing object.
16217         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16218         #
16219         Other differences between PUT and PATCH are:
16220         #
16221         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16222         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16223         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16224       operationId: UpdateBusinessProjectsProject
16225       consumes:
16226         - application/json
16227         - application/xml
16228       produces:
16229         - application/json
16230         - application/xml
16231       responses:
16232         "default":
16233           description: Response codes found in [response codes](https://wiki.onap.org/).
16234       parameters:
16235         - name: project-name
16236           in: path
16237           description: Name of the project deploying a service
16238           required: true
16239           type: string
16240           example: __PROJECT-NAME__
16241         - name: body
16242           in: body
16243           description: project object that needs to be updated.
16244           required: true
16245           schema:
16246             $ref: "#/patchDefinitions/project"
16247     delete:
16248       tags:
16249         - Business
16250       summary: delete an existing project
16251       description: delete an existing project
16252       operationId: deleteBusinessProjectsProject
16253       consumes:
16254         - application/json
16255         - application/xml
16256       produces:
16257         - application/json
16258         - application/xml
16259       responses:
16260         "default":
16261           description: Response codes found in [response codes](https://wiki.onap.org/).
16262       parameters:
16263         - name: project-name
16264           in: path
16265           description: Name of the project deploying a service
16266           required: true
16267           type: string
16268           example: __PROJECT-NAME__
16269         - name: resource-version
16270           in: query
16271           description: resource-version for concurrency
16272           required: true
16273           type: string
16274   /business/projects:
16275     get:
16276       tags:
16277         - Business
16278       summary: returns projects
16279       description: returns projects
16280       operationId: getBusinessProjects
16281       produces:
16282         - application/json
16283         - application/xml
16284       responses:
16285         "200":
16286           description: successful operation
16287           schema:
16288               $ref: "#/getDefinitions/projects"
16289         "default":
16290           description: Response codes found in [response codes](https://wiki.onap.org/).
16291       parameters:
16292         - name: project-name
16293           in: query
16294           description:
16295           required: false
16296           type: string
16297   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16298     put:
16299       tags:
16300         - ServiceDesignAndCreation
16301       summary: see node definition for valid relationships
16302       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16303       consumes:
16304         - application/json
16305         - application/xml
16306       produces:
16307         - application/json
16308         - application/xml
16309       responses:
16310         "default":
16311           description: Response codes found in [response codes](https://wiki.onap.org/).
16312       parameters:
16313         - name: vnf-image-uuid
16314           in: path
16315           description: Unique ID of this asset
16316           required: true
16317           type: string
16318           example: __VNF-IMAGE-UUID__
16319         - name: body
16320           in: body
16321           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
16322           required: true
16323           schema:
16324             $ref: "#/definitions/relationship"
16325     delete:
16326       tags:
16327         - ServiceDesignAndCreation
16328       summary: delete an existing relationship
16329       description: delete an existing relationship
16330       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16331       consumes:
16332         - application/json
16333         - application/xml
16334       produces:
16335         - application/json
16336         - application/xml
16337       responses:
16338         "default":
16339           description: Response codes found in [response codes](https://wiki.onap.org/).
16340       parameters:
16341         - name: vnf-image-uuid
16342           in: path
16343           description: Unique ID of this asset
16344           required: true
16345           type: string
16346           example: __VNF-IMAGE-UUID__
16347   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16348     get:
16349       tags:
16350         - ServiceDesignAndCreation
16351       summary: returns vnf-image
16352       description: returns vnf-image
16353       operationId: getServiceDesignAndCreationVnfImagesVnfImage
16354       produces:
16355         - application/json
16356         - application/xml
16357       responses:
16358         "200":
16359           description: successful operation
16360           schema:
16361               $ref: "#/getDefinitions/vnf-image"
16362         "default":
16363           description: Response codes found in [response codes](https://wiki.onap.org/).
16364       parameters:
16365         - name: vnf-image-uuid
16366           in: path
16367           description: Unique ID of this asset
16368           required: true
16369           type: string
16370           example: __VNF-IMAGE-UUID__
16371     put:
16372       tags:
16373         - ServiceDesignAndCreation
16374       summary: create or update an existing vnf-image
16375       description: |
16376         Create or update an existing vnf-image.
16377         #
16378         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16379       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16380       consumes:
16381         - application/json
16382         - application/xml
16383       produces:
16384         - application/json
16385         - application/xml
16386       responses:
16387         "default":
16388           description: Response codes found in [response codes](https://wiki.onap.org/).
16389       parameters:
16390         - name: vnf-image-uuid
16391           in: path
16392           description: Unique ID of this asset
16393           required: true
16394           type: string
16395           example: __VNF-IMAGE-UUID__
16396         - name: body
16397           in: body
16398           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
16399           required: true
16400           schema:
16401             $ref: "#/definitions/vnf-image"
16402     patch:
16403       tags:
16404         - ServiceDesignAndCreation
16405       summary: update an existing vnf-image
16406       description: |
16407         Update an existing vnf-image
16408         #
16409         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16410         The PUT operation will entirely replace an existing object.
16411         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16412         #
16413         Other differences between PUT and PATCH are:
16414         #
16415         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16416         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16417         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16418       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16419       consumes:
16420         - application/json
16421         - application/xml
16422       produces:
16423         - application/json
16424         - application/xml
16425       responses:
16426         "default":
16427           description: Response codes found in [response codes](https://wiki.onap.org/).
16428       parameters:
16429         - name: vnf-image-uuid
16430           in: path
16431           description: Unique ID of this asset
16432           required: true
16433           type: string
16434           example: __VNF-IMAGE-UUID__
16435         - name: body
16436           in: body
16437           description: vnf-image object that needs to be updated.
16438           required: true
16439           schema:
16440             $ref: "#/patchDefinitions/vnf-image"
16441     delete:
16442       tags:
16443         - ServiceDesignAndCreation
16444       summary: delete an existing vnf-image
16445       description: delete an existing vnf-image
16446       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16447       consumes:
16448         - application/json
16449         - application/xml
16450       produces:
16451         - application/json
16452         - application/xml
16453       responses:
16454         "default":
16455           description: Response codes found in [response codes](https://wiki.onap.org/).
16456       parameters:
16457         - name: vnf-image-uuid
16458           in: path
16459           description: Unique ID of this asset
16460           required: true
16461           type: string
16462           example: __VNF-IMAGE-UUID__
16463         - name: resource-version
16464           in: query
16465           description: resource-version for concurrency
16466           required: true
16467           type: string
16468   /service-design-and-creation/vnf-images:
16469     get:
16470       tags:
16471         - ServiceDesignAndCreation
16472       summary: returns vnf-images
16473       description: returns vnf-images
16474       operationId: getServiceDesignAndCreationVnfImages
16475       produces:
16476         - application/json
16477         - application/xml
16478       responses:
16479         "200":
16480           description: successful operation
16481           schema:
16482               $ref: "#/getDefinitions/vnf-images"
16483         "default":
16484           description: Response codes found in [response codes](https://wiki.onap.org/).
16485       parameters:
16486         - name: vnf-image-uuid
16487           in: query
16488           description:
16489           required: false
16490           type: string
16491         - name: application
16492           in: query
16493           description:
16494           required: false
16495           type: string
16496         - name: application-vendor
16497           in: query
16498           description:
16499           required: false
16500           type: string
16501         - name: application-version
16502           in: query
16503           description:
16504           required: false
16505           type: string
16506   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16507     put:
16508       tags:
16509         - ServiceDesignAndCreation
16510       summary: see node definition for valid relationships
16511       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16512       consumes:
16513         - application/json
16514         - application/xml
16515       produces:
16516         - application/json
16517         - application/xml
16518       responses:
16519         "default":
16520           description: Response codes found in [response codes](https://wiki.onap.org/).
16521       parameters:
16522         - name: service-id
16523           in: path
16524           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16525           required: true
16526           type: string
16527           example: __SERVICE-ID__
16528         - name: body
16529           in: body
16530           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
16531           required: true
16532           schema:
16533             $ref: "#/definitions/relationship"
16534     delete:
16535       tags:
16536         - ServiceDesignAndCreation
16537       summary: delete an existing relationship
16538       description: delete an existing relationship
16539       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16540       consumes:
16541         - application/json
16542         - application/xml
16543       produces:
16544         - application/json
16545         - application/xml
16546       responses:
16547         "default":
16548           description: Response codes found in [response codes](https://wiki.onap.org/).
16549       parameters:
16550         - name: service-id
16551           in: path
16552           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16553           required: true
16554           type: string
16555           example: __SERVICE-ID__
16556   /service-design-and-creation/services/service/{service-id}:
16557     get:
16558       tags:
16559         - ServiceDesignAndCreation
16560       summary: returns service
16561       description: returns service
16562       operationId: getServiceDesignAndCreationServicesService
16563       produces:
16564         - application/json
16565         - application/xml
16566       responses:
16567         "200":
16568           description: successful operation
16569           schema:
16570               $ref: "#/getDefinitions/service"
16571         "default":
16572           description: Response codes found in [response codes](https://wiki.onap.org/).
16573       parameters:
16574         - name: service-id
16575           in: path
16576           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16577           required: true
16578           type: string
16579           example: __SERVICE-ID__
16580     put:
16581       tags:
16582         - ServiceDesignAndCreation
16583       summary: create or update an existing service
16584       description: |
16585         Create or update an existing service.
16586         #
16587         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16588       operationId: createOrUpdateServiceDesignAndCreationServicesService
16589       consumes:
16590         - application/json
16591         - application/xml
16592       produces:
16593         - application/json
16594         - application/xml
16595       responses:
16596         "default":
16597           description: Response codes found in [response codes](https://wiki.onap.org/).
16598       parameters:
16599         - name: service-id
16600           in: path
16601           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16602           required: true
16603           type: string
16604           example: __SERVICE-ID__
16605         - name: body
16606           in: body
16607           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
16608           required: true
16609           schema:
16610             $ref: "#/definitions/service"
16611     patch:
16612       tags:
16613         - ServiceDesignAndCreation
16614       summary: update an existing service
16615       description: |
16616         Update an existing service
16617         #
16618         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16619         The PUT operation will entirely replace an existing object.
16620         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16621         #
16622         Other differences between PUT and PATCH are:
16623         #
16624         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16625         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16626         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16627       operationId: UpdateServiceDesignAndCreationServicesService
16628       consumes:
16629         - application/json
16630         - application/xml
16631       produces:
16632         - application/json
16633         - application/xml
16634       responses:
16635         "default":
16636           description: Response codes found in [response codes](https://wiki.onap.org/).
16637       parameters:
16638         - name: service-id
16639           in: path
16640           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16641           required: true
16642           type: string
16643           example: __SERVICE-ID__
16644         - name: body
16645           in: body
16646           description: service object that needs to be updated.
16647           required: true
16648           schema:
16649             $ref: "#/patchDefinitions/service"
16650     delete:
16651       tags:
16652         - ServiceDesignAndCreation
16653       summary: delete an existing service
16654       description: delete an existing service
16655       operationId: deleteServiceDesignAndCreationServicesService
16656       consumes:
16657         - application/json
16658         - application/xml
16659       produces:
16660         - application/json
16661         - application/xml
16662       responses:
16663         "default":
16664           description: Response codes found in [response codes](https://wiki.onap.org/).
16665       parameters:
16666         - name: service-id
16667           in: path
16668           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16669           required: true
16670           type: string
16671           example: __SERVICE-ID__
16672         - name: resource-version
16673           in: query
16674           description: resource-version for concurrency
16675           required: true
16676           type: string
16677   /service-design-and-creation/services:
16678     get:
16679       tags:
16680         - ServiceDesignAndCreation
16681       summary: returns services
16682       description: returns services
16683       operationId: getServiceDesignAndCreationServices
16684       produces:
16685         - application/json
16686         - application/xml
16687       responses:
16688         "200":
16689           description: successful operation
16690           schema:
16691               $ref: "#/getDefinitions/services"
16692         "default":
16693           description: Response codes found in [response codes](https://wiki.onap.org/).
16694       parameters:
16695         - name: service-id
16696           in: query
16697           description:
16698           required: false
16699           type: string
16700         - name: service-description
16701           in: query
16702           description:
16703           required: false
16704           type: string
16705   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
16706     put:
16707       tags:
16708         - ServiceDesignAndCreation
16709       summary: see node definition for valid relationships
16710       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
16711       consumes:
16712         - application/json
16713         - application/xml
16714       produces:
16715         - application/json
16716         - application/xml
16717       responses:
16718         "default":
16719           description: Response codes found in [response codes](https://wiki.onap.org/).
16720       parameters:
16721         - name: service-type
16722           in: path
16723           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16724           required: true
16725           type: string
16726           example: __SERVICE-TYPE__
16727         - name: vnf-type
16728           in: path
16729           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.
16730           required: true
16731           type: string
16732           example: __VNF-TYPE__
16733         - name: body
16734           in: body
16735           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
16736           required: true
16737           schema:
16738             $ref: "#/definitions/relationship"
16739     delete:
16740       tags:
16741         - ServiceDesignAndCreation
16742       summary: delete an existing relationship
16743       description: delete an existing relationship
16744       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
16745       consumes:
16746         - application/json
16747         - application/xml
16748       produces:
16749         - application/json
16750         - application/xml
16751       responses:
16752         "default":
16753           description: Response codes found in [response codes](https://wiki.onap.org/).
16754       parameters:
16755         - name: service-type
16756           in: path
16757           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16758           required: true
16759           type: string
16760           example: __SERVICE-TYPE__
16761         - name: vnf-type
16762           in: path
16763           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.
16764           required: true
16765           type: string
16766           example: __VNF-TYPE__
16767   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
16768     get:
16769       tags:
16770         - ServiceDesignAndCreation
16771       summary: returns service-capability
16772       description: returns service-capability
16773       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
16774       produces:
16775         - application/json
16776         - application/xml
16777       responses:
16778         "200":
16779           description: successful operation
16780           schema:
16781               $ref: "#/getDefinitions/service-capability"
16782         "default":
16783           description: Response codes found in [response codes](https://wiki.onap.org/).
16784       parameters:
16785         - name: service-type
16786           in: path
16787           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16788           required: true
16789           type: string
16790           example: __SERVICE-TYPE__
16791         - name: vnf-type
16792           in: path
16793           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.
16794           required: true
16795           type: string
16796           example: __VNF-TYPE__
16797     put:
16798       tags:
16799         - ServiceDesignAndCreation
16800       summary: create or update an existing service-capability
16801       description: |
16802         Create or update an existing service-capability.
16803         #
16804         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16805       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
16806       consumes:
16807         - application/json
16808         - application/xml
16809       produces:
16810         - application/json
16811         - application/xml
16812       responses:
16813         "default":
16814           description: Response codes found in [response codes](https://wiki.onap.org/).
16815       parameters:
16816         - name: service-type
16817           in: path
16818           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16819           required: true
16820           type: string
16821           example: __SERVICE-TYPE__
16822         - name: vnf-type
16823           in: path
16824           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.
16825           required: true
16826           type: string
16827           example: __VNF-TYPE__
16828         - name: body
16829           in: body
16830           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
16831           required: true
16832           schema:
16833             $ref: "#/definitions/service-capability"
16834     patch:
16835       tags:
16836         - ServiceDesignAndCreation
16837       summary: update an existing service-capability
16838       description: |
16839         Update an existing service-capability
16840         #
16841         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16842         The PUT operation will entirely replace an existing object.
16843         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16844         #
16845         Other differences between PUT and PATCH are:
16846         #
16847         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16848         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16849         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16850       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
16851       consumes:
16852         - application/json
16853         - application/xml
16854       produces:
16855         - application/json
16856         - application/xml
16857       responses:
16858         "default":
16859           description: Response codes found in [response codes](https://wiki.onap.org/).
16860       parameters:
16861         - name: service-type
16862           in: path
16863           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16864           required: true
16865           type: string
16866           example: __SERVICE-TYPE__
16867         - name: vnf-type
16868           in: path
16869           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.
16870           required: true
16871           type: string
16872           example: __VNF-TYPE__
16873         - name: body
16874           in: body
16875           description: service-capability object that needs to be updated.
16876           required: true
16877           schema:
16878             $ref: "#/patchDefinitions/service-capability"
16879     delete:
16880       tags:
16881         - ServiceDesignAndCreation
16882       summary: delete an existing service-capability
16883       description: delete an existing service-capability
16884       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
16885       consumes:
16886         - application/json
16887         - application/xml
16888       produces:
16889         - application/json
16890         - application/xml
16891       responses:
16892         "default":
16893           description: Response codes found in [response codes](https://wiki.onap.org/).
16894       parameters:
16895         - name: service-type
16896           in: path
16897           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16898           required: true
16899           type: string
16900           example: __SERVICE-TYPE__
16901         - name: vnf-type
16902           in: path
16903           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.
16904           required: true
16905           type: string
16906           example: __VNF-TYPE__
16907         - name: resource-version
16908           in: query
16909           description: resource-version for concurrency
16910           required: true
16911           type: string
16912   /service-design-and-creation/service-capabilities:
16913     get:
16914       tags:
16915         - ServiceDesignAndCreation
16916       summary: returns service-capabilities
16917       description: returns service-capabilities
16918       operationId: getServiceDesignAndCreationServiceCapabilities
16919       produces:
16920         - application/json
16921         - application/xml
16922       responses:
16923         "200":
16924           description: successful operation
16925           schema:
16926               $ref: "#/getDefinitions/service-capabilities"
16927         "default":
16928           description: Response codes found in [response codes](https://wiki.onap.org/).
16929       parameters:
16930         - name: service-type
16931           in: query
16932           description:
16933           required: false
16934           type: string
16935         - name: vnf-type
16936           in: query
16937           description:
16938           required: false
16939           type: string
16940   /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:
16941     put:
16942       tags:
16943         - ServiceDesignAndCreation
16944       summary: see node definition for valid relationships
16945       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16946       consumes:
16947         - application/json
16948         - application/xml
16949       produces:
16950         - application/json
16951         - application/xml
16952       responses:
16953         "default":
16954           description: Response codes found in [response codes](https://wiki.onap.org/).
16955       parameters:
16956         - name: model-invariant-id
16957           in: path
16958           description: Unique identifier corresponding to the main definition of a model in ASDC
16959           required: true
16960           type: string
16961           example: __MODEL-INVARIANT-ID__
16962         - name: model-version-id
16963           in: path
16964           description: Unique identifier corresponding to one version of a model in ASDC
16965           required: true
16966           type: string
16967           example: __MODEL-VERSION-ID__
16968         - name: model-element-uuid
16969           in: path
16970           required: true
16971           type: string
16972           example: __MODEL-ELEMENT-UUID__
16973         - name: model-constraint-uuid
16974           in: path
16975           required: true
16976           type: string
16977           example: __MODEL-CONSTRAINT-UUID__
16978         - name: constrained-element-set-uuid
16979           in: path
16980           required: true
16981           type: string
16982           example: __CONSTRAINED-ELEMENT-SET-UUID__
16983         - name: element-choice-set-uuid
16984           in: path
16985           required: true
16986           type: string
16987           example: __ELEMENT-CHOICE-SET-UUID__
16988         - name: body
16989           in: body
16990           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16991           required: true
16992           schema:
16993             $ref: "#/definitions/relationship"
16994     delete:
16995       tags:
16996         - ServiceDesignAndCreation
16997       summary: delete an existing relationship
16998       description: delete an existing relationship
16999       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17000       consumes:
17001         - application/json
17002         - application/xml
17003       produces:
17004         - application/json
17005         - application/xml
17006       responses:
17007         "default":
17008           description: Response codes found in [response codes](https://wiki.onap.org/).
17009       parameters:
17010         - name: model-invariant-id
17011           in: path
17012           description: Unique identifier corresponding to the main definition of a model in ASDC
17013           required: true
17014           type: string
17015           example: __MODEL-INVARIANT-ID__
17016         - name: model-version-id
17017           in: path
17018           description: Unique identifier corresponding to one version of a model in ASDC
17019           required: true
17020           type: string
17021           example: __MODEL-VERSION-ID__
17022         - name: model-element-uuid
17023           in: path
17024           required: true
17025           type: string
17026           example: __MODEL-ELEMENT-UUID__
17027         - name: model-constraint-uuid
17028           in: path
17029           required: true
17030           type: string
17031           example: __MODEL-CONSTRAINT-UUID__
17032         - name: constrained-element-set-uuid
17033           in: path
17034           required: true
17035           type: string
17036           example: __CONSTRAINED-ELEMENT-SET-UUID__
17037         - name: element-choice-set-uuid
17038           in: path
17039           required: true
17040           type: string
17041           example: __ELEMENT-CHOICE-SET-UUID__
17042   /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}:
17043     get:
17044       tags:
17045         - ServiceDesignAndCreation
17046       summary: returns element-choice-set
17047       description: returns element-choice-set
17048       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17049       produces:
17050         - application/json
17051         - application/xml
17052       responses:
17053         "200":
17054           description: successful operation
17055           schema:
17056               $ref: "#/getDefinitions/element-choice-set"
17057         "default":
17058           description: Response codes found in [response codes](https://wiki.onap.org/).
17059       parameters:
17060         - name: model-invariant-id
17061           in: path
17062           description: Unique identifier corresponding to the main definition of a model in ASDC
17063           required: true
17064           type: string
17065           example: __MODEL-INVARIANT-ID__
17066         - name: model-version-id
17067           in: path
17068           description: Unique identifier corresponding to one version of a model in ASDC
17069           required: true
17070           type: string
17071           example: __MODEL-VERSION-ID__
17072         - name: model-element-uuid
17073           in: path
17074           required: true
17075           type: string
17076           example: __MODEL-ELEMENT-UUID__
17077         - name: model-constraint-uuid
17078           in: path
17079           required: true
17080           type: string
17081           example: __MODEL-CONSTRAINT-UUID__
17082         - name: constrained-element-set-uuid
17083           in: path
17084           required: true
17085           type: string
17086           example: __CONSTRAINED-ELEMENT-SET-UUID__
17087         - name: element-choice-set-uuid
17088           in: path
17089           required: true
17090           type: string
17091           example: __ELEMENT-CHOICE-SET-UUID__
17092     put:
17093       tags:
17094         - ServiceDesignAndCreation
17095       summary: create or update an existing element-choice-set
17096       description: |
17097         Create or update an existing element-choice-set.
17098         #
17099         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17100       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17101       consumes:
17102         - application/json
17103         - application/xml
17104       produces:
17105         - application/json
17106         - application/xml
17107       responses:
17108         "default":
17109           description: Response codes found in [response codes](https://wiki.onap.org/).
17110       parameters:
17111         - name: model-invariant-id
17112           in: path
17113           description: Unique identifier corresponding to the main definition of a model in ASDC
17114           required: true
17115           type: string
17116           example: __MODEL-INVARIANT-ID__
17117         - name: model-version-id
17118           in: path
17119           description: Unique identifier corresponding to one version of a model in ASDC
17120           required: true
17121           type: string
17122           example: __MODEL-VERSION-ID__
17123         - name: model-element-uuid
17124           in: path
17125           required: true
17126           type: string
17127           example: __MODEL-ELEMENT-UUID__
17128         - name: model-constraint-uuid
17129           in: path
17130           required: true
17131           type: string
17132           example: __MODEL-CONSTRAINT-UUID__
17133         - name: constrained-element-set-uuid
17134           in: path
17135           required: true
17136           type: string
17137           example: __CONSTRAINED-ELEMENT-SET-UUID__
17138         - name: element-choice-set-uuid
17139           in: path
17140           required: true
17141           type: string
17142           example: __ELEMENT-CHOICE-SET-UUID__
17143         - name: body
17144           in: body
17145           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17146           required: true
17147           schema:
17148             $ref: "#/definitions/element-choice-set"
17149     patch:
17150       tags:
17151         - ServiceDesignAndCreation
17152       summary: update an existing element-choice-set
17153       description: |
17154         Update an existing element-choice-set
17155         #
17156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17157         The PUT operation will entirely replace an existing object.
17158         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17159         #
17160         Other differences between PUT and PATCH are:
17161         #
17162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17165       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17166       consumes:
17167         - application/json
17168         - application/xml
17169       produces:
17170         - application/json
17171         - application/xml
17172       responses:
17173         "default":
17174           description: Response codes found in [response codes](https://wiki.onap.org/).
17175       parameters:
17176         - name: model-invariant-id
17177           in: path
17178           description: Unique identifier corresponding to the main definition of a model in ASDC
17179           required: true
17180           type: string
17181           example: __MODEL-INVARIANT-ID__
17182         - name: model-version-id
17183           in: path
17184           description: Unique identifier corresponding to one version of a model in ASDC
17185           required: true
17186           type: string
17187           example: __MODEL-VERSION-ID__
17188         - name: model-element-uuid
17189           in: path
17190           required: true
17191           type: string
17192           example: __MODEL-ELEMENT-UUID__
17193         - name: model-constraint-uuid
17194           in: path
17195           required: true
17196           type: string
17197           example: __MODEL-CONSTRAINT-UUID__
17198         - name: constrained-element-set-uuid
17199           in: path
17200           required: true
17201           type: string
17202           example: __CONSTRAINED-ELEMENT-SET-UUID__
17203         - name: element-choice-set-uuid
17204           in: path
17205           required: true
17206           type: string
17207           example: __ELEMENT-CHOICE-SET-UUID__
17208         - name: body
17209           in: body
17210           description: element-choice-set object that needs to be updated.
17211           required: true
17212           schema:
17213             $ref: "#/patchDefinitions/element-choice-set"
17214     delete:
17215       tags:
17216         - ServiceDesignAndCreation
17217       summary: delete an existing element-choice-set
17218       description: delete an existing element-choice-set
17219       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17220       consumes:
17221         - application/json
17222         - application/xml
17223       produces:
17224         - application/json
17225         - application/xml
17226       responses:
17227         "default":
17228           description: Response codes found in [response codes](https://wiki.onap.org/).
17229       parameters:
17230         - name: model-invariant-id
17231           in: path
17232           description: Unique identifier corresponding to the main definition of a model in ASDC
17233           required: true
17234           type: string
17235           example: __MODEL-INVARIANT-ID__
17236         - name: model-version-id
17237           in: path
17238           description: Unique identifier corresponding to one version of a model in ASDC
17239           required: true
17240           type: string
17241           example: __MODEL-VERSION-ID__
17242         - name: model-element-uuid
17243           in: path
17244           required: true
17245           type: string
17246           example: __MODEL-ELEMENT-UUID__
17247         - name: model-constraint-uuid
17248           in: path
17249           required: true
17250           type: string
17251           example: __MODEL-CONSTRAINT-UUID__
17252         - name: constrained-element-set-uuid
17253           in: path
17254           required: true
17255           type: string
17256           example: __CONSTRAINED-ELEMENT-SET-UUID__
17257         - name: element-choice-set-uuid
17258           in: path
17259           required: true
17260           type: string
17261           example: __ELEMENT-CHOICE-SET-UUID__
17262         - name: resource-version
17263           in: query
17264           description: resource-version for concurrency
17265           required: true
17266           type: string
17267   /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:
17268     get:
17269       tags:
17270         - ServiceDesignAndCreation
17271       summary: returns element-choice-sets
17272       description: returns element-choice-sets
17273       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17274       produces:
17275         - application/json
17276         - application/xml
17277       responses:
17278         "200":
17279           description: successful operation
17280           schema:
17281               $ref: "#/getDefinitions/element-choice-sets"
17282         "default":
17283           description: Response codes found in [response codes](https://wiki.onap.org/).
17284       parameters:
17285         - name: model-invariant-id
17286           in: path
17287           description: Unique identifier corresponding to the main definition of a model in ASDC
17288           required: true
17289           type: string
17290           example: __MODEL-INVARIANT-ID__
17291         - name: model-version-id
17292           in: path
17293           description: Unique identifier corresponding to one version of a model in ASDC
17294           required: true
17295           type: string
17296           example: __MODEL-VERSION-ID__
17297         - name: model-element-uuid
17298           in: path
17299           required: true
17300           type: string
17301           example: __MODEL-ELEMENT-UUID__
17302         - name: model-constraint-uuid
17303           in: path
17304           required: true
17305           type: string
17306           example: __MODEL-CONSTRAINT-UUID__
17307         - name: constrained-element-set-uuid
17308           in: path
17309           required: true
17310           type: string
17311           example: __CONSTRAINED-ELEMENT-SET-UUID__
17312         - name: element-choice-set-uuid
17313           in: query
17314           description:
17315           required: false
17316           type: string
17317   /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:
17318     put:
17319       tags:
17320         - ServiceDesignAndCreation
17321       summary: see node definition for valid relationships
17322       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17323       consumes:
17324         - application/json
17325         - application/xml
17326       produces:
17327         - application/json
17328         - application/xml
17329       responses:
17330         "default":
17331           description: Response codes found in [response codes](https://wiki.onap.org/).
17332       parameters:
17333         - name: model-invariant-id
17334           in: path
17335           description: Unique identifier corresponding to the main definition of a model in ASDC
17336           required: true
17337           type: string
17338           example: __MODEL-INVARIANT-ID__
17339         - name: model-version-id
17340           in: path
17341           description: Unique identifier corresponding to one version of a model in ASDC
17342           required: true
17343           type: string
17344           example: __MODEL-VERSION-ID__
17345         - name: model-element-uuid
17346           in: path
17347           required: true
17348           type: string
17349           example: __MODEL-ELEMENT-UUID__
17350         - name: model-constraint-uuid
17351           in: path
17352           required: true
17353           type: string
17354           example: __MODEL-CONSTRAINT-UUID__
17355         - name: constrained-element-set-uuid
17356           in: path
17357           required: true
17358           type: string
17359           example: __CONSTRAINED-ELEMENT-SET-UUID__
17360         - name: body
17361           in: body
17362           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17363           required: true
17364           schema:
17365             $ref: "#/definitions/relationship"
17366     delete:
17367       tags:
17368         - ServiceDesignAndCreation
17369       summary: delete an existing relationship
17370       description: delete an existing relationship
17371       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17372       consumes:
17373         - application/json
17374         - application/xml
17375       produces:
17376         - application/json
17377         - application/xml
17378       responses:
17379         "default":
17380           description: Response codes found in [response codes](https://wiki.onap.org/).
17381       parameters:
17382         - name: model-invariant-id
17383           in: path
17384           description: Unique identifier corresponding to the main definition of a model in ASDC
17385           required: true
17386           type: string
17387           example: __MODEL-INVARIANT-ID__
17388         - name: model-version-id
17389           in: path
17390           description: Unique identifier corresponding to one version of a model in ASDC
17391           required: true
17392           type: string
17393           example: __MODEL-VERSION-ID__
17394         - name: model-element-uuid
17395           in: path
17396           required: true
17397           type: string
17398           example: __MODEL-ELEMENT-UUID__
17399         - name: model-constraint-uuid
17400           in: path
17401           required: true
17402           type: string
17403           example: __MODEL-CONSTRAINT-UUID__
17404         - name: constrained-element-set-uuid
17405           in: path
17406           required: true
17407           type: string
17408           example: __CONSTRAINED-ELEMENT-SET-UUID__
17409   /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}:
17410     get:
17411       tags:
17412         - ServiceDesignAndCreation
17413       summary: returns constrained-element-set
17414       description: returns constrained-element-set
17415       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17416       produces:
17417         - application/json
17418         - application/xml
17419       responses:
17420         "200":
17421           description: successful operation
17422           schema:
17423               $ref: "#/getDefinitions/constrained-element-set"
17424         "default":
17425           description: Response codes found in [response codes](https://wiki.onap.org/).
17426       parameters:
17427         - name: model-invariant-id
17428           in: path
17429           description: Unique identifier corresponding to the main definition of a model in ASDC
17430           required: true
17431           type: string
17432           example: __MODEL-INVARIANT-ID__
17433         - name: model-version-id
17434           in: path
17435           description: Unique identifier corresponding to one version of a model in ASDC
17436           required: true
17437           type: string
17438           example: __MODEL-VERSION-ID__
17439         - name: model-element-uuid
17440           in: path
17441           required: true
17442           type: string
17443           example: __MODEL-ELEMENT-UUID__
17444         - name: model-constraint-uuid
17445           in: path
17446           required: true
17447           type: string
17448           example: __MODEL-CONSTRAINT-UUID__
17449         - name: constrained-element-set-uuid
17450           in: path
17451           required: true
17452           type: string
17453           example: __CONSTRAINED-ELEMENT-SET-UUID__
17454     put:
17455       tags:
17456         - ServiceDesignAndCreation
17457       summary: create or update an existing constrained-element-set
17458       description: |
17459         Create or update an existing constrained-element-set.
17460         #
17461         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17462       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17463       consumes:
17464         - application/json
17465         - application/xml
17466       produces:
17467         - application/json
17468         - application/xml
17469       responses:
17470         "default":
17471           description: Response codes found in [response codes](https://wiki.onap.org/).
17472       parameters:
17473         - name: model-invariant-id
17474           in: path
17475           description: Unique identifier corresponding to the main definition of a model in ASDC
17476           required: true
17477           type: string
17478           example: __MODEL-INVARIANT-ID__
17479         - name: model-version-id
17480           in: path
17481           description: Unique identifier corresponding to one version of a model in ASDC
17482           required: true
17483           type: string
17484           example: __MODEL-VERSION-ID__
17485         - name: model-element-uuid
17486           in: path
17487           required: true
17488           type: string
17489           example: __MODEL-ELEMENT-UUID__
17490         - name: model-constraint-uuid
17491           in: path
17492           required: true
17493           type: string
17494           example: __MODEL-CONSTRAINT-UUID__
17495         - name: constrained-element-set-uuid
17496           in: path
17497           required: true
17498           type: string
17499           example: __CONSTRAINED-ELEMENT-SET-UUID__
17500         - name: body
17501           in: body
17502           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17503           required: true
17504           schema:
17505             $ref: "#/definitions/constrained-element-set"
17506     patch:
17507       tags:
17508         - ServiceDesignAndCreation
17509       summary: update an existing constrained-element-set
17510       description: |
17511         Update an existing constrained-element-set
17512         #
17513         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17514         The PUT operation will entirely replace an existing object.
17515         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17516         #
17517         Other differences between PUT and PATCH are:
17518         #
17519         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17520         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17521         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17522       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17523       consumes:
17524         - application/json
17525         - application/xml
17526       produces:
17527         - application/json
17528         - application/xml
17529       responses:
17530         "default":
17531           description: Response codes found in [response codes](https://wiki.onap.org/).
17532       parameters:
17533         - name: model-invariant-id
17534           in: path
17535           description: Unique identifier corresponding to the main definition of a model in ASDC
17536           required: true
17537           type: string
17538           example: __MODEL-INVARIANT-ID__
17539         - name: model-version-id
17540           in: path
17541           description: Unique identifier corresponding to one version of a model in ASDC
17542           required: true
17543           type: string
17544           example: __MODEL-VERSION-ID__
17545         - name: model-element-uuid
17546           in: path
17547           required: true
17548           type: string
17549           example: __MODEL-ELEMENT-UUID__
17550         - name: model-constraint-uuid
17551           in: path
17552           required: true
17553           type: string
17554           example: __MODEL-CONSTRAINT-UUID__
17555         - name: constrained-element-set-uuid
17556           in: path
17557           required: true
17558           type: string
17559           example: __CONSTRAINED-ELEMENT-SET-UUID__
17560         - name: body
17561           in: body
17562           description: constrained-element-set object that needs to be updated.
17563           required: true
17564           schema:
17565             $ref: "#/patchDefinitions/constrained-element-set"
17566     delete:
17567       tags:
17568         - ServiceDesignAndCreation
17569       summary: delete an existing constrained-element-set
17570       description: delete an existing constrained-element-set
17571       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17572       consumes:
17573         - application/json
17574         - application/xml
17575       produces:
17576         - application/json
17577         - application/xml
17578       responses:
17579         "default":
17580           description: Response codes found in [response codes](https://wiki.onap.org/).
17581       parameters:
17582         - name: model-invariant-id
17583           in: path
17584           description: Unique identifier corresponding to the main definition of a model in ASDC
17585           required: true
17586           type: string
17587           example: __MODEL-INVARIANT-ID__
17588         - name: model-version-id
17589           in: path
17590           description: Unique identifier corresponding to one version of a model in ASDC
17591           required: true
17592           type: string
17593           example: __MODEL-VERSION-ID__
17594         - name: model-element-uuid
17595           in: path
17596           required: true
17597           type: string
17598           example: __MODEL-ELEMENT-UUID__
17599         - name: model-constraint-uuid
17600           in: path
17601           required: true
17602           type: string
17603           example: __MODEL-CONSTRAINT-UUID__
17604         - name: constrained-element-set-uuid
17605           in: path
17606           required: true
17607           type: string
17608           example: __CONSTRAINED-ELEMENT-SET-UUID__
17609         - name: resource-version
17610           in: query
17611           description: resource-version for concurrency
17612           required: true
17613           type: string
17614   /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:
17615     get:
17616       tags:
17617         - ServiceDesignAndCreation
17618       summary: returns constrained-element-sets
17619       description: returns constrained-element-sets
17620       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17621       produces:
17622         - application/json
17623         - application/xml
17624       responses:
17625         "200":
17626           description: successful operation
17627           schema:
17628               $ref: "#/getDefinitions/constrained-element-sets"
17629         "default":
17630           description: Response codes found in [response codes](https://wiki.onap.org/).
17631       parameters:
17632         - name: model-invariant-id
17633           in: path
17634           description: Unique identifier corresponding to the main definition of a model in ASDC
17635           required: true
17636           type: string
17637           example: __MODEL-INVARIANT-ID__
17638         - name: model-version-id
17639           in: path
17640           description: Unique identifier corresponding to one version of a model in ASDC
17641           required: true
17642           type: string
17643           example: __MODEL-VERSION-ID__
17644         - name: model-element-uuid
17645           in: path
17646           required: true
17647           type: string
17648           example: __MODEL-ELEMENT-UUID__
17649         - name: model-constraint-uuid
17650           in: path
17651           required: true
17652           type: string
17653           example: __MODEL-CONSTRAINT-UUID__
17654         - name: constrained-element-set-uuid
17655           in: query
17656           description:
17657           required: false
17658           type: string
17659   /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}:
17660     get:
17661       tags:
17662         - ServiceDesignAndCreation
17663       summary: returns model-constraint
17664       description: returns model-constraint
17665       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17666       produces:
17667         - application/json
17668         - application/xml
17669       responses:
17670         "200":
17671           description: successful operation
17672           schema:
17673               $ref: "#/getDefinitions/model-constraint"
17674         "default":
17675           description: Response codes found in [response codes](https://wiki.onap.org/).
17676       parameters:
17677         - name: model-invariant-id
17678           in: path
17679           description: Unique identifier corresponding to the main definition of a model in ASDC
17680           required: true
17681           type: string
17682           example: __MODEL-INVARIANT-ID__
17683         - name: model-version-id
17684           in: path
17685           description: Unique identifier corresponding to one version of a model in ASDC
17686           required: true
17687           type: string
17688           example: __MODEL-VERSION-ID__
17689         - name: model-element-uuid
17690           in: path
17691           required: true
17692           type: string
17693           example: __MODEL-ELEMENT-UUID__
17694         - name: model-constraint-uuid
17695           in: path
17696           required: true
17697           type: string
17698           example: __MODEL-CONSTRAINT-UUID__
17699     put:
17700       tags:
17701         - ServiceDesignAndCreation
17702       summary: create or update an existing model-constraint
17703       description: |
17704         Create or update an existing model-constraint.
17705         #
17706         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17707       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17708       consumes:
17709         - application/json
17710         - application/xml
17711       produces:
17712         - application/json
17713         - application/xml
17714       responses:
17715         "default":
17716           description: Response codes found in [response codes](https://wiki.onap.org/).
17717       parameters:
17718         - name: model-invariant-id
17719           in: path
17720           description: Unique identifier corresponding to the main definition of a model in ASDC
17721           required: true
17722           type: string
17723           example: __MODEL-INVARIANT-ID__
17724         - name: model-version-id
17725           in: path
17726           description: Unique identifier corresponding to one version of a model in ASDC
17727           required: true
17728           type: string
17729           example: __MODEL-VERSION-ID__
17730         - name: model-element-uuid
17731           in: path
17732           required: true
17733           type: string
17734           example: __MODEL-ELEMENT-UUID__
17735         - name: model-constraint-uuid
17736           in: path
17737           required: true
17738           type: string
17739           example: __MODEL-CONSTRAINT-UUID__
17740         - name: body
17741           in: body
17742           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
17743           required: true
17744           schema:
17745             $ref: "#/definitions/model-constraint"
17746     patch:
17747       tags:
17748         - ServiceDesignAndCreation
17749       summary: update an existing model-constraint
17750       description: |
17751         Update an existing model-constraint
17752         #
17753         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17754         The PUT operation will entirely replace an existing object.
17755         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17756         #
17757         Other differences between PUT and PATCH are:
17758         #
17759         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17760         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17761         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17762       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17763       consumes:
17764         - application/json
17765         - application/xml
17766       produces:
17767         - application/json
17768         - application/xml
17769       responses:
17770         "default":
17771           description: Response codes found in [response codes](https://wiki.onap.org/).
17772       parameters:
17773         - name: model-invariant-id
17774           in: path
17775           description: Unique identifier corresponding to the main definition of a model in ASDC
17776           required: true
17777           type: string
17778           example: __MODEL-INVARIANT-ID__
17779         - name: model-version-id
17780           in: path
17781           description: Unique identifier corresponding to one version of a model in ASDC
17782           required: true
17783           type: string
17784           example: __MODEL-VERSION-ID__
17785         - name: model-element-uuid
17786           in: path
17787           required: true
17788           type: string
17789           example: __MODEL-ELEMENT-UUID__
17790         - name: model-constraint-uuid
17791           in: path
17792           required: true
17793           type: string
17794           example: __MODEL-CONSTRAINT-UUID__
17795         - name: body
17796           in: body
17797           description: model-constraint object that needs to be updated.
17798           required: true
17799           schema:
17800             $ref: "#/patchDefinitions/model-constraint"
17801     delete:
17802       tags:
17803         - ServiceDesignAndCreation
17804       summary: delete an existing model-constraint
17805       description: delete an existing model-constraint
17806       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17807       consumes:
17808         - application/json
17809         - application/xml
17810       produces:
17811         - application/json
17812         - application/xml
17813       responses:
17814         "default":
17815           description: Response codes found in [response codes](https://wiki.onap.org/).
17816       parameters:
17817         - name: model-invariant-id
17818           in: path
17819           description: Unique identifier corresponding to the main definition of a model in ASDC
17820           required: true
17821           type: string
17822           example: __MODEL-INVARIANT-ID__
17823         - name: model-version-id
17824           in: path
17825           description: Unique identifier corresponding to one version of a model in ASDC
17826           required: true
17827           type: string
17828           example: __MODEL-VERSION-ID__
17829         - name: model-element-uuid
17830           in: path
17831           required: true
17832           type: string
17833           example: __MODEL-ELEMENT-UUID__
17834         - name: model-constraint-uuid
17835           in: path
17836           required: true
17837           type: string
17838           example: __MODEL-CONSTRAINT-UUID__
17839         - name: resource-version
17840           in: query
17841           description: resource-version for concurrency
17842           required: true
17843           type: string
17844   /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:
17845     get:
17846       tags:
17847         - ServiceDesignAndCreation
17848       summary: returns model-constraints
17849       description: returns model-constraints
17850       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
17851       produces:
17852         - application/json
17853         - application/xml
17854       responses:
17855         "200":
17856           description: successful operation
17857           schema:
17858               $ref: "#/getDefinitions/model-constraints"
17859         "default":
17860           description: Response codes found in [response codes](https://wiki.onap.org/).
17861       parameters:
17862         - name: model-invariant-id
17863           in: path
17864           description: Unique identifier corresponding to the main definition of a model in ASDC
17865           required: true
17866           type: string
17867           example: __MODEL-INVARIANT-ID__
17868         - name: model-version-id
17869           in: path
17870           description: Unique identifier corresponding to one version of a model in ASDC
17871           required: true
17872           type: string
17873           example: __MODEL-VERSION-ID__
17874         - name: model-element-uuid
17875           in: path
17876           required: true
17877           type: string
17878           example: __MODEL-ELEMENT-UUID__
17879         - name: model-constraint-uuid
17880           in: query
17881           description:
17882           required: false
17883           type: string
17884   /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:
17885     put:
17886       tags:
17887         - ServiceDesignAndCreation
17888       summary: see node definition for valid relationships
17889       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
17890       consumes:
17891         - application/json
17892         - application/xml
17893       produces:
17894         - application/json
17895         - application/xml
17896       responses:
17897         "default":
17898           description: Response codes found in [response codes](https://wiki.onap.org/).
17899       parameters:
17900         - name: model-invariant-id
17901           in: path
17902           description: Unique identifier corresponding to the main definition of a model in ASDC
17903           required: true
17904           type: string
17905           example: __MODEL-INVARIANT-ID__
17906         - name: model-version-id
17907           in: path
17908           description: Unique identifier corresponding to one version of a model in ASDC
17909           required: true
17910           type: string
17911           example: __MODEL-VERSION-ID__
17912         - name: model-element-uuid
17913           in: path
17914           required: true
17915           type: string
17916           example: __MODEL-ELEMENT-UUID__
17917         - name: body
17918           in: body
17919           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
17920           required: true
17921           schema:
17922             $ref: "#/definitions/relationship"
17923     delete:
17924       tags:
17925         - ServiceDesignAndCreation
17926       summary: delete an existing relationship
17927       description: delete an existing relationship
17928       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
17929       consumes:
17930         - application/json
17931         - application/xml
17932       produces:
17933         - application/json
17934         - application/xml
17935       responses:
17936         "default":
17937           description: Response codes found in [response codes](https://wiki.onap.org/).
17938       parameters:
17939         - name: model-invariant-id
17940           in: path
17941           description: Unique identifier corresponding to the main definition of a model in ASDC
17942           required: true
17943           type: string
17944           example: __MODEL-INVARIANT-ID__
17945         - name: model-version-id
17946           in: path
17947           description: Unique identifier corresponding to one version of a model in ASDC
17948           required: true
17949           type: string
17950           example: __MODEL-VERSION-ID__
17951         - name: model-element-uuid
17952           in: path
17953           required: true
17954           type: string
17955           example: __MODEL-ELEMENT-UUID__
17956   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
17957     get:
17958       tags:
17959         - ServiceDesignAndCreation
17960       summary: returns model-element
17961       description: returns model-element
17962       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
17963       produces:
17964         - application/json
17965         - application/xml
17966       responses:
17967         "200":
17968           description: successful operation
17969           schema:
17970               $ref: "#/getDefinitions/model-element"
17971         "default":
17972           description: Response codes found in [response codes](https://wiki.onap.org/).
17973       parameters:
17974         - name: model-invariant-id
17975           in: path
17976           description: Unique identifier corresponding to the main definition of a model in ASDC
17977           required: true
17978           type: string
17979           example: __MODEL-INVARIANT-ID__
17980         - name: model-version-id
17981           in: path
17982           description: Unique identifier corresponding to one version of a model in ASDC
17983           required: true
17984           type: string
17985           example: __MODEL-VERSION-ID__
17986         - name: model-element-uuid
17987           in: path
17988           required: true
17989           type: string
17990           example: __MODEL-ELEMENT-UUID__
17991     put:
17992       tags:
17993         - ServiceDesignAndCreation
17994       summary: create or update an existing model-element
17995       description: |
17996         Create or update an existing model-element.
17997         #
17998         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17999       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18000       consumes:
18001         - application/json
18002         - application/xml
18003       produces:
18004         - application/json
18005         - application/xml
18006       responses:
18007         "default":
18008           description: Response codes found in [response codes](https://wiki.onap.org/).
18009       parameters:
18010         - name: model-invariant-id
18011           in: path
18012           description: Unique identifier corresponding to the main definition of a model in ASDC
18013           required: true
18014           type: string
18015           example: __MODEL-INVARIANT-ID__
18016         - name: model-version-id
18017           in: path
18018           description: Unique identifier corresponding to one version of a model in ASDC
18019           required: true
18020           type: string
18021           example: __MODEL-VERSION-ID__
18022         - name: model-element-uuid
18023           in: path
18024           required: true
18025           type: string
18026           example: __MODEL-ELEMENT-UUID__
18027         - name: body
18028           in: body
18029           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18030           required: true
18031           schema:
18032             $ref: "#/definitions/model-element"
18033     patch:
18034       tags:
18035         - ServiceDesignAndCreation
18036       summary: update an existing model-element
18037       description: |
18038         Update an existing model-element
18039         #
18040         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18041         The PUT operation will entirely replace an existing object.
18042         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18043         #
18044         Other differences between PUT and PATCH are:
18045         #
18046         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18047         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18048         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18049       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18050       consumes:
18051         - application/json
18052         - application/xml
18053       produces:
18054         - application/json
18055         - application/xml
18056       responses:
18057         "default":
18058           description: Response codes found in [response codes](https://wiki.onap.org/).
18059       parameters:
18060         - name: model-invariant-id
18061           in: path
18062           description: Unique identifier corresponding to the main definition of a model in ASDC
18063           required: true
18064           type: string
18065           example: __MODEL-INVARIANT-ID__
18066         - name: model-version-id
18067           in: path
18068           description: Unique identifier corresponding to one version of a model in ASDC
18069           required: true
18070           type: string
18071           example: __MODEL-VERSION-ID__
18072         - name: model-element-uuid
18073           in: path
18074           required: true
18075           type: string
18076           example: __MODEL-ELEMENT-UUID__
18077         - name: body
18078           in: body
18079           description: model-element object that needs to be updated.
18080           required: true
18081           schema:
18082             $ref: "#/patchDefinitions/model-element"
18083     delete:
18084       tags:
18085         - ServiceDesignAndCreation
18086       summary: delete an existing model-element
18087       description: delete an existing model-element
18088       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18089       consumes:
18090         - application/json
18091         - application/xml
18092       produces:
18093         - application/json
18094         - application/xml
18095       responses:
18096         "default":
18097           description: Response codes found in [response codes](https://wiki.onap.org/).
18098       parameters:
18099         - name: model-invariant-id
18100           in: path
18101           description: Unique identifier corresponding to the main definition of a model in ASDC
18102           required: true
18103           type: string
18104           example: __MODEL-INVARIANT-ID__
18105         - name: model-version-id
18106           in: path
18107           description: Unique identifier corresponding to one version of a model in ASDC
18108           required: true
18109           type: string
18110           example: __MODEL-VERSION-ID__
18111         - name: model-element-uuid
18112           in: path
18113           required: true
18114           type: string
18115           example: __MODEL-ELEMENT-UUID__
18116         - name: resource-version
18117           in: query
18118           description: resource-version for concurrency
18119           required: true
18120           type: string
18121   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18122     get:
18123       tags:
18124         - ServiceDesignAndCreation
18125       summary: returns model-elements
18126       description: returns model-elements
18127       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18128       produces:
18129         - application/json
18130         - application/xml
18131       responses:
18132         "200":
18133           description: successful operation
18134           schema:
18135               $ref: "#/getDefinitions/model-elements"
18136         "default":
18137           description: Response codes found in [response codes](https://wiki.onap.org/).
18138       parameters:
18139         - name: model-invariant-id
18140           in: path
18141           description: Unique identifier corresponding to the main definition of a model in ASDC
18142           required: true
18143           type: string
18144           example: __MODEL-INVARIANT-ID__
18145         - name: model-version-id
18146           in: path
18147           description: Unique identifier corresponding to one version of a model in ASDC
18148           required: true
18149           type: string
18150           example: __MODEL-VERSION-ID__
18151         - name: model-element-uuid
18152           in: query
18153           description:
18154           required: false
18155           type: string
18156   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18157     get:
18158       tags:
18159         - ServiceDesignAndCreation
18160       summary: returns metadatum
18161       description: returns metadatum
18162       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18163       produces:
18164         - application/json
18165         - application/xml
18166       responses:
18167         "200":
18168           description: successful operation
18169           schema:
18170               $ref: "#/getDefinitions/metadatum"
18171         "default":
18172           description: Response codes found in [response codes](https://wiki.onap.org/).
18173       parameters:
18174         - name: model-invariant-id
18175           in: path
18176           description: Unique identifier corresponding to the main definition of a model in ASDC
18177           required: true
18178           type: string
18179           example: __MODEL-INVARIANT-ID__
18180         - name: model-version-id
18181           in: path
18182           description: Unique identifier corresponding to one version of a model in ASDC
18183           required: true
18184           type: string
18185           example: __MODEL-VERSION-ID__
18186         - name: metaname
18187           in: path
18188           required: true
18189           type: string
18190           example: __METANAME__
18191     put:
18192       tags:
18193         - ServiceDesignAndCreation
18194       summary: create or update an existing metadatum
18195       description: |
18196         Create or update an existing metadatum.
18197         #
18198         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18199       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18200       consumes:
18201         - application/json
18202         - application/xml
18203       produces:
18204         - application/json
18205         - application/xml
18206       responses:
18207         "default":
18208           description: Response codes found in [response codes](https://wiki.onap.org/).
18209       parameters:
18210         - name: model-invariant-id
18211           in: path
18212           description: Unique identifier corresponding to the main definition of a model in ASDC
18213           required: true
18214           type: string
18215           example: __MODEL-INVARIANT-ID__
18216         - name: model-version-id
18217           in: path
18218           description: Unique identifier corresponding to one version of a model in ASDC
18219           required: true
18220           type: string
18221           example: __MODEL-VERSION-ID__
18222         - name: metaname
18223           in: path
18224           required: true
18225           type: string
18226           example: __METANAME__
18227         - name: body
18228           in: body
18229           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18230           required: true
18231           schema:
18232             $ref: "#/definitions/metadatum"
18233     patch:
18234       tags:
18235         - ServiceDesignAndCreation
18236       summary: update an existing metadatum
18237       description: |
18238         Update an existing metadatum
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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
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: model-invariant-id
18261           in: path
18262           description: Unique identifier corresponding to the main definition of a model in ASDC
18263           required: true
18264           type: string
18265           example: __MODEL-INVARIANT-ID__
18266         - name: model-version-id
18267           in: path
18268           description: Unique identifier corresponding to one version of a model in ASDC
18269           required: true
18270           type: string
18271           example: __MODEL-VERSION-ID__
18272         - name: metaname
18273           in: path
18274           required: true
18275           type: string
18276           example: __METANAME__
18277         - name: body
18278           in: body
18279           description: metadatum object that needs to be updated.
18280           required: true
18281           schema:
18282             $ref: "#/patchDefinitions/metadatum"
18283     delete:
18284       tags:
18285         - ServiceDesignAndCreation
18286       summary: delete an existing metadatum
18287       description: delete an existing metadatum
18288       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18289       consumes:
18290         - application/json
18291         - application/xml
18292       produces:
18293         - application/json
18294         - application/xml
18295       responses:
18296         "default":
18297           description: Response codes found in [response codes](https://wiki.onap.org/).
18298       parameters:
18299         - name: model-invariant-id
18300           in: path
18301           description: Unique identifier corresponding to the main definition of a model in ASDC
18302           required: true
18303           type: string
18304           example: __MODEL-INVARIANT-ID__
18305         - name: model-version-id
18306           in: path
18307           description: Unique identifier corresponding to one version of a model in ASDC
18308           required: true
18309           type: string
18310           example: __MODEL-VERSION-ID__
18311         - name: metaname
18312           in: path
18313           required: true
18314           type: string
18315           example: __METANAME__
18316         - name: resource-version
18317           in: query
18318           description: resource-version for concurrency
18319           required: true
18320           type: string
18321   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18322     get:
18323       tags:
18324         - ServiceDesignAndCreation
18325       summary: returns metadata
18326       description: returns metadata
18327       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18328       produces:
18329         - application/json
18330         - application/xml
18331       responses:
18332         "200":
18333           description: successful operation
18334           schema:
18335               $ref: "#/getDefinitions/metadata"
18336         "default":
18337           description: Response codes found in [response codes](https://wiki.onap.org/).
18338       parameters:
18339         - name: model-invariant-id
18340           in: path
18341           description: Unique identifier corresponding to the main definition of a model in ASDC
18342           required: true
18343           type: string
18344           example: __MODEL-INVARIANT-ID__
18345         - name: model-version-id
18346           in: path
18347           description: Unique identifier corresponding to one version of a model in ASDC
18348           required: true
18349           type: string
18350           example: __MODEL-VERSION-ID__
18351         - name: metaname
18352           in: query
18353           description:
18354           required: false
18355           type: string
18356   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18357     put:
18358       tags:
18359         - ServiceDesignAndCreation
18360       summary: see node definition for valid relationships
18361       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18362       consumes:
18363         - application/json
18364         - application/xml
18365       produces:
18366         - application/json
18367         - application/xml
18368       responses:
18369         "default":
18370           description: Response codes found in [response codes](https://wiki.onap.org/).
18371       parameters:
18372         - name: model-invariant-id
18373           in: path
18374           description: Unique identifier corresponding to the main definition of a model in ASDC
18375           required: true
18376           type: string
18377           example: __MODEL-INVARIANT-ID__
18378         - name: model-version-id
18379           in: path
18380           description: Unique identifier corresponding to one version of a model in ASDC
18381           required: true
18382           type: string
18383           example: __MODEL-VERSION-ID__
18384         - name: body
18385           in: body
18386           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18387           required: true
18388           schema:
18389             $ref: "#/definitions/relationship"
18390     delete:
18391       tags:
18392         - ServiceDesignAndCreation
18393       summary: delete an existing relationship
18394       description: delete an existing relationship
18395       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18396       consumes:
18397         - application/json
18398         - application/xml
18399       produces:
18400         - application/json
18401         - application/xml
18402       responses:
18403         "default":
18404           description: Response codes found in [response codes](https://wiki.onap.org/).
18405       parameters:
18406         - name: model-invariant-id
18407           in: path
18408           description: Unique identifier corresponding to the main definition of a model in ASDC
18409           required: true
18410           type: string
18411           example: __MODEL-INVARIANT-ID__
18412         - name: model-version-id
18413           in: path
18414           description: Unique identifier corresponding to one version of a model in ASDC
18415           required: true
18416           type: string
18417           example: __MODEL-VERSION-ID__
18418   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18419     get:
18420       tags:
18421         - ServiceDesignAndCreation
18422       summary: returns model-ver
18423       description: returns model-ver
18424       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18425       produces:
18426         - application/json
18427         - application/xml
18428       responses:
18429         "200":
18430           description: successful operation
18431           schema:
18432               $ref: "#/getDefinitions/model-ver"
18433         "default":
18434           description: Response codes found in [response codes](https://wiki.onap.org/).
18435       parameters:
18436         - name: model-invariant-id
18437           in: path
18438           description: Unique identifier corresponding to the main definition of a model in ASDC
18439           required: true
18440           type: string
18441           example: __MODEL-INVARIANT-ID__
18442         - name: model-version-id
18443           in: path
18444           description: Unique identifier corresponding to one version of a model in ASDC
18445           required: true
18446           type: string
18447           example: __MODEL-VERSION-ID__
18448     put:
18449       tags:
18450         - ServiceDesignAndCreation
18451       summary: create or update an existing model-ver
18452       description: |
18453         Create or update an existing model-ver.
18454         #
18455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18456       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18457       consumes:
18458         - application/json
18459         - application/xml
18460       produces:
18461         - application/json
18462         - application/xml
18463       responses:
18464         "default":
18465           description: Response codes found in [response codes](https://wiki.onap.org/).
18466       parameters:
18467         - name: model-invariant-id
18468           in: path
18469           description: Unique identifier corresponding to the main definition of a model in ASDC
18470           required: true
18471           type: string
18472           example: __MODEL-INVARIANT-ID__
18473         - name: model-version-id
18474           in: path
18475           description: Unique identifier corresponding to one version of a model in ASDC
18476           required: true
18477           type: string
18478           example: __MODEL-VERSION-ID__
18479         - name: body
18480           in: body
18481           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18482           required: true
18483           schema:
18484             $ref: "#/definitions/model-ver"
18485     patch:
18486       tags:
18487         - ServiceDesignAndCreation
18488       summary: update an existing model-ver
18489       description: |
18490         Update an existing model-ver
18491         #
18492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18493         The PUT operation will entirely replace an existing object.
18494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18495         #
18496         Other differences between PUT and PATCH are:
18497         #
18498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18501       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18502       consumes:
18503         - application/json
18504         - application/xml
18505       produces:
18506         - application/json
18507         - application/xml
18508       responses:
18509         "default":
18510           description: Response codes found in [response codes](https://wiki.onap.org/).
18511       parameters:
18512         - name: model-invariant-id
18513           in: path
18514           description: Unique identifier corresponding to the main definition of a model in ASDC
18515           required: true
18516           type: string
18517           example: __MODEL-INVARIANT-ID__
18518         - name: model-version-id
18519           in: path
18520           description: Unique identifier corresponding to one version of a model in ASDC
18521           required: true
18522           type: string
18523           example: __MODEL-VERSION-ID__
18524         - name: body
18525           in: body
18526           description: model-ver object that needs to be updated.
18527           required: true
18528           schema:
18529             $ref: "#/patchDefinitions/model-ver"
18530     delete:
18531       tags:
18532         - ServiceDesignAndCreation
18533       summary: delete an existing model-ver
18534       description: delete an existing model-ver
18535       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18536       consumes:
18537         - application/json
18538         - application/xml
18539       produces:
18540         - application/json
18541         - application/xml
18542       responses:
18543         "default":
18544           description: Response codes found in [response codes](https://wiki.onap.org/).
18545       parameters:
18546         - name: model-invariant-id
18547           in: path
18548           description: Unique identifier corresponding to the main definition of a model in ASDC
18549           required: true
18550           type: string
18551           example: __MODEL-INVARIANT-ID__
18552         - name: model-version-id
18553           in: path
18554           description: Unique identifier corresponding to one version of a model in ASDC
18555           required: true
18556           type: string
18557           example: __MODEL-VERSION-ID__
18558         - name: resource-version
18559           in: query
18560           description: resource-version for concurrency
18561           required: true
18562           type: string
18563   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
18564     get:
18565       tags:
18566         - ServiceDesignAndCreation
18567       summary: returns model-vers
18568       description: returns model-vers
18569       operationId: getServiceDesignAndCreationModelsModelModelVers
18570       produces:
18571         - application/json
18572         - application/xml
18573       responses:
18574         "200":
18575           description: successful operation
18576           schema:
18577               $ref: "#/getDefinitions/model-vers"
18578         "default":
18579           description: Response codes found in [response codes](https://wiki.onap.org/).
18580       parameters:
18581         - name: model-invariant-id
18582           in: path
18583           description: Unique identifier corresponding to the main definition of a model in ASDC
18584           required: true
18585           type: string
18586           example: __MODEL-INVARIANT-ID__
18587         - name: model-version-id
18588           in: query
18589           description:
18590           required: false
18591           type: string
18592         - name: model-name
18593           in: query
18594           description:
18595           required: false
18596           type: string
18597         - name: model-version
18598           in: query
18599           description:
18600           required: false
18601           type: string
18602   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
18603     put:
18604       tags:
18605         - ServiceDesignAndCreation
18606       summary: see node definition for valid relationships
18607       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
18608       consumes:
18609         - application/json
18610         - application/xml
18611       produces:
18612         - application/json
18613         - application/xml
18614       responses:
18615         "default":
18616           description: Response codes found in [response codes](https://wiki.onap.org/).
18617       parameters:
18618         - name: model-invariant-id
18619           in: path
18620           description: Unique identifier corresponding to the main definition of a model in ASDC
18621           required: true
18622           type: string
18623           example: __MODEL-INVARIANT-ID__
18624         - name: body
18625           in: body
18626           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
18627           required: true
18628           schema:
18629             $ref: "#/definitions/relationship"
18630     delete:
18631       tags:
18632         - ServiceDesignAndCreation
18633       summary: delete an existing relationship
18634       description: delete an existing relationship
18635       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
18636       consumes:
18637         - application/json
18638         - application/xml
18639       produces:
18640         - application/json
18641         - application/xml
18642       responses:
18643         "default":
18644           description: Response codes found in [response codes](https://wiki.onap.org/).
18645       parameters:
18646         - name: model-invariant-id
18647           in: path
18648           description: Unique identifier corresponding to the main definition of a model in ASDC
18649           required: true
18650           type: string
18651           example: __MODEL-INVARIANT-ID__
18652   /service-design-and-creation/models/model/{model-invariant-id}:
18653     get:
18654       tags:
18655         - ServiceDesignAndCreation
18656       summary: returns model
18657       description: returns model
18658       operationId: getServiceDesignAndCreationModelsModel
18659       produces:
18660         - application/json
18661         - application/xml
18662       responses:
18663         "200":
18664           description: successful operation
18665           schema:
18666               $ref: "#/getDefinitions/model"
18667         "default":
18668           description: Response codes found in [response codes](https://wiki.onap.org/).
18669       parameters:
18670         - name: model-invariant-id
18671           in: path
18672           description: Unique identifier corresponding to the main definition of a model in ASDC
18673           required: true
18674           type: string
18675           example: __MODEL-INVARIANT-ID__
18676     put:
18677       tags:
18678         - ServiceDesignAndCreation
18679       summary: create or update an existing model
18680       description: |
18681         Create or update an existing model.
18682         #
18683         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18684       operationId: createOrUpdateServiceDesignAndCreationModelsModel
18685       consumes:
18686         - application/json
18687         - application/xml
18688       produces:
18689         - application/json
18690         - application/xml
18691       responses:
18692         "default":
18693           description: Response codes found in [response codes](https://wiki.onap.org/).
18694       parameters:
18695         - name: model-invariant-id
18696           in: path
18697           description: Unique identifier corresponding to the main definition of a model in ASDC
18698           required: true
18699           type: string
18700           example: __MODEL-INVARIANT-ID__
18701         - name: body
18702           in: body
18703           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
18704           required: true
18705           schema:
18706             $ref: "#/definitions/model"
18707     patch:
18708       tags:
18709         - ServiceDesignAndCreation
18710       summary: update an existing model
18711       description: |
18712         Update an existing model
18713         #
18714         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18715         The PUT operation will entirely replace an existing object.
18716         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18717         #
18718         Other differences between PUT and PATCH are:
18719         #
18720         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18721         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18722         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18723       operationId: UpdateServiceDesignAndCreationModelsModel
18724       consumes:
18725         - application/json
18726         - application/xml
18727       produces:
18728         - application/json
18729         - application/xml
18730       responses:
18731         "default":
18732           description: Response codes found in [response codes](https://wiki.onap.org/).
18733       parameters:
18734         - name: model-invariant-id
18735           in: path
18736           description: Unique identifier corresponding to the main definition of a model in ASDC
18737           required: true
18738           type: string
18739           example: __MODEL-INVARIANT-ID__
18740         - name: body
18741           in: body
18742           description: model object that needs to be updated.
18743           required: true
18744           schema:
18745             $ref: "#/patchDefinitions/model"
18746     delete:
18747       tags:
18748         - ServiceDesignAndCreation
18749       summary: delete an existing model
18750       description: delete an existing model
18751       operationId: deleteServiceDesignAndCreationModelsModel
18752       consumes:
18753         - application/json
18754         - application/xml
18755       produces:
18756         - application/json
18757         - application/xml
18758       responses:
18759         "default":
18760           description: Response codes found in [response codes](https://wiki.onap.org/).
18761       parameters:
18762         - name: model-invariant-id
18763           in: path
18764           description: Unique identifier corresponding to the main definition of a model in ASDC
18765           required: true
18766           type: string
18767           example: __MODEL-INVARIANT-ID__
18768         - name: resource-version
18769           in: query
18770           description: resource-version for concurrency
18771           required: true
18772           type: string
18773   /service-design-and-creation/models:
18774     get:
18775       tags:
18776         - ServiceDesignAndCreation
18777       summary: returns models
18778       description: returns models
18779       operationId: getServiceDesignAndCreationModels
18780       produces:
18781         - application/json
18782         - application/xml
18783       responses:
18784         "200":
18785           description: successful operation
18786           schema:
18787               $ref: "#/getDefinitions/models"
18788         "default":
18789           description: Response codes found in [response codes](https://wiki.onap.org/).
18790       parameters:
18791         - name: model-invariant-id
18792           in: query
18793           description:
18794           required: false
18795           type: string
18796         - name: model-type
18797           in: query
18798           description:
18799           required: false
18800           type: string
18801   /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:
18802     put:
18803       tags:
18804         - ServiceDesignAndCreation
18805       summary: see node definition for valid relationships
18806       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
18807       consumes:
18808         - application/json
18809         - application/xml
18810       produces:
18811         - application/json
18812         - application/xml
18813       responses:
18814         "default":
18815           description: Response codes found in [response codes](https://wiki.onap.org/).
18816       parameters:
18817         - name: named-query-uuid
18818           in: path
18819           required: true
18820           type: string
18821           example: __NAMED-QUERY-UUID__
18822         - name: named-query-element-uuid
18823           in: path
18824           required: true
18825           type: string
18826           example: __NAMED-QUERY-ELEMENT-UUID__
18827         - name: related-lookup-uuid
18828           in: path
18829           required: true
18830           type: string
18831           example: __RELATED-LOOKUP-UUID__
18832         - name: body
18833           in: body
18834           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
18835           required: true
18836           schema:
18837             $ref: "#/definitions/relationship"
18838     delete:
18839       tags:
18840         - ServiceDesignAndCreation
18841       summary: delete an existing relationship
18842       description: delete an existing relationship
18843       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
18844       consumes:
18845         - application/json
18846         - application/xml
18847       produces:
18848         - application/json
18849         - application/xml
18850       responses:
18851         "default":
18852           description: Response codes found in [response codes](https://wiki.onap.org/).
18853       parameters:
18854         - name: named-query-uuid
18855           in: path
18856           required: true
18857           type: string
18858           example: __NAMED-QUERY-UUID__
18859         - name: named-query-element-uuid
18860           in: path
18861           required: true
18862           type: string
18863           example: __NAMED-QUERY-ELEMENT-UUID__
18864         - name: related-lookup-uuid
18865           in: path
18866           required: true
18867           type: string
18868           example: __RELATED-LOOKUP-UUID__
18869   /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}:
18870     get:
18871       tags:
18872         - ServiceDesignAndCreation
18873       summary: returns related-lookup
18874       description: returns related-lookup
18875       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18876       produces:
18877         - application/json
18878         - application/xml
18879       responses:
18880         "200":
18881           description: successful operation
18882           schema:
18883               $ref: "#/getDefinitions/related-lookup"
18884         "default":
18885           description: Response codes found in [response codes](https://wiki.onap.org/).
18886       parameters:
18887         - name: named-query-uuid
18888           in: path
18889           required: true
18890           type: string
18891           example: __NAMED-QUERY-UUID__
18892         - name: named-query-element-uuid
18893           in: path
18894           required: true
18895           type: string
18896           example: __NAMED-QUERY-ELEMENT-UUID__
18897         - name: related-lookup-uuid
18898           in: path
18899           required: true
18900           type: string
18901           example: __RELATED-LOOKUP-UUID__
18902     put:
18903       tags:
18904         - ServiceDesignAndCreation
18905       summary: create or update an existing related-lookup
18906       description: |
18907         Create or update an existing related-lookup.
18908         #
18909         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18910       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18911       consumes:
18912         - application/json
18913         - application/xml
18914       produces:
18915         - application/json
18916         - application/xml
18917       responses:
18918         "default":
18919           description: Response codes found in [response codes](https://wiki.onap.org/).
18920       parameters:
18921         - name: named-query-uuid
18922           in: path
18923           required: true
18924           type: string
18925           example: __NAMED-QUERY-UUID__
18926         - name: named-query-element-uuid
18927           in: path
18928           required: true
18929           type: string
18930           example: __NAMED-QUERY-ELEMENT-UUID__
18931         - name: related-lookup-uuid
18932           in: path
18933           required: true
18934           type: string
18935           example: __RELATED-LOOKUP-UUID__
18936         - name: body
18937           in: body
18938           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
18939           required: true
18940           schema:
18941             $ref: "#/definitions/related-lookup"
18942     patch:
18943       tags:
18944         - ServiceDesignAndCreation
18945       summary: update an existing related-lookup
18946       description: |
18947         Update an existing related-lookup
18948         #
18949         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18950         The PUT operation will entirely replace an existing object.
18951         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18952         #
18953         Other differences between PUT and PATCH are:
18954         #
18955         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18956         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18957         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18958       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18959       consumes:
18960         - application/json
18961         - application/xml
18962       produces:
18963         - application/json
18964         - application/xml
18965       responses:
18966         "default":
18967           description: Response codes found in [response codes](https://wiki.onap.org/).
18968       parameters:
18969         - name: named-query-uuid
18970           in: path
18971           required: true
18972           type: string
18973           example: __NAMED-QUERY-UUID__
18974         - name: named-query-element-uuid
18975           in: path
18976           required: true
18977           type: string
18978           example: __NAMED-QUERY-ELEMENT-UUID__
18979         - name: related-lookup-uuid
18980           in: path
18981           required: true
18982           type: string
18983           example: __RELATED-LOOKUP-UUID__
18984         - name: body
18985           in: body
18986           description: related-lookup object that needs to be updated.
18987           required: true
18988           schema:
18989             $ref: "#/patchDefinitions/related-lookup"
18990     delete:
18991       tags:
18992         - ServiceDesignAndCreation
18993       summary: delete an existing related-lookup
18994       description: delete an existing related-lookup
18995       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18996       consumes:
18997         - application/json
18998         - application/xml
18999       produces:
19000         - application/json
19001         - application/xml
19002       responses:
19003         "default":
19004           description: Response codes found in [response codes](https://wiki.onap.org/).
19005       parameters:
19006         - name: named-query-uuid
19007           in: path
19008           required: true
19009           type: string
19010           example: __NAMED-QUERY-UUID__
19011         - name: named-query-element-uuid
19012           in: path
19013           required: true
19014           type: string
19015           example: __NAMED-QUERY-ELEMENT-UUID__
19016         - name: related-lookup-uuid
19017           in: path
19018           required: true
19019           type: string
19020           example: __RELATED-LOOKUP-UUID__
19021         - name: resource-version
19022           in: query
19023           description: resource-version for concurrency
19024           required: true
19025           type: string
19026   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19027     get:
19028       tags:
19029         - ServiceDesignAndCreation
19030       summary: returns related-lookups
19031       description: returns related-lookups
19032       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19033       produces:
19034         - application/json
19035         - application/xml
19036       responses:
19037         "200":
19038           description: successful operation
19039           schema:
19040               $ref: "#/getDefinitions/related-lookups"
19041         "default":
19042           description: Response codes found in [response codes](https://wiki.onap.org/).
19043       parameters:
19044         - name: named-query-uuid
19045           in: path
19046           required: true
19047           type: string
19048           example: __NAMED-QUERY-UUID__
19049         - name: named-query-element-uuid
19050           in: path
19051           required: true
19052           type: string
19053           example: __NAMED-QUERY-ELEMENT-UUID__
19054         - name: related-lookup-uuid
19055           in: query
19056           description:
19057           required: false
19058           type: string
19059   /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}:
19060     get:
19061       tags:
19062         - ServiceDesignAndCreation
19063       summary: returns property-constraint
19064       description: returns property-constraint
19065       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19066       produces:
19067         - application/json
19068         - application/xml
19069       responses:
19070         "200":
19071           description: successful operation
19072           schema:
19073               $ref: "#/getDefinitions/property-constraint"
19074         "default":
19075           description: Response codes found in [response codes](https://wiki.onap.org/).
19076       parameters:
19077         - name: named-query-uuid
19078           in: path
19079           required: true
19080           type: string
19081           example: __NAMED-QUERY-UUID__
19082         - name: named-query-element-uuid
19083           in: path
19084           required: true
19085           type: string
19086           example: __NAMED-QUERY-ELEMENT-UUID__
19087         - name: property-constraint-uuid
19088           in: path
19089           required: true
19090           type: string
19091           example: __PROPERTY-CONSTRAINT-UUID__
19092     put:
19093       tags:
19094         - ServiceDesignAndCreation
19095       summary: create or update an existing property-constraint
19096       description: |
19097         Create or update an existing property-constraint.
19098         #
19099         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19100       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19101       consumes:
19102         - application/json
19103         - application/xml
19104       produces:
19105         - application/json
19106         - application/xml
19107       responses:
19108         "default":
19109           description: Response codes found in [response codes](https://wiki.onap.org/).
19110       parameters:
19111         - name: named-query-uuid
19112           in: path
19113           required: true
19114           type: string
19115           example: __NAMED-QUERY-UUID__
19116         - name: named-query-element-uuid
19117           in: path
19118           required: true
19119           type: string
19120           example: __NAMED-QUERY-ELEMENT-UUID__
19121         - name: property-constraint-uuid
19122           in: path
19123           required: true
19124           type: string
19125           example: __PROPERTY-CONSTRAINT-UUID__
19126         - name: body
19127           in: body
19128           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19129           required: true
19130           schema:
19131             $ref: "#/definitions/property-constraint"
19132     patch:
19133       tags:
19134         - ServiceDesignAndCreation
19135       summary: update an existing property-constraint
19136       description: |
19137         Update an existing property-constraint
19138         #
19139         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19140         The PUT operation will entirely replace an existing object.
19141         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19142         #
19143         Other differences between PUT and PATCH are:
19144         #
19145         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19146         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19147         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19148       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19149       consumes:
19150         - application/json
19151         - application/xml
19152       produces:
19153         - application/json
19154         - application/xml
19155       responses:
19156         "default":
19157           description: Response codes found in [response codes](https://wiki.onap.org/).
19158       parameters:
19159         - name: named-query-uuid
19160           in: path
19161           required: true
19162           type: string
19163           example: __NAMED-QUERY-UUID__
19164         - name: named-query-element-uuid
19165           in: path
19166           required: true
19167           type: string
19168           example: __NAMED-QUERY-ELEMENT-UUID__
19169         - name: property-constraint-uuid
19170           in: path
19171           required: true
19172           type: string
19173           example: __PROPERTY-CONSTRAINT-UUID__
19174         - name: body
19175           in: body
19176           description: property-constraint object that needs to be updated.
19177           required: true
19178           schema:
19179             $ref: "#/patchDefinitions/property-constraint"
19180     delete:
19181       tags:
19182         - ServiceDesignAndCreation
19183       summary: delete an existing property-constraint
19184       description: delete an existing property-constraint
19185       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19186       consumes:
19187         - application/json
19188         - application/xml
19189       produces:
19190         - application/json
19191         - application/xml
19192       responses:
19193         "default":
19194           description: Response codes found in [response codes](https://wiki.onap.org/).
19195       parameters:
19196         - name: named-query-uuid
19197           in: path
19198           required: true
19199           type: string
19200           example: __NAMED-QUERY-UUID__
19201         - name: named-query-element-uuid
19202           in: path
19203           required: true
19204           type: string
19205           example: __NAMED-QUERY-ELEMENT-UUID__
19206         - name: property-constraint-uuid
19207           in: path
19208           required: true
19209           type: string
19210           example: __PROPERTY-CONSTRAINT-UUID__
19211         - name: resource-version
19212           in: query
19213           description: resource-version for concurrency
19214           required: true
19215           type: string
19216   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19217     get:
19218       tags:
19219         - ServiceDesignAndCreation
19220       summary: returns property-constraints
19221       description: returns property-constraints
19222       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19223       produces:
19224         - application/json
19225         - application/xml
19226       responses:
19227         "200":
19228           description: successful operation
19229           schema:
19230               $ref: "#/getDefinitions/property-constraints"
19231         "default":
19232           description: Response codes found in [response codes](https://wiki.onap.org/).
19233       parameters:
19234         - name: named-query-uuid
19235           in: path
19236           required: true
19237           type: string
19238           example: __NAMED-QUERY-UUID__
19239         - name: named-query-element-uuid
19240           in: path
19241           required: true
19242           type: string
19243           example: __NAMED-QUERY-ELEMENT-UUID__
19244         - name: property-constraint-uuid
19245           in: query
19246           description:
19247           required: false
19248           type: string
19249   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19250     put:
19251       tags:
19252         - ServiceDesignAndCreation
19253       summary: see node definition for valid relationships
19254       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19255       consumes:
19256         - application/json
19257         - application/xml
19258       produces:
19259         - application/json
19260         - application/xml
19261       responses:
19262         "default":
19263           description: Response codes found in [response codes](https://wiki.onap.org/).
19264       parameters:
19265         - name: named-query-uuid
19266           in: path
19267           required: true
19268           type: string
19269           example: __NAMED-QUERY-UUID__
19270         - name: named-query-element-uuid
19271           in: path
19272           required: true
19273           type: string
19274           example: __NAMED-QUERY-ELEMENT-UUID__
19275         - name: body
19276           in: body
19277           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19278           required: true
19279           schema:
19280             $ref: "#/definitions/relationship"
19281     delete:
19282       tags:
19283         - ServiceDesignAndCreation
19284       summary: delete an existing relationship
19285       description: delete an existing relationship
19286       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19287       consumes:
19288         - application/json
19289         - application/xml
19290       produces:
19291         - application/json
19292         - application/xml
19293       responses:
19294         "default":
19295           description: Response codes found in [response codes](https://wiki.onap.org/).
19296       parameters:
19297         - name: named-query-uuid
19298           in: path
19299           required: true
19300           type: string
19301           example: __NAMED-QUERY-UUID__
19302         - name: named-query-element-uuid
19303           in: path
19304           required: true
19305           type: string
19306           example: __NAMED-QUERY-ELEMENT-UUID__
19307   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19308     get:
19309       tags:
19310         - ServiceDesignAndCreation
19311       summary: returns named-query-element
19312       description: returns named-query-element
19313       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19314       produces:
19315         - application/json
19316         - application/xml
19317       responses:
19318         "200":
19319           description: successful operation
19320           schema:
19321               $ref: "#/getDefinitions/named-query-element"
19322         "default":
19323           description: Response codes found in [response codes](https://wiki.onap.org/).
19324       parameters:
19325         - name: named-query-uuid
19326           in: path
19327           required: true
19328           type: string
19329           example: __NAMED-QUERY-UUID__
19330         - name: named-query-element-uuid
19331           in: path
19332           required: true
19333           type: string
19334           example: __NAMED-QUERY-ELEMENT-UUID__
19335     put:
19336       tags:
19337         - ServiceDesignAndCreation
19338       summary: create or update an existing named-query-element
19339       description: |
19340         Create or update an existing named-query-element.
19341         #
19342         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19343       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19344       consumes:
19345         - application/json
19346         - application/xml
19347       produces:
19348         - application/json
19349         - application/xml
19350       responses:
19351         "default":
19352           description: Response codes found in [response codes](https://wiki.onap.org/).
19353       parameters:
19354         - name: named-query-uuid
19355           in: path
19356           required: true
19357           type: string
19358           example: __NAMED-QUERY-UUID__
19359         - name: named-query-element-uuid
19360           in: path
19361           required: true
19362           type: string
19363           example: __NAMED-QUERY-ELEMENT-UUID__
19364         - name: body
19365           in: body
19366           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19367           required: true
19368           schema:
19369             $ref: "#/definitions/named-query-element"
19370     patch:
19371       tags:
19372         - ServiceDesignAndCreation
19373       summary: update an existing named-query-element
19374       description: |
19375         Update an existing named-query-element
19376         #
19377         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19378         The PUT operation will entirely replace an existing object.
19379         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19380         #
19381         Other differences between PUT and PATCH are:
19382         #
19383         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19384         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19385         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19386       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19387       consumes:
19388         - application/json
19389         - application/xml
19390       produces:
19391         - application/json
19392         - application/xml
19393       responses:
19394         "default":
19395           description: Response codes found in [response codes](https://wiki.onap.org/).
19396       parameters:
19397         - name: named-query-uuid
19398           in: path
19399           required: true
19400           type: string
19401           example: __NAMED-QUERY-UUID__
19402         - name: named-query-element-uuid
19403           in: path
19404           required: true
19405           type: string
19406           example: __NAMED-QUERY-ELEMENT-UUID__
19407         - name: body
19408           in: body
19409           description: named-query-element object that needs to be updated.
19410           required: true
19411           schema:
19412             $ref: "#/patchDefinitions/named-query-element"
19413     delete:
19414       tags:
19415         - ServiceDesignAndCreation
19416       summary: delete an existing named-query-element
19417       description: delete an existing named-query-element
19418       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19419       consumes:
19420         - application/json
19421         - application/xml
19422       produces:
19423         - application/json
19424         - application/xml
19425       responses:
19426         "default":
19427           description: Response codes found in [response codes](https://wiki.onap.org/).
19428       parameters:
19429         - name: named-query-uuid
19430           in: path
19431           required: true
19432           type: string
19433           example: __NAMED-QUERY-UUID__
19434         - name: named-query-element-uuid
19435           in: path
19436           required: true
19437           type: string
19438           example: __NAMED-QUERY-ELEMENT-UUID__
19439         - name: resource-version
19440           in: query
19441           description: resource-version for concurrency
19442           required: true
19443           type: string
19444   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19445     get:
19446       tags:
19447         - ServiceDesignAndCreation
19448       summary: returns named-query-elements
19449       description: returns named-query-elements
19450       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19451       produces:
19452         - application/json
19453         - application/xml
19454       responses:
19455         "200":
19456           description: successful operation
19457           schema:
19458               $ref: "#/getDefinitions/named-query-elements"
19459         "default":
19460           description: Response codes found in [response codes](https://wiki.onap.org/).
19461       parameters:
19462         - name: named-query-uuid
19463           in: path
19464           required: true
19465           type: string
19466           example: __NAMED-QUERY-UUID__
19467         - name: named-query-element-uuid
19468           in: query
19469           description:
19470           required: false
19471           type: string
19472   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19473     put:
19474       tags:
19475         - ServiceDesignAndCreation
19476       summary: see node definition for valid relationships
19477       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19478       consumes:
19479         - application/json
19480         - application/xml
19481       produces:
19482         - application/json
19483         - application/xml
19484       responses:
19485         "default":
19486           description: Response codes found in [response codes](https://wiki.onap.org/).
19487       parameters:
19488         - name: named-query-uuid
19489           in: path
19490           required: true
19491           type: string
19492           example: __NAMED-QUERY-UUID__
19493         - name: body
19494           in: body
19495           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19496           required: true
19497           schema:
19498             $ref: "#/definitions/relationship"
19499     delete:
19500       tags:
19501         - ServiceDesignAndCreation
19502       summary: delete an existing relationship
19503       description: delete an existing relationship
19504       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19505       consumes:
19506         - application/json
19507         - application/xml
19508       produces:
19509         - application/json
19510         - application/xml
19511       responses:
19512         "default":
19513           description: Response codes found in [response codes](https://wiki.onap.org/).
19514       parameters:
19515         - name: named-query-uuid
19516           in: path
19517           required: true
19518           type: string
19519           example: __NAMED-QUERY-UUID__
19520   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19521     get:
19522       tags:
19523         - ServiceDesignAndCreation
19524       summary: returns named-query
19525       description: returns named-query
19526       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19527       produces:
19528         - application/json
19529         - application/xml
19530       responses:
19531         "200":
19532           description: successful operation
19533           schema:
19534               $ref: "#/getDefinitions/named-query"
19535         "default":
19536           description: Response codes found in [response codes](https://wiki.onap.org/).
19537       parameters:
19538         - name: named-query-uuid
19539           in: path
19540           required: true
19541           type: string
19542           example: __NAMED-QUERY-UUID__
19543     put:
19544       tags:
19545         - ServiceDesignAndCreation
19546       summary: create or update an existing named-query
19547       description: |
19548         Create or update an existing named-query.
19549         #
19550         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19551       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
19552       consumes:
19553         - application/json
19554         - application/xml
19555       produces:
19556         - application/json
19557         - application/xml
19558       responses:
19559         "default":
19560           description: Response codes found in [response codes](https://wiki.onap.org/).
19561       parameters:
19562         - name: named-query-uuid
19563           in: path
19564           required: true
19565           type: string
19566           example: __NAMED-QUERY-UUID__
19567         - name: body
19568           in: body
19569           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19570           required: true
19571           schema:
19572             $ref: "#/definitions/named-query"
19573     patch:
19574       tags:
19575         - ServiceDesignAndCreation
19576       summary: update an existing named-query
19577       description: |
19578         Update an existing named-query
19579         #
19580         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19581         The PUT operation will entirely replace an existing object.
19582         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19583         #
19584         Other differences between PUT and PATCH are:
19585         #
19586         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19587         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19588         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19589       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
19590       consumes:
19591         - application/json
19592         - application/xml
19593       produces:
19594         - application/json
19595         - application/xml
19596       responses:
19597         "default":
19598           description: Response codes found in [response codes](https://wiki.onap.org/).
19599       parameters:
19600         - name: named-query-uuid
19601           in: path
19602           required: true
19603           type: string
19604           example: __NAMED-QUERY-UUID__
19605         - name: body
19606           in: body
19607           description: named-query object that needs to be updated.
19608           required: true
19609           schema:
19610             $ref: "#/patchDefinitions/named-query"
19611     delete:
19612       tags:
19613         - ServiceDesignAndCreation
19614       summary: delete an existing named-query
19615       description: delete an existing named-query
19616       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
19617       consumes:
19618         - application/json
19619         - application/xml
19620       produces:
19621         - application/json
19622         - application/xml
19623       responses:
19624         "default":
19625           description: Response codes found in [response codes](https://wiki.onap.org/).
19626       parameters:
19627         - name: named-query-uuid
19628           in: path
19629           required: true
19630           type: string
19631           example: __NAMED-QUERY-UUID__
19632         - name: resource-version
19633           in: query
19634           description: resource-version for concurrency
19635           required: true
19636           type: string
19637   /service-design-and-creation/named-queries:
19638     get:
19639       tags:
19640         - ServiceDesignAndCreation
19641       summary: returns named-queries
19642       description: returns named-queries
19643       operationId: getServiceDesignAndCreationNamedQueries
19644       produces:
19645         - application/json
19646         - application/xml
19647       responses:
19648         "200":
19649           description: successful operation
19650           schema:
19651               $ref: "#/getDefinitions/named-queries"
19652         "default":
19653           description: Response codes found in [response codes](https://wiki.onap.org/).
19654       parameters:
19655         - name: named-query-uuid
19656           in: query
19657           description:
19658           required: false
19659           type: string
19660         - name: named-query-name
19661           in: query
19662           description:
19663           required: false
19664           type: string
19665   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
19666     put:
19667       tags:
19668         - Network
19669       summary: see node definition for valid relationships
19670       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
19671       consumes:
19672         - application/json
19673         - application/xml
19674       produces:
19675         - application/json
19676         - application/xml
19677       responses:
19678         "default":
19679           description: Response codes found in [response codes](https://wiki.onap.org/).
19680       parameters:
19681         - name: link-name
19682           in: path
19683           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19684           required: true
19685           type: string
19686           example: __LINK-NAME__
19687         - name: body
19688           in: body
19689           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
19690           required: true
19691           schema:
19692             $ref: "#/definitions/relationship"
19693     delete:
19694       tags:
19695         - Network
19696       summary: delete an existing relationship
19697       description: delete an existing relationship
19698       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
19699       consumes:
19700         - application/json
19701         - application/xml
19702       produces:
19703         - application/json
19704         - application/xml
19705       responses:
19706         "default":
19707           description: Response codes found in [response codes](https://wiki.onap.org/).
19708       parameters:
19709         - name: link-name
19710           in: path
19711           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19712           required: true
19713           type: string
19714           example: __LINK-NAME__
19715   /network/logical-links/logical-link/{link-name}:
19716     get:
19717       tags:
19718         - Network
19719       summary: returns logical-link
19720       description: returns logical-link
19721       operationId: getNetworkLogicalLinksLogicalLink
19722       produces:
19723         - application/json
19724         - application/xml
19725       responses:
19726         "200":
19727           description: successful operation
19728           schema:
19729               $ref: "#/getDefinitions/logical-link"
19730         "default":
19731           description: Response codes found in [response codes](https://wiki.onap.org/).
19732       parameters:
19733         - name: link-name
19734           in: path
19735           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19736           required: true
19737           type: string
19738           example: __LINK-NAME__
19739     put:
19740       tags:
19741         - Network
19742       summary: create or update an existing logical-link
19743       description: |
19744         Create or update an existing logical-link.
19745         #
19746         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19747       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
19748       consumes:
19749         - application/json
19750         - application/xml
19751       produces:
19752         - application/json
19753         - application/xml
19754       responses:
19755         "default":
19756           description: Response codes found in [response codes](https://wiki.onap.org/).
19757       parameters:
19758         - name: link-name
19759           in: path
19760           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19761           required: true
19762           type: string
19763           example: __LINK-NAME__
19764         - name: body
19765           in: body
19766           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
19767           required: true
19768           schema:
19769             $ref: "#/definitions/logical-link"
19770     patch:
19771       tags:
19772         - Network
19773       summary: update an existing logical-link
19774       description: |
19775         Update an existing logical-link
19776         #
19777         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19778         The PUT operation will entirely replace an existing object.
19779         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19780         #
19781         Other differences between PUT and PATCH are:
19782         #
19783         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19784         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19785         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19786       operationId: UpdateNetworkLogicalLinksLogicalLink
19787       consumes:
19788         - application/json
19789         - application/xml
19790       produces:
19791         - application/json
19792         - application/xml
19793       responses:
19794         "default":
19795           description: Response codes found in [response codes](https://wiki.onap.org/).
19796       parameters:
19797         - name: link-name
19798           in: path
19799           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19800           required: true
19801           type: string
19802           example: __LINK-NAME__
19803         - name: body
19804           in: body
19805           description: logical-link object that needs to be updated.
19806           required: true
19807           schema:
19808             $ref: "#/patchDefinitions/logical-link"
19809     delete:
19810       tags:
19811         - Network
19812       summary: delete an existing logical-link
19813       description: delete an existing logical-link
19814       operationId: deleteNetworkLogicalLinksLogicalLink
19815       consumes:
19816         - application/json
19817         - application/xml
19818       produces:
19819         - application/json
19820         - application/xml
19821       responses:
19822         "default":
19823           description: Response codes found in [response codes](https://wiki.onap.org/).
19824       parameters:
19825         - name: link-name
19826           in: path
19827           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19828           required: true
19829           type: string
19830           example: __LINK-NAME__
19831         - name: resource-version
19832           in: query
19833           description: resource-version for concurrency
19834           required: true
19835           type: string
19836   /network/logical-links:
19837     get:
19838       tags:
19839         - Network
19840       summary: returns logical-links
19841       description: returns logical-links
19842       operationId: getNetworkLogicalLinks
19843       produces:
19844         - application/json
19845         - application/xml
19846       responses:
19847         "200":
19848           description: successful operation
19849           schema:
19850               $ref: "#/getDefinitions/logical-links"
19851         "default":
19852           description: Response codes found in [response codes](https://wiki.onap.org/).
19853       parameters:
19854         - name: link-name
19855           in: query
19856           description:
19857           required: false
19858           type: string
19859         - name: model-invariant-id
19860           in: query
19861           description:
19862           required: false
19863           type: string
19864         - name: model-version-id
19865           in: query
19866           description:
19867           required: false
19868           type: string
19869         - name: widget-model-id
19870           in: query
19871           description:
19872           required: false
19873           type: string
19874         - name: widget-model-version
19875           in: query
19876           description:
19877           required: false
19878           type: string
19879         - name: prov-status
19880           in: query
19881           description:
19882           required: false
19883           type: string
19884         - name: link-id
19885           in: query
19886           description:
19887           required: false
19888           type: string
19889         - name: circuit-id
19890           in: query
19891           description:
19892           required: false
19893           type: string
19894         - name: purpose
19895           in: query
19896           description:
19897           required: false
19898           type: string
19899   /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:
19900     put:
19901       tags:
19902         - Network
19903       summary: see node definition for valid relationships
19904       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
19905       consumes:
19906         - application/json
19907         - application/xml
19908       produces:
19909         - application/json
19910         - application/xml
19911       responses:
19912         "default":
19913           description: Response codes found in [response codes](https://wiki.onap.org/).
19914       parameters:
19915         - name: site-pair-set-id
19916           in: path
19917           description: Unique id of site pair set.
19918           required: true
19919           type: string
19920           example: __SITE-PAIR-SET-ID__
19921         - name: routing-instance-id
19922           in: path
19923           description: Unique id of routing instance
19924           required: true
19925           type: string
19926           example: __ROUTING-INSTANCE-ID__
19927         - name: site-pair-id
19928           in: path
19929           description: unique identifier of probe
19930           required: true
19931           type: string
19932           example: __SITE-PAIR-ID__
19933         - name: cos
19934           in: path
19935           description: unique identifier of probe
19936           required: true
19937           type: string
19938           example: __COS__
19939         - name: body
19940           in: body
19941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
19942           required: true
19943           schema:
19944             $ref: "#/definitions/relationship"
19945     delete:
19946       tags:
19947         - Network
19948       summary: delete an existing relationship
19949       description: delete an existing relationship
19950       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
19951       consumes:
19952         - application/json
19953         - application/xml
19954       produces:
19955         - application/json
19956         - application/xml
19957       responses:
19958         "default":
19959           description: Response codes found in [response codes](https://wiki.onap.org/).
19960       parameters:
19961         - name: site-pair-set-id
19962           in: path
19963           description: Unique id of site pair set.
19964           required: true
19965           type: string
19966           example: __SITE-PAIR-SET-ID__
19967         - name: routing-instance-id
19968           in: path
19969           description: Unique id of routing instance
19970           required: true
19971           type: string
19972           example: __ROUTING-INSTANCE-ID__
19973         - name: site-pair-id
19974           in: path
19975           description: unique identifier of probe
19976           required: true
19977           type: string
19978           example: __SITE-PAIR-ID__
19979         - name: cos
19980           in: path
19981           description: unique identifier of probe
19982           required: true
19983           type: string
19984           example: __COS__
19985   /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}:
19986     get:
19987       tags:
19988         - Network
19989       summary: returns class-of-service
19990       description: returns class-of-service
19991       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
19992       produces:
19993         - application/json
19994         - application/xml
19995       responses:
19996         "200":
19997           description: successful operation
19998           schema:
19999               $ref: "#/getDefinitions/class-of-service"
20000         "default":
20001           description: Response codes found in [response codes](https://wiki.onap.org/).
20002       parameters:
20003         - name: site-pair-set-id
20004           in: path
20005           description: Unique id of site pair set.
20006           required: true
20007           type: string
20008           example: __SITE-PAIR-SET-ID__
20009         - name: routing-instance-id
20010           in: path
20011           description: Unique id of routing instance
20012           required: true
20013           type: string
20014           example: __ROUTING-INSTANCE-ID__
20015         - name: site-pair-id
20016           in: path
20017           description: unique identifier of probe
20018           required: true
20019           type: string
20020           example: __SITE-PAIR-ID__
20021         - name: cos
20022           in: path
20023           description: unique identifier of probe
20024           required: true
20025           type: string
20026           example: __COS__
20027     put:
20028       tags:
20029         - Network
20030       summary: create or update an existing class-of-service
20031       description: |
20032         Create or update an existing class-of-service.
20033         #
20034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20035       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20036       consumes:
20037         - application/json
20038         - application/xml
20039       produces:
20040         - application/json
20041         - application/xml
20042       responses:
20043         "default":
20044           description: Response codes found in [response codes](https://wiki.onap.org/).
20045       parameters:
20046         - name: site-pair-set-id
20047           in: path
20048           description: Unique id of site pair set.
20049           required: true
20050           type: string
20051           example: __SITE-PAIR-SET-ID__
20052         - name: routing-instance-id
20053           in: path
20054           description: Unique id of routing instance
20055           required: true
20056           type: string
20057           example: __ROUTING-INSTANCE-ID__
20058         - name: site-pair-id
20059           in: path
20060           description: unique identifier of probe
20061           required: true
20062           type: string
20063           example: __SITE-PAIR-ID__
20064         - name: cos
20065           in: path
20066           description: unique identifier of probe
20067           required: true
20068           type: string
20069           example: __COS__
20070         - name: body
20071           in: body
20072           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20073           required: true
20074           schema:
20075             $ref: "#/definitions/class-of-service"
20076     patch:
20077       tags:
20078         - Network
20079       summary: update an existing class-of-service
20080       description: |
20081         Update an existing class-of-service
20082         #
20083         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20084         The PUT operation will entirely replace an existing object.
20085         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20086         #
20087         Other differences between PUT and PATCH are:
20088         #
20089         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20090         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20091         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20092       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20093       consumes:
20094         - application/json
20095         - application/xml
20096       produces:
20097         - application/json
20098         - application/xml
20099       responses:
20100         "default":
20101           description: Response codes found in [response codes](https://wiki.onap.org/).
20102       parameters:
20103         - name: site-pair-set-id
20104           in: path
20105           description: Unique id of site pair set.
20106           required: true
20107           type: string
20108           example: __SITE-PAIR-SET-ID__
20109         - name: routing-instance-id
20110           in: path
20111           description: Unique id of routing instance
20112           required: true
20113           type: string
20114           example: __ROUTING-INSTANCE-ID__
20115         - name: site-pair-id
20116           in: path
20117           description: unique identifier of probe
20118           required: true
20119           type: string
20120           example: __SITE-PAIR-ID__
20121         - name: cos
20122           in: path
20123           description: unique identifier of probe
20124           required: true
20125           type: string
20126           example: __COS__
20127         - name: body
20128           in: body
20129           description: class-of-service object that needs to be updated.
20130           required: true
20131           schema:
20132             $ref: "#/patchDefinitions/class-of-service"
20133     delete:
20134       tags:
20135         - Network
20136       summary: delete an existing class-of-service
20137       description: delete an existing class-of-service
20138       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20139       consumes:
20140         - application/json
20141         - application/xml
20142       produces:
20143         - application/json
20144         - application/xml
20145       responses:
20146         "default":
20147           description: Response codes found in [response codes](https://wiki.onap.org/).
20148       parameters:
20149         - name: site-pair-set-id
20150           in: path
20151           description: Unique id of site pair set.
20152           required: true
20153           type: string
20154           example: __SITE-PAIR-SET-ID__
20155         - name: routing-instance-id
20156           in: path
20157           description: Unique id of routing instance
20158           required: true
20159           type: string
20160           example: __ROUTING-INSTANCE-ID__
20161         - name: site-pair-id
20162           in: path
20163           description: unique identifier of probe
20164           required: true
20165           type: string
20166           example: __SITE-PAIR-ID__
20167         - name: cos
20168           in: path
20169           description: unique identifier of probe
20170           required: true
20171           type: string
20172           example: __COS__
20173         - name: resource-version
20174           in: query
20175           description: resource-version for concurrency
20176           required: true
20177           type: string
20178   /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:
20179     get:
20180       tags:
20181         - Network
20182       summary: returns classes-of-service
20183       description: returns classes-of-service
20184       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20185       produces:
20186         - application/json
20187         - application/xml
20188       responses:
20189         "200":
20190           description: successful operation
20191           schema:
20192               $ref: "#/getDefinitions/classes-of-service"
20193         "default":
20194           description: Response codes found in [response codes](https://wiki.onap.org/).
20195       parameters:
20196         - name: site-pair-set-id
20197           in: path
20198           description: Unique id of site pair set.
20199           required: true
20200           type: string
20201           example: __SITE-PAIR-SET-ID__
20202         - name: routing-instance-id
20203           in: path
20204           description: Unique id of routing instance
20205           required: true
20206           type: string
20207           example: __ROUTING-INSTANCE-ID__
20208         - name: site-pair-id
20209           in: path
20210           description: unique identifier of probe
20211           required: true
20212           type: string
20213           example: __SITE-PAIR-ID__
20214         - name: cos
20215           in: query
20216           description:
20217           required: false
20218           type: string
20219   /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:
20220     put:
20221       tags:
20222         - Network
20223       summary: see node definition for valid relationships
20224       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20225       consumes:
20226         - application/json
20227         - application/xml
20228       produces:
20229         - application/json
20230         - application/xml
20231       responses:
20232         "default":
20233           description: Response codes found in [response codes](https://wiki.onap.org/).
20234       parameters:
20235         - name: site-pair-set-id
20236           in: path
20237           description: Unique id of site pair set.
20238           required: true
20239           type: string
20240           example: __SITE-PAIR-SET-ID__
20241         - name: routing-instance-id
20242           in: path
20243           description: Unique id of routing instance
20244           required: true
20245           type: string
20246           example: __ROUTING-INSTANCE-ID__
20247         - name: site-pair-id
20248           in: path
20249           description: unique identifier of probe
20250           required: true
20251           type: string
20252           example: __SITE-PAIR-ID__
20253         - name: body
20254           in: body
20255           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20256           required: true
20257           schema:
20258             $ref: "#/definitions/relationship"
20259     delete:
20260       tags:
20261         - Network
20262       summary: delete an existing relationship
20263       description: delete an existing relationship
20264       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20265       consumes:
20266         - application/json
20267         - application/xml
20268       produces:
20269         - application/json
20270         - application/xml
20271       responses:
20272         "default":
20273           description: Response codes found in [response codes](https://wiki.onap.org/).
20274       parameters:
20275         - name: site-pair-set-id
20276           in: path
20277           description: Unique id of site pair set.
20278           required: true
20279           type: string
20280           example: __SITE-PAIR-SET-ID__
20281         - name: routing-instance-id
20282           in: path
20283           description: Unique id of routing instance
20284           required: true
20285           type: string
20286           example: __ROUTING-INSTANCE-ID__
20287         - name: site-pair-id
20288           in: path
20289           description: unique identifier of probe
20290           required: true
20291           type: string
20292           example: __SITE-PAIR-ID__
20293   /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}:
20294     get:
20295       tags:
20296         - Network
20297       summary: returns site-pair
20298       description: returns site-pair
20299       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20300       produces:
20301         - application/json
20302         - application/xml
20303       responses:
20304         "200":
20305           description: successful operation
20306           schema:
20307               $ref: "#/getDefinitions/site-pair"
20308         "default":
20309           description: Response codes found in [response codes](https://wiki.onap.org/).
20310       parameters:
20311         - name: site-pair-set-id
20312           in: path
20313           description: Unique id of site pair set.
20314           required: true
20315           type: string
20316           example: __SITE-PAIR-SET-ID__
20317         - name: routing-instance-id
20318           in: path
20319           description: Unique id of routing instance
20320           required: true
20321           type: string
20322           example: __ROUTING-INSTANCE-ID__
20323         - name: site-pair-id
20324           in: path
20325           description: unique identifier of probe
20326           required: true
20327           type: string
20328           example: __SITE-PAIR-ID__
20329     put:
20330       tags:
20331         - Network
20332       summary: create or update an existing site-pair
20333       description: |
20334         Create or update an existing site-pair.
20335         #
20336         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20337       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20338       consumes:
20339         - application/json
20340         - application/xml
20341       produces:
20342         - application/json
20343         - application/xml
20344       responses:
20345         "default":
20346           description: Response codes found in [response codes](https://wiki.onap.org/).
20347       parameters:
20348         - name: site-pair-set-id
20349           in: path
20350           description: Unique id of site pair set.
20351           required: true
20352           type: string
20353           example: __SITE-PAIR-SET-ID__
20354         - name: routing-instance-id
20355           in: path
20356           description: Unique id of routing instance
20357           required: true
20358           type: string
20359           example: __ROUTING-INSTANCE-ID__
20360         - name: site-pair-id
20361           in: path
20362           description: unique identifier of probe
20363           required: true
20364           type: string
20365           example: __SITE-PAIR-ID__
20366         - name: body
20367           in: body
20368           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20369           required: true
20370           schema:
20371             $ref: "#/definitions/site-pair"
20372     patch:
20373       tags:
20374         - Network
20375       summary: update an existing site-pair
20376       description: |
20377         Update an existing site-pair
20378         #
20379         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20380         The PUT operation will entirely replace an existing object.
20381         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20382         #
20383         Other differences between PUT and PATCH are:
20384         #
20385         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20386         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20387         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20388       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20389       consumes:
20390         - application/json
20391         - application/xml
20392       produces:
20393         - application/json
20394         - application/xml
20395       responses:
20396         "default":
20397           description: Response codes found in [response codes](https://wiki.onap.org/).
20398       parameters:
20399         - name: site-pair-set-id
20400           in: path
20401           description: Unique id of site pair set.
20402           required: true
20403           type: string
20404           example: __SITE-PAIR-SET-ID__
20405         - name: routing-instance-id
20406           in: path
20407           description: Unique id of routing instance
20408           required: true
20409           type: string
20410           example: __ROUTING-INSTANCE-ID__
20411         - name: site-pair-id
20412           in: path
20413           description: unique identifier of probe
20414           required: true
20415           type: string
20416           example: __SITE-PAIR-ID__
20417         - name: body
20418           in: body
20419           description: site-pair object that needs to be updated.
20420           required: true
20421           schema:
20422             $ref: "#/patchDefinitions/site-pair"
20423     delete:
20424       tags:
20425         - Network
20426       summary: delete an existing site-pair
20427       description: delete an existing site-pair
20428       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20429       consumes:
20430         - application/json
20431         - application/xml
20432       produces:
20433         - application/json
20434         - application/xml
20435       responses:
20436         "default":
20437           description: Response codes found in [response codes](https://wiki.onap.org/).
20438       parameters:
20439         - name: site-pair-set-id
20440           in: path
20441           description: Unique id of site pair set.
20442           required: true
20443           type: string
20444           example: __SITE-PAIR-SET-ID__
20445         - name: routing-instance-id
20446           in: path
20447           description: Unique id of routing instance
20448           required: true
20449           type: string
20450           example: __ROUTING-INSTANCE-ID__
20451         - name: site-pair-id
20452           in: path
20453           description: unique identifier of probe
20454           required: true
20455           type: string
20456           example: __SITE-PAIR-ID__
20457         - name: resource-version
20458           in: query
20459           description: resource-version for concurrency
20460           required: true
20461           type: string
20462   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20463     get:
20464       tags:
20465         - Network
20466       summary: returns site-pairs
20467       description: returns site-pairs
20468       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20469       produces:
20470         - application/json
20471         - application/xml
20472       responses:
20473         "200":
20474           description: successful operation
20475           schema:
20476               $ref: "#/getDefinitions/site-pairs"
20477         "default":
20478           description: Response codes found in [response codes](https://wiki.onap.org/).
20479       parameters:
20480         - name: site-pair-set-id
20481           in: path
20482           description: Unique id of site pair set.
20483           required: true
20484           type: string
20485           example: __SITE-PAIR-SET-ID__
20486         - name: routing-instance-id
20487           in: path
20488           description: Unique id of routing instance
20489           required: true
20490           type: string
20491           example: __ROUTING-INSTANCE-ID__
20492         - name: site-pair-id
20493           in: query
20494           description:
20495           required: false
20496           type: string
20497   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20498     put:
20499       tags:
20500         - Network
20501       summary: see node definition for valid relationships
20502       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20503       consumes:
20504         - application/json
20505         - application/xml
20506       produces:
20507         - application/json
20508         - application/xml
20509       responses:
20510         "default":
20511           description: Response codes found in [response codes](https://wiki.onap.org/).
20512       parameters:
20513         - name: site-pair-set-id
20514           in: path
20515           description: Unique id of site pair set.
20516           required: true
20517           type: string
20518           example: __SITE-PAIR-SET-ID__
20519         - name: routing-instance-id
20520           in: path
20521           description: Unique id of routing instance
20522           required: true
20523           type: string
20524           example: __ROUTING-INSTANCE-ID__
20525         - name: body
20526           in: body
20527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20528           required: true
20529           schema:
20530             $ref: "#/definitions/relationship"
20531     delete:
20532       tags:
20533         - Network
20534       summary: delete an existing relationship
20535       description: delete an existing relationship
20536       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20537       consumes:
20538         - application/json
20539         - application/xml
20540       produces:
20541         - application/json
20542         - application/xml
20543       responses:
20544         "default":
20545           description: Response codes found in [response codes](https://wiki.onap.org/).
20546       parameters:
20547         - name: site-pair-set-id
20548           in: path
20549           description: Unique id of site pair set.
20550           required: true
20551           type: string
20552           example: __SITE-PAIR-SET-ID__
20553         - name: routing-instance-id
20554           in: path
20555           description: Unique id of routing instance
20556           required: true
20557           type: string
20558           example: __ROUTING-INSTANCE-ID__
20559   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20560     get:
20561       tags:
20562         - Network
20563       summary: returns routing-instance
20564       description: returns routing-instance
20565       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20566       produces:
20567         - application/json
20568         - application/xml
20569       responses:
20570         "200":
20571           description: successful operation
20572           schema:
20573               $ref: "#/getDefinitions/routing-instance"
20574         "default":
20575           description: Response codes found in [response codes](https://wiki.onap.org/).
20576       parameters:
20577         - name: site-pair-set-id
20578           in: path
20579           description: Unique id of site pair set.
20580           required: true
20581           type: string
20582           example: __SITE-PAIR-SET-ID__
20583         - name: routing-instance-id
20584           in: path
20585           description: Unique id of routing instance
20586           required: true
20587           type: string
20588           example: __ROUTING-INSTANCE-ID__
20589     put:
20590       tags:
20591         - Network
20592       summary: create or update an existing routing-instance
20593       description: |
20594         Create or update an existing routing-instance.
20595         #
20596         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20597       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20598       consumes:
20599         - application/json
20600         - application/xml
20601       produces:
20602         - application/json
20603         - application/xml
20604       responses:
20605         "default":
20606           description: Response codes found in [response codes](https://wiki.onap.org/).
20607       parameters:
20608         - name: site-pair-set-id
20609           in: path
20610           description: Unique id of site pair set.
20611           required: true
20612           type: string
20613           example: __SITE-PAIR-SET-ID__
20614         - name: routing-instance-id
20615           in: path
20616           description: Unique id of routing instance
20617           required: true
20618           type: string
20619           example: __ROUTING-INSTANCE-ID__
20620         - name: body
20621           in: body
20622           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20623           required: true
20624           schema:
20625             $ref: "#/definitions/routing-instance"
20626     patch:
20627       tags:
20628         - Network
20629       summary: update an existing routing-instance
20630       description: |
20631         Update an existing routing-instance
20632         #
20633         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20634         The PUT operation will entirely replace an existing object.
20635         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20636         #
20637         Other differences between PUT and PATCH are:
20638         #
20639         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20640         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20641         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20642       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20643       consumes:
20644         - application/json
20645         - application/xml
20646       produces:
20647         - application/json
20648         - application/xml
20649       responses:
20650         "default":
20651           description: Response codes found in [response codes](https://wiki.onap.org/).
20652       parameters:
20653         - name: site-pair-set-id
20654           in: path
20655           description: Unique id of site pair set.
20656           required: true
20657           type: string
20658           example: __SITE-PAIR-SET-ID__
20659         - name: routing-instance-id
20660           in: path
20661           description: Unique id of routing instance
20662           required: true
20663           type: string
20664           example: __ROUTING-INSTANCE-ID__
20665         - name: body
20666           in: body
20667           description: routing-instance object that needs to be updated.
20668           required: true
20669           schema:
20670             $ref: "#/patchDefinitions/routing-instance"
20671     delete:
20672       tags:
20673         - Network
20674       summary: delete an existing routing-instance
20675       description: delete an existing routing-instance
20676       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20677       consumes:
20678         - application/json
20679         - application/xml
20680       produces:
20681         - application/json
20682         - application/xml
20683       responses:
20684         "default":
20685           description: Response codes found in [response codes](https://wiki.onap.org/).
20686       parameters:
20687         - name: site-pair-set-id
20688           in: path
20689           description: Unique id of site pair set.
20690           required: true
20691           type: string
20692           example: __SITE-PAIR-SET-ID__
20693         - name: routing-instance-id
20694           in: path
20695           description: Unique id of routing instance
20696           required: true
20697           type: string
20698           example: __ROUTING-INSTANCE-ID__
20699         - name: resource-version
20700           in: query
20701           description: resource-version for concurrency
20702           required: true
20703           type: string
20704   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
20705     get:
20706       tags:
20707         - Network
20708       summary: returns routing-instances
20709       description: returns routing-instances
20710       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
20711       produces:
20712         - application/json
20713         - application/xml
20714       responses:
20715         "200":
20716           description: successful operation
20717           schema:
20718               $ref: "#/getDefinitions/routing-instances"
20719         "default":
20720           description: Response codes found in [response codes](https://wiki.onap.org/).
20721       parameters:
20722         - name: site-pair-set-id
20723           in: path
20724           description: Unique id of site pair set.
20725           required: true
20726           type: string
20727           example: __SITE-PAIR-SET-ID__
20728         - name: routing-instance-id
20729           in: query
20730           description:
20731           required: false
20732           type: string
20733   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
20734     put:
20735       tags:
20736         - Network
20737       summary: see node definition for valid relationships
20738       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
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: site-pair-set-id
20750           in: path
20751           description: Unique id of site pair set.
20752           required: true
20753           type: string
20754           example: __SITE-PAIR-SET-ID__
20755         - name: body
20756           in: body
20757           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
20758           required: true
20759           schema:
20760             $ref: "#/definitions/relationship"
20761     delete:
20762       tags:
20763         - Network
20764       summary: delete an existing relationship
20765       description: delete an existing relationship
20766       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
20767       consumes:
20768         - application/json
20769         - application/xml
20770       produces:
20771         - application/json
20772         - application/xml
20773       responses:
20774         "default":
20775           description: Response codes found in [response codes](https://wiki.onap.org/).
20776       parameters:
20777         - name: site-pair-set-id
20778           in: path
20779           description: Unique id of site pair set.
20780           required: true
20781           type: string
20782           example: __SITE-PAIR-SET-ID__
20783   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
20784     get:
20785       tags:
20786         - Network
20787       summary: returns site-pair-set
20788       description: returns site-pair-set
20789       operationId: getNetworkSitePairSetsSitePairSet
20790       produces:
20791         - application/json
20792         - application/xml
20793       responses:
20794         "200":
20795           description: successful operation
20796           schema:
20797               $ref: "#/getDefinitions/site-pair-set"
20798         "default":
20799           description: Response codes found in [response codes](https://wiki.onap.org/).
20800       parameters:
20801         - name: site-pair-set-id
20802           in: path
20803           description: Unique id of site pair set.
20804           required: true
20805           type: string
20806           example: __SITE-PAIR-SET-ID__
20807     put:
20808       tags:
20809         - Network
20810       summary: create or update an existing site-pair-set
20811       description: |
20812         Create or update an existing site-pair-set.
20813         #
20814         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20815       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
20816       consumes:
20817         - application/json
20818         - application/xml
20819       produces:
20820         - application/json
20821         - application/xml
20822       responses:
20823         "default":
20824           description: Response codes found in [response codes](https://wiki.onap.org/).
20825       parameters:
20826         - name: site-pair-set-id
20827           in: path
20828           description: Unique id of site pair set.
20829           required: true
20830           type: string
20831           example: __SITE-PAIR-SET-ID__
20832         - name: body
20833           in: body
20834           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
20835           required: true
20836           schema:
20837             $ref: "#/definitions/site-pair-set"
20838     patch:
20839       tags:
20840         - Network
20841       summary: update an existing site-pair-set
20842       description: |
20843         Update an existing site-pair-set
20844         #
20845         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20846         The PUT operation will entirely replace an existing object.
20847         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20848         #
20849         Other differences between PUT and PATCH are:
20850         #
20851         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20852         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20853         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20854       operationId: UpdateNetworkSitePairSetsSitePairSet
20855       consumes:
20856         - application/json
20857         - application/xml
20858       produces:
20859         - application/json
20860         - application/xml
20861       responses:
20862         "default":
20863           description: Response codes found in [response codes](https://wiki.onap.org/).
20864       parameters:
20865         - name: site-pair-set-id
20866           in: path
20867           description: Unique id of site pair set.
20868           required: true
20869           type: string
20870           example: __SITE-PAIR-SET-ID__
20871         - name: body
20872           in: body
20873           description: site-pair-set object that needs to be updated.
20874           required: true
20875           schema:
20876             $ref: "#/patchDefinitions/site-pair-set"
20877     delete:
20878       tags:
20879         - Network
20880       summary: delete an existing site-pair-set
20881       description: delete an existing site-pair-set
20882       operationId: deleteNetworkSitePairSetsSitePairSet
20883       consumes:
20884         - application/json
20885         - application/xml
20886       produces:
20887         - application/json
20888         - application/xml
20889       responses:
20890         "default":
20891           description: Response codes found in [response codes](https://wiki.onap.org/).
20892       parameters:
20893         - name: site-pair-set-id
20894           in: path
20895           description: Unique id of site pair set.
20896           required: true
20897           type: string
20898           example: __SITE-PAIR-SET-ID__
20899         - name: resource-version
20900           in: query
20901           description: resource-version for concurrency
20902           required: true
20903           type: string
20904   /network/site-pair-sets:
20905     get:
20906       tags:
20907         - Network
20908       summary: returns site-pair-sets
20909       description: returns site-pair-sets
20910       operationId: getNetworkSitePairSets
20911       produces:
20912         - application/json
20913         - application/xml
20914       responses:
20915         "200":
20916           description: successful operation
20917           schema:
20918               $ref: "#/getDefinitions/site-pair-sets"
20919         "default":
20920           description: Response codes found in [response codes](https://wiki.onap.org/).
20921       parameters:
20922         - name: site-pair-set-id
20923           in: query
20924           description:
20925           required: false
20926           type: string
20927   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
20928     put:
20929       tags:
20930         - Network
20931       summary: see node definition for valid relationships
20932       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
20933       consumes:
20934         - application/json
20935         - application/xml
20936       produces:
20937         - application/json
20938         - application/xml
20939       responses:
20940         "default":
20941           description: Response codes found in [response codes](https://wiki.onap.org/).
20942       parameters:
20943         - name: vpn-id
20944           in: path
20945           description: VPN ID, globally unique within A&AI
20946           required: true
20947           type: string
20948           example: __VPN-ID__
20949         - name: global-route-target
20950           in: path
20951           description: Number used to identify an RT, globally unique in the network
20952           required: true
20953           type: string
20954           example: __GLOBAL-ROUTE-TARGET__
20955         - name: route-target-role
20956           in: path
20957           description: Role assigned to this route target
20958           required: true
20959           type: string
20960           example: __ROUTE-TARGET-ROLE__
20961         - name: body
20962           in: body
20963           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
20964           required: true
20965           schema:
20966             $ref: "#/definitions/relationship"
20967     delete:
20968       tags:
20969         - Network
20970       summary: delete an existing relationship
20971       description: delete an existing relationship
20972       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
20973       consumes:
20974         - application/json
20975         - application/xml
20976       produces:
20977         - application/json
20978         - application/xml
20979       responses:
20980         "default":
20981           description: Response codes found in [response codes](https://wiki.onap.org/).
20982       parameters:
20983         - name: vpn-id
20984           in: path
20985           description: VPN ID, globally unique within A&AI
20986           required: true
20987           type: string
20988           example: __VPN-ID__
20989         - name: global-route-target
20990           in: path
20991           description: Number used to identify an RT, globally unique in the network
20992           required: true
20993           type: string
20994           example: __GLOBAL-ROUTE-TARGET__
20995         - name: route-target-role
20996           in: path
20997           description: Role assigned to this route target
20998           required: true
20999           type: string
21000           example: __ROUTE-TARGET-ROLE__
21001   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
21002     get:
21003       tags:
21004         - Network
21005       summary: returns route-target
21006       description: returns route-target
21007       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21008       produces:
21009         - application/json
21010         - application/xml
21011       responses:
21012         "200":
21013           description: successful operation
21014           schema:
21015               $ref: "#/getDefinitions/route-target"
21016         "default":
21017           description: Response codes found in [response codes](https://wiki.onap.org/).
21018       parameters:
21019         - name: vpn-id
21020           in: path
21021           description: VPN ID, globally unique within A&AI
21022           required: true
21023           type: string
21024           example: __VPN-ID__
21025         - name: global-route-target
21026           in: path
21027           description: Number used to identify an RT, globally unique in the network
21028           required: true
21029           type: string
21030           example: __GLOBAL-ROUTE-TARGET__
21031         - name: route-target-role
21032           in: path
21033           description: Role assigned to this route target
21034           required: true
21035           type: string
21036           example: __ROUTE-TARGET-ROLE__
21037     put:
21038       tags:
21039         - Network
21040       summary: create or update an existing route-target
21041       description: |
21042         Create or update an existing route-target.
21043         #
21044         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21045       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21046       consumes:
21047         - application/json
21048         - application/xml
21049       produces:
21050         - application/json
21051         - application/xml
21052       responses:
21053         "default":
21054           description: Response codes found in [response codes](https://wiki.onap.org/).
21055       parameters:
21056         - name: vpn-id
21057           in: path
21058           description: VPN ID, globally unique within A&AI
21059           required: true
21060           type: string
21061           example: __VPN-ID__
21062         - name: global-route-target
21063           in: path
21064           description: Number used to identify an RT, globally unique in the network
21065           required: true
21066           type: string
21067           example: __GLOBAL-ROUTE-TARGET__
21068         - name: route-target-role
21069           in: path
21070           description: Role assigned to this route target
21071           required: true
21072           type: string
21073           example: __ROUTE-TARGET-ROLE__
21074         - name: body
21075           in: body
21076           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21077           required: true
21078           schema:
21079             $ref: "#/definitions/route-target"
21080     patch:
21081       tags:
21082         - Network
21083       summary: update an existing route-target
21084       description: |
21085         Update an existing route-target
21086         #
21087         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21088         The PUT operation will entirely replace an existing object.
21089         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21090         #
21091         Other differences between PUT and PATCH are:
21092         #
21093         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21094         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21095         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21096       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21097       consumes:
21098         - application/json
21099         - application/xml
21100       produces:
21101         - application/json
21102         - application/xml
21103       responses:
21104         "default":
21105           description: Response codes found in [response codes](https://wiki.onap.org/).
21106       parameters:
21107         - name: vpn-id
21108           in: path
21109           description: VPN ID, globally unique within A&AI
21110           required: true
21111           type: string
21112           example: __VPN-ID__
21113         - name: global-route-target
21114           in: path
21115           description: Number used to identify an RT, globally unique in the network
21116           required: true
21117           type: string
21118           example: __GLOBAL-ROUTE-TARGET__
21119         - name: route-target-role
21120           in: path
21121           description: Role assigned to this route target
21122           required: true
21123           type: string
21124           example: __ROUTE-TARGET-ROLE__
21125         - name: body
21126           in: body
21127           description: route-target object that needs to be updated.
21128           required: true
21129           schema:
21130             $ref: "#/patchDefinitions/route-target"
21131     delete:
21132       tags:
21133         - Network
21134       summary: delete an existing route-target
21135       description: delete an existing route-target
21136       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21137       consumes:
21138         - application/json
21139         - application/xml
21140       produces:
21141         - application/json
21142         - application/xml
21143       responses:
21144         "default":
21145           description: Response codes found in [response codes](https://wiki.onap.org/).
21146       parameters:
21147         - name: vpn-id
21148           in: path
21149           description: VPN ID, globally unique within A&AI
21150           required: true
21151           type: string
21152           example: __VPN-ID__
21153         - name: global-route-target
21154           in: path
21155           description: Number used to identify an RT, globally unique in the network
21156           required: true
21157           type: string
21158           example: __GLOBAL-ROUTE-TARGET__
21159         - name: route-target-role
21160           in: path
21161           description: Role assigned to this route target
21162           required: true
21163           type: string
21164           example: __ROUTE-TARGET-ROLE__
21165         - name: resource-version
21166           in: query
21167           description: resource-version for concurrency
21168           required: true
21169           type: string
21170   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
21171     get:
21172       tags:
21173         - Network
21174       summary: returns route-targets
21175       description: returns route-targets
21176       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
21177       produces:
21178         - application/json
21179         - application/xml
21180       responses:
21181         "200":
21182           description: successful operation
21183           schema:
21184               $ref: "#/getDefinitions/route-targets"
21185         "default":
21186           description: Response codes found in [response codes](https://wiki.onap.org/).
21187       parameters:
21188         - name: vpn-id
21189           in: path
21190           description: VPN ID, globally unique within A&AI
21191           required: true
21192           type: string
21193           example: __VPN-ID__
21194   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21195     put:
21196       tags:
21197         - Network
21198       summary: see node definition for valid relationships
21199       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
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: vpn-id
21211           in: path
21212           description: VPN ID, globally unique within A&AI
21213           required: true
21214           type: string
21215           example: __VPN-ID__
21216         - name: body
21217           in: body
21218           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
21219           required: true
21220           schema:
21221             $ref: "#/definitions/relationship"
21222     delete:
21223       tags:
21224         - Network
21225       summary: delete an existing relationship
21226       description: delete an existing relationship
21227       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21228       consumes:
21229         - application/json
21230         - application/xml
21231       produces:
21232         - application/json
21233         - application/xml
21234       responses:
21235         "default":
21236           description: Response codes found in [response codes](https://wiki.onap.org/).
21237       parameters:
21238         - name: vpn-id
21239           in: path
21240           description: VPN ID, globally unique within A&AI
21241           required: true
21242           type: string
21243           example: __VPN-ID__
21244   /network/vpn-bindings/vpn-binding/{vpn-id}:
21245     get:
21246       tags:
21247         - Network
21248       summary: returns vpn-binding
21249       description: returns vpn-binding
21250       operationId: getNetworkVpnBindingsVpnBinding
21251       produces:
21252         - application/json
21253         - application/xml
21254       responses:
21255         "200":
21256           description: successful operation
21257           schema:
21258               $ref: "#/getDefinitions/vpn-binding"
21259         "default":
21260           description: Response codes found in [response codes](https://wiki.onap.org/).
21261       parameters:
21262         - name: vpn-id
21263           in: path
21264           description: VPN ID, globally unique within A&AI
21265           required: true
21266           type: string
21267           example: __VPN-ID__
21268     put:
21269       tags:
21270         - Network
21271       summary: create or update an existing vpn-binding
21272       description: |
21273         Create or update an existing vpn-binding.
21274         #
21275         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21276       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21277       consumes:
21278         - application/json
21279         - application/xml
21280       produces:
21281         - application/json
21282         - application/xml
21283       responses:
21284         "default":
21285           description: Response codes found in [response codes](https://wiki.onap.org/).
21286       parameters:
21287         - name: vpn-id
21288           in: path
21289           description: VPN ID, globally unique within A&AI
21290           required: true
21291           type: string
21292           example: __VPN-ID__
21293         - name: body
21294           in: body
21295           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
21296           required: true
21297           schema:
21298             $ref: "#/definitions/vpn-binding"
21299     patch:
21300       tags:
21301         - Network
21302       summary: update an existing vpn-binding
21303       description: |
21304         Update an existing vpn-binding
21305         #
21306         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21307         The PUT operation will entirely replace an existing object.
21308         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21309         #
21310         Other differences between PUT and PATCH are:
21311         #
21312         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21313         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21314         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21315       operationId: UpdateNetworkVpnBindingsVpnBinding
21316       consumes:
21317         - application/json
21318         - application/xml
21319       produces:
21320         - application/json
21321         - application/xml
21322       responses:
21323         "default":
21324           description: Response codes found in [response codes](https://wiki.onap.org/).
21325       parameters:
21326         - name: vpn-id
21327           in: path
21328           description: VPN ID, globally unique within A&AI
21329           required: true
21330           type: string
21331           example: __VPN-ID__
21332         - name: body
21333           in: body
21334           description: vpn-binding object that needs to be updated.
21335           required: true
21336           schema:
21337             $ref: "#/patchDefinitions/vpn-binding"
21338     delete:
21339       tags:
21340         - Network
21341       summary: delete an existing vpn-binding
21342       description: delete an existing vpn-binding
21343       operationId: deleteNetworkVpnBindingsVpnBinding
21344       consumes:
21345         - application/json
21346         - application/xml
21347       produces:
21348         - application/json
21349         - application/xml
21350       responses:
21351         "default":
21352           description: Response codes found in [response codes](https://wiki.onap.org/).
21353       parameters:
21354         - name: vpn-id
21355           in: path
21356           description: VPN ID, globally unique within A&AI
21357           required: true
21358           type: string
21359           example: __VPN-ID__
21360         - name: resource-version
21361           in: query
21362           description: resource-version for concurrency
21363           required: true
21364           type: string
21365   /network/vpn-bindings:
21366     get:
21367       tags:
21368         - Network
21369       summary: returns vpn-bindings
21370       description: returns vpn-bindings
21371       operationId: getNetworkVpnBindings
21372       produces:
21373         - application/json
21374         - application/xml
21375       responses:
21376         "200":
21377           description: successful operation
21378           schema:
21379               $ref: "#/getDefinitions/vpn-bindings"
21380         "default":
21381           description: Response codes found in [response codes](https://wiki.onap.org/).
21382       parameters:
21383         - name: vpn-id
21384           in: query
21385           description:
21386           required: false
21387           type: string
21388         - name: vpn-name
21389           in: query
21390           description:
21391           required: false
21392           type: string
21393         - name: vpn-type
21394           in: query
21395           description:
21396           required: false
21397           type: string
21398   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21399     put:
21400       tags:
21401         - Network
21402       summary: see node definition for valid relationships
21403       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21404       consumes:
21405         - application/json
21406         - application/xml
21407       produces:
21408         - application/json
21409         - application/xml
21410       responses:
21411         "default":
21412           description: Response codes found in [response codes](https://wiki.onap.org/).
21413       parameters:
21414         - name: equipment-name
21415           in: path
21416           required: true
21417           type: string
21418           example: __EQUIPMENT-NAME__
21419         - name: body
21420           in: body
21421           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
21422           required: true
21423           schema:
21424             $ref: "#/definitions/relationship"
21425     delete:
21426       tags:
21427         - Network
21428       summary: delete an existing relationship
21429       description: delete an existing relationship
21430       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21431       consumes:
21432         - application/json
21433         - application/xml
21434       produces:
21435         - application/json
21436         - application/xml
21437       responses:
21438         "default":
21439           description: Response codes found in [response codes](https://wiki.onap.org/).
21440       parameters:
21441         - name: equipment-name
21442           in: path
21443           required: true
21444           type: string
21445           example: __EQUIPMENT-NAME__
21446   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21447     put:
21448       tags:
21449         - Network
21450       summary: see node definition for valid relationships
21451       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21452       consumes:
21453         - application/json
21454         - application/xml
21455       produces:
21456         - application/json
21457         - application/xml
21458       responses:
21459         "default":
21460           description: Response codes found in [response codes](https://wiki.onap.org/).
21461       parameters:
21462         - name: equipment-name
21463           in: path
21464           required: true
21465           type: string
21466           example: __EQUIPMENT-NAME__
21467         - name: interface-name
21468           in: path
21469           description: Name that identifies the physical interface
21470           required: true
21471           type: string
21472           example: __INTERFACE-NAME__
21473         - name: body
21474           in: body
21475           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
21476           required: true
21477           schema:
21478             $ref: "#/definitions/relationship"
21479     delete:
21480       tags:
21481         - Network
21482       summary: delete an existing relationship
21483       description: delete an existing relationship
21484       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21485       consumes:
21486         - application/json
21487         - application/xml
21488       produces:
21489         - application/json
21490         - application/xml
21491       responses:
21492         "default":
21493           description: Response codes found in [response codes](https://wiki.onap.org/).
21494       parameters:
21495         - name: equipment-name
21496           in: path
21497           required: true
21498           type: string
21499           example: __EQUIPMENT-NAME__
21500         - name: interface-name
21501           in: path
21502           description: Name that identifies the physical interface
21503           required: true
21504           type: string
21505           example: __INTERFACE-NAME__
21506   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
21507     put:
21508       tags:
21509         - Network
21510       summary: see node definition for valid relationships
21511       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
21512       consumes:
21513         - application/json
21514         - application/xml
21515       produces:
21516         - application/json
21517         - application/xml
21518       responses:
21519         "default":
21520           description: Response codes found in [response codes](https://wiki.onap.org/).
21521       parameters:
21522         - name: equipment-name
21523           in: path
21524           required: true
21525           type: string
21526           example: __EQUIPMENT-NAME__
21527         - name: interface-name
21528           in: path
21529           description: Name that identifies the physical interface
21530           required: true
21531           type: string
21532           example: __INTERFACE-NAME__
21533         - name: pf-pci-id
21534           in: path
21535           description: Identifier for the sriov-pf
21536           required: true
21537           type: string
21538           example: __PF-PCI-ID__
21539         - name: body
21540           in: body
21541           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
21542           required: true
21543           schema:
21544             $ref: "#/definitions/relationship"
21545     delete:
21546       tags:
21547         - Network
21548       summary: delete an existing relationship
21549       description: delete an existing relationship
21550       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
21551       consumes:
21552         - application/json
21553         - application/xml
21554       produces:
21555         - application/json
21556         - application/xml
21557       responses:
21558         "default":
21559           description: Response codes found in [response codes](https://wiki.onap.org/).
21560       parameters:
21561         - name: equipment-name
21562           in: path
21563           required: true
21564           type: string
21565           example: __EQUIPMENT-NAME__
21566         - name: interface-name
21567           in: path
21568           description: Name that identifies the physical interface
21569           required: true
21570           type: string
21571           example: __INTERFACE-NAME__
21572         - name: pf-pci-id
21573           in: path
21574           description: Identifier for the sriov-pf
21575           required: true
21576           type: string
21577           example: __PF-PCI-ID__
21578   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
21579     get:
21580       tags:
21581         - Network
21582       summary: returns sriov-pf
21583       description: returns sriov-pf
21584       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21585       produces:
21586         - application/json
21587         - application/xml
21588       responses:
21589         "200":
21590           description: successful operation
21591           schema:
21592               $ref: "#/getDefinitions/sriov-pf"
21593         "default":
21594           description: Response codes found in [response codes](https://wiki.onap.org/).
21595       parameters:
21596         - name: equipment-name
21597           in: path
21598           required: true
21599           type: string
21600           example: __EQUIPMENT-NAME__
21601         - name: interface-name
21602           in: path
21603           description: Name that identifies the physical interface
21604           required: true
21605           type: string
21606           example: __INTERFACE-NAME__
21607         - name: pf-pci-id
21608           in: path
21609           description: Identifier for the sriov-pf
21610           required: true
21611           type: string
21612           example: __PF-PCI-ID__
21613     put:
21614       tags:
21615         - Network
21616       summary: create or update an existing sriov-pf
21617       description: |
21618         Create or update an existing sriov-pf.
21619         #
21620         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21621       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21622       consumes:
21623         - application/json
21624         - application/xml
21625       produces:
21626         - application/json
21627         - application/xml
21628       responses:
21629         "default":
21630           description: Response codes found in [response codes](https://wiki.onap.org/).
21631       parameters:
21632         - name: equipment-name
21633           in: path
21634           required: true
21635           type: string
21636           example: __EQUIPMENT-NAME__
21637         - name: interface-name
21638           in: path
21639           description: Name that identifies the physical interface
21640           required: true
21641           type: string
21642           example: __INTERFACE-NAME__
21643         - name: pf-pci-id
21644           in: path
21645           description: Identifier for the sriov-pf
21646           required: true
21647           type: string
21648           example: __PF-PCI-ID__
21649         - name: body
21650           in: body
21651           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
21652           required: true
21653           schema:
21654             $ref: "#/definitions/sriov-pf"
21655     patch:
21656       tags:
21657         - Network
21658       summary: update an existing sriov-pf
21659       description: |
21660         Update an existing sriov-pf
21661         #
21662         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21663         The PUT operation will entirely replace an existing object.
21664         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21665         #
21666         Other differences between PUT and PATCH are:
21667         #
21668         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21669         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21670         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21671       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21672       consumes:
21673         - application/json
21674         - application/xml
21675       produces:
21676         - application/json
21677         - application/xml
21678       responses:
21679         "default":
21680           description: Response codes found in [response codes](https://wiki.onap.org/).
21681       parameters:
21682         - name: equipment-name
21683           in: path
21684           required: true
21685           type: string
21686           example: __EQUIPMENT-NAME__
21687         - name: interface-name
21688           in: path
21689           description: Name that identifies the physical interface
21690           required: true
21691           type: string
21692           example: __INTERFACE-NAME__
21693         - name: pf-pci-id
21694           in: path
21695           description: Identifier for the sriov-pf
21696           required: true
21697           type: string
21698           example: __PF-PCI-ID__
21699         - name: body
21700           in: body
21701           description: sriov-pf object that needs to be updated.
21702           required: true
21703           schema:
21704             $ref: "#/patchDefinitions/sriov-pf"
21705     delete:
21706       tags:
21707         - Network
21708       summary: delete an existing sriov-pf
21709       description: delete an existing sriov-pf
21710       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21711       consumes:
21712         - application/json
21713         - application/xml
21714       produces:
21715         - application/json
21716         - application/xml
21717       responses:
21718         "default":
21719           description: Response codes found in [response codes](https://wiki.onap.org/).
21720       parameters:
21721         - name: equipment-name
21722           in: path
21723           required: true
21724           type: string
21725           example: __EQUIPMENT-NAME__
21726         - name: interface-name
21727           in: path
21728           description: Name that identifies the physical interface
21729           required: true
21730           type: string
21731           example: __INTERFACE-NAME__
21732         - name: pf-pci-id
21733           in: path
21734           description: Identifier for the sriov-pf
21735           required: true
21736           type: string
21737           example: __PF-PCI-ID__
21738         - name: resource-version
21739           in: query
21740           description: resource-version for concurrency
21741           required: true
21742           type: string
21743   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
21744     get:
21745       tags:
21746         - Network
21747       summary: returns sriov-pfs
21748       description: returns sriov-pfs
21749       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
21750       produces:
21751         - application/json
21752         - application/xml
21753       responses:
21754         "200":
21755           description: successful operation
21756           schema:
21757               $ref: "#/getDefinitions/sriov-pfs"
21758         "default":
21759           description: Response codes found in [response codes](https://wiki.onap.org/).
21760       parameters:
21761         - name: equipment-name
21762           in: path
21763           required: true
21764           type: string
21765           example: __EQUIPMENT-NAME__
21766         - name: interface-name
21767           in: path
21768           description: Name that identifies the physical interface
21769           required: true
21770           type: string
21771           example: __INTERFACE-NAME__
21772         - name: pf-pci-id
21773           in: query
21774           description:
21775           required: false
21776           type: string
21777   /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:
21778     put:
21779       tags:
21780         - Network
21781       summary: see node definition for valid relationships
21782       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21783       consumes:
21784         - application/json
21785         - application/xml
21786       produces:
21787         - application/json
21788         - application/xml
21789       responses:
21790         "default":
21791           description: Response codes found in [response codes](https://wiki.onap.org/).
21792       parameters:
21793         - name: equipment-name
21794           in: path
21795           required: true
21796           type: string
21797           example: __EQUIPMENT-NAME__
21798         - name: interface-name
21799           in: path
21800           description: Name that identifies the physical interface
21801           required: true
21802           type: string
21803           example: __INTERFACE-NAME__
21804         - name: interface-name
21805           in: path
21806           description: Name given to the interface
21807           required: true
21808           type: string
21809           example: __INTERFACE-NAME__
21810         - name: vlan-interface
21811           in: path
21812           description: String that identifies the interface
21813           required: true
21814           type: string
21815           example: __VLAN-INTERFACE__
21816         - name: body
21817           in: body
21818           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21819           required: true
21820           schema:
21821             $ref: "#/definitions/relationship"
21822     delete:
21823       tags:
21824         - Network
21825       summary: delete an existing relationship
21826       description: delete an existing relationship
21827       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21828       consumes:
21829         - application/json
21830         - application/xml
21831       produces:
21832         - application/json
21833         - application/xml
21834       responses:
21835         "default":
21836           description: Response codes found in [response codes](https://wiki.onap.org/).
21837       parameters:
21838         - name: equipment-name
21839           in: path
21840           required: true
21841           type: string
21842           example: __EQUIPMENT-NAME__
21843         - name: interface-name
21844           in: path
21845           description: Name that identifies the physical interface
21846           required: true
21847           type: string
21848           example: __INTERFACE-NAME__
21849         - name: interface-name
21850           in: path
21851           description: Name given to the interface
21852           required: true
21853           type: string
21854           example: __INTERFACE-NAME__
21855         - name: vlan-interface
21856           in: path
21857           description: String that identifies the interface
21858           required: true
21859           type: string
21860           example: __VLAN-INTERFACE__
21861   /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:
21862     put:
21863       tags:
21864         - Network
21865       summary: see node definition for valid relationships
21866       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21867       consumes:
21868         - application/json
21869         - application/xml
21870       produces:
21871         - application/json
21872         - application/xml
21873       responses:
21874         "default":
21875           description: Response codes found in [response codes](https://wiki.onap.org/).
21876       parameters:
21877         - name: equipment-name
21878           in: path
21879           required: true
21880           type: string
21881           example: __EQUIPMENT-NAME__
21882         - name: interface-name
21883           in: path
21884           description: Name that identifies the physical interface
21885           required: true
21886           type: string
21887           example: __INTERFACE-NAME__
21888         - name: interface-name
21889           in: path
21890           description: Name given to the interface
21891           required: true
21892           type: string
21893           example: __INTERFACE-NAME__
21894         - name: vlan-interface
21895           in: path
21896           description: String that identifies the interface
21897           required: true
21898           type: string
21899           example: __VLAN-INTERFACE__
21900         - name: l3-interface-ipv4-address
21901           in: path
21902           description: IP address
21903           required: true
21904           type: string
21905           example: __L3-INTERFACE-IPV4-ADDRESS__
21906         - name: body
21907           in: body
21908           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21909           required: true
21910           schema:
21911             $ref: "#/definitions/relationship"
21912     delete:
21913       tags:
21914         - Network
21915       summary: delete an existing relationship
21916       description: delete an existing relationship
21917       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21918       consumes:
21919         - application/json
21920         - application/xml
21921       produces:
21922         - application/json
21923         - application/xml
21924       responses:
21925         "default":
21926           description: Response codes found in [response codes](https://wiki.onap.org/).
21927       parameters:
21928         - name: equipment-name
21929           in: path
21930           required: true
21931           type: string
21932           example: __EQUIPMENT-NAME__
21933         - name: interface-name
21934           in: path
21935           description: Name that identifies the physical interface
21936           required: true
21937           type: string
21938           example: __INTERFACE-NAME__
21939         - name: interface-name
21940           in: path
21941           description: Name given to the interface
21942           required: true
21943           type: string
21944           example: __INTERFACE-NAME__
21945         - name: vlan-interface
21946           in: path
21947           description: String that identifies the interface
21948           required: true
21949           type: string
21950           example: __VLAN-INTERFACE__
21951         - name: l3-interface-ipv4-address
21952           in: path
21953           description: IP address
21954           required: true
21955           type: string
21956           example: __L3-INTERFACE-IPV4-ADDRESS__
21957   /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}:
21958     get:
21959       tags:
21960         - Network
21961       summary: returns l3-interface-ipv4-address-list
21962       description: returns l3-interface-ipv4-address-list
21963       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21964       produces:
21965         - application/json
21966         - application/xml
21967       responses:
21968         "200":
21969           description: successful operation
21970           schema:
21971               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21972         "default":
21973           description: Response codes found in [response codes](https://wiki.onap.org/).
21974       parameters:
21975         - name: equipment-name
21976           in: path
21977           required: true
21978           type: string
21979           example: __EQUIPMENT-NAME__
21980         - name: interface-name
21981           in: path
21982           description: Name that identifies the physical interface
21983           required: true
21984           type: string
21985           example: __INTERFACE-NAME__
21986         - name: interface-name
21987           in: path
21988           description: Name given to the interface
21989           required: true
21990           type: string
21991           example: __INTERFACE-NAME__
21992         - name: vlan-interface
21993           in: path
21994           description: String that identifies the interface
21995           required: true
21996           type: string
21997           example: __VLAN-INTERFACE__
21998         - name: l3-interface-ipv4-address
21999           in: path
22000           description: IP address
22001           required: true
22002           type: string
22003           example: __L3-INTERFACE-IPV4-ADDRESS__
22004     put:
22005       tags:
22006         - Network
22007       summary: create or update an existing l3-interface-ipv4-address-list
22008       description: |
22009         Create or update an existing l3-interface-ipv4-address-list.
22010         #
22011         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22012       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22013       consumes:
22014         - application/json
22015         - application/xml
22016       produces:
22017         - application/json
22018         - application/xml
22019       responses:
22020         "default":
22021           description: Response codes found in [response codes](https://wiki.onap.org/).
22022       parameters:
22023         - name: equipment-name
22024           in: path
22025           required: true
22026           type: string
22027           example: __EQUIPMENT-NAME__
22028         - name: interface-name
22029           in: path
22030           description: Name that identifies the physical interface
22031           required: true
22032           type: string
22033           example: __INTERFACE-NAME__
22034         - name: interface-name
22035           in: path
22036           description: Name given to the interface
22037           required: true
22038           type: string
22039           example: __INTERFACE-NAME__
22040         - name: vlan-interface
22041           in: path
22042           description: String that identifies the interface
22043           required: true
22044           type: string
22045           example: __VLAN-INTERFACE__
22046         - name: l3-interface-ipv4-address
22047           in: path
22048           description: IP address
22049           required: true
22050           type: string
22051           example: __L3-INTERFACE-IPV4-ADDRESS__
22052         - name: body
22053           in: body
22054           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22055           required: true
22056           schema:
22057             $ref: "#/definitions/l3-interface-ipv4-address-list"
22058     patch:
22059       tags:
22060         - Network
22061       summary: update an existing l3-interface-ipv4-address-list
22062       description: |
22063         Update an existing l3-interface-ipv4-address-list
22064         #
22065         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22066         The PUT operation will entirely replace an existing object.
22067         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22068         #
22069         Other differences between PUT and PATCH are:
22070         #
22071         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22072         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22073         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22074       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22075       consumes:
22076         - application/json
22077         - application/xml
22078       produces:
22079         - application/json
22080         - application/xml
22081       responses:
22082         "default":
22083           description: Response codes found in [response codes](https://wiki.onap.org/).
22084       parameters:
22085         - name: equipment-name
22086           in: path
22087           required: true
22088           type: string
22089           example: __EQUIPMENT-NAME__
22090         - name: interface-name
22091           in: path
22092           description: Name that identifies the physical interface
22093           required: true
22094           type: string
22095           example: __INTERFACE-NAME__
22096         - name: interface-name
22097           in: path
22098           description: Name given to the interface
22099           required: true
22100           type: string
22101           example: __INTERFACE-NAME__
22102         - name: vlan-interface
22103           in: path
22104           description: String that identifies the interface
22105           required: true
22106           type: string
22107           example: __VLAN-INTERFACE__
22108         - name: l3-interface-ipv4-address
22109           in: path
22110           description: IP address
22111           required: true
22112           type: string
22113           example: __L3-INTERFACE-IPV4-ADDRESS__
22114         - name: body
22115           in: body
22116           description: l3-interface-ipv4-address-list object that needs to be updated.
22117           required: true
22118           schema:
22119             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22120     delete:
22121       tags:
22122         - Network
22123       summary: delete an existing l3-interface-ipv4-address-list
22124       description: delete an existing l3-interface-ipv4-address-list
22125       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22126       consumes:
22127         - application/json
22128         - application/xml
22129       produces:
22130         - application/json
22131         - application/xml
22132       responses:
22133         "default":
22134           description: Response codes found in [response codes](https://wiki.onap.org/).
22135       parameters:
22136         - name: equipment-name
22137           in: path
22138           required: true
22139           type: string
22140           example: __EQUIPMENT-NAME__
22141         - name: interface-name
22142           in: path
22143           description: Name that identifies the physical interface
22144           required: true
22145           type: string
22146           example: __INTERFACE-NAME__
22147         - name: interface-name
22148           in: path
22149           description: Name given to the interface
22150           required: true
22151           type: string
22152           example: __INTERFACE-NAME__
22153         - name: vlan-interface
22154           in: path
22155           description: String that identifies the interface
22156           required: true
22157           type: string
22158           example: __VLAN-INTERFACE__
22159         - name: l3-interface-ipv4-address
22160           in: path
22161           description: IP address
22162           required: true
22163           type: string
22164           example: __L3-INTERFACE-IPV4-ADDRESS__
22165         - name: resource-version
22166           in: query
22167           description: resource-version for concurrency
22168           required: true
22169           type: string
22170   /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:
22171     put:
22172       tags:
22173         - Network
22174       summary: see node definition for valid relationships
22175       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22176       consumes:
22177         - application/json
22178         - application/xml
22179       produces:
22180         - application/json
22181         - application/xml
22182       responses:
22183         "default":
22184           description: Response codes found in [response codes](https://wiki.onap.org/).
22185       parameters:
22186         - name: equipment-name
22187           in: path
22188           required: true
22189           type: string
22190           example: __EQUIPMENT-NAME__
22191         - name: interface-name
22192           in: path
22193           description: Name that identifies the physical interface
22194           required: true
22195           type: string
22196           example: __INTERFACE-NAME__
22197         - name: interface-name
22198           in: path
22199           description: Name given to the interface
22200           required: true
22201           type: string
22202           example: __INTERFACE-NAME__
22203         - name: vlan-interface
22204           in: path
22205           description: String that identifies the interface
22206           required: true
22207           type: string
22208           example: __VLAN-INTERFACE__
22209         - name: l3-interface-ipv6-address
22210           in: path
22211           description: IP address
22212           required: true
22213           type: string
22214           example: __L3-INTERFACE-IPV6-ADDRESS__
22215         - name: body
22216           in: body
22217           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22218           required: true
22219           schema:
22220             $ref: "#/definitions/relationship"
22221     delete:
22222       tags:
22223         - Network
22224       summary: delete an existing relationship
22225       description: delete an existing relationship
22226       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22227       consumes:
22228         - application/json
22229         - application/xml
22230       produces:
22231         - application/json
22232         - application/xml
22233       responses:
22234         "default":
22235           description: Response codes found in [response codes](https://wiki.onap.org/).
22236       parameters:
22237         - name: equipment-name
22238           in: path
22239           required: true
22240           type: string
22241           example: __EQUIPMENT-NAME__
22242         - name: interface-name
22243           in: path
22244           description: Name that identifies the physical interface
22245           required: true
22246           type: string
22247           example: __INTERFACE-NAME__
22248         - name: interface-name
22249           in: path
22250           description: Name given to the interface
22251           required: true
22252           type: string
22253           example: __INTERFACE-NAME__
22254         - name: vlan-interface
22255           in: path
22256           description: String that identifies the interface
22257           required: true
22258           type: string
22259           example: __VLAN-INTERFACE__
22260         - name: l3-interface-ipv6-address
22261           in: path
22262           description: IP address
22263           required: true
22264           type: string
22265           example: __L3-INTERFACE-IPV6-ADDRESS__
22266   /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}:
22267     get:
22268       tags:
22269         - Network
22270       summary: returns l3-interface-ipv6-address-list
22271       description: returns l3-interface-ipv6-address-list
22272       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22273       produces:
22274         - application/json
22275         - application/xml
22276       responses:
22277         "200":
22278           description: successful operation
22279           schema:
22280               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22281         "default":
22282           description: Response codes found in [response codes](https://wiki.onap.org/).
22283       parameters:
22284         - name: equipment-name
22285           in: path
22286           required: true
22287           type: string
22288           example: __EQUIPMENT-NAME__
22289         - name: interface-name
22290           in: path
22291           description: Name that identifies the physical interface
22292           required: true
22293           type: string
22294           example: __INTERFACE-NAME__
22295         - name: interface-name
22296           in: path
22297           description: Name given to the interface
22298           required: true
22299           type: string
22300           example: __INTERFACE-NAME__
22301         - name: vlan-interface
22302           in: path
22303           description: String that identifies the interface
22304           required: true
22305           type: string
22306           example: __VLAN-INTERFACE__
22307         - name: l3-interface-ipv6-address
22308           in: path
22309           description: IP address
22310           required: true
22311           type: string
22312           example: __L3-INTERFACE-IPV6-ADDRESS__
22313     put:
22314       tags:
22315         - Network
22316       summary: create or update an existing l3-interface-ipv6-address-list
22317       description: |
22318         Create or update an existing l3-interface-ipv6-address-list.
22319         #
22320         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22321       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22322       consumes:
22323         - application/json
22324         - application/xml
22325       produces:
22326         - application/json
22327         - application/xml
22328       responses:
22329         "default":
22330           description: Response codes found in [response codes](https://wiki.onap.org/).
22331       parameters:
22332         - name: equipment-name
22333           in: path
22334           required: true
22335           type: string
22336           example: __EQUIPMENT-NAME__
22337         - name: interface-name
22338           in: path
22339           description: Name that identifies the physical interface
22340           required: true
22341           type: string
22342           example: __INTERFACE-NAME__
22343         - name: interface-name
22344           in: path
22345           description: Name given to the interface
22346           required: true
22347           type: string
22348           example: __INTERFACE-NAME__
22349         - name: vlan-interface
22350           in: path
22351           description: String that identifies the interface
22352           required: true
22353           type: string
22354           example: __VLAN-INTERFACE__
22355         - name: l3-interface-ipv6-address
22356           in: path
22357           description: IP address
22358           required: true
22359           type: string
22360           example: __L3-INTERFACE-IPV6-ADDRESS__
22361         - name: body
22362           in: body
22363           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22364           required: true
22365           schema:
22366             $ref: "#/definitions/l3-interface-ipv6-address-list"
22367     patch:
22368       tags:
22369         - Network
22370       summary: update an existing l3-interface-ipv6-address-list
22371       description: |
22372         Update an existing l3-interface-ipv6-address-list
22373         #
22374         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22375         The PUT operation will entirely replace an existing object.
22376         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22377         #
22378         Other differences between PUT and PATCH are:
22379         #
22380         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22381         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22382         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22383       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22384       consumes:
22385         - application/json
22386         - application/xml
22387       produces:
22388         - application/json
22389         - application/xml
22390       responses:
22391         "default":
22392           description: Response codes found in [response codes](https://wiki.onap.org/).
22393       parameters:
22394         - name: equipment-name
22395           in: path
22396           required: true
22397           type: string
22398           example: __EQUIPMENT-NAME__
22399         - name: interface-name
22400           in: path
22401           description: Name that identifies the physical interface
22402           required: true
22403           type: string
22404           example: __INTERFACE-NAME__
22405         - name: interface-name
22406           in: path
22407           description: Name given to the interface
22408           required: true
22409           type: string
22410           example: __INTERFACE-NAME__
22411         - name: vlan-interface
22412           in: path
22413           description: String that identifies the interface
22414           required: true
22415           type: string
22416           example: __VLAN-INTERFACE__
22417         - name: l3-interface-ipv6-address
22418           in: path
22419           description: IP address
22420           required: true
22421           type: string
22422           example: __L3-INTERFACE-IPV6-ADDRESS__
22423         - name: body
22424           in: body
22425           description: l3-interface-ipv6-address-list object that needs to be updated.
22426           required: true
22427           schema:
22428             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22429     delete:
22430       tags:
22431         - Network
22432       summary: delete an existing l3-interface-ipv6-address-list
22433       description: delete an existing l3-interface-ipv6-address-list
22434       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22435       consumes:
22436         - application/json
22437         - application/xml
22438       produces:
22439         - application/json
22440         - application/xml
22441       responses:
22442         "default":
22443           description: Response codes found in [response codes](https://wiki.onap.org/).
22444       parameters:
22445         - name: equipment-name
22446           in: path
22447           required: true
22448           type: string
22449           example: __EQUIPMENT-NAME__
22450         - name: interface-name
22451           in: path
22452           description: Name that identifies the physical interface
22453           required: true
22454           type: string
22455           example: __INTERFACE-NAME__
22456         - name: interface-name
22457           in: path
22458           description: Name given to the interface
22459           required: true
22460           type: string
22461           example: __INTERFACE-NAME__
22462         - name: vlan-interface
22463           in: path
22464           description: String that identifies the interface
22465           required: true
22466           type: string
22467           example: __VLAN-INTERFACE__
22468         - name: l3-interface-ipv6-address
22469           in: path
22470           description: IP address
22471           required: true
22472           type: string
22473           example: __L3-INTERFACE-IPV6-ADDRESS__
22474         - name: resource-version
22475           in: query
22476           description: resource-version for concurrency
22477           required: true
22478           type: string
22479   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22480     get:
22481       tags:
22482         - Network
22483       summary: returns vlan
22484       description: returns vlan
22485       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22486       produces:
22487         - application/json
22488         - application/xml
22489       responses:
22490         "200":
22491           description: successful operation
22492           schema:
22493               $ref: "#/getDefinitions/vlan"
22494         "default":
22495           description: Response codes found in [response codes](https://wiki.onap.org/).
22496       parameters:
22497         - name: equipment-name
22498           in: path
22499           required: true
22500           type: string
22501           example: __EQUIPMENT-NAME__
22502         - name: interface-name
22503           in: path
22504           description: Name that identifies the physical interface
22505           required: true
22506           type: string
22507           example: __INTERFACE-NAME__
22508         - name: interface-name
22509           in: path
22510           description: Name given to the interface
22511           required: true
22512           type: string
22513           example: __INTERFACE-NAME__
22514         - name: vlan-interface
22515           in: path
22516           description: String that identifies the interface
22517           required: true
22518           type: string
22519           example: __VLAN-INTERFACE__
22520     put:
22521       tags:
22522         - Network
22523       summary: create or update an existing vlan
22524       description: |
22525         Create or update an existing vlan.
22526         #
22527         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22528       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22529       consumes:
22530         - application/json
22531         - application/xml
22532       produces:
22533         - application/json
22534         - application/xml
22535       responses:
22536         "default":
22537           description: Response codes found in [response codes](https://wiki.onap.org/).
22538       parameters:
22539         - name: equipment-name
22540           in: path
22541           required: true
22542           type: string
22543           example: __EQUIPMENT-NAME__
22544         - name: interface-name
22545           in: path
22546           description: Name that identifies the physical interface
22547           required: true
22548           type: string
22549           example: __INTERFACE-NAME__
22550         - name: interface-name
22551           in: path
22552           description: Name given to the interface
22553           required: true
22554           type: string
22555           example: __INTERFACE-NAME__
22556         - name: vlan-interface
22557           in: path
22558           description: String that identifies the interface
22559           required: true
22560           type: string
22561           example: __VLAN-INTERFACE__
22562         - name: body
22563           in: body
22564           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22565           required: true
22566           schema:
22567             $ref: "#/definitions/vlan"
22568     patch:
22569       tags:
22570         - Network
22571       summary: update an existing vlan
22572       description: |
22573         Update an existing vlan
22574         #
22575         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22576         The PUT operation will entirely replace an existing object.
22577         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22578         #
22579         Other differences between PUT and PATCH are:
22580         #
22581         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22582         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22583         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22584       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22585       consumes:
22586         - application/json
22587         - application/xml
22588       produces:
22589         - application/json
22590         - application/xml
22591       responses:
22592         "default":
22593           description: Response codes found in [response codes](https://wiki.onap.org/).
22594       parameters:
22595         - name: equipment-name
22596           in: path
22597           required: true
22598           type: string
22599           example: __EQUIPMENT-NAME__
22600         - name: interface-name
22601           in: path
22602           description: Name that identifies the physical interface
22603           required: true
22604           type: string
22605           example: __INTERFACE-NAME__
22606         - name: interface-name
22607           in: path
22608           description: Name given to the interface
22609           required: true
22610           type: string
22611           example: __INTERFACE-NAME__
22612         - name: vlan-interface
22613           in: path
22614           description: String that identifies the interface
22615           required: true
22616           type: string
22617           example: __VLAN-INTERFACE__
22618         - name: body
22619           in: body
22620           description: vlan object that needs to be updated.
22621           required: true
22622           schema:
22623             $ref: "#/patchDefinitions/vlan"
22624     delete:
22625       tags:
22626         - Network
22627       summary: delete an existing vlan
22628       description: delete an existing vlan
22629       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22630       consumes:
22631         - application/json
22632         - application/xml
22633       produces:
22634         - application/json
22635         - application/xml
22636       responses:
22637         "default":
22638           description: Response codes found in [response codes](https://wiki.onap.org/).
22639       parameters:
22640         - name: equipment-name
22641           in: path
22642           required: true
22643           type: string
22644           example: __EQUIPMENT-NAME__
22645         - name: interface-name
22646           in: path
22647           description: Name that identifies the physical interface
22648           required: true
22649           type: string
22650           example: __INTERFACE-NAME__
22651         - name: interface-name
22652           in: path
22653           description: Name given to the interface
22654           required: true
22655           type: string
22656           example: __INTERFACE-NAME__
22657         - name: vlan-interface
22658           in: path
22659           description: String that identifies the interface
22660           required: true
22661           type: string
22662           example: __VLAN-INTERFACE__
22663         - name: resource-version
22664           in: query
22665           description: resource-version for concurrency
22666           required: true
22667           type: string
22668   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22669     get:
22670       tags:
22671         - Network
22672       summary: returns vlans
22673       description: returns vlans
22674       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22675       produces:
22676         - application/json
22677         - application/xml
22678       responses:
22679         "200":
22680           description: successful operation
22681           schema:
22682               $ref: "#/getDefinitions/vlans"
22683         "default":
22684           description: Response codes found in [response codes](https://wiki.onap.org/).
22685       parameters:
22686         - name: equipment-name
22687           in: path
22688           required: true
22689           type: string
22690           example: __EQUIPMENT-NAME__
22691         - name: interface-name
22692           in: path
22693           description: Name that identifies the physical interface
22694           required: true
22695           type: string
22696           example: __INTERFACE-NAME__
22697         - name: interface-name
22698           in: path
22699           description: Name given to the interface
22700           required: true
22701           type: string
22702           example: __INTERFACE-NAME__
22703         - name: vlan-interface
22704           in: query
22705           description:
22706           required: false
22707           type: string
22708         - name: vlan-id-inner
22709           in: query
22710           description:
22711           required: false
22712           type: integer
22713           format: int64
22714         - name: vpn-key
22715           in: query
22716           description:
22717           required: false
22718           type: string
22719   /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:
22720     put:
22721       tags:
22722         - Network
22723       summary: see node definition for valid relationships
22724       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22725       consumes:
22726         - application/json
22727         - application/xml
22728       produces:
22729         - application/json
22730         - application/xml
22731       responses:
22732         "default":
22733           description: Response codes found in [response codes](https://wiki.onap.org/).
22734       parameters:
22735         - name: equipment-name
22736           in: path
22737           required: true
22738           type: string
22739           example: __EQUIPMENT-NAME__
22740         - name: interface-name
22741           in: path
22742           description: Name that identifies the physical interface
22743           required: true
22744           type: string
22745           example: __INTERFACE-NAME__
22746         - name: interface-name
22747           in: path
22748           description: Name given to the interface
22749           required: true
22750           type: string
22751           example: __INTERFACE-NAME__
22752         - name: pci-id
22753           in: path
22754           description: PCI ID used to identify the sriov-vf
22755           required: true
22756           type: string
22757           example: __PCI-ID__
22758         - name: body
22759           in: body
22760           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22761           required: true
22762           schema:
22763             $ref: "#/definitions/relationship"
22764     delete:
22765       tags:
22766         - Network
22767       summary: delete an existing relationship
22768       description: delete an existing relationship
22769       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22770       consumes:
22771         - application/json
22772         - application/xml
22773       produces:
22774         - application/json
22775         - application/xml
22776       responses:
22777         "default":
22778           description: Response codes found in [response codes](https://wiki.onap.org/).
22779       parameters:
22780         - name: equipment-name
22781           in: path
22782           required: true
22783           type: string
22784           example: __EQUIPMENT-NAME__
22785         - name: interface-name
22786           in: path
22787           description: Name that identifies the physical interface
22788           required: true
22789           type: string
22790           example: __INTERFACE-NAME__
22791         - name: interface-name
22792           in: path
22793           description: Name given to the interface
22794           required: true
22795           type: string
22796           example: __INTERFACE-NAME__
22797         - name: pci-id
22798           in: path
22799           description: PCI ID used to identify the sriov-vf
22800           required: true
22801           type: string
22802           example: __PCI-ID__
22803   /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}:
22804     get:
22805       tags:
22806         - Network
22807       summary: returns sriov-vf
22808       description: returns sriov-vf
22809       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22810       produces:
22811         - application/json
22812         - application/xml
22813       responses:
22814         "200":
22815           description: successful operation
22816           schema:
22817               $ref: "#/getDefinitions/sriov-vf"
22818         "default":
22819           description: Response codes found in [response codes](https://wiki.onap.org/).
22820       parameters:
22821         - name: equipment-name
22822           in: path
22823           required: true
22824           type: string
22825           example: __EQUIPMENT-NAME__
22826         - name: interface-name
22827           in: path
22828           description: Name that identifies the physical interface
22829           required: true
22830           type: string
22831           example: __INTERFACE-NAME__
22832         - name: interface-name
22833           in: path
22834           description: Name given to the interface
22835           required: true
22836           type: string
22837           example: __INTERFACE-NAME__
22838         - name: pci-id
22839           in: path
22840           description: PCI ID used to identify the sriov-vf
22841           required: true
22842           type: string
22843           example: __PCI-ID__
22844     put:
22845       tags:
22846         - Network
22847       summary: create or update an existing sriov-vf
22848       description: |
22849         Create or update an existing sriov-vf.
22850         #
22851         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22852       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22853       consumes:
22854         - application/json
22855         - application/xml
22856       produces:
22857         - application/json
22858         - application/xml
22859       responses:
22860         "default":
22861           description: Response codes found in [response codes](https://wiki.onap.org/).
22862       parameters:
22863         - name: equipment-name
22864           in: path
22865           required: true
22866           type: string
22867           example: __EQUIPMENT-NAME__
22868         - name: interface-name
22869           in: path
22870           description: Name that identifies the physical interface
22871           required: true
22872           type: string
22873           example: __INTERFACE-NAME__
22874         - name: interface-name
22875           in: path
22876           description: Name given to the interface
22877           required: true
22878           type: string
22879           example: __INTERFACE-NAME__
22880         - name: pci-id
22881           in: path
22882           description: PCI ID used to identify the sriov-vf
22883           required: true
22884           type: string
22885           example: __PCI-ID__
22886         - name: body
22887           in: body
22888           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22889           required: true
22890           schema:
22891             $ref: "#/definitions/sriov-vf"
22892     patch:
22893       tags:
22894         - Network
22895       summary: update an existing sriov-vf
22896       description: |
22897         Update an existing sriov-vf
22898         #
22899         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22900         The PUT operation will entirely replace an existing object.
22901         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22902         #
22903         Other differences between PUT and PATCH are:
22904         #
22905         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22906         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22907         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22908       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22909       consumes:
22910         - application/json
22911         - application/xml
22912       produces:
22913         - application/json
22914         - application/xml
22915       responses:
22916         "default":
22917           description: Response codes found in [response codes](https://wiki.onap.org/).
22918       parameters:
22919         - name: equipment-name
22920           in: path
22921           required: true
22922           type: string
22923           example: __EQUIPMENT-NAME__
22924         - name: interface-name
22925           in: path
22926           description: Name that identifies the physical interface
22927           required: true
22928           type: string
22929           example: __INTERFACE-NAME__
22930         - name: interface-name
22931           in: path
22932           description: Name given to the interface
22933           required: true
22934           type: string
22935           example: __INTERFACE-NAME__
22936         - name: pci-id
22937           in: path
22938           description: PCI ID used to identify the sriov-vf
22939           required: true
22940           type: string
22941           example: __PCI-ID__
22942         - name: body
22943           in: body
22944           description: sriov-vf object that needs to be updated.
22945           required: true
22946           schema:
22947             $ref: "#/patchDefinitions/sriov-vf"
22948     delete:
22949       tags:
22950         - Network
22951       summary: delete an existing sriov-vf
22952       description: delete an existing sriov-vf
22953       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22954       consumes:
22955         - application/json
22956         - application/xml
22957       produces:
22958         - application/json
22959         - application/xml
22960       responses:
22961         "default":
22962           description: Response codes found in [response codes](https://wiki.onap.org/).
22963       parameters:
22964         - name: equipment-name
22965           in: path
22966           required: true
22967           type: string
22968           example: __EQUIPMENT-NAME__
22969         - name: interface-name
22970           in: path
22971           description: Name that identifies the physical interface
22972           required: true
22973           type: string
22974           example: __INTERFACE-NAME__
22975         - name: interface-name
22976           in: path
22977           description: Name given to the interface
22978           required: true
22979           type: string
22980           example: __INTERFACE-NAME__
22981         - name: pci-id
22982           in: path
22983           description: PCI ID used to identify the sriov-vf
22984           required: true
22985           type: string
22986           example: __PCI-ID__
22987         - name: resource-version
22988           in: query
22989           description: resource-version for concurrency
22990           required: true
22991           type: string
22992   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
22993     get:
22994       tags:
22995         - Network
22996       summary: returns sriov-vfs
22997       description: returns sriov-vfs
22998       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
22999       produces:
23000         - application/json
23001         - application/xml
23002       responses:
23003         "200":
23004           description: successful operation
23005           schema:
23006               $ref: "#/getDefinitions/sriov-vfs"
23007         "default":
23008           description: Response codes found in [response codes](https://wiki.onap.org/).
23009       parameters:
23010         - name: equipment-name
23011           in: path
23012           required: true
23013           type: string
23014           example: __EQUIPMENT-NAME__
23015         - name: interface-name
23016           in: path
23017           description: Name that identifies the physical interface
23018           required: true
23019           type: string
23020           example: __INTERFACE-NAME__
23021         - name: interface-name
23022           in: path
23023           description: Name given to the interface
23024           required: true
23025           type: string
23026           example: __INTERFACE-NAME__
23027         - name: pci-id
23028           in: query
23029           description:
23030           required: false
23031           type: string
23032         - name: vf-vlan-filter
23033           in: query
23034           description:
23035           required: false
23036           type: string
23037         - name: vf-mac-filter
23038           in: query
23039           description:
23040           required: false
23041           type: string
23042         - name: vf-vlan-strip
23043           in: query
23044           description:
23045           required: false
23046           type: boolean
23047         - name: neutron-network-id
23048           in: query
23049           description:
23050           required: false
23051           type: string
23052   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23053     put:
23054       tags:
23055         - Network
23056       summary: see node definition for valid relationships
23057       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23058       consumes:
23059         - application/json
23060         - application/xml
23061       produces:
23062         - application/json
23063         - application/xml
23064       responses:
23065         "default":
23066           description: Response codes found in [response codes](https://wiki.onap.org/).
23067       parameters:
23068         - name: equipment-name
23069           in: path
23070           required: true
23071           type: string
23072           example: __EQUIPMENT-NAME__
23073         - name: interface-name
23074           in: path
23075           description: Name that identifies the physical interface
23076           required: true
23077           type: string
23078           example: __INTERFACE-NAME__
23079         - name: interface-name
23080           in: path
23081           description: Name given to the interface
23082           required: true
23083           type: string
23084           example: __INTERFACE-NAME__
23085         - name: body
23086           in: body
23087           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23088           required: true
23089           schema:
23090             $ref: "#/definitions/relationship"
23091     delete:
23092       tags:
23093         - Network
23094       summary: delete an existing relationship
23095       description: delete an existing relationship
23096       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23097       consumes:
23098         - application/json
23099         - application/xml
23100       produces:
23101         - application/json
23102         - application/xml
23103       responses:
23104         "default":
23105           description: Response codes found in [response codes](https://wiki.onap.org/).
23106       parameters:
23107         - name: equipment-name
23108           in: path
23109           required: true
23110           type: string
23111           example: __EQUIPMENT-NAME__
23112         - name: interface-name
23113           in: path
23114           description: Name that identifies the physical interface
23115           required: true
23116           type: string
23117           example: __INTERFACE-NAME__
23118         - name: interface-name
23119           in: path
23120           description: Name given to the interface
23121           required: true
23122           type: string
23123           example: __INTERFACE-NAME__
23124   /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:
23125     put:
23126       tags:
23127         - Network
23128       summary: see node definition for valid relationships
23129       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23130       consumes:
23131         - application/json
23132         - application/xml
23133       produces:
23134         - application/json
23135         - application/xml
23136       responses:
23137         "default":
23138           description: Response codes found in [response codes](https://wiki.onap.org/).
23139       parameters:
23140         - name: equipment-name
23141           in: path
23142           required: true
23143           type: string
23144           example: __EQUIPMENT-NAME__
23145         - name: interface-name
23146           in: path
23147           description: Name that identifies the physical interface
23148           required: true
23149           type: string
23150           example: __INTERFACE-NAME__
23151         - name: interface-name
23152           in: path
23153           description: Name given to the interface
23154           required: true
23155           type: string
23156           example: __INTERFACE-NAME__
23157         - name: l3-interface-ipv4-address
23158           in: path
23159           description: IP address
23160           required: true
23161           type: string
23162           example: __L3-INTERFACE-IPV4-ADDRESS__
23163         - name: body
23164           in: body
23165           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23166           required: true
23167           schema:
23168             $ref: "#/definitions/relationship"
23169     delete:
23170       tags:
23171         - Network
23172       summary: delete an existing relationship
23173       description: delete an existing relationship
23174       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23175       consumes:
23176         - application/json
23177         - application/xml
23178       produces:
23179         - application/json
23180         - application/xml
23181       responses:
23182         "default":
23183           description: Response codes found in [response codes](https://wiki.onap.org/).
23184       parameters:
23185         - name: equipment-name
23186           in: path
23187           required: true
23188           type: string
23189           example: __EQUIPMENT-NAME__
23190         - name: interface-name
23191           in: path
23192           description: Name that identifies the physical interface
23193           required: true
23194           type: string
23195           example: __INTERFACE-NAME__
23196         - name: interface-name
23197           in: path
23198           description: Name given to the interface
23199           required: true
23200           type: string
23201           example: __INTERFACE-NAME__
23202         - name: l3-interface-ipv4-address
23203           in: path
23204           description: IP address
23205           required: true
23206           type: string
23207           example: __L3-INTERFACE-IPV4-ADDRESS__
23208   /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}:
23209     get:
23210       tags:
23211         - Network
23212       summary: returns l3-interface-ipv4-address-list
23213       description: returns l3-interface-ipv4-address-list
23214       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23215       produces:
23216         - application/json
23217         - application/xml
23218       responses:
23219         "200":
23220           description: successful operation
23221           schema:
23222               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23223         "default":
23224           description: Response codes found in [response codes](https://wiki.onap.org/).
23225       parameters:
23226         - name: equipment-name
23227           in: path
23228           required: true
23229           type: string
23230           example: __EQUIPMENT-NAME__
23231         - name: interface-name
23232           in: path
23233           description: Name that identifies the physical interface
23234           required: true
23235           type: string
23236           example: __INTERFACE-NAME__
23237         - name: interface-name
23238           in: path
23239           description: Name given to the interface
23240           required: true
23241           type: string
23242           example: __INTERFACE-NAME__
23243         - name: l3-interface-ipv4-address
23244           in: path
23245           description: IP address
23246           required: true
23247           type: string
23248           example: __L3-INTERFACE-IPV4-ADDRESS__
23249     put:
23250       tags:
23251         - Network
23252       summary: create or update an existing l3-interface-ipv4-address-list
23253       description: |
23254         Create or update an existing l3-interface-ipv4-address-list.
23255         #
23256         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23257       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23258       consumes:
23259         - application/json
23260         - application/xml
23261       produces:
23262         - application/json
23263         - application/xml
23264       responses:
23265         "default":
23266           description: Response codes found in [response codes](https://wiki.onap.org/).
23267       parameters:
23268         - name: equipment-name
23269           in: path
23270           required: true
23271           type: string
23272           example: __EQUIPMENT-NAME__
23273         - name: interface-name
23274           in: path
23275           description: Name that identifies the physical interface
23276           required: true
23277           type: string
23278           example: __INTERFACE-NAME__
23279         - name: interface-name
23280           in: path
23281           description: Name given to the interface
23282           required: true
23283           type: string
23284           example: __INTERFACE-NAME__
23285         - name: l3-interface-ipv4-address
23286           in: path
23287           description: IP address
23288           required: true
23289           type: string
23290           example: __L3-INTERFACE-IPV4-ADDRESS__
23291         - name: body
23292           in: body
23293           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23294           required: true
23295           schema:
23296             $ref: "#/definitions/l3-interface-ipv4-address-list"
23297     patch:
23298       tags:
23299         - Network
23300       summary: update an existing l3-interface-ipv4-address-list
23301       description: |
23302         Update an existing l3-interface-ipv4-address-list
23303         #
23304         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23305         The PUT operation will entirely replace an existing object.
23306         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23307         #
23308         Other differences between PUT and PATCH are:
23309         #
23310         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23311         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23312         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23313       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23314       consumes:
23315         - application/json
23316         - application/xml
23317       produces:
23318         - application/json
23319         - application/xml
23320       responses:
23321         "default":
23322           description: Response codes found in [response codes](https://wiki.onap.org/).
23323       parameters:
23324         - name: equipment-name
23325           in: path
23326           required: true
23327           type: string
23328           example: __EQUIPMENT-NAME__
23329         - name: interface-name
23330           in: path
23331           description: Name that identifies the physical interface
23332           required: true
23333           type: string
23334           example: __INTERFACE-NAME__
23335         - name: interface-name
23336           in: path
23337           description: Name given to the interface
23338           required: true
23339           type: string
23340           example: __INTERFACE-NAME__
23341         - name: l3-interface-ipv4-address
23342           in: path
23343           description: IP address
23344           required: true
23345           type: string
23346           example: __L3-INTERFACE-IPV4-ADDRESS__
23347         - name: body
23348           in: body
23349           description: l3-interface-ipv4-address-list object that needs to be updated.
23350           required: true
23351           schema:
23352             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23353     delete:
23354       tags:
23355         - Network
23356       summary: delete an existing l3-interface-ipv4-address-list
23357       description: delete an existing l3-interface-ipv4-address-list
23358       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23359       consumes:
23360         - application/json
23361         - application/xml
23362       produces:
23363         - application/json
23364         - application/xml
23365       responses:
23366         "default":
23367           description: Response codes found in [response codes](https://wiki.onap.org/).
23368       parameters:
23369         - name: equipment-name
23370           in: path
23371           required: true
23372           type: string
23373           example: __EQUIPMENT-NAME__
23374         - name: interface-name
23375           in: path
23376           description: Name that identifies the physical interface
23377           required: true
23378           type: string
23379           example: __INTERFACE-NAME__
23380         - name: interface-name
23381           in: path
23382           description: Name given to the interface
23383           required: true
23384           type: string
23385           example: __INTERFACE-NAME__
23386         - name: l3-interface-ipv4-address
23387           in: path
23388           description: IP address
23389           required: true
23390           type: string
23391           example: __L3-INTERFACE-IPV4-ADDRESS__
23392         - name: resource-version
23393           in: query
23394           description: resource-version for concurrency
23395           required: true
23396           type: string
23397   /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:
23398     put:
23399       tags:
23400         - Network
23401       summary: see node definition for valid relationships
23402       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23403       consumes:
23404         - application/json
23405         - application/xml
23406       produces:
23407         - application/json
23408         - application/xml
23409       responses:
23410         "default":
23411           description: Response codes found in [response codes](https://wiki.onap.org/).
23412       parameters:
23413         - name: equipment-name
23414           in: path
23415           required: true
23416           type: string
23417           example: __EQUIPMENT-NAME__
23418         - name: interface-name
23419           in: path
23420           description: Name that identifies the physical interface
23421           required: true
23422           type: string
23423           example: __INTERFACE-NAME__
23424         - name: interface-name
23425           in: path
23426           description: Name given to the interface
23427           required: true
23428           type: string
23429           example: __INTERFACE-NAME__
23430         - name: l3-interface-ipv6-address
23431           in: path
23432           description: IP address
23433           required: true
23434           type: string
23435           example: __L3-INTERFACE-IPV6-ADDRESS__
23436         - name: body
23437           in: body
23438           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23439           required: true
23440           schema:
23441             $ref: "#/definitions/relationship"
23442     delete:
23443       tags:
23444         - Network
23445       summary: delete an existing relationship
23446       description: delete an existing relationship
23447       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23448       consumes:
23449         - application/json
23450         - application/xml
23451       produces:
23452         - application/json
23453         - application/xml
23454       responses:
23455         "default":
23456           description: Response codes found in [response codes](https://wiki.onap.org/).
23457       parameters:
23458         - name: equipment-name
23459           in: path
23460           required: true
23461           type: string
23462           example: __EQUIPMENT-NAME__
23463         - name: interface-name
23464           in: path
23465           description: Name that identifies the physical interface
23466           required: true
23467           type: string
23468           example: __INTERFACE-NAME__
23469         - name: interface-name
23470           in: path
23471           description: Name given to the interface
23472           required: true
23473           type: string
23474           example: __INTERFACE-NAME__
23475         - name: l3-interface-ipv6-address
23476           in: path
23477           description: IP address
23478           required: true
23479           type: string
23480           example: __L3-INTERFACE-IPV6-ADDRESS__
23481   /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}:
23482     get:
23483       tags:
23484         - Network
23485       summary: returns l3-interface-ipv6-address-list
23486       description: returns l3-interface-ipv6-address-list
23487       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23488       produces:
23489         - application/json
23490         - application/xml
23491       responses:
23492         "200":
23493           description: successful operation
23494           schema:
23495               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23496         "default":
23497           description: Response codes found in [response codes](https://wiki.onap.org/).
23498       parameters:
23499         - name: equipment-name
23500           in: path
23501           required: true
23502           type: string
23503           example: __EQUIPMENT-NAME__
23504         - name: interface-name
23505           in: path
23506           description: Name that identifies the physical interface
23507           required: true
23508           type: string
23509           example: __INTERFACE-NAME__
23510         - name: interface-name
23511           in: path
23512           description: Name given to the interface
23513           required: true
23514           type: string
23515           example: __INTERFACE-NAME__
23516         - name: l3-interface-ipv6-address
23517           in: path
23518           description: IP address
23519           required: true
23520           type: string
23521           example: __L3-INTERFACE-IPV6-ADDRESS__
23522     put:
23523       tags:
23524         - Network
23525       summary: create or update an existing l3-interface-ipv6-address-list
23526       description: |
23527         Create or update an existing l3-interface-ipv6-address-list.
23528         #
23529         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23530       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23531       consumes:
23532         - application/json
23533         - application/xml
23534       produces:
23535         - application/json
23536         - application/xml
23537       responses:
23538         "default":
23539           description: Response codes found in [response codes](https://wiki.onap.org/).
23540       parameters:
23541         - name: equipment-name
23542           in: path
23543           required: true
23544           type: string
23545           example: __EQUIPMENT-NAME__
23546         - name: interface-name
23547           in: path
23548           description: Name that identifies the physical interface
23549           required: true
23550           type: string
23551           example: __INTERFACE-NAME__
23552         - name: interface-name
23553           in: path
23554           description: Name given to the interface
23555           required: true
23556           type: string
23557           example: __INTERFACE-NAME__
23558         - name: l3-interface-ipv6-address
23559           in: path
23560           description: IP address
23561           required: true
23562           type: string
23563           example: __L3-INTERFACE-IPV6-ADDRESS__
23564         - name: body
23565           in: body
23566           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23567           required: true
23568           schema:
23569             $ref: "#/definitions/l3-interface-ipv6-address-list"
23570     patch:
23571       tags:
23572         - Network
23573       summary: update an existing l3-interface-ipv6-address-list
23574       description: |
23575         Update an existing l3-interface-ipv6-address-list
23576         #
23577         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23578         The PUT operation will entirely replace an existing object.
23579         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23580         #
23581         Other differences between PUT and PATCH are:
23582         #
23583         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23584         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23585         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23586       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23587       consumes:
23588         - application/json
23589         - application/xml
23590       produces:
23591         - application/json
23592         - application/xml
23593       responses:
23594         "default":
23595           description: Response codes found in [response codes](https://wiki.onap.org/).
23596       parameters:
23597         - name: equipment-name
23598           in: path
23599           required: true
23600           type: string
23601           example: __EQUIPMENT-NAME__
23602         - name: interface-name
23603           in: path
23604           description: Name that identifies the physical interface
23605           required: true
23606           type: string
23607           example: __INTERFACE-NAME__
23608         - name: interface-name
23609           in: path
23610           description: Name given to the interface
23611           required: true
23612           type: string
23613           example: __INTERFACE-NAME__
23614         - name: l3-interface-ipv6-address
23615           in: path
23616           description: IP address
23617           required: true
23618           type: string
23619           example: __L3-INTERFACE-IPV6-ADDRESS__
23620         - name: body
23621           in: body
23622           description: l3-interface-ipv6-address-list object that needs to be updated.
23623           required: true
23624           schema:
23625             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23626     delete:
23627       tags:
23628         - Network
23629       summary: delete an existing l3-interface-ipv6-address-list
23630       description: delete an existing l3-interface-ipv6-address-list
23631       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23632       consumes:
23633         - application/json
23634         - application/xml
23635       produces:
23636         - application/json
23637         - application/xml
23638       responses:
23639         "default":
23640           description: Response codes found in [response codes](https://wiki.onap.org/).
23641       parameters:
23642         - name: equipment-name
23643           in: path
23644           required: true
23645           type: string
23646           example: __EQUIPMENT-NAME__
23647         - name: interface-name
23648           in: path
23649           description: Name that identifies the physical interface
23650           required: true
23651           type: string
23652           example: __INTERFACE-NAME__
23653         - name: interface-name
23654           in: path
23655           description: Name given to the interface
23656           required: true
23657           type: string
23658           example: __INTERFACE-NAME__
23659         - name: l3-interface-ipv6-address
23660           in: path
23661           description: IP address
23662           required: true
23663           type: string
23664           example: __L3-INTERFACE-IPV6-ADDRESS__
23665         - name: resource-version
23666           in: query
23667           description: resource-version for concurrency
23668           required: true
23669           type: string
23670   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23671     get:
23672       tags:
23673         - Network
23674       summary: returns l-interface
23675       description: returns l-interface
23676       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23677       produces:
23678         - application/json
23679         - application/xml
23680       responses:
23681         "200":
23682           description: successful operation
23683           schema:
23684               $ref: "#/getDefinitions/l-interface"
23685         "default":
23686           description: Response codes found in [response codes](https://wiki.onap.org/).
23687       parameters:
23688         - name: equipment-name
23689           in: path
23690           required: true
23691           type: string
23692           example: __EQUIPMENT-NAME__
23693         - name: interface-name
23694           in: path
23695           description: Name that identifies the physical interface
23696           required: true
23697           type: string
23698           example: __INTERFACE-NAME__
23699         - name: interface-name
23700           in: path
23701           description: Name given to the interface
23702           required: true
23703           type: string
23704           example: __INTERFACE-NAME__
23705     put:
23706       tags:
23707         - Network
23708       summary: create or update an existing l-interface
23709       description: |
23710         Create or update an existing l-interface.
23711         #
23712         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23713       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23714       consumes:
23715         - application/json
23716         - application/xml
23717       produces:
23718         - application/json
23719         - application/xml
23720       responses:
23721         "default":
23722           description: Response codes found in [response codes](https://wiki.onap.org/).
23723       parameters:
23724         - name: equipment-name
23725           in: path
23726           required: true
23727           type: string
23728           example: __EQUIPMENT-NAME__
23729         - name: interface-name
23730           in: path
23731           description: Name that identifies the physical interface
23732           required: true
23733           type: string
23734           example: __INTERFACE-NAME__
23735         - name: interface-name
23736           in: path
23737           description: Name given to the interface
23738           required: true
23739           type: string
23740           example: __INTERFACE-NAME__
23741         - name: body
23742           in: body
23743           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23744           required: true
23745           schema:
23746             $ref: "#/definitions/l-interface"
23747     patch:
23748       tags:
23749         - Network
23750       summary: update an existing l-interface
23751       description: |
23752         Update an existing l-interface
23753         #
23754         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23755         The PUT operation will entirely replace an existing object.
23756         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23757         #
23758         Other differences between PUT and PATCH are:
23759         #
23760         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23761         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23762         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23763       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23764       consumes:
23765         - application/json
23766         - application/xml
23767       produces:
23768         - application/json
23769         - application/xml
23770       responses:
23771         "default":
23772           description: Response codes found in [response codes](https://wiki.onap.org/).
23773       parameters:
23774         - name: equipment-name
23775           in: path
23776           required: true
23777           type: string
23778           example: __EQUIPMENT-NAME__
23779         - name: interface-name
23780           in: path
23781           description: Name that identifies the physical interface
23782           required: true
23783           type: string
23784           example: __INTERFACE-NAME__
23785         - name: interface-name
23786           in: path
23787           description: Name given to the interface
23788           required: true
23789           type: string
23790           example: __INTERFACE-NAME__
23791         - name: body
23792           in: body
23793           description: l-interface object that needs to be updated.
23794           required: true
23795           schema:
23796             $ref: "#/patchDefinitions/l-interface"
23797     delete:
23798       tags:
23799         - Network
23800       summary: delete an existing l-interface
23801       description: delete an existing l-interface
23802       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23803       consumes:
23804         - application/json
23805         - application/xml
23806       produces:
23807         - application/json
23808         - application/xml
23809       responses:
23810         "default":
23811           description: Response codes found in [response codes](https://wiki.onap.org/).
23812       parameters:
23813         - name: equipment-name
23814           in: path
23815           required: true
23816           type: string
23817           example: __EQUIPMENT-NAME__
23818         - name: interface-name
23819           in: path
23820           description: Name that identifies the physical interface
23821           required: true
23822           type: string
23823           example: __INTERFACE-NAME__
23824         - name: interface-name
23825           in: path
23826           description: Name given to the interface
23827           required: true
23828           type: string
23829           example: __INTERFACE-NAME__
23830         - name: resource-version
23831           in: query
23832           description: resource-version for concurrency
23833           required: true
23834           type: string
23835   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
23836     get:
23837       tags:
23838         - Network
23839       summary: returns l-interfaces
23840       description: returns l-interfaces
23841       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
23842       produces:
23843         - application/json
23844         - application/xml
23845       responses:
23846         "200":
23847           description: successful operation
23848           schema:
23849               $ref: "#/getDefinitions/l-interfaces"
23850         "default":
23851           description: Response codes found in [response codes](https://wiki.onap.org/).
23852       parameters:
23853         - name: equipment-name
23854           in: path
23855           required: true
23856           type: string
23857           example: __EQUIPMENT-NAME__
23858         - name: interface-name
23859           in: path
23860           description: Name that identifies the physical interface
23861           required: true
23862           type: string
23863           example: __INTERFACE-NAME__
23864         - name: interface-name
23865           in: query
23866           description:
23867           required: false
23868           type: string
23869         - name: interface-id
23870           in: query
23871           description:
23872           required: false
23873           type: string
23874         - name: macaddr
23875           in: query
23876           description:
23877           required: false
23878           type: string
23879         - name: network-name
23880           in: query
23881           description:
23882           required: false
23883           type: string
23884   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
23885     get:
23886       tags:
23887         - Network
23888       summary: returns p-interface
23889       description: returns p-interface
23890       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
23891       produces:
23892         - application/json
23893         - application/xml
23894       responses:
23895         "200":
23896           description: successful operation
23897           schema:
23898               $ref: "#/getDefinitions/p-interface"
23899         "default":
23900           description: Response codes found in [response codes](https://wiki.onap.org/).
23901       parameters:
23902         - name: equipment-name
23903           in: path
23904           required: true
23905           type: string
23906           example: __EQUIPMENT-NAME__
23907         - name: interface-name
23908           in: path
23909           description: Name that identifies the physical interface
23910           required: true
23911           type: string
23912           example: __INTERFACE-NAME__
23913     put:
23914       tags:
23915         - Network
23916       summary: create or update an existing p-interface
23917       description: |
23918         Create or update an existing p-interface.
23919         #
23920         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23921       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
23922       consumes:
23923         - application/json
23924         - application/xml
23925       produces:
23926         - application/json
23927         - application/xml
23928       responses:
23929         "default":
23930           description: Response codes found in [response codes](https://wiki.onap.org/).
23931       parameters:
23932         - name: equipment-name
23933           in: path
23934           required: true
23935           type: string
23936           example: __EQUIPMENT-NAME__
23937         - name: interface-name
23938           in: path
23939           description: Name that identifies the physical interface
23940           required: true
23941           type: string
23942           example: __INTERFACE-NAME__
23943         - name: body
23944           in: body
23945           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
23946           required: true
23947           schema:
23948             $ref: "#/definitions/p-interface"
23949     patch:
23950       tags:
23951         - Network
23952       summary: update an existing p-interface
23953       description: |
23954         Update an existing p-interface
23955         #
23956         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23957         The PUT operation will entirely replace an existing object.
23958         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23959         #
23960         Other differences between PUT and PATCH are:
23961         #
23962         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23963         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23964         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23965       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
23966       consumes:
23967         - application/json
23968         - application/xml
23969       produces:
23970         - application/json
23971         - application/xml
23972       responses:
23973         "default":
23974           description: Response codes found in [response codes](https://wiki.onap.org/).
23975       parameters:
23976         - name: equipment-name
23977           in: path
23978           required: true
23979           type: string
23980           example: __EQUIPMENT-NAME__
23981         - name: interface-name
23982           in: path
23983           description: Name that identifies the physical interface
23984           required: true
23985           type: string
23986           example: __INTERFACE-NAME__
23987         - name: body
23988           in: body
23989           description: p-interface object that needs to be updated.
23990           required: true
23991           schema:
23992             $ref: "#/patchDefinitions/p-interface"
23993     delete:
23994       tags:
23995         - Network
23996       summary: delete an existing p-interface
23997       description: delete an existing p-interface
23998       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
23999       consumes:
24000         - application/json
24001         - application/xml
24002       produces:
24003         - application/json
24004         - application/xml
24005       responses:
24006         "default":
24007           description: Response codes found in [response codes](https://wiki.onap.org/).
24008       parameters:
24009         - name: equipment-name
24010           in: path
24011           required: true
24012           type: string
24013           example: __EQUIPMENT-NAME__
24014         - name: interface-name
24015           in: path
24016           description: Name that identifies the physical interface
24017           required: true
24018           type: string
24019           example: __INTERFACE-NAME__
24020         - name: resource-version
24021           in: query
24022           description: resource-version for concurrency
24023           required: true
24024           type: string
24025   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24026     get:
24027       tags:
24028         - Network
24029       summary: returns p-interfaces
24030       description: returns p-interfaces
24031       operationId: getNetworkVplsPesVplsPePInterfaces
24032       produces:
24033         - application/json
24034         - application/xml
24035       responses:
24036         "200":
24037           description: successful operation
24038           schema:
24039               $ref: "#/getDefinitions/p-interfaces"
24040         "default":
24041           description: Response codes found in [response codes](https://wiki.onap.org/).
24042       parameters:
24043         - name: equipment-name
24044           in: path
24045           required: true
24046           type: string
24047           example: __EQUIPMENT-NAME__
24048         - name: interface-name
24049           in: query
24050           description:
24051           required: false
24052           type: string
24053         - name: prov-status
24054           in: query
24055           description:
24056           required: false
24057           type: string
24058   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24059     put:
24060       tags:
24061         - Network
24062       summary: see node definition for valid relationships
24063       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24064       consumes:
24065         - application/json
24066         - application/xml
24067       produces:
24068         - application/json
24069         - application/xml
24070       responses:
24071         "default":
24072           description: Response codes found in [response codes](https://wiki.onap.org/).
24073       parameters:
24074         - name: equipment-name
24075           in: path
24076           required: true
24077           type: string
24078           example: __EQUIPMENT-NAME__
24079         - name: interface-name
24080           in: path
24081           description: Name that identifies the link aggregate interface
24082           required: true
24083           type: string
24084           example: __INTERFACE-NAME__
24085         - name: body
24086           in: body
24087           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24088           required: true
24089           schema:
24090             $ref: "#/definitions/relationship"
24091     delete:
24092       tags:
24093         - Network
24094       summary: delete an existing relationship
24095       description: delete an existing relationship
24096       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24097       consumes:
24098         - application/json
24099         - application/xml
24100       produces:
24101         - application/json
24102         - application/xml
24103       responses:
24104         "default":
24105           description: Response codes found in [response codes](https://wiki.onap.org/).
24106       parameters:
24107         - name: equipment-name
24108           in: path
24109           required: true
24110           type: string
24111           example: __EQUIPMENT-NAME__
24112         - name: interface-name
24113           in: path
24114           description: Name that identifies the link aggregate interface
24115           required: true
24116           type: string
24117           example: __INTERFACE-NAME__
24118   /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:
24119     put:
24120       tags:
24121         - Network
24122       summary: see node definition for valid relationships
24123       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24124       consumes:
24125         - application/json
24126         - application/xml
24127       produces:
24128         - application/json
24129         - application/xml
24130       responses:
24131         "default":
24132           description: Response codes found in [response codes](https://wiki.onap.org/).
24133       parameters:
24134         - name: equipment-name
24135           in: path
24136           required: true
24137           type: string
24138           example: __EQUIPMENT-NAME__
24139         - name: interface-name
24140           in: path
24141           description: Name that identifies the link aggregate interface
24142           required: true
24143           type: string
24144           example: __INTERFACE-NAME__
24145         - name: interface-name
24146           in: path
24147           description: Name given to the interface
24148           required: true
24149           type: string
24150           example: __INTERFACE-NAME__
24151         - name: vlan-interface
24152           in: path
24153           description: String that identifies the interface
24154           required: true
24155           type: string
24156           example: __VLAN-INTERFACE__
24157         - name: body
24158           in: body
24159           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24160           required: true
24161           schema:
24162             $ref: "#/definitions/relationship"
24163     delete:
24164       tags:
24165         - Network
24166       summary: delete an existing relationship
24167       description: delete an existing relationship
24168       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24169       consumes:
24170         - application/json
24171         - application/xml
24172       produces:
24173         - application/json
24174         - application/xml
24175       responses:
24176         "default":
24177           description: Response codes found in [response codes](https://wiki.onap.org/).
24178       parameters:
24179         - name: equipment-name
24180           in: path
24181           required: true
24182           type: string
24183           example: __EQUIPMENT-NAME__
24184         - name: interface-name
24185           in: path
24186           description: Name that identifies the link aggregate interface
24187           required: true
24188           type: string
24189           example: __INTERFACE-NAME__
24190         - name: interface-name
24191           in: path
24192           description: Name given to the interface
24193           required: true
24194           type: string
24195           example: __INTERFACE-NAME__
24196         - name: vlan-interface
24197           in: path
24198           description: String that identifies the interface
24199           required: true
24200           type: string
24201           example: __VLAN-INTERFACE__
24202   /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:
24203     put:
24204       tags:
24205         - Network
24206       summary: see node definition for valid relationships
24207       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24208       consumes:
24209         - application/json
24210         - application/xml
24211       produces:
24212         - application/json
24213         - application/xml
24214       responses:
24215         "default":
24216           description: Response codes found in [response codes](https://wiki.onap.org/).
24217       parameters:
24218         - name: equipment-name
24219           in: path
24220           required: true
24221           type: string
24222           example: __EQUIPMENT-NAME__
24223         - name: interface-name
24224           in: path
24225           description: Name that identifies the link aggregate interface
24226           required: true
24227           type: string
24228           example: __INTERFACE-NAME__
24229         - name: interface-name
24230           in: path
24231           description: Name given to the interface
24232           required: true
24233           type: string
24234           example: __INTERFACE-NAME__
24235         - name: vlan-interface
24236           in: path
24237           description: String that identifies the interface
24238           required: true
24239           type: string
24240           example: __VLAN-INTERFACE__
24241         - name: l3-interface-ipv4-address
24242           in: path
24243           description: IP address
24244           required: true
24245           type: string
24246           example: __L3-INTERFACE-IPV4-ADDRESS__
24247         - name: body
24248           in: body
24249           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24250           required: true
24251           schema:
24252             $ref: "#/definitions/relationship"
24253     delete:
24254       tags:
24255         - Network
24256       summary: delete an existing relationship
24257       description: delete an existing relationship
24258       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24259       consumes:
24260         - application/json
24261         - application/xml
24262       produces:
24263         - application/json
24264         - application/xml
24265       responses:
24266         "default":
24267           description: Response codes found in [response codes](https://wiki.onap.org/).
24268       parameters:
24269         - name: equipment-name
24270           in: path
24271           required: true
24272           type: string
24273           example: __EQUIPMENT-NAME__
24274         - name: interface-name
24275           in: path
24276           description: Name that identifies the link aggregate interface
24277           required: true
24278           type: string
24279           example: __INTERFACE-NAME__
24280         - name: interface-name
24281           in: path
24282           description: Name given to the interface
24283           required: true
24284           type: string
24285           example: __INTERFACE-NAME__
24286         - name: vlan-interface
24287           in: path
24288           description: String that identifies the interface
24289           required: true
24290           type: string
24291           example: __VLAN-INTERFACE__
24292         - name: l3-interface-ipv4-address
24293           in: path
24294           description: IP address
24295           required: true
24296           type: string
24297           example: __L3-INTERFACE-IPV4-ADDRESS__
24298   /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}:
24299     get:
24300       tags:
24301         - Network
24302       summary: returns l3-interface-ipv4-address-list
24303       description: returns l3-interface-ipv4-address-list
24304       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24305       produces:
24306         - application/json
24307         - application/xml
24308       responses:
24309         "200":
24310           description: successful operation
24311           schema:
24312               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24313         "default":
24314           description: Response codes found in [response codes](https://wiki.onap.org/).
24315       parameters:
24316         - name: equipment-name
24317           in: path
24318           required: true
24319           type: string
24320           example: __EQUIPMENT-NAME__
24321         - name: interface-name
24322           in: path
24323           description: Name that identifies the link aggregate interface
24324           required: true
24325           type: string
24326           example: __INTERFACE-NAME__
24327         - name: interface-name
24328           in: path
24329           description: Name given to the interface
24330           required: true
24331           type: string
24332           example: __INTERFACE-NAME__
24333         - name: vlan-interface
24334           in: path
24335           description: String that identifies the interface
24336           required: true
24337           type: string
24338           example: __VLAN-INTERFACE__
24339         - name: l3-interface-ipv4-address
24340           in: path
24341           description: IP address
24342           required: true
24343           type: string
24344           example: __L3-INTERFACE-IPV4-ADDRESS__
24345     put:
24346       tags:
24347         - Network
24348       summary: create or update an existing l3-interface-ipv4-address-list
24349       description: |
24350         Create or update an existing l3-interface-ipv4-address-list.
24351         #
24352         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24353       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24354       consumes:
24355         - application/json
24356         - application/xml
24357       produces:
24358         - application/json
24359         - application/xml
24360       responses:
24361         "default":
24362           description: Response codes found in [response codes](https://wiki.onap.org/).
24363       parameters:
24364         - name: equipment-name
24365           in: path
24366           required: true
24367           type: string
24368           example: __EQUIPMENT-NAME__
24369         - name: interface-name
24370           in: path
24371           description: Name that identifies the link aggregate interface
24372           required: true
24373           type: string
24374           example: __INTERFACE-NAME__
24375         - name: interface-name
24376           in: path
24377           description: Name given to the interface
24378           required: true
24379           type: string
24380           example: __INTERFACE-NAME__
24381         - name: vlan-interface
24382           in: path
24383           description: String that identifies the interface
24384           required: true
24385           type: string
24386           example: __VLAN-INTERFACE__
24387         - name: l3-interface-ipv4-address
24388           in: path
24389           description: IP address
24390           required: true
24391           type: string
24392           example: __L3-INTERFACE-IPV4-ADDRESS__
24393         - name: body
24394           in: body
24395           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24396           required: true
24397           schema:
24398             $ref: "#/definitions/l3-interface-ipv4-address-list"
24399     patch:
24400       tags:
24401         - Network
24402       summary: update an existing l3-interface-ipv4-address-list
24403       description: |
24404         Update an existing l3-interface-ipv4-address-list
24405         #
24406         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24407         The PUT operation will entirely replace an existing object.
24408         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24409         #
24410         Other differences between PUT and PATCH are:
24411         #
24412         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24413         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24414         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24415       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24416       consumes:
24417         - application/json
24418         - application/xml
24419       produces:
24420         - application/json
24421         - application/xml
24422       responses:
24423         "default":
24424           description: Response codes found in [response codes](https://wiki.onap.org/).
24425       parameters:
24426         - name: equipment-name
24427           in: path
24428           required: true
24429           type: string
24430           example: __EQUIPMENT-NAME__
24431         - name: interface-name
24432           in: path
24433           description: Name that identifies the link aggregate interface
24434           required: true
24435           type: string
24436           example: __INTERFACE-NAME__
24437         - name: interface-name
24438           in: path
24439           description: Name given to the interface
24440           required: true
24441           type: string
24442           example: __INTERFACE-NAME__
24443         - name: vlan-interface
24444           in: path
24445           description: String that identifies the interface
24446           required: true
24447           type: string
24448           example: __VLAN-INTERFACE__
24449         - name: l3-interface-ipv4-address
24450           in: path
24451           description: IP address
24452           required: true
24453           type: string
24454           example: __L3-INTERFACE-IPV4-ADDRESS__
24455         - name: body
24456           in: body
24457           description: l3-interface-ipv4-address-list object that needs to be updated.
24458           required: true
24459           schema:
24460             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24461     delete:
24462       tags:
24463         - Network
24464       summary: delete an existing l3-interface-ipv4-address-list
24465       description: delete an existing l3-interface-ipv4-address-list
24466       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24467       consumes:
24468         - application/json
24469         - application/xml
24470       produces:
24471         - application/json
24472         - application/xml
24473       responses:
24474         "default":
24475           description: Response codes found in [response codes](https://wiki.onap.org/).
24476       parameters:
24477         - name: equipment-name
24478           in: path
24479           required: true
24480           type: string
24481           example: __EQUIPMENT-NAME__
24482         - name: interface-name
24483           in: path
24484           description: Name that identifies the link aggregate interface
24485           required: true
24486           type: string
24487           example: __INTERFACE-NAME__
24488         - name: interface-name
24489           in: path
24490           description: Name given to the interface
24491           required: true
24492           type: string
24493           example: __INTERFACE-NAME__
24494         - name: vlan-interface
24495           in: path
24496           description: String that identifies the interface
24497           required: true
24498           type: string
24499           example: __VLAN-INTERFACE__
24500         - name: l3-interface-ipv4-address
24501           in: path
24502           description: IP address
24503           required: true
24504           type: string
24505           example: __L3-INTERFACE-IPV4-ADDRESS__
24506         - name: resource-version
24507           in: query
24508           description: resource-version for concurrency
24509           required: true
24510           type: string
24511   /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:
24512     put:
24513       tags:
24514         - Network
24515       summary: see node definition for valid relationships
24516       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24517       consumes:
24518         - application/json
24519         - application/xml
24520       produces:
24521         - application/json
24522         - application/xml
24523       responses:
24524         "default":
24525           description: Response codes found in [response codes](https://wiki.onap.org/).
24526       parameters:
24527         - name: equipment-name
24528           in: path
24529           required: true
24530           type: string
24531           example: __EQUIPMENT-NAME__
24532         - name: interface-name
24533           in: path
24534           description: Name that identifies the link aggregate interface
24535           required: true
24536           type: string
24537           example: __INTERFACE-NAME__
24538         - name: interface-name
24539           in: path
24540           description: Name given to the interface
24541           required: true
24542           type: string
24543           example: __INTERFACE-NAME__
24544         - name: vlan-interface
24545           in: path
24546           description: String that identifies the interface
24547           required: true
24548           type: string
24549           example: __VLAN-INTERFACE__
24550         - name: l3-interface-ipv6-address
24551           in: path
24552           description: IP address
24553           required: true
24554           type: string
24555           example: __L3-INTERFACE-IPV6-ADDRESS__
24556         - name: body
24557           in: body
24558           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24559           required: true
24560           schema:
24561             $ref: "#/definitions/relationship"
24562     delete:
24563       tags:
24564         - Network
24565       summary: delete an existing relationship
24566       description: delete an existing relationship
24567       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24568       consumes:
24569         - application/json
24570         - application/xml
24571       produces:
24572         - application/json
24573         - application/xml
24574       responses:
24575         "default":
24576           description: Response codes found in [response codes](https://wiki.onap.org/).
24577       parameters:
24578         - name: equipment-name
24579           in: path
24580           required: true
24581           type: string
24582           example: __EQUIPMENT-NAME__
24583         - name: interface-name
24584           in: path
24585           description: Name that identifies the link aggregate interface
24586           required: true
24587           type: string
24588           example: __INTERFACE-NAME__
24589         - name: interface-name
24590           in: path
24591           description: Name given to the interface
24592           required: true
24593           type: string
24594           example: __INTERFACE-NAME__
24595         - name: vlan-interface
24596           in: path
24597           description: String that identifies the interface
24598           required: true
24599           type: string
24600           example: __VLAN-INTERFACE__
24601         - name: l3-interface-ipv6-address
24602           in: path
24603           description: IP address
24604           required: true
24605           type: string
24606           example: __L3-INTERFACE-IPV6-ADDRESS__
24607   /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}:
24608     get:
24609       tags:
24610         - Network
24611       summary: returns l3-interface-ipv6-address-list
24612       description: returns l3-interface-ipv6-address-list
24613       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24614       produces:
24615         - application/json
24616         - application/xml
24617       responses:
24618         "200":
24619           description: successful operation
24620           schema:
24621               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24622         "default":
24623           description: Response codes found in [response codes](https://wiki.onap.org/).
24624       parameters:
24625         - name: equipment-name
24626           in: path
24627           required: true
24628           type: string
24629           example: __EQUIPMENT-NAME__
24630         - name: interface-name
24631           in: path
24632           description: Name that identifies the link aggregate interface
24633           required: true
24634           type: string
24635           example: __INTERFACE-NAME__
24636         - name: interface-name
24637           in: path
24638           description: Name given to the interface
24639           required: true
24640           type: string
24641           example: __INTERFACE-NAME__
24642         - name: vlan-interface
24643           in: path
24644           description: String that identifies the interface
24645           required: true
24646           type: string
24647           example: __VLAN-INTERFACE__
24648         - name: l3-interface-ipv6-address
24649           in: path
24650           description: IP address
24651           required: true
24652           type: string
24653           example: __L3-INTERFACE-IPV6-ADDRESS__
24654     put:
24655       tags:
24656         - Network
24657       summary: create or update an existing l3-interface-ipv6-address-list
24658       description: |
24659         Create or update an existing l3-interface-ipv6-address-list.
24660         #
24661         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24662       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24663       consumes:
24664         - application/json
24665         - application/xml
24666       produces:
24667         - application/json
24668         - application/xml
24669       responses:
24670         "default":
24671           description: Response codes found in [response codes](https://wiki.onap.org/).
24672       parameters:
24673         - name: equipment-name
24674           in: path
24675           required: true
24676           type: string
24677           example: __EQUIPMENT-NAME__
24678         - name: interface-name
24679           in: path
24680           description: Name that identifies the link aggregate interface
24681           required: true
24682           type: string
24683           example: __INTERFACE-NAME__
24684         - name: interface-name
24685           in: path
24686           description: Name given to the interface
24687           required: true
24688           type: string
24689           example: __INTERFACE-NAME__
24690         - name: vlan-interface
24691           in: path
24692           description: String that identifies the interface
24693           required: true
24694           type: string
24695           example: __VLAN-INTERFACE__
24696         - name: l3-interface-ipv6-address
24697           in: path
24698           description: IP address
24699           required: true
24700           type: string
24701           example: __L3-INTERFACE-IPV6-ADDRESS__
24702         - name: body
24703           in: body
24704           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24705           required: true
24706           schema:
24707             $ref: "#/definitions/l3-interface-ipv6-address-list"
24708     patch:
24709       tags:
24710         - Network
24711       summary: update an existing l3-interface-ipv6-address-list
24712       description: |
24713         Update an existing l3-interface-ipv6-address-list
24714         #
24715         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24716         The PUT operation will entirely replace an existing object.
24717         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24718         #
24719         Other differences between PUT and PATCH are:
24720         #
24721         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24722         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24723         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24724       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24725       consumes:
24726         - application/json
24727         - application/xml
24728       produces:
24729         - application/json
24730         - application/xml
24731       responses:
24732         "default":
24733           description: Response codes found in [response codes](https://wiki.onap.org/).
24734       parameters:
24735         - name: equipment-name
24736           in: path
24737           required: true
24738           type: string
24739           example: __EQUIPMENT-NAME__
24740         - name: interface-name
24741           in: path
24742           description: Name that identifies the link aggregate interface
24743           required: true
24744           type: string
24745           example: __INTERFACE-NAME__
24746         - name: interface-name
24747           in: path
24748           description: Name given to the interface
24749           required: true
24750           type: string
24751           example: __INTERFACE-NAME__
24752         - name: vlan-interface
24753           in: path
24754           description: String that identifies the interface
24755           required: true
24756           type: string
24757           example: __VLAN-INTERFACE__
24758         - name: l3-interface-ipv6-address
24759           in: path
24760           description: IP address
24761           required: true
24762           type: string
24763           example: __L3-INTERFACE-IPV6-ADDRESS__
24764         - name: body
24765           in: body
24766           description: l3-interface-ipv6-address-list object that needs to be updated.
24767           required: true
24768           schema:
24769             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24770     delete:
24771       tags:
24772         - Network
24773       summary: delete an existing l3-interface-ipv6-address-list
24774       description: delete an existing l3-interface-ipv6-address-list
24775       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24776       consumes:
24777         - application/json
24778         - application/xml
24779       produces:
24780         - application/json
24781         - application/xml
24782       responses:
24783         "default":
24784           description: Response codes found in [response codes](https://wiki.onap.org/).
24785       parameters:
24786         - name: equipment-name
24787           in: path
24788           required: true
24789           type: string
24790           example: __EQUIPMENT-NAME__
24791         - name: interface-name
24792           in: path
24793           description: Name that identifies the link aggregate interface
24794           required: true
24795           type: string
24796           example: __INTERFACE-NAME__
24797         - name: interface-name
24798           in: path
24799           description: Name given to the interface
24800           required: true
24801           type: string
24802           example: __INTERFACE-NAME__
24803         - name: vlan-interface
24804           in: path
24805           description: String that identifies the interface
24806           required: true
24807           type: string
24808           example: __VLAN-INTERFACE__
24809         - name: l3-interface-ipv6-address
24810           in: path
24811           description: IP address
24812           required: true
24813           type: string
24814           example: __L3-INTERFACE-IPV6-ADDRESS__
24815         - name: resource-version
24816           in: query
24817           description: resource-version for concurrency
24818           required: true
24819           type: string
24820   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
24821     get:
24822       tags:
24823         - Network
24824       summary: returns vlan
24825       description: returns vlan
24826       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24827       produces:
24828         - application/json
24829         - application/xml
24830       responses:
24831         "200":
24832           description: successful operation
24833           schema:
24834               $ref: "#/getDefinitions/vlan"
24835         "default":
24836           description: Response codes found in [response codes](https://wiki.onap.org/).
24837       parameters:
24838         - name: equipment-name
24839           in: path
24840           required: true
24841           type: string
24842           example: __EQUIPMENT-NAME__
24843         - name: interface-name
24844           in: path
24845           description: Name that identifies the link aggregate interface
24846           required: true
24847           type: string
24848           example: __INTERFACE-NAME__
24849         - name: interface-name
24850           in: path
24851           description: Name given to the interface
24852           required: true
24853           type: string
24854           example: __INTERFACE-NAME__
24855         - name: vlan-interface
24856           in: path
24857           description: String that identifies the interface
24858           required: true
24859           type: string
24860           example: __VLAN-INTERFACE__
24861     put:
24862       tags:
24863         - Network
24864       summary: create or update an existing vlan
24865       description: |
24866         Create or update an existing vlan.
24867         #
24868         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24869       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24870       consumes:
24871         - application/json
24872         - application/xml
24873       produces:
24874         - application/json
24875         - application/xml
24876       responses:
24877         "default":
24878           description: Response codes found in [response codes](https://wiki.onap.org/).
24879       parameters:
24880         - name: equipment-name
24881           in: path
24882           required: true
24883           type: string
24884           example: __EQUIPMENT-NAME__
24885         - name: interface-name
24886           in: path
24887           description: Name that identifies the link aggregate interface
24888           required: true
24889           type: string
24890           example: __INTERFACE-NAME__
24891         - name: interface-name
24892           in: path
24893           description: Name given to the interface
24894           required: true
24895           type: string
24896           example: __INTERFACE-NAME__
24897         - name: vlan-interface
24898           in: path
24899           description: String that identifies the interface
24900           required: true
24901           type: string
24902           example: __VLAN-INTERFACE__
24903         - name: body
24904           in: body
24905           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24906           required: true
24907           schema:
24908             $ref: "#/definitions/vlan"
24909     patch:
24910       tags:
24911         - Network
24912       summary: update an existing vlan
24913       description: |
24914         Update an existing vlan
24915         #
24916         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24917         The PUT operation will entirely replace an existing object.
24918         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24919         #
24920         Other differences between PUT and PATCH are:
24921         #
24922         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24923         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24924         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24925       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24926       consumes:
24927         - application/json
24928         - application/xml
24929       produces:
24930         - application/json
24931         - application/xml
24932       responses:
24933         "default":
24934           description: Response codes found in [response codes](https://wiki.onap.org/).
24935       parameters:
24936         - name: equipment-name
24937           in: path
24938           required: true
24939           type: string
24940           example: __EQUIPMENT-NAME__
24941         - name: interface-name
24942           in: path
24943           description: Name that identifies the link aggregate interface
24944           required: true
24945           type: string
24946           example: __INTERFACE-NAME__
24947         - name: interface-name
24948           in: path
24949           description: Name given to the interface
24950           required: true
24951           type: string
24952           example: __INTERFACE-NAME__
24953         - name: vlan-interface
24954           in: path
24955           description: String that identifies the interface
24956           required: true
24957           type: string
24958           example: __VLAN-INTERFACE__
24959         - name: body
24960           in: body
24961           description: vlan object that needs to be updated.
24962           required: true
24963           schema:
24964             $ref: "#/patchDefinitions/vlan"
24965     delete:
24966       tags:
24967         - Network
24968       summary: delete an existing vlan
24969       description: delete an existing vlan
24970       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24971       consumes:
24972         - application/json
24973         - application/xml
24974       produces:
24975         - application/json
24976         - application/xml
24977       responses:
24978         "default":
24979           description: Response codes found in [response codes](https://wiki.onap.org/).
24980       parameters:
24981         - name: equipment-name
24982           in: path
24983           required: true
24984           type: string
24985           example: __EQUIPMENT-NAME__
24986         - name: interface-name
24987           in: path
24988           description: Name that identifies the link aggregate interface
24989           required: true
24990           type: string
24991           example: __INTERFACE-NAME__
24992         - name: interface-name
24993           in: path
24994           description: Name given to the interface
24995           required: true
24996           type: string
24997           example: __INTERFACE-NAME__
24998         - name: vlan-interface
24999           in: path
25000           description: String that identifies the interface
25001           required: true
25002           type: string
25003           example: __VLAN-INTERFACE__
25004         - name: resource-version
25005           in: query
25006           description: resource-version for concurrency
25007           required: true
25008           type: string
25009   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25010     get:
25011       tags:
25012         - Network
25013       summary: returns vlans
25014       description: returns vlans
25015       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25016       produces:
25017         - application/json
25018         - application/xml
25019       responses:
25020         "200":
25021           description: successful operation
25022           schema:
25023               $ref: "#/getDefinitions/vlans"
25024         "default":
25025           description: Response codes found in [response codes](https://wiki.onap.org/).
25026       parameters:
25027         - name: equipment-name
25028           in: path
25029           required: true
25030           type: string
25031           example: __EQUIPMENT-NAME__
25032         - name: interface-name
25033           in: path
25034           description: Name that identifies the link aggregate interface
25035           required: true
25036           type: string
25037           example: __INTERFACE-NAME__
25038         - name: interface-name
25039           in: path
25040           description: Name given to the interface
25041           required: true
25042           type: string
25043           example: __INTERFACE-NAME__
25044         - name: vlan-interface
25045           in: query
25046           description:
25047           required: false
25048           type: string
25049         - name: vlan-id-inner
25050           in: query
25051           description:
25052           required: false
25053           type: integer
25054           format: int64
25055         - name: vpn-key
25056           in: query
25057           description:
25058           required: false
25059           type: string
25060   /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:
25061     put:
25062       tags:
25063         - Network
25064       summary: see node definition for valid relationships
25065       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25066       consumes:
25067         - application/json
25068         - application/xml
25069       produces:
25070         - application/json
25071         - application/xml
25072       responses:
25073         "default":
25074           description: Response codes found in [response codes](https://wiki.onap.org/).
25075       parameters:
25076         - name: equipment-name
25077           in: path
25078           required: true
25079           type: string
25080           example: __EQUIPMENT-NAME__
25081         - name: interface-name
25082           in: path
25083           description: Name that identifies the link aggregate interface
25084           required: true
25085           type: string
25086           example: __INTERFACE-NAME__
25087         - name: interface-name
25088           in: path
25089           description: Name given to the interface
25090           required: true
25091           type: string
25092           example: __INTERFACE-NAME__
25093         - name: pci-id
25094           in: path
25095           description: PCI ID used to identify the sriov-vf
25096           required: true
25097           type: string
25098           example: __PCI-ID__
25099         - name: body
25100           in: body
25101           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25102           required: true
25103           schema:
25104             $ref: "#/definitions/relationship"
25105     delete:
25106       tags:
25107         - Network
25108       summary: delete an existing relationship
25109       description: delete an existing relationship
25110       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25111       consumes:
25112         - application/json
25113         - application/xml
25114       produces:
25115         - application/json
25116         - application/xml
25117       responses:
25118         "default":
25119           description: Response codes found in [response codes](https://wiki.onap.org/).
25120       parameters:
25121         - name: equipment-name
25122           in: path
25123           required: true
25124           type: string
25125           example: __EQUIPMENT-NAME__
25126         - name: interface-name
25127           in: path
25128           description: Name that identifies the link aggregate interface
25129           required: true
25130           type: string
25131           example: __INTERFACE-NAME__
25132         - name: interface-name
25133           in: path
25134           description: Name given to the interface
25135           required: true
25136           type: string
25137           example: __INTERFACE-NAME__
25138         - name: pci-id
25139           in: path
25140           description: PCI ID used to identify the sriov-vf
25141           required: true
25142           type: string
25143           example: __PCI-ID__
25144   /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}:
25145     get:
25146       tags:
25147         - Network
25148       summary: returns sriov-vf
25149       description: returns sriov-vf
25150       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25151       produces:
25152         - application/json
25153         - application/xml
25154       responses:
25155         "200":
25156           description: successful operation
25157           schema:
25158               $ref: "#/getDefinitions/sriov-vf"
25159         "default":
25160           description: Response codes found in [response codes](https://wiki.onap.org/).
25161       parameters:
25162         - name: equipment-name
25163           in: path
25164           required: true
25165           type: string
25166           example: __EQUIPMENT-NAME__
25167         - name: interface-name
25168           in: path
25169           description: Name that identifies the link aggregate interface
25170           required: true
25171           type: string
25172           example: __INTERFACE-NAME__
25173         - name: interface-name
25174           in: path
25175           description: Name given to the interface
25176           required: true
25177           type: string
25178           example: __INTERFACE-NAME__
25179         - name: pci-id
25180           in: path
25181           description: PCI ID used to identify the sriov-vf
25182           required: true
25183           type: string
25184           example: __PCI-ID__
25185     put:
25186       tags:
25187         - Network
25188       summary: create or update an existing sriov-vf
25189       description: |
25190         Create or update an existing sriov-vf.
25191         #
25192         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25193       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25194       consumes:
25195         - application/json
25196         - application/xml
25197       produces:
25198         - application/json
25199         - application/xml
25200       responses:
25201         "default":
25202           description: Response codes found in [response codes](https://wiki.onap.org/).
25203       parameters:
25204         - name: equipment-name
25205           in: path
25206           required: true
25207           type: string
25208           example: __EQUIPMENT-NAME__
25209         - name: interface-name
25210           in: path
25211           description: Name that identifies the link aggregate interface
25212           required: true
25213           type: string
25214           example: __INTERFACE-NAME__
25215         - name: interface-name
25216           in: path
25217           description: Name given to the interface
25218           required: true
25219           type: string
25220           example: __INTERFACE-NAME__
25221         - name: pci-id
25222           in: path
25223           description: PCI ID used to identify the sriov-vf
25224           required: true
25225           type: string
25226           example: __PCI-ID__
25227         - name: body
25228           in: body
25229           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25230           required: true
25231           schema:
25232             $ref: "#/definitions/sriov-vf"
25233     patch:
25234       tags:
25235         - Network
25236       summary: update an existing sriov-vf
25237       description: |
25238         Update an existing sriov-vf
25239         #
25240         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25241         The PUT operation will entirely replace an existing object.
25242         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25243         #
25244         Other differences between PUT and PATCH are:
25245         #
25246         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25247         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25248         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25249       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25250       consumes:
25251         - application/json
25252         - application/xml
25253       produces:
25254         - application/json
25255         - application/xml
25256       responses:
25257         "default":
25258           description: Response codes found in [response codes](https://wiki.onap.org/).
25259       parameters:
25260         - name: equipment-name
25261           in: path
25262           required: true
25263           type: string
25264           example: __EQUIPMENT-NAME__
25265         - name: interface-name
25266           in: path
25267           description: Name that identifies the link aggregate interface
25268           required: true
25269           type: string
25270           example: __INTERFACE-NAME__
25271         - name: interface-name
25272           in: path
25273           description: Name given to the interface
25274           required: true
25275           type: string
25276           example: __INTERFACE-NAME__
25277         - name: pci-id
25278           in: path
25279           description: PCI ID used to identify the sriov-vf
25280           required: true
25281           type: string
25282           example: __PCI-ID__
25283         - name: body
25284           in: body
25285           description: sriov-vf object that needs to be updated.
25286           required: true
25287           schema:
25288             $ref: "#/patchDefinitions/sriov-vf"
25289     delete:
25290       tags:
25291         - Network
25292       summary: delete an existing sriov-vf
25293       description: delete an existing sriov-vf
25294       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25295       consumes:
25296         - application/json
25297         - application/xml
25298       produces:
25299         - application/json
25300         - application/xml
25301       responses:
25302         "default":
25303           description: Response codes found in [response codes](https://wiki.onap.org/).
25304       parameters:
25305         - name: equipment-name
25306           in: path
25307           required: true
25308           type: string
25309           example: __EQUIPMENT-NAME__
25310         - name: interface-name
25311           in: path
25312           description: Name that identifies the link aggregate interface
25313           required: true
25314           type: string
25315           example: __INTERFACE-NAME__
25316         - name: interface-name
25317           in: path
25318           description: Name given to the interface
25319           required: true
25320           type: string
25321           example: __INTERFACE-NAME__
25322         - name: pci-id
25323           in: path
25324           description: PCI ID used to identify the sriov-vf
25325           required: true
25326           type: string
25327           example: __PCI-ID__
25328         - name: resource-version
25329           in: query
25330           description: resource-version for concurrency
25331           required: true
25332           type: string
25333   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25334     get:
25335       tags:
25336         - Network
25337       summary: returns sriov-vfs
25338       description: returns sriov-vfs
25339       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
25340       produces:
25341         - application/json
25342         - application/xml
25343       responses:
25344         "200":
25345           description: successful operation
25346           schema:
25347               $ref: "#/getDefinitions/sriov-vfs"
25348         "default":
25349           description: Response codes found in [response codes](https://wiki.onap.org/).
25350       parameters:
25351         - name: equipment-name
25352           in: path
25353           required: true
25354           type: string
25355           example: __EQUIPMENT-NAME__
25356         - name: interface-name
25357           in: path
25358           description: Name that identifies the link aggregate interface
25359           required: true
25360           type: string
25361           example: __INTERFACE-NAME__
25362         - name: interface-name
25363           in: path
25364           description: Name given to the interface
25365           required: true
25366           type: string
25367           example: __INTERFACE-NAME__
25368         - name: pci-id
25369           in: query
25370           description:
25371           required: false
25372           type: string
25373         - name: vf-vlan-filter
25374           in: query
25375           description:
25376           required: false
25377           type: string
25378         - name: vf-mac-filter
25379           in: query
25380           description:
25381           required: false
25382           type: string
25383         - name: vf-vlan-strip
25384           in: query
25385           description:
25386           required: false
25387           type: boolean
25388         - name: neutron-network-id
25389           in: query
25390           description:
25391           required: false
25392           type: string
25393   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25394     put:
25395       tags:
25396         - Network
25397       summary: see node definition for valid relationships
25398       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25399       consumes:
25400         - application/json
25401         - application/xml
25402       produces:
25403         - application/json
25404         - application/xml
25405       responses:
25406         "default":
25407           description: Response codes found in [response codes](https://wiki.onap.org/).
25408       parameters:
25409         - name: equipment-name
25410           in: path
25411           required: true
25412           type: string
25413           example: __EQUIPMENT-NAME__
25414         - name: interface-name
25415           in: path
25416           description: Name that identifies the link aggregate interface
25417           required: true
25418           type: string
25419           example: __INTERFACE-NAME__
25420         - name: interface-name
25421           in: path
25422           description: Name given to the interface
25423           required: true
25424           type: string
25425           example: __INTERFACE-NAME__
25426         - name: body
25427           in: body
25428           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
25429           required: true
25430           schema:
25431             $ref: "#/definitions/relationship"
25432     delete:
25433       tags:
25434         - Network
25435       summary: delete an existing relationship
25436       description: delete an existing relationship
25437       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25438       consumes:
25439         - application/json
25440         - application/xml
25441       produces:
25442         - application/json
25443         - application/xml
25444       responses:
25445         "default":
25446           description: Response codes found in [response codes](https://wiki.onap.org/).
25447       parameters:
25448         - name: equipment-name
25449           in: path
25450           required: true
25451           type: string
25452           example: __EQUIPMENT-NAME__
25453         - name: interface-name
25454           in: path
25455           description: Name that identifies the link aggregate interface
25456           required: true
25457           type: string
25458           example: __INTERFACE-NAME__
25459         - name: interface-name
25460           in: path
25461           description: Name given to the interface
25462           required: true
25463           type: string
25464           example: __INTERFACE-NAME__
25465   /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:
25466     put:
25467       tags:
25468         - Network
25469       summary: see node definition for valid relationships
25470       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25471       consumes:
25472         - application/json
25473         - application/xml
25474       produces:
25475         - application/json
25476         - application/xml
25477       responses:
25478         "default":
25479           description: Response codes found in [response codes](https://wiki.onap.org/).
25480       parameters:
25481         - name: equipment-name
25482           in: path
25483           required: true
25484           type: string
25485           example: __EQUIPMENT-NAME__
25486         - name: interface-name
25487           in: path
25488           description: Name that identifies the link aggregate interface
25489           required: true
25490           type: string
25491           example: __INTERFACE-NAME__
25492         - name: interface-name
25493           in: path
25494           description: Name given to the interface
25495           required: true
25496           type: string
25497           example: __INTERFACE-NAME__
25498         - name: l3-interface-ipv4-address
25499           in: path
25500           description: IP address
25501           required: true
25502           type: string
25503           example: __L3-INTERFACE-IPV4-ADDRESS__
25504         - name: body
25505           in: body
25506           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25507           required: true
25508           schema:
25509             $ref: "#/definitions/relationship"
25510     delete:
25511       tags:
25512         - Network
25513       summary: delete an existing relationship
25514       description: delete an existing relationship
25515       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25516       consumes:
25517         - application/json
25518         - application/xml
25519       produces:
25520         - application/json
25521         - application/xml
25522       responses:
25523         "default":
25524           description: Response codes found in [response codes](https://wiki.onap.org/).
25525       parameters:
25526         - name: equipment-name
25527           in: path
25528           required: true
25529           type: string
25530           example: __EQUIPMENT-NAME__
25531         - name: interface-name
25532           in: path
25533           description: Name that identifies the link aggregate interface
25534           required: true
25535           type: string
25536           example: __INTERFACE-NAME__
25537         - name: interface-name
25538           in: path
25539           description: Name given to the interface
25540           required: true
25541           type: string
25542           example: __INTERFACE-NAME__
25543         - name: l3-interface-ipv4-address
25544           in: path
25545           description: IP address
25546           required: true
25547           type: string
25548           example: __L3-INTERFACE-IPV4-ADDRESS__
25549   /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}:
25550     get:
25551       tags:
25552         - Network
25553       summary: returns l3-interface-ipv4-address-list
25554       description: returns l3-interface-ipv4-address-list
25555       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25556       produces:
25557         - application/json
25558         - application/xml
25559       responses:
25560         "200":
25561           description: successful operation
25562           schema:
25563               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25564         "default":
25565           description: Response codes found in [response codes](https://wiki.onap.org/).
25566       parameters:
25567         - name: equipment-name
25568           in: path
25569           required: true
25570           type: string
25571           example: __EQUIPMENT-NAME__
25572         - name: interface-name
25573           in: path
25574           description: Name that identifies the link aggregate interface
25575           required: true
25576           type: string
25577           example: __INTERFACE-NAME__
25578         - name: interface-name
25579           in: path
25580           description: Name given to the interface
25581           required: true
25582           type: string
25583           example: __INTERFACE-NAME__
25584         - name: l3-interface-ipv4-address
25585           in: path
25586           description: IP address
25587           required: true
25588           type: string
25589           example: __L3-INTERFACE-IPV4-ADDRESS__
25590     put:
25591       tags:
25592         - Network
25593       summary: create or update an existing l3-interface-ipv4-address-list
25594       description: |
25595         Create or update an existing l3-interface-ipv4-address-list.
25596         #
25597         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25598       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25599       consumes:
25600         - application/json
25601         - application/xml
25602       produces:
25603         - application/json
25604         - application/xml
25605       responses:
25606         "default":
25607           description: Response codes found in [response codes](https://wiki.onap.org/).
25608       parameters:
25609         - name: equipment-name
25610           in: path
25611           required: true
25612           type: string
25613           example: __EQUIPMENT-NAME__
25614         - name: interface-name
25615           in: path
25616           description: Name that identifies the link aggregate interface
25617           required: true
25618           type: string
25619           example: __INTERFACE-NAME__
25620         - name: interface-name
25621           in: path
25622           description: Name given to the interface
25623           required: true
25624           type: string
25625           example: __INTERFACE-NAME__
25626         - name: l3-interface-ipv4-address
25627           in: path
25628           description: IP address
25629           required: true
25630           type: string
25631           example: __L3-INTERFACE-IPV4-ADDRESS__
25632         - name: body
25633           in: body
25634           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25635           required: true
25636           schema:
25637             $ref: "#/definitions/l3-interface-ipv4-address-list"
25638     patch:
25639       tags:
25640         - Network
25641       summary: update an existing l3-interface-ipv4-address-list
25642       description: |
25643         Update an existing l3-interface-ipv4-address-list
25644         #
25645         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25646         The PUT operation will entirely replace an existing object.
25647         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25648         #
25649         Other differences between PUT and PATCH are:
25650         #
25651         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25652         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25653         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25654       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25655       consumes:
25656         - application/json
25657         - application/xml
25658       produces:
25659         - application/json
25660         - application/xml
25661       responses:
25662         "default":
25663           description: Response codes found in [response codes](https://wiki.onap.org/).
25664       parameters:
25665         - name: equipment-name
25666           in: path
25667           required: true
25668           type: string
25669           example: __EQUIPMENT-NAME__
25670         - name: interface-name
25671           in: path
25672           description: Name that identifies the link aggregate interface
25673           required: true
25674           type: string
25675           example: __INTERFACE-NAME__
25676         - name: interface-name
25677           in: path
25678           description: Name given to the interface
25679           required: true
25680           type: string
25681           example: __INTERFACE-NAME__
25682         - name: l3-interface-ipv4-address
25683           in: path
25684           description: IP address
25685           required: true
25686           type: string
25687           example: __L3-INTERFACE-IPV4-ADDRESS__
25688         - name: body
25689           in: body
25690           description: l3-interface-ipv4-address-list object that needs to be updated.
25691           required: true
25692           schema:
25693             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25694     delete:
25695       tags:
25696         - Network
25697       summary: delete an existing l3-interface-ipv4-address-list
25698       description: delete an existing l3-interface-ipv4-address-list
25699       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25700       consumes:
25701         - application/json
25702         - application/xml
25703       produces:
25704         - application/json
25705         - application/xml
25706       responses:
25707         "default":
25708           description: Response codes found in [response codes](https://wiki.onap.org/).
25709       parameters:
25710         - name: equipment-name
25711           in: path
25712           required: true
25713           type: string
25714           example: __EQUIPMENT-NAME__
25715         - name: interface-name
25716           in: path
25717           description: Name that identifies the link aggregate interface
25718           required: true
25719           type: string
25720           example: __INTERFACE-NAME__
25721         - name: interface-name
25722           in: path
25723           description: Name given to the interface
25724           required: true
25725           type: string
25726           example: __INTERFACE-NAME__
25727         - name: l3-interface-ipv4-address
25728           in: path
25729           description: IP address
25730           required: true
25731           type: string
25732           example: __L3-INTERFACE-IPV4-ADDRESS__
25733         - name: resource-version
25734           in: query
25735           description: resource-version for concurrency
25736           required: true
25737           type: string
25738   /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:
25739     put:
25740       tags:
25741         - Network
25742       summary: see node definition for valid relationships
25743       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
25744       consumes:
25745         - application/json
25746         - application/xml
25747       produces:
25748         - application/json
25749         - application/xml
25750       responses:
25751         "default":
25752           description: Response codes found in [response codes](https://wiki.onap.org/).
25753       parameters:
25754         - name: equipment-name
25755           in: path
25756           required: true
25757           type: string
25758           example: __EQUIPMENT-NAME__
25759         - name: interface-name
25760           in: path
25761           description: Name that identifies the link aggregate interface
25762           required: true
25763           type: string
25764           example: __INTERFACE-NAME__
25765         - name: interface-name
25766           in: path
25767           description: Name given to the interface
25768           required: true
25769           type: string
25770           example: __INTERFACE-NAME__
25771         - name: l3-interface-ipv6-address
25772           in: path
25773           description: IP address
25774           required: true
25775           type: string
25776           example: __L3-INTERFACE-IPV6-ADDRESS__
25777         - name: body
25778           in: body
25779           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
25780           required: true
25781           schema:
25782             $ref: "#/definitions/relationship"
25783     delete:
25784       tags:
25785         - Network
25786       summary: delete an existing relationship
25787       description: delete an existing relationship
25788       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
25789       consumes:
25790         - application/json
25791         - application/xml
25792       produces:
25793         - application/json
25794         - application/xml
25795       responses:
25796         "default":
25797           description: Response codes found in [response codes](https://wiki.onap.org/).
25798       parameters:
25799         - name: equipment-name
25800           in: path
25801           required: true
25802           type: string
25803           example: __EQUIPMENT-NAME__
25804         - name: interface-name
25805           in: path
25806           description: Name that identifies the link aggregate interface
25807           required: true
25808           type: string
25809           example: __INTERFACE-NAME__
25810         - name: interface-name
25811           in: path
25812           description: Name given to the interface
25813           required: true
25814           type: string
25815           example: __INTERFACE-NAME__
25816         - name: l3-interface-ipv6-address
25817           in: path
25818           description: IP address
25819           required: true
25820           type: string
25821           example: __L3-INTERFACE-IPV6-ADDRESS__
25822   /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}:
25823     get:
25824       tags:
25825         - Network
25826       summary: returns l3-interface-ipv6-address-list
25827       description: returns l3-interface-ipv6-address-list
25828       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25829       produces:
25830         - application/json
25831         - application/xml
25832       responses:
25833         "200":
25834           description: successful operation
25835           schema:
25836               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25837         "default":
25838           description: Response codes found in [response codes](https://wiki.onap.org/).
25839       parameters:
25840         - name: equipment-name
25841           in: path
25842           required: true
25843           type: string
25844           example: __EQUIPMENT-NAME__
25845         - name: interface-name
25846           in: path
25847           description: Name that identifies the link aggregate interface
25848           required: true
25849           type: string
25850           example: __INTERFACE-NAME__
25851         - name: interface-name
25852           in: path
25853           description: Name given to the interface
25854           required: true
25855           type: string
25856           example: __INTERFACE-NAME__
25857         - name: l3-interface-ipv6-address
25858           in: path
25859           description: IP address
25860           required: true
25861           type: string
25862           example: __L3-INTERFACE-IPV6-ADDRESS__
25863     put:
25864       tags:
25865         - Network
25866       summary: create or update an existing l3-interface-ipv6-address-list
25867       description: |
25868         Create or update an existing l3-interface-ipv6-address-list.
25869         #
25870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25871       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25872       consumes:
25873         - application/json
25874         - application/xml
25875       produces:
25876         - application/json
25877         - application/xml
25878       responses:
25879         "default":
25880           description: Response codes found in [response codes](https://wiki.onap.org/).
25881       parameters:
25882         - name: equipment-name
25883           in: path
25884           required: true
25885           type: string
25886           example: __EQUIPMENT-NAME__
25887         - name: interface-name
25888           in: path
25889           description: Name that identifies the link aggregate interface
25890           required: true
25891           type: string
25892           example: __INTERFACE-NAME__
25893         - name: interface-name
25894           in: path
25895           description: Name given to the interface
25896           required: true
25897           type: string
25898           example: __INTERFACE-NAME__
25899         - name: l3-interface-ipv6-address
25900           in: path
25901           description: IP address
25902           required: true
25903           type: string
25904           example: __L3-INTERFACE-IPV6-ADDRESS__
25905         - name: body
25906           in: body
25907           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
25908           required: true
25909           schema:
25910             $ref: "#/definitions/l3-interface-ipv6-address-list"
25911     patch:
25912       tags:
25913         - Network
25914       summary: update an existing l3-interface-ipv6-address-list
25915       description: |
25916         Update an existing l3-interface-ipv6-address-list
25917         #
25918         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25919         The PUT operation will entirely replace an existing object.
25920         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25921         #
25922         Other differences between PUT and PATCH are:
25923         #
25924         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25925         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25926         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25927       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25928       consumes:
25929         - application/json
25930         - application/xml
25931       produces:
25932         - application/json
25933         - application/xml
25934       responses:
25935         "default":
25936           description: Response codes found in [response codes](https://wiki.onap.org/).
25937       parameters:
25938         - name: equipment-name
25939           in: path
25940           required: true
25941           type: string
25942           example: __EQUIPMENT-NAME__
25943         - name: interface-name
25944           in: path
25945           description: Name that identifies the link aggregate interface
25946           required: true
25947           type: string
25948           example: __INTERFACE-NAME__
25949         - name: interface-name
25950           in: path
25951           description: Name given to the interface
25952           required: true
25953           type: string
25954           example: __INTERFACE-NAME__
25955         - name: l3-interface-ipv6-address
25956           in: path
25957           description: IP address
25958           required: true
25959           type: string
25960           example: __L3-INTERFACE-IPV6-ADDRESS__
25961         - name: body
25962           in: body
25963           description: l3-interface-ipv6-address-list object that needs to be updated.
25964           required: true
25965           schema:
25966             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25967     delete:
25968       tags:
25969         - Network
25970       summary: delete an existing l3-interface-ipv6-address-list
25971       description: delete an existing l3-interface-ipv6-address-list
25972       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25973       consumes:
25974         - application/json
25975         - application/xml
25976       produces:
25977         - application/json
25978         - application/xml
25979       responses:
25980         "default":
25981           description: Response codes found in [response codes](https://wiki.onap.org/).
25982       parameters:
25983         - name: equipment-name
25984           in: path
25985           required: true
25986           type: string
25987           example: __EQUIPMENT-NAME__
25988         - name: interface-name
25989           in: path
25990           description: Name that identifies the link aggregate interface
25991           required: true
25992           type: string
25993           example: __INTERFACE-NAME__
25994         - name: interface-name
25995           in: path
25996           description: Name given to the interface
25997           required: true
25998           type: string
25999           example: __INTERFACE-NAME__
26000         - name: l3-interface-ipv6-address
26001           in: path
26002           description: IP address
26003           required: true
26004           type: string
26005           example: __L3-INTERFACE-IPV6-ADDRESS__
26006         - name: resource-version
26007           in: query
26008           description: resource-version for concurrency
26009           required: true
26010           type: string
26011   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26012     get:
26013       tags:
26014         - Network
26015       summary: returns l-interface
26016       description: returns l-interface
26017       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26018       produces:
26019         - application/json
26020         - application/xml
26021       responses:
26022         "200":
26023           description: successful operation
26024           schema:
26025               $ref: "#/getDefinitions/l-interface"
26026         "default":
26027           description: Response codes found in [response codes](https://wiki.onap.org/).
26028       parameters:
26029         - name: equipment-name
26030           in: path
26031           required: true
26032           type: string
26033           example: __EQUIPMENT-NAME__
26034         - name: interface-name
26035           in: path
26036           description: Name that identifies the link aggregate interface
26037           required: true
26038           type: string
26039           example: __INTERFACE-NAME__
26040         - name: interface-name
26041           in: path
26042           description: Name given to the interface
26043           required: true
26044           type: string
26045           example: __INTERFACE-NAME__
26046     put:
26047       tags:
26048         - Network
26049       summary: create or update an existing l-interface
26050       description: |
26051         Create or update an existing l-interface.
26052         #
26053         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26054       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26055       consumes:
26056         - application/json
26057         - application/xml
26058       produces:
26059         - application/json
26060         - application/xml
26061       responses:
26062         "default":
26063           description: Response codes found in [response codes](https://wiki.onap.org/).
26064       parameters:
26065         - name: equipment-name
26066           in: path
26067           required: true
26068           type: string
26069           example: __EQUIPMENT-NAME__
26070         - name: interface-name
26071           in: path
26072           description: Name that identifies the link aggregate interface
26073           required: true
26074           type: string
26075           example: __INTERFACE-NAME__
26076         - name: interface-name
26077           in: path
26078           description: Name given to the interface
26079           required: true
26080           type: string
26081           example: __INTERFACE-NAME__
26082         - name: body
26083           in: body
26084           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26085           required: true
26086           schema:
26087             $ref: "#/definitions/l-interface"
26088     patch:
26089       tags:
26090         - Network
26091       summary: update an existing l-interface
26092       description: |
26093         Update an existing l-interface
26094         #
26095         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26096         The PUT operation will entirely replace an existing object.
26097         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26098         #
26099         Other differences between PUT and PATCH are:
26100         #
26101         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26102         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26103         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26104       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26105       consumes:
26106         - application/json
26107         - application/xml
26108       produces:
26109         - application/json
26110         - application/xml
26111       responses:
26112         "default":
26113           description: Response codes found in [response codes](https://wiki.onap.org/).
26114       parameters:
26115         - name: equipment-name
26116           in: path
26117           required: true
26118           type: string
26119           example: __EQUIPMENT-NAME__
26120         - name: interface-name
26121           in: path
26122           description: Name that identifies the link aggregate interface
26123           required: true
26124           type: string
26125           example: __INTERFACE-NAME__
26126         - name: interface-name
26127           in: path
26128           description: Name given to the interface
26129           required: true
26130           type: string
26131           example: __INTERFACE-NAME__
26132         - name: body
26133           in: body
26134           description: l-interface object that needs to be updated.
26135           required: true
26136           schema:
26137             $ref: "#/patchDefinitions/l-interface"
26138     delete:
26139       tags:
26140         - Network
26141       summary: delete an existing l-interface
26142       description: delete an existing l-interface
26143       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26144       consumes:
26145         - application/json
26146         - application/xml
26147       produces:
26148         - application/json
26149         - application/xml
26150       responses:
26151         "default":
26152           description: Response codes found in [response codes](https://wiki.onap.org/).
26153       parameters:
26154         - name: equipment-name
26155           in: path
26156           required: true
26157           type: string
26158           example: __EQUIPMENT-NAME__
26159         - name: interface-name
26160           in: path
26161           description: Name that identifies the link aggregate interface
26162           required: true
26163           type: string
26164           example: __INTERFACE-NAME__
26165         - name: interface-name
26166           in: path
26167           description: Name given to the interface
26168           required: true
26169           type: string
26170           example: __INTERFACE-NAME__
26171         - name: resource-version
26172           in: query
26173           description: resource-version for concurrency
26174           required: true
26175           type: string
26176   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26177     get:
26178       tags:
26179         - Network
26180       summary: returns l-interfaces
26181       description: returns l-interfaces
26182       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26183       produces:
26184         - application/json
26185         - application/xml
26186       responses:
26187         "200":
26188           description: successful operation
26189           schema:
26190               $ref: "#/getDefinitions/l-interfaces"
26191         "default":
26192           description: Response codes found in [response codes](https://wiki.onap.org/).
26193       parameters:
26194         - name: equipment-name
26195           in: path
26196           required: true
26197           type: string
26198           example: __EQUIPMENT-NAME__
26199         - name: interface-name
26200           in: path
26201           description: Name that identifies the link aggregate interface
26202           required: true
26203           type: string
26204           example: __INTERFACE-NAME__
26205         - name: interface-name
26206           in: query
26207           description:
26208           required: false
26209           type: string
26210         - name: interface-id
26211           in: query
26212           description:
26213           required: false
26214           type: string
26215         - name: macaddr
26216           in: query
26217           description:
26218           required: false
26219           type: string
26220         - name: network-name
26221           in: query
26222           description:
26223           required: false
26224           type: string
26225   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
26226     get:
26227       tags:
26228         - Network
26229       summary: returns lag-interface
26230       description: returns lag-interface
26231       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
26232       produces:
26233         - application/json
26234         - application/xml
26235       responses:
26236         "200":
26237           description: successful operation
26238           schema:
26239               $ref: "#/getDefinitions/lag-interface"
26240         "default":
26241           description: Response codes found in [response codes](https://wiki.onap.org/).
26242       parameters:
26243         - name: equipment-name
26244           in: path
26245           required: true
26246           type: string
26247           example: __EQUIPMENT-NAME__
26248         - name: interface-name
26249           in: path
26250           description: Name that identifies the link aggregate interface
26251           required: true
26252           type: string
26253           example: __INTERFACE-NAME__
26254     put:
26255       tags:
26256         - Network
26257       summary: create or update an existing lag-interface
26258       description: |
26259         Create or update an existing lag-interface.
26260         #
26261         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26262       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26263       consumes:
26264         - application/json
26265         - application/xml
26266       produces:
26267         - application/json
26268         - application/xml
26269       responses:
26270         "default":
26271           description: Response codes found in [response codes](https://wiki.onap.org/).
26272       parameters:
26273         - name: equipment-name
26274           in: path
26275           required: true
26276           type: string
26277           example: __EQUIPMENT-NAME__
26278         - name: interface-name
26279           in: path
26280           description: Name that identifies the link aggregate interface
26281           required: true
26282           type: string
26283           example: __INTERFACE-NAME__
26284         - name: body
26285           in: body
26286           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26287           required: true
26288           schema:
26289             $ref: "#/definitions/lag-interface"
26290     patch:
26291       tags:
26292         - Network
26293       summary: update an existing lag-interface
26294       description: |
26295         Update an existing lag-interface
26296         #
26297         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26298         The PUT operation will entirely replace an existing object.
26299         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26300         #
26301         Other differences between PUT and PATCH are:
26302         #
26303         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26304         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26305         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26306       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26307       consumes:
26308         - application/json
26309         - application/xml
26310       produces:
26311         - application/json
26312         - application/xml
26313       responses:
26314         "default":
26315           description: Response codes found in [response codes](https://wiki.onap.org/).
26316       parameters:
26317         - name: equipment-name
26318           in: path
26319           required: true
26320           type: string
26321           example: __EQUIPMENT-NAME__
26322         - name: interface-name
26323           in: path
26324           description: Name that identifies the link aggregate interface
26325           required: true
26326           type: string
26327           example: __INTERFACE-NAME__
26328         - name: body
26329           in: body
26330           description: lag-interface object that needs to be updated.
26331           required: true
26332           schema:
26333             $ref: "#/patchDefinitions/lag-interface"
26334     delete:
26335       tags:
26336         - Network
26337       summary: delete an existing lag-interface
26338       description: delete an existing lag-interface
26339       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
26340       consumes:
26341         - application/json
26342         - application/xml
26343       produces:
26344         - application/json
26345         - application/xml
26346       responses:
26347         "default":
26348           description: Response codes found in [response codes](https://wiki.onap.org/).
26349       parameters:
26350         - name: equipment-name
26351           in: path
26352           required: true
26353           type: string
26354           example: __EQUIPMENT-NAME__
26355         - name: interface-name
26356           in: path
26357           description: Name that identifies the link aggregate interface
26358           required: true
26359           type: string
26360           example: __INTERFACE-NAME__
26361         - name: resource-version
26362           in: query
26363           description: resource-version for concurrency
26364           required: true
26365           type: string
26366   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
26367     get:
26368       tags:
26369         - Network
26370       summary: returns lag-interfaces
26371       description: returns lag-interfaces
26372       operationId: getNetworkVplsPesVplsPeLagInterfaces
26373       produces:
26374         - application/json
26375         - application/xml
26376       responses:
26377         "200":
26378           description: successful operation
26379           schema:
26380               $ref: "#/getDefinitions/lag-interfaces"
26381         "default":
26382           description: Response codes found in [response codes](https://wiki.onap.org/).
26383       parameters:
26384         - name: equipment-name
26385           in: path
26386           required: true
26387           type: string
26388           example: __EQUIPMENT-NAME__
26389         - name: interface-name
26390           in: query
26391           description:
26392           required: false
26393           type: string
26394         - name: interface-id
26395           in: query
26396           description:
26397           required: false
26398           type: string
26399         - name: interface-role
26400           in: query
26401           description:
26402           required: false
26403           type: string
26404   /network/vpls-pes/vpls-pe/{equipment-name}:
26405     get:
26406       tags:
26407         - Network
26408       summary: returns vpls-pe
26409       description: returns vpls-pe
26410       operationId: getNetworkVplsPesVplsPe
26411       produces:
26412         - application/json
26413         - application/xml
26414       responses:
26415         "200":
26416           description: successful operation
26417           schema:
26418               $ref: "#/getDefinitions/vpls-pe"
26419         "default":
26420           description: Response codes found in [response codes](https://wiki.onap.org/).
26421       parameters:
26422         - name: equipment-name
26423           in: path
26424           required: true
26425           type: string
26426           example: __EQUIPMENT-NAME__
26427     put:
26428       tags:
26429         - Network
26430       summary: create or update an existing vpls-pe
26431       description: |
26432         Create or update an existing vpls-pe.
26433         #
26434         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26435       operationId: createOrUpdateNetworkVplsPesVplsPe
26436       consumes:
26437         - application/json
26438         - application/xml
26439       produces:
26440         - application/json
26441         - application/xml
26442       responses:
26443         "default":
26444           description: Response codes found in [response codes](https://wiki.onap.org/).
26445       parameters:
26446         - name: equipment-name
26447           in: path
26448           required: true
26449           type: string
26450           example: __EQUIPMENT-NAME__
26451         - name: body
26452           in: body
26453           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
26454           required: true
26455           schema:
26456             $ref: "#/definitions/vpls-pe"
26457     patch:
26458       tags:
26459         - Network
26460       summary: update an existing vpls-pe
26461       description: |
26462         Update an existing vpls-pe
26463         #
26464         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26465         The PUT operation will entirely replace an existing object.
26466         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26467         #
26468         Other differences between PUT and PATCH are:
26469         #
26470         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26471         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26472         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26473       operationId: UpdateNetworkVplsPesVplsPe
26474       consumes:
26475         - application/json
26476         - application/xml
26477       produces:
26478         - application/json
26479         - application/xml
26480       responses:
26481         "default":
26482           description: Response codes found in [response codes](https://wiki.onap.org/).
26483       parameters:
26484         - name: equipment-name
26485           in: path
26486           required: true
26487           type: string
26488           example: __EQUIPMENT-NAME__
26489         - name: body
26490           in: body
26491           description: vpls-pe object that needs to be updated.
26492           required: true
26493           schema:
26494             $ref: "#/patchDefinitions/vpls-pe"
26495     delete:
26496       tags:
26497         - Network
26498       summary: delete an existing vpls-pe
26499       description: delete an existing vpls-pe
26500       operationId: deleteNetworkVplsPesVplsPe
26501       consumes:
26502         - application/json
26503         - application/xml
26504       produces:
26505         - application/json
26506         - application/xml
26507       responses:
26508         "default":
26509           description: Response codes found in [response codes](https://wiki.onap.org/).
26510       parameters:
26511         - name: equipment-name
26512           in: path
26513           required: true
26514           type: string
26515           example: __EQUIPMENT-NAME__
26516         - name: resource-version
26517           in: query
26518           description: resource-version for concurrency
26519           required: true
26520           type: string
26521   /network/vpls-pes:
26522     get:
26523       tags:
26524         - Network
26525       summary: returns vpls-pes
26526       description: returns vpls-pes
26527       operationId: getNetworkVplsPes
26528       produces:
26529         - application/json
26530         - application/xml
26531       responses:
26532         "200":
26533           description: successful operation
26534           schema:
26535               $ref: "#/getDefinitions/vpls-pes"
26536         "default":
26537           description: Response codes found in [response codes](https://wiki.onap.org/).
26538       parameters:
26539         - name: equipment-name
26540           in: query
26541           description:
26542           required: false
26543           type: string
26544         - name: prov-status
26545           in: query
26546           description:
26547           required: false
26548           type: string
26549   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
26550     put:
26551       tags:
26552         - Network
26553       summary: see node definition for valid relationships
26554       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
26555       consumes:
26556         - application/json
26557         - application/xml
26558       produces:
26559         - application/json
26560         - application/xml
26561       responses:
26562         "default":
26563           description: Response codes found in [response codes](https://wiki.onap.org/).
26564       parameters:
26565         - name: multicast-configuration-id
26566           in: path
26567           description: Unique id of multicast configuration.
26568           required: true
26569           type: string
26570           example: __MULTICAST-CONFIGURATION-ID__
26571         - name: body
26572           in: body
26573           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
26574           required: true
26575           schema:
26576             $ref: "#/definitions/relationship"
26577     delete:
26578       tags:
26579         - Network
26580       summary: delete an existing relationship
26581       description: delete an existing relationship
26582       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
26583       consumes:
26584         - application/json
26585         - application/xml
26586       produces:
26587         - application/json
26588         - application/xml
26589       responses:
26590         "default":
26591           description: Response codes found in [response codes](https://wiki.onap.org/).
26592       parameters:
26593         - name: multicast-configuration-id
26594           in: path
26595           description: Unique id of multicast configuration.
26596           required: true
26597           type: string
26598           example: __MULTICAST-CONFIGURATION-ID__
26599   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
26600     get:
26601       tags:
26602         - Network
26603       summary: returns multicast-configuration
26604       description: returns multicast-configuration
26605       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
26606       produces:
26607         - application/json
26608         - application/xml
26609       responses:
26610         "200":
26611           description: successful operation
26612           schema:
26613               $ref: "#/getDefinitions/multicast-configuration"
26614         "default":
26615           description: Response codes found in [response codes](https://wiki.onap.org/).
26616       parameters:
26617         - name: multicast-configuration-id
26618           in: path
26619           description: Unique id of multicast configuration.
26620           required: true
26621           type: string
26622           example: __MULTICAST-CONFIGURATION-ID__
26623     put:
26624       tags:
26625         - Network
26626       summary: create or update an existing multicast-configuration
26627       description: |
26628         Create or update an existing multicast-configuration.
26629         #
26630         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26631       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
26632       consumes:
26633         - application/json
26634         - application/xml
26635       produces:
26636         - application/json
26637         - application/xml
26638       responses:
26639         "default":
26640           description: Response codes found in [response codes](https://wiki.onap.org/).
26641       parameters:
26642         - name: multicast-configuration-id
26643           in: path
26644           description: Unique id of multicast configuration.
26645           required: true
26646           type: string
26647           example: __MULTICAST-CONFIGURATION-ID__
26648         - name: body
26649           in: body
26650           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
26651           required: true
26652           schema:
26653             $ref: "#/definitions/multicast-configuration"
26654     patch:
26655       tags:
26656         - Network
26657       summary: update an existing multicast-configuration
26658       description: |
26659         Update an existing multicast-configuration
26660         #
26661         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26662         The PUT operation will entirely replace an existing object.
26663         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26664         #
26665         Other differences between PUT and PATCH are:
26666         #
26667         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26668         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26669         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26670       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
26671       consumes:
26672         - application/json
26673         - application/xml
26674       produces:
26675         - application/json
26676         - application/xml
26677       responses:
26678         "default":
26679           description: Response codes found in [response codes](https://wiki.onap.org/).
26680       parameters:
26681         - name: multicast-configuration-id
26682           in: path
26683           description: Unique id of multicast configuration.
26684           required: true
26685           type: string
26686           example: __MULTICAST-CONFIGURATION-ID__
26687         - name: body
26688           in: body
26689           description: multicast-configuration object that needs to be updated.
26690           required: true
26691           schema:
26692             $ref: "#/patchDefinitions/multicast-configuration"
26693     delete:
26694       tags:
26695         - Network
26696       summary: delete an existing multicast-configuration
26697       description: delete an existing multicast-configuration
26698       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
26699       consumes:
26700         - application/json
26701         - application/xml
26702       produces:
26703         - application/json
26704         - application/xml
26705       responses:
26706         "default":
26707           description: Response codes found in [response codes](https://wiki.onap.org/).
26708       parameters:
26709         - name: multicast-configuration-id
26710           in: path
26711           description: Unique id of multicast configuration.
26712           required: true
26713           type: string
26714           example: __MULTICAST-CONFIGURATION-ID__
26715         - name: resource-version
26716           in: query
26717           description: resource-version for concurrency
26718           required: true
26719           type: string
26720   /network/multicast-configurations:
26721     get:
26722       tags:
26723         - Network
26724       summary: returns multicast-configurations
26725       description: returns multicast-configurations
26726       operationId: getNetworkMulticastConfigurations
26727       produces:
26728         - application/json
26729         - application/xml
26730       responses:
26731         "200":
26732           description: successful operation
26733           schema:
26734               $ref: "#/getDefinitions/multicast-configurations"
26735         "default":
26736           description: Response codes found in [response codes](https://wiki.onap.org/).
26737       parameters:
26738         - name: multicast-configuration-id
26739           in: query
26740           description:
26741           required: false
26742           type: string
26743   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
26744     put:
26745       tags:
26746         - Network
26747       summary: see node definition for valid relationships
26748       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
26749       consumes:
26750         - application/json
26751         - application/xml
26752       produces:
26753         - application/json
26754         - application/xml
26755       responses:
26756         "default":
26757           description: Response codes found in [response codes](https://wiki.onap.org/).
26758       parameters:
26759         - name: vnf-id
26760           in: path
26761           description: Unique id of VNF.  This is unique across the graph.
26762           required: true
26763           type: string
26764           example: __VNF-ID__
26765         - name: interface-id
26766           in: path
26767           description: Unique ID of the interface
26768           required: true
26769           type: string
26770           example: __INTERFACE-ID__
26771         - name: cvlan-tag
26772           in: path
26773           description: See mis-na-virtualization-platform.yang
26774           required: true
26775           type: integer
26776           format: int64
26777           example: __CVLAN-TAG__
26778         - name: body
26779           in: body
26780           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
26781           required: true
26782           schema:
26783             $ref: "#/definitions/relationship"
26784     delete:
26785       tags:
26786         - Network
26787       summary: delete an existing relationship
26788       description: delete an existing relationship
26789       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
26790       consumes:
26791         - application/json
26792         - application/xml
26793       produces:
26794         - application/json
26795         - application/xml
26796       responses:
26797         "default":
26798           description: Response codes found in [response codes](https://wiki.onap.org/).
26799       parameters:
26800         - name: vnf-id
26801           in: path
26802           description: Unique id of VNF.  This is unique across the graph.
26803           required: true
26804           type: string
26805           example: __VNF-ID__
26806         - name: interface-id
26807           in: path
26808           description: Unique ID of the interface
26809           required: true
26810           type: string
26811           example: __INTERFACE-ID__
26812         - name: cvlan-tag
26813           in: path
26814           description: See mis-na-virtualization-platform.yang
26815           required: true
26816           type: integer
26817           format: int64
26818           example: __CVLAN-TAG__
26819   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
26820     get:
26821       tags:
26822         - Network
26823       summary: returns cvlan-tag-entry
26824       description: returns cvlan-tag-entry
26825       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26826       produces:
26827         - application/json
26828         - application/xml
26829       responses:
26830         "200":
26831           description: successful operation
26832           schema:
26833               $ref: "#/getDefinitions/cvlan-tag-entry"
26834         "default":
26835           description: Response codes found in [response codes](https://wiki.onap.org/).
26836       parameters:
26837         - name: vnf-id
26838           in: path
26839           description: Unique id of VNF.  This is unique across the graph.
26840           required: true
26841           type: string
26842           example: __VNF-ID__
26843         - name: interface-id
26844           in: path
26845           description: Unique ID of the interface
26846           required: true
26847           type: string
26848           example: __INTERFACE-ID__
26849         - name: cvlan-tag
26850           in: path
26851           description: See mis-na-virtualization-platform.yang
26852           required: true
26853           type: integer
26854           format: int64
26855           example: __CVLAN-TAG__
26856     put:
26857       tags:
26858         - Network
26859       summary: create or update an existing cvlan-tag-entry
26860       description: |
26861         Create or update an existing cvlan-tag-entry.
26862         #
26863         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26864       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26865       consumes:
26866         - application/json
26867         - application/xml
26868       produces:
26869         - application/json
26870         - application/xml
26871       responses:
26872         "default":
26873           description: Response codes found in [response codes](https://wiki.onap.org/).
26874       parameters:
26875         - name: vnf-id
26876           in: path
26877           description: Unique id of VNF.  This is unique across the graph.
26878           required: true
26879           type: string
26880           example: __VNF-ID__
26881         - name: interface-id
26882           in: path
26883           description: Unique ID of the interface
26884           required: true
26885           type: string
26886           example: __INTERFACE-ID__
26887         - name: cvlan-tag
26888           in: path
26889           description: See mis-na-virtualization-platform.yang
26890           required: true
26891           type: integer
26892           format: int64
26893           example: __CVLAN-TAG__
26894         - name: body
26895           in: body
26896           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
26897           required: true
26898           schema:
26899             $ref: "#/definitions/cvlan-tag-entry"
26900     patch:
26901       tags:
26902         - Network
26903       summary: update an existing cvlan-tag-entry
26904       description: |
26905         Update an existing cvlan-tag-entry
26906         #
26907         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26908         The PUT operation will entirely replace an existing object.
26909         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26910         #
26911         Other differences between PUT and PATCH are:
26912         #
26913         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26914         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26915         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26916       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26917       consumes:
26918         - application/json
26919         - application/xml
26920       produces:
26921         - application/json
26922         - application/xml
26923       responses:
26924         "default":
26925           description: Response codes found in [response codes](https://wiki.onap.org/).
26926       parameters:
26927         - name: vnf-id
26928           in: path
26929           description: Unique id of VNF.  This is unique across the graph.
26930           required: true
26931           type: string
26932           example: __VNF-ID__
26933         - name: interface-id
26934           in: path
26935           description: Unique ID of the interface
26936           required: true
26937           type: string
26938           example: __INTERFACE-ID__
26939         - name: cvlan-tag
26940           in: path
26941           description: See mis-na-virtualization-platform.yang
26942           required: true
26943           type: integer
26944           format: int64
26945           example: __CVLAN-TAG__
26946         - name: body
26947           in: body
26948           description: cvlan-tag-entry object that needs to be updated.
26949           required: true
26950           schema:
26951             $ref: "#/patchDefinitions/cvlan-tag-entry"
26952     delete:
26953       tags:
26954         - Network
26955       summary: delete an existing cvlan-tag-entry
26956       description: delete an existing cvlan-tag-entry
26957       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26958       consumes:
26959         - application/json
26960         - application/xml
26961       produces:
26962         - application/json
26963         - application/xml
26964       responses:
26965         "default":
26966           description: Response codes found in [response codes](https://wiki.onap.org/).
26967       parameters:
26968         - name: vnf-id
26969           in: path
26970           description: Unique id of VNF.  This is unique across the graph.
26971           required: true
26972           type: string
26973           example: __VNF-ID__
26974         - name: interface-id
26975           in: path
26976           description: Unique ID of the interface
26977           required: true
26978           type: string
26979           example: __INTERFACE-ID__
26980         - name: cvlan-tag
26981           in: path
26982           description: See mis-na-virtualization-platform.yang
26983           required: true
26984           type: integer
26985           format: int64
26986           example: __CVLAN-TAG__
26987         - name: resource-version
26988           in: query
26989           description: resource-version for concurrency
26990           required: true
26991           type: string
26992   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
26993     get:
26994       tags:
26995         - Network
26996       summary: returns cvlan-tags
26997       description: returns cvlan-tags
26998       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
26999       produces:
27000         - application/json
27001         - application/xml
27002       responses:
27003         "200":
27004           description: successful operation
27005           schema:
27006               $ref: "#/getDefinitions/cvlan-tags"
27007         "default":
27008           description: Response codes found in [response codes](https://wiki.onap.org/).
27009       parameters:
27010         - name: vnf-id
27011           in: path
27012           description: Unique id of VNF.  This is unique across the graph.
27013           required: true
27014           type: string
27015           example: __VNF-ID__
27016         - name: interface-id
27017           in: path
27018           description: Unique ID of the interface
27019           required: true
27020           type: string
27021           example: __INTERFACE-ID__
27022         - name: cvlan-tag
27023           in: query
27024           description:
27025           required: false
27026           type: integer
27027           format: int64
27028   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27029     put:
27030       tags:
27031         - Network
27032       summary: see node definition for valid relationships
27033       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27034       consumes:
27035         - application/json
27036         - application/xml
27037       produces:
27038         - application/json
27039         - application/xml
27040       responses:
27041         "default":
27042           description: Response codes found in [response codes](https://wiki.onap.org/).
27043       parameters:
27044         - name: vnf-id
27045           in: path
27046           description: Unique id of VNF.  This is unique across the graph.
27047           required: true
27048           type: string
27049           example: __VNF-ID__
27050         - name: interface-id
27051           in: path
27052           description: Unique ID of the interface
27053           required: true
27054           type: string
27055           example: __INTERFACE-ID__
27056         - name: body
27057           in: body
27058           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
27059           required: true
27060           schema:
27061             $ref: "#/definitions/relationship"
27062     delete:
27063       tags:
27064         - Network
27065       summary: delete an existing relationship
27066       description: delete an existing relationship
27067       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27068       consumes:
27069         - application/json
27070         - application/xml
27071       produces:
27072         - application/json
27073         - application/xml
27074       responses:
27075         "default":
27076           description: Response codes found in [response codes](https://wiki.onap.org/).
27077       parameters:
27078         - name: vnf-id
27079           in: path
27080           description: Unique id of VNF.  This is unique across the graph.
27081           required: true
27082           type: string
27083           example: __VNF-ID__
27084         - name: interface-id
27085           in: path
27086           description: Unique ID of the interface
27087           required: true
27088           type: string
27089           example: __INTERFACE-ID__
27090   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27091     get:
27092       tags:
27093         - Network
27094       summary: returns port-group
27095       description: returns port-group
27096       operationId: getNetworkVcesVcePortGroupsPortGroup
27097       produces:
27098         - application/json
27099         - application/xml
27100       responses:
27101         "200":
27102           description: successful operation
27103           schema:
27104               $ref: "#/getDefinitions/port-group"
27105         "default":
27106           description: Response codes found in [response codes](https://wiki.onap.org/).
27107       parameters:
27108         - name: vnf-id
27109           in: path
27110           description: Unique id of VNF.  This is unique across the graph.
27111           required: true
27112           type: string
27113           example: __VNF-ID__
27114         - name: interface-id
27115           in: path
27116           description: Unique ID of the interface
27117           required: true
27118           type: string
27119           example: __INTERFACE-ID__
27120     put:
27121       tags:
27122         - Network
27123       summary: create or update an existing port-group
27124       description: |
27125         Create or update an existing port-group.
27126         #
27127         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27128       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
27129       consumes:
27130         - application/json
27131         - application/xml
27132       produces:
27133         - application/json
27134         - application/xml
27135       responses:
27136         "default":
27137           description: Response codes found in [response codes](https://wiki.onap.org/).
27138       parameters:
27139         - name: vnf-id
27140           in: path
27141           description: Unique id of VNF.  This is unique across the graph.
27142           required: true
27143           type: string
27144           example: __VNF-ID__
27145         - name: interface-id
27146           in: path
27147           description: Unique ID of the interface
27148           required: true
27149           type: string
27150           example: __INTERFACE-ID__
27151         - name: body
27152           in: body
27153           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
27154           required: true
27155           schema:
27156             $ref: "#/definitions/port-group"
27157     patch:
27158       tags:
27159         - Network
27160       summary: update an existing port-group
27161       description: |
27162         Update an existing port-group
27163         #
27164         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27165         The PUT operation will entirely replace an existing object.
27166         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27167         #
27168         Other differences between PUT and PATCH are:
27169         #
27170         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27171         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27172         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27173       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
27174       consumes:
27175         - application/json
27176         - application/xml
27177       produces:
27178         - application/json
27179         - application/xml
27180       responses:
27181         "default":
27182           description: Response codes found in [response codes](https://wiki.onap.org/).
27183       parameters:
27184         - name: vnf-id
27185           in: path
27186           description: Unique id of VNF.  This is unique across the graph.
27187           required: true
27188           type: string
27189           example: __VNF-ID__
27190         - name: interface-id
27191           in: path
27192           description: Unique ID of the interface
27193           required: true
27194           type: string
27195           example: __INTERFACE-ID__
27196         - name: body
27197           in: body
27198           description: port-group object that needs to be updated.
27199           required: true
27200           schema:
27201             $ref: "#/patchDefinitions/port-group"
27202     delete:
27203       tags:
27204         - Network
27205       summary: delete an existing port-group
27206       description: delete an existing port-group
27207       operationId: deleteNetworkVcesVcePortGroupsPortGroup
27208       consumes:
27209         - application/json
27210         - application/xml
27211       produces:
27212         - application/json
27213         - application/xml
27214       responses:
27215         "default":
27216           description: Response codes found in [response codes](https://wiki.onap.org/).
27217       parameters:
27218         - name: vnf-id
27219           in: path
27220           description: Unique id of VNF.  This is unique across the graph.
27221           required: true
27222           type: string
27223           example: __VNF-ID__
27224         - name: interface-id
27225           in: path
27226           description: Unique ID of the interface
27227           required: true
27228           type: string
27229           example: __INTERFACE-ID__
27230         - name: resource-version
27231           in: query
27232           description: resource-version for concurrency
27233           required: true
27234           type: string
27235   /network/vces/vce/{vnf-id}/port-groups:
27236     get:
27237       tags:
27238         - Network
27239       summary: returns port-groups
27240       description: returns port-groups
27241       operationId: getNetworkVcesVcePortGroups
27242       produces:
27243         - application/json
27244         - application/xml
27245       responses:
27246         "200":
27247           description: successful operation
27248           schema:
27249               $ref: "#/getDefinitions/port-groups"
27250         "default":
27251           description: Response codes found in [response codes](https://wiki.onap.org/).
27252       parameters:
27253         - name: vnf-id
27254           in: path
27255           description: Unique id of VNF.  This is unique across the graph.
27256           required: true
27257           type: string
27258           example: __VNF-ID__
27259         - name: interface-id
27260           in: query
27261           description:
27262           required: false
27263           type: string
27264         - name: port-group-id
27265           in: query
27266           description:
27267           required: false
27268           type: string
27269         - name: switch-name
27270           in: query
27271           description:
27272           required: false
27273           type: string
27274         - name: heat-stack-id
27275           in: query
27276           description:
27277           required: false
27278           type: string
27279   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27280     put:
27281       tags:
27282         - Network
27283       summary: see node definition for valid relationships
27284       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
27285       consumes:
27286         - application/json
27287         - application/xml
27288       produces:
27289         - application/json
27290         - application/xml
27291       responses:
27292         "default":
27293           description: Response codes found in [response codes](https://wiki.onap.org/).
27294       parameters:
27295         - name: vnf-id
27296           in: path
27297           description: Unique id of VNF.  This is unique across the graph.
27298           required: true
27299           type: string
27300           example: __VNF-ID__
27301         - name: group-uuid
27302           in: path
27303           description: Unique ID for the license group the resource belongs to, should be uuid.
27304           required: true
27305           type: string
27306           example: __GROUP-UUID__
27307         - name: resource-uuid
27308           in: path
27309           description: Unique ID of a license resource.
27310           required: true
27311           type: string
27312           example: __RESOURCE-UUID__
27313         - name: body
27314           in: body
27315           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
27316           required: true
27317           schema:
27318             $ref: "#/definitions/relationship"
27319     delete:
27320       tags:
27321         - Network
27322       summary: delete an existing relationship
27323       description: delete an existing relationship
27324       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
27325       consumes:
27326         - application/json
27327         - application/xml
27328       produces:
27329         - application/json
27330         - application/xml
27331       responses:
27332         "default":
27333           description: Response codes found in [response codes](https://wiki.onap.org/).
27334       parameters:
27335         - name: vnf-id
27336           in: path
27337           description: Unique id of VNF.  This is unique across the graph.
27338           required: true
27339           type: string
27340           example: __VNF-ID__
27341         - name: group-uuid
27342           in: path
27343           description: Unique ID for the license group the resource belongs to, should be uuid.
27344           required: true
27345           type: string
27346           example: __GROUP-UUID__
27347         - name: resource-uuid
27348           in: path
27349           description: Unique ID of a license resource.
27350           required: true
27351           type: string
27352           example: __RESOURCE-UUID__
27353   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
27354     get:
27355       tags:
27356         - Network
27357       summary: returns license
27358       description: returns license
27359       operationId: getNetworkVcesVceLicensesLicense
27360       produces:
27361         - application/json
27362         - application/xml
27363       responses:
27364         "200":
27365           description: successful operation
27366           schema:
27367               $ref: "#/getDefinitions/license"
27368         "default":
27369           description: Response codes found in [response codes](https://wiki.onap.org/).
27370       parameters:
27371         - name: vnf-id
27372           in: path
27373           description: Unique id of VNF.  This is unique across the graph.
27374           required: true
27375           type: string
27376           example: __VNF-ID__
27377         - name: group-uuid
27378           in: path
27379           description: Unique ID for the license group the resource belongs to, should be uuid.
27380           required: true
27381           type: string
27382           example: __GROUP-UUID__
27383         - name: resource-uuid
27384           in: path
27385           description: Unique ID of a license resource.
27386           required: true
27387           type: string
27388           example: __RESOURCE-UUID__
27389     put:
27390       tags:
27391         - Network
27392       summary: create or update an existing license
27393       description: |
27394         Create or update an existing license.
27395         #
27396         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27397       operationId: createOrUpdateNetworkVcesVceLicensesLicense
27398       consumes:
27399         - application/json
27400         - application/xml
27401       produces:
27402         - application/json
27403         - application/xml
27404       responses:
27405         "default":
27406           description: Response codes found in [response codes](https://wiki.onap.org/).
27407       parameters:
27408         - name: vnf-id
27409           in: path
27410           description: Unique id of VNF.  This is unique across the graph.
27411           required: true
27412           type: string
27413           example: __VNF-ID__
27414         - name: group-uuid
27415           in: path
27416           description: Unique ID for the license group the resource belongs to, should be uuid.
27417           required: true
27418           type: string
27419           example: __GROUP-UUID__
27420         - name: resource-uuid
27421           in: path
27422           description: Unique ID of a license resource.
27423           required: true
27424           type: string
27425           example: __RESOURCE-UUID__
27426         - name: body
27427           in: body
27428           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
27429           required: true
27430           schema:
27431             $ref: "#/definitions/license"
27432     patch:
27433       tags:
27434         - Network
27435       summary: update an existing license
27436       description: |
27437         Update an existing license
27438         #
27439         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27440         The PUT operation will entirely replace an existing object.
27441         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27442         #
27443         Other differences between PUT and PATCH are:
27444         #
27445         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27446         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27447         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27448       operationId: UpdateNetworkVcesVceLicensesLicense
27449       consumes:
27450         - application/json
27451         - application/xml
27452       produces:
27453         - application/json
27454         - application/xml
27455       responses:
27456         "default":
27457           description: Response codes found in [response codes](https://wiki.onap.org/).
27458       parameters:
27459         - name: vnf-id
27460           in: path
27461           description: Unique id of VNF.  This is unique across the graph.
27462           required: true
27463           type: string
27464           example: __VNF-ID__
27465         - name: group-uuid
27466           in: path
27467           description: Unique ID for the license group the resource belongs to, should be uuid.
27468           required: true
27469           type: string
27470           example: __GROUP-UUID__
27471         - name: resource-uuid
27472           in: path
27473           description: Unique ID of a license resource.
27474           required: true
27475           type: string
27476           example: __RESOURCE-UUID__
27477         - name: body
27478           in: body
27479           description: license object that needs to be updated.
27480           required: true
27481           schema:
27482             $ref: "#/patchDefinitions/license"
27483     delete:
27484       tags:
27485         - Network
27486       summary: delete an existing license
27487       description: delete an existing license
27488       operationId: deleteNetworkVcesVceLicensesLicense
27489       consumes:
27490         - application/json
27491         - application/xml
27492       produces:
27493         - application/json
27494         - application/xml
27495       responses:
27496         "default":
27497           description: Response codes found in [response codes](https://wiki.onap.org/).
27498       parameters:
27499         - name: vnf-id
27500           in: path
27501           description: Unique id of VNF.  This is unique across the graph.
27502           required: true
27503           type: string
27504           example: __VNF-ID__
27505         - name: group-uuid
27506           in: path
27507           description: Unique ID for the license group the resource belongs to, should be uuid.
27508           required: true
27509           type: string
27510           example: __GROUP-UUID__
27511         - name: resource-uuid
27512           in: path
27513           description: Unique ID of a license resource.
27514           required: true
27515           type: string
27516           example: __RESOURCE-UUID__
27517         - name: resource-version
27518           in: query
27519           description: resource-version for concurrency
27520           required: true
27521           type: string
27522   /network/vces/vce/{vnf-id}/licenses:
27523     get:
27524       tags:
27525         - Network
27526       summary: returns licenses
27527       description: returns licenses
27528       operationId: getNetworkVcesVceLicenses
27529       produces:
27530         - application/json
27531         - application/xml
27532       responses:
27533         "200":
27534           description: successful operation
27535           schema:
27536               $ref: "#/getDefinitions/licenses"
27537         "default":
27538           description: Response codes found in [response codes](https://wiki.onap.org/).
27539       parameters:
27540         - name: vnf-id
27541           in: path
27542           description: Unique id of VNF.  This is unique across the graph.
27543           required: true
27544           type: string
27545           example: __VNF-ID__
27546         - name: group-uuid
27547           in: query
27548           description:
27549           required: false
27550           type: string
27551         - name: resource-uuid
27552           in: query
27553           description:
27554           required: false
27555           type: string
27556   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27557     put:
27558       tags:
27559         - Network
27560       summary: see node definition for valid relationships
27561       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
27562       consumes:
27563         - application/json
27564         - application/xml
27565       produces:
27566         - application/json
27567         - application/xml
27568       responses:
27569         "default":
27570           description: Response codes found in [response codes](https://wiki.onap.org/).
27571       parameters:
27572         - name: vnf-id
27573           in: path
27574           description: Unique id of VNF.  This is unique across the graph.
27575           required: true
27576           type: string
27577           example: __VNF-ID__
27578         - name: group-uuid
27579           in: path
27580           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27581           required: true
27582           type: string
27583           example: __GROUP-UUID__
27584         - name: resource-uuid
27585           in: path
27586           description: Unique ID of an entitlement resource.
27587           required: true
27588           type: string
27589           example: __RESOURCE-UUID__
27590         - name: body
27591           in: body
27592           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
27593           required: true
27594           schema:
27595             $ref: "#/definitions/relationship"
27596     delete:
27597       tags:
27598         - Network
27599       summary: delete an existing relationship
27600       description: delete an existing relationship
27601       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
27602       consumes:
27603         - application/json
27604         - application/xml
27605       produces:
27606         - application/json
27607         - application/xml
27608       responses:
27609         "default":
27610           description: Response codes found in [response codes](https://wiki.onap.org/).
27611       parameters:
27612         - name: vnf-id
27613           in: path
27614           description: Unique id of VNF.  This is unique across the graph.
27615           required: true
27616           type: string
27617           example: __VNF-ID__
27618         - name: group-uuid
27619           in: path
27620           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27621           required: true
27622           type: string
27623           example: __GROUP-UUID__
27624         - name: resource-uuid
27625           in: path
27626           description: Unique ID of an entitlement resource.
27627           required: true
27628           type: string
27629           example: __RESOURCE-UUID__
27630   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
27631     get:
27632       tags:
27633         - Network
27634       summary: returns entitlement
27635       description: returns entitlement
27636       operationId: getNetworkVcesVceEntitlementsEntitlement
27637       produces:
27638         - application/json
27639         - application/xml
27640       responses:
27641         "200":
27642           description: successful operation
27643           schema:
27644               $ref: "#/getDefinitions/entitlement"
27645         "default":
27646           description: Response codes found in [response codes](https://wiki.onap.org/).
27647       parameters:
27648         - name: vnf-id
27649           in: path
27650           description: Unique id of VNF.  This is unique across the graph.
27651           required: true
27652           type: string
27653           example: __VNF-ID__
27654         - name: group-uuid
27655           in: path
27656           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27657           required: true
27658           type: string
27659           example: __GROUP-UUID__
27660         - name: resource-uuid
27661           in: path
27662           description: Unique ID of an entitlement resource.
27663           required: true
27664           type: string
27665           example: __RESOURCE-UUID__
27666     put:
27667       tags:
27668         - Network
27669       summary: create or update an existing entitlement
27670       description: |
27671         Create or update an existing entitlement.
27672         #
27673         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27674       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
27675       consumes:
27676         - application/json
27677         - application/xml
27678       produces:
27679         - application/json
27680         - application/xml
27681       responses:
27682         "default":
27683           description: Response codes found in [response codes](https://wiki.onap.org/).
27684       parameters:
27685         - name: vnf-id
27686           in: path
27687           description: Unique id of VNF.  This is unique across the graph.
27688           required: true
27689           type: string
27690           example: __VNF-ID__
27691         - name: group-uuid
27692           in: path
27693           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27694           required: true
27695           type: string
27696           example: __GROUP-UUID__
27697         - name: resource-uuid
27698           in: path
27699           description: Unique ID of an entitlement resource.
27700           required: true
27701           type: string
27702           example: __RESOURCE-UUID__
27703         - name: body
27704           in: body
27705           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
27706           required: true
27707           schema:
27708             $ref: "#/definitions/entitlement"
27709     patch:
27710       tags:
27711         - Network
27712       summary: update an existing entitlement
27713       description: |
27714         Update an existing entitlement
27715         #
27716         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27717         The PUT operation will entirely replace an existing object.
27718         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27719         #
27720         Other differences between PUT and PATCH are:
27721         #
27722         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27723         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27724         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27725       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
27726       consumes:
27727         - application/json
27728         - application/xml
27729       produces:
27730         - application/json
27731         - application/xml
27732       responses:
27733         "default":
27734           description: Response codes found in [response codes](https://wiki.onap.org/).
27735       parameters:
27736         - name: vnf-id
27737           in: path
27738           description: Unique id of VNF.  This is unique across the graph.
27739           required: true
27740           type: string
27741           example: __VNF-ID__
27742         - name: group-uuid
27743           in: path
27744           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27745           required: true
27746           type: string
27747           example: __GROUP-UUID__
27748         - name: resource-uuid
27749           in: path
27750           description: Unique ID of an entitlement resource.
27751           required: true
27752           type: string
27753           example: __RESOURCE-UUID__
27754         - name: body
27755           in: body
27756           description: entitlement object that needs to be updated.
27757           required: true
27758           schema:
27759             $ref: "#/patchDefinitions/entitlement"
27760     delete:
27761       tags:
27762         - Network
27763       summary: delete an existing entitlement
27764       description: delete an existing entitlement
27765       operationId: deleteNetworkVcesVceEntitlementsEntitlement
27766       consumes:
27767         - application/json
27768         - application/xml
27769       produces:
27770         - application/json
27771         - application/xml
27772       responses:
27773         "default":
27774           description: Response codes found in [response codes](https://wiki.onap.org/).
27775       parameters:
27776         - name: vnf-id
27777           in: path
27778           description: Unique id of VNF.  This is unique across the graph.
27779           required: true
27780           type: string
27781           example: __VNF-ID__
27782         - name: group-uuid
27783           in: path
27784           description: Unique ID for the entitlement group the resource comes from, should be uuid.
27785           required: true
27786           type: string
27787           example: __GROUP-UUID__
27788         - name: resource-uuid
27789           in: path
27790           description: Unique ID of an entitlement resource.
27791           required: true
27792           type: string
27793           example: __RESOURCE-UUID__
27794         - name: resource-version
27795           in: query
27796           description: resource-version for concurrency
27797           required: true
27798           type: string
27799   /network/vces/vce/{vnf-id}/entitlements:
27800     get:
27801       tags:
27802         - Network
27803       summary: returns entitlements
27804       description: returns entitlements
27805       operationId: getNetworkVcesVceEntitlements
27806       produces:
27807         - application/json
27808         - application/xml
27809       responses:
27810         "200":
27811           description: successful operation
27812           schema:
27813               $ref: "#/getDefinitions/entitlements"
27814         "default":
27815           description: Response codes found in [response codes](https://wiki.onap.org/).
27816       parameters:
27817         - name: vnf-id
27818           in: path
27819           description: Unique id of VNF.  This is unique across the graph.
27820           required: true
27821           type: string
27822           example: __VNF-ID__
27823         - name: group-uuid
27824           in: query
27825           description:
27826           required: false
27827           type: string
27828         - name: resource-uuid
27829           in: query
27830           description:
27831           required: false
27832           type: string
27833   /network/vces/vce/{vnf-id}/relationship-list/relationship:
27834     put:
27835       tags:
27836         - Network
27837       summary: see node definition for valid relationships
27838       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
27839       consumes:
27840         - application/json
27841         - application/xml
27842       produces:
27843         - application/json
27844         - application/xml
27845       responses:
27846         "default":
27847           description: Response codes found in [response codes](https://wiki.onap.org/).
27848       parameters:
27849         - name: vnf-id
27850           in: path
27851           description: Unique id of VNF.  This is unique across the graph.
27852           required: true
27853           type: string
27854           example: __VNF-ID__
27855         - name: body
27856           in: body
27857           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
27858           required: true
27859           schema:
27860             $ref: "#/definitions/relationship"
27861     delete:
27862       tags:
27863         - Network
27864       summary: delete an existing relationship
27865       description: delete an existing relationship
27866       operationId: deleteNetworkVcesVceRelationshipListRelationship
27867       consumes:
27868         - application/json
27869         - application/xml
27870       produces:
27871         - application/json
27872         - application/xml
27873       responses:
27874         "default":
27875           description: Response codes found in [response codes](https://wiki.onap.org/).
27876       parameters:
27877         - name: vnf-id
27878           in: path
27879           description: Unique id of VNF.  This is unique across the graph.
27880           required: true
27881           type: string
27882           example: __VNF-ID__
27883   /network/vces/vce/{vnf-id}:
27884     get:
27885       tags:
27886         - Network
27887       summary: returns vce
27888       description: returns vce
27889       operationId: getNetworkVcesVce
27890       produces:
27891         - application/json
27892         - application/xml
27893       responses:
27894         "200":
27895           description: successful operation
27896           schema:
27897               $ref: "#/getDefinitions/vce"
27898         "default":
27899           description: Response codes found in [response codes](https://wiki.onap.org/).
27900       parameters:
27901         - name: vnf-id
27902           in: path
27903           description: Unique id of VNF.  This is unique across the graph.
27904           required: true
27905           type: string
27906           example: __VNF-ID__
27907     put:
27908       tags:
27909         - Network
27910       summary: create or update an existing vce
27911       description: |
27912         Create or update an existing vce.
27913         #
27914         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27915       operationId: createOrUpdateNetworkVcesVce
27916       consumes:
27917         - application/json
27918         - application/xml
27919       produces:
27920         - application/json
27921         - application/xml
27922       responses:
27923         "default":
27924           description: Response codes found in [response codes](https://wiki.onap.org/).
27925       parameters:
27926         - name: vnf-id
27927           in: path
27928           description: Unique id of VNF.  This is unique across the graph.
27929           required: true
27930           type: string
27931           example: __VNF-ID__
27932         - name: body
27933           in: body
27934           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
27935           required: true
27936           schema:
27937             $ref: "#/definitions/vce"
27938     patch:
27939       tags:
27940         - Network
27941       summary: update an existing vce
27942       description: |
27943         Update an existing vce
27944         #
27945         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27946         The PUT operation will entirely replace an existing object.
27947         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27948         #
27949         Other differences between PUT and PATCH are:
27950         #
27951         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27952         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27953         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27954       operationId: UpdateNetworkVcesVce
27955       consumes:
27956         - application/json
27957         - application/xml
27958       produces:
27959         - application/json
27960         - application/xml
27961       responses:
27962         "default":
27963           description: Response codes found in [response codes](https://wiki.onap.org/).
27964       parameters:
27965         - name: vnf-id
27966           in: path
27967           description: Unique id of VNF.  This is unique across the graph.
27968           required: true
27969           type: string
27970           example: __VNF-ID__
27971         - name: body
27972           in: body
27973           description: vce object that needs to be updated.
27974           required: true
27975           schema:
27976             $ref: "#/patchDefinitions/vce"
27977     delete:
27978       tags:
27979         - Network
27980       summary: delete an existing vce
27981       description: delete an existing vce
27982       operationId: deleteNetworkVcesVce
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: resource-version
28000           in: query
28001           description: resource-version for concurrency
28002           required: true
28003           type: string
28004   /network/vces:
28005     get:
28006       tags:
28007         - Network
28008       summary: returns vces
28009       description: returns vces
28010       operationId: getNetworkVces
28011       produces:
28012         - application/json
28013         - application/xml
28014       responses:
28015         "200":
28016           description: successful operation
28017           schema:
28018               $ref: "#/getDefinitions/vces"
28019         "default":
28020           description: Response codes found in [response codes](https://wiki.onap.org/).
28021       parameters:
28022         - name: vnf-id
28023           in: query
28024           description:
28025           required: false
28026           type: string
28027         - name: vnf-name
28028           in: query
28029           description:
28030           required: false
28031           type: string
28032         - name: vnf-name2
28033           in: query
28034           description:
28035           required: false
28036           type: string
28037         - name: vnf-type
28038           in: query
28039           description:
28040           required: false
28041           type: string
28042         - name: service-id
28043           in: query
28044           description:
28045           required: false
28046           type: string
28047         - name: regional-resource-zone
28048           in: query
28049           description:
28050           required: false
28051           type: string
28052         - name: prov-status
28053           in: query
28054           description:
28055           required: false
28056           type: string
28057         - name: heat-stack-id
28058           in: query
28059           description:
28060           required: false
28061           type: string
28062         - name: vpe-id
28063           in: query
28064           description:
28065           required: false
28066           type: string
28067   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
28068     put:
28069       tags:
28070         - Network
28071       summary: see node definition for valid relationships
28072       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
28073       consumes:
28074         - application/json
28075         - application/xml
28076       produces:
28077         - application/json
28078         - application/xml
28079       responses:
28080         "default":
28081           description: Response codes found in [response codes](https://wiki.onap.org/).
28082       parameters:
28083         - name: vnfc-name
28084           in: path
28085           description: Unique ID of vnfc.
28086           required: true
28087           type: string
28088           example: __VNFC-NAME__
28089         - name: body
28090           in: body
28091           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
28092           required: true
28093           schema:
28094             $ref: "#/definitions/relationship"
28095     delete:
28096       tags:
28097         - Network
28098       summary: delete an existing relationship
28099       description: delete an existing relationship
28100       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
28101       consumes:
28102         - application/json
28103         - application/xml
28104       produces:
28105         - application/json
28106         - application/xml
28107       responses:
28108         "default":
28109           description: Response codes found in [response codes](https://wiki.onap.org/).
28110       parameters:
28111         - name: vnfc-name
28112           in: path
28113           description: Unique ID of vnfc.
28114           required: true
28115           type: string
28116           example: __VNFC-NAME__
28117   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
28118     put:
28119       tags:
28120         - Network
28121       summary: see node definition for valid relationships
28122       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
28123       consumes:
28124         - application/json
28125         - application/xml
28126       produces:
28127         - application/json
28128         - application/xml
28129       responses:
28130         "default":
28131           description: Response codes found in [response codes](https://wiki.onap.org/).
28132       parameters:
28133         - name: vnfc-name
28134           in: path
28135           description: Unique ID of vnfc.
28136           required: true
28137           type: string
28138           example: __VNFC-NAME__
28139         - name: l3-interface-ipv4-address
28140           in: path
28141           description: IP address
28142           required: true
28143           type: string
28144           example: __L3-INTERFACE-IPV4-ADDRESS__
28145         - name: body
28146           in: body
28147           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
28148           required: true
28149           schema:
28150             $ref: "#/definitions/relationship"
28151     delete:
28152       tags:
28153         - Network
28154       summary: delete an existing relationship
28155       description: delete an existing relationship
28156       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
28157       consumes:
28158         - application/json
28159         - application/xml
28160       produces:
28161         - application/json
28162         - application/xml
28163       responses:
28164         "default":
28165           description: Response codes found in [response codes](https://wiki.onap.org/).
28166       parameters:
28167         - name: vnfc-name
28168           in: path
28169           description: Unique ID of vnfc.
28170           required: true
28171           type: string
28172           example: __VNFC-NAME__
28173         - name: l3-interface-ipv4-address
28174           in: path
28175           description: IP address
28176           required: true
28177           type: string
28178           example: __L3-INTERFACE-IPV4-ADDRESS__
28179   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28180     get:
28181       tags:
28182         - Network
28183       summary: returns l3-interface-ipv4-address-list
28184       description: returns l3-interface-ipv4-address-list
28185       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28186       produces:
28187         - application/json
28188         - application/xml
28189       responses:
28190         "200":
28191           description: successful operation
28192           schema:
28193               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28194         "default":
28195           description: Response codes found in [response codes](https://wiki.onap.org/).
28196       parameters:
28197         - name: vnfc-name
28198           in: path
28199           description: Unique ID of vnfc.
28200           required: true
28201           type: string
28202           example: __VNFC-NAME__
28203         - name: l3-interface-ipv4-address
28204           in: path
28205           description: IP address
28206           required: true
28207           type: string
28208           example: __L3-INTERFACE-IPV4-ADDRESS__
28209     put:
28210       tags:
28211         - Network
28212       summary: create or update an existing l3-interface-ipv4-address-list
28213       description: |
28214         Create or update an existing l3-interface-ipv4-address-list.
28215         #
28216         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28217       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28218       consumes:
28219         - application/json
28220         - application/xml
28221       produces:
28222         - application/json
28223         - application/xml
28224       responses:
28225         "default":
28226           description: Response codes found in [response codes](https://wiki.onap.org/).
28227       parameters:
28228         - name: vnfc-name
28229           in: path
28230           description: Unique ID of vnfc.
28231           required: true
28232           type: string
28233           example: __VNFC-NAME__
28234         - name: l3-interface-ipv4-address
28235           in: path
28236           description: IP address
28237           required: true
28238           type: string
28239           example: __L3-INTERFACE-IPV4-ADDRESS__
28240         - name: body
28241           in: body
28242           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
28243           required: true
28244           schema:
28245             $ref: "#/definitions/l3-interface-ipv4-address-list"
28246     patch:
28247       tags:
28248         - Network
28249       summary: update an existing l3-interface-ipv4-address-list
28250       description: |
28251         Update an existing l3-interface-ipv4-address-list
28252         #
28253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28254         The PUT operation will entirely replace an existing object.
28255         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28256         #
28257         Other differences between PUT and PATCH are:
28258         #
28259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28262       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28263       consumes:
28264         - application/json
28265         - application/xml
28266       produces:
28267         - application/json
28268         - application/xml
28269       responses:
28270         "default":
28271           description: Response codes found in [response codes](https://wiki.onap.org/).
28272       parameters:
28273         - name: vnfc-name
28274           in: path
28275           description: Unique ID of vnfc.
28276           required: true
28277           type: string
28278           example: __VNFC-NAME__
28279         - name: l3-interface-ipv4-address
28280           in: path
28281           description: IP address
28282           required: true
28283           type: string
28284           example: __L3-INTERFACE-IPV4-ADDRESS__
28285         - name: body
28286           in: body
28287           description: l3-interface-ipv4-address-list object that needs to be updated.
28288           required: true
28289           schema:
28290             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28291     delete:
28292       tags:
28293         - Network
28294       summary: delete an existing l3-interface-ipv4-address-list
28295       description: delete an existing l3-interface-ipv4-address-list
28296       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28297       consumes:
28298         - application/json
28299         - application/xml
28300       produces:
28301         - application/json
28302         - application/xml
28303       responses:
28304         "default":
28305           description: Response codes found in [response codes](https://wiki.onap.org/).
28306       parameters:
28307         - name: vnfc-name
28308           in: path
28309           description: Unique ID of vnfc.
28310           required: true
28311           type: string
28312           example: __VNFC-NAME__
28313         - name: l3-interface-ipv4-address
28314           in: path
28315           description: IP address
28316           required: true
28317           type: string
28318           example: __L3-INTERFACE-IPV4-ADDRESS__
28319         - name: resource-version
28320           in: query
28321           description: resource-version for concurrency
28322           required: true
28323           type: string
28324   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
28325     put:
28326       tags:
28327         - Network
28328       summary: see node definition for valid relationships
28329       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
28330       consumes:
28331         - application/json
28332         - application/xml
28333       produces:
28334         - application/json
28335         - application/xml
28336       responses:
28337         "default":
28338           description: Response codes found in [response codes](https://wiki.onap.org/).
28339       parameters:
28340         - name: vnfc-name
28341           in: path
28342           description: Unique ID of vnfc.
28343           required: true
28344           type: string
28345           example: __VNFC-NAME__
28346         - name: l3-interface-ipv6-address
28347           in: path
28348           description: IP address
28349           required: true
28350           type: string
28351           example: __L3-INTERFACE-IPV6-ADDRESS__
28352         - name: body
28353           in: body
28354           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
28355           required: true
28356           schema:
28357             $ref: "#/definitions/relationship"
28358     delete:
28359       tags:
28360         - Network
28361       summary: delete an existing relationship
28362       description: delete an existing relationship
28363       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
28364       consumes:
28365         - application/json
28366         - application/xml
28367       produces:
28368         - application/json
28369         - application/xml
28370       responses:
28371         "default":
28372           description: Response codes found in [response codes](https://wiki.onap.org/).
28373       parameters:
28374         - name: vnfc-name
28375           in: path
28376           description: Unique ID of vnfc.
28377           required: true
28378           type: string
28379           example: __VNFC-NAME__
28380         - name: l3-interface-ipv6-address
28381           in: path
28382           description: IP address
28383           required: true
28384           type: string
28385           example: __L3-INTERFACE-IPV6-ADDRESS__
28386   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28387     get:
28388       tags:
28389         - Network
28390       summary: returns l3-interface-ipv6-address-list
28391       description: returns l3-interface-ipv6-address-list
28392       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28393       produces:
28394         - application/json
28395         - application/xml
28396       responses:
28397         "200":
28398           description: successful operation
28399           schema:
28400               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28401         "default":
28402           description: Response codes found in [response codes](https://wiki.onap.org/).
28403       parameters:
28404         - name: vnfc-name
28405           in: path
28406           description: Unique ID of vnfc.
28407           required: true
28408           type: string
28409           example: __VNFC-NAME__
28410         - name: l3-interface-ipv6-address
28411           in: path
28412           description: IP address
28413           required: true
28414           type: string
28415           example: __L3-INTERFACE-IPV6-ADDRESS__
28416     put:
28417       tags:
28418         - Network
28419       summary: create or update an existing l3-interface-ipv6-address-list
28420       description: |
28421         Create or update an existing l3-interface-ipv6-address-list.
28422         #
28423         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28424       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28425       consumes:
28426         - application/json
28427         - application/xml
28428       produces:
28429         - application/json
28430         - application/xml
28431       responses:
28432         "default":
28433           description: Response codes found in [response codes](https://wiki.onap.org/).
28434       parameters:
28435         - name: vnfc-name
28436           in: path
28437           description: Unique ID of vnfc.
28438           required: true
28439           type: string
28440           example: __VNFC-NAME__
28441         - name: l3-interface-ipv6-address
28442           in: path
28443           description: IP address
28444           required: true
28445           type: string
28446           example: __L3-INTERFACE-IPV6-ADDRESS__
28447         - name: body
28448           in: body
28449           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
28450           required: true
28451           schema:
28452             $ref: "#/definitions/l3-interface-ipv6-address-list"
28453     patch:
28454       tags:
28455         - Network
28456       summary: update an existing l3-interface-ipv6-address-list
28457       description: |
28458         Update an existing l3-interface-ipv6-address-list
28459         #
28460         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28461         The PUT operation will entirely replace an existing object.
28462         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28463         #
28464         Other differences between PUT and PATCH are:
28465         #
28466         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28467         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28468         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28469       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28470       consumes:
28471         - application/json
28472         - application/xml
28473       produces:
28474         - application/json
28475         - application/xml
28476       responses:
28477         "default":
28478           description: Response codes found in [response codes](https://wiki.onap.org/).
28479       parameters:
28480         - name: vnfc-name
28481           in: path
28482           description: Unique ID of vnfc.
28483           required: true
28484           type: string
28485           example: __VNFC-NAME__
28486         - name: l3-interface-ipv6-address
28487           in: path
28488           description: IP address
28489           required: true
28490           type: string
28491           example: __L3-INTERFACE-IPV6-ADDRESS__
28492         - name: body
28493           in: body
28494           description: l3-interface-ipv6-address-list object that needs to be updated.
28495           required: true
28496           schema:
28497             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28498     delete:
28499       tags:
28500         - Network
28501       summary: delete an existing l3-interface-ipv6-address-list
28502       description: delete an existing l3-interface-ipv6-address-list
28503       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28504       consumes:
28505         - application/json
28506         - application/xml
28507       produces:
28508         - application/json
28509         - application/xml
28510       responses:
28511         "default":
28512           description: Response codes found in [response codes](https://wiki.onap.org/).
28513       parameters:
28514         - name: vnfc-name
28515           in: path
28516           description: Unique ID of vnfc.
28517           required: true
28518           type: string
28519           example: __VNFC-NAME__
28520         - name: l3-interface-ipv6-address
28521           in: path
28522           description: IP address
28523           required: true
28524           type: string
28525           example: __L3-INTERFACE-IPV6-ADDRESS__
28526         - name: resource-version
28527           in: query
28528           description: resource-version for concurrency
28529           required: true
28530           type: string
28531   /network/vnfcs/vnfc/{vnfc-name}:
28532     get:
28533       tags:
28534         - Network
28535       summary: returns vnfc
28536       description: returns vnfc
28537       operationId: getNetworkVnfcsVnfc
28538       produces:
28539         - application/json
28540         - application/xml
28541       responses:
28542         "200":
28543           description: successful operation
28544           schema:
28545               $ref: "#/getDefinitions/vnfc"
28546         "default":
28547           description: Response codes found in [response codes](https://wiki.onap.org/).
28548       parameters:
28549         - name: vnfc-name
28550           in: path
28551           description: Unique ID of vnfc.
28552           required: true
28553           type: string
28554           example: __VNFC-NAME__
28555     put:
28556       tags:
28557         - Network
28558       summary: create or update an existing vnfc
28559       description: |
28560         Create or update an existing vnfc.
28561         #
28562         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28563       operationId: createOrUpdateNetworkVnfcsVnfc
28564       consumes:
28565         - application/json
28566         - application/xml
28567       produces:
28568         - application/json
28569         - application/xml
28570       responses:
28571         "default":
28572           description: Response codes found in [response codes](https://wiki.onap.org/).
28573       parameters:
28574         - name: vnfc-name
28575           in: path
28576           description: Unique ID of vnfc.
28577           required: true
28578           type: string
28579           example: __VNFC-NAME__
28580         - name: body
28581           in: body
28582           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
28583           required: true
28584           schema:
28585             $ref: "#/definitions/vnfc"
28586     patch:
28587       tags:
28588         - Network
28589       summary: update an existing vnfc
28590       description: |
28591         Update an existing vnfc
28592         #
28593         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28594         The PUT operation will entirely replace an existing object.
28595         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28596         #
28597         Other differences between PUT and PATCH are:
28598         #
28599         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28600         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28601         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28602       operationId: UpdateNetworkVnfcsVnfc
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: vnfc-name
28614           in: path
28615           description: Unique ID of vnfc.
28616           required: true
28617           type: string
28618           example: __VNFC-NAME__
28619         - name: body
28620           in: body
28621           description: vnfc object that needs to be updated.
28622           required: true
28623           schema:
28624             $ref: "#/patchDefinitions/vnfc"
28625     delete:
28626       tags:
28627         - Network
28628       summary: delete an existing vnfc
28629       description: delete an existing vnfc
28630       operationId: deleteNetworkVnfcsVnfc
28631       consumes:
28632         - application/json
28633         - application/xml
28634       produces:
28635         - application/json
28636         - application/xml
28637       responses:
28638         "default":
28639           description: Response codes found in [response codes](https://wiki.onap.org/).
28640       parameters:
28641         - name: vnfc-name
28642           in: path
28643           description: Unique ID of vnfc.
28644           required: true
28645           type: string
28646           example: __VNFC-NAME__
28647         - name: resource-version
28648           in: query
28649           description: resource-version for concurrency
28650           required: true
28651           type: string
28652   /network/vnfcs:
28653     get:
28654       tags:
28655         - Network
28656       summary: returns vnfcs
28657       description: returns vnfcs
28658       operationId: getNetworkVnfcs
28659       produces:
28660         - application/json
28661         - application/xml
28662       responses:
28663         "200":
28664           description: successful operation
28665           schema:
28666               $ref: "#/getDefinitions/vnfcs"
28667         "default":
28668           description: Response codes found in [response codes](https://wiki.onap.org/).
28669       parameters:
28670         - name: vnfc-name
28671           in: query
28672           description:
28673           required: false
28674           type: string
28675         - name: nfc-naming-code
28676           in: query
28677           description:
28678           required: false
28679           type: string
28680         - name: nfc-function
28681           in: query
28682           description:
28683           required: false
28684           type: string
28685         - name: prov-status
28686           in: query
28687           description:
28688           required: false
28689           type: string
28690         - name: ipaddress-v4-oam-vip
28691           in: query
28692           description:
28693           required: false
28694           type: string
28695         - name: in-maint
28696           in: query
28697           description:
28698           required: false
28699           type: boolean
28700         - name: is-closed-loop-disabled
28701           in: query
28702           description:
28703           required: false
28704           type: boolean
28705         - name: group-notation
28706           in: query
28707           description:
28708           required: false
28709           type: string
28710         - name: model-invariant-id
28711           in: query
28712           description:
28713           required: false
28714           type: string
28715         - name: model-version-id
28716           in: query
28717           description:
28718           required: false
28719           type: string
28720   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
28721     put:
28722       tags:
28723         - Network
28724       summary: see node definition for valid relationships
28725       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
28726       consumes:
28727         - application/json
28728         - application/xml
28729       produces:
28730         - application/json
28731         - application/xml
28732       responses:
28733         "default":
28734           description: Response codes found in [response codes](https://wiki.onap.org/).
28735       parameters:
28736         - name: network-id
28737           in: path
28738           description: Network ID, should be uuid. Unique across A&AI.
28739           required: true
28740           type: string
28741           example: __NETWORK-ID__
28742         - name: subnet-id
28743           in: path
28744           description: Subnet ID, should be UUID.
28745           required: true
28746           type: string
28747           example: __SUBNET-ID__
28748         - name: host-route-id
28749           in: path
28750           description: host-route id
28751           required: true
28752           type: string
28753           example: __HOST-ROUTE-ID__
28754         - name: body
28755           in: body
28756           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
28757           required: true
28758           schema:
28759             $ref: "#/definitions/relationship"
28760     delete:
28761       tags:
28762         - Network
28763       summary: delete an existing relationship
28764       description: delete an existing relationship
28765       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
28766       consumes:
28767         - application/json
28768         - application/xml
28769       produces:
28770         - application/json
28771         - application/xml
28772       responses:
28773         "default":
28774           description: Response codes found in [response codes](https://wiki.onap.org/).
28775       parameters:
28776         - name: network-id
28777           in: path
28778           description: Network ID, should be uuid. Unique across A&AI.
28779           required: true
28780           type: string
28781           example: __NETWORK-ID__
28782         - name: subnet-id
28783           in: path
28784           description: Subnet ID, should be UUID.
28785           required: true
28786           type: string
28787           example: __SUBNET-ID__
28788         - name: host-route-id
28789           in: path
28790           description: host-route id
28791           required: true
28792           type: string
28793           example: __HOST-ROUTE-ID__
28794   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
28795     get:
28796       tags:
28797         - Network
28798       summary: returns host-route
28799       description: returns host-route
28800       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28801       produces:
28802         - application/json
28803         - application/xml
28804       responses:
28805         "200":
28806           description: successful operation
28807           schema:
28808               $ref: "#/getDefinitions/host-route"
28809         "default":
28810           description: Response codes found in [response codes](https://wiki.onap.org/).
28811       parameters:
28812         - name: network-id
28813           in: path
28814           description: Network ID, should be uuid. Unique across A&AI.
28815           required: true
28816           type: string
28817           example: __NETWORK-ID__
28818         - name: subnet-id
28819           in: path
28820           description: Subnet ID, should be UUID.
28821           required: true
28822           type: string
28823           example: __SUBNET-ID__
28824         - name: host-route-id
28825           in: path
28826           description: host-route id
28827           required: true
28828           type: string
28829           example: __HOST-ROUTE-ID__
28830     put:
28831       tags:
28832         - Network
28833       summary: create or update an existing host-route
28834       description: |
28835         Create or update an existing host-route.
28836         #
28837         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28838       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28839       consumes:
28840         - application/json
28841         - application/xml
28842       produces:
28843         - application/json
28844         - application/xml
28845       responses:
28846         "default":
28847           description: Response codes found in [response codes](https://wiki.onap.org/).
28848       parameters:
28849         - name: network-id
28850           in: path
28851           description: Network ID, should be uuid. Unique across A&AI.
28852           required: true
28853           type: string
28854           example: __NETWORK-ID__
28855         - name: subnet-id
28856           in: path
28857           description: Subnet ID, should be UUID.
28858           required: true
28859           type: string
28860           example: __SUBNET-ID__
28861         - name: host-route-id
28862           in: path
28863           description: host-route id
28864           required: true
28865           type: string
28866           example: __HOST-ROUTE-ID__
28867         - name: body
28868           in: body
28869           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
28870           required: true
28871           schema:
28872             $ref: "#/definitions/host-route"
28873     patch:
28874       tags:
28875         - Network
28876       summary: update an existing host-route
28877       description: |
28878         Update an existing host-route
28879         #
28880         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28881         The PUT operation will entirely replace an existing object.
28882         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28883         #
28884         Other differences between PUT and PATCH are:
28885         #
28886         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28887         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28888         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28889       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28890       consumes:
28891         - application/json
28892         - application/xml
28893       produces:
28894         - application/json
28895         - application/xml
28896       responses:
28897         "default":
28898           description: Response codes found in [response codes](https://wiki.onap.org/).
28899       parameters:
28900         - name: network-id
28901           in: path
28902           description: Network ID, should be uuid. Unique across A&AI.
28903           required: true
28904           type: string
28905           example: __NETWORK-ID__
28906         - name: subnet-id
28907           in: path
28908           description: Subnet ID, should be UUID.
28909           required: true
28910           type: string
28911           example: __SUBNET-ID__
28912         - name: host-route-id
28913           in: path
28914           description: host-route id
28915           required: true
28916           type: string
28917           example: __HOST-ROUTE-ID__
28918         - name: body
28919           in: body
28920           description: host-route object that needs to be updated.
28921           required: true
28922           schema:
28923             $ref: "#/patchDefinitions/host-route"
28924     delete:
28925       tags:
28926         - Network
28927       summary: delete an existing host-route
28928       description: delete an existing host-route
28929       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28930       consumes:
28931         - application/json
28932         - application/xml
28933       produces:
28934         - application/json
28935         - application/xml
28936       responses:
28937         "default":
28938           description: Response codes found in [response codes](https://wiki.onap.org/).
28939       parameters:
28940         - name: network-id
28941           in: path
28942           description: Network ID, should be uuid. Unique across A&AI.
28943           required: true
28944           type: string
28945           example: __NETWORK-ID__
28946         - name: subnet-id
28947           in: path
28948           description: Subnet ID, should be UUID.
28949           required: true
28950           type: string
28951           example: __SUBNET-ID__
28952         - name: host-route-id
28953           in: path
28954           description: host-route id
28955           required: true
28956           type: string
28957           example: __HOST-ROUTE-ID__
28958         - name: resource-version
28959           in: query
28960           description: resource-version for concurrency
28961           required: true
28962           type: string
28963   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
28964     get:
28965       tags:
28966         - Network
28967       summary: returns host-routes
28968       description: returns host-routes
28969       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
28970       produces:
28971         - application/json
28972         - application/xml
28973       responses:
28974         "200":
28975           description: successful operation
28976           schema:
28977               $ref: "#/getDefinitions/host-routes"
28978         "default":
28979           description: Response codes found in [response codes](https://wiki.onap.org/).
28980       parameters:
28981         - name: network-id
28982           in: path
28983           description: Network ID, should be uuid. Unique across A&AI.
28984           required: true
28985           type: string
28986           example: __NETWORK-ID__
28987         - name: subnet-id
28988           in: path
28989           description: Subnet ID, should be UUID.
28990           required: true
28991           type: string
28992           example: __SUBNET-ID__
28993         - name: host-route-id
28994           in: query
28995           description:
28996           required: false
28997           type: string
28998   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
28999     put:
29000       tags:
29001         - Network
29002       summary: see node definition for valid relationships
29003       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29004       consumes:
29005         - application/json
29006         - application/xml
29007       produces:
29008         - application/json
29009         - application/xml
29010       responses:
29011         "default":
29012           description: Response codes found in [response codes](https://wiki.onap.org/).
29013       parameters:
29014         - name: network-id
29015           in: path
29016           description: Network ID, should be uuid. Unique across A&AI.
29017           required: true
29018           type: string
29019           example: __NETWORK-ID__
29020         - name: subnet-id
29021           in: path
29022           description: Subnet ID, should be UUID.
29023           required: true
29024           type: string
29025           example: __SUBNET-ID__
29026         - name: body
29027           in: body
29028           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29029           required: true
29030           schema:
29031             $ref: "#/definitions/relationship"
29032     delete:
29033       tags:
29034         - Network
29035       summary: delete an existing relationship
29036       description: delete an existing relationship
29037       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29038       consumes:
29039         - application/json
29040         - application/xml
29041       produces:
29042         - application/json
29043         - application/xml
29044       responses:
29045         "default":
29046           description: Response codes found in [response codes](https://wiki.onap.org/).
29047       parameters:
29048         - name: network-id
29049           in: path
29050           description: Network ID, should be uuid. Unique across A&AI.
29051           required: true
29052           type: string
29053           example: __NETWORK-ID__
29054         - name: subnet-id
29055           in: path
29056           description: Subnet ID, should be UUID.
29057           required: true
29058           type: string
29059           example: __SUBNET-ID__
29060   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29061     get:
29062       tags:
29063         - Network
29064       summary: returns subnet
29065       description: returns subnet
29066       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29067       produces:
29068         - application/json
29069         - application/xml
29070       responses:
29071         "200":
29072           description: successful operation
29073           schema:
29074               $ref: "#/getDefinitions/subnet"
29075         "default":
29076           description: Response codes found in [response codes](https://wiki.onap.org/).
29077       parameters:
29078         - name: network-id
29079           in: path
29080           description: Network ID, should be uuid. Unique across A&AI.
29081           required: true
29082           type: string
29083           example: __NETWORK-ID__
29084         - name: subnet-id
29085           in: path
29086           description: Subnet ID, should be UUID.
29087           required: true
29088           type: string
29089           example: __SUBNET-ID__
29090     put:
29091       tags:
29092         - Network
29093       summary: create or update an existing subnet
29094       description: |
29095         Create or update an existing subnet.
29096         #
29097         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29098       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29099       consumes:
29100         - application/json
29101         - application/xml
29102       produces:
29103         - application/json
29104         - application/xml
29105       responses:
29106         "default":
29107           description: Response codes found in [response codes](https://wiki.onap.org/).
29108       parameters:
29109         - name: network-id
29110           in: path
29111           description: Network ID, should be uuid. Unique across A&AI.
29112           required: true
29113           type: string
29114           example: __NETWORK-ID__
29115         - name: subnet-id
29116           in: path
29117           description: Subnet ID, should be UUID.
29118           required: true
29119           type: string
29120           example: __SUBNET-ID__
29121         - name: body
29122           in: body
29123           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29124           required: true
29125           schema:
29126             $ref: "#/definitions/subnet"
29127     patch:
29128       tags:
29129         - Network
29130       summary: update an existing subnet
29131       description: |
29132         Update an existing subnet
29133         #
29134         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29135         The PUT operation will entirely replace an existing object.
29136         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29137         #
29138         Other differences between PUT and PATCH are:
29139         #
29140         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29141         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29142         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29143       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29144       consumes:
29145         - application/json
29146         - application/xml
29147       produces:
29148         - application/json
29149         - application/xml
29150       responses:
29151         "default":
29152           description: Response codes found in [response codes](https://wiki.onap.org/).
29153       parameters:
29154         - name: network-id
29155           in: path
29156           description: Network ID, should be uuid. Unique across A&AI.
29157           required: true
29158           type: string
29159           example: __NETWORK-ID__
29160         - name: subnet-id
29161           in: path
29162           description: Subnet ID, should be UUID.
29163           required: true
29164           type: string
29165           example: __SUBNET-ID__
29166         - name: body
29167           in: body
29168           description: subnet object that needs to be updated.
29169           required: true
29170           schema:
29171             $ref: "#/patchDefinitions/subnet"
29172     delete:
29173       tags:
29174         - Network
29175       summary: delete an existing subnet
29176       description: delete an existing subnet
29177       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29178       consumes:
29179         - application/json
29180         - application/xml
29181       produces:
29182         - application/json
29183         - application/xml
29184       responses:
29185         "default":
29186           description: Response codes found in [response codes](https://wiki.onap.org/).
29187       parameters:
29188         - name: network-id
29189           in: path
29190           description: Network ID, should be uuid. Unique across A&AI.
29191           required: true
29192           type: string
29193           example: __NETWORK-ID__
29194         - name: subnet-id
29195           in: path
29196           description: Subnet ID, should be UUID.
29197           required: true
29198           type: string
29199           example: __SUBNET-ID__
29200         - name: resource-version
29201           in: query
29202           description: resource-version for concurrency
29203           required: true
29204           type: string
29205   /network/l3-networks/l3-network/{network-id}/subnets:
29206     get:
29207       tags:
29208         - Network
29209       summary: returns subnets
29210       description: returns subnets
29211       operationId: getNetworkL3NetworksL3NetworkSubnets
29212       produces:
29213         - application/json
29214         - application/xml
29215       responses:
29216         "200":
29217           description: successful operation
29218           schema:
29219               $ref: "#/getDefinitions/subnets"
29220         "default":
29221           description: Response codes found in [response codes](https://wiki.onap.org/).
29222       parameters:
29223         - name: network-id
29224           in: path
29225           description: Network ID, should be uuid. Unique across A&AI.
29226           required: true
29227           type: string
29228           example: __NETWORK-ID__
29229         - name: subnet-id
29230           in: query
29231           description:
29232           required: false
29233           type: string
29234         - name: subnet-name
29235           in: query
29236           description:
29237           required: false
29238           type: string
29239   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29240     put:
29241       tags:
29242         - Network
29243       summary: see node definition for valid relationships
29244       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29245       consumes:
29246         - application/json
29247         - application/xml
29248       produces:
29249         - application/json
29250         - application/xml
29251       responses:
29252         "default":
29253           description: Response codes found in [response codes](https://wiki.onap.org/).
29254       parameters:
29255         - name: network-id
29256           in: path
29257           description: Network ID, should be uuid. Unique across A&AI.
29258           required: true
29259           type: string
29260           example: __NETWORK-ID__
29261         - name: vlan-id-inner
29262           in: path
29263           description: id.
29264           required: true
29265           type: integer
29266           format: int64
29267           example: __VLAN-ID-INNER__
29268         - name: body
29269           in: body
29270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29271           required: true
29272           schema:
29273             $ref: "#/definitions/relationship"
29274     delete:
29275       tags:
29276         - Network
29277       summary: delete an existing relationship
29278       description: delete an existing relationship
29279       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29280       consumes:
29281         - application/json
29282         - application/xml
29283       produces:
29284         - application/json
29285         - application/xml
29286       responses:
29287         "default":
29288           description: Response codes found in [response codes](https://wiki.onap.org/).
29289       parameters:
29290         - name: network-id
29291           in: path
29292           description: Network ID, should be uuid. Unique across A&AI.
29293           required: true
29294           type: string
29295           example: __NETWORK-ID__
29296         - name: vlan-id-inner
29297           in: path
29298           description: id.
29299           required: true
29300           type: integer
29301           format: int64
29302           example: __VLAN-ID-INNER__
29303   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29304     get:
29305       tags:
29306         - Network
29307       summary: returns ctag-assignment
29308       description: returns ctag-assignment
29309       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29310       produces:
29311         - application/json
29312         - application/xml
29313       responses:
29314         "200":
29315           description: successful operation
29316           schema:
29317               $ref: "#/getDefinitions/ctag-assignment"
29318         "default":
29319           description: Response codes found in [response codes](https://wiki.onap.org/).
29320       parameters:
29321         - name: network-id
29322           in: path
29323           description: Network ID, should be uuid. Unique across A&AI.
29324           required: true
29325           type: string
29326           example: __NETWORK-ID__
29327         - name: vlan-id-inner
29328           in: path
29329           description: id.
29330           required: true
29331           type: integer
29332           format: int64
29333           example: __VLAN-ID-INNER__
29334     put:
29335       tags:
29336         - Network
29337       summary: create or update an existing ctag-assignment
29338       description: |
29339         Create or update an existing ctag-assignment.
29340         #
29341         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29342       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29343       consumes:
29344         - application/json
29345         - application/xml
29346       produces:
29347         - application/json
29348         - application/xml
29349       responses:
29350         "default":
29351           description: Response codes found in [response codes](https://wiki.onap.org/).
29352       parameters:
29353         - name: network-id
29354           in: path
29355           description: Network ID, should be uuid. Unique across A&AI.
29356           required: true
29357           type: string
29358           example: __NETWORK-ID__
29359         - name: vlan-id-inner
29360           in: path
29361           description: id.
29362           required: true
29363           type: integer
29364           format: int64
29365           example: __VLAN-ID-INNER__
29366         - name: body
29367           in: body
29368           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29369           required: true
29370           schema:
29371             $ref: "#/definitions/ctag-assignment"
29372     patch:
29373       tags:
29374         - Network
29375       summary: update an existing ctag-assignment
29376       description: |
29377         Update an existing ctag-assignment
29378         #
29379         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29380         The PUT operation will entirely replace an existing object.
29381         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29382         #
29383         Other differences between PUT and PATCH are:
29384         #
29385         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29386         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29387         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29388       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29389       consumes:
29390         - application/json
29391         - application/xml
29392       produces:
29393         - application/json
29394         - application/xml
29395       responses:
29396         "default":
29397           description: Response codes found in [response codes](https://wiki.onap.org/).
29398       parameters:
29399         - name: network-id
29400           in: path
29401           description: Network ID, should be uuid. Unique across A&AI.
29402           required: true
29403           type: string
29404           example: __NETWORK-ID__
29405         - name: vlan-id-inner
29406           in: path
29407           description: id.
29408           required: true
29409           type: integer
29410           format: int64
29411           example: __VLAN-ID-INNER__
29412         - name: body
29413           in: body
29414           description: ctag-assignment object that needs to be updated.
29415           required: true
29416           schema:
29417             $ref: "#/patchDefinitions/ctag-assignment"
29418     delete:
29419       tags:
29420         - Network
29421       summary: delete an existing ctag-assignment
29422       description: delete an existing ctag-assignment
29423       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29424       consumes:
29425         - application/json
29426         - application/xml
29427       produces:
29428         - application/json
29429         - application/xml
29430       responses:
29431         "default":
29432           description: Response codes found in [response codes](https://wiki.onap.org/).
29433       parameters:
29434         - name: network-id
29435           in: path
29436           description: Network ID, should be uuid. Unique across A&AI.
29437           required: true
29438           type: string
29439           example: __NETWORK-ID__
29440         - name: vlan-id-inner
29441           in: path
29442           description: id.
29443           required: true
29444           type: integer
29445           format: int64
29446           example: __VLAN-ID-INNER__
29447         - name: resource-version
29448           in: query
29449           description: resource-version for concurrency
29450           required: true
29451           type: string
29452   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29453     get:
29454       tags:
29455         - Network
29456       summary: returns ctag-assignments
29457       description: returns ctag-assignments
29458       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29459       produces:
29460         - application/json
29461         - application/xml
29462       responses:
29463         "200":
29464           description: successful operation
29465           schema:
29466               $ref: "#/getDefinitions/ctag-assignments"
29467         "default":
29468           description: Response codes found in [response codes](https://wiki.onap.org/).
29469       parameters:
29470         - name: network-id
29471           in: path
29472           description: Network ID, should be uuid. Unique across A&AI.
29473           required: true
29474           type: string
29475           example: __NETWORK-ID__
29476         - name: vlan-id-inner
29477           in: query
29478           description:
29479           required: false
29480           type: integer
29481           format: int64
29482   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
29483     put:
29484       tags:
29485         - Network
29486       summary: see node definition for valid relationships
29487       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29488       consumes:
29489         - application/json
29490         - application/xml
29491       produces:
29492         - application/json
29493         - application/xml
29494       responses:
29495         "default":
29496           description: Response codes found in [response codes](https://wiki.onap.org/).
29497       parameters:
29498         - name: network-id
29499           in: path
29500           description: Network ID, should be uuid. Unique across A&AI.
29501           required: true
29502           type: string
29503           example: __NETWORK-ID__
29504         - name: segmentation-id
29505           in: path
29506           description: Route Table Reference id, UUID assigned to this instance.
29507           required: true
29508           type: string
29509           example: __SEGMENTATION-ID__
29510         - name: body
29511           in: body
29512           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29513           required: true
29514           schema:
29515             $ref: "#/definitions/relationship"
29516     delete:
29517       tags:
29518         - Network
29519       summary: delete an existing relationship
29520       description: delete an existing relationship
29521       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29522       consumes:
29523         - application/json
29524         - application/xml
29525       produces:
29526         - application/json
29527         - application/xml
29528       responses:
29529         "default":
29530           description: Response codes found in [response codes](https://wiki.onap.org/).
29531       parameters:
29532         - name: network-id
29533           in: path
29534           description: Network ID, should be uuid. Unique across A&AI.
29535           required: true
29536           type: string
29537           example: __NETWORK-ID__
29538         - name: segmentation-id
29539           in: path
29540           description: Route Table Reference id, UUID assigned to this instance.
29541           required: true
29542           type: string
29543           example: __SEGMENTATION-ID__
29544   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
29545     get:
29546       tags:
29547         - Network
29548       summary: returns segmentation-assignment
29549       description: returns segmentation-assignment
29550       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29551       produces:
29552         - application/json
29553         - application/xml
29554       responses:
29555         "200":
29556           description: successful operation
29557           schema:
29558               $ref: "#/getDefinitions/segmentation-assignment"
29559         "default":
29560           description: Response codes found in [response codes](https://wiki.onap.org/).
29561       parameters:
29562         - name: network-id
29563           in: path
29564           description: Network ID, should be uuid. Unique across A&AI.
29565           required: true
29566           type: string
29567           example: __NETWORK-ID__
29568         - name: segmentation-id
29569           in: path
29570           description: Route Table Reference id, UUID assigned to this instance.
29571           required: true
29572           type: string
29573           example: __SEGMENTATION-ID__
29574     put:
29575       tags:
29576         - Network
29577       summary: create or update an existing segmentation-assignment
29578       description: |
29579         Create or update an existing segmentation-assignment.
29580         #
29581         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29582       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29583       consumes:
29584         - application/json
29585         - application/xml
29586       produces:
29587         - application/json
29588         - application/xml
29589       responses:
29590         "default":
29591           description: Response codes found in [response codes](https://wiki.onap.org/).
29592       parameters:
29593         - name: network-id
29594           in: path
29595           description: Network ID, should be uuid. Unique across A&AI.
29596           required: true
29597           type: string
29598           example: __NETWORK-ID__
29599         - name: segmentation-id
29600           in: path
29601           description: Route Table Reference id, UUID assigned to this instance.
29602           required: true
29603           type: string
29604           example: __SEGMENTATION-ID__
29605         - name: body
29606           in: body
29607           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29608           required: true
29609           schema:
29610             $ref: "#/definitions/segmentation-assignment"
29611     patch:
29612       tags:
29613         - Network
29614       summary: update an existing segmentation-assignment
29615       description: |
29616         Update an existing segmentation-assignment
29617         #
29618         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29619         The PUT operation will entirely replace an existing object.
29620         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29621         #
29622         Other differences between PUT and PATCH are:
29623         #
29624         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29625         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29626         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29627       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29628       consumes:
29629         - application/json
29630         - application/xml
29631       produces:
29632         - application/json
29633         - application/xml
29634       responses:
29635         "default":
29636           description: Response codes found in [response codes](https://wiki.onap.org/).
29637       parameters:
29638         - name: network-id
29639           in: path
29640           description: Network ID, should be uuid. Unique across A&AI.
29641           required: true
29642           type: string
29643           example: __NETWORK-ID__
29644         - name: segmentation-id
29645           in: path
29646           description: Route Table Reference id, UUID assigned to this instance.
29647           required: true
29648           type: string
29649           example: __SEGMENTATION-ID__
29650         - name: body
29651           in: body
29652           description: segmentation-assignment object that needs to be updated.
29653           required: true
29654           schema:
29655             $ref: "#/patchDefinitions/segmentation-assignment"
29656     delete:
29657       tags:
29658         - Network
29659       summary: delete an existing segmentation-assignment
29660       description: delete an existing segmentation-assignment
29661       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29662       consumes:
29663         - application/json
29664         - application/xml
29665       produces:
29666         - application/json
29667         - application/xml
29668       responses:
29669         "default":
29670           description: Response codes found in [response codes](https://wiki.onap.org/).
29671       parameters:
29672         - name: network-id
29673           in: path
29674           description: Network ID, should be uuid. Unique across A&AI.
29675           required: true
29676           type: string
29677           example: __NETWORK-ID__
29678         - name: segmentation-id
29679           in: path
29680           description: Route Table Reference id, UUID assigned to this instance.
29681           required: true
29682           type: string
29683           example: __SEGMENTATION-ID__
29684         - name: resource-version
29685           in: query
29686           description: resource-version for concurrency
29687           required: true
29688           type: string
29689   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
29690     get:
29691       tags:
29692         - Network
29693       summary: returns segmentation-assignments
29694       description: returns segmentation-assignments
29695       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
29696       produces:
29697         - application/json
29698         - application/xml
29699       responses:
29700         "200":
29701           description: successful operation
29702           schema:
29703               $ref: "#/getDefinitions/segmentation-assignments"
29704         "default":
29705           description: Response codes found in [response codes](https://wiki.onap.org/).
29706       parameters:
29707         - name: network-id
29708           in: path
29709           description: Network ID, should be uuid. Unique across A&AI.
29710           required: true
29711           type: string
29712           example: __NETWORK-ID__
29713         - name: segmentation-id
29714           in: query
29715           description:
29716           required: false
29717           type: string
29718   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
29719     put:
29720       tags:
29721         - Network
29722       summary: see node definition for valid relationships
29723       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
29724       consumes:
29725         - application/json
29726         - application/xml
29727       produces:
29728         - application/json
29729         - application/xml
29730       responses:
29731         "default":
29732           description: Response codes found in [response codes](https://wiki.onap.org/).
29733       parameters:
29734         - name: network-id
29735           in: path
29736           description: Network ID, should be uuid. Unique across A&AI.
29737           required: true
29738           type: string
29739           example: __NETWORK-ID__
29740         - name: body
29741           in: body
29742           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
29743           required: true
29744           schema:
29745             $ref: "#/definitions/relationship"
29746     delete:
29747       tags:
29748         - Network
29749       summary: delete an existing relationship
29750       description: delete an existing relationship
29751       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
29752       consumes:
29753         - application/json
29754         - application/xml
29755       produces:
29756         - application/json
29757         - application/xml
29758       responses:
29759         "default":
29760           description: Response codes found in [response codes](https://wiki.onap.org/).
29761       parameters:
29762         - name: network-id
29763           in: path
29764           description: Network ID, should be uuid. Unique across A&AI.
29765           required: true
29766           type: string
29767           example: __NETWORK-ID__
29768   /network/l3-networks/l3-network/{network-id}:
29769     get:
29770       tags:
29771         - Network
29772       summary: returns l3-network
29773       description: returns l3-network
29774       operationId: getNetworkL3NetworksL3Network
29775       produces:
29776         - application/json
29777         - application/xml
29778       responses:
29779         "200":
29780           description: successful operation
29781           schema:
29782               $ref: "#/getDefinitions/l3-network"
29783         "default":
29784           description: Response codes found in [response codes](https://wiki.onap.org/).
29785       parameters:
29786         - name: network-id
29787           in: path
29788           description: Network ID, should be uuid. Unique across A&AI.
29789           required: true
29790           type: string
29791           example: __NETWORK-ID__
29792     put:
29793       tags:
29794         - Network
29795       summary: create or update an existing l3-network
29796       description: |
29797         Create or update an existing l3-network.
29798         #
29799         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29800       operationId: createOrUpdateNetworkL3NetworksL3Network
29801       consumes:
29802         - application/json
29803         - application/xml
29804       produces:
29805         - application/json
29806         - application/xml
29807       responses:
29808         "default":
29809           description: Response codes found in [response codes](https://wiki.onap.org/).
29810       parameters:
29811         - name: network-id
29812           in: path
29813           description: Network ID, should be uuid. Unique across A&AI.
29814           required: true
29815           type: string
29816           example: __NETWORK-ID__
29817         - name: body
29818           in: body
29819           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
29820           required: true
29821           schema:
29822             $ref: "#/definitions/l3-network"
29823     patch:
29824       tags:
29825         - Network
29826       summary: update an existing l3-network
29827       description: |
29828         Update an existing l3-network
29829         #
29830         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29831         The PUT operation will entirely replace an existing object.
29832         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29833         #
29834         Other differences between PUT and PATCH are:
29835         #
29836         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29837         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29838         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29839       operationId: UpdateNetworkL3NetworksL3Network
29840       consumes:
29841         - application/json
29842         - application/xml
29843       produces:
29844         - application/json
29845         - application/xml
29846       responses:
29847         "default":
29848           description: Response codes found in [response codes](https://wiki.onap.org/).
29849       parameters:
29850         - name: network-id
29851           in: path
29852           description: Network ID, should be uuid. Unique across A&AI.
29853           required: true
29854           type: string
29855           example: __NETWORK-ID__
29856         - name: body
29857           in: body
29858           description: l3-network object that needs to be updated.
29859           required: true
29860           schema:
29861             $ref: "#/patchDefinitions/l3-network"
29862     delete:
29863       tags:
29864         - Network
29865       summary: delete an existing l3-network
29866       description: delete an existing l3-network
29867       operationId: deleteNetworkL3NetworksL3Network
29868       consumes:
29869         - application/json
29870         - application/xml
29871       produces:
29872         - application/json
29873         - application/xml
29874       responses:
29875         "default":
29876           description: Response codes found in [response codes](https://wiki.onap.org/).
29877       parameters:
29878         - name: network-id
29879           in: path
29880           description: Network ID, should be uuid. Unique across A&AI.
29881           required: true
29882           type: string
29883           example: __NETWORK-ID__
29884         - name: resource-version
29885           in: query
29886           description: resource-version for concurrency
29887           required: true
29888           type: string
29889   /network/l3-networks:
29890     get:
29891       tags:
29892         - Network
29893       summary: returns l3-networks
29894       description: returns l3-networks
29895       operationId: getNetworkL3Networks
29896       produces:
29897         - application/json
29898         - application/xml
29899       responses:
29900         "200":
29901           description: successful operation
29902           schema:
29903               $ref: "#/getDefinitions/l3-networks"
29904         "default":
29905           description: Response codes found in [response codes](https://wiki.onap.org/).
29906       parameters:
29907         - name: network-id
29908           in: query
29909           description:
29910           required: false
29911           type: string
29912         - name: network-name
29913           in: query
29914           description:
29915           required: false
29916           type: string
29917         - name: network-role
29918           in: query
29919           description:
29920           required: false
29921           type: string
29922         - name: service-id
29923           in: query
29924           description:
29925           required: false
29926           type: string
29927         - name: heat-stack-id
29928           in: query
29929           description:
29930           required: false
29931           type: string
29932         - name: contrail-network-fqdn
29933           in: query
29934           description:
29935           required: false
29936           type: string
29937         - name: model-invariant-id
29938           in: query
29939           description:
29940           required: false
29941           type: string
29942         - name: model-version-id
29943           in: query
29944           description:
29945           required: false
29946           type: string
29947         - name: widget-model-id
29948           in: query
29949           description:
29950           required: false
29951           type: string
29952         - name: widget-model-version
29953           in: query
29954           description:
29955           required: false
29956           type: string
29957   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
29958     put:
29959       tags:
29960         - Network
29961       summary: see node definition for valid relationships
29962       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
29963       consumes:
29964         - application/json
29965         - application/xml
29966       produces:
29967         - application/json
29968         - application/xml
29969       responses:
29970         "default":
29971           description: Response codes found in [response codes](https://wiki.onap.org/).
29972       parameters:
29973         - name: network-policy-id
29974           in: path
29975           description: UUID representing unique key to this instance
29976           required: true
29977           type: string
29978           example: __NETWORK-POLICY-ID__
29979         - name: body
29980           in: body
29981           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
29982           required: true
29983           schema:
29984             $ref: "#/definitions/relationship"
29985     delete:
29986       tags:
29987         - Network
29988       summary: delete an existing relationship
29989       description: delete an existing relationship
29990       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
29991       consumes:
29992         - application/json
29993         - application/xml
29994       produces:
29995         - application/json
29996         - application/xml
29997       responses:
29998         "default":
29999           description: Response codes found in [response codes](https://wiki.onap.org/).
30000       parameters:
30001         - name: network-policy-id
30002           in: path
30003           description: UUID representing unique key to this instance
30004           required: true
30005           type: string
30006           example: __NETWORK-POLICY-ID__
30007   /network/network-policies/network-policy/{network-policy-id}:
30008     get:
30009       tags:
30010         - Network
30011       summary: returns network-policy
30012       description: returns network-policy
30013       operationId: getNetworkNetworkPoliciesNetworkPolicy
30014       produces:
30015         - application/json
30016         - application/xml
30017       responses:
30018         "200":
30019           description: successful operation
30020           schema:
30021               $ref: "#/getDefinitions/network-policy"
30022         "default":
30023           description: Response codes found in [response codes](https://wiki.onap.org/).
30024       parameters:
30025         - name: network-policy-id
30026           in: path
30027           description: UUID representing unique key to this instance
30028           required: true
30029           type: string
30030           example: __NETWORK-POLICY-ID__
30031     put:
30032       tags:
30033         - Network
30034       summary: create or update an existing network-policy
30035       description: |
30036         Create or update an existing network-policy.
30037         #
30038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30039       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30040       consumes:
30041         - application/json
30042         - application/xml
30043       produces:
30044         - application/json
30045         - application/xml
30046       responses:
30047         "default":
30048           description: Response codes found in [response codes](https://wiki.onap.org/).
30049       parameters:
30050         - name: network-policy-id
30051           in: path
30052           description: UUID representing unique key to this instance
30053           required: true
30054           type: string
30055           example: __NETWORK-POLICY-ID__
30056         - name: body
30057           in: body
30058           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
30059           required: true
30060           schema:
30061             $ref: "#/definitions/network-policy"
30062     patch:
30063       tags:
30064         - Network
30065       summary: update an existing network-policy
30066       description: |
30067         Update an existing network-policy
30068         #
30069         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30070         The PUT operation will entirely replace an existing object.
30071         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30072         #
30073         Other differences between PUT and PATCH are:
30074         #
30075         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30076         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30077         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30078       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30079       consumes:
30080         - application/json
30081         - application/xml
30082       produces:
30083         - application/json
30084         - application/xml
30085       responses:
30086         "default":
30087           description: Response codes found in [response codes](https://wiki.onap.org/).
30088       parameters:
30089         - name: network-policy-id
30090           in: path
30091           description: UUID representing unique key to this instance
30092           required: true
30093           type: string
30094           example: __NETWORK-POLICY-ID__
30095         - name: body
30096           in: body
30097           description: network-policy object that needs to be updated.
30098           required: true
30099           schema:
30100             $ref: "#/patchDefinitions/network-policy"
30101     delete:
30102       tags:
30103         - Network
30104       summary: delete an existing network-policy
30105       description: delete an existing network-policy
30106       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30107       consumes:
30108         - application/json
30109         - application/xml
30110       produces:
30111         - application/json
30112         - application/xml
30113       responses:
30114         "default":
30115           description: Response codes found in [response codes](https://wiki.onap.org/).
30116       parameters:
30117         - name: network-policy-id
30118           in: path
30119           description: UUID representing unique key to this instance
30120           required: true
30121           type: string
30122           example: __NETWORK-POLICY-ID__
30123         - name: resource-version
30124           in: query
30125           description: resource-version for concurrency
30126           required: true
30127           type: string
30128   /network/network-policies:
30129     get:
30130       tags:
30131         - Network
30132       summary: returns network-policies
30133       description: returns network-policies
30134       operationId: getNetworkNetworkPolicies
30135       produces:
30136         - application/json
30137         - application/xml
30138       responses:
30139         "200":
30140           description: successful operation
30141           schema:
30142               $ref: "#/getDefinitions/network-policies"
30143         "default":
30144           description: Response codes found in [response codes](https://wiki.onap.org/).
30145       parameters:
30146         - name: network-policy-id
30147           in: query
30148           description:
30149           required: false
30150           type: string
30151         - name: network-policy-fqdn
30152           in: query
30153           description:
30154           required: false
30155           type: string
30156   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30157     put:
30158       tags:
30159         - Network
30160       summary: see node definition for valid relationships
30161       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30162       consumes:
30163         - application/json
30164         - application/xml
30165       produces:
30166         - application/json
30167         - application/xml
30168       responses:
30169         "default":
30170           description: Response codes found in [response codes](https://wiki.onap.org/).
30171       parameters:
30172         - name: vnf-id
30173           in: path
30174           description: Unique id of VNF.  This is unique across the graph.
30175           required: true
30176           type: string
30177           example: __VNF-ID__
30178         - name: body
30179           in: body
30180           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
30181           required: true
30182           schema:
30183             $ref: "#/definitions/relationship"
30184     delete:
30185       tags:
30186         - Network
30187       summary: delete an existing relationship
30188       description: delete an existing relationship
30189       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30190       consumes:
30191         - application/json
30192         - application/xml
30193       produces:
30194         - application/json
30195         - application/xml
30196       responses:
30197         "default":
30198           description: Response codes found in [response codes](https://wiki.onap.org/).
30199       parameters:
30200         - name: vnf-id
30201           in: path
30202           description: Unique id of VNF.  This is unique across the graph.
30203           required: true
30204           type: string
30205           example: __VNF-ID__
30206   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30207     put:
30208       tags:
30209         - Network
30210       summary: see node definition for valid relationships
30211       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30212       consumes:
30213         - application/json
30214         - application/xml
30215       produces:
30216         - application/json
30217         - application/xml
30218       responses:
30219         "default":
30220           description: Response codes found in [response codes](https://wiki.onap.org/).
30221       parameters:
30222         - name: vnf-id
30223           in: path
30224           description: Unique id of VNF.  This is unique across the graph.
30225           required: true
30226           type: string
30227           example: __VNF-ID__
30228         - name: interface-name
30229           in: path
30230           description: Name given to the interface
30231           required: true
30232           type: string
30233           example: __INTERFACE-NAME__
30234         - name: vlan-interface
30235           in: path
30236           description: String that identifies the interface
30237           required: true
30238           type: string
30239           example: __VLAN-INTERFACE__
30240         - name: body
30241           in: body
30242           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30243           required: true
30244           schema:
30245             $ref: "#/definitions/relationship"
30246     delete:
30247       tags:
30248         - Network
30249       summary: delete an existing relationship
30250       description: delete an existing relationship
30251       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30252       consumes:
30253         - application/json
30254         - application/xml
30255       produces:
30256         - application/json
30257         - application/xml
30258       responses:
30259         "default":
30260           description: Response codes found in [response codes](https://wiki.onap.org/).
30261       parameters:
30262         - name: vnf-id
30263           in: path
30264           description: Unique id of VNF.  This is unique across the graph.
30265           required: true
30266           type: string
30267           example: __VNF-ID__
30268         - name: interface-name
30269           in: path
30270           description: Name given to the interface
30271           required: true
30272           type: string
30273           example: __INTERFACE-NAME__
30274         - name: vlan-interface
30275           in: path
30276           description: String that identifies the interface
30277           required: true
30278           type: string
30279           example: __VLAN-INTERFACE__
30280   /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:
30281     put:
30282       tags:
30283         - Network
30284       summary: see node definition for valid relationships
30285       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30286       consumes:
30287         - application/json
30288         - application/xml
30289       produces:
30290         - application/json
30291         - application/xml
30292       responses:
30293         "default":
30294           description: Response codes found in [response codes](https://wiki.onap.org/).
30295       parameters:
30296         - name: vnf-id
30297           in: path
30298           description: Unique id of VNF.  This is unique across the graph.
30299           required: true
30300           type: string
30301           example: __VNF-ID__
30302         - name: interface-name
30303           in: path
30304           description: Name given to the interface
30305           required: true
30306           type: string
30307           example: __INTERFACE-NAME__
30308         - name: vlan-interface
30309           in: path
30310           description: String that identifies the interface
30311           required: true
30312           type: string
30313           example: __VLAN-INTERFACE__
30314         - name: l3-interface-ipv4-address
30315           in: path
30316           description: IP address
30317           required: true
30318           type: string
30319           example: __L3-INTERFACE-IPV4-ADDRESS__
30320         - name: body
30321           in: body
30322           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30323           required: true
30324           schema:
30325             $ref: "#/definitions/relationship"
30326     delete:
30327       tags:
30328         - Network
30329       summary: delete an existing relationship
30330       description: delete an existing relationship
30331       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30332       consumes:
30333         - application/json
30334         - application/xml
30335       produces:
30336         - application/json
30337         - application/xml
30338       responses:
30339         "default":
30340           description: Response codes found in [response codes](https://wiki.onap.org/).
30341       parameters:
30342         - name: vnf-id
30343           in: path
30344           description: Unique id of VNF.  This is unique across the graph.
30345           required: true
30346           type: string
30347           example: __VNF-ID__
30348         - name: interface-name
30349           in: path
30350           description: Name given to the interface
30351           required: true
30352           type: string
30353           example: __INTERFACE-NAME__
30354         - name: vlan-interface
30355           in: path
30356           description: String that identifies the interface
30357           required: true
30358           type: string
30359           example: __VLAN-INTERFACE__
30360         - name: l3-interface-ipv4-address
30361           in: path
30362           description: IP address
30363           required: true
30364           type: string
30365           example: __L3-INTERFACE-IPV4-ADDRESS__
30366   /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}:
30367     get:
30368       tags:
30369         - Network
30370       summary: returns l3-interface-ipv4-address-list
30371       description: returns l3-interface-ipv4-address-list
30372       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30373       produces:
30374         - application/json
30375         - application/xml
30376       responses:
30377         "200":
30378           description: successful operation
30379           schema:
30380               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30381         "default":
30382           description: Response codes found in [response codes](https://wiki.onap.org/).
30383       parameters:
30384         - name: vnf-id
30385           in: path
30386           description: Unique id of VNF.  This is unique across the graph.
30387           required: true
30388           type: string
30389           example: __VNF-ID__
30390         - name: interface-name
30391           in: path
30392           description: Name given to the interface
30393           required: true
30394           type: string
30395           example: __INTERFACE-NAME__
30396         - name: vlan-interface
30397           in: path
30398           description: String that identifies the interface
30399           required: true
30400           type: string
30401           example: __VLAN-INTERFACE__
30402         - name: l3-interface-ipv4-address
30403           in: path
30404           description: IP address
30405           required: true
30406           type: string
30407           example: __L3-INTERFACE-IPV4-ADDRESS__
30408     put:
30409       tags:
30410         - Network
30411       summary: create or update an existing l3-interface-ipv4-address-list
30412       description: |
30413         Create or update an existing l3-interface-ipv4-address-list.
30414         #
30415         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30416       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30417       consumes:
30418         - application/json
30419         - application/xml
30420       produces:
30421         - application/json
30422         - application/xml
30423       responses:
30424         "default":
30425           description: Response codes found in [response codes](https://wiki.onap.org/).
30426       parameters:
30427         - name: vnf-id
30428           in: path
30429           description: Unique id of VNF.  This is unique across the graph.
30430           required: true
30431           type: string
30432           example: __VNF-ID__
30433         - name: interface-name
30434           in: path
30435           description: Name given to the interface
30436           required: true
30437           type: string
30438           example: __INTERFACE-NAME__
30439         - name: vlan-interface
30440           in: path
30441           description: String that identifies the interface
30442           required: true
30443           type: string
30444           example: __VLAN-INTERFACE__
30445         - name: l3-interface-ipv4-address
30446           in: path
30447           description: IP address
30448           required: true
30449           type: string
30450           example: __L3-INTERFACE-IPV4-ADDRESS__
30451         - name: body
30452           in: body
30453           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30454           required: true
30455           schema:
30456             $ref: "#/definitions/l3-interface-ipv4-address-list"
30457     patch:
30458       tags:
30459         - Network
30460       summary: update an existing l3-interface-ipv4-address-list
30461       description: |
30462         Update an existing l3-interface-ipv4-address-list
30463         #
30464         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30465         The PUT operation will entirely replace an existing object.
30466         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30467         #
30468         Other differences between PUT and PATCH are:
30469         #
30470         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30471         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30472         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30473       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30474       consumes:
30475         - application/json
30476         - application/xml
30477       produces:
30478         - application/json
30479         - application/xml
30480       responses:
30481         "default":
30482           description: Response codes found in [response codes](https://wiki.onap.org/).
30483       parameters:
30484         - name: vnf-id
30485           in: path
30486           description: Unique id of VNF.  This is unique across the graph.
30487           required: true
30488           type: string
30489           example: __VNF-ID__
30490         - name: interface-name
30491           in: path
30492           description: Name given to the interface
30493           required: true
30494           type: string
30495           example: __INTERFACE-NAME__
30496         - name: vlan-interface
30497           in: path
30498           description: String that identifies the interface
30499           required: true
30500           type: string
30501           example: __VLAN-INTERFACE__
30502         - name: l3-interface-ipv4-address
30503           in: path
30504           description: IP address
30505           required: true
30506           type: string
30507           example: __L3-INTERFACE-IPV4-ADDRESS__
30508         - name: body
30509           in: body
30510           description: l3-interface-ipv4-address-list object that needs to be updated.
30511           required: true
30512           schema:
30513             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30514     delete:
30515       tags:
30516         - Network
30517       summary: delete an existing l3-interface-ipv4-address-list
30518       description: delete an existing l3-interface-ipv4-address-list
30519       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30520       consumes:
30521         - application/json
30522         - application/xml
30523       produces:
30524         - application/json
30525         - application/xml
30526       responses:
30527         "default":
30528           description: Response codes found in [response codes](https://wiki.onap.org/).
30529       parameters:
30530         - name: vnf-id
30531           in: path
30532           description: Unique id of VNF.  This is unique across the graph.
30533           required: true
30534           type: string
30535           example: __VNF-ID__
30536         - name: interface-name
30537           in: path
30538           description: Name given to the interface
30539           required: true
30540           type: string
30541           example: __INTERFACE-NAME__
30542         - name: vlan-interface
30543           in: path
30544           description: String that identifies the interface
30545           required: true
30546           type: string
30547           example: __VLAN-INTERFACE__
30548         - name: l3-interface-ipv4-address
30549           in: path
30550           description: IP address
30551           required: true
30552           type: string
30553           example: __L3-INTERFACE-IPV4-ADDRESS__
30554         - name: resource-version
30555           in: query
30556           description: resource-version for concurrency
30557           required: true
30558           type: string
30559   /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:
30560     put:
30561       tags:
30562         - Network
30563       summary: see node definition for valid relationships
30564       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30565       consumes:
30566         - application/json
30567         - application/xml
30568       produces:
30569         - application/json
30570         - application/xml
30571       responses:
30572         "default":
30573           description: Response codes found in [response codes](https://wiki.onap.org/).
30574       parameters:
30575         - name: vnf-id
30576           in: path
30577           description: Unique id of VNF.  This is unique across the graph.
30578           required: true
30579           type: string
30580           example: __VNF-ID__
30581         - name: interface-name
30582           in: path
30583           description: Name given to the interface
30584           required: true
30585           type: string
30586           example: __INTERFACE-NAME__
30587         - name: vlan-interface
30588           in: path
30589           description: String that identifies the interface
30590           required: true
30591           type: string
30592           example: __VLAN-INTERFACE__
30593         - name: l3-interface-ipv6-address
30594           in: path
30595           description: IP address
30596           required: true
30597           type: string
30598           example: __L3-INTERFACE-IPV6-ADDRESS__
30599         - name: body
30600           in: body
30601           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30602           required: true
30603           schema:
30604             $ref: "#/definitions/relationship"
30605     delete:
30606       tags:
30607         - Network
30608       summary: delete an existing relationship
30609       description: delete an existing relationship
30610       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30611       consumes:
30612         - application/json
30613         - application/xml
30614       produces:
30615         - application/json
30616         - application/xml
30617       responses:
30618         "default":
30619           description: Response codes found in [response codes](https://wiki.onap.org/).
30620       parameters:
30621         - name: vnf-id
30622           in: path
30623           description: Unique id of VNF.  This is unique across the graph.
30624           required: true
30625           type: string
30626           example: __VNF-ID__
30627         - name: interface-name
30628           in: path
30629           description: Name given to the interface
30630           required: true
30631           type: string
30632           example: __INTERFACE-NAME__
30633         - name: vlan-interface
30634           in: path
30635           description: String that identifies the interface
30636           required: true
30637           type: string
30638           example: __VLAN-INTERFACE__
30639         - name: l3-interface-ipv6-address
30640           in: path
30641           description: IP address
30642           required: true
30643           type: string
30644           example: __L3-INTERFACE-IPV6-ADDRESS__
30645   /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}:
30646     get:
30647       tags:
30648         - Network
30649       summary: returns l3-interface-ipv6-address-list
30650       description: returns l3-interface-ipv6-address-list
30651       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30652       produces:
30653         - application/json
30654         - application/xml
30655       responses:
30656         "200":
30657           description: successful operation
30658           schema:
30659               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30660         "default":
30661           description: Response codes found in [response codes](https://wiki.onap.org/).
30662       parameters:
30663         - name: vnf-id
30664           in: path
30665           description: Unique id of VNF.  This is unique across the graph.
30666           required: true
30667           type: string
30668           example: __VNF-ID__
30669         - name: interface-name
30670           in: path
30671           description: Name given to the interface
30672           required: true
30673           type: string
30674           example: __INTERFACE-NAME__
30675         - name: vlan-interface
30676           in: path
30677           description: String that identifies the interface
30678           required: true
30679           type: string
30680           example: __VLAN-INTERFACE__
30681         - name: l3-interface-ipv6-address
30682           in: path
30683           description: IP address
30684           required: true
30685           type: string
30686           example: __L3-INTERFACE-IPV6-ADDRESS__
30687     put:
30688       tags:
30689         - Network
30690       summary: create or update an existing l3-interface-ipv6-address-list
30691       description: |
30692         Create or update an existing l3-interface-ipv6-address-list.
30693         #
30694         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30695       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30696       consumes:
30697         - application/json
30698         - application/xml
30699       produces:
30700         - application/json
30701         - application/xml
30702       responses:
30703         "default":
30704           description: Response codes found in [response codes](https://wiki.onap.org/).
30705       parameters:
30706         - name: vnf-id
30707           in: path
30708           description: Unique id of VNF.  This is unique across the graph.
30709           required: true
30710           type: string
30711           example: __VNF-ID__
30712         - name: interface-name
30713           in: path
30714           description: Name given to the interface
30715           required: true
30716           type: string
30717           example: __INTERFACE-NAME__
30718         - name: vlan-interface
30719           in: path
30720           description: String that identifies the interface
30721           required: true
30722           type: string
30723           example: __VLAN-INTERFACE__
30724         - name: l3-interface-ipv6-address
30725           in: path
30726           description: IP address
30727           required: true
30728           type: string
30729           example: __L3-INTERFACE-IPV6-ADDRESS__
30730         - name: body
30731           in: body
30732           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30733           required: true
30734           schema:
30735             $ref: "#/definitions/l3-interface-ipv6-address-list"
30736     patch:
30737       tags:
30738         - Network
30739       summary: update an existing l3-interface-ipv6-address-list
30740       description: |
30741         Update an existing l3-interface-ipv6-address-list
30742         #
30743         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30744         The PUT operation will entirely replace an existing object.
30745         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30746         #
30747         Other differences between PUT and PATCH are:
30748         #
30749         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30750         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30751         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30752       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30753       consumes:
30754         - application/json
30755         - application/xml
30756       produces:
30757         - application/json
30758         - application/xml
30759       responses:
30760         "default":
30761           description: Response codes found in [response codes](https://wiki.onap.org/).
30762       parameters:
30763         - name: vnf-id
30764           in: path
30765           description: Unique id of VNF.  This is unique across the graph.
30766           required: true
30767           type: string
30768           example: __VNF-ID__
30769         - name: interface-name
30770           in: path
30771           description: Name given to the interface
30772           required: true
30773           type: string
30774           example: __INTERFACE-NAME__
30775         - name: vlan-interface
30776           in: path
30777           description: String that identifies the interface
30778           required: true
30779           type: string
30780           example: __VLAN-INTERFACE__
30781         - name: l3-interface-ipv6-address
30782           in: path
30783           description: IP address
30784           required: true
30785           type: string
30786           example: __L3-INTERFACE-IPV6-ADDRESS__
30787         - name: body
30788           in: body
30789           description: l3-interface-ipv6-address-list object that needs to be updated.
30790           required: true
30791           schema:
30792             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30793     delete:
30794       tags:
30795         - Network
30796       summary: delete an existing l3-interface-ipv6-address-list
30797       description: delete an existing l3-interface-ipv6-address-list
30798       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30799       consumes:
30800         - application/json
30801         - application/xml
30802       produces:
30803         - application/json
30804         - application/xml
30805       responses:
30806         "default":
30807           description: Response codes found in [response codes](https://wiki.onap.org/).
30808       parameters:
30809         - name: vnf-id
30810           in: path
30811           description: Unique id of VNF.  This is unique across the graph.
30812           required: true
30813           type: string
30814           example: __VNF-ID__
30815         - name: interface-name
30816           in: path
30817           description: Name given to the interface
30818           required: true
30819           type: string
30820           example: __INTERFACE-NAME__
30821         - name: vlan-interface
30822           in: path
30823           description: String that identifies the interface
30824           required: true
30825           type: string
30826           example: __VLAN-INTERFACE__
30827         - name: l3-interface-ipv6-address
30828           in: path
30829           description: IP address
30830           required: true
30831           type: string
30832           example: __L3-INTERFACE-IPV6-ADDRESS__
30833         - name: resource-version
30834           in: query
30835           description: resource-version for concurrency
30836           required: true
30837           type: string
30838   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
30839     get:
30840       tags:
30841         - Network
30842       summary: returns vlan
30843       description: returns vlan
30844       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30845       produces:
30846         - application/json
30847         - application/xml
30848       responses:
30849         "200":
30850           description: successful operation
30851           schema:
30852               $ref: "#/getDefinitions/vlan"
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 given to the interface
30865           required: true
30866           type: string
30867           example: __INTERFACE-NAME__
30868         - name: vlan-interface
30869           in: path
30870           description: String that identifies the interface
30871           required: true
30872           type: string
30873           example: __VLAN-INTERFACE__
30874     put:
30875       tags:
30876         - Network
30877       summary: create or update an existing vlan
30878       description: |
30879         Create or update an existing vlan.
30880         #
30881         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30882       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30883       consumes:
30884         - application/json
30885         - application/xml
30886       produces:
30887         - application/json
30888         - application/xml
30889       responses:
30890         "default":
30891           description: Response codes found in [response codes](https://wiki.onap.org/).
30892       parameters:
30893         - name: vnf-id
30894           in: path
30895           description: Unique id of VNF.  This is unique across the graph.
30896           required: true
30897           type: string
30898           example: __VNF-ID__
30899         - name: interface-name
30900           in: path
30901           description: Name given to the interface
30902           required: true
30903           type: string
30904           example: __INTERFACE-NAME__
30905         - name: vlan-interface
30906           in: path
30907           description: String that identifies the interface
30908           required: true
30909           type: string
30910           example: __VLAN-INTERFACE__
30911         - name: body
30912           in: body
30913           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30914           required: true
30915           schema:
30916             $ref: "#/definitions/vlan"
30917     patch:
30918       tags:
30919         - Network
30920       summary: update an existing vlan
30921       description: |
30922         Update an existing vlan
30923         #
30924         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30925         The PUT operation will entirely replace an existing object.
30926         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30927         #
30928         Other differences between PUT and PATCH are:
30929         #
30930         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30931         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30932         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30933       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30934       consumes:
30935         - application/json
30936         - application/xml
30937       produces:
30938         - application/json
30939         - application/xml
30940       responses:
30941         "default":
30942           description: Response codes found in [response codes](https://wiki.onap.org/).
30943       parameters:
30944         - name: vnf-id
30945           in: path
30946           description: Unique id of VNF.  This is unique across the graph.
30947           required: true
30948           type: string
30949           example: __VNF-ID__
30950         - name: interface-name
30951           in: path
30952           description: Name given to the interface
30953           required: true
30954           type: string
30955           example: __INTERFACE-NAME__
30956         - name: vlan-interface
30957           in: path
30958           description: String that identifies the interface
30959           required: true
30960           type: string
30961           example: __VLAN-INTERFACE__
30962         - name: body
30963           in: body
30964           description: vlan object that needs to be updated.
30965           required: true
30966           schema:
30967             $ref: "#/patchDefinitions/vlan"
30968     delete:
30969       tags:
30970         - Network
30971       summary: delete an existing vlan
30972       description: delete an existing vlan
30973       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30974       consumes:
30975         - application/json
30976         - application/xml
30977       produces:
30978         - application/json
30979         - application/xml
30980       responses:
30981         "default":
30982           description: Response codes found in [response codes](https://wiki.onap.org/).
30983       parameters:
30984         - name: vnf-id
30985           in: path
30986           description: Unique id of VNF.  This is unique across the graph.
30987           required: true
30988           type: string
30989           example: __VNF-ID__
30990         - name: interface-name
30991           in: path
30992           description: Name given to the interface
30993           required: true
30994           type: string
30995           example: __INTERFACE-NAME__
30996         - name: vlan-interface
30997           in: path
30998           description: String that identifies the interface
30999           required: true
31000           type: string
31001           example: __VLAN-INTERFACE__
31002         - name: resource-version
31003           in: query
31004           description: resource-version for concurrency
31005           required: true
31006           type: string
31007   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31008     get:
31009       tags:
31010         - Network
31011       summary: returns vlans
31012       description: returns vlans
31013       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31014       produces:
31015         - application/json
31016         - application/xml
31017       responses:
31018         "200":
31019           description: successful operation
31020           schema:
31021               $ref: "#/getDefinitions/vlans"
31022         "default":
31023           description: Response codes found in [response codes](https://wiki.onap.org/).
31024       parameters:
31025         - name: vnf-id
31026           in: path
31027           description: Unique id of VNF.  This is unique across the graph.
31028           required: true
31029           type: string
31030           example: __VNF-ID__
31031         - name: interface-name
31032           in: path
31033           description: Name given to the interface
31034           required: true
31035           type: string
31036           example: __INTERFACE-NAME__
31037         - name: vlan-interface
31038           in: query
31039           description:
31040           required: false
31041           type: string
31042         - name: vlan-id-inner
31043           in: query
31044           description:
31045           required: false
31046           type: integer
31047           format: int64
31048         - name: vpn-key
31049           in: query
31050           description:
31051           required: false
31052           type: string
31053   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31054     put:
31055       tags:
31056         - Network
31057       summary: see node definition for valid relationships
31058       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31059       consumes:
31060         - application/json
31061         - application/xml
31062       produces:
31063         - application/json
31064         - application/xml
31065       responses:
31066         "default":
31067           description: Response codes found in [response codes](https://wiki.onap.org/).
31068       parameters:
31069         - name: vnf-id
31070           in: path
31071           description: Unique id of VNF.  This is unique across the graph.
31072           required: true
31073           type: string
31074           example: __VNF-ID__
31075         - name: interface-name
31076           in: path
31077           description: Name given to the interface
31078           required: true
31079           type: string
31080           example: __INTERFACE-NAME__
31081         - name: pci-id
31082           in: path
31083           description: PCI ID used to identify the sriov-vf
31084           required: true
31085           type: string
31086           example: __PCI-ID__
31087         - name: body
31088           in: body
31089           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31090           required: true
31091           schema:
31092             $ref: "#/definitions/relationship"
31093     delete:
31094       tags:
31095         - Network
31096       summary: delete an existing relationship
31097       description: delete an existing relationship
31098       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31099       consumes:
31100         - application/json
31101         - application/xml
31102       produces:
31103         - application/json
31104         - application/xml
31105       responses:
31106         "default":
31107           description: Response codes found in [response codes](https://wiki.onap.org/).
31108       parameters:
31109         - name: vnf-id
31110           in: path
31111           description: Unique id of VNF.  This is unique across the graph.
31112           required: true
31113           type: string
31114           example: __VNF-ID__
31115         - name: interface-name
31116           in: path
31117           description: Name given to the interface
31118           required: true
31119           type: string
31120           example: __INTERFACE-NAME__
31121         - name: pci-id
31122           in: path
31123           description: PCI ID used to identify the sriov-vf
31124           required: true
31125           type: string
31126           example: __PCI-ID__
31127   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31128     get:
31129       tags:
31130         - Network
31131       summary: returns sriov-vf
31132       description: returns sriov-vf
31133       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31134       produces:
31135         - application/json
31136         - application/xml
31137       responses:
31138         "200":
31139           description: successful operation
31140           schema:
31141               $ref: "#/getDefinitions/sriov-vf"
31142         "default":
31143           description: Response codes found in [response codes](https://wiki.onap.org/).
31144       parameters:
31145         - name: vnf-id
31146           in: path
31147           description: Unique id of VNF.  This is unique across the graph.
31148           required: true
31149           type: string
31150           example: __VNF-ID__
31151         - name: interface-name
31152           in: path
31153           description: Name given to the interface
31154           required: true
31155           type: string
31156           example: __INTERFACE-NAME__
31157         - name: pci-id
31158           in: path
31159           description: PCI ID used to identify the sriov-vf
31160           required: true
31161           type: string
31162           example: __PCI-ID__
31163     put:
31164       tags:
31165         - Network
31166       summary: create or update an existing sriov-vf
31167       description: |
31168         Create or update an existing sriov-vf.
31169         #
31170         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31171       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31172       consumes:
31173         - application/json
31174         - application/xml
31175       produces:
31176         - application/json
31177         - application/xml
31178       responses:
31179         "default":
31180           description: Response codes found in [response codes](https://wiki.onap.org/).
31181       parameters:
31182         - name: vnf-id
31183           in: path
31184           description: Unique id of VNF.  This is unique across the graph.
31185           required: true
31186           type: string
31187           example: __VNF-ID__
31188         - name: interface-name
31189           in: path
31190           description: Name given to the interface
31191           required: true
31192           type: string
31193           example: __INTERFACE-NAME__
31194         - name: pci-id
31195           in: path
31196           description: PCI ID used to identify the sriov-vf
31197           required: true
31198           type: string
31199           example: __PCI-ID__
31200         - name: body
31201           in: body
31202           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31203           required: true
31204           schema:
31205             $ref: "#/definitions/sriov-vf"
31206     patch:
31207       tags:
31208         - Network
31209       summary: update an existing sriov-vf
31210       description: |
31211         Update an existing sriov-vf
31212         #
31213         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31214         The PUT operation will entirely replace an existing object.
31215         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31216         #
31217         Other differences between PUT and PATCH are:
31218         #
31219         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31220         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31221         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31222       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31223       consumes:
31224         - application/json
31225         - application/xml
31226       produces:
31227         - application/json
31228         - application/xml
31229       responses:
31230         "default":
31231           description: Response codes found in [response codes](https://wiki.onap.org/).
31232       parameters:
31233         - name: vnf-id
31234           in: path
31235           description: Unique id of VNF.  This is unique across the graph.
31236           required: true
31237           type: string
31238           example: __VNF-ID__
31239         - name: interface-name
31240           in: path
31241           description: Name given to the interface
31242           required: true
31243           type: string
31244           example: __INTERFACE-NAME__
31245         - name: pci-id
31246           in: path
31247           description: PCI ID used to identify the sriov-vf
31248           required: true
31249           type: string
31250           example: __PCI-ID__
31251         - name: body
31252           in: body
31253           description: sriov-vf object that needs to be updated.
31254           required: true
31255           schema:
31256             $ref: "#/patchDefinitions/sriov-vf"
31257     delete:
31258       tags:
31259         - Network
31260       summary: delete an existing sriov-vf
31261       description: delete an existing sriov-vf
31262       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31263       consumes:
31264         - application/json
31265         - application/xml
31266       produces:
31267         - application/json
31268         - application/xml
31269       responses:
31270         "default":
31271           description: Response codes found in [response codes](https://wiki.onap.org/).
31272       parameters:
31273         - name: vnf-id
31274           in: path
31275           description: Unique id of VNF.  This is unique across the graph.
31276           required: true
31277           type: string
31278           example: __VNF-ID__
31279         - name: interface-name
31280           in: path
31281           description: Name given to the interface
31282           required: true
31283           type: string
31284           example: __INTERFACE-NAME__
31285         - name: pci-id
31286           in: path
31287           description: PCI ID used to identify the sriov-vf
31288           required: true
31289           type: string
31290           example: __PCI-ID__
31291         - name: resource-version
31292           in: query
31293           description: resource-version for concurrency
31294           required: true
31295           type: string
31296   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
31297     get:
31298       tags:
31299         - Network
31300       summary: returns sriov-vfs
31301       description: returns sriov-vfs
31302       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
31303       produces:
31304         - application/json
31305         - application/xml
31306       responses:
31307         "200":
31308           description: successful operation
31309           schema:
31310               $ref: "#/getDefinitions/sriov-vfs"
31311         "default":
31312           description: Response codes found in [response codes](https://wiki.onap.org/).
31313       parameters:
31314         - name: vnf-id
31315           in: path
31316           description: Unique id of VNF.  This is unique across the graph.
31317           required: true
31318           type: string
31319           example: __VNF-ID__
31320         - name: interface-name
31321           in: path
31322           description: Name given to the interface
31323           required: true
31324           type: string
31325           example: __INTERFACE-NAME__
31326         - name: pci-id
31327           in: query
31328           description:
31329           required: false
31330           type: string
31331         - name: vf-vlan-filter
31332           in: query
31333           description:
31334           required: false
31335           type: string
31336         - name: vf-mac-filter
31337           in: query
31338           description:
31339           required: false
31340           type: string
31341         - name: vf-vlan-strip
31342           in: query
31343           description:
31344           required: false
31345           type: boolean
31346         - name: neutron-network-id
31347           in: query
31348           description:
31349           required: false
31350           type: string
31351   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
31352     put:
31353       tags:
31354         - Network
31355       summary: see node definition for valid relationships
31356       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
31357       consumes:
31358         - application/json
31359         - application/xml
31360       produces:
31361         - application/json
31362         - application/xml
31363       responses:
31364         "default":
31365           description: Response codes found in [response codes](https://wiki.onap.org/).
31366       parameters:
31367         - name: vnf-id
31368           in: path
31369           description: Unique id of VNF.  This is unique across the graph.
31370           required: true
31371           type: string
31372           example: __VNF-ID__
31373         - name: interface-name
31374           in: path
31375           description: Name given to the interface
31376           required: true
31377           type: string
31378           example: __INTERFACE-NAME__
31379         - name: body
31380           in: body
31381           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
31382           required: true
31383           schema:
31384             $ref: "#/definitions/relationship"
31385     delete:
31386       tags:
31387         - Network
31388       summary: delete an existing relationship
31389       description: delete an existing relationship
31390       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
31391       consumes:
31392         - application/json
31393         - application/xml
31394       produces:
31395         - application/json
31396         - application/xml
31397       responses:
31398         "default":
31399           description: Response codes found in [response codes](https://wiki.onap.org/).
31400       parameters:
31401         - name: vnf-id
31402           in: path
31403           description: Unique id of VNF.  This is unique across the graph.
31404           required: true
31405           type: string
31406           example: __VNF-ID__
31407         - name: interface-name
31408           in: path
31409           description: Name given to the interface
31410           required: true
31411           type: string
31412           example: __INTERFACE-NAME__
31413   /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:
31414     put:
31415       tags:
31416         - Network
31417       summary: see node definition for valid relationships
31418       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31419       consumes:
31420         - application/json
31421         - application/xml
31422       produces:
31423         - application/json
31424         - application/xml
31425       responses:
31426         "default":
31427           description: Response codes found in [response codes](https://wiki.onap.org/).
31428       parameters:
31429         - name: vnf-id
31430           in: path
31431           description: Unique id of VNF.  This is unique across the graph.
31432           required: true
31433           type: string
31434           example: __VNF-ID__
31435         - name: interface-name
31436           in: path
31437           description: Name given to the interface
31438           required: true
31439           type: string
31440           example: __INTERFACE-NAME__
31441         - name: l3-interface-ipv4-address
31442           in: path
31443           description: IP address
31444           required: true
31445           type: string
31446           example: __L3-INTERFACE-IPV4-ADDRESS__
31447         - name: body
31448           in: body
31449           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31450           required: true
31451           schema:
31452             $ref: "#/definitions/relationship"
31453     delete:
31454       tags:
31455         - Network
31456       summary: delete an existing relationship
31457       description: delete an existing relationship
31458       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31459       consumes:
31460         - application/json
31461         - application/xml
31462       produces:
31463         - application/json
31464         - application/xml
31465       responses:
31466         "default":
31467           description: Response codes found in [response codes](https://wiki.onap.org/).
31468       parameters:
31469         - name: vnf-id
31470           in: path
31471           description: Unique id of VNF.  This is unique across the graph.
31472           required: true
31473           type: string
31474           example: __VNF-ID__
31475         - name: interface-name
31476           in: path
31477           description: Name given to the interface
31478           required: true
31479           type: string
31480           example: __INTERFACE-NAME__
31481         - name: l3-interface-ipv4-address
31482           in: path
31483           description: IP address
31484           required: true
31485           type: string
31486           example: __L3-INTERFACE-IPV4-ADDRESS__
31487   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31488     get:
31489       tags:
31490         - Network
31491       summary: returns l3-interface-ipv4-address-list
31492       description: returns l3-interface-ipv4-address-list
31493       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31494       produces:
31495         - application/json
31496         - application/xml
31497       responses:
31498         "200":
31499           description: successful operation
31500           schema:
31501               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31502         "default":
31503           description: Response codes found in [response codes](https://wiki.onap.org/).
31504       parameters:
31505         - name: vnf-id
31506           in: path
31507           description: Unique id of VNF.  This is unique across the graph.
31508           required: true
31509           type: string
31510           example: __VNF-ID__
31511         - name: interface-name
31512           in: path
31513           description: Name given to the interface
31514           required: true
31515           type: string
31516           example: __INTERFACE-NAME__
31517         - name: l3-interface-ipv4-address
31518           in: path
31519           description: IP address
31520           required: true
31521           type: string
31522           example: __L3-INTERFACE-IPV4-ADDRESS__
31523     put:
31524       tags:
31525         - Network
31526       summary: create or update an existing l3-interface-ipv4-address-list
31527       description: |
31528         Create or update an existing l3-interface-ipv4-address-list.
31529         #
31530         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31531       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31532       consumes:
31533         - application/json
31534         - application/xml
31535       produces:
31536         - application/json
31537         - application/xml
31538       responses:
31539         "default":
31540           description: Response codes found in [response codes](https://wiki.onap.org/).
31541       parameters:
31542         - name: vnf-id
31543           in: path
31544           description: Unique id of VNF.  This is unique across the graph.
31545           required: true
31546           type: string
31547           example: __VNF-ID__
31548         - name: interface-name
31549           in: path
31550           description: Name given to the interface
31551           required: true
31552           type: string
31553           example: __INTERFACE-NAME__
31554         - name: l3-interface-ipv4-address
31555           in: path
31556           description: IP address
31557           required: true
31558           type: string
31559           example: __L3-INTERFACE-IPV4-ADDRESS__
31560         - name: body
31561           in: body
31562           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31563           required: true
31564           schema:
31565             $ref: "#/definitions/l3-interface-ipv4-address-list"
31566     patch:
31567       tags:
31568         - Network
31569       summary: update an existing l3-interface-ipv4-address-list
31570       description: |
31571         Update an existing l3-interface-ipv4-address-list
31572         #
31573         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31574         The PUT operation will entirely replace an existing object.
31575         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31576         #
31577         Other differences between PUT and PATCH are:
31578         #
31579         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31580         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31581         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31582       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31583       consumes:
31584         - application/json
31585         - application/xml
31586       produces:
31587         - application/json
31588         - application/xml
31589       responses:
31590         "default":
31591           description: Response codes found in [response codes](https://wiki.onap.org/).
31592       parameters:
31593         - name: vnf-id
31594           in: path
31595           description: Unique id of VNF.  This is unique across the graph.
31596           required: true
31597           type: string
31598           example: __VNF-ID__
31599         - name: interface-name
31600           in: path
31601           description: Name given to the interface
31602           required: true
31603           type: string
31604           example: __INTERFACE-NAME__
31605         - name: l3-interface-ipv4-address
31606           in: path
31607           description: IP address
31608           required: true
31609           type: string
31610           example: __L3-INTERFACE-IPV4-ADDRESS__
31611         - name: body
31612           in: body
31613           description: l3-interface-ipv4-address-list object that needs to be updated.
31614           required: true
31615           schema:
31616             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31617     delete:
31618       tags:
31619         - Network
31620       summary: delete an existing l3-interface-ipv4-address-list
31621       description: delete an existing l3-interface-ipv4-address-list
31622       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31623       consumes:
31624         - application/json
31625         - application/xml
31626       produces:
31627         - application/json
31628         - application/xml
31629       responses:
31630         "default":
31631           description: Response codes found in [response codes](https://wiki.onap.org/).
31632       parameters:
31633         - name: vnf-id
31634           in: path
31635           description: Unique id of VNF.  This is unique across the graph.
31636           required: true
31637           type: string
31638           example: __VNF-ID__
31639         - name: interface-name
31640           in: path
31641           description: Name given to the interface
31642           required: true
31643           type: string
31644           example: __INTERFACE-NAME__
31645         - name: l3-interface-ipv4-address
31646           in: path
31647           description: IP address
31648           required: true
31649           type: string
31650           example: __L3-INTERFACE-IPV4-ADDRESS__
31651         - name: resource-version
31652           in: query
31653           description: resource-version for concurrency
31654           required: true
31655           type: string
31656   /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:
31657     put:
31658       tags:
31659         - Network
31660       summary: see node definition for valid relationships
31661       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31662       consumes:
31663         - application/json
31664         - application/xml
31665       produces:
31666         - application/json
31667         - application/xml
31668       responses:
31669         "default":
31670           description: Response codes found in [response codes](https://wiki.onap.org/).
31671       parameters:
31672         - name: vnf-id
31673           in: path
31674           description: Unique id of VNF.  This is unique across the graph.
31675           required: true
31676           type: string
31677           example: __VNF-ID__
31678         - name: interface-name
31679           in: path
31680           description: Name given to the interface
31681           required: true
31682           type: string
31683           example: __INTERFACE-NAME__
31684         - name: l3-interface-ipv6-address
31685           in: path
31686           description: IP address
31687           required: true
31688           type: string
31689           example: __L3-INTERFACE-IPV6-ADDRESS__
31690         - name: body
31691           in: body
31692           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31693           required: true
31694           schema:
31695             $ref: "#/definitions/relationship"
31696     delete:
31697       tags:
31698         - Network
31699       summary: delete an existing relationship
31700       description: delete an existing relationship
31701       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31702       consumes:
31703         - application/json
31704         - application/xml
31705       produces:
31706         - application/json
31707         - application/xml
31708       responses:
31709         "default":
31710           description: Response codes found in [response codes](https://wiki.onap.org/).
31711       parameters:
31712         - name: vnf-id
31713           in: path
31714           description: Unique id of VNF.  This is unique across the graph.
31715           required: true
31716           type: string
31717           example: __VNF-ID__
31718         - name: interface-name
31719           in: path
31720           description: Name given to the interface
31721           required: true
31722           type: string
31723           example: __INTERFACE-NAME__
31724         - name: l3-interface-ipv6-address
31725           in: path
31726           description: IP address
31727           required: true
31728           type: string
31729           example: __L3-INTERFACE-IPV6-ADDRESS__
31730   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31731     get:
31732       tags:
31733         - Network
31734       summary: returns l3-interface-ipv6-address-list
31735       description: returns l3-interface-ipv6-address-list
31736       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31737       produces:
31738         - application/json
31739         - application/xml
31740       responses:
31741         "200":
31742           description: successful operation
31743           schema:
31744               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31745         "default":
31746           description: Response codes found in [response codes](https://wiki.onap.org/).
31747       parameters:
31748         - name: vnf-id
31749           in: path
31750           description: Unique id of VNF.  This is unique across the graph.
31751           required: true
31752           type: string
31753           example: __VNF-ID__
31754         - name: interface-name
31755           in: path
31756           description: Name given to the interface
31757           required: true
31758           type: string
31759           example: __INTERFACE-NAME__
31760         - name: l3-interface-ipv6-address
31761           in: path
31762           description: IP address
31763           required: true
31764           type: string
31765           example: __L3-INTERFACE-IPV6-ADDRESS__
31766     put:
31767       tags:
31768         - Network
31769       summary: create or update an existing l3-interface-ipv6-address-list
31770       description: |
31771         Create or update an existing l3-interface-ipv6-address-list.
31772         #
31773         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31774       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31775       consumes:
31776         - application/json
31777         - application/xml
31778       produces:
31779         - application/json
31780         - application/xml
31781       responses:
31782         "default":
31783           description: Response codes found in [response codes](https://wiki.onap.org/).
31784       parameters:
31785         - name: vnf-id
31786           in: path
31787           description: Unique id of VNF.  This is unique across the graph.
31788           required: true
31789           type: string
31790           example: __VNF-ID__
31791         - name: interface-name
31792           in: path
31793           description: Name given to the interface
31794           required: true
31795           type: string
31796           example: __INTERFACE-NAME__
31797         - name: l3-interface-ipv6-address
31798           in: path
31799           description: IP address
31800           required: true
31801           type: string
31802           example: __L3-INTERFACE-IPV6-ADDRESS__
31803         - name: body
31804           in: body
31805           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31806           required: true
31807           schema:
31808             $ref: "#/definitions/l3-interface-ipv6-address-list"
31809     patch:
31810       tags:
31811         - Network
31812       summary: update an existing l3-interface-ipv6-address-list
31813       description: |
31814         Update an existing l3-interface-ipv6-address-list
31815         #
31816         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31817         The PUT operation will entirely replace an existing object.
31818         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31819         #
31820         Other differences between PUT and PATCH are:
31821         #
31822         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31823         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31824         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31825       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31826       consumes:
31827         - application/json
31828         - application/xml
31829       produces:
31830         - application/json
31831         - application/xml
31832       responses:
31833         "default":
31834           description: Response codes found in [response codes](https://wiki.onap.org/).
31835       parameters:
31836         - name: vnf-id
31837           in: path
31838           description: Unique id of VNF.  This is unique across the graph.
31839           required: true
31840           type: string
31841           example: __VNF-ID__
31842         - name: interface-name
31843           in: path
31844           description: Name given to the interface
31845           required: true
31846           type: string
31847           example: __INTERFACE-NAME__
31848         - name: l3-interface-ipv6-address
31849           in: path
31850           description: IP address
31851           required: true
31852           type: string
31853           example: __L3-INTERFACE-IPV6-ADDRESS__
31854         - name: body
31855           in: body
31856           description: l3-interface-ipv6-address-list object that needs to be updated.
31857           required: true
31858           schema:
31859             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31860     delete:
31861       tags:
31862         - Network
31863       summary: delete an existing l3-interface-ipv6-address-list
31864       description: delete an existing l3-interface-ipv6-address-list
31865       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31866       consumes:
31867         - application/json
31868         - application/xml
31869       produces:
31870         - application/json
31871         - application/xml
31872       responses:
31873         "default":
31874           description: Response codes found in [response codes](https://wiki.onap.org/).
31875       parameters:
31876         - name: vnf-id
31877           in: path
31878           description: Unique id of VNF.  This is unique across the graph.
31879           required: true
31880           type: string
31881           example: __VNF-ID__
31882         - name: interface-name
31883           in: path
31884           description: Name given to the interface
31885           required: true
31886           type: string
31887           example: __INTERFACE-NAME__
31888         - name: l3-interface-ipv6-address
31889           in: path
31890           description: IP address
31891           required: true
31892           type: string
31893           example: __L3-INTERFACE-IPV6-ADDRESS__
31894         - name: resource-version
31895           in: query
31896           description: resource-version for concurrency
31897           required: true
31898           type: string
31899   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
31900     get:
31901       tags:
31902         - Network
31903       summary: returns l-interface
31904       description: returns l-interface
31905       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
31906       produces:
31907         - application/json
31908         - application/xml
31909       responses:
31910         "200":
31911           description: successful operation
31912           schema:
31913               $ref: "#/getDefinitions/l-interface"
31914         "default":
31915           description: Response codes found in [response codes](https://wiki.onap.org/).
31916       parameters:
31917         - name: vnf-id
31918           in: path
31919           description: Unique id of VNF.  This is unique across the graph.
31920           required: true
31921           type: string
31922           example: __VNF-ID__
31923         - name: interface-name
31924           in: path
31925           description: Name given to the interface
31926           required: true
31927           type: string
31928           example: __INTERFACE-NAME__
31929     put:
31930       tags:
31931         - Network
31932       summary: create or update an existing l-interface
31933       description: |
31934         Create or update an existing l-interface.
31935         #
31936         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31937       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
31938       consumes:
31939         - application/json
31940         - application/xml
31941       produces:
31942         - application/json
31943         - application/xml
31944       responses:
31945         "default":
31946           description: Response codes found in [response codes](https://wiki.onap.org/).
31947       parameters:
31948         - name: vnf-id
31949           in: path
31950           description: Unique id of VNF.  This is unique across the graph.
31951           required: true
31952           type: string
31953           example: __VNF-ID__
31954         - name: interface-name
31955           in: path
31956           description: Name given to the interface
31957           required: true
31958           type: string
31959           example: __INTERFACE-NAME__
31960         - name: body
31961           in: body
31962           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
31963           required: true
31964           schema:
31965             $ref: "#/definitions/l-interface"
31966     patch:
31967       tags:
31968         - Network
31969       summary: update an existing l-interface
31970       description: |
31971         Update an existing l-interface
31972         #
31973         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31974         The PUT operation will entirely replace an existing object.
31975         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31976         #
31977         Other differences between PUT and PATCH are:
31978         #
31979         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31980         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31981         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31982       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
31983       consumes:
31984         - application/json
31985         - application/xml
31986       produces:
31987         - application/json
31988         - application/xml
31989       responses:
31990         "default":
31991           description: Response codes found in [response codes](https://wiki.onap.org/).
31992       parameters:
31993         - name: vnf-id
31994           in: path
31995           description: Unique id of VNF.  This is unique across the graph.
31996           required: true
31997           type: string
31998           example: __VNF-ID__
31999         - name: interface-name
32000           in: path
32001           description: Name given to the interface
32002           required: true
32003           type: string
32004           example: __INTERFACE-NAME__
32005         - name: body
32006           in: body
32007           description: l-interface object that needs to be updated.
32008           required: true
32009           schema:
32010             $ref: "#/patchDefinitions/l-interface"
32011     delete:
32012       tags:
32013         - Network
32014       summary: delete an existing l-interface
32015       description: delete an existing l-interface
32016       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
32017       consumes:
32018         - application/json
32019         - application/xml
32020       produces:
32021         - application/json
32022         - application/xml
32023       responses:
32024         "default":
32025           description: Response codes found in [response codes](https://wiki.onap.org/).
32026       parameters:
32027         - name: vnf-id
32028           in: path
32029           description: Unique id of VNF.  This is unique across the graph.
32030           required: true
32031           type: string
32032           example: __VNF-ID__
32033         - name: interface-name
32034           in: path
32035           description: Name given to the interface
32036           required: true
32037           type: string
32038           example: __INTERFACE-NAME__
32039         - name: resource-version
32040           in: query
32041           description: resource-version for concurrency
32042           required: true
32043           type: string
32044   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
32045     get:
32046       tags:
32047         - Network
32048       summary: returns l-interfaces
32049       description: returns l-interfaces
32050       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
32051       produces:
32052         - application/json
32053         - application/xml
32054       responses:
32055         "200":
32056           description: successful operation
32057           schema:
32058               $ref: "#/getDefinitions/l-interfaces"
32059         "default":
32060           description: Response codes found in [response codes](https://wiki.onap.org/).
32061       parameters:
32062         - name: vnf-id
32063           in: path
32064           description: Unique id of VNF.  This is unique across the graph.
32065           required: true
32066           type: string
32067           example: __VNF-ID__
32068         - name: interface-name
32069           in: query
32070           description:
32071           required: false
32072           type: string
32073         - name: interface-id
32074           in: query
32075           description:
32076           required: false
32077           type: string
32078         - name: macaddr
32079           in: query
32080           description:
32081           required: false
32082           type: string
32083         - name: network-name
32084           in: query
32085           description:
32086           required: false
32087           type: string
32088   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
32089     put:
32090       tags:
32091         - Network
32092       summary: see node definition for valid relationships
32093       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
32094       consumes:
32095         - application/json
32096         - application/xml
32097       produces:
32098         - application/json
32099         - application/xml
32100       responses:
32101         "default":
32102           description: Response codes found in [response codes](https://wiki.onap.org/).
32103       parameters:
32104         - name: vnf-id
32105           in: path
32106           description: Unique id of VNF.  This is unique across the graph.
32107           required: true
32108           type: string
32109           example: __VNF-ID__
32110         - name: interface-name
32111           in: path
32112           description: Name that identifies the link aggregate interface
32113           required: true
32114           type: string
32115           example: __INTERFACE-NAME__
32116         - name: body
32117           in: body
32118           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
32119           required: true
32120           schema:
32121             $ref: "#/definitions/relationship"
32122     delete:
32123       tags:
32124         - Network
32125       summary: delete an existing relationship
32126       description: delete an existing relationship
32127       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
32128       consumes:
32129         - application/json
32130         - application/xml
32131       produces:
32132         - application/json
32133         - application/xml
32134       responses:
32135         "default":
32136           description: Response codes found in [response codes](https://wiki.onap.org/).
32137       parameters:
32138         - name: vnf-id
32139           in: path
32140           description: Unique id of VNF.  This is unique across the graph.
32141           required: true
32142           type: string
32143           example: __VNF-ID__
32144         - name: interface-name
32145           in: path
32146           description: Name that identifies the link aggregate interface
32147           required: true
32148           type: string
32149           example: __INTERFACE-NAME__
32150   /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:
32151     put:
32152       tags:
32153         - Network
32154       summary: see node definition for valid relationships
32155       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32156       consumes:
32157         - application/json
32158         - application/xml
32159       produces:
32160         - application/json
32161         - application/xml
32162       responses:
32163         "default":
32164           description: Response codes found in [response codes](https://wiki.onap.org/).
32165       parameters:
32166         - name: vnf-id
32167           in: path
32168           description: Unique id of VNF.  This is unique across the graph.
32169           required: true
32170           type: string
32171           example: __VNF-ID__
32172         - name: interface-name
32173           in: path
32174           description: Name that identifies the link aggregate interface
32175           required: true
32176           type: string
32177           example: __INTERFACE-NAME__
32178         - name: interface-name
32179           in: path
32180           description: Name given to the interface
32181           required: true
32182           type: string
32183           example: __INTERFACE-NAME__
32184         - name: vlan-interface
32185           in: path
32186           description: String that identifies the interface
32187           required: true
32188           type: string
32189           example: __VLAN-INTERFACE__
32190         - name: body
32191           in: body
32192           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
32193           required: true
32194           schema:
32195             $ref: "#/definitions/relationship"
32196     delete:
32197       tags:
32198         - Network
32199       summary: delete an existing relationship
32200       description: delete an existing relationship
32201       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32202       consumes:
32203         - application/json
32204         - application/xml
32205       produces:
32206         - application/json
32207         - application/xml
32208       responses:
32209         "default":
32210           description: Response codes found in [response codes](https://wiki.onap.org/).
32211       parameters:
32212         - name: vnf-id
32213           in: path
32214           description: Unique id of VNF.  This is unique across the graph.
32215           required: true
32216           type: string
32217           example: __VNF-ID__
32218         - name: interface-name
32219           in: path
32220           description: Name that identifies the link aggregate interface
32221           required: true
32222           type: string
32223           example: __INTERFACE-NAME__
32224         - name: interface-name
32225           in: path
32226           description: Name given to the interface
32227           required: true
32228           type: string
32229           example: __INTERFACE-NAME__
32230         - name: vlan-interface
32231           in: path
32232           description: String that identifies the interface
32233           required: true
32234           type: string
32235           example: __VLAN-INTERFACE__
32236   /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:
32237     put:
32238       tags:
32239         - Network
32240       summary: see node definition for valid relationships
32241       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32242       consumes:
32243         - application/json
32244         - application/xml
32245       produces:
32246         - application/json
32247         - application/xml
32248       responses:
32249         "default":
32250           description: Response codes found in [response codes](https://wiki.onap.org/).
32251       parameters:
32252         - name: vnf-id
32253           in: path
32254           description: Unique id of VNF.  This is unique across the graph.
32255           required: true
32256           type: string
32257           example: __VNF-ID__
32258         - name: interface-name
32259           in: path
32260           description: Name that identifies the link aggregate interface
32261           required: true
32262           type: string
32263           example: __INTERFACE-NAME__
32264         - name: interface-name
32265           in: path
32266           description: Name given to the interface
32267           required: true
32268           type: string
32269           example: __INTERFACE-NAME__
32270         - name: vlan-interface
32271           in: path
32272           description: String that identifies the interface
32273           required: true
32274           type: string
32275           example: __VLAN-INTERFACE__
32276         - name: l3-interface-ipv4-address
32277           in: path
32278           description: IP address
32279           required: true
32280           type: string
32281           example: __L3-INTERFACE-IPV4-ADDRESS__
32282         - name: body
32283           in: body
32284           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32285           required: true
32286           schema:
32287             $ref: "#/definitions/relationship"
32288     delete:
32289       tags:
32290         - Network
32291       summary: delete an existing relationship
32292       description: delete an existing relationship
32293       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32294       consumes:
32295         - application/json
32296         - application/xml
32297       produces:
32298         - application/json
32299         - application/xml
32300       responses:
32301         "default":
32302           description: Response codes found in [response codes](https://wiki.onap.org/).
32303       parameters:
32304         - name: vnf-id
32305           in: path
32306           description: Unique id of VNF.  This is unique across the graph.
32307           required: true
32308           type: string
32309           example: __VNF-ID__
32310         - name: interface-name
32311           in: path
32312           description: Name that identifies the link aggregate interface
32313           required: true
32314           type: string
32315           example: __INTERFACE-NAME__
32316         - name: interface-name
32317           in: path
32318           description: Name given to the interface
32319           required: true
32320           type: string
32321           example: __INTERFACE-NAME__
32322         - name: vlan-interface
32323           in: path
32324           description: String that identifies the interface
32325           required: true
32326           type: string
32327           example: __VLAN-INTERFACE__
32328         - name: l3-interface-ipv4-address
32329           in: path
32330           description: IP address
32331           required: true
32332           type: string
32333           example: __L3-INTERFACE-IPV4-ADDRESS__
32334   /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}:
32335     get:
32336       tags:
32337         - Network
32338       summary: returns l3-interface-ipv4-address-list
32339       description: returns l3-interface-ipv4-address-list
32340       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32341       produces:
32342         - application/json
32343         - application/xml
32344       responses:
32345         "200":
32346           description: successful operation
32347           schema:
32348               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32349         "default":
32350           description: Response codes found in [response codes](https://wiki.onap.org/).
32351       parameters:
32352         - name: vnf-id
32353           in: path
32354           description: Unique id of VNF.  This is unique across the graph.
32355           required: true
32356           type: string
32357           example: __VNF-ID__
32358         - name: interface-name
32359           in: path
32360           description: Name that identifies the link aggregate interface
32361           required: true
32362           type: string
32363           example: __INTERFACE-NAME__
32364         - name: interface-name
32365           in: path
32366           description: Name given to the interface
32367           required: true
32368           type: string
32369           example: __INTERFACE-NAME__
32370         - name: vlan-interface
32371           in: path
32372           description: String that identifies the interface
32373           required: true
32374           type: string
32375           example: __VLAN-INTERFACE__
32376         - name: l3-interface-ipv4-address
32377           in: path
32378           description: IP address
32379           required: true
32380           type: string
32381           example: __L3-INTERFACE-IPV4-ADDRESS__
32382     put:
32383       tags:
32384         - Network
32385       summary: create or update an existing l3-interface-ipv4-address-list
32386       description: |
32387         Create or update an existing l3-interface-ipv4-address-list.
32388         #
32389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32390       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32391       consumes:
32392         - application/json
32393         - application/xml
32394       produces:
32395         - application/json
32396         - application/xml
32397       responses:
32398         "default":
32399           description: Response codes found in [response codes](https://wiki.onap.org/).
32400       parameters:
32401         - name: vnf-id
32402           in: path
32403           description: Unique id of VNF.  This is unique across the graph.
32404           required: true
32405           type: string
32406           example: __VNF-ID__
32407         - name: interface-name
32408           in: path
32409           description: Name that identifies the link aggregate interface
32410           required: true
32411           type: string
32412           example: __INTERFACE-NAME__
32413         - name: interface-name
32414           in: path
32415           description: Name given to the interface
32416           required: true
32417           type: string
32418           example: __INTERFACE-NAME__
32419         - name: vlan-interface
32420           in: path
32421           description: String that identifies the interface
32422           required: true
32423           type: string
32424           example: __VLAN-INTERFACE__
32425         - name: l3-interface-ipv4-address
32426           in: path
32427           description: IP address
32428           required: true
32429           type: string
32430           example: __L3-INTERFACE-IPV4-ADDRESS__
32431         - name: body
32432           in: body
32433           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32434           required: true
32435           schema:
32436             $ref: "#/definitions/l3-interface-ipv4-address-list"
32437     patch:
32438       tags:
32439         - Network
32440       summary: update an existing l3-interface-ipv4-address-list
32441       description: |
32442         Update an existing l3-interface-ipv4-address-list
32443         #
32444         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32445         The PUT operation will entirely replace an existing object.
32446         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32447         #
32448         Other differences between PUT and PATCH are:
32449         #
32450         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32451         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32452         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32453       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32454       consumes:
32455         - application/json
32456         - application/xml
32457       produces:
32458         - application/json
32459         - application/xml
32460       responses:
32461         "default":
32462           description: Response codes found in [response codes](https://wiki.onap.org/).
32463       parameters:
32464         - name: vnf-id
32465           in: path
32466           description: Unique id of VNF.  This is unique across the graph.
32467           required: true
32468           type: string
32469           example: __VNF-ID__
32470         - name: interface-name
32471           in: path
32472           description: Name that identifies the link aggregate interface
32473           required: true
32474           type: string
32475           example: __INTERFACE-NAME__
32476         - name: interface-name
32477           in: path
32478           description: Name given to the interface
32479           required: true
32480           type: string
32481           example: __INTERFACE-NAME__
32482         - name: vlan-interface
32483           in: path
32484           description: String that identifies the interface
32485           required: true
32486           type: string
32487           example: __VLAN-INTERFACE__
32488         - name: l3-interface-ipv4-address
32489           in: path
32490           description: IP address
32491           required: true
32492           type: string
32493           example: __L3-INTERFACE-IPV4-ADDRESS__
32494         - name: body
32495           in: body
32496           description: l3-interface-ipv4-address-list object that needs to be updated.
32497           required: true
32498           schema:
32499             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32500     delete:
32501       tags:
32502         - Network
32503       summary: delete an existing l3-interface-ipv4-address-list
32504       description: delete an existing l3-interface-ipv4-address-list
32505       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32506       consumes:
32507         - application/json
32508         - application/xml
32509       produces:
32510         - application/json
32511         - application/xml
32512       responses:
32513         "default":
32514           description: Response codes found in [response codes](https://wiki.onap.org/).
32515       parameters:
32516         - name: vnf-id
32517           in: path
32518           description: Unique id of VNF.  This is unique across the graph.
32519           required: true
32520           type: string
32521           example: __VNF-ID__
32522         - name: interface-name
32523           in: path
32524           description: Name that identifies the link aggregate interface
32525           required: true
32526           type: string
32527           example: __INTERFACE-NAME__
32528         - name: interface-name
32529           in: path
32530           description: Name given to the interface
32531           required: true
32532           type: string
32533           example: __INTERFACE-NAME__
32534         - name: vlan-interface
32535           in: path
32536           description: String that identifies the interface
32537           required: true
32538           type: string
32539           example: __VLAN-INTERFACE__
32540         - name: l3-interface-ipv4-address
32541           in: path
32542           description: IP address
32543           required: true
32544           type: string
32545           example: __L3-INTERFACE-IPV4-ADDRESS__
32546         - name: resource-version
32547           in: query
32548           description: resource-version for concurrency
32549           required: true
32550           type: string
32551   /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:
32552     put:
32553       tags:
32554         - Network
32555       summary: see node definition for valid relationships
32556       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32557       consumes:
32558         - application/json
32559         - application/xml
32560       produces:
32561         - application/json
32562         - application/xml
32563       responses:
32564         "default":
32565           description: Response codes found in [response codes](https://wiki.onap.org/).
32566       parameters:
32567         - name: vnf-id
32568           in: path
32569           description: Unique id of VNF.  This is unique across the graph.
32570           required: true
32571           type: string
32572           example: __VNF-ID__
32573         - name: interface-name
32574           in: path
32575           description: Name that identifies the link aggregate interface
32576           required: true
32577           type: string
32578           example: __INTERFACE-NAME__
32579         - name: interface-name
32580           in: path
32581           description: Name given to the interface
32582           required: true
32583           type: string
32584           example: __INTERFACE-NAME__
32585         - name: vlan-interface
32586           in: path
32587           description: String that identifies the interface
32588           required: true
32589           type: string
32590           example: __VLAN-INTERFACE__
32591         - name: l3-interface-ipv6-address
32592           in: path
32593           description: IP address
32594           required: true
32595           type: string
32596           example: __L3-INTERFACE-IPV6-ADDRESS__
32597         - name: body
32598           in: body
32599           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32600           required: true
32601           schema:
32602             $ref: "#/definitions/relationship"
32603     delete:
32604       tags:
32605         - Network
32606       summary: delete an existing relationship
32607       description: delete an existing relationship
32608       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32609       consumes:
32610         - application/json
32611         - application/xml
32612       produces:
32613         - application/json
32614         - application/xml
32615       responses:
32616         "default":
32617           description: Response codes found in [response codes](https://wiki.onap.org/).
32618       parameters:
32619         - name: vnf-id
32620           in: path
32621           description: Unique id of VNF.  This is unique across the graph.
32622           required: true
32623           type: string
32624           example: __VNF-ID__
32625         - name: interface-name
32626           in: path
32627           description: Name that identifies the link aggregate interface
32628           required: true
32629           type: string
32630           example: __INTERFACE-NAME__
32631         - name: interface-name
32632           in: path
32633           description: Name given to the interface
32634           required: true
32635           type: string
32636           example: __INTERFACE-NAME__
32637         - name: vlan-interface
32638           in: path
32639           description: String that identifies the interface
32640           required: true
32641           type: string
32642           example: __VLAN-INTERFACE__
32643         - name: l3-interface-ipv6-address
32644           in: path
32645           description: IP address
32646           required: true
32647           type: string
32648           example: __L3-INTERFACE-IPV6-ADDRESS__
32649   /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}:
32650     get:
32651       tags:
32652         - Network
32653       summary: returns l3-interface-ipv6-address-list
32654       description: returns l3-interface-ipv6-address-list
32655       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32656       produces:
32657         - application/json
32658         - application/xml
32659       responses:
32660         "200":
32661           description: successful operation
32662           schema:
32663               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32664         "default":
32665           description: Response codes found in [response codes](https://wiki.onap.org/).
32666       parameters:
32667         - name: vnf-id
32668           in: path
32669           description: Unique id of VNF.  This is unique across the graph.
32670           required: true
32671           type: string
32672           example: __VNF-ID__
32673         - name: interface-name
32674           in: path
32675           description: Name that identifies the link aggregate interface
32676           required: true
32677           type: string
32678           example: __INTERFACE-NAME__
32679         - name: interface-name
32680           in: path
32681           description: Name given to the interface
32682           required: true
32683           type: string
32684           example: __INTERFACE-NAME__
32685         - name: vlan-interface
32686           in: path
32687           description: String that identifies the interface
32688           required: true
32689           type: string
32690           example: __VLAN-INTERFACE__
32691         - name: l3-interface-ipv6-address
32692           in: path
32693           description: IP address
32694           required: true
32695           type: string
32696           example: __L3-INTERFACE-IPV6-ADDRESS__
32697     put:
32698       tags:
32699         - Network
32700       summary: create or update an existing l3-interface-ipv6-address-list
32701       description: |
32702         Create or update an existing l3-interface-ipv6-address-list.
32703         #
32704         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32705       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32706       consumes:
32707         - application/json
32708         - application/xml
32709       produces:
32710         - application/json
32711         - application/xml
32712       responses:
32713         "default":
32714           description: Response codes found in [response codes](https://wiki.onap.org/).
32715       parameters:
32716         - name: vnf-id
32717           in: path
32718           description: Unique id of VNF.  This is unique across the graph.
32719           required: true
32720           type: string
32721           example: __VNF-ID__
32722         - name: interface-name
32723           in: path
32724           description: Name that identifies the link aggregate interface
32725           required: true
32726           type: string
32727           example: __INTERFACE-NAME__
32728         - name: interface-name
32729           in: path
32730           description: Name given to the interface
32731           required: true
32732           type: string
32733           example: __INTERFACE-NAME__
32734         - name: vlan-interface
32735           in: path
32736           description: String that identifies the interface
32737           required: true
32738           type: string
32739           example: __VLAN-INTERFACE__
32740         - name: l3-interface-ipv6-address
32741           in: path
32742           description: IP address
32743           required: true
32744           type: string
32745           example: __L3-INTERFACE-IPV6-ADDRESS__
32746         - name: body
32747           in: body
32748           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32749           required: true
32750           schema:
32751             $ref: "#/definitions/l3-interface-ipv6-address-list"
32752     patch:
32753       tags:
32754         - Network
32755       summary: update an existing l3-interface-ipv6-address-list
32756       description: |
32757         Update an existing l3-interface-ipv6-address-list
32758         #
32759         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32760         The PUT operation will entirely replace an existing object.
32761         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32762         #
32763         Other differences between PUT and PATCH are:
32764         #
32765         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32766         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32767         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32768       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32769       consumes:
32770         - application/json
32771         - application/xml
32772       produces:
32773         - application/json
32774         - application/xml
32775       responses:
32776         "default":
32777           description: Response codes found in [response codes](https://wiki.onap.org/).
32778       parameters:
32779         - name: vnf-id
32780           in: path
32781           description: Unique id of VNF.  This is unique across the graph.
32782           required: true
32783           type: string
32784           example: __VNF-ID__
32785         - name: interface-name
32786           in: path
32787           description: Name that identifies the link aggregate interface
32788           required: true
32789           type: string
32790           example: __INTERFACE-NAME__
32791         - name: interface-name
32792           in: path
32793           description: Name given to the interface
32794           required: true
32795           type: string
32796           example: __INTERFACE-NAME__
32797         - name: vlan-interface
32798           in: path
32799           description: String that identifies the interface
32800           required: true
32801           type: string
32802           example: __VLAN-INTERFACE__
32803         - name: l3-interface-ipv6-address
32804           in: path
32805           description: IP address
32806           required: true
32807           type: string
32808           example: __L3-INTERFACE-IPV6-ADDRESS__
32809         - name: body
32810           in: body
32811           description: l3-interface-ipv6-address-list object that needs to be updated.
32812           required: true
32813           schema:
32814             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32815     delete:
32816       tags:
32817         - Network
32818       summary: delete an existing l3-interface-ipv6-address-list
32819       description: delete an existing l3-interface-ipv6-address-list
32820       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32821       consumes:
32822         - application/json
32823         - application/xml
32824       produces:
32825         - application/json
32826         - application/xml
32827       responses:
32828         "default":
32829           description: Response codes found in [response codes](https://wiki.onap.org/).
32830       parameters:
32831         - name: vnf-id
32832           in: path
32833           description: Unique id of VNF.  This is unique across the graph.
32834           required: true
32835           type: string
32836           example: __VNF-ID__
32837         - name: interface-name
32838           in: path
32839           description: Name that identifies the link aggregate interface
32840           required: true
32841           type: string
32842           example: __INTERFACE-NAME__
32843         - name: interface-name
32844           in: path
32845           description: Name given to the interface
32846           required: true
32847           type: string
32848           example: __INTERFACE-NAME__
32849         - name: vlan-interface
32850           in: path
32851           description: String that identifies the interface
32852           required: true
32853           type: string
32854           example: __VLAN-INTERFACE__
32855         - name: l3-interface-ipv6-address
32856           in: path
32857           description: IP address
32858           required: true
32859           type: string
32860           example: __L3-INTERFACE-IPV6-ADDRESS__
32861         - name: resource-version
32862           in: query
32863           description: resource-version for concurrency
32864           required: true
32865           type: string
32866   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
32867     get:
32868       tags:
32869         - Network
32870       summary: returns vlan
32871       description: returns vlan
32872       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
32873       produces:
32874         - application/json
32875         - application/xml
32876       responses:
32877         "200":
32878           description: successful operation
32879           schema:
32880               $ref: "#/getDefinitions/vlan"
32881         "default":
32882           description: Response codes found in [response codes](https://wiki.onap.org/).
32883       parameters:
32884         - name: vnf-id
32885           in: path
32886           description: Unique id of VNF.  This is unique across the graph.
32887           required: true
32888           type: string
32889           example: __VNF-ID__
32890         - name: interface-name
32891           in: path
32892           description: Name that identifies the link aggregate interface
32893           required: true
32894           type: string
32895           example: __INTERFACE-NAME__
32896         - name: interface-name
32897           in: path
32898           description: Name given to the interface
32899           required: true
32900           type: string
32901           example: __INTERFACE-NAME__
32902         - name: vlan-interface
32903           in: path
32904           description: String that identifies the interface
32905           required: true
32906           type: string
32907           example: __VLAN-INTERFACE__
32908     put:
32909       tags:
32910         - Network
32911       summary: create or update an existing vlan
32912       description: |
32913         Create or update an existing vlan.
32914         #
32915         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32916       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
32917       consumes:
32918         - application/json
32919         - application/xml
32920       produces:
32921         - application/json
32922         - application/xml
32923       responses:
32924         "default":
32925           description: Response codes found in [response codes](https://wiki.onap.org/).
32926       parameters:
32927         - name: vnf-id
32928           in: path
32929           description: Unique id of VNF.  This is unique across the graph.
32930           required: true
32931           type: string
32932           example: __VNF-ID__
32933         - name: interface-name
32934           in: path
32935           description: Name that identifies the link aggregate interface
32936           required: true
32937           type: string
32938           example: __INTERFACE-NAME__
32939         - name: interface-name
32940           in: path
32941           description: Name given to the interface
32942           required: true
32943           type: string
32944           example: __INTERFACE-NAME__
32945         - name: vlan-interface
32946           in: path
32947           description: String that identifies the interface
32948           required: true
32949           type: string
32950           example: __VLAN-INTERFACE__
32951         - name: body
32952           in: body
32953           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
32954           required: true
32955           schema:
32956             $ref: "#/definitions/vlan"
32957     patch:
32958       tags:
32959         - Network
32960       summary: update an existing vlan
32961       description: |
32962         Update an existing vlan
32963         #
32964         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32965         The PUT operation will entirely replace an existing object.
32966         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32967         #
32968         Other differences between PUT and PATCH are:
32969         #
32970         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32971         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32972         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32973       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
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-id
32985           in: path
32986           description: Unique id of VNF.  This is unique across the graph.
32987           required: true
32988           type: string
32989           example: __VNF-ID__
32990         - name: interface-name
32991           in: path
32992           description: Name that identifies the link aggregate interface
32993           required: true
32994           type: string
32995           example: __INTERFACE-NAME__
32996         - name: interface-name
32997           in: path
32998           description: Name given to the interface
32999           required: true
33000           type: string
33001           example: __INTERFACE-NAME__
33002         - name: vlan-interface
33003           in: path
33004           description: String that identifies the interface
33005           required: true
33006           type: string
33007           example: __VLAN-INTERFACE__
33008         - name: body
33009           in: body
33010           description: vlan object that needs to be updated.
33011           required: true
33012           schema:
33013             $ref: "#/patchDefinitions/vlan"
33014     delete:
33015       tags:
33016         - Network
33017       summary: delete an existing vlan
33018       description: delete an existing vlan
33019       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
33020       consumes:
33021         - application/json
33022         - application/xml
33023       produces:
33024         - application/json
33025         - application/xml
33026       responses:
33027         "default":
33028           description: Response codes found in [response codes](https://wiki.onap.org/).
33029       parameters:
33030         - name: vnf-id
33031           in: path
33032           description: Unique id of VNF.  This is unique across the graph.
33033           required: true
33034           type: string
33035           example: __VNF-ID__
33036         - name: interface-name
33037           in: path
33038           description: Name that identifies the link aggregate interface
33039           required: true
33040           type: string
33041           example: __INTERFACE-NAME__
33042         - name: interface-name
33043           in: path
33044           description: Name given to the interface
33045           required: true
33046           type: string
33047           example: __INTERFACE-NAME__
33048         - name: vlan-interface
33049           in: path
33050           description: String that identifies the interface
33051           required: true
33052           type: string
33053           example: __VLAN-INTERFACE__
33054         - name: resource-version
33055           in: query
33056           description: resource-version for concurrency
33057           required: true
33058           type: string
33059   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
33060     get:
33061       tags:
33062         - Network
33063       summary: returns vlans
33064       description: returns vlans
33065       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
33066       produces:
33067         - application/json
33068         - application/xml
33069       responses:
33070         "200":
33071           description: successful operation
33072           schema:
33073               $ref: "#/getDefinitions/vlans"
33074         "default":
33075           description: Response codes found in [response codes](https://wiki.onap.org/).
33076       parameters:
33077         - name: vnf-id
33078           in: path
33079           description: Unique id of VNF.  This is unique across the graph.
33080           required: true
33081           type: string
33082           example: __VNF-ID__
33083         - name: interface-name
33084           in: path
33085           description: Name that identifies the link aggregate interface
33086           required: true
33087           type: string
33088           example: __INTERFACE-NAME__
33089         - name: interface-name
33090           in: path
33091           description: Name given to the interface
33092           required: true
33093           type: string
33094           example: __INTERFACE-NAME__
33095         - name: vlan-interface
33096           in: query
33097           description:
33098           required: false
33099           type: string
33100         - name: vlan-id-inner
33101           in: query
33102           description:
33103           required: false
33104           type: integer
33105           format: int64
33106         - name: vpn-key
33107           in: query
33108           description:
33109           required: false
33110           type: string
33111   /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:
33112     put:
33113       tags:
33114         - Network
33115       summary: see node definition for valid relationships
33116       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33117       consumes:
33118         - application/json
33119         - application/xml
33120       produces:
33121         - application/json
33122         - application/xml
33123       responses:
33124         "default":
33125           description: Response codes found in [response codes](https://wiki.onap.org/).
33126       parameters:
33127         - name: vnf-id
33128           in: path
33129           description: Unique id of VNF.  This is unique across the graph.
33130           required: true
33131           type: string
33132           example: __VNF-ID__
33133         - name: interface-name
33134           in: path
33135           description: Name that identifies the link aggregate interface
33136           required: true
33137           type: string
33138           example: __INTERFACE-NAME__
33139         - name: interface-name
33140           in: path
33141           description: Name given to the interface
33142           required: true
33143           type: string
33144           example: __INTERFACE-NAME__
33145         - name: pci-id
33146           in: path
33147           description: PCI ID used to identify the sriov-vf
33148           required: true
33149           type: string
33150           example: __PCI-ID__
33151         - name: body
33152           in: body
33153           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33154           required: true
33155           schema:
33156             $ref: "#/definitions/relationship"
33157     delete:
33158       tags:
33159         - Network
33160       summary: delete an existing relationship
33161       description: delete an existing relationship
33162       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33163       consumes:
33164         - application/json
33165         - application/xml
33166       produces:
33167         - application/json
33168         - application/xml
33169       responses:
33170         "default":
33171           description: Response codes found in [response codes](https://wiki.onap.org/).
33172       parameters:
33173         - name: vnf-id
33174           in: path
33175           description: Unique id of VNF.  This is unique across the graph.
33176           required: true
33177           type: string
33178           example: __VNF-ID__
33179         - name: interface-name
33180           in: path
33181           description: Name that identifies the link aggregate interface
33182           required: true
33183           type: string
33184           example: __INTERFACE-NAME__
33185         - name: interface-name
33186           in: path
33187           description: Name given to the interface
33188           required: true
33189           type: string
33190           example: __INTERFACE-NAME__
33191         - name: pci-id
33192           in: path
33193           description: PCI ID used to identify the sriov-vf
33194           required: true
33195           type: string
33196           example: __PCI-ID__
33197   /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}:
33198     get:
33199       tags:
33200         - Network
33201       summary: returns sriov-vf
33202       description: returns sriov-vf
33203       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33204       produces:
33205         - application/json
33206         - application/xml
33207       responses:
33208         "200":
33209           description: successful operation
33210           schema:
33211               $ref: "#/getDefinitions/sriov-vf"
33212         "default":
33213           description: Response codes found in [response codes](https://wiki.onap.org/).
33214       parameters:
33215         - name: vnf-id
33216           in: path
33217           description: Unique id of VNF.  This is unique across the graph.
33218           required: true
33219           type: string
33220           example: __VNF-ID__
33221         - name: interface-name
33222           in: path
33223           description: Name that identifies the link aggregate interface
33224           required: true
33225           type: string
33226           example: __INTERFACE-NAME__
33227         - name: interface-name
33228           in: path
33229           description: Name given to the interface
33230           required: true
33231           type: string
33232           example: __INTERFACE-NAME__
33233         - name: pci-id
33234           in: path
33235           description: PCI ID used to identify the sriov-vf
33236           required: true
33237           type: string
33238           example: __PCI-ID__
33239     put:
33240       tags:
33241         - Network
33242       summary: create or update an existing sriov-vf
33243       description: |
33244         Create or update an existing sriov-vf.
33245         #
33246         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33247       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33248       consumes:
33249         - application/json
33250         - application/xml
33251       produces:
33252         - application/json
33253         - application/xml
33254       responses:
33255         "default":
33256           description: Response codes found in [response codes](https://wiki.onap.org/).
33257       parameters:
33258         - name: vnf-id
33259           in: path
33260           description: Unique id of VNF.  This is unique across the graph.
33261           required: true
33262           type: string
33263           example: __VNF-ID__
33264         - name: interface-name
33265           in: path
33266           description: Name that identifies the link aggregate interface
33267           required: true
33268           type: string
33269           example: __INTERFACE-NAME__
33270         - name: interface-name
33271           in: path
33272           description: Name given to the interface
33273           required: true
33274           type: string
33275           example: __INTERFACE-NAME__
33276         - name: pci-id
33277           in: path
33278           description: PCI ID used to identify the sriov-vf
33279           required: true
33280           type: string
33281           example: __PCI-ID__
33282         - name: body
33283           in: body
33284           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33285           required: true
33286           schema:
33287             $ref: "#/definitions/sriov-vf"
33288     patch:
33289       tags:
33290         - Network
33291       summary: update an existing sriov-vf
33292       description: |
33293         Update an existing sriov-vf
33294         #
33295         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33296         The PUT operation will entirely replace an existing object.
33297         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33298         #
33299         Other differences between PUT and PATCH are:
33300         #
33301         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33302         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33303         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33304       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33305       consumes:
33306         - application/json
33307         - application/xml
33308       produces:
33309         - application/json
33310         - application/xml
33311       responses:
33312         "default":
33313           description: Response codes found in [response codes](https://wiki.onap.org/).
33314       parameters:
33315         - name: vnf-id
33316           in: path
33317           description: Unique id of VNF.  This is unique across the graph.
33318           required: true
33319           type: string
33320           example: __VNF-ID__
33321         - name: interface-name
33322           in: path
33323           description: Name that identifies the link aggregate interface
33324           required: true
33325           type: string
33326           example: __INTERFACE-NAME__
33327         - name: interface-name
33328           in: path
33329           description: Name given to the interface
33330           required: true
33331           type: string
33332           example: __INTERFACE-NAME__
33333         - name: pci-id
33334           in: path
33335           description: PCI ID used to identify the sriov-vf
33336           required: true
33337           type: string
33338           example: __PCI-ID__
33339         - name: body
33340           in: body
33341           description: sriov-vf object that needs to be updated.
33342           required: true
33343           schema:
33344             $ref: "#/patchDefinitions/sriov-vf"
33345     delete:
33346       tags:
33347         - Network
33348       summary: delete an existing sriov-vf
33349       description: delete an existing sriov-vf
33350       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33351       consumes:
33352         - application/json
33353         - application/xml
33354       produces:
33355         - application/json
33356         - application/xml
33357       responses:
33358         "default":
33359           description: Response codes found in [response codes](https://wiki.onap.org/).
33360       parameters:
33361         - name: vnf-id
33362           in: path
33363           description: Unique id of VNF.  This is unique across the graph.
33364           required: true
33365           type: string
33366           example: __VNF-ID__
33367         - name: interface-name
33368           in: path
33369           description: Name that identifies the link aggregate interface
33370           required: true
33371           type: string
33372           example: __INTERFACE-NAME__
33373         - name: interface-name
33374           in: path
33375           description: Name given to the interface
33376           required: true
33377           type: string
33378           example: __INTERFACE-NAME__
33379         - name: pci-id
33380           in: path
33381           description: PCI ID used to identify the sriov-vf
33382           required: true
33383           type: string
33384           example: __PCI-ID__
33385         - name: resource-version
33386           in: query
33387           description: resource-version for concurrency
33388           required: true
33389           type: string
33390   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33391     get:
33392       tags:
33393         - Network
33394       summary: returns sriov-vfs
33395       description: returns sriov-vfs
33396       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
33397       produces:
33398         - application/json
33399         - application/xml
33400       responses:
33401         "200":
33402           description: successful operation
33403           schema:
33404               $ref: "#/getDefinitions/sriov-vfs"
33405         "default":
33406           description: Response codes found in [response codes](https://wiki.onap.org/).
33407       parameters:
33408         - name: vnf-id
33409           in: path
33410           description: Unique id of VNF.  This is unique across the graph.
33411           required: true
33412           type: string
33413           example: __VNF-ID__
33414         - name: interface-name
33415           in: path
33416           description: Name that identifies the link aggregate interface
33417           required: true
33418           type: string
33419           example: __INTERFACE-NAME__
33420         - name: interface-name
33421           in: path
33422           description: Name given to the interface
33423           required: true
33424           type: string
33425           example: __INTERFACE-NAME__
33426         - name: pci-id
33427           in: query
33428           description:
33429           required: false
33430           type: string
33431         - name: vf-vlan-filter
33432           in: query
33433           description:
33434           required: false
33435           type: string
33436         - name: vf-mac-filter
33437           in: query
33438           description:
33439           required: false
33440           type: string
33441         - name: vf-vlan-strip
33442           in: query
33443           description:
33444           required: false
33445           type: boolean
33446         - name: neutron-network-id
33447           in: query
33448           description:
33449           required: false
33450           type: string
33451   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33452     put:
33453       tags:
33454         - Network
33455       summary: see node definition for valid relationships
33456       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
33457       consumes:
33458         - application/json
33459         - application/xml
33460       produces:
33461         - application/json
33462         - application/xml
33463       responses:
33464         "default":
33465           description: Response codes found in [response codes](https://wiki.onap.org/).
33466       parameters:
33467         - name: vnf-id
33468           in: path
33469           description: Unique id of VNF.  This is unique across the graph.
33470           required: true
33471           type: string
33472           example: __VNF-ID__
33473         - name: interface-name
33474           in: path
33475           description: Name that identifies the link aggregate interface
33476           required: true
33477           type: string
33478           example: __INTERFACE-NAME__
33479         - name: interface-name
33480           in: path
33481           description: Name given to the interface
33482           required: true
33483           type: string
33484           example: __INTERFACE-NAME__
33485         - name: body
33486           in: body
33487           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
33488           required: true
33489           schema:
33490             $ref: "#/definitions/relationship"
33491     delete:
33492       tags:
33493         - Network
33494       summary: delete an existing relationship
33495       description: delete an existing relationship
33496       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
33497       consumes:
33498         - application/json
33499         - application/xml
33500       produces:
33501         - application/json
33502         - application/xml
33503       responses:
33504         "default":
33505           description: Response codes found in [response codes](https://wiki.onap.org/).
33506       parameters:
33507         - name: vnf-id
33508           in: path
33509           description: Unique id of VNF.  This is unique across the graph.
33510           required: true
33511           type: string
33512           example: __VNF-ID__
33513         - name: interface-name
33514           in: path
33515           description: Name that identifies the link aggregate interface
33516           required: true
33517           type: string
33518           example: __INTERFACE-NAME__
33519         - name: interface-name
33520           in: path
33521           description: Name given to the interface
33522           required: true
33523           type: string
33524           example: __INTERFACE-NAME__
33525   /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:
33526     put:
33527       tags:
33528         - Network
33529       summary: see node definition for valid relationships
33530       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33531       consumes:
33532         - application/json
33533         - application/xml
33534       produces:
33535         - application/json
33536         - application/xml
33537       responses:
33538         "default":
33539           description: Response codes found in [response codes](https://wiki.onap.org/).
33540       parameters:
33541         - name: vnf-id
33542           in: path
33543           description: Unique id of VNF.  This is unique across the graph.
33544           required: true
33545           type: string
33546           example: __VNF-ID__
33547         - name: interface-name
33548           in: path
33549           description: Name that identifies the link aggregate interface
33550           required: true
33551           type: string
33552           example: __INTERFACE-NAME__
33553         - name: interface-name
33554           in: path
33555           description: Name given to the interface
33556           required: true
33557           type: string
33558           example: __INTERFACE-NAME__
33559         - name: l3-interface-ipv4-address
33560           in: path
33561           description: IP address
33562           required: true
33563           type: string
33564           example: __L3-INTERFACE-IPV4-ADDRESS__
33565         - name: body
33566           in: body
33567           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33568           required: true
33569           schema:
33570             $ref: "#/definitions/relationship"
33571     delete:
33572       tags:
33573         - Network
33574       summary: delete an existing relationship
33575       description: delete an existing relationship
33576       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33577       consumes:
33578         - application/json
33579         - application/xml
33580       produces:
33581         - application/json
33582         - application/xml
33583       responses:
33584         "default":
33585           description: Response codes found in [response codes](https://wiki.onap.org/).
33586       parameters:
33587         - name: vnf-id
33588           in: path
33589           description: Unique id of VNF.  This is unique across the graph.
33590           required: true
33591           type: string
33592           example: __VNF-ID__
33593         - name: interface-name
33594           in: path
33595           description: Name that identifies the link aggregate interface
33596           required: true
33597           type: string
33598           example: __INTERFACE-NAME__
33599         - name: interface-name
33600           in: path
33601           description: Name given to the interface
33602           required: true
33603           type: string
33604           example: __INTERFACE-NAME__
33605         - name: l3-interface-ipv4-address
33606           in: path
33607           description: IP address
33608           required: true
33609           type: string
33610           example: __L3-INTERFACE-IPV4-ADDRESS__
33611   /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}:
33612     get:
33613       tags:
33614         - Network
33615       summary: returns l3-interface-ipv4-address-list
33616       description: returns l3-interface-ipv4-address-list
33617       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33618       produces:
33619         - application/json
33620         - application/xml
33621       responses:
33622         "200":
33623           description: successful operation
33624           schema:
33625               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33626         "default":
33627           description: Response codes found in [response codes](https://wiki.onap.org/).
33628       parameters:
33629         - name: vnf-id
33630           in: path
33631           description: Unique id of VNF.  This is unique across the graph.
33632           required: true
33633           type: string
33634           example: __VNF-ID__
33635         - name: interface-name
33636           in: path
33637           description: Name that identifies the link aggregate interface
33638           required: true
33639           type: string
33640           example: __INTERFACE-NAME__
33641         - name: interface-name
33642           in: path
33643           description: Name given to the interface
33644           required: true
33645           type: string
33646           example: __INTERFACE-NAME__
33647         - name: l3-interface-ipv4-address
33648           in: path
33649           description: IP address
33650           required: true
33651           type: string
33652           example: __L3-INTERFACE-IPV4-ADDRESS__
33653     put:
33654       tags:
33655         - Network
33656       summary: create or update an existing l3-interface-ipv4-address-list
33657       description: |
33658         Create or update an existing l3-interface-ipv4-address-list.
33659         #
33660         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33661       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33662       consumes:
33663         - application/json
33664         - application/xml
33665       produces:
33666         - application/json
33667         - application/xml
33668       responses:
33669         "default":
33670           description: Response codes found in [response codes](https://wiki.onap.org/).
33671       parameters:
33672         - name: vnf-id
33673           in: path
33674           description: Unique id of VNF.  This is unique across the graph.
33675           required: true
33676           type: string
33677           example: __VNF-ID__
33678         - name: interface-name
33679           in: path
33680           description: Name that identifies the link aggregate interface
33681           required: true
33682           type: string
33683           example: __INTERFACE-NAME__
33684         - name: interface-name
33685           in: path
33686           description: Name given to the interface
33687           required: true
33688           type: string
33689           example: __INTERFACE-NAME__
33690         - name: l3-interface-ipv4-address
33691           in: path
33692           description: IP address
33693           required: true
33694           type: string
33695           example: __L3-INTERFACE-IPV4-ADDRESS__
33696         - name: body
33697           in: body
33698           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33699           required: true
33700           schema:
33701             $ref: "#/definitions/l3-interface-ipv4-address-list"
33702     patch:
33703       tags:
33704         - Network
33705       summary: update an existing l3-interface-ipv4-address-list
33706       description: |
33707         Update an existing l3-interface-ipv4-address-list
33708         #
33709         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33710         The PUT operation will entirely replace an existing object.
33711         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33712         #
33713         Other differences between PUT and PATCH are:
33714         #
33715         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33716         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33717         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33718       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33719       consumes:
33720         - application/json
33721         - application/xml
33722       produces:
33723         - application/json
33724         - application/xml
33725       responses:
33726         "default":
33727           description: Response codes found in [response codes](https://wiki.onap.org/).
33728       parameters:
33729         - name: vnf-id
33730           in: path
33731           description: Unique id of VNF.  This is unique across the graph.
33732           required: true
33733           type: string
33734           example: __VNF-ID__
33735         - name: interface-name
33736           in: path
33737           description: Name that identifies the link aggregate interface
33738           required: true
33739           type: string
33740           example: __INTERFACE-NAME__
33741         - name: interface-name
33742           in: path
33743           description: Name given to the interface
33744           required: true
33745           type: string
33746           example: __INTERFACE-NAME__
33747         - name: l3-interface-ipv4-address
33748           in: path
33749           description: IP address
33750           required: true
33751           type: string
33752           example: __L3-INTERFACE-IPV4-ADDRESS__
33753         - name: body
33754           in: body
33755           description: l3-interface-ipv4-address-list object that needs to be updated.
33756           required: true
33757           schema:
33758             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33759     delete:
33760       tags:
33761         - Network
33762       summary: delete an existing l3-interface-ipv4-address-list
33763       description: delete an existing l3-interface-ipv4-address-list
33764       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33765       consumes:
33766         - application/json
33767         - application/xml
33768       produces:
33769         - application/json
33770         - application/xml
33771       responses:
33772         "default":
33773           description: Response codes found in [response codes](https://wiki.onap.org/).
33774       parameters:
33775         - name: vnf-id
33776           in: path
33777           description: Unique id of VNF.  This is unique across the graph.
33778           required: true
33779           type: string
33780           example: __VNF-ID__
33781         - name: interface-name
33782           in: path
33783           description: Name that identifies the link aggregate interface
33784           required: true
33785           type: string
33786           example: __INTERFACE-NAME__
33787         - name: interface-name
33788           in: path
33789           description: Name given to the interface
33790           required: true
33791           type: string
33792           example: __INTERFACE-NAME__
33793         - name: l3-interface-ipv4-address
33794           in: path
33795           description: IP address
33796           required: true
33797           type: string
33798           example: __L3-INTERFACE-IPV4-ADDRESS__
33799         - name: resource-version
33800           in: query
33801           description: resource-version for concurrency
33802           required: true
33803           type: string
33804   /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:
33805     put:
33806       tags:
33807         - Network
33808       summary: see node definition for valid relationships
33809       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33810       consumes:
33811         - application/json
33812         - application/xml
33813       produces:
33814         - application/json
33815         - application/xml
33816       responses:
33817         "default":
33818           description: Response codes found in [response codes](https://wiki.onap.org/).
33819       parameters:
33820         - name: vnf-id
33821           in: path
33822           description: Unique id of VNF.  This is unique across the graph.
33823           required: true
33824           type: string
33825           example: __VNF-ID__
33826         - name: interface-name
33827           in: path
33828           description: Name that identifies the link aggregate interface
33829           required: true
33830           type: string
33831           example: __INTERFACE-NAME__
33832         - name: interface-name
33833           in: path
33834           description: Name given to the interface
33835           required: true
33836           type: string
33837           example: __INTERFACE-NAME__
33838         - name: l3-interface-ipv6-address
33839           in: path
33840           description: IP address
33841           required: true
33842           type: string
33843           example: __L3-INTERFACE-IPV6-ADDRESS__
33844         - name: body
33845           in: body
33846           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33847           required: true
33848           schema:
33849             $ref: "#/definitions/relationship"
33850     delete:
33851       tags:
33852         - Network
33853       summary: delete an existing relationship
33854       description: delete an existing relationship
33855       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33856       consumes:
33857         - application/json
33858         - application/xml
33859       produces:
33860         - application/json
33861         - application/xml
33862       responses:
33863         "default":
33864           description: Response codes found in [response codes](https://wiki.onap.org/).
33865       parameters:
33866         - name: vnf-id
33867           in: path
33868           description: Unique id of VNF.  This is unique across the graph.
33869           required: true
33870           type: string
33871           example: __VNF-ID__
33872         - name: interface-name
33873           in: path
33874           description: Name that identifies the link aggregate interface
33875           required: true
33876           type: string
33877           example: __INTERFACE-NAME__
33878         - name: interface-name
33879           in: path
33880           description: Name given to the interface
33881           required: true
33882           type: string
33883           example: __INTERFACE-NAME__
33884         - name: l3-interface-ipv6-address
33885           in: path
33886           description: IP address
33887           required: true
33888           type: string
33889           example: __L3-INTERFACE-IPV6-ADDRESS__
33890   /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}:
33891     get:
33892       tags:
33893         - Network
33894       summary: returns l3-interface-ipv6-address-list
33895       description: returns l3-interface-ipv6-address-list
33896       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33897       produces:
33898         - application/json
33899         - application/xml
33900       responses:
33901         "200":
33902           description: successful operation
33903           schema:
33904               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33905         "default":
33906           description: Response codes found in [response codes](https://wiki.onap.org/).
33907       parameters:
33908         - name: vnf-id
33909           in: path
33910           description: Unique id of VNF.  This is unique across the graph.
33911           required: true
33912           type: string
33913           example: __VNF-ID__
33914         - name: interface-name
33915           in: path
33916           description: Name that identifies the link aggregate interface
33917           required: true
33918           type: string
33919           example: __INTERFACE-NAME__
33920         - name: interface-name
33921           in: path
33922           description: Name given to the interface
33923           required: true
33924           type: string
33925           example: __INTERFACE-NAME__
33926         - name: l3-interface-ipv6-address
33927           in: path
33928           description: IP address
33929           required: true
33930           type: string
33931           example: __L3-INTERFACE-IPV6-ADDRESS__
33932     put:
33933       tags:
33934         - Network
33935       summary: create or update an existing l3-interface-ipv6-address-list
33936       description: |
33937         Create or update an existing l3-interface-ipv6-address-list.
33938         #
33939         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33940       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33941       consumes:
33942         - application/json
33943         - application/xml
33944       produces:
33945         - application/json
33946         - application/xml
33947       responses:
33948         "default":
33949           description: Response codes found in [response codes](https://wiki.onap.org/).
33950       parameters:
33951         - name: vnf-id
33952           in: path
33953           description: Unique id of VNF.  This is unique across the graph.
33954           required: true
33955           type: string
33956           example: __VNF-ID__
33957         - name: interface-name
33958           in: path
33959           description: Name that identifies the link aggregate interface
33960           required: true
33961           type: string
33962           example: __INTERFACE-NAME__
33963         - name: interface-name
33964           in: path
33965           description: Name given to the interface
33966           required: true
33967           type: string
33968           example: __INTERFACE-NAME__
33969         - name: l3-interface-ipv6-address
33970           in: path
33971           description: IP address
33972           required: true
33973           type: string
33974           example: __L3-INTERFACE-IPV6-ADDRESS__
33975         - name: body
33976           in: body
33977           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33978           required: true
33979           schema:
33980             $ref: "#/definitions/l3-interface-ipv6-address-list"
33981     patch:
33982       tags:
33983         - Network
33984       summary: update an existing l3-interface-ipv6-address-list
33985       description: |
33986         Update an existing l3-interface-ipv6-address-list
33987         #
33988         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33989         The PUT operation will entirely replace an existing object.
33990         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33991         #
33992         Other differences between PUT and PATCH are:
33993         #
33994         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33995         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33996         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33997       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33998       consumes:
33999         - application/json
34000         - application/xml
34001       produces:
34002         - application/json
34003         - application/xml
34004       responses:
34005         "default":
34006           description: Response codes found in [response codes](https://wiki.onap.org/).
34007       parameters:
34008         - name: vnf-id
34009           in: path
34010           description: Unique id of VNF.  This is unique across the graph.
34011           required: true
34012           type: string
34013           example: __VNF-ID__
34014         - name: interface-name
34015           in: path
34016           description: Name that identifies the link aggregate interface
34017           required: true
34018           type: string
34019           example: __INTERFACE-NAME__
34020         - name: interface-name
34021           in: path
34022           description: Name given to the interface
34023           required: true
34024           type: string
34025           example: __INTERFACE-NAME__
34026         - name: l3-interface-ipv6-address
34027           in: path
34028           description: IP address
34029           required: true
34030           type: string
34031           example: __L3-INTERFACE-IPV6-ADDRESS__
34032         - name: body
34033           in: body
34034           description: l3-interface-ipv6-address-list object that needs to be updated.
34035           required: true
34036           schema:
34037             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34038     delete:
34039       tags:
34040         - Network
34041       summary: delete an existing l3-interface-ipv6-address-list
34042       description: delete an existing l3-interface-ipv6-address-list
34043       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34044       consumes:
34045         - application/json
34046         - application/xml
34047       produces:
34048         - application/json
34049         - application/xml
34050       responses:
34051         "default":
34052           description: Response codes found in [response codes](https://wiki.onap.org/).
34053       parameters:
34054         - name: vnf-id
34055           in: path
34056           description: Unique id of VNF.  This is unique across the graph.
34057           required: true
34058           type: string
34059           example: __VNF-ID__
34060         - name: interface-name
34061           in: path
34062           description: Name that identifies the link aggregate interface
34063           required: true
34064           type: string
34065           example: __INTERFACE-NAME__
34066         - name: interface-name
34067           in: path
34068           description: Name given to the interface
34069           required: true
34070           type: string
34071           example: __INTERFACE-NAME__
34072         - name: l3-interface-ipv6-address
34073           in: path
34074           description: IP address
34075           required: true
34076           type: string
34077           example: __L3-INTERFACE-IPV6-ADDRESS__
34078         - name: resource-version
34079           in: query
34080           description: resource-version for concurrency
34081           required: true
34082           type: string
34083   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
34084     get:
34085       tags:
34086         - Network
34087       summary: returns l-interface
34088       description: returns l-interface
34089       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34090       produces:
34091         - application/json
34092         - application/xml
34093       responses:
34094         "200":
34095           description: successful operation
34096           schema:
34097               $ref: "#/getDefinitions/l-interface"
34098         "default":
34099           description: Response codes found in [response codes](https://wiki.onap.org/).
34100       parameters:
34101         - name: vnf-id
34102           in: path
34103           description: Unique id of VNF.  This is unique across the graph.
34104           required: true
34105           type: string
34106           example: __VNF-ID__
34107         - name: interface-name
34108           in: path
34109           description: Name that identifies the link aggregate interface
34110           required: true
34111           type: string
34112           example: __INTERFACE-NAME__
34113         - name: interface-name
34114           in: path
34115           description: Name given to the interface
34116           required: true
34117           type: string
34118           example: __INTERFACE-NAME__
34119     put:
34120       tags:
34121         - Network
34122       summary: create or update an existing l-interface
34123       description: |
34124         Create or update an existing l-interface.
34125         #
34126         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34127       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34128       consumes:
34129         - application/json
34130         - application/xml
34131       produces:
34132         - application/json
34133         - application/xml
34134       responses:
34135         "default":
34136           description: Response codes found in [response codes](https://wiki.onap.org/).
34137       parameters:
34138         - name: vnf-id
34139           in: path
34140           description: Unique id of VNF.  This is unique across the graph.
34141           required: true
34142           type: string
34143           example: __VNF-ID__
34144         - name: interface-name
34145           in: path
34146           description: Name that identifies the link aggregate interface
34147           required: true
34148           type: string
34149           example: __INTERFACE-NAME__
34150         - name: interface-name
34151           in: path
34152           description: Name given to the interface
34153           required: true
34154           type: string
34155           example: __INTERFACE-NAME__
34156         - name: body
34157           in: body
34158           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34159           required: true
34160           schema:
34161             $ref: "#/definitions/l-interface"
34162     patch:
34163       tags:
34164         - Network
34165       summary: update an existing l-interface
34166       description: |
34167         Update an existing l-interface
34168         #
34169         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34170         The PUT operation will entirely replace an existing object.
34171         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34172         #
34173         Other differences between PUT and PATCH are:
34174         #
34175         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34176         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34177         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34178       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34179       consumes:
34180         - application/json
34181         - application/xml
34182       produces:
34183         - application/json
34184         - application/xml
34185       responses:
34186         "default":
34187           description: Response codes found in [response codes](https://wiki.onap.org/).
34188       parameters:
34189         - name: vnf-id
34190           in: path
34191           description: Unique id of VNF.  This is unique across the graph.
34192           required: true
34193           type: string
34194           example: __VNF-ID__
34195         - name: interface-name
34196           in: path
34197           description: Name that identifies the link aggregate interface
34198           required: true
34199           type: string
34200           example: __INTERFACE-NAME__
34201         - name: interface-name
34202           in: path
34203           description: Name given to the interface
34204           required: true
34205           type: string
34206           example: __INTERFACE-NAME__
34207         - name: body
34208           in: body
34209           description: l-interface object that needs to be updated.
34210           required: true
34211           schema:
34212             $ref: "#/patchDefinitions/l-interface"
34213     delete:
34214       tags:
34215         - Network
34216       summary: delete an existing l-interface
34217       description: delete an existing l-interface
34218       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34219       consumes:
34220         - application/json
34221         - application/xml
34222       produces:
34223         - application/json
34224         - application/xml
34225       responses:
34226         "default":
34227           description: Response codes found in [response codes](https://wiki.onap.org/).
34228       parameters:
34229         - name: vnf-id
34230           in: path
34231           description: Unique id of VNF.  This is unique across the graph.
34232           required: true
34233           type: string
34234           example: __VNF-ID__
34235         - name: interface-name
34236           in: path
34237           description: Name that identifies the link aggregate interface
34238           required: true
34239           type: string
34240           example: __INTERFACE-NAME__
34241         - name: interface-name
34242           in: path
34243           description: Name given to the interface
34244           required: true
34245           type: string
34246           example: __INTERFACE-NAME__
34247         - name: resource-version
34248           in: query
34249           description: resource-version for concurrency
34250           required: true
34251           type: string
34252   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
34253     get:
34254       tags:
34255         - Network
34256       summary: returns l-interfaces
34257       description: returns l-interfaces
34258       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
34259       produces:
34260         - application/json
34261         - application/xml
34262       responses:
34263         "200":
34264           description: successful operation
34265           schema:
34266               $ref: "#/getDefinitions/l-interfaces"
34267         "default":
34268           description: Response codes found in [response codes](https://wiki.onap.org/).
34269       parameters:
34270         - name: vnf-id
34271           in: path
34272           description: Unique id of VNF.  This is unique across the graph.
34273           required: true
34274           type: string
34275           example: __VNF-ID__
34276         - name: interface-name
34277           in: path
34278           description: Name that identifies the link aggregate interface
34279           required: true
34280           type: string
34281           example: __INTERFACE-NAME__
34282         - name: interface-name
34283           in: query
34284           description:
34285           required: false
34286           type: string
34287         - name: interface-id
34288           in: query
34289           description:
34290           required: false
34291           type: string
34292         - name: macaddr
34293           in: query
34294           description:
34295           required: false
34296           type: string
34297         - name: network-name
34298           in: query
34299           description:
34300           required: false
34301           type: string
34302   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
34303     get:
34304       tags:
34305         - Network
34306       summary: returns lag-interface
34307       description: returns lag-interface
34308       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34309       produces:
34310         - application/json
34311         - application/xml
34312       responses:
34313         "200":
34314           description: successful operation
34315           schema:
34316               $ref: "#/getDefinitions/lag-interface"
34317         "default":
34318           description: Response codes found in [response codes](https://wiki.onap.org/).
34319       parameters:
34320         - name: vnf-id
34321           in: path
34322           description: Unique id of VNF.  This is unique across the graph.
34323           required: true
34324           type: string
34325           example: __VNF-ID__
34326         - name: interface-name
34327           in: path
34328           description: Name that identifies the link aggregate interface
34329           required: true
34330           type: string
34331           example: __INTERFACE-NAME__
34332     put:
34333       tags:
34334         - Network
34335       summary: create or update an existing lag-interface
34336       description: |
34337         Create or update an existing lag-interface.
34338         #
34339         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34340       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34341       consumes:
34342         - application/json
34343         - application/xml
34344       produces:
34345         - application/json
34346         - application/xml
34347       responses:
34348         "default":
34349           description: Response codes found in [response codes](https://wiki.onap.org/).
34350       parameters:
34351         - name: vnf-id
34352           in: path
34353           description: Unique id of VNF.  This is unique across the graph.
34354           required: true
34355           type: string
34356           example: __VNF-ID__
34357         - name: interface-name
34358           in: path
34359           description: Name that identifies the link aggregate interface
34360           required: true
34361           type: string
34362           example: __INTERFACE-NAME__
34363         - name: body
34364           in: body
34365           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
34366           required: true
34367           schema:
34368             $ref: "#/definitions/lag-interface"
34369     patch:
34370       tags:
34371         - Network
34372       summary: update an existing lag-interface
34373       description: |
34374         Update an existing lag-interface
34375         #
34376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34377         The PUT operation will entirely replace an existing object.
34378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34379         #
34380         Other differences between PUT and PATCH are:
34381         #
34382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34385       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34386       consumes:
34387         - application/json
34388         - application/xml
34389       produces:
34390         - application/json
34391         - application/xml
34392       responses:
34393         "default":
34394           description: Response codes found in [response codes](https://wiki.onap.org/).
34395       parameters:
34396         - name: vnf-id
34397           in: path
34398           description: Unique id of VNF.  This is unique across the graph.
34399           required: true
34400           type: string
34401           example: __VNF-ID__
34402         - name: interface-name
34403           in: path
34404           description: Name that identifies the link aggregate interface
34405           required: true
34406           type: string
34407           example: __INTERFACE-NAME__
34408         - name: body
34409           in: body
34410           description: lag-interface object that needs to be updated.
34411           required: true
34412           schema:
34413             $ref: "#/patchDefinitions/lag-interface"
34414     delete:
34415       tags:
34416         - Network
34417       summary: delete an existing lag-interface
34418       description: delete an existing lag-interface
34419       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34420       consumes:
34421         - application/json
34422         - application/xml
34423       produces:
34424         - application/json
34425         - application/xml
34426       responses:
34427         "default":
34428           description: Response codes found in [response codes](https://wiki.onap.org/).
34429       parameters:
34430         - name: vnf-id
34431           in: path
34432           description: Unique id of VNF.  This is unique across the graph.
34433           required: true
34434           type: string
34435           example: __VNF-ID__
34436         - name: interface-name
34437           in: path
34438           description: Name that identifies the link aggregate interface
34439           required: true
34440           type: string
34441           example: __INTERFACE-NAME__
34442         - name: resource-version
34443           in: query
34444           description: resource-version for concurrency
34445           required: true
34446           type: string
34447   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
34448     get:
34449       tags:
34450         - Network
34451       summary: returns lag-interfaces
34452       description: returns lag-interfaces
34453       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
34454       produces:
34455         - application/json
34456         - application/xml
34457       responses:
34458         "200":
34459           description: successful operation
34460           schema:
34461               $ref: "#/getDefinitions/lag-interfaces"
34462         "default":
34463           description: Response codes found in [response codes](https://wiki.onap.org/).
34464       parameters:
34465         - name: vnf-id
34466           in: path
34467           description: Unique id of VNF.  This is unique across the graph.
34468           required: true
34469           type: string
34470           example: __VNF-ID__
34471         - name: interface-name
34472           in: query
34473           description:
34474           required: false
34475           type: string
34476         - name: interface-id
34477           in: query
34478           description:
34479           required: false
34480           type: string
34481         - name: interface-role
34482           in: query
34483           description:
34484           required: false
34485           type: string
34486   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
34487     put:
34488       tags:
34489         - Network
34490       summary: see node definition for valid relationships
34491       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34492       consumes:
34493         - application/json
34494         - application/xml
34495       produces:
34496         - application/json
34497         - application/xml
34498       responses:
34499         "default":
34500           description: Response codes found in [response codes](https://wiki.onap.org/).
34501       parameters:
34502         - name: vnf-id
34503           in: path
34504           description: Unique id of VNF.  This is unique across the graph.
34505           required: true
34506           type: string
34507           example: __VNF-ID__
34508         - name: vf-module-id
34509           in: path
34510           description: Unique ID of vf-module.
34511           required: true
34512           type: string
34513           example: __VF-MODULE-ID__
34514         - name: body
34515           in: body
34516           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34517           required: true
34518           schema:
34519             $ref: "#/definitions/relationship"
34520     delete:
34521       tags:
34522         - Network
34523       summary: delete an existing relationship
34524       description: delete an existing relationship
34525       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34526       consumes:
34527         - application/json
34528         - application/xml
34529       produces:
34530         - application/json
34531         - application/xml
34532       responses:
34533         "default":
34534           description: Response codes found in [response codes](https://wiki.onap.org/).
34535       parameters:
34536         - name: vnf-id
34537           in: path
34538           description: Unique id of VNF.  This is unique across the graph.
34539           required: true
34540           type: string
34541           example: __VNF-ID__
34542         - name: vf-module-id
34543           in: path
34544           description: Unique ID of vf-module.
34545           required: true
34546           type: string
34547           example: __VF-MODULE-ID__
34548   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
34549     get:
34550       tags:
34551         - Network
34552       summary: returns vf-module
34553       description: returns vf-module
34554       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
34555       produces:
34556         - application/json
34557         - application/xml
34558       responses:
34559         "200":
34560           description: successful operation
34561           schema:
34562               $ref: "#/getDefinitions/vf-module"
34563         "default":
34564           description: Response codes found in [response codes](https://wiki.onap.org/).
34565       parameters:
34566         - name: vnf-id
34567           in: path
34568           description: Unique id of VNF.  This is unique across the graph.
34569           required: true
34570           type: string
34571           example: __VNF-ID__
34572         - name: vf-module-id
34573           in: path
34574           description: Unique ID of vf-module.
34575           required: true
34576           type: string
34577           example: __VF-MODULE-ID__
34578     put:
34579       tags:
34580         - Network
34581       summary: create or update an existing vf-module
34582       description: |
34583         Create or update an existing vf-module.
34584         #
34585         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34586       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34587       consumes:
34588         - application/json
34589         - application/xml
34590       produces:
34591         - application/json
34592         - application/xml
34593       responses:
34594         "default":
34595           description: Response codes found in [response codes](https://wiki.onap.org/).
34596       parameters:
34597         - name: vnf-id
34598           in: path
34599           description: Unique id of VNF.  This is unique across the graph.
34600           required: true
34601           type: string
34602           example: __VNF-ID__
34603         - name: vf-module-id
34604           in: path
34605           description: Unique ID of vf-module.
34606           required: true
34607           type: string
34608           example: __VF-MODULE-ID__
34609         - name: body
34610           in: body
34611           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34612           required: true
34613           schema:
34614             $ref: "#/definitions/vf-module"
34615     patch:
34616       tags:
34617         - Network
34618       summary: update an existing vf-module
34619       description: |
34620         Update an existing vf-module
34621         #
34622         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34623         The PUT operation will entirely replace an existing object.
34624         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34625         #
34626         Other differences between PUT and PATCH are:
34627         #
34628         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34629         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34630         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34631       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34632       consumes:
34633         - application/json
34634         - application/xml
34635       produces:
34636         - application/json
34637         - application/xml
34638       responses:
34639         "default":
34640           description: Response codes found in [response codes](https://wiki.onap.org/).
34641       parameters:
34642         - name: vnf-id
34643           in: path
34644           description: Unique id of VNF.  This is unique across the graph.
34645           required: true
34646           type: string
34647           example: __VNF-ID__
34648         - name: vf-module-id
34649           in: path
34650           description: Unique ID of vf-module.
34651           required: true
34652           type: string
34653           example: __VF-MODULE-ID__
34654         - name: body
34655           in: body
34656           description: vf-module object that needs to be updated.
34657           required: true
34658           schema:
34659             $ref: "#/patchDefinitions/vf-module"
34660     delete:
34661       tags:
34662         - Network
34663       summary: delete an existing vf-module
34664       description: delete an existing vf-module
34665       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
34666       consumes:
34667         - application/json
34668         - application/xml
34669       produces:
34670         - application/json
34671         - application/xml
34672       responses:
34673         "default":
34674           description: Response codes found in [response codes](https://wiki.onap.org/).
34675       parameters:
34676         - name: vnf-id
34677           in: path
34678           description: Unique id of VNF.  This is unique across the graph.
34679           required: true
34680           type: string
34681           example: __VNF-ID__
34682         - name: vf-module-id
34683           in: path
34684           description: Unique ID of vf-module.
34685           required: true
34686           type: string
34687           example: __VF-MODULE-ID__
34688         - name: resource-version
34689           in: query
34690           description: resource-version for concurrency
34691           required: true
34692           type: string
34693   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
34694     get:
34695       tags:
34696         - Network
34697       summary: returns vf-modules
34698       description: returns vf-modules
34699       operationId: getNetworkGenericVnfsGenericVnfVfModules
34700       produces:
34701         - application/json
34702         - application/xml
34703       responses:
34704         "200":
34705           description: successful operation
34706           schema:
34707               $ref: "#/getDefinitions/vf-modules"
34708         "default":
34709           description: Response codes found in [response codes](https://wiki.onap.org/).
34710       parameters:
34711         - name: vnf-id
34712           in: path
34713           description: Unique id of VNF.  This is unique across the graph.
34714           required: true
34715           type: string
34716           example: __VNF-ID__
34717         - name: vf-module-id
34718           in: query
34719           description:
34720           required: false
34721           type: string
34722         - name: vf-module-name
34723           in: query
34724           description:
34725           required: false
34726           type: string
34727         - name: heat-stack-id
34728           in: query
34729           description:
34730           required: false
34731           type: string
34732         - name: model-invariant-id
34733           in: query
34734           description:
34735           required: false
34736           type: string
34737         - name: model-version-id
34738           in: query
34739           description:
34740           required: false
34741           type: string
34742         - name: widget-model-id
34743           in: query
34744           description:
34745           required: false
34746           type: string
34747         - name: widget-model-version
34748           in: query
34749           description:
34750           required: false
34751           type: string
34752         - name: contrail-service-instance-fqdn
34753           in: query
34754           description:
34755           required: false
34756           type: string
34757   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
34758     put:
34759       tags:
34760         - Network
34761       summary: see node definition for valid relationships
34762       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
34763       consumes:
34764         - application/json
34765         - application/xml
34766       produces:
34767         - application/json
34768         - application/xml
34769       responses:
34770         "default":
34771           description: Response codes found in [response codes](https://wiki.onap.org/).
34772       parameters:
34773         - name: vnf-id
34774           in: path
34775           description: Unique id of VNF.  This is unique across the graph.
34776           required: true
34777           type: string
34778           example: __VNF-ID__
34779         - name: group-uuid
34780           in: path
34781           description: Unique ID for the license group the resource belongs to, should be uuid.
34782           required: true
34783           type: string
34784           example: __GROUP-UUID__
34785         - name: resource-uuid
34786           in: path
34787           description: Unique ID of a license resource.
34788           required: true
34789           type: string
34790           example: __RESOURCE-UUID__
34791         - name: body
34792           in: body
34793           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
34794           required: true
34795           schema:
34796             $ref: "#/definitions/relationship"
34797     delete:
34798       tags:
34799         - Network
34800       summary: delete an existing relationship
34801       description: delete an existing relationship
34802       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
34803       consumes:
34804         - application/json
34805         - application/xml
34806       produces:
34807         - application/json
34808         - application/xml
34809       responses:
34810         "default":
34811           description: Response codes found in [response codes](https://wiki.onap.org/).
34812       parameters:
34813         - name: vnf-id
34814           in: path
34815           description: Unique id of VNF.  This is unique across the graph.
34816           required: true
34817           type: string
34818           example: __VNF-ID__
34819         - name: group-uuid
34820           in: path
34821           description: Unique ID for the license group the resource belongs to, should be uuid.
34822           required: true
34823           type: string
34824           example: __GROUP-UUID__
34825         - name: resource-uuid
34826           in: path
34827           description: Unique ID of a license resource.
34828           required: true
34829           type: string
34830           example: __RESOURCE-UUID__
34831   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
34832     get:
34833       tags:
34834         - Network
34835       summary: returns license
34836       description: returns license
34837       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
34838       produces:
34839         - application/json
34840         - application/xml
34841       responses:
34842         "200":
34843           description: successful operation
34844           schema:
34845               $ref: "#/getDefinitions/license"
34846         "default":
34847           description: Response codes found in [response codes](https://wiki.onap.org/).
34848       parameters:
34849         - name: vnf-id
34850           in: path
34851           description: Unique id of VNF.  This is unique across the graph.
34852           required: true
34853           type: string
34854           example: __VNF-ID__
34855         - name: group-uuid
34856           in: path
34857           description: Unique ID for the license group the resource belongs to, should be uuid.
34858           required: true
34859           type: string
34860           example: __GROUP-UUID__
34861         - name: resource-uuid
34862           in: path
34863           description: Unique ID of a license resource.
34864           required: true
34865           type: string
34866           example: __RESOURCE-UUID__
34867     put:
34868       tags:
34869         - Network
34870       summary: create or update an existing license
34871       description: |
34872         Create or update an existing license.
34873         #
34874         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34875       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
34876       consumes:
34877         - application/json
34878         - application/xml
34879       produces:
34880         - application/json
34881         - application/xml
34882       responses:
34883         "default":
34884           description: Response codes found in [response codes](https://wiki.onap.org/).
34885       parameters:
34886         - name: vnf-id
34887           in: path
34888           description: Unique id of VNF.  This is unique across the graph.
34889           required: true
34890           type: string
34891           example: __VNF-ID__
34892         - name: group-uuid
34893           in: path
34894           description: Unique ID for the license group the resource belongs to, should be uuid.
34895           required: true
34896           type: string
34897           example: __GROUP-UUID__
34898         - name: resource-uuid
34899           in: path
34900           description: Unique ID of a license resource.
34901           required: true
34902           type: string
34903           example: __RESOURCE-UUID__
34904         - name: body
34905           in: body
34906           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
34907           required: true
34908           schema:
34909             $ref: "#/definitions/license"
34910     patch:
34911       tags:
34912         - Network
34913       summary: update an existing license
34914       description: |
34915         Update an existing license
34916         #
34917         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34918         The PUT operation will entirely replace an existing object.
34919         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34920         #
34921         Other differences between PUT and PATCH are:
34922         #
34923         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34924         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34925         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34926       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
34927       consumes:
34928         - application/json
34929         - application/xml
34930       produces:
34931         - application/json
34932         - application/xml
34933       responses:
34934         "default":
34935           description: Response codes found in [response codes](https://wiki.onap.org/).
34936       parameters:
34937         - name: vnf-id
34938           in: path
34939           description: Unique id of VNF.  This is unique across the graph.
34940           required: true
34941           type: string
34942           example: __VNF-ID__
34943         - name: group-uuid
34944           in: path
34945           description: Unique ID for the license group the resource belongs to, should be uuid.
34946           required: true
34947           type: string
34948           example: __GROUP-UUID__
34949         - name: resource-uuid
34950           in: path
34951           description: Unique ID of a license resource.
34952           required: true
34953           type: string
34954           example: __RESOURCE-UUID__
34955         - name: body
34956           in: body
34957           description: license object that needs to be updated.
34958           required: true
34959           schema:
34960             $ref: "#/patchDefinitions/license"
34961     delete:
34962       tags:
34963         - Network
34964       summary: delete an existing license
34965       description: delete an existing license
34966       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
34967       consumes:
34968         - application/json
34969         - application/xml
34970       produces:
34971         - application/json
34972         - application/xml
34973       responses:
34974         "default":
34975           description: Response codes found in [response codes](https://wiki.onap.org/).
34976       parameters:
34977         - name: vnf-id
34978           in: path
34979           description: Unique id of VNF.  This is unique across the graph.
34980           required: true
34981           type: string
34982           example: __VNF-ID__
34983         - name: group-uuid
34984           in: path
34985           description: Unique ID for the license group the resource belongs to, should be uuid.
34986           required: true
34987           type: string
34988           example: __GROUP-UUID__
34989         - name: resource-uuid
34990           in: path
34991           description: Unique ID of a license resource.
34992           required: true
34993           type: string
34994           example: __RESOURCE-UUID__
34995         - name: resource-version
34996           in: query
34997           description: resource-version for concurrency
34998           required: true
34999           type: string
35000   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
35001     get:
35002       tags:
35003         - Network
35004       summary: returns licenses
35005       description: returns licenses
35006       operationId: getNetworkGenericVnfsGenericVnfLicenses
35007       produces:
35008         - application/json
35009         - application/xml
35010       responses:
35011         "200":
35012           description: successful operation
35013           schema:
35014               $ref: "#/getDefinitions/licenses"
35015         "default":
35016           description: Response codes found in [response codes](https://wiki.onap.org/).
35017       parameters:
35018         - name: vnf-id
35019           in: path
35020           description: Unique id of VNF.  This is unique across the graph.
35021           required: true
35022           type: string
35023           example: __VNF-ID__
35024         - name: group-uuid
35025           in: query
35026           description:
35027           required: false
35028           type: string
35029         - name: resource-uuid
35030           in: query
35031           description:
35032           required: false
35033           type: string
35034   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
35035     put:
35036       tags:
35037         - Network
35038       summary: see node definition for valid relationships
35039       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
35040       consumes:
35041         - application/json
35042         - application/xml
35043       produces:
35044         - application/json
35045         - application/xml
35046       responses:
35047         "default":
35048           description: Response codes found in [response codes](https://wiki.onap.org/).
35049       parameters:
35050         - name: vnf-id
35051           in: path
35052           description: Unique id of VNF.  This is unique across the graph.
35053           required: true
35054           type: string
35055           example: __VNF-ID__
35056         - name: group-uuid
35057           in: path
35058           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35059           required: true
35060           type: string
35061           example: __GROUP-UUID__
35062         - name: resource-uuid
35063           in: path
35064           description: Unique ID of an entitlement resource.
35065           required: true
35066           type: string
35067           example: __RESOURCE-UUID__
35068         - name: body
35069           in: body
35070           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
35071           required: true
35072           schema:
35073             $ref: "#/definitions/relationship"
35074     delete:
35075       tags:
35076         - Network
35077       summary: delete an existing relationship
35078       description: delete an existing relationship
35079       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
35080       consumes:
35081         - application/json
35082         - application/xml
35083       produces:
35084         - application/json
35085         - application/xml
35086       responses:
35087         "default":
35088           description: Response codes found in [response codes](https://wiki.onap.org/).
35089       parameters:
35090         - name: vnf-id
35091           in: path
35092           description: Unique id of VNF.  This is unique across the graph.
35093           required: true
35094           type: string
35095           example: __VNF-ID__
35096         - name: group-uuid
35097           in: path
35098           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35099           required: true
35100           type: string
35101           example: __GROUP-UUID__
35102         - name: resource-uuid
35103           in: path
35104           description: Unique ID of an entitlement resource.
35105           required: true
35106           type: string
35107           example: __RESOURCE-UUID__
35108   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
35109     get:
35110       tags:
35111         - Network
35112       summary: returns entitlement
35113       description: returns entitlement
35114       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35115       produces:
35116         - application/json
35117         - application/xml
35118       responses:
35119         "200":
35120           description: successful operation
35121           schema:
35122               $ref: "#/getDefinitions/entitlement"
35123         "default":
35124           description: Response codes found in [response codes](https://wiki.onap.org/).
35125       parameters:
35126         - name: vnf-id
35127           in: path
35128           description: Unique id of VNF.  This is unique across the graph.
35129           required: true
35130           type: string
35131           example: __VNF-ID__
35132         - name: group-uuid
35133           in: path
35134           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35135           required: true
35136           type: string
35137           example: __GROUP-UUID__
35138         - name: resource-uuid
35139           in: path
35140           description: Unique ID of an entitlement resource.
35141           required: true
35142           type: string
35143           example: __RESOURCE-UUID__
35144     put:
35145       tags:
35146         - Network
35147       summary: create or update an existing entitlement
35148       description: |
35149         Create or update an existing entitlement.
35150         #
35151         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35152       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35153       consumes:
35154         - application/json
35155         - application/xml
35156       produces:
35157         - application/json
35158         - application/xml
35159       responses:
35160         "default":
35161           description: Response codes found in [response codes](https://wiki.onap.org/).
35162       parameters:
35163         - name: vnf-id
35164           in: path
35165           description: Unique id of VNF.  This is unique across the graph.
35166           required: true
35167           type: string
35168           example: __VNF-ID__
35169         - name: group-uuid
35170           in: path
35171           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35172           required: true
35173           type: string
35174           example: __GROUP-UUID__
35175         - name: resource-uuid
35176           in: path
35177           description: Unique ID of an entitlement resource.
35178           required: true
35179           type: string
35180           example: __RESOURCE-UUID__
35181         - name: body
35182           in: body
35183           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
35184           required: true
35185           schema:
35186             $ref: "#/definitions/entitlement"
35187     patch:
35188       tags:
35189         - Network
35190       summary: update an existing entitlement
35191       description: |
35192         Update an existing entitlement
35193         #
35194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35195         The PUT operation will entirely replace an existing object.
35196         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35197         #
35198         Other differences between PUT and PATCH are:
35199         #
35200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35203       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35204       consumes:
35205         - application/json
35206         - application/xml
35207       produces:
35208         - application/json
35209         - application/xml
35210       responses:
35211         "default":
35212           description: Response codes found in [response codes](https://wiki.onap.org/).
35213       parameters:
35214         - name: vnf-id
35215           in: path
35216           description: Unique id of VNF.  This is unique across the graph.
35217           required: true
35218           type: string
35219           example: __VNF-ID__
35220         - name: group-uuid
35221           in: path
35222           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35223           required: true
35224           type: string
35225           example: __GROUP-UUID__
35226         - name: resource-uuid
35227           in: path
35228           description: Unique ID of an entitlement resource.
35229           required: true
35230           type: string
35231           example: __RESOURCE-UUID__
35232         - name: body
35233           in: body
35234           description: entitlement object that needs to be updated.
35235           required: true
35236           schema:
35237             $ref: "#/patchDefinitions/entitlement"
35238     delete:
35239       tags:
35240         - Network
35241       summary: delete an existing entitlement
35242       description: delete an existing entitlement
35243       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35244       consumes:
35245         - application/json
35246         - application/xml
35247       produces:
35248         - application/json
35249         - application/xml
35250       responses:
35251         "default":
35252           description: Response codes found in [response codes](https://wiki.onap.org/).
35253       parameters:
35254         - name: vnf-id
35255           in: path
35256           description: Unique id of VNF.  This is unique across the graph.
35257           required: true
35258           type: string
35259           example: __VNF-ID__
35260         - name: group-uuid
35261           in: path
35262           description: Unique ID for the entitlement group the resource comes from, should be uuid.
35263           required: true
35264           type: string
35265           example: __GROUP-UUID__
35266         - name: resource-uuid
35267           in: path
35268           description: Unique ID of an entitlement resource.
35269           required: true
35270           type: string
35271           example: __RESOURCE-UUID__
35272         - name: resource-version
35273           in: query
35274           description: resource-version for concurrency
35275           required: true
35276           type: string
35277   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
35278     get:
35279       tags:
35280         - Network
35281       summary: returns entitlements
35282       description: returns entitlements
35283       operationId: getNetworkGenericVnfsGenericVnfEntitlements
35284       produces:
35285         - application/json
35286         - application/xml
35287       responses:
35288         "200":
35289           description: successful operation
35290           schema:
35291               $ref: "#/getDefinitions/entitlements"
35292         "default":
35293           description: Response codes found in [response codes](https://wiki.onap.org/).
35294       parameters:
35295         - name: vnf-id
35296           in: path
35297           description: Unique id of VNF.  This is unique across the graph.
35298           required: true
35299           type: string
35300           example: __VNF-ID__
35301         - name: group-uuid
35302           in: query
35303           description:
35304           required: false
35305           type: string
35306         - name: resource-uuid
35307           in: query
35308           description:
35309           required: false
35310           type: string
35311   /network/generic-vnfs/generic-vnf/{vnf-id}:
35312     get:
35313       tags:
35314         - Network
35315       summary: returns generic-vnf
35316       description: returns generic-vnf
35317       operationId: getNetworkGenericVnfsGenericVnf
35318       produces:
35319         - application/json
35320         - application/xml
35321       responses:
35322         "200":
35323           description: successful operation
35324           schema:
35325               $ref: "#/getDefinitions/generic-vnf"
35326         "default":
35327           description: Response codes found in [response codes](https://wiki.onap.org/).
35328       parameters:
35329         - name: vnf-id
35330           in: path
35331           description: Unique id of VNF.  This is unique across the graph.
35332           required: true
35333           type: string
35334           example: __VNF-ID__
35335     put:
35336       tags:
35337         - Network
35338       summary: create or update an existing generic-vnf
35339       description: |
35340         Create or update an existing generic-vnf.
35341         #
35342         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35343       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
35344       consumes:
35345         - application/json
35346         - application/xml
35347       produces:
35348         - application/json
35349         - application/xml
35350       responses:
35351         "default":
35352           description: Response codes found in [response codes](https://wiki.onap.org/).
35353       parameters:
35354         - name: vnf-id
35355           in: path
35356           description: Unique id of VNF.  This is unique across the graph.
35357           required: true
35358           type: string
35359           example: __VNF-ID__
35360         - name: body
35361           in: body
35362           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
35363           required: true
35364           schema:
35365             $ref: "#/definitions/generic-vnf"
35366     patch:
35367       tags:
35368         - Network
35369       summary: update an existing generic-vnf
35370       description: |
35371         Update an existing generic-vnf
35372         #
35373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35374         The PUT operation will entirely replace an existing object.
35375         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35376         #
35377         Other differences between PUT and PATCH are:
35378         #
35379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35382       operationId: UpdateNetworkGenericVnfsGenericVnf
35383       consumes:
35384         - application/json
35385         - application/xml
35386       produces:
35387         - application/json
35388         - application/xml
35389       responses:
35390         "default":
35391           description: Response codes found in [response codes](https://wiki.onap.org/).
35392       parameters:
35393         - name: vnf-id
35394           in: path
35395           description: Unique id of VNF.  This is unique across the graph.
35396           required: true
35397           type: string
35398           example: __VNF-ID__
35399         - name: body
35400           in: body
35401           description: generic-vnf object that needs to be updated.
35402           required: true
35403           schema:
35404             $ref: "#/patchDefinitions/generic-vnf"
35405     delete:
35406       tags:
35407         - Network
35408       summary: delete an existing generic-vnf
35409       description: delete an existing generic-vnf
35410       operationId: deleteNetworkGenericVnfsGenericVnf
35411       consumes:
35412         - application/json
35413         - application/xml
35414       produces:
35415         - application/json
35416         - application/xml
35417       responses:
35418         "default":
35419           description: Response codes found in [response codes](https://wiki.onap.org/).
35420       parameters:
35421         - name: vnf-id
35422           in: path
35423           description: Unique id of VNF.  This is unique across the graph.
35424           required: true
35425           type: string
35426           example: __VNF-ID__
35427         - name: resource-version
35428           in: query
35429           description: resource-version for concurrency
35430           required: true
35431           type: string
35432   /network/generic-vnfs:
35433     get:
35434       tags:
35435         - Network
35436       summary: returns generic-vnfs
35437       description: returns generic-vnfs
35438       operationId: getNetworkGenericVnfs
35439       produces:
35440         - application/json
35441         - application/xml
35442       responses:
35443         "200":
35444           description: successful operation
35445           schema:
35446               $ref: "#/getDefinitions/generic-vnfs"
35447         "default":
35448           description: Response codes found in [response codes](https://wiki.onap.org/).
35449       parameters:
35450         - name: vnf-id
35451           in: query
35452           description:
35453           required: false
35454           type: string
35455         - name: vnf-name
35456           in: query
35457           description:
35458           required: false
35459           type: string
35460         - name: vnf-name2
35461           in: query
35462           description:
35463           required: false
35464           type: string
35465         - name: vnf-type
35466           in: query
35467           description:
35468           required: false
35469           type: string
35470         - name: service-id
35471           in: query
35472           description:
35473           required: false
35474           type: string
35475         - name: regional-resource-zone
35476           in: query
35477           description:
35478           required: false
35479           type: string
35480         - name: prov-status
35481           in: query
35482           description:
35483           required: false
35484           type: string
35485         - name: heat-stack-id
35486           in: query
35487           description:
35488           required: false
35489           type: string
35490         - name: in-maint
35491           in: query
35492           description:
35493           required: false
35494           type: boolean
35495         - name: is-closed-loop-disabled
35496           in: query
35497           description:
35498           required: false
35499           type: boolean
35500         - name: model-invariant-id
35501           in: query
35502           description:
35503           required: false
35504           type: string
35505         - name: model-version-id
35506           in: query
35507           description:
35508           required: false
35509           type: string
35510         - name: widget-model-id
35511           in: query
35512           description:
35513           required: false
35514           type: string
35515         - name: widget-model-version
35516           in: query
35517           description:
35518           required: false
35519           type: string
35520         - name: nf-type
35521           in: query
35522           description:
35523           required: false
35524           type: string
35525         - name: nf-function
35526           in: query
35527           description:
35528           required: false
35529           type: string
35530         - name: nf-role
35531           in: query
35532           description:
35533           required: false
35534           type: string
35535         - name: nf-naming-code
35536           in: query
35537           description:
35538           required: false
35539           type: string
35540   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
35541     put:
35542       tags:
35543         - Network
35544       summary: see node definition for valid relationships
35545       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
35546       consumes:
35547         - application/json
35548         - application/xml
35549       produces:
35550         - application/json
35551         - application/xml
35552       responses:
35553         "default":
35554           description: Response codes found in [response codes](https://wiki.onap.org/).
35555       parameters:
35556         - name: link-name
35557           in: path
35558           description: Alphabetical concatenation of lag-interface names
35559           required: true
35560           type: string
35561           example: __LINK-NAME__
35562         - name: body
35563           in: body
35564           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
35565           required: true
35566           schema:
35567             $ref: "#/definitions/relationship"
35568     delete:
35569       tags:
35570         - Network
35571       summary: delete an existing relationship
35572       description: delete an existing relationship
35573       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
35574       consumes:
35575         - application/json
35576         - application/xml
35577       produces:
35578         - application/json
35579         - application/xml
35580       responses:
35581         "default":
35582           description: Response codes found in [response codes](https://wiki.onap.org/).
35583       parameters:
35584         - name: link-name
35585           in: path
35586           description: Alphabetical concatenation of lag-interface names
35587           required: true
35588           type: string
35589           example: __LINK-NAME__
35590   /network/lag-links/lag-link/{link-name}:
35591     get:
35592       tags:
35593         - Network
35594       summary: returns lag-link
35595       description: returns lag-link
35596       operationId: getNetworkLagLinksLagLink
35597       produces:
35598         - application/json
35599         - application/xml
35600       responses:
35601         "200":
35602           description: successful operation
35603           schema:
35604               $ref: "#/getDefinitions/lag-link"
35605         "default":
35606           description: Response codes found in [response codes](https://wiki.onap.org/).
35607       parameters:
35608         - name: link-name
35609           in: path
35610           description: Alphabetical concatenation of lag-interface names
35611           required: true
35612           type: string
35613           example: __LINK-NAME__
35614     put:
35615       tags:
35616         - Network
35617       summary: create or update an existing lag-link
35618       description: |
35619         Create or update an existing lag-link.
35620         #
35621         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35622       operationId: createOrUpdateNetworkLagLinksLagLink
35623       consumes:
35624         - application/json
35625         - application/xml
35626       produces:
35627         - application/json
35628         - application/xml
35629       responses:
35630         "default":
35631           description: Response codes found in [response codes](https://wiki.onap.org/).
35632       parameters:
35633         - name: link-name
35634           in: path
35635           description: Alphabetical concatenation of lag-interface names
35636           required: true
35637           type: string
35638           example: __LINK-NAME__
35639         - name: body
35640           in: body
35641           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
35642           required: true
35643           schema:
35644             $ref: "#/definitions/lag-link"
35645     patch:
35646       tags:
35647         - Network
35648       summary: update an existing lag-link
35649       description: |
35650         Update an existing lag-link
35651         #
35652         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35653         The PUT operation will entirely replace an existing object.
35654         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35655         #
35656         Other differences between PUT and PATCH are:
35657         #
35658         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35659         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35660         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35661       operationId: UpdateNetworkLagLinksLagLink
35662       consumes:
35663         - application/json
35664         - application/xml
35665       produces:
35666         - application/json
35667         - application/xml
35668       responses:
35669         "default":
35670           description: Response codes found in [response codes](https://wiki.onap.org/).
35671       parameters:
35672         - name: link-name
35673           in: path
35674           description: Alphabetical concatenation of lag-interface names
35675           required: true
35676           type: string
35677           example: __LINK-NAME__
35678         - name: body
35679           in: body
35680           description: lag-link object that needs to be updated.
35681           required: true
35682           schema:
35683             $ref: "#/patchDefinitions/lag-link"
35684     delete:
35685       tags:
35686         - Network
35687       summary: delete an existing lag-link
35688       description: delete an existing lag-link
35689       operationId: deleteNetworkLagLinksLagLink
35690       consumes:
35691         - application/json
35692         - application/xml
35693       produces:
35694         - application/json
35695         - application/xml
35696       responses:
35697         "default":
35698           description: Response codes found in [response codes](https://wiki.onap.org/).
35699       parameters:
35700         - name: link-name
35701           in: path
35702           description: Alphabetical concatenation of lag-interface names
35703           required: true
35704           type: string
35705           example: __LINK-NAME__
35706         - name: resource-version
35707           in: query
35708           description: resource-version for concurrency
35709           required: true
35710           type: string
35711   /network/lag-links:
35712     get:
35713       tags:
35714         - Network
35715       summary: returns lag-links
35716       description: returns lag-links
35717       operationId: getNetworkLagLinks
35718       produces:
35719         - application/json
35720         - application/xml
35721       responses:
35722         "200":
35723           description: successful operation
35724           schema:
35725               $ref: "#/getDefinitions/lag-links"
35726         "default":
35727           description: Response codes found in [response codes](https://wiki.onap.org/).
35728       parameters:
35729         - name: link-name
35730           in: query
35731           description:
35732           required: false
35733           type: string
35734   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
35735     put:
35736       tags:
35737         - Network
35738       summary: see node definition for valid relationships
35739       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
35740       consumes:
35741         - application/json
35742         - application/xml
35743       produces:
35744         - application/json
35745         - application/xml
35746       responses:
35747         "default":
35748           description: Response codes found in [response codes](https://wiki.onap.org/).
35749       parameters:
35750         - name: vnf-id2
35751           in: path
35752           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35753           required: true
35754           type: string
35755           example: __VNF-ID2__
35756         - name: body
35757           in: body
35758           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
35759           required: true
35760           schema:
35761             $ref: "#/definitions/relationship"
35762     delete:
35763       tags:
35764         - Network
35765       summary: delete an existing relationship
35766       description: delete an existing relationship
35767       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
35768       consumes:
35769         - application/json
35770         - application/xml
35771       produces:
35772         - application/json
35773         - application/xml
35774       responses:
35775         "default":
35776           description: Response codes found in [response codes](https://wiki.onap.org/).
35777       parameters:
35778         - name: vnf-id2
35779           in: path
35780           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35781           required: true
35782           type: string
35783           example: __VNF-ID2__
35784   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
35785     put:
35786       tags:
35787         - Network
35788       summary: see node definition for valid relationships
35789       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35790       consumes:
35791         - application/json
35792         - application/xml
35793       produces:
35794         - application/json
35795         - application/xml
35796       responses:
35797         "default":
35798           description: Response codes found in [response codes](https://wiki.onap.org/).
35799       parameters:
35800         - name: vnf-id2
35801           in: path
35802           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35803           required: true
35804           type: string
35805           example: __VNF-ID2__
35806         - name: interface-name
35807           in: path
35808           description: Name given to the interface
35809           required: true
35810           type: string
35811           example: __INTERFACE-NAME__
35812         - name: vlan-interface
35813           in: path
35814           description: String that identifies the interface
35815           required: true
35816           type: string
35817           example: __VLAN-INTERFACE__
35818         - name: body
35819           in: body
35820           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
35821           required: true
35822           schema:
35823             $ref: "#/definitions/relationship"
35824     delete:
35825       tags:
35826         - Network
35827       summary: delete an existing relationship
35828       description: delete an existing relationship
35829       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35830       consumes:
35831         - application/json
35832         - application/xml
35833       produces:
35834         - application/json
35835         - application/xml
35836       responses:
35837         "default":
35838           description: Response codes found in [response codes](https://wiki.onap.org/).
35839       parameters:
35840         - name: vnf-id2
35841           in: path
35842           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35843           required: true
35844           type: string
35845           example: __VNF-ID2__
35846         - name: interface-name
35847           in: path
35848           description: Name given to the interface
35849           required: true
35850           type: string
35851           example: __INTERFACE-NAME__
35852         - name: vlan-interface
35853           in: path
35854           description: String that identifies the interface
35855           required: true
35856           type: string
35857           example: __VLAN-INTERFACE__
35858   /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:
35859     put:
35860       tags:
35861         - Network
35862       summary: see node definition for valid relationships
35863       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35864       consumes:
35865         - application/json
35866         - application/xml
35867       produces:
35868         - application/json
35869         - application/xml
35870       responses:
35871         "default":
35872           description: Response codes found in [response codes](https://wiki.onap.org/).
35873       parameters:
35874         - name: vnf-id2
35875           in: path
35876           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35877           required: true
35878           type: string
35879           example: __VNF-ID2__
35880         - name: interface-name
35881           in: path
35882           description: Name given to the interface
35883           required: true
35884           type: string
35885           example: __INTERFACE-NAME__
35886         - name: vlan-interface
35887           in: path
35888           description: String that identifies the interface
35889           required: true
35890           type: string
35891           example: __VLAN-INTERFACE__
35892         - name: l3-interface-ipv4-address
35893           in: path
35894           description: IP address
35895           required: true
35896           type: string
35897           example: __L3-INTERFACE-IPV4-ADDRESS__
35898         - name: body
35899           in: body
35900           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35901           required: true
35902           schema:
35903             $ref: "#/definitions/relationship"
35904     delete:
35905       tags:
35906         - Network
35907       summary: delete an existing relationship
35908       description: delete an existing relationship
35909       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35910       consumes:
35911         - application/json
35912         - application/xml
35913       produces:
35914         - application/json
35915         - application/xml
35916       responses:
35917         "default":
35918           description: Response codes found in [response codes](https://wiki.onap.org/).
35919       parameters:
35920         - name: vnf-id2
35921           in: path
35922           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35923           required: true
35924           type: string
35925           example: __VNF-ID2__
35926         - name: interface-name
35927           in: path
35928           description: Name given to the interface
35929           required: true
35930           type: string
35931           example: __INTERFACE-NAME__
35932         - name: vlan-interface
35933           in: path
35934           description: String that identifies the interface
35935           required: true
35936           type: string
35937           example: __VLAN-INTERFACE__
35938         - name: l3-interface-ipv4-address
35939           in: path
35940           description: IP address
35941           required: true
35942           type: string
35943           example: __L3-INTERFACE-IPV4-ADDRESS__
35944   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35945     get:
35946       tags:
35947         - Network
35948       summary: returns l3-interface-ipv4-address-list
35949       description: returns l3-interface-ipv4-address-list
35950       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35951       produces:
35952         - application/json
35953         - application/xml
35954       responses:
35955         "200":
35956           description: successful operation
35957           schema:
35958               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35959         "default":
35960           description: Response codes found in [response codes](https://wiki.onap.org/).
35961       parameters:
35962         - name: vnf-id2
35963           in: path
35964           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35965           required: true
35966           type: string
35967           example: __VNF-ID2__
35968         - name: interface-name
35969           in: path
35970           description: Name given to the interface
35971           required: true
35972           type: string
35973           example: __INTERFACE-NAME__
35974         - name: vlan-interface
35975           in: path
35976           description: String that identifies the interface
35977           required: true
35978           type: string
35979           example: __VLAN-INTERFACE__
35980         - name: l3-interface-ipv4-address
35981           in: path
35982           description: IP address
35983           required: true
35984           type: string
35985           example: __L3-INTERFACE-IPV4-ADDRESS__
35986     put:
35987       tags:
35988         - Network
35989       summary: create or update an existing l3-interface-ipv4-address-list
35990       description: |
35991         Create or update an existing l3-interface-ipv4-address-list.
35992         #
35993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35994       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35995       consumes:
35996         - application/json
35997         - application/xml
35998       produces:
35999         - application/json
36000         - application/xml
36001       responses:
36002         "default":
36003           description: Response codes found in [response codes](https://wiki.onap.org/).
36004       parameters:
36005         - name: vnf-id2
36006           in: path
36007           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36008           required: true
36009           type: string
36010           example: __VNF-ID2__
36011         - name: interface-name
36012           in: path
36013           description: Name given to the interface
36014           required: true
36015           type: string
36016           example: __INTERFACE-NAME__
36017         - name: vlan-interface
36018           in: path
36019           description: String that identifies the interface
36020           required: true
36021           type: string
36022           example: __VLAN-INTERFACE__
36023         - name: l3-interface-ipv4-address
36024           in: path
36025           description: IP address
36026           required: true
36027           type: string
36028           example: __L3-INTERFACE-IPV4-ADDRESS__
36029         - name: body
36030           in: body
36031           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
36032           required: true
36033           schema:
36034             $ref: "#/definitions/l3-interface-ipv4-address-list"
36035     patch:
36036       tags:
36037         - Network
36038       summary: update an existing l3-interface-ipv4-address-list
36039       description: |
36040         Update an existing l3-interface-ipv4-address-list
36041         #
36042         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36043         The PUT operation will entirely replace an existing object.
36044         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36045         #
36046         Other differences between PUT and PATCH are:
36047         #
36048         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36049         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36050         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36051       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
36052       consumes:
36053         - application/json
36054         - application/xml
36055       produces:
36056         - application/json
36057         - application/xml
36058       responses:
36059         "default":
36060           description: Response codes found in [response codes](https://wiki.onap.org/).
36061       parameters:
36062         - name: vnf-id2
36063           in: path
36064           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36065           required: true
36066           type: string
36067           example: __VNF-ID2__
36068         - name: interface-name
36069           in: path
36070           description: Name given to the interface
36071           required: true
36072           type: string
36073           example: __INTERFACE-NAME__
36074         - name: vlan-interface
36075           in: path
36076           description: String that identifies the interface
36077           required: true
36078           type: string
36079           example: __VLAN-INTERFACE__
36080         - name: l3-interface-ipv4-address
36081           in: path
36082           description: IP address
36083           required: true
36084           type: string
36085           example: __L3-INTERFACE-IPV4-ADDRESS__
36086         - name: body
36087           in: body
36088           description: l3-interface-ipv4-address-list object that needs to be updated.
36089           required: true
36090           schema:
36091             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36092     delete:
36093       tags:
36094         - Network
36095       summary: delete an existing l3-interface-ipv4-address-list
36096       description: delete an existing l3-interface-ipv4-address-list
36097       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: vnf-id2
36109           in: path
36110           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36111           required: true
36112           type: string
36113           example: __VNF-ID2__
36114         - name: interface-name
36115           in: path
36116           description: Name given to the interface
36117           required: true
36118           type: string
36119           example: __INTERFACE-NAME__
36120         - name: vlan-interface
36121           in: path
36122           description: String that identifies the interface
36123           required: true
36124           type: string
36125           example: __VLAN-INTERFACE__
36126         - name: l3-interface-ipv4-address
36127           in: path
36128           description: IP address
36129           required: true
36130           type: string
36131           example: __L3-INTERFACE-IPV4-ADDRESS__
36132         - name: resource-version
36133           in: query
36134           description: resource-version for concurrency
36135           required: true
36136           type: string
36137   /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:
36138     put:
36139       tags:
36140         - Network
36141       summary: see node definition for valid relationships
36142       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
36143       consumes:
36144         - application/json
36145         - application/xml
36146       produces:
36147         - application/json
36148         - application/xml
36149       responses:
36150         "default":
36151           description: Response codes found in [response codes](https://wiki.onap.org/).
36152       parameters:
36153         - name: vnf-id2
36154           in: path
36155           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36156           required: true
36157           type: string
36158           example: __VNF-ID2__
36159         - name: interface-name
36160           in: path
36161           description: Name given to the interface
36162           required: true
36163           type: string
36164           example: __INTERFACE-NAME__
36165         - name: vlan-interface
36166           in: path
36167           description: String that identifies the interface
36168           required: true
36169           type: string
36170           example: __VLAN-INTERFACE__
36171         - name: l3-interface-ipv6-address
36172           in: path
36173           description: IP address
36174           required: true
36175           type: string
36176           example: __L3-INTERFACE-IPV6-ADDRESS__
36177         - name: body
36178           in: body
36179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
36180           required: true
36181           schema:
36182             $ref: "#/definitions/relationship"
36183     delete:
36184       tags:
36185         - Network
36186       summary: delete an existing relationship
36187       description: delete an existing relationship
36188       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
36189       consumes:
36190         - application/json
36191         - application/xml
36192       produces:
36193         - application/json
36194         - application/xml
36195       responses:
36196         "default":
36197           description: Response codes found in [response codes](https://wiki.onap.org/).
36198       parameters:
36199         - name: vnf-id2
36200           in: path
36201           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36202           required: true
36203           type: string
36204           example: __VNF-ID2__
36205         - name: interface-name
36206           in: path
36207           description: Name given to the interface
36208           required: true
36209           type: string
36210           example: __INTERFACE-NAME__
36211         - name: vlan-interface
36212           in: path
36213           description: String that identifies the interface
36214           required: true
36215           type: string
36216           example: __VLAN-INTERFACE__
36217         - name: l3-interface-ipv6-address
36218           in: path
36219           description: IP address
36220           required: true
36221           type: string
36222           example: __L3-INTERFACE-IPV6-ADDRESS__
36223   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36224     get:
36225       tags:
36226         - Network
36227       summary: returns l3-interface-ipv6-address-list
36228       description: returns l3-interface-ipv6-address-list
36229       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36230       produces:
36231         - application/json
36232         - application/xml
36233       responses:
36234         "200":
36235           description: successful operation
36236           schema:
36237               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36238         "default":
36239           description: Response codes found in [response codes](https://wiki.onap.org/).
36240       parameters:
36241         - name: vnf-id2
36242           in: path
36243           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36244           required: true
36245           type: string
36246           example: __VNF-ID2__
36247         - name: interface-name
36248           in: path
36249           description: Name given to the interface
36250           required: true
36251           type: string
36252           example: __INTERFACE-NAME__
36253         - name: vlan-interface
36254           in: path
36255           description: String that identifies the interface
36256           required: true
36257           type: string
36258           example: __VLAN-INTERFACE__
36259         - name: l3-interface-ipv6-address
36260           in: path
36261           description: IP address
36262           required: true
36263           type: string
36264           example: __L3-INTERFACE-IPV6-ADDRESS__
36265     put:
36266       tags:
36267         - Network
36268       summary: create or update an existing l3-interface-ipv6-address-list
36269       description: |
36270         Create or update an existing l3-interface-ipv6-address-list.
36271         #
36272         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36273       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36274       consumes:
36275         - application/json
36276         - application/xml
36277       produces:
36278         - application/json
36279         - application/xml
36280       responses:
36281         "default":
36282           description: Response codes found in [response codes](https://wiki.onap.org/).
36283       parameters:
36284         - name: vnf-id2
36285           in: path
36286           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36287           required: true
36288           type: string
36289           example: __VNF-ID2__
36290         - name: interface-name
36291           in: path
36292           description: Name given to the interface
36293           required: true
36294           type: string
36295           example: __INTERFACE-NAME__
36296         - name: vlan-interface
36297           in: path
36298           description: String that identifies the interface
36299           required: true
36300           type: string
36301           example: __VLAN-INTERFACE__
36302         - name: l3-interface-ipv6-address
36303           in: path
36304           description: IP address
36305           required: true
36306           type: string
36307           example: __L3-INTERFACE-IPV6-ADDRESS__
36308         - name: body
36309           in: body
36310           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
36311           required: true
36312           schema:
36313             $ref: "#/definitions/l3-interface-ipv6-address-list"
36314     patch:
36315       tags:
36316         - Network
36317       summary: update an existing l3-interface-ipv6-address-list
36318       description: |
36319         Update an existing l3-interface-ipv6-address-list
36320         #
36321         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36322         The PUT operation will entirely replace an existing object.
36323         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36324         #
36325         Other differences between PUT and PATCH are:
36326         #
36327         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36328         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36329         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36330       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36331       consumes:
36332         - application/json
36333         - application/xml
36334       produces:
36335         - application/json
36336         - application/xml
36337       responses:
36338         "default":
36339           description: Response codes found in [response codes](https://wiki.onap.org/).
36340       parameters:
36341         - name: vnf-id2
36342           in: path
36343           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36344           required: true
36345           type: string
36346           example: __VNF-ID2__
36347         - name: interface-name
36348           in: path
36349           description: Name given to the interface
36350           required: true
36351           type: string
36352           example: __INTERFACE-NAME__
36353         - name: vlan-interface
36354           in: path
36355           description: String that identifies the interface
36356           required: true
36357           type: string
36358           example: __VLAN-INTERFACE__
36359         - name: l3-interface-ipv6-address
36360           in: path
36361           description: IP address
36362           required: true
36363           type: string
36364           example: __L3-INTERFACE-IPV6-ADDRESS__
36365         - name: body
36366           in: body
36367           description: l3-interface-ipv6-address-list object that needs to be updated.
36368           required: true
36369           schema:
36370             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36371     delete:
36372       tags:
36373         - Network
36374       summary: delete an existing l3-interface-ipv6-address-list
36375       description: delete an existing l3-interface-ipv6-address-list
36376       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36377       consumes:
36378         - application/json
36379         - application/xml
36380       produces:
36381         - application/json
36382         - application/xml
36383       responses:
36384         "default":
36385           description: Response codes found in [response codes](https://wiki.onap.org/).
36386       parameters:
36387         - name: vnf-id2
36388           in: path
36389           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36390           required: true
36391           type: string
36392           example: __VNF-ID2__
36393         - name: interface-name
36394           in: path
36395           description: Name given to the interface
36396           required: true
36397           type: string
36398           example: __INTERFACE-NAME__
36399         - name: vlan-interface
36400           in: path
36401           description: String that identifies the interface
36402           required: true
36403           type: string
36404           example: __VLAN-INTERFACE__
36405         - name: l3-interface-ipv6-address
36406           in: path
36407           description: IP address
36408           required: true
36409           type: string
36410           example: __L3-INTERFACE-IPV6-ADDRESS__
36411         - name: resource-version
36412           in: query
36413           description: resource-version for concurrency
36414           required: true
36415           type: string
36416   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
36417     get:
36418       tags:
36419         - Network
36420       summary: returns vlan
36421       description: returns vlan
36422       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36423       produces:
36424         - application/json
36425         - application/xml
36426       responses:
36427         "200":
36428           description: successful operation
36429           schema:
36430               $ref: "#/getDefinitions/vlan"
36431         "default":
36432           description: Response codes found in [response codes](https://wiki.onap.org/).
36433       parameters:
36434         - name: vnf-id2
36435           in: path
36436           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36437           required: true
36438           type: string
36439           example: __VNF-ID2__
36440         - name: interface-name
36441           in: path
36442           description: Name given to the interface
36443           required: true
36444           type: string
36445           example: __INTERFACE-NAME__
36446         - name: vlan-interface
36447           in: path
36448           description: String that identifies the interface
36449           required: true
36450           type: string
36451           example: __VLAN-INTERFACE__
36452     put:
36453       tags:
36454         - Network
36455       summary: create or update an existing vlan
36456       description: |
36457         Create or update an existing vlan.
36458         #
36459         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36460       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36461       consumes:
36462         - application/json
36463         - application/xml
36464       produces:
36465         - application/json
36466         - application/xml
36467       responses:
36468         "default":
36469           description: Response codes found in [response codes](https://wiki.onap.org/).
36470       parameters:
36471         - name: vnf-id2
36472           in: path
36473           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36474           required: true
36475           type: string
36476           example: __VNF-ID2__
36477         - name: interface-name
36478           in: path
36479           description: Name given to the interface
36480           required: true
36481           type: string
36482           example: __INTERFACE-NAME__
36483         - name: vlan-interface
36484           in: path
36485           description: String that identifies the interface
36486           required: true
36487           type: string
36488           example: __VLAN-INTERFACE__
36489         - name: body
36490           in: body
36491           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
36492           required: true
36493           schema:
36494             $ref: "#/definitions/vlan"
36495     patch:
36496       tags:
36497         - Network
36498       summary: update an existing vlan
36499       description: |
36500         Update an existing vlan
36501         #
36502         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36503         The PUT operation will entirely replace an existing object.
36504         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36505         #
36506         Other differences between PUT and PATCH are:
36507         #
36508         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36509         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36510         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36511       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
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: vnf-id2
36523           in: path
36524           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36525           required: true
36526           type: string
36527           example: __VNF-ID2__
36528         - name: interface-name
36529           in: path
36530           description: Name given to the interface
36531           required: true
36532           type: string
36533           example: __INTERFACE-NAME__
36534         - name: vlan-interface
36535           in: path
36536           description: String that identifies the interface
36537           required: true
36538           type: string
36539           example: __VLAN-INTERFACE__
36540         - name: body
36541           in: body
36542           description: vlan object that needs to be updated.
36543           required: true
36544           schema:
36545             $ref: "#/patchDefinitions/vlan"
36546     delete:
36547       tags:
36548         - Network
36549       summary: delete an existing vlan
36550       description: delete an existing vlan
36551       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36552       consumes:
36553         - application/json
36554         - application/xml
36555       produces:
36556         - application/json
36557         - application/xml
36558       responses:
36559         "default":
36560           description: Response codes found in [response codes](https://wiki.onap.org/).
36561       parameters:
36562         - name: vnf-id2
36563           in: path
36564           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36565           required: true
36566           type: string
36567           example: __VNF-ID2__
36568         - name: interface-name
36569           in: path
36570           description: Name given to the interface
36571           required: true
36572           type: string
36573           example: __INTERFACE-NAME__
36574         - name: vlan-interface
36575           in: path
36576           description: String that identifies the interface
36577           required: true
36578           type: string
36579           example: __VLAN-INTERFACE__
36580         - name: resource-version
36581           in: query
36582           description: resource-version for concurrency
36583           required: true
36584           type: string
36585   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
36586     get:
36587       tags:
36588         - Network
36589       summary: returns vlans
36590       description: returns vlans
36591       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
36592       produces:
36593         - application/json
36594         - application/xml
36595       responses:
36596         "200":
36597           description: successful operation
36598           schema:
36599               $ref: "#/getDefinitions/vlans"
36600         "default":
36601           description: Response codes found in [response codes](https://wiki.onap.org/).
36602       parameters:
36603         - name: vnf-id2
36604           in: path
36605           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36606           required: true
36607           type: string
36608           example: __VNF-ID2__
36609         - name: interface-name
36610           in: path
36611           description: Name given to the interface
36612           required: true
36613           type: string
36614           example: __INTERFACE-NAME__
36615         - name: vlan-interface
36616           in: query
36617           description:
36618           required: false
36619           type: string
36620         - name: vlan-id-inner
36621           in: query
36622           description:
36623           required: false
36624           type: integer
36625           format: int64
36626         - name: vpn-key
36627           in: query
36628           description:
36629           required: false
36630           type: string
36631   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
36632     put:
36633       tags:
36634         - Network
36635       summary: see node definition for valid relationships
36636       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36637       consumes:
36638         - application/json
36639         - application/xml
36640       produces:
36641         - application/json
36642         - application/xml
36643       responses:
36644         "default":
36645           description: Response codes found in [response codes](https://wiki.onap.org/).
36646       parameters:
36647         - name: vnf-id2
36648           in: path
36649           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36650           required: true
36651           type: string
36652           example: __VNF-ID2__
36653         - name: interface-name
36654           in: path
36655           description: Name given to the interface
36656           required: true
36657           type: string
36658           example: __INTERFACE-NAME__
36659         - name: pci-id
36660           in: path
36661           description: PCI ID used to identify the sriov-vf
36662           required: true
36663           type: string
36664           example: __PCI-ID__
36665         - name: body
36666           in: body
36667           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36668           required: true
36669           schema:
36670             $ref: "#/definitions/relationship"
36671     delete:
36672       tags:
36673         - Network
36674       summary: delete an existing relationship
36675       description: delete an existing relationship
36676       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36677       consumes:
36678         - application/json
36679         - application/xml
36680       produces:
36681         - application/json
36682         - application/xml
36683       responses:
36684         "default":
36685           description: Response codes found in [response codes](https://wiki.onap.org/).
36686       parameters:
36687         - name: vnf-id2
36688           in: path
36689           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36690           required: true
36691           type: string
36692           example: __VNF-ID2__
36693         - name: interface-name
36694           in: path
36695           description: Name given to the interface
36696           required: true
36697           type: string
36698           example: __INTERFACE-NAME__
36699         - name: pci-id
36700           in: path
36701           description: PCI ID used to identify the sriov-vf
36702           required: true
36703           type: string
36704           example: __PCI-ID__
36705   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36706     get:
36707       tags:
36708         - Network
36709       summary: returns sriov-vf
36710       description: returns sriov-vf
36711       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36712       produces:
36713         - application/json
36714         - application/xml
36715       responses:
36716         "200":
36717           description: successful operation
36718           schema:
36719               $ref: "#/getDefinitions/sriov-vf"
36720         "default":
36721           description: Response codes found in [response codes](https://wiki.onap.org/).
36722       parameters:
36723         - name: vnf-id2
36724           in: path
36725           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36726           required: true
36727           type: string
36728           example: __VNF-ID2__
36729         - name: interface-name
36730           in: path
36731           description: Name given to the interface
36732           required: true
36733           type: string
36734           example: __INTERFACE-NAME__
36735         - name: pci-id
36736           in: path
36737           description: PCI ID used to identify the sriov-vf
36738           required: true
36739           type: string
36740           example: __PCI-ID__
36741     put:
36742       tags:
36743         - Network
36744       summary: create or update an existing sriov-vf
36745       description: |
36746         Create or update an existing sriov-vf.
36747         #
36748         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36749       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36750       consumes:
36751         - application/json
36752         - application/xml
36753       produces:
36754         - application/json
36755         - application/xml
36756       responses:
36757         "default":
36758           description: Response codes found in [response codes](https://wiki.onap.org/).
36759       parameters:
36760         - name: vnf-id2
36761           in: path
36762           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36763           required: true
36764           type: string
36765           example: __VNF-ID2__
36766         - name: interface-name
36767           in: path
36768           description: Name given to the interface
36769           required: true
36770           type: string
36771           example: __INTERFACE-NAME__
36772         - name: pci-id
36773           in: path
36774           description: PCI ID used to identify the sriov-vf
36775           required: true
36776           type: string
36777           example: __PCI-ID__
36778         - name: body
36779           in: body
36780           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36781           required: true
36782           schema:
36783             $ref: "#/definitions/sriov-vf"
36784     patch:
36785       tags:
36786         - Network
36787       summary: update an existing sriov-vf
36788       description: |
36789         Update an existing sriov-vf
36790         #
36791         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36792         The PUT operation will entirely replace an existing object.
36793         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36794         #
36795         Other differences between PUT and PATCH are:
36796         #
36797         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36798         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36799         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36800       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36801       consumes:
36802         - application/json
36803         - application/xml
36804       produces:
36805         - application/json
36806         - application/xml
36807       responses:
36808         "default":
36809           description: Response codes found in [response codes](https://wiki.onap.org/).
36810       parameters:
36811         - name: vnf-id2
36812           in: path
36813           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36814           required: true
36815           type: string
36816           example: __VNF-ID2__
36817         - name: interface-name
36818           in: path
36819           description: Name given to the interface
36820           required: true
36821           type: string
36822           example: __INTERFACE-NAME__
36823         - name: pci-id
36824           in: path
36825           description: PCI ID used to identify the sriov-vf
36826           required: true
36827           type: string
36828           example: __PCI-ID__
36829         - name: body
36830           in: body
36831           description: sriov-vf object that needs to be updated.
36832           required: true
36833           schema:
36834             $ref: "#/patchDefinitions/sriov-vf"
36835     delete:
36836       tags:
36837         - Network
36838       summary: delete an existing sriov-vf
36839       description: delete an existing sriov-vf
36840       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36841       consumes:
36842         - application/json
36843         - application/xml
36844       produces:
36845         - application/json
36846         - application/xml
36847       responses:
36848         "default":
36849           description: Response codes found in [response codes](https://wiki.onap.org/).
36850       parameters:
36851         - name: vnf-id2
36852           in: path
36853           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36854           required: true
36855           type: string
36856           example: __VNF-ID2__
36857         - name: interface-name
36858           in: path
36859           description: Name given to the interface
36860           required: true
36861           type: string
36862           example: __INTERFACE-NAME__
36863         - name: pci-id
36864           in: path
36865           description: PCI ID used to identify the sriov-vf
36866           required: true
36867           type: string
36868           example: __PCI-ID__
36869         - name: resource-version
36870           in: query
36871           description: resource-version for concurrency
36872           required: true
36873           type: string
36874   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36875     get:
36876       tags:
36877         - Network
36878       summary: returns sriov-vfs
36879       description: returns sriov-vfs
36880       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
36881       produces:
36882         - application/json
36883         - application/xml
36884       responses:
36885         "200":
36886           description: successful operation
36887           schema:
36888               $ref: "#/getDefinitions/sriov-vfs"
36889         "default":
36890           description: Response codes found in [response codes](https://wiki.onap.org/).
36891       parameters:
36892         - name: vnf-id2
36893           in: path
36894           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36895           required: true
36896           type: string
36897           example: __VNF-ID2__
36898         - name: interface-name
36899           in: path
36900           description: Name given to the interface
36901           required: true
36902           type: string
36903           example: __INTERFACE-NAME__
36904         - name: pci-id
36905           in: query
36906           description:
36907           required: false
36908           type: string
36909         - name: vf-vlan-filter
36910           in: query
36911           description:
36912           required: false
36913           type: string
36914         - name: vf-mac-filter
36915           in: query
36916           description:
36917           required: false
36918           type: string
36919         - name: vf-vlan-strip
36920           in: query
36921           description:
36922           required: false
36923           type: boolean
36924         - name: neutron-network-id
36925           in: query
36926           description:
36927           required: false
36928           type: string
36929   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36930     put:
36931       tags:
36932         - Network
36933       summary: see node definition for valid relationships
36934       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36935       consumes:
36936         - application/json
36937         - application/xml
36938       produces:
36939         - application/json
36940         - application/xml
36941       responses:
36942         "default":
36943           description: Response codes found in [response codes](https://wiki.onap.org/).
36944       parameters:
36945         - name: vnf-id2
36946           in: path
36947           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36948           required: true
36949           type: string
36950           example: __VNF-ID2__
36951         - name: interface-name
36952           in: path
36953           description: Name given to the interface
36954           required: true
36955           type: string
36956           example: __INTERFACE-NAME__
36957         - name: body
36958           in: body
36959           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
36960           required: true
36961           schema:
36962             $ref: "#/definitions/relationship"
36963     delete:
36964       tags:
36965         - Network
36966       summary: delete an existing relationship
36967       description: delete an existing relationship
36968       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36969       consumes:
36970         - application/json
36971         - application/xml
36972       produces:
36973         - application/json
36974         - application/xml
36975       responses:
36976         "default":
36977           description: Response codes found in [response codes](https://wiki.onap.org/).
36978       parameters:
36979         - name: vnf-id2
36980           in: path
36981           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36982           required: true
36983           type: string
36984           example: __VNF-ID2__
36985         - name: interface-name
36986           in: path
36987           description: Name given to the interface
36988           required: true
36989           type: string
36990           example: __INTERFACE-NAME__
36991   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36992     put:
36993       tags:
36994         - Network
36995       summary: see node definition for valid relationships
36996       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36997       consumes:
36998         - application/json
36999         - application/xml
37000       produces:
37001         - application/json
37002         - application/xml
37003       responses:
37004         "default":
37005           description: Response codes found in [response codes](https://wiki.onap.org/).
37006       parameters:
37007         - name: vnf-id2
37008           in: path
37009           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37010           required: true
37011           type: string
37012           example: __VNF-ID2__
37013         - name: interface-name
37014           in: path
37015           description: Name given to the interface
37016           required: true
37017           type: string
37018           example: __INTERFACE-NAME__
37019         - name: l3-interface-ipv4-address
37020           in: path
37021           description: IP address
37022           required: true
37023           type: string
37024           example: __L3-INTERFACE-IPV4-ADDRESS__
37025         - name: body
37026           in: body
37027           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37028           required: true
37029           schema:
37030             $ref: "#/definitions/relationship"
37031     delete:
37032       tags:
37033         - Network
37034       summary: delete an existing relationship
37035       description: delete an existing relationship
37036       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
37037       consumes:
37038         - application/json
37039         - application/xml
37040       produces:
37041         - application/json
37042         - application/xml
37043       responses:
37044         "default":
37045           description: Response codes found in [response codes](https://wiki.onap.org/).
37046       parameters:
37047         - name: vnf-id2
37048           in: path
37049           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37050           required: true
37051           type: string
37052           example: __VNF-ID2__
37053         - name: interface-name
37054           in: path
37055           description: Name given to the interface
37056           required: true
37057           type: string
37058           example: __INTERFACE-NAME__
37059         - name: l3-interface-ipv4-address
37060           in: path
37061           description: IP address
37062           required: true
37063           type: string
37064           example: __L3-INTERFACE-IPV4-ADDRESS__
37065   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37066     get:
37067       tags:
37068         - Network
37069       summary: returns l3-interface-ipv4-address-list
37070       description: returns l3-interface-ipv4-address-list
37071       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37072       produces:
37073         - application/json
37074         - application/xml
37075       responses:
37076         "200":
37077           description: successful operation
37078           schema:
37079               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37080         "default":
37081           description: Response codes found in [response codes](https://wiki.onap.org/).
37082       parameters:
37083         - name: vnf-id2
37084           in: path
37085           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37086           required: true
37087           type: string
37088           example: __VNF-ID2__
37089         - name: interface-name
37090           in: path
37091           description: Name given to the interface
37092           required: true
37093           type: string
37094           example: __INTERFACE-NAME__
37095         - name: l3-interface-ipv4-address
37096           in: path
37097           description: IP address
37098           required: true
37099           type: string
37100           example: __L3-INTERFACE-IPV4-ADDRESS__
37101     put:
37102       tags:
37103         - Network
37104       summary: create or update an existing l3-interface-ipv4-address-list
37105       description: |
37106         Create or update an existing l3-interface-ipv4-address-list.
37107         #
37108         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37109       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37110       consumes:
37111         - application/json
37112         - application/xml
37113       produces:
37114         - application/json
37115         - application/xml
37116       responses:
37117         "default":
37118           description: Response codes found in [response codes](https://wiki.onap.org/).
37119       parameters:
37120         - name: vnf-id2
37121           in: path
37122           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37123           required: true
37124           type: string
37125           example: __VNF-ID2__
37126         - name: interface-name
37127           in: path
37128           description: Name given to the interface
37129           required: true
37130           type: string
37131           example: __INTERFACE-NAME__
37132         - name: l3-interface-ipv4-address
37133           in: path
37134           description: IP address
37135           required: true
37136           type: string
37137           example: __L3-INTERFACE-IPV4-ADDRESS__
37138         - name: body
37139           in: body
37140           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37141           required: true
37142           schema:
37143             $ref: "#/definitions/l3-interface-ipv4-address-list"
37144     patch:
37145       tags:
37146         - Network
37147       summary: update an existing l3-interface-ipv4-address-list
37148       description: |
37149         Update an existing l3-interface-ipv4-address-list
37150         #
37151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37152         The PUT operation will entirely replace an existing object.
37153         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37154         #
37155         Other differences between PUT and PATCH are:
37156         #
37157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37160       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37161       consumes:
37162         - application/json
37163         - application/xml
37164       produces:
37165         - application/json
37166         - application/xml
37167       responses:
37168         "default":
37169           description: Response codes found in [response codes](https://wiki.onap.org/).
37170       parameters:
37171         - name: vnf-id2
37172           in: path
37173           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37174           required: true
37175           type: string
37176           example: __VNF-ID2__
37177         - name: interface-name
37178           in: path
37179           description: Name given to the interface
37180           required: true
37181           type: string
37182           example: __INTERFACE-NAME__
37183         - name: l3-interface-ipv4-address
37184           in: path
37185           description: IP address
37186           required: true
37187           type: string
37188           example: __L3-INTERFACE-IPV4-ADDRESS__
37189         - name: body
37190           in: body
37191           description: l3-interface-ipv4-address-list object that needs to be updated.
37192           required: true
37193           schema:
37194             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37195     delete:
37196       tags:
37197         - Network
37198       summary: delete an existing l3-interface-ipv4-address-list
37199       description: delete an existing l3-interface-ipv4-address-list
37200       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37201       consumes:
37202         - application/json
37203         - application/xml
37204       produces:
37205         - application/json
37206         - application/xml
37207       responses:
37208         "default":
37209           description: Response codes found in [response codes](https://wiki.onap.org/).
37210       parameters:
37211         - name: vnf-id2
37212           in: path
37213           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37214           required: true
37215           type: string
37216           example: __VNF-ID2__
37217         - name: interface-name
37218           in: path
37219           description: Name given to the interface
37220           required: true
37221           type: string
37222           example: __INTERFACE-NAME__
37223         - name: l3-interface-ipv4-address
37224           in: path
37225           description: IP address
37226           required: true
37227           type: string
37228           example: __L3-INTERFACE-IPV4-ADDRESS__
37229         - name: resource-version
37230           in: query
37231           description: resource-version for concurrency
37232           required: true
37233           type: string
37234   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
37235     put:
37236       tags:
37237         - Network
37238       summary: see node definition for valid relationships
37239       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37240       consumes:
37241         - application/json
37242         - application/xml
37243       produces:
37244         - application/json
37245         - application/xml
37246       responses:
37247         "default":
37248           description: Response codes found in [response codes](https://wiki.onap.org/).
37249       parameters:
37250         - name: vnf-id2
37251           in: path
37252           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37253           required: true
37254           type: string
37255           example: __VNF-ID2__
37256         - name: interface-name
37257           in: path
37258           description: Name given to the interface
37259           required: true
37260           type: string
37261           example: __INTERFACE-NAME__
37262         - name: l3-interface-ipv6-address
37263           in: path
37264           description: IP address
37265           required: true
37266           type: string
37267           example: __L3-INTERFACE-IPV6-ADDRESS__
37268         - name: body
37269           in: body
37270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37271           required: true
37272           schema:
37273             $ref: "#/definitions/relationship"
37274     delete:
37275       tags:
37276         - Network
37277       summary: delete an existing relationship
37278       description: delete an existing relationship
37279       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37280       consumes:
37281         - application/json
37282         - application/xml
37283       produces:
37284         - application/json
37285         - application/xml
37286       responses:
37287         "default":
37288           description: Response codes found in [response codes](https://wiki.onap.org/).
37289       parameters:
37290         - name: vnf-id2
37291           in: path
37292           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37293           required: true
37294           type: string
37295           example: __VNF-ID2__
37296         - name: interface-name
37297           in: path
37298           description: Name given to the interface
37299           required: true
37300           type: string
37301           example: __INTERFACE-NAME__
37302         - name: l3-interface-ipv6-address
37303           in: path
37304           description: IP address
37305           required: true
37306           type: string
37307           example: __L3-INTERFACE-IPV6-ADDRESS__
37308   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37309     get:
37310       tags:
37311         - Network
37312       summary: returns l3-interface-ipv6-address-list
37313       description: returns l3-interface-ipv6-address-list
37314       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37315       produces:
37316         - application/json
37317         - application/xml
37318       responses:
37319         "200":
37320           description: successful operation
37321           schema:
37322               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37323         "default":
37324           description: Response codes found in [response codes](https://wiki.onap.org/).
37325       parameters:
37326         - name: vnf-id2
37327           in: path
37328           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37329           required: true
37330           type: string
37331           example: __VNF-ID2__
37332         - name: interface-name
37333           in: path
37334           description: Name given to the interface
37335           required: true
37336           type: string
37337           example: __INTERFACE-NAME__
37338         - name: l3-interface-ipv6-address
37339           in: path
37340           description: IP address
37341           required: true
37342           type: string
37343           example: __L3-INTERFACE-IPV6-ADDRESS__
37344     put:
37345       tags:
37346         - Network
37347       summary: create or update an existing l3-interface-ipv6-address-list
37348       description: |
37349         Create or update an existing l3-interface-ipv6-address-list.
37350         #
37351         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37352       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37353       consumes:
37354         - application/json
37355         - application/xml
37356       produces:
37357         - application/json
37358         - application/xml
37359       responses:
37360         "default":
37361           description: Response codes found in [response codes](https://wiki.onap.org/).
37362       parameters:
37363         - name: vnf-id2
37364           in: path
37365           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37366           required: true
37367           type: string
37368           example: __VNF-ID2__
37369         - name: interface-name
37370           in: path
37371           description: Name given to the interface
37372           required: true
37373           type: string
37374           example: __INTERFACE-NAME__
37375         - name: l3-interface-ipv6-address
37376           in: path
37377           description: IP address
37378           required: true
37379           type: string
37380           example: __L3-INTERFACE-IPV6-ADDRESS__
37381         - name: body
37382           in: body
37383           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37384           required: true
37385           schema:
37386             $ref: "#/definitions/l3-interface-ipv6-address-list"
37387     patch:
37388       tags:
37389         - Network
37390       summary: update an existing l3-interface-ipv6-address-list
37391       description: |
37392         Update an existing l3-interface-ipv6-address-list
37393         #
37394         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37395         The PUT operation will entirely replace an existing object.
37396         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37397         #
37398         Other differences between PUT and PATCH are:
37399         #
37400         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37401         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37402         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37403       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37404       consumes:
37405         - application/json
37406         - application/xml
37407       produces:
37408         - application/json
37409         - application/xml
37410       responses:
37411         "default":
37412           description: Response codes found in [response codes](https://wiki.onap.org/).
37413       parameters:
37414         - name: vnf-id2
37415           in: path
37416           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37417           required: true
37418           type: string
37419           example: __VNF-ID2__
37420         - name: interface-name
37421           in: path
37422           description: Name given to the interface
37423           required: true
37424           type: string
37425           example: __INTERFACE-NAME__
37426         - name: l3-interface-ipv6-address
37427           in: path
37428           description: IP address
37429           required: true
37430           type: string
37431           example: __L3-INTERFACE-IPV6-ADDRESS__
37432         - name: body
37433           in: body
37434           description: l3-interface-ipv6-address-list object that needs to be updated.
37435           required: true
37436           schema:
37437             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37438     delete:
37439       tags:
37440         - Network
37441       summary: delete an existing l3-interface-ipv6-address-list
37442       description: delete an existing l3-interface-ipv6-address-list
37443       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37444       consumes:
37445         - application/json
37446         - application/xml
37447       produces:
37448         - application/json
37449         - application/xml
37450       responses:
37451         "default":
37452           description: Response codes found in [response codes](https://wiki.onap.org/).
37453       parameters:
37454         - name: vnf-id2
37455           in: path
37456           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37457           required: true
37458           type: string
37459           example: __VNF-ID2__
37460         - name: interface-name
37461           in: path
37462           description: Name given to the interface
37463           required: true
37464           type: string
37465           example: __INTERFACE-NAME__
37466         - name: l3-interface-ipv6-address
37467           in: path
37468           description: IP address
37469           required: true
37470           type: string
37471           example: __L3-INTERFACE-IPV6-ADDRESS__
37472         - name: resource-version
37473           in: query
37474           description: resource-version for concurrency
37475           required: true
37476           type: string
37477   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
37478     get:
37479       tags:
37480         - Network
37481       summary: returns l-interface
37482       description: returns l-interface
37483       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
37484       produces:
37485         - application/json
37486         - application/xml
37487       responses:
37488         "200":
37489           description: successful operation
37490           schema:
37491               $ref: "#/getDefinitions/l-interface"
37492         "default":
37493           description: Response codes found in [response codes](https://wiki.onap.org/).
37494       parameters:
37495         - name: vnf-id2
37496           in: path
37497           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37498           required: true
37499           type: string
37500           example: __VNF-ID2__
37501         - name: interface-name
37502           in: path
37503           description: Name given to the interface
37504           required: true
37505           type: string
37506           example: __INTERFACE-NAME__
37507     put:
37508       tags:
37509         - Network
37510       summary: create or update an existing l-interface
37511       description: |
37512         Create or update an existing l-interface.
37513         #
37514         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37515       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
37516       consumes:
37517         - application/json
37518         - application/xml
37519       produces:
37520         - application/json
37521         - application/xml
37522       responses:
37523         "default":
37524           description: Response codes found in [response codes](https://wiki.onap.org/).
37525       parameters:
37526         - name: vnf-id2
37527           in: path
37528           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37529           required: true
37530           type: string
37531           example: __VNF-ID2__
37532         - name: interface-name
37533           in: path
37534           description: Name given to the interface
37535           required: true
37536           type: string
37537           example: __INTERFACE-NAME__
37538         - name: body
37539           in: body
37540           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
37541           required: true
37542           schema:
37543             $ref: "#/definitions/l-interface"
37544     patch:
37545       tags:
37546         - Network
37547       summary: update an existing l-interface
37548       description: |
37549         Update an existing l-interface
37550         #
37551         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37552         The PUT operation will entirely replace an existing object.
37553         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37554         #
37555         Other differences between PUT and PATCH are:
37556         #
37557         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37558         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37559         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37560       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
37561       consumes:
37562         - application/json
37563         - application/xml
37564       produces:
37565         - application/json
37566         - application/xml
37567       responses:
37568         "default":
37569           description: Response codes found in [response codes](https://wiki.onap.org/).
37570       parameters:
37571         - name: vnf-id2
37572           in: path
37573           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37574           required: true
37575           type: string
37576           example: __VNF-ID2__
37577         - name: interface-name
37578           in: path
37579           description: Name given to the interface
37580           required: true
37581           type: string
37582           example: __INTERFACE-NAME__
37583         - name: body
37584           in: body
37585           description: l-interface object that needs to be updated.
37586           required: true
37587           schema:
37588             $ref: "#/patchDefinitions/l-interface"
37589     delete:
37590       tags:
37591         - Network
37592       summary: delete an existing l-interface
37593       description: delete an existing l-interface
37594       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
37595       consumes:
37596         - application/json
37597         - application/xml
37598       produces:
37599         - application/json
37600         - application/xml
37601       responses:
37602         "default":
37603           description: Response codes found in [response codes](https://wiki.onap.org/).
37604       parameters:
37605         - name: vnf-id2
37606           in: path
37607           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37608           required: true
37609           type: string
37610           example: __VNF-ID2__
37611         - name: interface-name
37612           in: path
37613           description: Name given to the interface
37614           required: true
37615           type: string
37616           example: __INTERFACE-NAME__
37617         - name: resource-version
37618           in: query
37619           description: resource-version for concurrency
37620           required: true
37621           type: string
37622   /network/newvces/newvce/{vnf-id2}/l-interfaces:
37623     get:
37624       tags:
37625         - Network
37626       summary: returns l-interfaces
37627       description: returns l-interfaces
37628       operationId: getNetworkNewvcesNewvceLInterfaces
37629       produces:
37630         - application/json
37631         - application/xml
37632       responses:
37633         "200":
37634           description: successful operation
37635           schema:
37636               $ref: "#/getDefinitions/l-interfaces"
37637         "default":
37638           description: Response codes found in [response codes](https://wiki.onap.org/).
37639       parameters:
37640         - name: vnf-id2
37641           in: path
37642           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37643           required: true
37644           type: string
37645           example: __VNF-ID2__
37646         - name: interface-name
37647           in: query
37648           description:
37649           required: false
37650           type: string
37651         - name: interface-id
37652           in: query
37653           description:
37654           required: false
37655           type: string
37656         - name: macaddr
37657           in: query
37658           description:
37659           required: false
37660           type: string
37661         - name: network-name
37662           in: query
37663           description:
37664           required: false
37665           type: string
37666   /network/newvces/newvce/{vnf-id2}:
37667     get:
37668       tags:
37669         - Network
37670       summary: returns newvce
37671       description: returns newvce
37672       operationId: getNetworkNewvcesNewvce
37673       produces:
37674         - application/json
37675         - application/xml
37676       responses:
37677         "200":
37678           description: successful operation
37679           schema:
37680               $ref: "#/getDefinitions/newvce"
37681         "default":
37682           description: Response codes found in [response codes](https://wiki.onap.org/).
37683       parameters:
37684         - name: vnf-id2
37685           in: path
37686           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37687           required: true
37688           type: string
37689           example: __VNF-ID2__
37690     put:
37691       tags:
37692         - Network
37693       summary: create or update an existing newvce
37694       description: |
37695         Create or update an existing newvce.
37696         #
37697         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37698       operationId: createOrUpdateNetworkNewvcesNewvce
37699       consumes:
37700         - application/json
37701         - application/xml
37702       produces:
37703         - application/json
37704         - application/xml
37705       responses:
37706         "default":
37707           description: Response codes found in [response codes](https://wiki.onap.org/).
37708       parameters:
37709         - name: vnf-id2
37710           in: path
37711           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37712           required: true
37713           type: string
37714           example: __VNF-ID2__
37715         - name: body
37716           in: body
37717           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
37718           required: true
37719           schema:
37720             $ref: "#/definitions/newvce"
37721     patch:
37722       tags:
37723         - Network
37724       summary: update an existing newvce
37725       description: |
37726         Update an existing newvce
37727         #
37728         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37729         The PUT operation will entirely replace an existing object.
37730         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37731         #
37732         Other differences between PUT and PATCH are:
37733         #
37734         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37735         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37736         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37737       operationId: UpdateNetworkNewvcesNewvce
37738       consumes:
37739         - application/json
37740         - application/xml
37741       produces:
37742         - application/json
37743         - application/xml
37744       responses:
37745         "default":
37746           description: Response codes found in [response codes](https://wiki.onap.org/).
37747       parameters:
37748         - name: vnf-id2
37749           in: path
37750           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37751           required: true
37752           type: string
37753           example: __VNF-ID2__
37754         - name: body
37755           in: body
37756           description: newvce object that needs to be updated.
37757           required: true
37758           schema:
37759             $ref: "#/patchDefinitions/newvce"
37760     delete:
37761       tags:
37762         - Network
37763       summary: delete an existing newvce
37764       description: delete an existing newvce
37765       operationId: deleteNetworkNewvcesNewvce
37766       consumes:
37767         - application/json
37768         - application/xml
37769       produces:
37770         - application/json
37771         - application/xml
37772       responses:
37773         "default":
37774           description: Response codes found in [response codes](https://wiki.onap.org/).
37775       parameters:
37776         - name: vnf-id2
37777           in: path
37778           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37779           required: true
37780           type: string
37781           example: __VNF-ID2__
37782         - name: resource-version
37783           in: query
37784           description: resource-version for concurrency
37785           required: true
37786           type: string
37787   /network/newvces:
37788     get:
37789       tags:
37790         - Network
37791       summary: returns newvces
37792       description: returns newvces
37793       operationId: getNetworkNewvces
37794       produces:
37795         - application/json
37796         - application/xml
37797       responses:
37798         "200":
37799           description: successful operation
37800           schema:
37801               $ref: "#/getDefinitions/newvces"
37802         "default":
37803           description: Response codes found in [response codes](https://wiki.onap.org/).
37804       parameters:
37805         - name: vnf-id2
37806           in: query
37807           description:
37808           required: false
37809           type: string
37810         - name: vnf-name
37811           in: query
37812           description:
37813           required: false
37814           type: string
37815         - name: vnf-name2
37816           in: query
37817           description:
37818           required: false
37819           type: string
37820         - name: vnf-type
37821           in: query
37822           description:
37823           required: false
37824           type: string
37825         - name: prov-status
37826           in: query
37827           description:
37828           required: false
37829           type: string
37830         - name: heat-stack-id
37831           in: query
37832           description:
37833           required: false
37834           type: string
37835   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
37836     put:
37837       tags:
37838         - Network
37839       summary: see node definition for valid relationships
37840       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
37841       consumes:
37842         - application/json
37843         - application/xml
37844       produces:
37845         - application/json
37846         - application/xml
37847       responses:
37848         "default":
37849           description: Response codes found in [response codes](https://wiki.onap.org/).
37850       parameters:
37851         - name: pnf-name
37852           in: path
37853           description: unique name of Physical Network Function.
37854           required: true
37855           type: string
37856           example: __PNF-NAME__
37857         - name: body
37858           in: body
37859           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
37860           required: true
37861           schema:
37862             $ref: "#/definitions/relationship"
37863     delete:
37864       tags:
37865         - Network
37866       summary: delete an existing relationship
37867       description: delete an existing relationship
37868       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
37869       consumes:
37870         - application/json
37871         - application/xml
37872       produces:
37873         - application/json
37874         - application/xml
37875       responses:
37876         "default":
37877           description: Response codes found in [response codes](https://wiki.onap.org/).
37878       parameters:
37879         - name: pnf-name
37880           in: path
37881           description: unique name of Physical Network Function.
37882           required: true
37883           type: string
37884           example: __PNF-NAME__
37885   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
37886     put:
37887       tags:
37888         - Network
37889       summary: see node definition for valid relationships
37890       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37891       consumes:
37892         - application/json
37893         - application/xml
37894       produces:
37895         - application/json
37896         - application/xml
37897       responses:
37898         "default":
37899           description: Response codes found in [response codes](https://wiki.onap.org/).
37900       parameters:
37901         - name: pnf-name
37902           in: path
37903           description: unique name of Physical Network Function.
37904           required: true
37905           type: string
37906           example: __PNF-NAME__
37907         - name: interface-name
37908           in: path
37909           description: Name that identifies the physical interface
37910           required: true
37911           type: string
37912           example: __INTERFACE-NAME__
37913         - name: body
37914           in: body
37915           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
37916           required: true
37917           schema:
37918             $ref: "#/definitions/relationship"
37919     delete:
37920       tags:
37921         - Network
37922       summary: delete an existing relationship
37923       description: delete an existing relationship
37924       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37925       consumes:
37926         - application/json
37927         - application/xml
37928       produces:
37929         - application/json
37930         - application/xml
37931       responses:
37932         "default":
37933           description: Response codes found in [response codes](https://wiki.onap.org/).
37934       parameters:
37935         - name: pnf-name
37936           in: path
37937           description: unique name of Physical Network Function.
37938           required: true
37939           type: string
37940           example: __PNF-NAME__
37941         - name: interface-name
37942           in: path
37943           description: Name that identifies the physical interface
37944           required: true
37945           type: string
37946           example: __INTERFACE-NAME__
37947   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
37948     put:
37949       tags:
37950         - Network
37951       summary: see node definition for valid relationships
37952       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
37953       consumes:
37954         - application/json
37955         - application/xml
37956       produces:
37957         - application/json
37958         - application/xml
37959       responses:
37960         "default":
37961           description: Response codes found in [response codes](https://wiki.onap.org/).
37962       parameters:
37963         - name: pnf-name
37964           in: path
37965           description: unique name of Physical Network Function.
37966           required: true
37967           type: string
37968           example: __PNF-NAME__
37969         - name: interface-name
37970           in: path
37971           description: Name that identifies the physical interface
37972           required: true
37973           type: string
37974           example: __INTERFACE-NAME__
37975         - name: pf-pci-id
37976           in: path
37977           description: Identifier for the sriov-pf
37978           required: true
37979           type: string
37980           example: __PF-PCI-ID__
37981         - name: body
37982           in: body
37983           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
37984           required: true
37985           schema:
37986             $ref: "#/definitions/relationship"
37987     delete:
37988       tags:
37989         - Network
37990       summary: delete an existing relationship
37991       description: delete an existing relationship
37992       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
37993       consumes:
37994         - application/json
37995         - application/xml
37996       produces:
37997         - application/json
37998         - application/xml
37999       responses:
38000         "default":
38001           description: Response codes found in [response codes](https://wiki.onap.org/).
38002       parameters:
38003         - name: pnf-name
38004           in: path
38005           description: unique name of Physical Network Function.
38006           required: true
38007           type: string
38008           example: __PNF-NAME__
38009         - name: interface-name
38010           in: path
38011           description: Name that identifies the physical interface
38012           required: true
38013           type: string
38014           example: __INTERFACE-NAME__
38015         - name: pf-pci-id
38016           in: path
38017           description: Identifier for the sriov-pf
38018           required: true
38019           type: string
38020           example: __PF-PCI-ID__
38021   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
38022     get:
38023       tags:
38024         - Network
38025       summary: returns sriov-pf
38026       description: returns sriov-pf
38027       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38028       produces:
38029         - application/json
38030         - application/xml
38031       responses:
38032         "200":
38033           description: successful operation
38034           schema:
38035               $ref: "#/getDefinitions/sriov-pf"
38036         "default":
38037           description: Response codes found in [response codes](https://wiki.onap.org/).
38038       parameters:
38039         - name: pnf-name
38040           in: path
38041           description: unique name of Physical Network Function.
38042           required: true
38043           type: string
38044           example: __PNF-NAME__
38045         - name: interface-name
38046           in: path
38047           description: Name that identifies the physical interface
38048           required: true
38049           type: string
38050           example: __INTERFACE-NAME__
38051         - name: pf-pci-id
38052           in: path
38053           description: Identifier for the sriov-pf
38054           required: true
38055           type: string
38056           example: __PF-PCI-ID__
38057     put:
38058       tags:
38059         - Network
38060       summary: create or update an existing sriov-pf
38061       description: |
38062         Create or update an existing sriov-pf.
38063         #
38064         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38065       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38066       consumes:
38067         - application/json
38068         - application/xml
38069       produces:
38070         - application/json
38071         - application/xml
38072       responses:
38073         "default":
38074           description: Response codes found in [response codes](https://wiki.onap.org/).
38075       parameters:
38076         - name: pnf-name
38077           in: path
38078           description: unique name of Physical Network Function.
38079           required: true
38080           type: string
38081           example: __PNF-NAME__
38082         - name: interface-name
38083           in: path
38084           description: Name that identifies the physical interface
38085           required: true
38086           type: string
38087           example: __INTERFACE-NAME__
38088         - name: pf-pci-id
38089           in: path
38090           description: Identifier for the sriov-pf
38091           required: true
38092           type: string
38093           example: __PF-PCI-ID__
38094         - name: body
38095           in: body
38096           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
38097           required: true
38098           schema:
38099             $ref: "#/definitions/sriov-pf"
38100     patch:
38101       tags:
38102         - Network
38103       summary: update an existing sriov-pf
38104       description: |
38105         Update an existing sriov-pf
38106         #
38107         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38108         The PUT operation will entirely replace an existing object.
38109         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38110         #
38111         Other differences between PUT and PATCH are:
38112         #
38113         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38114         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38115         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38116       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38117       consumes:
38118         - application/json
38119         - application/xml
38120       produces:
38121         - application/json
38122         - application/xml
38123       responses:
38124         "default":
38125           description: Response codes found in [response codes](https://wiki.onap.org/).
38126       parameters:
38127         - name: pnf-name
38128           in: path
38129           description: unique name of Physical Network Function.
38130           required: true
38131           type: string
38132           example: __PNF-NAME__
38133         - name: interface-name
38134           in: path
38135           description: Name that identifies the physical interface
38136           required: true
38137           type: string
38138           example: __INTERFACE-NAME__
38139         - name: pf-pci-id
38140           in: path
38141           description: Identifier for the sriov-pf
38142           required: true
38143           type: string
38144           example: __PF-PCI-ID__
38145         - name: body
38146           in: body
38147           description: sriov-pf object that needs to be updated.
38148           required: true
38149           schema:
38150             $ref: "#/patchDefinitions/sriov-pf"
38151     delete:
38152       tags:
38153         - Network
38154       summary: delete an existing sriov-pf
38155       description: delete an existing sriov-pf
38156       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38157       consumes:
38158         - application/json
38159         - application/xml
38160       produces:
38161         - application/json
38162         - application/xml
38163       responses:
38164         "default":
38165           description: Response codes found in [response codes](https://wiki.onap.org/).
38166       parameters:
38167         - name: pnf-name
38168           in: path
38169           description: unique name of Physical Network Function.
38170           required: true
38171           type: string
38172           example: __PNF-NAME__
38173         - name: interface-name
38174           in: path
38175           description: Name that identifies the physical interface
38176           required: true
38177           type: string
38178           example: __INTERFACE-NAME__
38179         - name: pf-pci-id
38180           in: path
38181           description: Identifier for the sriov-pf
38182           required: true
38183           type: string
38184           example: __PF-PCI-ID__
38185         - name: resource-version
38186           in: query
38187           description: resource-version for concurrency
38188           required: true
38189           type: string
38190   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
38191     get:
38192       tags:
38193         - Network
38194       summary: returns sriov-pfs
38195       description: returns sriov-pfs
38196       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
38197       produces:
38198         - application/json
38199         - application/xml
38200       responses:
38201         "200":
38202           description: successful operation
38203           schema:
38204               $ref: "#/getDefinitions/sriov-pfs"
38205         "default":
38206           description: Response codes found in [response codes](https://wiki.onap.org/).
38207       parameters:
38208         - name: pnf-name
38209           in: path
38210           description: unique name of Physical Network Function.
38211           required: true
38212           type: string
38213           example: __PNF-NAME__
38214         - name: interface-name
38215           in: path
38216           description: Name that identifies the physical interface
38217           required: true
38218           type: string
38219           example: __INTERFACE-NAME__
38220         - name: pf-pci-id
38221           in: query
38222           description:
38223           required: false
38224           type: string
38225   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
38226     put:
38227       tags:
38228         - Network
38229       summary: see node definition for valid relationships
38230       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38231       consumes:
38232         - application/json
38233         - application/xml
38234       produces:
38235         - application/json
38236         - application/xml
38237       responses:
38238         "default":
38239           description: Response codes found in [response codes](https://wiki.onap.org/).
38240       parameters:
38241         - name: pnf-name
38242           in: path
38243           description: unique name of Physical Network Function.
38244           required: true
38245           type: string
38246           example: __PNF-NAME__
38247         - name: interface-name
38248           in: path
38249           description: Name that identifies the physical interface
38250           required: true
38251           type: string
38252           example: __INTERFACE-NAME__
38253         - name: interface-name
38254           in: path
38255           description: Name given to the interface
38256           required: true
38257           type: string
38258           example: __INTERFACE-NAME__
38259         - name: vlan-interface
38260           in: path
38261           description: String that identifies the interface
38262           required: true
38263           type: string
38264           example: __VLAN-INTERFACE__
38265         - name: body
38266           in: body
38267           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
38268           required: true
38269           schema:
38270             $ref: "#/definitions/relationship"
38271     delete:
38272       tags:
38273         - Network
38274       summary: delete an existing relationship
38275       description: delete an existing relationship
38276       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38277       consumes:
38278         - application/json
38279         - application/xml
38280       produces:
38281         - application/json
38282         - application/xml
38283       responses:
38284         "default":
38285           description: Response codes found in [response codes](https://wiki.onap.org/).
38286       parameters:
38287         - name: pnf-name
38288           in: path
38289           description: unique name of Physical Network Function.
38290           required: true
38291           type: string
38292           example: __PNF-NAME__
38293         - name: interface-name
38294           in: path
38295           description: Name that identifies the physical interface
38296           required: true
38297           type: string
38298           example: __INTERFACE-NAME__
38299         - name: interface-name
38300           in: path
38301           description: Name given to the interface
38302           required: true
38303           type: string
38304           example: __INTERFACE-NAME__
38305         - name: vlan-interface
38306           in: path
38307           description: String that identifies the interface
38308           required: true
38309           type: string
38310           example: __VLAN-INTERFACE__
38311   /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:
38312     put:
38313       tags:
38314         - Network
38315       summary: see node definition for valid relationships
38316       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38317       consumes:
38318         - application/json
38319         - application/xml
38320       produces:
38321         - application/json
38322         - application/xml
38323       responses:
38324         "default":
38325           description: Response codes found in [response codes](https://wiki.onap.org/).
38326       parameters:
38327         - name: pnf-name
38328           in: path
38329           description: unique name of Physical Network Function.
38330           required: true
38331           type: string
38332           example: __PNF-NAME__
38333         - name: interface-name
38334           in: path
38335           description: Name that identifies the physical interface
38336           required: true
38337           type: string
38338           example: __INTERFACE-NAME__
38339         - name: interface-name
38340           in: path
38341           description: Name given to the interface
38342           required: true
38343           type: string
38344           example: __INTERFACE-NAME__
38345         - name: vlan-interface
38346           in: path
38347           description: String that identifies the interface
38348           required: true
38349           type: string
38350           example: __VLAN-INTERFACE__
38351         - name: l3-interface-ipv4-address
38352           in: path
38353           description: IP address
38354           required: true
38355           type: string
38356           example: __L3-INTERFACE-IPV4-ADDRESS__
38357         - name: body
38358           in: body
38359           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38360           required: true
38361           schema:
38362             $ref: "#/definitions/relationship"
38363     delete:
38364       tags:
38365         - Network
38366       summary: delete an existing relationship
38367       description: delete an existing relationship
38368       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38369       consumes:
38370         - application/json
38371         - application/xml
38372       produces:
38373         - application/json
38374         - application/xml
38375       responses:
38376         "default":
38377           description: Response codes found in [response codes](https://wiki.onap.org/).
38378       parameters:
38379         - name: pnf-name
38380           in: path
38381           description: unique name of Physical Network Function.
38382           required: true
38383           type: string
38384           example: __PNF-NAME__
38385         - name: interface-name
38386           in: path
38387           description: Name that identifies the physical interface
38388           required: true
38389           type: string
38390           example: __INTERFACE-NAME__
38391         - name: interface-name
38392           in: path
38393           description: Name given to the interface
38394           required: true
38395           type: string
38396           example: __INTERFACE-NAME__
38397         - name: vlan-interface
38398           in: path
38399           description: String that identifies the interface
38400           required: true
38401           type: string
38402           example: __VLAN-INTERFACE__
38403         - name: l3-interface-ipv4-address
38404           in: path
38405           description: IP address
38406           required: true
38407           type: string
38408           example: __L3-INTERFACE-IPV4-ADDRESS__
38409   /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}:
38410     get:
38411       tags:
38412         - Network
38413       summary: returns l3-interface-ipv4-address-list
38414       description: returns l3-interface-ipv4-address-list
38415       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38416       produces:
38417         - application/json
38418         - application/xml
38419       responses:
38420         "200":
38421           description: successful operation
38422           schema:
38423               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38424         "default":
38425           description: Response codes found in [response codes](https://wiki.onap.org/).
38426       parameters:
38427         - name: pnf-name
38428           in: path
38429           description: unique name of Physical Network Function.
38430           required: true
38431           type: string
38432           example: __PNF-NAME__
38433         - name: interface-name
38434           in: path
38435           description: Name that identifies the physical interface
38436           required: true
38437           type: string
38438           example: __INTERFACE-NAME__
38439         - name: interface-name
38440           in: path
38441           description: Name given to the interface
38442           required: true
38443           type: string
38444           example: __INTERFACE-NAME__
38445         - name: vlan-interface
38446           in: path
38447           description: String that identifies the interface
38448           required: true
38449           type: string
38450           example: __VLAN-INTERFACE__
38451         - name: l3-interface-ipv4-address
38452           in: path
38453           description: IP address
38454           required: true
38455           type: string
38456           example: __L3-INTERFACE-IPV4-ADDRESS__
38457     put:
38458       tags:
38459         - Network
38460       summary: create or update an existing l3-interface-ipv4-address-list
38461       description: |
38462         Create or update an existing l3-interface-ipv4-address-list.
38463         #
38464         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38465       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38466       consumes:
38467         - application/json
38468         - application/xml
38469       produces:
38470         - application/json
38471         - application/xml
38472       responses:
38473         "default":
38474           description: Response codes found in [response codes](https://wiki.onap.org/).
38475       parameters:
38476         - name: pnf-name
38477           in: path
38478           description: unique name of Physical Network Function.
38479           required: true
38480           type: string
38481           example: __PNF-NAME__
38482         - name: interface-name
38483           in: path
38484           description: Name that identifies the physical interface
38485           required: true
38486           type: string
38487           example: __INTERFACE-NAME__
38488         - name: interface-name
38489           in: path
38490           description: Name given to the interface
38491           required: true
38492           type: string
38493           example: __INTERFACE-NAME__
38494         - name: vlan-interface
38495           in: path
38496           description: String that identifies the interface
38497           required: true
38498           type: string
38499           example: __VLAN-INTERFACE__
38500         - name: l3-interface-ipv4-address
38501           in: path
38502           description: IP address
38503           required: true
38504           type: string
38505           example: __L3-INTERFACE-IPV4-ADDRESS__
38506         - name: body
38507           in: body
38508           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38509           required: true
38510           schema:
38511             $ref: "#/definitions/l3-interface-ipv4-address-list"
38512     patch:
38513       tags:
38514         - Network
38515       summary: update an existing l3-interface-ipv4-address-list
38516       description: |
38517         Update an existing l3-interface-ipv4-address-list
38518         #
38519         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38520         The PUT operation will entirely replace an existing object.
38521         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38522         #
38523         Other differences between PUT and PATCH are:
38524         #
38525         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38526         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38527         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38528       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38529       consumes:
38530         - application/json
38531         - application/xml
38532       produces:
38533         - application/json
38534         - application/xml
38535       responses:
38536         "default":
38537           description: Response codes found in [response codes](https://wiki.onap.org/).
38538       parameters:
38539         - name: pnf-name
38540           in: path
38541           description: unique name of Physical Network Function.
38542           required: true
38543           type: string
38544           example: __PNF-NAME__
38545         - name: interface-name
38546           in: path
38547           description: Name that identifies the physical interface
38548           required: true
38549           type: string
38550           example: __INTERFACE-NAME__
38551         - name: interface-name
38552           in: path
38553           description: Name given to the interface
38554           required: true
38555           type: string
38556           example: __INTERFACE-NAME__
38557         - name: vlan-interface
38558           in: path
38559           description: String that identifies the interface
38560           required: true
38561           type: string
38562           example: __VLAN-INTERFACE__
38563         - name: l3-interface-ipv4-address
38564           in: path
38565           description: IP address
38566           required: true
38567           type: string
38568           example: __L3-INTERFACE-IPV4-ADDRESS__
38569         - name: body
38570           in: body
38571           description: l3-interface-ipv4-address-list object that needs to be updated.
38572           required: true
38573           schema:
38574             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38575     delete:
38576       tags:
38577         - Network
38578       summary: delete an existing l3-interface-ipv4-address-list
38579       description: delete an existing l3-interface-ipv4-address-list
38580       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38581       consumes:
38582         - application/json
38583         - application/xml
38584       produces:
38585         - application/json
38586         - application/xml
38587       responses:
38588         "default":
38589           description: Response codes found in [response codes](https://wiki.onap.org/).
38590       parameters:
38591         - name: pnf-name
38592           in: path
38593           description: unique name of Physical Network Function.
38594           required: true
38595           type: string
38596           example: __PNF-NAME__
38597         - name: interface-name
38598           in: path
38599           description: Name that identifies the physical interface
38600           required: true
38601           type: string
38602           example: __INTERFACE-NAME__
38603         - name: interface-name
38604           in: path
38605           description: Name given to the interface
38606           required: true
38607           type: string
38608           example: __INTERFACE-NAME__
38609         - name: vlan-interface
38610           in: path
38611           description: String that identifies the interface
38612           required: true
38613           type: string
38614           example: __VLAN-INTERFACE__
38615         - name: l3-interface-ipv4-address
38616           in: path
38617           description: IP address
38618           required: true
38619           type: string
38620           example: __L3-INTERFACE-IPV4-ADDRESS__
38621         - name: resource-version
38622           in: query
38623           description: resource-version for concurrency
38624           required: true
38625           type: string
38626   /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:
38627     put:
38628       tags:
38629         - Network
38630       summary: see node definition for valid relationships
38631       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38632       consumes:
38633         - application/json
38634         - application/xml
38635       produces:
38636         - application/json
38637         - application/xml
38638       responses:
38639         "default":
38640           description: Response codes found in [response codes](https://wiki.onap.org/).
38641       parameters:
38642         - name: pnf-name
38643           in: path
38644           description: unique name of Physical Network Function.
38645           required: true
38646           type: string
38647           example: __PNF-NAME__
38648         - name: interface-name
38649           in: path
38650           description: Name that identifies the physical interface
38651           required: true
38652           type: string
38653           example: __INTERFACE-NAME__
38654         - name: interface-name
38655           in: path
38656           description: Name given to the interface
38657           required: true
38658           type: string
38659           example: __INTERFACE-NAME__
38660         - name: vlan-interface
38661           in: path
38662           description: String that identifies the interface
38663           required: true
38664           type: string
38665           example: __VLAN-INTERFACE__
38666         - name: l3-interface-ipv6-address
38667           in: path
38668           description: IP address
38669           required: true
38670           type: string
38671           example: __L3-INTERFACE-IPV6-ADDRESS__
38672         - name: body
38673           in: body
38674           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38675           required: true
38676           schema:
38677             $ref: "#/definitions/relationship"
38678     delete:
38679       tags:
38680         - Network
38681       summary: delete an existing relationship
38682       description: delete an existing relationship
38683       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38684       consumes:
38685         - application/json
38686         - application/xml
38687       produces:
38688         - application/json
38689         - application/xml
38690       responses:
38691         "default":
38692           description: Response codes found in [response codes](https://wiki.onap.org/).
38693       parameters:
38694         - name: pnf-name
38695           in: path
38696           description: unique name of Physical Network Function.
38697           required: true
38698           type: string
38699           example: __PNF-NAME__
38700         - name: interface-name
38701           in: path
38702           description: Name that identifies the physical interface
38703           required: true
38704           type: string
38705           example: __INTERFACE-NAME__
38706         - name: interface-name
38707           in: path
38708           description: Name given to the interface
38709           required: true
38710           type: string
38711           example: __INTERFACE-NAME__
38712         - name: vlan-interface
38713           in: path
38714           description: String that identifies the interface
38715           required: true
38716           type: string
38717           example: __VLAN-INTERFACE__
38718         - name: l3-interface-ipv6-address
38719           in: path
38720           description: IP address
38721           required: true
38722           type: string
38723           example: __L3-INTERFACE-IPV6-ADDRESS__
38724   /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}:
38725     get:
38726       tags:
38727         - Network
38728       summary: returns l3-interface-ipv6-address-list
38729       description: returns l3-interface-ipv6-address-list
38730       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38731       produces:
38732         - application/json
38733         - application/xml
38734       responses:
38735         "200":
38736           description: successful operation
38737           schema:
38738               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38739         "default":
38740           description: Response codes found in [response codes](https://wiki.onap.org/).
38741       parameters:
38742         - name: pnf-name
38743           in: path
38744           description: unique name of Physical Network Function.
38745           required: true
38746           type: string
38747           example: __PNF-NAME__
38748         - name: interface-name
38749           in: path
38750           description: Name that identifies the physical interface
38751           required: true
38752           type: string
38753           example: __INTERFACE-NAME__
38754         - name: interface-name
38755           in: path
38756           description: Name given to the interface
38757           required: true
38758           type: string
38759           example: __INTERFACE-NAME__
38760         - name: vlan-interface
38761           in: path
38762           description: String that identifies the interface
38763           required: true
38764           type: string
38765           example: __VLAN-INTERFACE__
38766         - name: l3-interface-ipv6-address
38767           in: path
38768           description: IP address
38769           required: true
38770           type: string
38771           example: __L3-INTERFACE-IPV6-ADDRESS__
38772     put:
38773       tags:
38774         - Network
38775       summary: create or update an existing l3-interface-ipv6-address-list
38776       description: |
38777         Create or update an existing l3-interface-ipv6-address-list.
38778         #
38779         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38780       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38781       consumes:
38782         - application/json
38783         - application/xml
38784       produces:
38785         - application/json
38786         - application/xml
38787       responses:
38788         "default":
38789           description: Response codes found in [response codes](https://wiki.onap.org/).
38790       parameters:
38791         - name: pnf-name
38792           in: path
38793           description: unique name of Physical Network Function.
38794           required: true
38795           type: string
38796           example: __PNF-NAME__
38797         - name: interface-name
38798           in: path
38799           description: Name that identifies the physical interface
38800           required: true
38801           type: string
38802           example: __INTERFACE-NAME__
38803         - name: interface-name
38804           in: path
38805           description: Name given to the interface
38806           required: true
38807           type: string
38808           example: __INTERFACE-NAME__
38809         - name: vlan-interface
38810           in: path
38811           description: String that identifies the interface
38812           required: true
38813           type: string
38814           example: __VLAN-INTERFACE__
38815         - name: l3-interface-ipv6-address
38816           in: path
38817           description: IP address
38818           required: true
38819           type: string
38820           example: __L3-INTERFACE-IPV6-ADDRESS__
38821         - name: body
38822           in: body
38823           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38824           required: true
38825           schema:
38826             $ref: "#/definitions/l3-interface-ipv6-address-list"
38827     patch:
38828       tags:
38829         - Network
38830       summary: update an existing l3-interface-ipv6-address-list
38831       description: |
38832         Update an existing l3-interface-ipv6-address-list
38833         #
38834         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38835         The PUT operation will entirely replace an existing object.
38836         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38837         #
38838         Other differences between PUT and PATCH are:
38839         #
38840         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38841         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38842         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38843       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38844       consumes:
38845         - application/json
38846         - application/xml
38847       produces:
38848         - application/json
38849         - application/xml
38850       responses:
38851         "default":
38852           description: Response codes found in [response codes](https://wiki.onap.org/).
38853       parameters:
38854         - name: pnf-name
38855           in: path
38856           description: unique name of Physical Network Function.
38857           required: true
38858           type: string
38859           example: __PNF-NAME__
38860         - name: interface-name
38861           in: path
38862           description: Name that identifies the physical interface
38863           required: true
38864           type: string
38865           example: __INTERFACE-NAME__
38866         - name: interface-name
38867           in: path
38868           description: Name given to the interface
38869           required: true
38870           type: string
38871           example: __INTERFACE-NAME__
38872         - name: vlan-interface
38873           in: path
38874           description: String that identifies the interface
38875           required: true
38876           type: string
38877           example: __VLAN-INTERFACE__
38878         - name: l3-interface-ipv6-address
38879           in: path
38880           description: IP address
38881           required: true
38882           type: string
38883           example: __L3-INTERFACE-IPV6-ADDRESS__
38884         - name: body
38885           in: body
38886           description: l3-interface-ipv6-address-list object that needs to be updated.
38887           required: true
38888           schema:
38889             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38890     delete:
38891       tags:
38892         - Network
38893       summary: delete an existing l3-interface-ipv6-address-list
38894       description: delete an existing l3-interface-ipv6-address-list
38895       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38896       consumes:
38897         - application/json
38898         - application/xml
38899       produces:
38900         - application/json
38901         - application/xml
38902       responses:
38903         "default":
38904           description: Response codes found in [response codes](https://wiki.onap.org/).
38905       parameters:
38906         - name: pnf-name
38907           in: path
38908           description: unique name of Physical Network Function.
38909           required: true
38910           type: string
38911           example: __PNF-NAME__
38912         - name: interface-name
38913           in: path
38914           description: Name that identifies the physical interface
38915           required: true
38916           type: string
38917           example: __INTERFACE-NAME__
38918         - name: interface-name
38919           in: path
38920           description: Name given to the interface
38921           required: true
38922           type: string
38923           example: __INTERFACE-NAME__
38924         - name: vlan-interface
38925           in: path
38926           description: String that identifies the interface
38927           required: true
38928           type: string
38929           example: __VLAN-INTERFACE__
38930         - name: l3-interface-ipv6-address
38931           in: path
38932           description: IP address
38933           required: true
38934           type: string
38935           example: __L3-INTERFACE-IPV6-ADDRESS__
38936         - name: resource-version
38937           in: query
38938           description: resource-version for concurrency
38939           required: true
38940           type: string
38941   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38942     get:
38943       tags:
38944         - Network
38945       summary: returns vlan
38946       description: returns vlan
38947       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38948       produces:
38949         - application/json
38950         - application/xml
38951       responses:
38952         "200":
38953           description: successful operation
38954           schema:
38955               $ref: "#/getDefinitions/vlan"
38956         "default":
38957           description: Response codes found in [response codes](https://wiki.onap.org/).
38958       parameters:
38959         - name: pnf-name
38960           in: path
38961           description: unique name of Physical Network Function.
38962           required: true
38963           type: string
38964           example: __PNF-NAME__
38965         - name: interface-name
38966           in: path
38967           description: Name that identifies the physical interface
38968           required: true
38969           type: string
38970           example: __INTERFACE-NAME__
38971         - name: interface-name
38972           in: path
38973           description: Name given to the interface
38974           required: true
38975           type: string
38976           example: __INTERFACE-NAME__
38977         - name: vlan-interface
38978           in: path
38979           description: String that identifies the interface
38980           required: true
38981           type: string
38982           example: __VLAN-INTERFACE__
38983     put:
38984       tags:
38985         - Network
38986       summary: create or update an existing vlan
38987       description: |
38988         Create or update an existing vlan.
38989         #
38990         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38991       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38992       consumes:
38993         - application/json
38994         - application/xml
38995       produces:
38996         - application/json
38997         - application/xml
38998       responses:
38999         "default":
39000           description: Response codes found in [response codes](https://wiki.onap.org/).
39001       parameters:
39002         - name: pnf-name
39003           in: path
39004           description: unique name of Physical Network Function.
39005           required: true
39006           type: string
39007           example: __PNF-NAME__
39008         - name: interface-name
39009           in: path
39010           description: Name that identifies the physical interface
39011           required: true
39012           type: string
39013           example: __INTERFACE-NAME__
39014         - name: interface-name
39015           in: path
39016           description: Name given to the interface
39017           required: true
39018           type: string
39019           example: __INTERFACE-NAME__
39020         - name: vlan-interface
39021           in: path
39022           description: String that identifies the interface
39023           required: true
39024           type: string
39025           example: __VLAN-INTERFACE__
39026         - name: body
39027           in: body
39028           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39029           required: true
39030           schema:
39031             $ref: "#/definitions/vlan"
39032     patch:
39033       tags:
39034         - Network
39035       summary: update an existing vlan
39036       description: |
39037         Update an existing vlan
39038         #
39039         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39040         The PUT operation will entirely replace an existing object.
39041         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39042         #
39043         Other differences between PUT and PATCH are:
39044         #
39045         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39046         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39047         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39048       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
39049       consumes:
39050         - application/json
39051         - application/xml
39052       produces:
39053         - application/json
39054         - application/xml
39055       responses:
39056         "default":
39057           description: Response codes found in [response codes](https://wiki.onap.org/).
39058       parameters:
39059         - name: pnf-name
39060           in: path
39061           description: unique name of Physical Network Function.
39062           required: true
39063           type: string
39064           example: __PNF-NAME__
39065         - name: interface-name
39066           in: path
39067           description: Name that identifies the physical interface
39068           required: true
39069           type: string
39070           example: __INTERFACE-NAME__
39071         - name: interface-name
39072           in: path
39073           description: Name given to the interface
39074           required: true
39075           type: string
39076           example: __INTERFACE-NAME__
39077         - name: vlan-interface
39078           in: path
39079           description: String that identifies the interface
39080           required: true
39081           type: string
39082           example: __VLAN-INTERFACE__
39083         - name: body
39084           in: body
39085           description: vlan object that needs to be updated.
39086           required: true
39087           schema:
39088             $ref: "#/patchDefinitions/vlan"
39089     delete:
39090       tags:
39091         - Network
39092       summary: delete an existing vlan
39093       description: delete an existing vlan
39094       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
39095       consumes:
39096         - application/json
39097         - application/xml
39098       produces:
39099         - application/json
39100         - application/xml
39101       responses:
39102         "default":
39103           description: Response codes found in [response codes](https://wiki.onap.org/).
39104       parameters:
39105         - name: pnf-name
39106           in: path
39107           description: unique name of Physical Network Function.
39108           required: true
39109           type: string
39110           example: __PNF-NAME__
39111         - name: interface-name
39112           in: path
39113           description: Name that identifies the physical interface
39114           required: true
39115           type: string
39116           example: __INTERFACE-NAME__
39117         - name: interface-name
39118           in: path
39119           description: Name given to the interface
39120           required: true
39121           type: string
39122           example: __INTERFACE-NAME__
39123         - name: vlan-interface
39124           in: path
39125           description: String that identifies the interface
39126           required: true
39127           type: string
39128           example: __VLAN-INTERFACE__
39129         - name: resource-version
39130           in: query
39131           description: resource-version for concurrency
39132           required: true
39133           type: string
39134   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
39135     get:
39136       tags:
39137         - Network
39138       summary: returns vlans
39139       description: returns vlans
39140       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
39141       produces:
39142         - application/json
39143         - application/xml
39144       responses:
39145         "200":
39146           description: successful operation
39147           schema:
39148               $ref: "#/getDefinitions/vlans"
39149         "default":
39150           description: Response codes found in [response codes](https://wiki.onap.org/).
39151       parameters:
39152         - name: pnf-name
39153           in: path
39154           description: unique name of Physical Network Function.
39155           required: true
39156           type: string
39157           example: __PNF-NAME__
39158         - name: interface-name
39159           in: path
39160           description: Name that identifies the physical interface
39161           required: true
39162           type: string
39163           example: __INTERFACE-NAME__
39164         - name: interface-name
39165           in: path
39166           description: Name given to the interface
39167           required: true
39168           type: string
39169           example: __INTERFACE-NAME__
39170         - name: vlan-interface
39171           in: query
39172           description:
39173           required: false
39174           type: string
39175         - name: vlan-id-inner
39176           in: query
39177           description:
39178           required: false
39179           type: integer
39180           format: int64
39181         - name: vpn-key
39182           in: query
39183           description:
39184           required: false
39185           type: string
39186   /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:
39187     put:
39188       tags:
39189         - Network
39190       summary: see node definition for valid relationships
39191       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39192       consumes:
39193         - application/json
39194         - application/xml
39195       produces:
39196         - application/json
39197         - application/xml
39198       responses:
39199         "default":
39200           description: Response codes found in [response codes](https://wiki.onap.org/).
39201       parameters:
39202         - name: pnf-name
39203           in: path
39204           description: unique name of Physical Network Function.
39205           required: true
39206           type: string
39207           example: __PNF-NAME__
39208         - name: interface-name
39209           in: path
39210           description: Name that identifies the physical interface
39211           required: true
39212           type: string
39213           example: __INTERFACE-NAME__
39214         - name: interface-name
39215           in: path
39216           description: Name given to the interface
39217           required: true
39218           type: string
39219           example: __INTERFACE-NAME__
39220         - name: pci-id
39221           in: path
39222           description: PCI ID used to identify the sriov-vf
39223           required: true
39224           type: string
39225           example: __PCI-ID__
39226         - name: body
39227           in: body
39228           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39229           required: true
39230           schema:
39231             $ref: "#/definitions/relationship"
39232     delete:
39233       tags:
39234         - Network
39235       summary: delete an existing relationship
39236       description: delete an existing relationship
39237       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39238       consumes:
39239         - application/json
39240         - application/xml
39241       produces:
39242         - application/json
39243         - application/xml
39244       responses:
39245         "default":
39246           description: Response codes found in [response codes](https://wiki.onap.org/).
39247       parameters:
39248         - name: pnf-name
39249           in: path
39250           description: unique name of Physical Network Function.
39251           required: true
39252           type: string
39253           example: __PNF-NAME__
39254         - name: interface-name
39255           in: path
39256           description: Name that identifies the physical interface
39257           required: true
39258           type: string
39259           example: __INTERFACE-NAME__
39260         - name: interface-name
39261           in: path
39262           description: Name given to the interface
39263           required: true
39264           type: string
39265           example: __INTERFACE-NAME__
39266         - name: pci-id
39267           in: path
39268           description: PCI ID used to identify the sriov-vf
39269           required: true
39270           type: string
39271           example: __PCI-ID__
39272   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
39273     get:
39274       tags:
39275         - Network
39276       summary: returns sriov-vf
39277       description: returns sriov-vf
39278       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39279       produces:
39280         - application/json
39281         - application/xml
39282       responses:
39283         "200":
39284           description: successful operation
39285           schema:
39286               $ref: "#/getDefinitions/sriov-vf"
39287         "default":
39288           description: Response codes found in [response codes](https://wiki.onap.org/).
39289       parameters:
39290         - name: pnf-name
39291           in: path
39292           description: unique name of Physical Network Function.
39293           required: true
39294           type: string
39295           example: __PNF-NAME__
39296         - name: interface-name
39297           in: path
39298           description: Name that identifies the physical interface
39299           required: true
39300           type: string
39301           example: __INTERFACE-NAME__
39302         - name: interface-name
39303           in: path
39304           description: Name given to the interface
39305           required: true
39306           type: string
39307           example: __INTERFACE-NAME__
39308         - name: pci-id
39309           in: path
39310           description: PCI ID used to identify the sriov-vf
39311           required: true
39312           type: string
39313           example: __PCI-ID__
39314     put:
39315       tags:
39316         - Network
39317       summary: create or update an existing sriov-vf
39318       description: |
39319         Create or update an existing sriov-vf.
39320         #
39321         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39322       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39323       consumes:
39324         - application/json
39325         - application/xml
39326       produces:
39327         - application/json
39328         - application/xml
39329       responses:
39330         "default":
39331           description: Response codes found in [response codes](https://wiki.onap.org/).
39332       parameters:
39333         - name: pnf-name
39334           in: path
39335           description: unique name of Physical Network Function.
39336           required: true
39337           type: string
39338           example: __PNF-NAME__
39339         - name: interface-name
39340           in: path
39341           description: Name that identifies the physical interface
39342           required: true
39343           type: string
39344           example: __INTERFACE-NAME__
39345         - name: interface-name
39346           in: path
39347           description: Name given to the interface
39348           required: true
39349           type: string
39350           example: __INTERFACE-NAME__
39351         - name: pci-id
39352           in: path
39353           description: PCI ID used to identify the sriov-vf
39354           required: true
39355           type: string
39356           example: __PCI-ID__
39357         - name: body
39358           in: body
39359           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39360           required: true
39361           schema:
39362             $ref: "#/definitions/sriov-vf"
39363     patch:
39364       tags:
39365         - Network
39366       summary: update an existing sriov-vf
39367       description: |
39368         Update an existing sriov-vf
39369         #
39370         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39371         The PUT operation will entirely replace an existing object.
39372         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39373         #
39374         Other differences between PUT and PATCH are:
39375         #
39376         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39377         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39378         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39379       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39380       consumes:
39381         - application/json
39382         - application/xml
39383       produces:
39384         - application/json
39385         - application/xml
39386       responses:
39387         "default":
39388           description: Response codes found in [response codes](https://wiki.onap.org/).
39389       parameters:
39390         - name: pnf-name
39391           in: path
39392           description: unique name of Physical Network Function.
39393           required: true
39394           type: string
39395           example: __PNF-NAME__
39396         - name: interface-name
39397           in: path
39398           description: Name that identifies the physical interface
39399           required: true
39400           type: string
39401           example: __INTERFACE-NAME__
39402         - name: interface-name
39403           in: path
39404           description: Name given to the interface
39405           required: true
39406           type: string
39407           example: __INTERFACE-NAME__
39408         - name: pci-id
39409           in: path
39410           description: PCI ID used to identify the sriov-vf
39411           required: true
39412           type: string
39413           example: __PCI-ID__
39414         - name: body
39415           in: body
39416           description: sriov-vf object that needs to be updated.
39417           required: true
39418           schema:
39419             $ref: "#/patchDefinitions/sriov-vf"
39420     delete:
39421       tags:
39422         - Network
39423       summary: delete an existing sriov-vf
39424       description: delete an existing sriov-vf
39425       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39426       consumes:
39427         - application/json
39428         - application/xml
39429       produces:
39430         - application/json
39431         - application/xml
39432       responses:
39433         "default":
39434           description: Response codes found in [response codes](https://wiki.onap.org/).
39435       parameters:
39436         - name: pnf-name
39437           in: path
39438           description: unique name of Physical Network Function.
39439           required: true
39440           type: string
39441           example: __PNF-NAME__
39442         - name: interface-name
39443           in: path
39444           description: Name that identifies the physical interface
39445           required: true
39446           type: string
39447           example: __INTERFACE-NAME__
39448         - name: interface-name
39449           in: path
39450           description: Name given to the interface
39451           required: true
39452           type: string
39453           example: __INTERFACE-NAME__
39454         - name: pci-id
39455           in: path
39456           description: PCI ID used to identify the sriov-vf
39457           required: true
39458           type: string
39459           example: __PCI-ID__
39460         - name: resource-version
39461           in: query
39462           description: resource-version for concurrency
39463           required: true
39464           type: string
39465   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
39466     get:
39467       tags:
39468         - Network
39469       summary: returns sriov-vfs
39470       description: returns sriov-vfs
39471       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
39472       produces:
39473         - application/json
39474         - application/xml
39475       responses:
39476         "200":
39477           description: successful operation
39478           schema:
39479               $ref: "#/getDefinitions/sriov-vfs"
39480         "default":
39481           description: Response codes found in [response codes](https://wiki.onap.org/).
39482       parameters:
39483         - name: pnf-name
39484           in: path
39485           description: unique name of Physical Network Function.
39486           required: true
39487           type: string
39488           example: __PNF-NAME__
39489         - name: interface-name
39490           in: path
39491           description: Name that identifies the physical interface
39492           required: true
39493           type: string
39494           example: __INTERFACE-NAME__
39495         - name: interface-name
39496           in: path
39497           description: Name given to the interface
39498           required: true
39499           type: string
39500           example: __INTERFACE-NAME__
39501         - name: pci-id
39502           in: query
39503           description:
39504           required: false
39505           type: string
39506         - name: vf-vlan-filter
39507           in: query
39508           description:
39509           required: false
39510           type: string
39511         - name: vf-mac-filter
39512           in: query
39513           description:
39514           required: false
39515           type: string
39516         - name: vf-vlan-strip
39517           in: query
39518           description:
39519           required: false
39520           type: boolean
39521         - name: neutron-network-id
39522           in: query
39523           description:
39524           required: false
39525           type: string
39526   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39527     put:
39528       tags:
39529         - Network
39530       summary: see node definition for valid relationships
39531       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39532       consumes:
39533         - application/json
39534         - application/xml
39535       produces:
39536         - application/json
39537         - application/xml
39538       responses:
39539         "default":
39540           description: Response codes found in [response codes](https://wiki.onap.org/).
39541       parameters:
39542         - name: pnf-name
39543           in: path
39544           description: unique name of Physical Network Function.
39545           required: true
39546           type: string
39547           example: __PNF-NAME__
39548         - name: interface-name
39549           in: path
39550           description: Name that identifies the physical interface
39551           required: true
39552           type: string
39553           example: __INTERFACE-NAME__
39554         - name: interface-name
39555           in: path
39556           description: Name given to the interface
39557           required: true
39558           type: string
39559           example: __INTERFACE-NAME__
39560         - name: body
39561           in: body
39562           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39563           required: true
39564           schema:
39565             $ref: "#/definitions/relationship"
39566     delete:
39567       tags:
39568         - Network
39569       summary: delete an existing relationship
39570       description: delete an existing relationship
39571       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39572       consumes:
39573         - application/json
39574         - application/xml
39575       produces:
39576         - application/json
39577         - application/xml
39578       responses:
39579         "default":
39580           description: Response codes found in [response codes](https://wiki.onap.org/).
39581       parameters:
39582         - name: pnf-name
39583           in: path
39584           description: unique name of Physical Network Function.
39585           required: true
39586           type: string
39587           example: __PNF-NAME__
39588         - name: interface-name
39589           in: path
39590           description: Name that identifies the physical interface
39591           required: true
39592           type: string
39593           example: __INTERFACE-NAME__
39594         - name: interface-name
39595           in: path
39596           description: Name given to the interface
39597           required: true
39598           type: string
39599           example: __INTERFACE-NAME__
39600   /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:
39601     put:
39602       tags:
39603         - Network
39604       summary: see node definition for valid relationships
39605       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39606       consumes:
39607         - application/json
39608         - application/xml
39609       produces:
39610         - application/json
39611         - application/xml
39612       responses:
39613         "default":
39614           description: Response codes found in [response codes](https://wiki.onap.org/).
39615       parameters:
39616         - name: pnf-name
39617           in: path
39618           description: unique name of Physical Network Function.
39619           required: true
39620           type: string
39621           example: __PNF-NAME__
39622         - name: interface-name
39623           in: path
39624           description: Name that identifies the physical interface
39625           required: true
39626           type: string
39627           example: __INTERFACE-NAME__
39628         - name: interface-name
39629           in: path
39630           description: Name given to the interface
39631           required: true
39632           type: string
39633           example: __INTERFACE-NAME__
39634         - name: l3-interface-ipv4-address
39635           in: path
39636           description: IP address
39637           required: true
39638           type: string
39639           example: __L3-INTERFACE-IPV4-ADDRESS__
39640         - name: body
39641           in: body
39642           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39643           required: true
39644           schema:
39645             $ref: "#/definitions/relationship"
39646     delete:
39647       tags:
39648         - Network
39649       summary: delete an existing relationship
39650       description: delete an existing relationship
39651       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39652       consumes:
39653         - application/json
39654         - application/xml
39655       produces:
39656         - application/json
39657         - application/xml
39658       responses:
39659         "default":
39660           description: Response codes found in [response codes](https://wiki.onap.org/).
39661       parameters:
39662         - name: pnf-name
39663           in: path
39664           description: unique name of Physical Network Function.
39665           required: true
39666           type: string
39667           example: __PNF-NAME__
39668         - name: interface-name
39669           in: path
39670           description: Name that identifies the physical interface
39671           required: true
39672           type: string
39673           example: __INTERFACE-NAME__
39674         - name: interface-name
39675           in: path
39676           description: Name given to the interface
39677           required: true
39678           type: string
39679           example: __INTERFACE-NAME__
39680         - name: l3-interface-ipv4-address
39681           in: path
39682           description: IP address
39683           required: true
39684           type: string
39685           example: __L3-INTERFACE-IPV4-ADDRESS__
39686   /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}:
39687     get:
39688       tags:
39689         - Network
39690       summary: returns l3-interface-ipv4-address-list
39691       description: returns l3-interface-ipv4-address-list
39692       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39693       produces:
39694         - application/json
39695         - application/xml
39696       responses:
39697         "200":
39698           description: successful operation
39699           schema:
39700               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39701         "default":
39702           description: Response codes found in [response codes](https://wiki.onap.org/).
39703       parameters:
39704         - name: pnf-name
39705           in: path
39706           description: unique name of Physical Network Function.
39707           required: true
39708           type: string
39709           example: __PNF-NAME__
39710         - name: interface-name
39711           in: path
39712           description: Name that identifies the physical interface
39713           required: true
39714           type: string
39715           example: __INTERFACE-NAME__
39716         - name: interface-name
39717           in: path
39718           description: Name given to the interface
39719           required: true
39720           type: string
39721           example: __INTERFACE-NAME__
39722         - name: l3-interface-ipv4-address
39723           in: path
39724           description: IP address
39725           required: true
39726           type: string
39727           example: __L3-INTERFACE-IPV4-ADDRESS__
39728     put:
39729       tags:
39730         - Network
39731       summary: create or update an existing l3-interface-ipv4-address-list
39732       description: |
39733         Create or update an existing l3-interface-ipv4-address-list.
39734         #
39735         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39736       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39737       consumes:
39738         - application/json
39739         - application/xml
39740       produces:
39741         - application/json
39742         - application/xml
39743       responses:
39744         "default":
39745           description: Response codes found in [response codes](https://wiki.onap.org/).
39746       parameters:
39747         - name: pnf-name
39748           in: path
39749           description: unique name of Physical Network Function.
39750           required: true
39751           type: string
39752           example: __PNF-NAME__
39753         - name: interface-name
39754           in: path
39755           description: Name that identifies the physical interface
39756           required: true
39757           type: string
39758           example: __INTERFACE-NAME__
39759         - name: interface-name
39760           in: path
39761           description: Name given to the interface
39762           required: true
39763           type: string
39764           example: __INTERFACE-NAME__
39765         - name: l3-interface-ipv4-address
39766           in: path
39767           description: IP address
39768           required: true
39769           type: string
39770           example: __L3-INTERFACE-IPV4-ADDRESS__
39771         - name: body
39772           in: body
39773           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39774           required: true
39775           schema:
39776             $ref: "#/definitions/l3-interface-ipv4-address-list"
39777     patch:
39778       tags:
39779         - Network
39780       summary: update an existing l3-interface-ipv4-address-list
39781       description: |
39782         Update an existing l3-interface-ipv4-address-list
39783         #
39784         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39785         The PUT operation will entirely replace an existing object.
39786         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39787         #
39788         Other differences between PUT and PATCH are:
39789         #
39790         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39791         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39792         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39793       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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 physical interface
39813           required: true
39814           type: string
39815           example: __INTERFACE-NAME__
39816         - name: interface-name
39817           in: path
39818           description: Name given to the interface
39819           required: true
39820           type: string
39821           example: __INTERFACE-NAME__
39822         - name: l3-interface-ipv4-address
39823           in: path
39824           description: IP address
39825           required: true
39826           type: string
39827           example: __L3-INTERFACE-IPV4-ADDRESS__
39828         - name: body
39829           in: body
39830           description: l3-interface-ipv4-address-list object that needs to be updated.
39831           required: true
39832           schema:
39833             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39834     delete:
39835       tags:
39836         - Network
39837       summary: delete an existing l3-interface-ipv4-address-list
39838       description: delete an existing l3-interface-ipv4-address-list
39839       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39840       consumes:
39841         - application/json
39842         - application/xml
39843       produces:
39844         - application/json
39845         - application/xml
39846       responses:
39847         "default":
39848           description: Response codes found in [response codes](https://wiki.onap.org/).
39849       parameters:
39850         - name: pnf-name
39851           in: path
39852           description: unique name of Physical Network Function.
39853           required: true
39854           type: string
39855           example: __PNF-NAME__
39856         - name: interface-name
39857           in: path
39858           description: Name that identifies the physical interface
39859           required: true
39860           type: string
39861           example: __INTERFACE-NAME__
39862         - name: interface-name
39863           in: path
39864           description: Name given to the interface
39865           required: true
39866           type: string
39867           example: __INTERFACE-NAME__
39868         - name: l3-interface-ipv4-address
39869           in: path
39870           description: IP address
39871           required: true
39872           type: string
39873           example: __L3-INTERFACE-IPV4-ADDRESS__
39874         - name: resource-version
39875           in: query
39876           description: resource-version for concurrency
39877           required: true
39878           type: string
39879   /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:
39880     put:
39881       tags:
39882         - Network
39883       summary: see node definition for valid relationships
39884       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39885       consumes:
39886         - application/json
39887         - application/xml
39888       produces:
39889         - application/json
39890         - application/xml
39891       responses:
39892         "default":
39893           description: Response codes found in [response codes](https://wiki.onap.org/).
39894       parameters:
39895         - name: pnf-name
39896           in: path
39897           description: unique name of Physical Network Function.
39898           required: true
39899           type: string
39900           example: __PNF-NAME__
39901         - name: interface-name
39902           in: path
39903           description: Name that identifies the physical interface
39904           required: true
39905           type: string
39906           example: __INTERFACE-NAME__
39907         - name: interface-name
39908           in: path
39909           description: Name given to the interface
39910           required: true
39911           type: string
39912           example: __INTERFACE-NAME__
39913         - name: l3-interface-ipv6-address
39914           in: path
39915           description: IP address
39916           required: true
39917           type: string
39918           example: __L3-INTERFACE-IPV6-ADDRESS__
39919         - name: body
39920           in: body
39921           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39922           required: true
39923           schema:
39924             $ref: "#/definitions/relationship"
39925     delete:
39926       tags:
39927         - Network
39928       summary: delete an existing relationship
39929       description: delete an existing relationship
39930       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39931       consumes:
39932         - application/json
39933         - application/xml
39934       produces:
39935         - application/json
39936         - application/xml
39937       responses:
39938         "default":
39939           description: Response codes found in [response codes](https://wiki.onap.org/).
39940       parameters:
39941         - name: pnf-name
39942           in: path
39943           description: unique name of Physical Network Function.
39944           required: true
39945           type: string
39946           example: __PNF-NAME__
39947         - name: interface-name
39948           in: path
39949           description: Name that identifies the physical interface
39950           required: true
39951           type: string
39952           example: __INTERFACE-NAME__
39953         - name: interface-name
39954           in: path
39955           description: Name given to the interface
39956           required: true
39957           type: string
39958           example: __INTERFACE-NAME__
39959         - name: l3-interface-ipv6-address
39960           in: path
39961           description: IP address
39962           required: true
39963           type: string
39964           example: __L3-INTERFACE-IPV6-ADDRESS__
39965   /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}:
39966     get:
39967       tags:
39968         - Network
39969       summary: returns l3-interface-ipv6-address-list
39970       description: returns l3-interface-ipv6-address-list
39971       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39972       produces:
39973         - application/json
39974         - application/xml
39975       responses:
39976         "200":
39977           description: successful operation
39978           schema:
39979               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39980         "default":
39981           description: Response codes found in [response codes](https://wiki.onap.org/).
39982       parameters:
39983         - name: pnf-name
39984           in: path
39985           description: unique name of Physical Network Function.
39986           required: true
39987           type: string
39988           example: __PNF-NAME__
39989         - name: interface-name
39990           in: path
39991           description: Name that identifies the physical interface
39992           required: true
39993           type: string
39994           example: __INTERFACE-NAME__
39995         - name: interface-name
39996           in: path
39997           description: Name given to the interface
39998           required: true
39999           type: string
40000           example: __INTERFACE-NAME__
40001         - name: l3-interface-ipv6-address
40002           in: path
40003           description: IP address
40004           required: true
40005           type: string
40006           example: __L3-INTERFACE-IPV6-ADDRESS__
40007     put:
40008       tags:
40009         - Network
40010       summary: create or update an existing l3-interface-ipv6-address-list
40011       description: |
40012         Create or update an existing l3-interface-ipv6-address-list.
40013         #
40014         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40015       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40016       consumes:
40017         - application/json
40018         - application/xml
40019       produces:
40020         - application/json
40021         - application/xml
40022       responses:
40023         "default":
40024           description: Response codes found in [response codes](https://wiki.onap.org/).
40025       parameters:
40026         - name: pnf-name
40027           in: path
40028           description: unique name of Physical Network Function.
40029           required: true
40030           type: string
40031           example: __PNF-NAME__
40032         - name: interface-name
40033           in: path
40034           description: Name that identifies the physical interface
40035           required: true
40036           type: string
40037           example: __INTERFACE-NAME__
40038         - name: interface-name
40039           in: path
40040           description: Name given to the interface
40041           required: true
40042           type: string
40043           example: __INTERFACE-NAME__
40044         - name: l3-interface-ipv6-address
40045           in: path
40046           description: IP address
40047           required: true
40048           type: string
40049           example: __L3-INTERFACE-IPV6-ADDRESS__
40050         - name: body
40051           in: body
40052           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40053           required: true
40054           schema:
40055             $ref: "#/definitions/l3-interface-ipv6-address-list"
40056     patch:
40057       tags:
40058         - Network
40059       summary: update an existing l3-interface-ipv6-address-list
40060       description: |
40061         Update an existing l3-interface-ipv6-address-list
40062         #
40063         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40064         The PUT operation will entirely replace an existing object.
40065         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40066         #
40067         Other differences between PUT and PATCH are:
40068         #
40069         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40070         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40071         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40072       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40073       consumes:
40074         - application/json
40075         - application/xml
40076       produces:
40077         - application/json
40078         - application/xml
40079       responses:
40080         "default":
40081           description: Response codes found in [response codes](https://wiki.onap.org/).
40082       parameters:
40083         - name: pnf-name
40084           in: path
40085           description: unique name of Physical Network Function.
40086           required: true
40087           type: string
40088           example: __PNF-NAME__
40089         - name: interface-name
40090           in: path
40091           description: Name that identifies the physical interface
40092           required: true
40093           type: string
40094           example: __INTERFACE-NAME__
40095         - name: interface-name
40096           in: path
40097           description: Name given to the interface
40098           required: true
40099           type: string
40100           example: __INTERFACE-NAME__
40101         - name: l3-interface-ipv6-address
40102           in: path
40103           description: IP address
40104           required: true
40105           type: string
40106           example: __L3-INTERFACE-IPV6-ADDRESS__
40107         - name: body
40108           in: body
40109           description: l3-interface-ipv6-address-list object that needs to be updated.
40110           required: true
40111           schema:
40112             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40113     delete:
40114       tags:
40115         - Network
40116       summary: delete an existing l3-interface-ipv6-address-list
40117       description: delete an existing l3-interface-ipv6-address-list
40118       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40119       consumes:
40120         - application/json
40121         - application/xml
40122       produces:
40123         - application/json
40124         - application/xml
40125       responses:
40126         "default":
40127           description: Response codes found in [response codes](https://wiki.onap.org/).
40128       parameters:
40129         - name: pnf-name
40130           in: path
40131           description: unique name of Physical Network Function.
40132           required: true
40133           type: string
40134           example: __PNF-NAME__
40135         - name: interface-name
40136           in: path
40137           description: Name that identifies the physical interface
40138           required: true
40139           type: string
40140           example: __INTERFACE-NAME__
40141         - name: interface-name
40142           in: path
40143           description: Name given to the interface
40144           required: true
40145           type: string
40146           example: __INTERFACE-NAME__
40147         - name: l3-interface-ipv6-address
40148           in: path
40149           description: IP address
40150           required: true
40151           type: string
40152           example: __L3-INTERFACE-IPV6-ADDRESS__
40153         - name: resource-version
40154           in: query
40155           description: resource-version for concurrency
40156           required: true
40157           type: string
40158   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
40159     get:
40160       tags:
40161         - Network
40162       summary: returns l-interface
40163       description: returns l-interface
40164       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40165       produces:
40166         - application/json
40167         - application/xml
40168       responses:
40169         "200":
40170           description: successful operation
40171           schema:
40172               $ref: "#/getDefinitions/l-interface"
40173         "default":
40174           description: Response codes found in [response codes](https://wiki.onap.org/).
40175       parameters:
40176         - name: pnf-name
40177           in: path
40178           description: unique name of Physical Network Function.
40179           required: true
40180           type: string
40181           example: __PNF-NAME__
40182         - name: interface-name
40183           in: path
40184           description: Name that identifies the physical interface
40185           required: true
40186           type: string
40187           example: __INTERFACE-NAME__
40188         - name: interface-name
40189           in: path
40190           description: Name given to the interface
40191           required: true
40192           type: string
40193           example: __INTERFACE-NAME__
40194     put:
40195       tags:
40196         - Network
40197       summary: create or update an existing l-interface
40198       description: |
40199         Create or update an existing l-interface.
40200         #
40201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40202       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40203       consumes:
40204         - application/json
40205         - application/xml
40206       produces:
40207         - application/json
40208         - application/xml
40209       responses:
40210         "default":
40211           description: Response codes found in [response codes](https://wiki.onap.org/).
40212       parameters:
40213         - name: pnf-name
40214           in: path
40215           description: unique name of Physical Network Function.
40216           required: true
40217           type: string
40218           example: __PNF-NAME__
40219         - name: interface-name
40220           in: path
40221           description: Name that identifies the physical interface
40222           required: true
40223           type: string
40224           example: __INTERFACE-NAME__
40225         - name: interface-name
40226           in: path
40227           description: Name given to the interface
40228           required: true
40229           type: string
40230           example: __INTERFACE-NAME__
40231         - name: body
40232           in: body
40233           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40234           required: true
40235           schema:
40236             $ref: "#/definitions/l-interface"
40237     patch:
40238       tags:
40239         - Network
40240       summary: update an existing l-interface
40241       description: |
40242         Update an existing l-interface
40243         #
40244         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40245         The PUT operation will entirely replace an existing object.
40246         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40247         #
40248         Other differences between PUT and PATCH are:
40249         #
40250         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40251         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40252         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40253       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40254       consumes:
40255         - application/json
40256         - application/xml
40257       produces:
40258         - application/json
40259         - application/xml
40260       responses:
40261         "default":
40262           description: Response codes found in [response codes](https://wiki.onap.org/).
40263       parameters:
40264         - name: pnf-name
40265           in: path
40266           description: unique name of Physical Network Function.
40267           required: true
40268           type: string
40269           example: __PNF-NAME__
40270         - name: interface-name
40271           in: path
40272           description: Name that identifies the physical interface
40273           required: true
40274           type: string
40275           example: __INTERFACE-NAME__
40276         - name: interface-name
40277           in: path
40278           description: Name given to the interface
40279           required: true
40280           type: string
40281           example: __INTERFACE-NAME__
40282         - name: body
40283           in: body
40284           description: l-interface object that needs to be updated.
40285           required: true
40286           schema:
40287             $ref: "#/patchDefinitions/l-interface"
40288     delete:
40289       tags:
40290         - Network
40291       summary: delete an existing l-interface
40292       description: delete an existing l-interface
40293       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40294       consumes:
40295         - application/json
40296         - application/xml
40297       produces:
40298         - application/json
40299         - application/xml
40300       responses:
40301         "default":
40302           description: Response codes found in [response codes](https://wiki.onap.org/).
40303       parameters:
40304         - name: pnf-name
40305           in: path
40306           description: unique name of Physical Network Function.
40307           required: true
40308           type: string
40309           example: __PNF-NAME__
40310         - name: interface-name
40311           in: path
40312           description: Name that identifies the physical interface
40313           required: true
40314           type: string
40315           example: __INTERFACE-NAME__
40316         - name: interface-name
40317           in: path
40318           description: Name given to the interface
40319           required: true
40320           type: string
40321           example: __INTERFACE-NAME__
40322         - name: resource-version
40323           in: query
40324           description: resource-version for concurrency
40325           required: true
40326           type: string
40327   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
40328     get:
40329       tags:
40330         - Network
40331       summary: returns l-interfaces
40332       description: returns l-interfaces
40333       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
40334       produces:
40335         - application/json
40336         - application/xml
40337       responses:
40338         "200":
40339           description: successful operation
40340           schema:
40341               $ref: "#/getDefinitions/l-interfaces"
40342         "default":
40343           description: Response codes found in [response codes](https://wiki.onap.org/).
40344       parameters:
40345         - name: pnf-name
40346           in: path
40347           description: unique name of Physical Network Function.
40348           required: true
40349           type: string
40350           example: __PNF-NAME__
40351         - name: interface-name
40352           in: path
40353           description: Name that identifies the physical interface
40354           required: true
40355           type: string
40356           example: __INTERFACE-NAME__
40357         - name: interface-name
40358           in: query
40359           description:
40360           required: false
40361           type: string
40362         - name: interface-id
40363           in: query
40364           description:
40365           required: false
40366           type: string
40367         - name: macaddr
40368           in: query
40369           description:
40370           required: false
40371           type: string
40372         - name: network-name
40373           in: query
40374           description:
40375           required: false
40376           type: string
40377   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
40378     get:
40379       tags:
40380         - Network
40381       summary: returns p-interface
40382       description: returns p-interface
40383       operationId: getNetworkPnfsPnfPInterfacesPInterface
40384       produces:
40385         - application/json
40386         - application/xml
40387       responses:
40388         "200":
40389           description: successful operation
40390           schema:
40391               $ref: "#/getDefinitions/p-interface"
40392         "default":
40393           description: Response codes found in [response codes](https://wiki.onap.org/).
40394       parameters:
40395         - name: pnf-name
40396           in: path
40397           description: unique name of Physical Network Function.
40398           required: true
40399           type: string
40400           example: __PNF-NAME__
40401         - name: interface-name
40402           in: path
40403           description: Name that identifies the physical interface
40404           required: true
40405           type: string
40406           example: __INTERFACE-NAME__
40407     put:
40408       tags:
40409         - Network
40410       summary: create or update an existing p-interface
40411       description: |
40412         Create or update an existing p-interface.
40413         #
40414         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40415       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
40416       consumes:
40417         - application/json
40418         - application/xml
40419       produces:
40420         - application/json
40421         - application/xml
40422       responses:
40423         "default":
40424           description: Response codes found in [response codes](https://wiki.onap.org/).
40425       parameters:
40426         - name: pnf-name
40427           in: path
40428           description: unique name of Physical Network Function.
40429           required: true
40430           type: string
40431           example: __PNF-NAME__
40432         - name: interface-name
40433           in: path
40434           description: Name that identifies the physical interface
40435           required: true
40436           type: string
40437           example: __INTERFACE-NAME__
40438         - name: body
40439           in: body
40440           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
40441           required: true
40442           schema:
40443             $ref: "#/definitions/p-interface"
40444     patch:
40445       tags:
40446         - Network
40447       summary: update an existing p-interface
40448       description: |
40449         Update an existing p-interface
40450         #
40451         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40452         The PUT operation will entirely replace an existing object.
40453         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40454         #
40455         Other differences between PUT and PATCH are:
40456         #
40457         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40458         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40459         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40460       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
40461       consumes:
40462         - application/json
40463         - application/xml
40464       produces:
40465         - application/json
40466         - application/xml
40467       responses:
40468         "default":
40469           description: Response codes found in [response codes](https://wiki.onap.org/).
40470       parameters:
40471         - name: pnf-name
40472           in: path
40473           description: unique name of Physical Network Function.
40474           required: true
40475           type: string
40476           example: __PNF-NAME__
40477         - name: interface-name
40478           in: path
40479           description: Name that identifies the physical interface
40480           required: true
40481           type: string
40482           example: __INTERFACE-NAME__
40483         - name: body
40484           in: body
40485           description: p-interface object that needs to be updated.
40486           required: true
40487           schema:
40488             $ref: "#/patchDefinitions/p-interface"
40489     delete:
40490       tags:
40491         - Network
40492       summary: delete an existing p-interface
40493       description: delete an existing p-interface
40494       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
40495       consumes:
40496         - application/json
40497         - application/xml
40498       produces:
40499         - application/json
40500         - application/xml
40501       responses:
40502         "default":
40503           description: Response codes found in [response codes](https://wiki.onap.org/).
40504       parameters:
40505         - name: pnf-name
40506           in: path
40507           description: unique name of Physical Network Function.
40508           required: true
40509           type: string
40510           example: __PNF-NAME__
40511         - name: interface-name
40512           in: path
40513           description: Name that identifies the physical interface
40514           required: true
40515           type: string
40516           example: __INTERFACE-NAME__
40517         - name: resource-version
40518           in: query
40519           description: resource-version for concurrency
40520           required: true
40521           type: string
40522   /network/pnfs/pnf/{pnf-name}/p-interfaces:
40523     get:
40524       tags:
40525         - Network
40526       summary: returns p-interfaces
40527       description: returns p-interfaces
40528       operationId: getNetworkPnfsPnfPInterfaces
40529       produces:
40530         - application/json
40531         - application/xml
40532       responses:
40533         "200":
40534           description: successful operation
40535           schema:
40536               $ref: "#/getDefinitions/p-interfaces"
40537         "default":
40538           description: Response codes found in [response codes](https://wiki.onap.org/).
40539       parameters:
40540         - name: pnf-name
40541           in: path
40542           description: unique name of Physical Network Function.
40543           required: true
40544           type: string
40545           example: __PNF-NAME__
40546         - name: interface-name
40547           in: query
40548           description:
40549           required: false
40550           type: string
40551         - name: prov-status
40552           in: query
40553           description:
40554           required: false
40555           type: string
40556   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
40557     put:
40558       tags:
40559         - Network
40560       summary: see node definition for valid relationships
40561       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40562       consumes:
40563         - application/json
40564         - application/xml
40565       produces:
40566         - application/json
40567         - application/xml
40568       responses:
40569         "default":
40570           description: Response codes found in [response codes](https://wiki.onap.org/).
40571       parameters:
40572         - name: pnf-name
40573           in: path
40574           description: unique name of Physical Network Function.
40575           required: true
40576           type: string
40577           example: __PNF-NAME__
40578         - name: interface-name
40579           in: path
40580           description: Name that identifies the link aggregate interface
40581           required: true
40582           type: string
40583           example: __INTERFACE-NAME__
40584         - name: body
40585           in: body
40586           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
40587           required: true
40588           schema:
40589             $ref: "#/definitions/relationship"
40590     delete:
40591       tags:
40592         - Network
40593       summary: delete an existing relationship
40594       description: delete an existing relationship
40595       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40596       consumes:
40597         - application/json
40598         - application/xml
40599       produces:
40600         - application/json
40601         - application/xml
40602       responses:
40603         "default":
40604           description: Response codes found in [response codes](https://wiki.onap.org/).
40605       parameters:
40606         - name: pnf-name
40607           in: path
40608           description: unique name of Physical Network Function.
40609           required: true
40610           type: string
40611           example: __PNF-NAME__
40612         - name: interface-name
40613           in: path
40614           description: Name that identifies the link aggregate interface
40615           required: true
40616           type: string
40617           example: __INTERFACE-NAME__
40618   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40619     put:
40620       tags:
40621         - Network
40622       summary: see node definition for valid relationships
40623       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40624       consumes:
40625         - application/json
40626         - application/xml
40627       produces:
40628         - application/json
40629         - application/xml
40630       responses:
40631         "default":
40632           description: Response codes found in [response codes](https://wiki.onap.org/).
40633       parameters:
40634         - name: pnf-name
40635           in: path
40636           description: unique name of Physical Network Function.
40637           required: true
40638           type: string
40639           example: __PNF-NAME__
40640         - name: interface-name
40641           in: path
40642           description: Name that identifies the link aggregate interface
40643           required: true
40644           type: string
40645           example: __INTERFACE-NAME__
40646         - name: interface-name
40647           in: path
40648           description: Name given to the interface
40649           required: true
40650           type: string
40651           example: __INTERFACE-NAME__
40652         - name: vlan-interface
40653           in: path
40654           description: String that identifies the interface
40655           required: true
40656           type: string
40657           example: __VLAN-INTERFACE__
40658         - name: body
40659           in: body
40660           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
40661           required: true
40662           schema:
40663             $ref: "#/definitions/relationship"
40664     delete:
40665       tags:
40666         - Network
40667       summary: delete an existing relationship
40668       description: delete an existing relationship
40669       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40670       consumes:
40671         - application/json
40672         - application/xml
40673       produces:
40674         - application/json
40675         - application/xml
40676       responses:
40677         "default":
40678           description: Response codes found in [response codes](https://wiki.onap.org/).
40679       parameters:
40680         - name: pnf-name
40681           in: path
40682           description: unique name of Physical Network Function.
40683           required: true
40684           type: string
40685           example: __PNF-NAME__
40686         - name: interface-name
40687           in: path
40688           description: Name that identifies the link aggregate interface
40689           required: true
40690           type: string
40691           example: __INTERFACE-NAME__
40692         - name: interface-name
40693           in: path
40694           description: Name given to the interface
40695           required: true
40696           type: string
40697           example: __INTERFACE-NAME__
40698         - name: vlan-interface
40699           in: path
40700           description: String that identifies the interface
40701           required: true
40702           type: string
40703           example: __VLAN-INTERFACE__
40704   /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:
40705     put:
40706       tags:
40707         - Network
40708       summary: see node definition for valid relationships
40709       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40710       consumes:
40711         - application/json
40712         - application/xml
40713       produces:
40714         - application/json
40715         - application/xml
40716       responses:
40717         "default":
40718           description: Response codes found in [response codes](https://wiki.onap.org/).
40719       parameters:
40720         - name: pnf-name
40721           in: path
40722           description: unique name of Physical Network Function.
40723           required: true
40724           type: string
40725           example: __PNF-NAME__
40726         - name: interface-name
40727           in: path
40728           description: Name that identifies the link aggregate interface
40729           required: true
40730           type: string
40731           example: __INTERFACE-NAME__
40732         - name: interface-name
40733           in: path
40734           description: Name given to the interface
40735           required: true
40736           type: string
40737           example: __INTERFACE-NAME__
40738         - name: vlan-interface
40739           in: path
40740           description: String that identifies the interface
40741           required: true
40742           type: string
40743           example: __VLAN-INTERFACE__
40744         - name: l3-interface-ipv4-address
40745           in: path
40746           description: IP address
40747           required: true
40748           type: string
40749           example: __L3-INTERFACE-IPV4-ADDRESS__
40750         - name: body
40751           in: body
40752           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40753           required: true
40754           schema:
40755             $ref: "#/definitions/relationship"
40756     delete:
40757       tags:
40758         - Network
40759       summary: delete an existing relationship
40760       description: delete an existing relationship
40761       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40762       consumes:
40763         - application/json
40764         - application/xml
40765       produces:
40766         - application/json
40767         - application/xml
40768       responses:
40769         "default":
40770           description: Response codes found in [response codes](https://wiki.onap.org/).
40771       parameters:
40772         - name: pnf-name
40773           in: path
40774           description: unique name of Physical Network Function.
40775           required: true
40776           type: string
40777           example: __PNF-NAME__
40778         - name: interface-name
40779           in: path
40780           description: Name that identifies the link aggregate interface
40781           required: true
40782           type: string
40783           example: __INTERFACE-NAME__
40784         - name: interface-name
40785           in: path
40786           description: Name given to the interface
40787           required: true
40788           type: string
40789           example: __INTERFACE-NAME__
40790         - name: vlan-interface
40791           in: path
40792           description: String that identifies the interface
40793           required: true
40794           type: string
40795           example: __VLAN-INTERFACE__
40796         - name: l3-interface-ipv4-address
40797           in: path
40798           description: IP address
40799           required: true
40800           type: string
40801           example: __L3-INTERFACE-IPV4-ADDRESS__
40802   /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}:
40803     get:
40804       tags:
40805         - Network
40806       summary: returns l3-interface-ipv4-address-list
40807       description: returns l3-interface-ipv4-address-list
40808       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40809       produces:
40810         - application/json
40811         - application/xml
40812       responses:
40813         "200":
40814           description: successful operation
40815           schema:
40816               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40817         "default":
40818           description: Response codes found in [response codes](https://wiki.onap.org/).
40819       parameters:
40820         - name: pnf-name
40821           in: path
40822           description: unique name of Physical Network Function.
40823           required: true
40824           type: string
40825           example: __PNF-NAME__
40826         - name: interface-name
40827           in: path
40828           description: Name that identifies the link aggregate interface
40829           required: true
40830           type: string
40831           example: __INTERFACE-NAME__
40832         - name: interface-name
40833           in: path
40834           description: Name given to the interface
40835           required: true
40836           type: string
40837           example: __INTERFACE-NAME__
40838         - name: vlan-interface
40839           in: path
40840           description: String that identifies the interface
40841           required: true
40842           type: string
40843           example: __VLAN-INTERFACE__
40844         - name: l3-interface-ipv4-address
40845           in: path
40846           description: IP address
40847           required: true
40848           type: string
40849           example: __L3-INTERFACE-IPV4-ADDRESS__
40850     put:
40851       tags:
40852         - Network
40853       summary: create or update an existing l3-interface-ipv4-address-list
40854       description: |
40855         Create or update an existing l3-interface-ipv4-address-list.
40856         #
40857         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40858       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40859       consumes:
40860         - application/json
40861         - application/xml
40862       produces:
40863         - application/json
40864         - application/xml
40865       responses:
40866         "default":
40867           description: Response codes found in [response codes](https://wiki.onap.org/).
40868       parameters:
40869         - name: pnf-name
40870           in: path
40871           description: unique name of Physical Network Function.
40872           required: true
40873           type: string
40874           example: __PNF-NAME__
40875         - name: interface-name
40876           in: path
40877           description: Name that identifies the link aggregate interface
40878           required: true
40879           type: string
40880           example: __INTERFACE-NAME__
40881         - name: interface-name
40882           in: path
40883           description: Name given to the interface
40884           required: true
40885           type: string
40886           example: __INTERFACE-NAME__
40887         - name: vlan-interface
40888           in: path
40889           description: String that identifies the interface
40890           required: true
40891           type: string
40892           example: __VLAN-INTERFACE__
40893         - name: l3-interface-ipv4-address
40894           in: path
40895           description: IP address
40896           required: true
40897           type: string
40898           example: __L3-INTERFACE-IPV4-ADDRESS__
40899         - name: body
40900           in: body
40901           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40902           required: true
40903           schema:
40904             $ref: "#/definitions/l3-interface-ipv4-address-list"
40905     patch:
40906       tags:
40907         - Network
40908       summary: update an existing l3-interface-ipv4-address-list
40909       description: |
40910         Update an existing l3-interface-ipv4-address-list
40911         #
40912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40913         The PUT operation will entirely replace an existing object.
40914         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40915         #
40916         Other differences between PUT and PATCH are:
40917         #
40918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40921       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40922       consumes:
40923         - application/json
40924         - application/xml
40925       produces:
40926         - application/json
40927         - application/xml
40928       responses:
40929         "default":
40930           description: Response codes found in [response codes](https://wiki.onap.org/).
40931       parameters:
40932         - name: pnf-name
40933           in: path
40934           description: unique name of Physical Network Function.
40935           required: true
40936           type: string
40937           example: __PNF-NAME__
40938         - name: interface-name
40939           in: path
40940           description: Name that identifies the link aggregate interface
40941           required: true
40942           type: string
40943           example: __INTERFACE-NAME__
40944         - name: interface-name
40945           in: path
40946           description: Name given to the interface
40947           required: true
40948           type: string
40949           example: __INTERFACE-NAME__
40950         - name: vlan-interface
40951           in: path
40952           description: String that identifies the interface
40953           required: true
40954           type: string
40955           example: __VLAN-INTERFACE__
40956         - name: l3-interface-ipv4-address
40957           in: path
40958           description: IP address
40959           required: true
40960           type: string
40961           example: __L3-INTERFACE-IPV4-ADDRESS__
40962         - name: body
40963           in: body
40964           description: l3-interface-ipv4-address-list object that needs to be updated.
40965           required: true
40966           schema:
40967             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40968     delete:
40969       tags:
40970         - Network
40971       summary: delete an existing l3-interface-ipv4-address-list
40972       description: delete an existing l3-interface-ipv4-address-list
40973       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40974       consumes:
40975         - application/json
40976         - application/xml
40977       produces:
40978         - application/json
40979         - application/xml
40980       responses:
40981         "default":
40982           description: Response codes found in [response codes](https://wiki.onap.org/).
40983       parameters:
40984         - name: pnf-name
40985           in: path
40986           description: unique name of Physical Network Function.
40987           required: true
40988           type: string
40989           example: __PNF-NAME__
40990         - name: interface-name
40991           in: path
40992           description: Name that identifies the link aggregate interface
40993           required: true
40994           type: string
40995           example: __INTERFACE-NAME__
40996         - name: interface-name
40997           in: path
40998           description: Name given to the interface
40999           required: true
41000           type: string
41001           example: __INTERFACE-NAME__
41002         - name: vlan-interface
41003           in: path
41004           description: String that identifies the interface
41005           required: true
41006           type: string
41007           example: __VLAN-INTERFACE__
41008         - name: l3-interface-ipv4-address
41009           in: path
41010           description: IP address
41011           required: true
41012           type: string
41013           example: __L3-INTERFACE-IPV4-ADDRESS__
41014         - name: resource-version
41015           in: query
41016           description: resource-version for concurrency
41017           required: true
41018           type: string
41019   /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:
41020     put:
41021       tags:
41022         - Network
41023       summary: see node definition for valid relationships
41024       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41025       consumes:
41026         - application/json
41027         - application/xml
41028       produces:
41029         - application/json
41030         - application/xml
41031       responses:
41032         "default":
41033           description: Response codes found in [response codes](https://wiki.onap.org/).
41034       parameters:
41035         - name: pnf-name
41036           in: path
41037           description: unique name of Physical Network Function.
41038           required: true
41039           type: string
41040           example: __PNF-NAME__
41041         - name: interface-name
41042           in: path
41043           description: Name that identifies the link aggregate interface
41044           required: true
41045           type: string
41046           example: __INTERFACE-NAME__
41047         - name: interface-name
41048           in: path
41049           description: Name given to the interface
41050           required: true
41051           type: string
41052           example: __INTERFACE-NAME__
41053         - name: vlan-interface
41054           in: path
41055           description: String that identifies the interface
41056           required: true
41057           type: string
41058           example: __VLAN-INTERFACE__
41059         - name: l3-interface-ipv6-address
41060           in: path
41061           description: IP address
41062           required: true
41063           type: string
41064           example: __L3-INTERFACE-IPV6-ADDRESS__
41065         - name: body
41066           in: body
41067           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41068           required: true
41069           schema:
41070             $ref: "#/definitions/relationship"
41071     delete:
41072       tags:
41073         - Network
41074       summary: delete an existing relationship
41075       description: delete an existing relationship
41076       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41077       consumes:
41078         - application/json
41079         - application/xml
41080       produces:
41081         - application/json
41082         - application/xml
41083       responses:
41084         "default":
41085           description: Response codes found in [response codes](https://wiki.onap.org/).
41086       parameters:
41087         - name: pnf-name
41088           in: path
41089           description: unique name of Physical Network Function.
41090           required: true
41091           type: string
41092           example: __PNF-NAME__
41093         - name: interface-name
41094           in: path
41095           description: Name that identifies the link aggregate interface
41096           required: true
41097           type: string
41098           example: __INTERFACE-NAME__
41099         - name: interface-name
41100           in: path
41101           description: Name given to the interface
41102           required: true
41103           type: string
41104           example: __INTERFACE-NAME__
41105         - name: vlan-interface
41106           in: path
41107           description: String that identifies the interface
41108           required: true
41109           type: string
41110           example: __VLAN-INTERFACE__
41111         - name: l3-interface-ipv6-address
41112           in: path
41113           description: IP address
41114           required: true
41115           type: string
41116           example: __L3-INTERFACE-IPV6-ADDRESS__
41117   /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}:
41118     get:
41119       tags:
41120         - Network
41121       summary: returns l3-interface-ipv6-address-list
41122       description: returns l3-interface-ipv6-address-list
41123       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41124       produces:
41125         - application/json
41126         - application/xml
41127       responses:
41128         "200":
41129           description: successful operation
41130           schema:
41131               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41132         "default":
41133           description: Response codes found in [response codes](https://wiki.onap.org/).
41134       parameters:
41135         - name: pnf-name
41136           in: path
41137           description: unique name of Physical Network Function.
41138           required: true
41139           type: string
41140           example: __PNF-NAME__
41141         - name: interface-name
41142           in: path
41143           description: Name that identifies the link aggregate interface
41144           required: true
41145           type: string
41146           example: __INTERFACE-NAME__
41147         - name: interface-name
41148           in: path
41149           description: Name given to the interface
41150           required: true
41151           type: string
41152           example: __INTERFACE-NAME__
41153         - name: vlan-interface
41154           in: path
41155           description: String that identifies the interface
41156           required: true
41157           type: string
41158           example: __VLAN-INTERFACE__
41159         - name: l3-interface-ipv6-address
41160           in: path
41161           description: IP address
41162           required: true
41163           type: string
41164           example: __L3-INTERFACE-IPV6-ADDRESS__
41165     put:
41166       tags:
41167         - Network
41168       summary: create or update an existing l3-interface-ipv6-address-list
41169       description: |
41170         Create or update an existing l3-interface-ipv6-address-list.
41171         #
41172         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41173       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41174       consumes:
41175         - application/json
41176         - application/xml
41177       produces:
41178         - application/json
41179         - application/xml
41180       responses:
41181         "default":
41182           description: Response codes found in [response codes](https://wiki.onap.org/).
41183       parameters:
41184         - name: pnf-name
41185           in: path
41186           description: unique name of Physical Network Function.
41187           required: true
41188           type: string
41189           example: __PNF-NAME__
41190         - name: interface-name
41191           in: path
41192           description: Name that identifies the link aggregate interface
41193           required: true
41194           type: string
41195           example: __INTERFACE-NAME__
41196         - name: interface-name
41197           in: path
41198           description: Name given to the interface
41199           required: true
41200           type: string
41201           example: __INTERFACE-NAME__
41202         - name: vlan-interface
41203           in: path
41204           description: String that identifies the interface
41205           required: true
41206           type: string
41207           example: __VLAN-INTERFACE__
41208         - name: l3-interface-ipv6-address
41209           in: path
41210           description: IP address
41211           required: true
41212           type: string
41213           example: __L3-INTERFACE-IPV6-ADDRESS__
41214         - name: body
41215           in: body
41216           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41217           required: true
41218           schema:
41219             $ref: "#/definitions/l3-interface-ipv6-address-list"
41220     patch:
41221       tags:
41222         - Network
41223       summary: update an existing l3-interface-ipv6-address-list
41224       description: |
41225         Update an existing l3-interface-ipv6-address-list
41226         #
41227         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41228         The PUT operation will entirely replace an existing object.
41229         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41230         #
41231         Other differences between PUT and PATCH are:
41232         #
41233         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41234         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41235         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41236       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41237       consumes:
41238         - application/json
41239         - application/xml
41240       produces:
41241         - application/json
41242         - application/xml
41243       responses:
41244         "default":
41245           description: Response codes found in [response codes](https://wiki.onap.org/).
41246       parameters:
41247         - name: pnf-name
41248           in: path
41249           description: unique name of Physical Network Function.
41250           required: true
41251           type: string
41252           example: __PNF-NAME__
41253         - name: interface-name
41254           in: path
41255           description: Name that identifies the link aggregate interface
41256           required: true
41257           type: string
41258           example: __INTERFACE-NAME__
41259         - name: interface-name
41260           in: path
41261           description: Name given to the interface
41262           required: true
41263           type: string
41264           example: __INTERFACE-NAME__
41265         - name: vlan-interface
41266           in: path
41267           description: String that identifies the interface
41268           required: true
41269           type: string
41270           example: __VLAN-INTERFACE__
41271         - name: l3-interface-ipv6-address
41272           in: path
41273           description: IP address
41274           required: true
41275           type: string
41276           example: __L3-INTERFACE-IPV6-ADDRESS__
41277         - name: body
41278           in: body
41279           description: l3-interface-ipv6-address-list object that needs to be updated.
41280           required: true
41281           schema:
41282             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41283     delete:
41284       tags:
41285         - Network
41286       summary: delete an existing l3-interface-ipv6-address-list
41287       description: delete an existing l3-interface-ipv6-address-list
41288       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41289       consumes:
41290         - application/json
41291         - application/xml
41292       produces:
41293         - application/json
41294         - application/xml
41295       responses:
41296         "default":
41297           description: Response codes found in [response codes](https://wiki.onap.org/).
41298       parameters:
41299         - name: pnf-name
41300           in: path
41301           description: unique name of Physical Network Function.
41302           required: true
41303           type: string
41304           example: __PNF-NAME__
41305         - name: interface-name
41306           in: path
41307           description: Name that identifies the link aggregate interface
41308           required: true
41309           type: string
41310           example: __INTERFACE-NAME__
41311         - name: interface-name
41312           in: path
41313           description: Name given to the interface
41314           required: true
41315           type: string
41316           example: __INTERFACE-NAME__
41317         - name: vlan-interface
41318           in: path
41319           description: String that identifies the interface
41320           required: true
41321           type: string
41322           example: __VLAN-INTERFACE__
41323         - name: l3-interface-ipv6-address
41324           in: path
41325           description: IP address
41326           required: true
41327           type: string
41328           example: __L3-INTERFACE-IPV6-ADDRESS__
41329         - name: resource-version
41330           in: query
41331           description: resource-version for concurrency
41332           required: true
41333           type: string
41334   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
41335     get:
41336       tags:
41337         - Network
41338       summary: returns vlan
41339       description: returns vlan
41340       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41341       produces:
41342         - application/json
41343         - application/xml
41344       responses:
41345         "200":
41346           description: successful operation
41347           schema:
41348               $ref: "#/getDefinitions/vlan"
41349         "default":
41350           description: Response codes found in [response codes](https://wiki.onap.org/).
41351       parameters:
41352         - name: pnf-name
41353           in: path
41354           description: unique name of Physical Network Function.
41355           required: true
41356           type: string
41357           example: __PNF-NAME__
41358         - name: interface-name
41359           in: path
41360           description: Name that identifies the link aggregate interface
41361           required: true
41362           type: string
41363           example: __INTERFACE-NAME__
41364         - name: interface-name
41365           in: path
41366           description: Name given to the interface
41367           required: true
41368           type: string
41369           example: __INTERFACE-NAME__
41370         - name: vlan-interface
41371           in: path
41372           description: String that identifies the interface
41373           required: true
41374           type: string
41375           example: __VLAN-INTERFACE__
41376     put:
41377       tags:
41378         - Network
41379       summary: create or update an existing vlan
41380       description: |
41381         Create or update an existing vlan.
41382         #
41383         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41384       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41385       consumes:
41386         - application/json
41387         - application/xml
41388       produces:
41389         - application/json
41390         - application/xml
41391       responses:
41392         "default":
41393           description: Response codes found in [response codes](https://wiki.onap.org/).
41394       parameters:
41395         - name: pnf-name
41396           in: path
41397           description: unique name of Physical Network Function.
41398           required: true
41399           type: string
41400           example: __PNF-NAME__
41401         - name: interface-name
41402           in: path
41403           description: Name that identifies the link aggregate interface
41404           required: true
41405           type: string
41406           example: __INTERFACE-NAME__
41407         - name: interface-name
41408           in: path
41409           description: Name given to the interface
41410           required: true
41411           type: string
41412           example: __INTERFACE-NAME__
41413         - name: vlan-interface
41414           in: path
41415           description: String that identifies the interface
41416           required: true
41417           type: string
41418           example: __VLAN-INTERFACE__
41419         - name: body
41420           in: body
41421           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41422           required: true
41423           schema:
41424             $ref: "#/definitions/vlan"
41425     patch:
41426       tags:
41427         - Network
41428       summary: update an existing vlan
41429       description: |
41430         Update an existing vlan
41431         #
41432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41433         The PUT operation will entirely replace an existing object.
41434         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41435         #
41436         Other differences between PUT and PATCH are:
41437         #
41438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41441       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41442       consumes:
41443         - application/json
41444         - application/xml
41445       produces:
41446         - application/json
41447         - application/xml
41448       responses:
41449         "default":
41450           description: Response codes found in [response codes](https://wiki.onap.org/).
41451       parameters:
41452         - name: pnf-name
41453           in: path
41454           description: unique name of Physical Network Function.
41455           required: true
41456           type: string
41457           example: __PNF-NAME__
41458         - name: interface-name
41459           in: path
41460           description: Name that identifies the link aggregate interface
41461           required: true
41462           type: string
41463           example: __INTERFACE-NAME__
41464         - name: interface-name
41465           in: path
41466           description: Name given to the interface
41467           required: true
41468           type: string
41469           example: __INTERFACE-NAME__
41470         - name: vlan-interface
41471           in: path
41472           description: String that identifies the interface
41473           required: true
41474           type: string
41475           example: __VLAN-INTERFACE__
41476         - name: body
41477           in: body
41478           description: vlan object that needs to be updated.
41479           required: true
41480           schema:
41481             $ref: "#/patchDefinitions/vlan"
41482     delete:
41483       tags:
41484         - Network
41485       summary: delete an existing vlan
41486       description: delete an existing vlan
41487       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41488       consumes:
41489         - application/json
41490         - application/xml
41491       produces:
41492         - application/json
41493         - application/xml
41494       responses:
41495         "default":
41496           description: Response codes found in [response codes](https://wiki.onap.org/).
41497       parameters:
41498         - name: pnf-name
41499           in: path
41500           description: unique name of Physical Network Function.
41501           required: true
41502           type: string
41503           example: __PNF-NAME__
41504         - name: interface-name
41505           in: path
41506           description: Name that identifies the link aggregate interface
41507           required: true
41508           type: string
41509           example: __INTERFACE-NAME__
41510         - name: interface-name
41511           in: path
41512           description: Name given to the interface
41513           required: true
41514           type: string
41515           example: __INTERFACE-NAME__
41516         - name: vlan-interface
41517           in: path
41518           description: String that identifies the interface
41519           required: true
41520           type: string
41521           example: __VLAN-INTERFACE__
41522         - name: resource-version
41523           in: query
41524           description: resource-version for concurrency
41525           required: true
41526           type: string
41527   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41528     get:
41529       tags:
41530         - Network
41531       summary: returns vlans
41532       description: returns vlans
41533       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
41534       produces:
41535         - application/json
41536         - application/xml
41537       responses:
41538         "200":
41539           description: successful operation
41540           schema:
41541               $ref: "#/getDefinitions/vlans"
41542         "default":
41543           description: Response codes found in [response codes](https://wiki.onap.org/).
41544       parameters:
41545         - name: pnf-name
41546           in: path
41547           description: unique name of Physical Network Function.
41548           required: true
41549           type: string
41550           example: __PNF-NAME__
41551         - name: interface-name
41552           in: path
41553           description: Name that identifies the link aggregate interface
41554           required: true
41555           type: string
41556           example: __INTERFACE-NAME__
41557         - name: interface-name
41558           in: path
41559           description: Name given to the interface
41560           required: true
41561           type: string
41562           example: __INTERFACE-NAME__
41563         - name: vlan-interface
41564           in: query
41565           description:
41566           required: false
41567           type: string
41568         - name: vlan-id-inner
41569           in: query
41570           description:
41571           required: false
41572           type: integer
41573           format: int64
41574         - name: vpn-key
41575           in: query
41576           description:
41577           required: false
41578           type: string
41579   /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:
41580     put:
41581       tags:
41582         - Network
41583       summary: see node definition for valid relationships
41584       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41585       consumes:
41586         - application/json
41587         - application/xml
41588       produces:
41589         - application/json
41590         - application/xml
41591       responses:
41592         "default":
41593           description: Response codes found in [response codes](https://wiki.onap.org/).
41594       parameters:
41595         - name: pnf-name
41596           in: path
41597           description: unique name of Physical Network Function.
41598           required: true
41599           type: string
41600           example: __PNF-NAME__
41601         - name: interface-name
41602           in: path
41603           description: Name that identifies the link aggregate interface
41604           required: true
41605           type: string
41606           example: __INTERFACE-NAME__
41607         - name: interface-name
41608           in: path
41609           description: Name given to the interface
41610           required: true
41611           type: string
41612           example: __INTERFACE-NAME__
41613         - name: pci-id
41614           in: path
41615           description: PCI ID used to identify the sriov-vf
41616           required: true
41617           type: string
41618           example: __PCI-ID__
41619         - name: body
41620           in: body
41621           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41622           required: true
41623           schema:
41624             $ref: "#/definitions/relationship"
41625     delete:
41626       tags:
41627         - Network
41628       summary: delete an existing relationship
41629       description: delete an existing relationship
41630       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41631       consumes:
41632         - application/json
41633         - application/xml
41634       produces:
41635         - application/json
41636         - application/xml
41637       responses:
41638         "default":
41639           description: Response codes found in [response codes](https://wiki.onap.org/).
41640       parameters:
41641         - name: pnf-name
41642           in: path
41643           description: unique name of Physical Network Function.
41644           required: true
41645           type: string
41646           example: __PNF-NAME__
41647         - name: interface-name
41648           in: path
41649           description: Name that identifies the link aggregate interface
41650           required: true
41651           type: string
41652           example: __INTERFACE-NAME__
41653         - name: interface-name
41654           in: path
41655           description: Name given to the interface
41656           required: true
41657           type: string
41658           example: __INTERFACE-NAME__
41659         - name: pci-id
41660           in: path
41661           description: PCI ID used to identify the sriov-vf
41662           required: true
41663           type: string
41664           example: __PCI-ID__
41665   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
41666     get:
41667       tags:
41668         - Network
41669       summary: returns sriov-vf
41670       description: returns sriov-vf
41671       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41672       produces:
41673         - application/json
41674         - application/xml
41675       responses:
41676         "200":
41677           description: successful operation
41678           schema:
41679               $ref: "#/getDefinitions/sriov-vf"
41680         "default":
41681           description: Response codes found in [response codes](https://wiki.onap.org/).
41682       parameters:
41683         - name: pnf-name
41684           in: path
41685           description: unique name of Physical Network Function.
41686           required: true
41687           type: string
41688           example: __PNF-NAME__
41689         - name: interface-name
41690           in: path
41691           description: Name that identifies the link aggregate interface
41692           required: true
41693           type: string
41694           example: __INTERFACE-NAME__
41695         - name: interface-name
41696           in: path
41697           description: Name given to the interface
41698           required: true
41699           type: string
41700           example: __INTERFACE-NAME__
41701         - name: pci-id
41702           in: path
41703           description: PCI ID used to identify the sriov-vf
41704           required: true
41705           type: string
41706           example: __PCI-ID__
41707     put:
41708       tags:
41709         - Network
41710       summary: create or update an existing sriov-vf
41711       description: |
41712         Create or update an existing sriov-vf.
41713         #
41714         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41715       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41716       consumes:
41717         - application/json
41718         - application/xml
41719       produces:
41720         - application/json
41721         - application/xml
41722       responses:
41723         "default":
41724           description: Response codes found in [response codes](https://wiki.onap.org/).
41725       parameters:
41726         - name: pnf-name
41727           in: path
41728           description: unique name of Physical Network Function.
41729           required: true
41730           type: string
41731           example: __PNF-NAME__
41732         - name: interface-name
41733           in: path
41734           description: Name that identifies the link aggregate interface
41735           required: true
41736           type: string
41737           example: __INTERFACE-NAME__
41738         - name: interface-name
41739           in: path
41740           description: Name given to the interface
41741           required: true
41742           type: string
41743           example: __INTERFACE-NAME__
41744         - name: pci-id
41745           in: path
41746           description: PCI ID used to identify the sriov-vf
41747           required: true
41748           type: string
41749           example: __PCI-ID__
41750         - name: body
41751           in: body
41752           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41753           required: true
41754           schema:
41755             $ref: "#/definitions/sriov-vf"
41756     patch:
41757       tags:
41758         - Network
41759       summary: update an existing sriov-vf
41760       description: |
41761         Update an existing sriov-vf
41762         #
41763         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41764         The PUT operation will entirely replace an existing object.
41765         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41766         #
41767         Other differences between PUT and PATCH are:
41768         #
41769         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41770         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41771         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41772       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41773       consumes:
41774         - application/json
41775         - application/xml
41776       produces:
41777         - application/json
41778         - application/xml
41779       responses:
41780         "default":
41781           description: Response codes found in [response codes](https://wiki.onap.org/).
41782       parameters:
41783         - name: pnf-name
41784           in: path
41785           description: unique name of Physical Network Function.
41786           required: true
41787           type: string
41788           example: __PNF-NAME__
41789         - name: interface-name
41790           in: path
41791           description: Name that identifies the link aggregate interface
41792           required: true
41793           type: string
41794           example: __INTERFACE-NAME__
41795         - name: interface-name
41796           in: path
41797           description: Name given to the interface
41798           required: true
41799           type: string
41800           example: __INTERFACE-NAME__
41801         - name: pci-id
41802           in: path
41803           description: PCI ID used to identify the sriov-vf
41804           required: true
41805           type: string
41806           example: __PCI-ID__
41807         - name: body
41808           in: body
41809           description: sriov-vf object that needs to be updated.
41810           required: true
41811           schema:
41812             $ref: "#/patchDefinitions/sriov-vf"
41813     delete:
41814       tags:
41815         - Network
41816       summary: delete an existing sriov-vf
41817       description: delete an existing sriov-vf
41818       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41819       consumes:
41820         - application/json
41821         - application/xml
41822       produces:
41823         - application/json
41824         - application/xml
41825       responses:
41826         "default":
41827           description: Response codes found in [response codes](https://wiki.onap.org/).
41828       parameters:
41829         - name: pnf-name
41830           in: path
41831           description: unique name of Physical Network Function.
41832           required: true
41833           type: string
41834           example: __PNF-NAME__
41835         - name: interface-name
41836           in: path
41837           description: Name that identifies the link aggregate interface
41838           required: true
41839           type: string
41840           example: __INTERFACE-NAME__
41841         - name: interface-name
41842           in: path
41843           description: Name given to the interface
41844           required: true
41845           type: string
41846           example: __INTERFACE-NAME__
41847         - name: pci-id
41848           in: path
41849           description: PCI ID used to identify the sriov-vf
41850           required: true
41851           type: string
41852           example: __PCI-ID__
41853         - name: resource-version
41854           in: query
41855           description: resource-version for concurrency
41856           required: true
41857           type: string
41858   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
41859     get:
41860       tags:
41861         - Network
41862       summary: returns sriov-vfs
41863       description: returns sriov-vfs
41864       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
41865       produces:
41866         - application/json
41867         - application/xml
41868       responses:
41869         "200":
41870           description: successful operation
41871           schema:
41872               $ref: "#/getDefinitions/sriov-vfs"
41873         "default":
41874           description: Response codes found in [response codes](https://wiki.onap.org/).
41875       parameters:
41876         - name: pnf-name
41877           in: path
41878           description: unique name of Physical Network Function.
41879           required: true
41880           type: string
41881           example: __PNF-NAME__
41882         - name: interface-name
41883           in: path
41884           description: Name that identifies the link aggregate interface
41885           required: true
41886           type: string
41887           example: __INTERFACE-NAME__
41888         - name: interface-name
41889           in: path
41890           description: Name given to the interface
41891           required: true
41892           type: string
41893           example: __INTERFACE-NAME__
41894         - name: pci-id
41895           in: query
41896           description:
41897           required: false
41898           type: string
41899         - name: vf-vlan-filter
41900           in: query
41901           description:
41902           required: false
41903           type: string
41904         - name: vf-mac-filter
41905           in: query
41906           description:
41907           required: false
41908           type: string
41909         - name: vf-vlan-strip
41910           in: query
41911           description:
41912           required: false
41913           type: boolean
41914         - name: neutron-network-id
41915           in: query
41916           description:
41917           required: false
41918           type: string
41919   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
41920     put:
41921       tags:
41922         - Network
41923       summary: see node definition for valid relationships
41924       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41925       consumes:
41926         - application/json
41927         - application/xml
41928       produces:
41929         - application/json
41930         - application/xml
41931       responses:
41932         "default":
41933           description: Response codes found in [response codes](https://wiki.onap.org/).
41934       parameters:
41935         - name: pnf-name
41936           in: path
41937           description: unique name of Physical Network Function.
41938           required: true
41939           type: string
41940           example: __PNF-NAME__
41941         - name: interface-name
41942           in: path
41943           description: Name that identifies the link aggregate interface
41944           required: true
41945           type: string
41946           example: __INTERFACE-NAME__
41947         - name: interface-name
41948           in: path
41949           description: Name given to the interface
41950           required: true
41951           type: string
41952           example: __INTERFACE-NAME__
41953         - name: body
41954           in: body
41955           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
41956           required: true
41957           schema:
41958             $ref: "#/definitions/relationship"
41959     delete:
41960       tags:
41961         - Network
41962       summary: delete an existing relationship
41963       description: delete an existing relationship
41964       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41965       consumes:
41966         - application/json
41967         - application/xml
41968       produces:
41969         - application/json
41970         - application/xml
41971       responses:
41972         "default":
41973           description: Response codes found in [response codes](https://wiki.onap.org/).
41974       parameters:
41975         - name: pnf-name
41976           in: path
41977           description: unique name of Physical Network Function.
41978           required: true
41979           type: string
41980           example: __PNF-NAME__
41981         - name: interface-name
41982           in: path
41983           description: Name that identifies the link aggregate interface
41984           required: true
41985           type: string
41986           example: __INTERFACE-NAME__
41987         - name: interface-name
41988           in: path
41989           description: Name given to the interface
41990           required: true
41991           type: string
41992           example: __INTERFACE-NAME__
41993   /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:
41994     put:
41995       tags:
41996         - Network
41997       summary: see node definition for valid relationships
41998       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41999       consumes:
42000         - application/json
42001         - application/xml
42002       produces:
42003         - application/json
42004         - application/xml
42005       responses:
42006         "default":
42007           description: Response codes found in [response codes](https://wiki.onap.org/).
42008       parameters:
42009         - name: pnf-name
42010           in: path
42011           description: unique name of Physical Network Function.
42012           required: true
42013           type: string
42014           example: __PNF-NAME__
42015         - name: interface-name
42016           in: path
42017           description: Name that identifies the link aggregate interface
42018           required: true
42019           type: string
42020           example: __INTERFACE-NAME__
42021         - name: interface-name
42022           in: path
42023           description: Name given to the interface
42024           required: true
42025           type: string
42026           example: __INTERFACE-NAME__
42027         - name: l3-interface-ipv4-address
42028           in: path
42029           description: IP address
42030           required: true
42031           type: string
42032           example: __L3-INTERFACE-IPV4-ADDRESS__
42033         - name: body
42034           in: body
42035           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42036           required: true
42037           schema:
42038             $ref: "#/definitions/relationship"
42039     delete:
42040       tags:
42041         - Network
42042       summary: delete an existing relationship
42043       description: delete an existing relationship
42044       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42045       consumes:
42046         - application/json
42047         - application/xml
42048       produces:
42049         - application/json
42050         - application/xml
42051       responses:
42052         "default":
42053           description: Response codes found in [response codes](https://wiki.onap.org/).
42054       parameters:
42055         - name: pnf-name
42056           in: path
42057           description: unique name of Physical Network Function.
42058           required: true
42059           type: string
42060           example: __PNF-NAME__
42061         - name: interface-name
42062           in: path
42063           description: Name that identifies the link aggregate interface
42064           required: true
42065           type: string
42066           example: __INTERFACE-NAME__
42067         - name: interface-name
42068           in: path
42069           description: Name given to the interface
42070           required: true
42071           type: string
42072           example: __INTERFACE-NAME__
42073         - name: l3-interface-ipv4-address
42074           in: path
42075           description: IP address
42076           required: true
42077           type: string
42078           example: __L3-INTERFACE-IPV4-ADDRESS__
42079   /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}:
42080     get:
42081       tags:
42082         - Network
42083       summary: returns l3-interface-ipv4-address-list
42084       description: returns l3-interface-ipv4-address-list
42085       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42086       produces:
42087         - application/json
42088         - application/xml
42089       responses:
42090         "200":
42091           description: successful operation
42092           schema:
42093               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42094         "default":
42095           description: Response codes found in [response codes](https://wiki.onap.org/).
42096       parameters:
42097         - name: pnf-name
42098           in: path
42099           description: unique name of Physical Network Function.
42100           required: true
42101           type: string
42102           example: __PNF-NAME__
42103         - name: interface-name
42104           in: path
42105           description: Name that identifies the link aggregate interface
42106           required: true
42107           type: string
42108           example: __INTERFACE-NAME__
42109         - name: interface-name
42110           in: path
42111           description: Name given to the interface
42112           required: true
42113           type: string
42114           example: __INTERFACE-NAME__
42115         - name: l3-interface-ipv4-address
42116           in: path
42117           description: IP address
42118           required: true
42119           type: string
42120           example: __L3-INTERFACE-IPV4-ADDRESS__
42121     put:
42122       tags:
42123         - Network
42124       summary: create or update an existing l3-interface-ipv4-address-list
42125       description: |
42126         Create or update an existing l3-interface-ipv4-address-list.
42127         #
42128         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42129       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42130       consumes:
42131         - application/json
42132         - application/xml
42133       produces:
42134         - application/json
42135         - application/xml
42136       responses:
42137         "default":
42138           description: Response codes found in [response codes](https://wiki.onap.org/).
42139       parameters:
42140         - name: pnf-name
42141           in: path
42142           description: unique name of Physical Network Function.
42143           required: true
42144           type: string
42145           example: __PNF-NAME__
42146         - name: interface-name
42147           in: path
42148           description: Name that identifies the link aggregate interface
42149           required: true
42150           type: string
42151           example: __INTERFACE-NAME__
42152         - name: interface-name
42153           in: path
42154           description: Name given to the interface
42155           required: true
42156           type: string
42157           example: __INTERFACE-NAME__
42158         - name: l3-interface-ipv4-address
42159           in: path
42160           description: IP address
42161           required: true
42162           type: string
42163           example: __L3-INTERFACE-IPV4-ADDRESS__
42164         - name: body
42165           in: body
42166           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42167           required: true
42168           schema:
42169             $ref: "#/definitions/l3-interface-ipv4-address-list"
42170     patch:
42171       tags:
42172         - Network
42173       summary: update an existing l3-interface-ipv4-address-list
42174       description: |
42175         Update an existing l3-interface-ipv4-address-list
42176         #
42177         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42178         The PUT operation will entirely replace an existing object.
42179         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42180         #
42181         Other differences between PUT and PATCH are:
42182         #
42183         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42184         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42185         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42186       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42187       consumes:
42188         - application/json
42189         - application/xml
42190       produces:
42191         - application/json
42192         - application/xml
42193       responses:
42194         "default":
42195           description: Response codes found in [response codes](https://wiki.onap.org/).
42196       parameters:
42197         - name: pnf-name
42198           in: path
42199           description: unique name of Physical Network Function.
42200           required: true
42201           type: string
42202           example: __PNF-NAME__
42203         - name: interface-name
42204           in: path
42205           description: Name that identifies the link aggregate interface
42206           required: true
42207           type: string
42208           example: __INTERFACE-NAME__
42209         - name: interface-name
42210           in: path
42211           description: Name given to the interface
42212           required: true
42213           type: string
42214           example: __INTERFACE-NAME__
42215         - name: l3-interface-ipv4-address
42216           in: path
42217           description: IP address
42218           required: true
42219           type: string
42220           example: __L3-INTERFACE-IPV4-ADDRESS__
42221         - name: body
42222           in: body
42223           description: l3-interface-ipv4-address-list object that needs to be updated.
42224           required: true
42225           schema:
42226             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42227     delete:
42228       tags:
42229         - Network
42230       summary: delete an existing l3-interface-ipv4-address-list
42231       description: delete an existing l3-interface-ipv4-address-list
42232       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42233       consumes:
42234         - application/json
42235         - application/xml
42236       produces:
42237         - application/json
42238         - application/xml
42239       responses:
42240         "default":
42241           description: Response codes found in [response codes](https://wiki.onap.org/).
42242       parameters:
42243         - name: pnf-name
42244           in: path
42245           description: unique name of Physical Network Function.
42246           required: true
42247           type: string
42248           example: __PNF-NAME__
42249         - name: interface-name
42250           in: path
42251           description: Name that identifies the link aggregate interface
42252           required: true
42253           type: string
42254           example: __INTERFACE-NAME__
42255         - name: interface-name
42256           in: path
42257           description: Name given to the interface
42258           required: true
42259           type: string
42260           example: __INTERFACE-NAME__
42261         - name: l3-interface-ipv4-address
42262           in: path
42263           description: IP address
42264           required: true
42265           type: string
42266           example: __L3-INTERFACE-IPV4-ADDRESS__
42267         - name: resource-version
42268           in: query
42269           description: resource-version for concurrency
42270           required: true
42271           type: string
42272   /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:
42273     put:
42274       tags:
42275         - Network
42276       summary: see node definition for valid relationships
42277       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42278       consumes:
42279         - application/json
42280         - application/xml
42281       produces:
42282         - application/json
42283         - application/xml
42284       responses:
42285         "default":
42286           description: Response codes found in [response codes](https://wiki.onap.org/).
42287       parameters:
42288         - name: pnf-name
42289           in: path
42290           description: unique name of Physical Network Function.
42291           required: true
42292           type: string
42293           example: __PNF-NAME__
42294         - name: interface-name
42295           in: path
42296           description: Name that identifies the link aggregate interface
42297           required: true
42298           type: string
42299           example: __INTERFACE-NAME__
42300         - name: interface-name
42301           in: path
42302           description: Name given to the interface
42303           required: true
42304           type: string
42305           example: __INTERFACE-NAME__
42306         - name: l3-interface-ipv6-address
42307           in: path
42308           description: IP address
42309           required: true
42310           type: string
42311           example: __L3-INTERFACE-IPV6-ADDRESS__
42312         - name: body
42313           in: body
42314           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42315           required: true
42316           schema:
42317             $ref: "#/definitions/relationship"
42318     delete:
42319       tags:
42320         - Network
42321       summary: delete an existing relationship
42322       description: delete an existing relationship
42323       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42324       consumes:
42325         - application/json
42326         - application/xml
42327       produces:
42328         - application/json
42329         - application/xml
42330       responses:
42331         "default":
42332           description: Response codes found in [response codes](https://wiki.onap.org/).
42333       parameters:
42334         - name: pnf-name
42335           in: path
42336           description: unique name of Physical Network Function.
42337           required: true
42338           type: string
42339           example: __PNF-NAME__
42340         - name: interface-name
42341           in: path
42342           description: Name that identifies the link aggregate interface
42343           required: true
42344           type: string
42345           example: __INTERFACE-NAME__
42346         - name: interface-name
42347           in: path
42348           description: Name given to the interface
42349           required: true
42350           type: string
42351           example: __INTERFACE-NAME__
42352         - name: l3-interface-ipv6-address
42353           in: path
42354           description: IP address
42355           required: true
42356           type: string
42357           example: __L3-INTERFACE-IPV6-ADDRESS__
42358   /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}:
42359     get:
42360       tags:
42361         - Network
42362       summary: returns l3-interface-ipv6-address-list
42363       description: returns l3-interface-ipv6-address-list
42364       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42365       produces:
42366         - application/json
42367         - application/xml
42368       responses:
42369         "200":
42370           description: successful operation
42371           schema:
42372               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42373         "default":
42374           description: Response codes found in [response codes](https://wiki.onap.org/).
42375       parameters:
42376         - name: pnf-name
42377           in: path
42378           description: unique name of Physical Network Function.
42379           required: true
42380           type: string
42381           example: __PNF-NAME__
42382         - name: interface-name
42383           in: path
42384           description: Name that identifies the link aggregate interface
42385           required: true
42386           type: string
42387           example: __INTERFACE-NAME__
42388         - name: interface-name
42389           in: path
42390           description: Name given to the interface
42391           required: true
42392           type: string
42393           example: __INTERFACE-NAME__
42394         - name: l3-interface-ipv6-address
42395           in: path
42396           description: IP address
42397           required: true
42398           type: string
42399           example: __L3-INTERFACE-IPV6-ADDRESS__
42400     put:
42401       tags:
42402         - Network
42403       summary: create or update an existing l3-interface-ipv6-address-list
42404       description: |
42405         Create or update an existing l3-interface-ipv6-address-list.
42406         #
42407         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42408       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42409       consumes:
42410         - application/json
42411         - application/xml
42412       produces:
42413         - application/json
42414         - application/xml
42415       responses:
42416         "default":
42417           description: Response codes found in [response codes](https://wiki.onap.org/).
42418       parameters:
42419         - name: pnf-name
42420           in: path
42421           description: unique name of Physical Network Function.
42422           required: true
42423           type: string
42424           example: __PNF-NAME__
42425         - name: interface-name
42426           in: path
42427           description: Name that identifies the link aggregate interface
42428           required: true
42429           type: string
42430           example: __INTERFACE-NAME__
42431         - name: interface-name
42432           in: path
42433           description: Name given to the interface
42434           required: true
42435           type: string
42436           example: __INTERFACE-NAME__
42437         - name: l3-interface-ipv6-address
42438           in: path
42439           description: IP address
42440           required: true
42441           type: string
42442           example: __L3-INTERFACE-IPV6-ADDRESS__
42443         - name: body
42444           in: body
42445           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42446           required: true
42447           schema:
42448             $ref: "#/definitions/l3-interface-ipv6-address-list"
42449     patch:
42450       tags:
42451         - Network
42452       summary: update an existing l3-interface-ipv6-address-list
42453       description: |
42454         Update an existing l3-interface-ipv6-address-list
42455         #
42456         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42457         The PUT operation will entirely replace an existing object.
42458         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42459         #
42460         Other differences between PUT and PATCH are:
42461         #
42462         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42463         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42464         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42465       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42466       consumes:
42467         - application/json
42468         - application/xml
42469       produces:
42470         - application/json
42471         - application/xml
42472       responses:
42473         "default":
42474           description: Response codes found in [response codes](https://wiki.onap.org/).
42475       parameters:
42476         - name: pnf-name
42477           in: path
42478           description: unique name of Physical Network Function.
42479           required: true
42480           type: string
42481           example: __PNF-NAME__
42482         - name: interface-name
42483           in: path
42484           description: Name that identifies the link aggregate interface
42485           required: true
42486           type: string
42487           example: __INTERFACE-NAME__
42488         - name: interface-name
42489           in: path
42490           description: Name given to the interface
42491           required: true
42492           type: string
42493           example: __INTERFACE-NAME__
42494         - name: l3-interface-ipv6-address
42495           in: path
42496           description: IP address
42497           required: true
42498           type: string
42499           example: __L3-INTERFACE-IPV6-ADDRESS__
42500         - name: body
42501           in: body
42502           description: l3-interface-ipv6-address-list object that needs to be updated.
42503           required: true
42504           schema:
42505             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42506     delete:
42507       tags:
42508         - Network
42509       summary: delete an existing l3-interface-ipv6-address-list
42510       description: delete an existing l3-interface-ipv6-address-list
42511       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42512       consumes:
42513         - application/json
42514         - application/xml
42515       produces:
42516         - application/json
42517         - application/xml
42518       responses:
42519         "default":
42520           description: Response codes found in [response codes](https://wiki.onap.org/).
42521       parameters:
42522         - name: pnf-name
42523           in: path
42524           description: unique name of Physical Network Function.
42525           required: true
42526           type: string
42527           example: __PNF-NAME__
42528         - name: interface-name
42529           in: path
42530           description: Name that identifies the link aggregate interface
42531           required: true
42532           type: string
42533           example: __INTERFACE-NAME__
42534         - name: interface-name
42535           in: path
42536           description: Name given to the interface
42537           required: true
42538           type: string
42539           example: __INTERFACE-NAME__
42540         - name: l3-interface-ipv6-address
42541           in: path
42542           description: IP address
42543           required: true
42544           type: string
42545           example: __L3-INTERFACE-IPV6-ADDRESS__
42546         - name: resource-version
42547           in: query
42548           description: resource-version for concurrency
42549           required: true
42550           type: string
42551   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
42552     get:
42553       tags:
42554         - Network
42555       summary: returns l-interface
42556       description: returns l-interface
42557       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42558       produces:
42559         - application/json
42560         - application/xml
42561       responses:
42562         "200":
42563           description: successful operation
42564           schema:
42565               $ref: "#/getDefinitions/l-interface"
42566         "default":
42567           description: Response codes found in [response codes](https://wiki.onap.org/).
42568       parameters:
42569         - name: pnf-name
42570           in: path
42571           description: unique name of Physical Network Function.
42572           required: true
42573           type: string
42574           example: __PNF-NAME__
42575         - name: interface-name
42576           in: path
42577           description: Name that identifies the link aggregate interface
42578           required: true
42579           type: string
42580           example: __INTERFACE-NAME__
42581         - name: interface-name
42582           in: path
42583           description: Name given to the interface
42584           required: true
42585           type: string
42586           example: __INTERFACE-NAME__
42587     put:
42588       tags:
42589         - Network
42590       summary: create or update an existing l-interface
42591       description: |
42592         Create or update an existing l-interface.
42593         #
42594         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42595       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42596       consumes:
42597         - application/json
42598         - application/xml
42599       produces:
42600         - application/json
42601         - application/xml
42602       responses:
42603         "default":
42604           description: Response codes found in [response codes](https://wiki.onap.org/).
42605       parameters:
42606         - name: pnf-name
42607           in: path
42608           description: unique name of Physical Network Function.
42609           required: true
42610           type: string
42611           example: __PNF-NAME__
42612         - name: interface-name
42613           in: path
42614           description: Name that identifies the link aggregate interface
42615           required: true
42616           type: string
42617           example: __INTERFACE-NAME__
42618         - name: interface-name
42619           in: path
42620           description: Name given to the interface
42621           required: true
42622           type: string
42623           example: __INTERFACE-NAME__
42624         - name: body
42625           in: body
42626           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
42627           required: true
42628           schema:
42629             $ref: "#/definitions/l-interface"
42630     patch:
42631       tags:
42632         - Network
42633       summary: update an existing l-interface
42634       description: |
42635         Update an existing l-interface
42636         #
42637         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42638         The PUT operation will entirely replace an existing object.
42639         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42640         #
42641         Other differences between PUT and PATCH are:
42642         #
42643         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42644         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42645         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42646       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42647       consumes:
42648         - application/json
42649         - application/xml
42650       produces:
42651         - application/json
42652         - application/xml
42653       responses:
42654         "default":
42655           description: Response codes found in [response codes](https://wiki.onap.org/).
42656       parameters:
42657         - name: pnf-name
42658           in: path
42659           description: unique name of Physical Network Function.
42660           required: true
42661           type: string
42662           example: __PNF-NAME__
42663         - name: interface-name
42664           in: path
42665           description: Name that identifies the link aggregate interface
42666           required: true
42667           type: string
42668           example: __INTERFACE-NAME__
42669         - name: interface-name
42670           in: path
42671           description: Name given to the interface
42672           required: true
42673           type: string
42674           example: __INTERFACE-NAME__
42675         - name: body
42676           in: body
42677           description: l-interface object that needs to be updated.
42678           required: true
42679           schema:
42680             $ref: "#/patchDefinitions/l-interface"
42681     delete:
42682       tags:
42683         - Network
42684       summary: delete an existing l-interface
42685       description: delete an existing l-interface
42686       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42687       consumes:
42688         - application/json
42689         - application/xml
42690       produces:
42691         - application/json
42692         - application/xml
42693       responses:
42694         "default":
42695           description: Response codes found in [response codes](https://wiki.onap.org/).
42696       parameters:
42697         - name: pnf-name
42698           in: path
42699           description: unique name of Physical Network Function.
42700           required: true
42701           type: string
42702           example: __PNF-NAME__
42703         - name: interface-name
42704           in: path
42705           description: Name that identifies the link aggregate interface
42706           required: true
42707           type: string
42708           example: __INTERFACE-NAME__
42709         - name: interface-name
42710           in: path
42711           description: Name given to the interface
42712           required: true
42713           type: string
42714           example: __INTERFACE-NAME__
42715         - name: resource-version
42716           in: query
42717           description: resource-version for concurrency
42718           required: true
42719           type: string
42720   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
42721     get:
42722       tags:
42723         - Network
42724       summary: returns l-interfaces
42725       description: returns l-interfaces
42726       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
42727       produces:
42728         - application/json
42729         - application/xml
42730       responses:
42731         "200":
42732           description: successful operation
42733           schema:
42734               $ref: "#/getDefinitions/l-interfaces"
42735         "default":
42736           description: Response codes found in [response codes](https://wiki.onap.org/).
42737       parameters:
42738         - name: pnf-name
42739           in: path
42740           description: unique name of Physical Network Function.
42741           required: true
42742           type: string
42743           example: __PNF-NAME__
42744         - name: interface-name
42745           in: path
42746           description: Name that identifies the link aggregate interface
42747           required: true
42748           type: string
42749           example: __INTERFACE-NAME__
42750         - name: interface-name
42751           in: query
42752           description:
42753           required: false
42754           type: string
42755         - name: interface-id
42756           in: query
42757           description:
42758           required: false
42759           type: string
42760         - name: macaddr
42761           in: query
42762           description:
42763           required: false
42764           type: string
42765         - name: network-name
42766           in: query
42767           description:
42768           required: false
42769           type: string
42770   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
42771     get:
42772       tags:
42773         - Network
42774       summary: returns lag-interface
42775       description: returns lag-interface
42776       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
42777       produces:
42778         - application/json
42779         - application/xml
42780       responses:
42781         "200":
42782           description: successful operation
42783           schema:
42784               $ref: "#/getDefinitions/lag-interface"
42785         "default":
42786           description: Response codes found in [response codes](https://wiki.onap.org/).
42787       parameters:
42788         - name: pnf-name
42789           in: path
42790           description: unique name of Physical Network Function.
42791           required: true
42792           type: string
42793           example: __PNF-NAME__
42794         - name: interface-name
42795           in: path
42796           description: Name that identifies the link aggregate interface
42797           required: true
42798           type: string
42799           example: __INTERFACE-NAME__
42800     put:
42801       tags:
42802         - Network
42803       summary: create or update an existing lag-interface
42804       description: |
42805         Create or update an existing lag-interface.
42806         #
42807         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42808       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
42809       consumes:
42810         - application/json
42811         - application/xml
42812       produces:
42813         - application/json
42814         - application/xml
42815       responses:
42816         "default":
42817           description: Response codes found in [response codes](https://wiki.onap.org/).
42818       parameters:
42819         - name: pnf-name
42820           in: path
42821           description: unique name of Physical Network Function.
42822           required: true
42823           type: string
42824           example: __PNF-NAME__
42825         - name: interface-name
42826           in: path
42827           description: Name that identifies the link aggregate interface
42828           required: true
42829           type: string
42830           example: __INTERFACE-NAME__
42831         - name: body
42832           in: body
42833           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
42834           required: true
42835           schema:
42836             $ref: "#/definitions/lag-interface"
42837     patch:
42838       tags:
42839         - Network
42840       summary: update an existing lag-interface
42841       description: |
42842         Update an existing lag-interface
42843         #
42844         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42845         The PUT operation will entirely replace an existing object.
42846         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42847         #
42848         Other differences between PUT and PATCH are:
42849         #
42850         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42851         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42852         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42853       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
42854       consumes:
42855         - application/json
42856         - application/xml
42857       produces:
42858         - application/json
42859         - application/xml
42860       responses:
42861         "default":
42862           description: Response codes found in [response codes](https://wiki.onap.org/).
42863       parameters:
42864         - name: pnf-name
42865           in: path
42866           description: unique name of Physical Network Function.
42867           required: true
42868           type: string
42869           example: __PNF-NAME__
42870         - name: interface-name
42871           in: path
42872           description: Name that identifies the link aggregate interface
42873           required: true
42874           type: string
42875           example: __INTERFACE-NAME__
42876         - name: body
42877           in: body
42878           description: lag-interface object that needs to be updated.
42879           required: true
42880           schema:
42881             $ref: "#/patchDefinitions/lag-interface"
42882     delete:
42883       tags:
42884         - Network
42885       summary: delete an existing lag-interface
42886       description: delete an existing lag-interface
42887       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
42888       consumes:
42889         - application/json
42890         - application/xml
42891       produces:
42892         - application/json
42893         - application/xml
42894       responses:
42895         "default":
42896           description: Response codes found in [response codes](https://wiki.onap.org/).
42897       parameters:
42898         - name: pnf-name
42899           in: path
42900           description: unique name of Physical Network Function.
42901           required: true
42902           type: string
42903           example: __PNF-NAME__
42904         - name: interface-name
42905           in: path
42906           description: Name that identifies the link aggregate interface
42907           required: true
42908           type: string
42909           example: __INTERFACE-NAME__
42910         - name: resource-version
42911           in: query
42912           description: resource-version for concurrency
42913           required: true
42914           type: string
42915   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
42916     get:
42917       tags:
42918         - Network
42919       summary: returns lag-interfaces
42920       description: returns lag-interfaces
42921       operationId: getNetworkPnfsPnfLagInterfaces
42922       produces:
42923         - application/json
42924         - application/xml
42925       responses:
42926         "200":
42927           description: successful operation
42928           schema:
42929               $ref: "#/getDefinitions/lag-interfaces"
42930         "default":
42931           description: Response codes found in [response codes](https://wiki.onap.org/).
42932       parameters:
42933         - name: pnf-name
42934           in: path
42935           description: unique name of Physical Network Function.
42936           required: true
42937           type: string
42938           example: __PNF-NAME__
42939         - name: interface-name
42940           in: query
42941           description:
42942           required: false
42943           type: string
42944         - name: interface-id
42945           in: query
42946           description:
42947           required: false
42948           type: string
42949         - name: interface-role
42950           in: query
42951           description:
42952           required: false
42953           type: string
42954   /network/pnfs/pnf/{pnf-name}:
42955     get:
42956       tags:
42957         - Network
42958       summary: returns pnf
42959       description: returns pnf
42960       operationId: getNetworkPnfsPnf
42961       produces:
42962         - application/json
42963         - application/xml
42964       responses:
42965         "200":
42966           description: successful operation
42967           schema:
42968               $ref: "#/getDefinitions/pnf"
42969         "default":
42970           description: Response codes found in [response codes](https://wiki.onap.org/).
42971       parameters:
42972         - name: pnf-name
42973           in: path
42974           description: unique name of Physical Network Function.
42975           required: true
42976           type: string
42977           example: __PNF-NAME__
42978     put:
42979       tags:
42980         - Network
42981       summary: create or update an existing pnf
42982       description: |
42983         Create or update an existing pnf.
42984         #
42985         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42986       operationId: createOrUpdateNetworkPnfsPnf
42987       consumes:
42988         - application/json
42989         - application/xml
42990       produces:
42991         - application/json
42992         - application/xml
42993       responses:
42994         "default":
42995           description: Response codes found in [response codes](https://wiki.onap.org/).
42996       parameters:
42997         - name: pnf-name
42998           in: path
42999           description: unique name of Physical Network Function.
43000           required: true
43001           type: string
43002           example: __PNF-NAME__
43003         - name: body
43004           in: body
43005           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
43006           required: true
43007           schema:
43008             $ref: "#/definitions/pnf"
43009     patch:
43010       tags:
43011         - Network
43012       summary: update an existing pnf
43013       description: |
43014         Update an existing pnf
43015         #
43016         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43017         The PUT operation will entirely replace an existing object.
43018         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43019         #
43020         Other differences between PUT and PATCH are:
43021         #
43022         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43023         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43024         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43025       operationId: UpdateNetworkPnfsPnf
43026       consumes:
43027         - application/json
43028         - application/xml
43029       produces:
43030         - application/json
43031         - application/xml
43032       responses:
43033         "default":
43034           description: Response codes found in [response codes](https://wiki.onap.org/).
43035       parameters:
43036         - name: pnf-name
43037           in: path
43038           description: unique name of Physical Network Function.
43039           required: true
43040           type: string
43041           example: __PNF-NAME__
43042         - name: body
43043           in: body
43044           description: pnf object that needs to be updated.
43045           required: true
43046           schema:
43047             $ref: "#/patchDefinitions/pnf"
43048     delete:
43049       tags:
43050         - Network
43051       summary: delete an existing pnf
43052       description: delete an existing pnf
43053       operationId: deleteNetworkPnfsPnf
43054       consumes:
43055         - application/json
43056         - application/xml
43057       produces:
43058         - application/json
43059         - application/xml
43060       responses:
43061         "default":
43062           description: Response codes found in [response codes](https://wiki.onap.org/).
43063       parameters:
43064         - name: pnf-name
43065           in: path
43066           description: unique name of Physical Network Function.
43067           required: true
43068           type: string
43069           example: __PNF-NAME__
43070         - name: resource-version
43071           in: query
43072           description: resource-version for concurrency
43073           required: true
43074           type: string
43075   /network/pnfs:
43076     get:
43077       tags:
43078         - Network
43079       summary: returns pnfs
43080       description: returns pnfs
43081       operationId: getNetworkPnfs
43082       produces:
43083         - application/json
43084         - application/xml
43085       responses:
43086         "200":
43087           description: successful operation
43088           schema:
43089               $ref: "#/getDefinitions/pnfs"
43090         "default":
43091           description: Response codes found in [response codes](https://wiki.onap.org/).
43092       parameters:
43093         - name: pnf-name
43094           in: query
43095           description:
43096           required: false
43097           type: string
43098         - name: inv-status
43099           in: query
43100           description:
43101           required: false
43102           type: string
43103   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
43104     put:
43105       tags:
43106         - Network
43107       summary: see node definition for valid relationships
43108       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
43109       consumes:
43110         - application/json
43111         - application/xml
43112       produces:
43113         - application/json
43114         - application/xml
43115       responses:
43116         "default":
43117           description: Response codes found in [response codes](https://wiki.onap.org/).
43118       parameters:
43119         - name: link-name
43120           in: path
43121           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43122           required: true
43123           type: string
43124           example: __LINK-NAME__
43125         - name: body
43126           in: body
43127           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
43128           required: true
43129           schema:
43130             $ref: "#/definitions/relationship"
43131     delete:
43132       tags:
43133         - Network
43134       summary: delete an existing relationship
43135       description: delete an existing relationship
43136       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
43137       consumes:
43138         - application/json
43139         - application/xml
43140       produces:
43141         - application/json
43142         - application/xml
43143       responses:
43144         "default":
43145           description: Response codes found in [response codes](https://wiki.onap.org/).
43146       parameters:
43147         - name: link-name
43148           in: path
43149           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43150           required: true
43151           type: string
43152           example: __LINK-NAME__
43153   /network/physical-links/physical-link/{link-name}:
43154     get:
43155       tags:
43156         - Network
43157       summary: returns physical-link
43158       description: returns physical-link
43159       operationId: getNetworkPhysicalLinksPhysicalLink
43160       produces:
43161         - application/json
43162         - application/xml
43163       responses:
43164         "200":
43165           description: successful operation
43166           schema:
43167               $ref: "#/getDefinitions/physical-link"
43168         "default":
43169           description: Response codes found in [response codes](https://wiki.onap.org/).
43170       parameters:
43171         - name: link-name
43172           in: path
43173           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43174           required: true
43175           type: string
43176           example: __LINK-NAME__
43177     put:
43178       tags:
43179         - Network
43180       summary: create or update an existing physical-link
43181       description: |
43182         Create or update an existing physical-link.
43183         #
43184         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43185       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
43186       consumes:
43187         - application/json
43188         - application/xml
43189       produces:
43190         - application/json
43191         - application/xml
43192       responses:
43193         "default":
43194           description: Response codes found in [response codes](https://wiki.onap.org/).
43195       parameters:
43196         - name: link-name
43197           in: path
43198           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43199           required: true
43200           type: string
43201           example: __LINK-NAME__
43202         - name: body
43203           in: body
43204           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
43205           required: true
43206           schema:
43207             $ref: "#/definitions/physical-link"
43208     patch:
43209       tags:
43210         - Network
43211       summary: update an existing physical-link
43212       description: |
43213         Update an existing physical-link
43214         #
43215         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43216         The PUT operation will entirely replace an existing object.
43217         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43218         #
43219         Other differences between PUT and PATCH are:
43220         #
43221         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43222         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43223         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43224       operationId: UpdateNetworkPhysicalLinksPhysicalLink
43225       consumes:
43226         - application/json
43227         - application/xml
43228       produces:
43229         - application/json
43230         - application/xml
43231       responses:
43232         "default":
43233           description: Response codes found in [response codes](https://wiki.onap.org/).
43234       parameters:
43235         - name: link-name
43236           in: path
43237           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43238           required: true
43239           type: string
43240           example: __LINK-NAME__
43241         - name: body
43242           in: body
43243           description: physical-link object that needs to be updated.
43244           required: true
43245           schema:
43246             $ref: "#/patchDefinitions/physical-link"
43247     delete:
43248       tags:
43249         - Network
43250       summary: delete an existing physical-link
43251       description: delete an existing physical-link
43252       operationId: deleteNetworkPhysicalLinksPhysicalLink
43253       consumes:
43254         - application/json
43255         - application/xml
43256       produces:
43257         - application/json
43258         - application/xml
43259       responses:
43260         "default":
43261           description: Response codes found in [response codes](https://wiki.onap.org/).
43262       parameters:
43263         - name: link-name
43264           in: path
43265           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43266           required: true
43267           type: string
43268           example: __LINK-NAME__
43269         - name: resource-version
43270           in: query
43271           description: resource-version for concurrency
43272           required: true
43273           type: string
43274   /network/physical-links:
43275     get:
43276       tags:
43277         - Network
43278       summary: returns physical-links
43279       description: returns physical-links
43280       operationId: getNetworkPhysicalLinks
43281       produces:
43282         - application/json
43283         - application/xml
43284       responses:
43285         "200":
43286           description: successful operation
43287           schema:
43288               $ref: "#/getDefinitions/physical-links"
43289         "default":
43290           description: Response codes found in [response codes](https://wiki.onap.org/).
43291       parameters:
43292         - name: link-name
43293           in: query
43294           description:
43295           required: false
43296           type: string
43297         - name: circuit-id
43298           in: query
43299           description:
43300           required: false
43301           type: string
43302   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
43303     put:
43304       tags:
43305         - Network
43306       summary: see node definition for valid relationships
43307       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43308       consumes:
43309         - application/json
43310         - application/xml
43311       produces:
43312         - application/json
43313         - application/xml
43314       responses:
43315         "default":
43316           description: Response codes found in [response codes](https://wiki.onap.org/).
43317       parameters:
43318         - name: ipsec-configuration-id
43319           in: path
43320           description: UUID of this configuration
43321           required: true
43322           type: string
43323           example: __IPSEC-CONFIGURATION-ID__
43324         - name: body
43325           in: body
43326           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
43327           required: true
43328           schema:
43329             $ref: "#/definitions/relationship"
43330     delete:
43331       tags:
43332         - Network
43333       summary: delete an existing relationship
43334       description: delete an existing relationship
43335       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43336       consumes:
43337         - application/json
43338         - application/xml
43339       produces:
43340         - application/json
43341         - application/xml
43342       responses:
43343         "default":
43344           description: Response codes found in [response codes](https://wiki.onap.org/).
43345       parameters:
43346         - name: ipsec-configuration-id
43347           in: path
43348           description: UUID of this configuration
43349           required: true
43350           type: string
43351           example: __IPSEC-CONFIGURATION-ID__
43352   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
43353     put:
43354       tags:
43355         - Network
43356       summary: see node definition for valid relationships
43357       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43358       consumes:
43359         - application/json
43360         - application/xml
43361       produces:
43362         - application/json
43363         - application/xml
43364       responses:
43365         "default":
43366           description: Response codes found in [response codes](https://wiki.onap.org/).
43367       parameters:
43368         - name: ipsec-configuration-id
43369           in: path
43370           description: UUID of this configuration
43371           required: true
43372           type: string
43373           example: __IPSEC-CONFIGURATION-ID__
43374         - name: vig-address-type
43375           in: path
43376           description: indicates whether the VIG is for AVPN or INTERNET
43377           required: true
43378           type: string
43379           example: __VIG-ADDRESS-TYPE__
43380         - name: body
43381           in: body
43382           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43383           required: true
43384           schema:
43385             $ref: "#/definitions/relationship"
43386     delete:
43387       tags:
43388         - Network
43389       summary: delete an existing relationship
43390       description: delete an existing relationship
43391       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43392       consumes:
43393         - application/json
43394         - application/xml
43395       produces:
43396         - application/json
43397         - application/xml
43398       responses:
43399         "default":
43400           description: Response codes found in [response codes](https://wiki.onap.org/).
43401       parameters:
43402         - name: ipsec-configuration-id
43403           in: path
43404           description: UUID of this configuration
43405           required: true
43406           type: string
43407           example: __IPSEC-CONFIGURATION-ID__
43408         - name: vig-address-type
43409           in: path
43410           description: indicates whether the VIG is for AVPN or INTERNET
43411           required: true
43412           type: string
43413           example: __VIG-ADDRESS-TYPE__
43414   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
43415     get:
43416       tags:
43417         - Network
43418       summary: returns vig-server
43419       description: returns vig-server
43420       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43421       produces:
43422         - application/json
43423         - application/xml
43424       responses:
43425         "200":
43426           description: successful operation
43427           schema:
43428               $ref: "#/getDefinitions/vig-server"
43429         "default":
43430           description: Response codes found in [response codes](https://wiki.onap.org/).
43431       parameters:
43432         - name: ipsec-configuration-id
43433           in: path
43434           description: UUID of this configuration
43435           required: true
43436           type: string
43437           example: __IPSEC-CONFIGURATION-ID__
43438         - name: vig-address-type
43439           in: path
43440           description: indicates whether the VIG is for AVPN or INTERNET
43441           required: true
43442           type: string
43443           example: __VIG-ADDRESS-TYPE__
43444     put:
43445       tags:
43446         - Network
43447       summary: create or update an existing vig-server
43448       description: |
43449         Create or update an existing vig-server.
43450         #
43451         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43452       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43453       consumes:
43454         - application/json
43455         - application/xml
43456       produces:
43457         - application/json
43458         - application/xml
43459       responses:
43460         "default":
43461           description: Response codes found in [response codes](https://wiki.onap.org/).
43462       parameters:
43463         - name: ipsec-configuration-id
43464           in: path
43465           description: UUID of this configuration
43466           required: true
43467           type: string
43468           example: __IPSEC-CONFIGURATION-ID__
43469         - name: vig-address-type
43470           in: path
43471           description: indicates whether the VIG is for AVPN or INTERNET
43472           required: true
43473           type: string
43474           example: __VIG-ADDRESS-TYPE__
43475         - name: body
43476           in: body
43477           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43478           required: true
43479           schema:
43480             $ref: "#/definitions/vig-server"
43481     patch:
43482       tags:
43483         - Network
43484       summary: update an existing vig-server
43485       description: |
43486         Update an existing vig-server
43487         #
43488         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43489         The PUT operation will entirely replace an existing object.
43490         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43491         #
43492         Other differences between PUT and PATCH are:
43493         #
43494         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43495         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43496         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43497       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43498       consumes:
43499         - application/json
43500         - application/xml
43501       produces:
43502         - application/json
43503         - application/xml
43504       responses:
43505         "default":
43506           description: Response codes found in [response codes](https://wiki.onap.org/).
43507       parameters:
43508         - name: ipsec-configuration-id
43509           in: path
43510           description: UUID of this configuration
43511           required: true
43512           type: string
43513           example: __IPSEC-CONFIGURATION-ID__
43514         - name: vig-address-type
43515           in: path
43516           description: indicates whether the VIG is for AVPN or INTERNET
43517           required: true
43518           type: string
43519           example: __VIG-ADDRESS-TYPE__
43520         - name: body
43521           in: body
43522           description: vig-server object that needs to be updated.
43523           required: true
43524           schema:
43525             $ref: "#/patchDefinitions/vig-server"
43526     delete:
43527       tags:
43528         - Network
43529       summary: delete an existing vig-server
43530       description: delete an existing vig-server
43531       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43532       consumes:
43533         - application/json
43534         - application/xml
43535       produces:
43536         - application/json
43537         - application/xml
43538       responses:
43539         "default":
43540           description: Response codes found in [response codes](https://wiki.onap.org/).
43541       parameters:
43542         - name: ipsec-configuration-id
43543           in: path
43544           description: UUID of this configuration
43545           required: true
43546           type: string
43547           example: __IPSEC-CONFIGURATION-ID__
43548         - name: vig-address-type
43549           in: path
43550           description: indicates whether the VIG is for AVPN or INTERNET
43551           required: true
43552           type: string
43553           example: __VIG-ADDRESS-TYPE__
43554         - name: resource-version
43555           in: query
43556           description: resource-version for concurrency
43557           required: true
43558           type: string
43559   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
43560     get:
43561       tags:
43562         - Network
43563       summary: returns vig-servers
43564       description: returns vig-servers
43565       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
43566       produces:
43567         - application/json
43568         - application/xml
43569       responses:
43570         "200":
43571           description: successful operation
43572           schema:
43573               $ref: "#/getDefinitions/vig-servers"
43574         "default":
43575           description: Response codes found in [response codes](https://wiki.onap.org/).
43576       parameters:
43577         - name: ipsec-configuration-id
43578           in: path
43579           description: UUID of this configuration
43580           required: true
43581           type: string
43582           example: __IPSEC-CONFIGURATION-ID__
43583         - name: vig-address-type
43584           in: query
43585           description:
43586           required: false
43587           type: string
43588   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
43589     get:
43590       tags:
43591         - Network
43592       summary: returns ipsec-configuration
43593       description: returns ipsec-configuration
43594       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
43595       produces:
43596         - application/json
43597         - application/xml
43598       responses:
43599         "200":
43600           description: successful operation
43601           schema:
43602               $ref: "#/getDefinitions/ipsec-configuration"
43603         "default":
43604           description: Response codes found in [response codes](https://wiki.onap.org/).
43605       parameters:
43606         - name: ipsec-configuration-id
43607           in: path
43608           description: UUID of this configuration
43609           required: true
43610           type: string
43611           example: __IPSEC-CONFIGURATION-ID__
43612     put:
43613       tags:
43614         - Network
43615       summary: create or update an existing ipsec-configuration
43616       description: |
43617         Create or update an existing ipsec-configuration.
43618         #
43619         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43620       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
43621       consumes:
43622         - application/json
43623         - application/xml
43624       produces:
43625         - application/json
43626         - application/xml
43627       responses:
43628         "default":
43629           description: Response codes found in [response codes](https://wiki.onap.org/).
43630       parameters:
43631         - name: ipsec-configuration-id
43632           in: path
43633           description: UUID of this configuration
43634           required: true
43635           type: string
43636           example: __IPSEC-CONFIGURATION-ID__
43637         - name: body
43638           in: body
43639           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
43640           required: true
43641           schema:
43642             $ref: "#/definitions/ipsec-configuration"
43643     patch:
43644       tags:
43645         - Network
43646       summary: update an existing ipsec-configuration
43647       description: |
43648         Update an existing ipsec-configuration
43649         #
43650         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43651         The PUT operation will entirely replace an existing object.
43652         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43653         #
43654         Other differences between PUT and PATCH are:
43655         #
43656         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43657         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43658         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43659       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
43660       consumes:
43661         - application/json
43662         - application/xml
43663       produces:
43664         - application/json
43665         - application/xml
43666       responses:
43667         "default":
43668           description: Response codes found in [response codes](https://wiki.onap.org/).
43669       parameters:
43670         - name: ipsec-configuration-id
43671           in: path
43672           description: UUID of this configuration
43673           required: true
43674           type: string
43675           example: __IPSEC-CONFIGURATION-ID__
43676         - name: body
43677           in: body
43678           description: ipsec-configuration object that needs to be updated.
43679           required: true
43680           schema:
43681             $ref: "#/patchDefinitions/ipsec-configuration"
43682     delete:
43683       tags:
43684         - Network
43685       summary: delete an existing ipsec-configuration
43686       description: delete an existing ipsec-configuration
43687       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
43688       consumes:
43689         - application/json
43690         - application/xml
43691       produces:
43692         - application/json
43693         - application/xml
43694       responses:
43695         "default":
43696           description: Response codes found in [response codes](https://wiki.onap.org/).
43697       parameters:
43698         - name: ipsec-configuration-id
43699           in: path
43700           description: UUID of this configuration
43701           required: true
43702           type: string
43703           example: __IPSEC-CONFIGURATION-ID__
43704         - name: resource-version
43705           in: query
43706           description: resource-version for concurrency
43707           required: true
43708           type: string
43709   /network/ipsec-configurations:
43710     get:
43711       tags:
43712         - Network
43713       summary: returns ipsec-configurations
43714       description: returns ipsec-configurations
43715       operationId: getNetworkIpsecConfigurations
43716       produces:
43717         - application/json
43718         - application/xml
43719       responses:
43720         "200":
43721           description: successful operation
43722           schema:
43723               $ref: "#/getDefinitions/ipsec-configurations"
43724         "default":
43725           description: Response codes found in [response codes](https://wiki.onap.org/).
43726       parameters:
43727         - name: ipsec-configuration-id
43728           in: query
43729           description:
43730           required: false
43731           type: string
43732   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
43733     put:
43734       tags:
43735         - Network
43736       summary: see node definition for valid relationships
43737       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43738       consumes:
43739         - application/json
43740         - application/xml
43741       produces:
43742         - application/json
43743         - application/xml
43744       responses:
43745         "default":
43746           description: Response codes found in [response codes](https://wiki.onap.org/).
43747       parameters:
43748         - name: route-table-reference-id
43749           in: path
43750           description: Route Table Reference id, UUID assigned to this instance.
43751           required: true
43752           type: string
43753           example: __ROUTE-TABLE-REFERENCE-ID__
43754         - name: body
43755           in: body
43756           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
43757           required: true
43758           schema:
43759             $ref: "#/definitions/relationship"
43760     delete:
43761       tags:
43762         - Network
43763       summary: delete an existing relationship
43764       description: delete an existing relationship
43765       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43766       consumes:
43767         - application/json
43768         - application/xml
43769       produces:
43770         - application/json
43771         - application/xml
43772       responses:
43773         "default":
43774           description: Response codes found in [response codes](https://wiki.onap.org/).
43775       parameters:
43776         - name: route-table-reference-id
43777           in: path
43778           description: Route Table Reference id, UUID assigned to this instance.
43779           required: true
43780           type: string
43781           example: __ROUTE-TABLE-REFERENCE-ID__
43782   /network/route-table-references/route-table-reference/{route-table-reference-id}:
43783     get:
43784       tags:
43785         - Network
43786       summary: returns route-table-reference
43787       description: returns route-table-reference
43788       operationId: getNetworkRouteTableReferencesRouteTableReference
43789       produces:
43790         - application/json
43791         - application/xml
43792       responses:
43793         "200":
43794           description: successful operation
43795           schema:
43796               $ref: "#/getDefinitions/route-table-reference"
43797         "default":
43798           description: Response codes found in [response codes](https://wiki.onap.org/).
43799       parameters:
43800         - name: route-table-reference-id
43801           in: path
43802           description: Route Table Reference id, UUID assigned to this instance.
43803           required: true
43804           type: string
43805           example: __ROUTE-TABLE-REFERENCE-ID__
43806     put:
43807       tags:
43808         - Network
43809       summary: create or update an existing route-table-reference
43810       description: |
43811         Create or update an existing route-table-reference.
43812         #
43813         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43814       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
43815       consumes:
43816         - application/json
43817         - application/xml
43818       produces:
43819         - application/json
43820         - application/xml
43821       responses:
43822         "default":
43823           description: Response codes found in [response codes](https://wiki.onap.org/).
43824       parameters:
43825         - name: route-table-reference-id
43826           in: path
43827           description: Route Table Reference id, UUID assigned to this instance.
43828           required: true
43829           type: string
43830           example: __ROUTE-TABLE-REFERENCE-ID__
43831         - name: body
43832           in: body
43833           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
43834           required: true
43835           schema:
43836             $ref: "#/definitions/route-table-reference"
43837     patch:
43838       tags:
43839         - Network
43840       summary: update an existing route-table-reference
43841       description: |
43842         Update an existing route-table-reference
43843         #
43844         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43845         The PUT operation will entirely replace an existing object.
43846         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43847         #
43848         Other differences between PUT and PATCH are:
43849         #
43850         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43851         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43852         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43853       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
43854       consumes:
43855         - application/json
43856         - application/xml
43857       produces:
43858         - application/json
43859         - application/xml
43860       responses:
43861         "default":
43862           description: Response codes found in [response codes](https://wiki.onap.org/).
43863       parameters:
43864         - name: route-table-reference-id
43865           in: path
43866           description: Route Table Reference id, UUID assigned to this instance.
43867           required: true
43868           type: string
43869           example: __ROUTE-TABLE-REFERENCE-ID__
43870         - name: body
43871           in: body
43872           description: route-table-reference object that needs to be updated.
43873           required: true
43874           schema:
43875             $ref: "#/patchDefinitions/route-table-reference"
43876     delete:
43877       tags:
43878         - Network
43879       summary: delete an existing route-table-reference
43880       description: delete an existing route-table-reference
43881       operationId: deleteNetworkRouteTableReferencesRouteTableReference
43882       consumes:
43883         - application/json
43884         - application/xml
43885       produces:
43886         - application/json
43887         - application/xml
43888       responses:
43889         "default":
43890           description: Response codes found in [response codes](https://wiki.onap.org/).
43891       parameters:
43892         - name: route-table-reference-id
43893           in: path
43894           description: Route Table Reference id, UUID assigned to this instance.
43895           required: true
43896           type: string
43897           example: __ROUTE-TABLE-REFERENCE-ID__
43898         - name: resource-version
43899           in: query
43900           description: resource-version for concurrency
43901           required: true
43902           type: string
43903   /network/route-table-references:
43904     get:
43905       tags:
43906         - Network
43907       summary: returns route-table-references
43908       description: returns route-table-references
43909       operationId: getNetworkRouteTableReferences
43910       produces:
43911         - application/json
43912         - application/xml
43913       responses:
43914         "200":
43915           description: successful operation
43916           schema:
43917               $ref: "#/getDefinitions/route-table-references"
43918         "default":
43919           description: Response codes found in [response codes](https://wiki.onap.org/).
43920       parameters:
43921         - name: route-table-reference-id
43922           in: query
43923           description:
43924           required: false
43925           type: string
43926         - name: route-table-reference-fqdn
43927           in: query
43928           description:
43929           required: false
43930           type: string
43931   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
43932     put:
43933       tags:
43934         - Network
43935       summary: see node definition for valid relationships
43936       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
43937       consumes:
43938         - application/json
43939         - application/xml
43940       produces:
43941         - application/json
43942         - application/xml
43943       responses:
43944         "default":
43945           description: Response codes found in [response codes](https://wiki.onap.org/).
43946       parameters:
43947         - name: id
43948           in: path
43949           description: Instance Group ID, UUID assigned to this instance.
43950           required: true
43951           type: string
43952           example: __ID__
43953         - name: body
43954           in: body
43955           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
43956           required: true
43957           schema:
43958             $ref: "#/definitions/relationship"
43959     delete:
43960       tags:
43961         - Network
43962       summary: delete an existing relationship
43963       description: delete an existing relationship
43964       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
43965       consumes:
43966         - application/json
43967         - application/xml
43968       produces:
43969         - application/json
43970         - application/xml
43971       responses:
43972         "default":
43973           description: Response codes found in [response codes](https://wiki.onap.org/).
43974       parameters:
43975         - name: id
43976           in: path
43977           description: Instance Group ID, UUID assigned to this instance.
43978           required: true
43979           type: string
43980           example: __ID__
43981   /network/instance-groups/instance-group/{id}:
43982     get:
43983       tags:
43984         - Network
43985       summary: returns instance-group
43986       description: returns instance-group
43987       operationId: getNetworkInstanceGroupsInstanceGroup
43988       produces:
43989         - application/json
43990         - application/xml
43991       responses:
43992         "200":
43993           description: successful operation
43994           schema:
43995               $ref: "#/getDefinitions/instance-group"
43996         "default":
43997           description: Response codes found in [response codes](https://wiki.onap.org/).
43998       parameters:
43999         - name: id
44000           in: path
44001           description: Instance Group ID, UUID assigned to this instance.
44002           required: true
44003           type: string
44004           example: __ID__
44005     put:
44006       tags:
44007         - Network
44008       summary: create or update an existing instance-group
44009       description: |
44010         Create or update an existing instance-group.
44011         #
44012         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44013       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
44014       consumes:
44015         - application/json
44016         - application/xml
44017       produces:
44018         - application/json
44019         - application/xml
44020       responses:
44021         "default":
44022           description: Response codes found in [response codes](https://wiki.onap.org/).
44023       parameters:
44024         - name: id
44025           in: path
44026           description: Instance Group ID, UUID assigned to this instance.
44027           required: true
44028           type: string
44029           example: __ID__
44030         - name: body
44031           in: body
44032           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
44033           required: true
44034           schema:
44035             $ref: "#/definitions/instance-group"
44036     patch:
44037       tags:
44038         - Network
44039       summary: update an existing instance-group
44040       description: |
44041         Update an existing instance-group
44042         #
44043         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44044         The PUT operation will entirely replace an existing object.
44045         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44046         #
44047         Other differences between PUT and PATCH are:
44048         #
44049         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44050         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44051         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44052       operationId: UpdateNetworkInstanceGroupsInstanceGroup
44053       consumes:
44054         - application/json
44055         - application/xml
44056       produces:
44057         - application/json
44058         - application/xml
44059       responses:
44060         "default":
44061           description: Response codes found in [response codes](https://wiki.onap.org/).
44062       parameters:
44063         - name: id
44064           in: path
44065           description: Instance Group ID, UUID assigned to this instance.
44066           required: true
44067           type: string
44068           example: __ID__
44069         - name: body
44070           in: body
44071           description: instance-group object that needs to be updated.
44072           required: true
44073           schema:
44074             $ref: "#/patchDefinitions/instance-group"
44075     delete:
44076       tags:
44077         - Network
44078       summary: delete an existing instance-group
44079       description: delete an existing instance-group
44080       operationId: deleteNetworkInstanceGroupsInstanceGroup
44081       consumes:
44082         - application/json
44083         - application/xml
44084       produces:
44085         - application/json
44086         - application/xml
44087       responses:
44088         "default":
44089           description: Response codes found in [response codes](https://wiki.onap.org/).
44090       parameters:
44091         - name: id
44092           in: path
44093           description: Instance Group ID, UUID assigned to this instance.
44094           required: true
44095           type: string
44096           example: __ID__
44097         - name: resource-version
44098           in: query
44099           description: resource-version for concurrency
44100           required: true
44101           type: string
44102   /network/instance-groups:
44103     get:
44104       tags:
44105         - Network
44106       summary: returns instance-groups
44107       description: returns instance-groups
44108       operationId: getNetworkInstanceGroups
44109       produces:
44110         - application/json
44111         - application/xml
44112       responses:
44113         "200":
44114           description: successful operation
44115           schema:
44116               $ref: "#/getDefinitions/instance-groups"
44117         "default":
44118           description: Response codes found in [response codes](https://wiki.onap.org/).
44119       parameters:
44120         - name: id
44121           in: query
44122           description:
44123           required: false
44124           type: string
44125         - name: description
44126           in: query
44127           description:
44128           required: false
44129           type: string
44130         - name: type
44131           in: query
44132           description:
44133           required: false
44134           type: string
44135         - name: sub-type
44136           in: query
44137           description:
44138           required: false
44139           type: string
44140   /network/zones/zone/{zone-id}/relationship-list/relationship:
44141     put:
44142       tags:
44143         - Network
44144       summary: see node definition for valid relationships
44145       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
44146       consumes:
44147         - application/json
44148         - application/xml
44149       produces:
44150         - application/json
44151         - application/xml
44152       responses:
44153         "default":
44154           description: Response codes found in [response codes](https://wiki.onap.org/).
44155       parameters:
44156         - name: zone-id
44157           in: path
44158           description: Code assigned by AIC to the zone
44159           required: true
44160           type: string
44161           example: __ZONE-ID__
44162         - name: body
44163           in: body
44164           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
44165           required: true
44166           schema:
44167             $ref: "#/definitions/relationship"
44168     delete:
44169       tags:
44170         - Network
44171       summary: delete an existing relationship
44172       description: delete an existing relationship
44173       operationId: deleteNetworkZonesZoneRelationshipListRelationship
44174       consumes:
44175         - application/json
44176         - application/xml
44177       produces:
44178         - application/json
44179         - application/xml
44180       responses:
44181         "default":
44182           description: Response codes found in [response codes](https://wiki.onap.org/).
44183       parameters:
44184         - name: zone-id
44185           in: path
44186           description: Code assigned by AIC to the zone
44187           required: true
44188           type: string
44189           example: __ZONE-ID__
44190   /network/zones/zone/{zone-id}:
44191     get:
44192       tags:
44193         - Network
44194       summary: returns zone
44195       description: returns zone
44196       operationId: getNetworkZonesZone
44197       produces:
44198         - application/json
44199         - application/xml
44200       responses:
44201         "200":
44202           description: successful operation
44203           schema:
44204               $ref: "#/getDefinitions/zone"
44205         "default":
44206           description: Response codes found in [response codes](https://wiki.onap.org/).
44207       parameters:
44208         - name: zone-id
44209           in: path
44210           description: Code assigned by AIC to the zone
44211           required: true
44212           type: string
44213           example: __ZONE-ID__
44214     put:
44215       tags:
44216         - Network
44217       summary: create or update an existing zone
44218       description: |
44219         Create or update an existing zone.
44220         #
44221         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44222       operationId: createOrUpdateNetworkZonesZone
44223       consumes:
44224         - application/json
44225         - application/xml
44226       produces:
44227         - application/json
44228         - application/xml
44229       responses:
44230         "default":
44231           description: Response codes found in [response codes](https://wiki.onap.org/).
44232       parameters:
44233         - name: zone-id
44234           in: path
44235           description: Code assigned by AIC to the zone
44236           required: true
44237           type: string
44238           example: __ZONE-ID__
44239         - name: body
44240           in: body
44241           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
44242           required: true
44243           schema:
44244             $ref: "#/definitions/zone"
44245     patch:
44246       tags:
44247         - Network
44248       summary: update an existing zone
44249       description: |
44250         Update an existing zone
44251         #
44252         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44253         The PUT operation will entirely replace an existing object.
44254         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44255         #
44256         Other differences between PUT and PATCH are:
44257         #
44258         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44259         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44260         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44261       operationId: UpdateNetworkZonesZone
44262       consumes:
44263         - application/json
44264         - application/xml
44265       produces:
44266         - application/json
44267         - application/xml
44268       responses:
44269         "default":
44270           description: Response codes found in [response codes](https://wiki.onap.org/).
44271       parameters:
44272         - name: zone-id
44273           in: path
44274           description: Code assigned by AIC to the zone
44275           required: true
44276           type: string
44277           example: __ZONE-ID__
44278         - name: body
44279           in: body
44280           description: zone object that needs to be updated.
44281           required: true
44282           schema:
44283             $ref: "#/patchDefinitions/zone"
44284     delete:
44285       tags:
44286         - Network
44287       summary: delete an existing zone
44288       description: delete an existing zone
44289       operationId: deleteNetworkZonesZone
44290       consumes:
44291         - application/json
44292         - application/xml
44293       produces:
44294         - application/json
44295         - application/xml
44296       responses:
44297         "default":
44298           description: Response codes found in [response codes](https://wiki.onap.org/).
44299       parameters:
44300         - name: zone-id
44301           in: path
44302           description: Code assigned by AIC to the zone
44303           required: true
44304           type: string
44305           example: __ZONE-ID__
44306         - name: resource-version
44307           in: query
44308           description: resource-version for concurrency
44309           required: true
44310           type: string
44311   /network/zones:
44312     get:
44313       tags:
44314         - Network
44315       summary: returns zones
44316       description: returns zones
44317       operationId: getNetworkZones
44318       produces:
44319         - application/json
44320         - application/xml
44321       responses:
44322         "200":
44323           description: successful operation
44324           schema:
44325               $ref: "#/getDefinitions/zones"
44326         "default":
44327           description: Response codes found in [response codes](https://wiki.onap.org/).
44328       parameters:
44329         - name: zone-id
44330           in: query
44331           description:
44332           required: false
44333           type: string
44334         - name: design-type
44335           in: query
44336           description:
44337           required: false
44338           type: string
44339         - name: zone-context
44340           in: query
44341           description:
44342           required: false
44343           type: string
44344   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
44345     put:
44346       tags:
44347         - Network
44348       summary: see node definition for valid relationships
44349       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
44350       consumes:
44351         - application/json
44352         - application/xml
44353       produces:
44354         - application/json
44355         - application/xml
44356       responses:
44357         "default":
44358           description: Response codes found in [response codes](https://wiki.onap.org/).
44359       parameters:
44360         - name: configuration-id
44361           in: path
44362           description: UUID assigned to configuration.
44363           required: true
44364           type: string
44365           example: __CONFIGURATION-ID__
44366         - name: body
44367           in: body
44368           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
44369           required: true
44370           schema:
44371             $ref: "#/definitions/relationship"
44372     delete:
44373       tags:
44374         - Network
44375       summary: delete an existing relationship
44376       description: delete an existing relationship
44377       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
44378       consumes:
44379         - application/json
44380         - application/xml
44381       produces:
44382         - application/json
44383         - application/xml
44384       responses:
44385         "default":
44386           description: Response codes found in [response codes](https://wiki.onap.org/).
44387       parameters:
44388         - name: configuration-id
44389           in: path
44390           description: UUID assigned to configuration.
44391           required: true
44392           type: string
44393           example: __CONFIGURATION-ID__
44394   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
44395     get:
44396       tags:
44397         - Network
44398       summary: returns metadatum
44399       description: returns metadatum
44400       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
44401       produces:
44402         - application/json
44403         - application/xml
44404       responses:
44405         "200":
44406           description: successful operation
44407           schema:
44408               $ref: "#/getDefinitions/metadatum"
44409         "default":
44410           description: Response codes found in [response codes](https://wiki.onap.org/).
44411       parameters:
44412         - name: configuration-id
44413           in: path
44414           description: UUID assigned to configuration.
44415           required: true
44416           type: string
44417           example: __CONFIGURATION-ID__
44418         - name: metaname
44419           in: path
44420           required: true
44421           type: string
44422           example: __METANAME__
44423     put:
44424       tags:
44425         - Network
44426       summary: create or update an existing metadatum
44427       description: |
44428         Create or update an existing metadatum.
44429         #
44430         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44431       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
44432       consumes:
44433         - application/json
44434         - application/xml
44435       produces:
44436         - application/json
44437         - application/xml
44438       responses:
44439         "default":
44440           description: Response codes found in [response codes](https://wiki.onap.org/).
44441       parameters:
44442         - name: configuration-id
44443           in: path
44444           description: UUID assigned to configuration.
44445           required: true
44446           type: string
44447           example: __CONFIGURATION-ID__
44448         - name: metaname
44449           in: path
44450           required: true
44451           type: string
44452           example: __METANAME__
44453         - name: body
44454           in: body
44455           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)
44456           required: true
44457           schema:
44458             $ref: "#/definitions/metadatum"
44459     patch:
44460       tags:
44461         - Network
44462       summary: update an existing metadatum
44463       description: |
44464         Update an existing metadatum
44465         #
44466         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44467         The PUT operation will entirely replace an existing object.
44468         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44469         #
44470         Other differences between PUT and PATCH are:
44471         #
44472         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44473         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44474         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44475       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
44476       consumes:
44477         - application/json
44478         - application/xml
44479       produces:
44480         - application/json
44481         - application/xml
44482       responses:
44483         "default":
44484           description: Response codes found in [response codes](https://wiki.onap.org/).
44485       parameters:
44486         - name: configuration-id
44487           in: path
44488           description: UUID assigned to configuration.
44489           required: true
44490           type: string
44491           example: __CONFIGURATION-ID__
44492         - name: metaname
44493           in: path
44494           required: true
44495           type: string
44496           example: __METANAME__
44497         - name: body
44498           in: body
44499           description: metadatum object that needs to be updated.
44500           required: true
44501           schema:
44502             $ref: "#/patchDefinitions/metadatum"
44503     delete:
44504       tags:
44505         - Network
44506       summary: delete an existing metadatum
44507       description: delete an existing metadatum
44508       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
44509       consumes:
44510         - application/json
44511         - application/xml
44512       produces:
44513         - application/json
44514         - application/xml
44515       responses:
44516         "default":
44517           description: Response codes found in [response codes](https://wiki.onap.org/).
44518       parameters:
44519         - name: configuration-id
44520           in: path
44521           description: UUID assigned to configuration.
44522           required: true
44523           type: string
44524           example: __CONFIGURATION-ID__
44525         - name: metaname
44526           in: path
44527           required: true
44528           type: string
44529           example: __METANAME__
44530         - name: resource-version
44531           in: query
44532           description: resource-version for concurrency
44533           required: true
44534           type: string
44535   /network/configurations/configuration/{configuration-id}/metadata:
44536     get:
44537       tags:
44538         - Network
44539       summary: returns metadata
44540       description: returns metadata
44541       operationId: getNetworkConfigurationsConfigurationMetadata
44542       produces:
44543         - application/json
44544         - application/xml
44545       responses:
44546         "200":
44547           description: successful operation
44548           schema:
44549               $ref: "#/getDefinitions/metadata"
44550         "default":
44551           description: Response codes found in [response codes](https://wiki.onap.org/).
44552       parameters:
44553         - name: configuration-id
44554           in: path
44555           description: UUID assigned to configuration.
44556           required: true
44557           type: string
44558           example: __CONFIGURATION-ID__
44559         - name: metaname
44560           in: query
44561           description:
44562           required: false
44563           type: string
44564   /network/configurations/configuration/{configuration-id}:
44565     get:
44566       tags:
44567         - Network
44568       summary: returns configuration
44569       description: returns configuration
44570       operationId: getNetworkConfigurationsConfiguration
44571       produces:
44572         - application/json
44573         - application/xml
44574       responses:
44575         "200":
44576           description: successful operation
44577           schema:
44578               $ref: "#/getDefinitions/configuration"
44579         "default":
44580           description: Response codes found in [response codes](https://wiki.onap.org/).
44581       parameters:
44582         - name: configuration-id
44583           in: path
44584           description: UUID assigned to configuration.
44585           required: true
44586           type: string
44587           example: __CONFIGURATION-ID__
44588     put:
44589       tags:
44590         - Network
44591       summary: create or update an existing configuration
44592       description: |
44593         Create or update an existing configuration.
44594         #
44595         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44596       operationId: createOrUpdateNetworkConfigurationsConfiguration
44597       consumes:
44598         - application/json
44599         - application/xml
44600       produces:
44601         - application/json
44602         - application/xml
44603       responses:
44604         "default":
44605           description: Response codes found in [response codes](https://wiki.onap.org/).
44606       parameters:
44607         - name: configuration-id
44608           in: path
44609           description: UUID assigned to configuration.
44610           required: true
44611           type: string
44612           example: __CONFIGURATION-ID__
44613         - name: body
44614           in: body
44615           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
44616           required: true
44617           schema:
44618             $ref: "#/definitions/configuration"
44619     patch:
44620       tags:
44621         - Network
44622       summary: update an existing configuration
44623       description: |
44624         Update an existing configuration
44625         #
44626         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44627         The PUT operation will entirely replace an existing object.
44628         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44629         #
44630         Other differences between PUT and PATCH are:
44631         #
44632         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44633         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44634         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44635       operationId: UpdateNetworkConfigurationsConfiguration
44636       consumes:
44637         - application/json
44638         - application/xml
44639       produces:
44640         - application/json
44641         - application/xml
44642       responses:
44643         "default":
44644           description: Response codes found in [response codes](https://wiki.onap.org/).
44645       parameters:
44646         - name: configuration-id
44647           in: path
44648           description: UUID assigned to configuration.
44649           required: true
44650           type: string
44651           example: __CONFIGURATION-ID__
44652         - name: body
44653           in: body
44654           description: configuration object that needs to be updated.
44655           required: true
44656           schema:
44657             $ref: "#/patchDefinitions/configuration"
44658     delete:
44659       tags:
44660         - Network
44661       summary: delete an existing configuration
44662       description: delete an existing configuration
44663       operationId: deleteNetworkConfigurationsConfiguration
44664       consumes:
44665         - application/json
44666         - application/xml
44667       produces:
44668         - application/json
44669         - application/xml
44670       responses:
44671         "default":
44672           description: Response codes found in [response codes](https://wiki.onap.org/).
44673       parameters:
44674         - name: configuration-id
44675           in: path
44676           description: UUID assigned to configuration.
44677           required: true
44678           type: string
44679           example: __CONFIGURATION-ID__
44680         - name: resource-version
44681           in: query
44682           description: resource-version for concurrency
44683           required: true
44684           type: string
44685   /network/configurations:
44686     get:
44687       tags:
44688         - Network
44689       summary: returns configurations
44690       description: returns configurations
44691       operationId: getNetworkConfigurations
44692       produces:
44693         - application/json
44694         - application/xml
44695       responses:
44696         "200":
44697           description: successful operation
44698           schema:
44699               $ref: "#/getDefinitions/configurations"
44700         "default":
44701           description: Response codes found in [response codes](https://wiki.onap.org/).
44702       parameters:
44703         - name: configuration-id
44704           in: query
44705           description:
44706           required: false
44707           type: string
44708         - name: model-invariant-id
44709           in: query
44710           description:
44711           required: false
44712           type: string
44713         - name: model-version-id
44714           in: query
44715           description:
44716           required: false
44717           type: string
44718 definitions:
44719   action:
44720     properties:
44721       action-type:
44722         type: string
44723       action-data:
44724         type: array
44725         items:
44726           $ref: "#/definitions/action-data"
44727   action-data:
44728     properties:
44729       property-name:
44730         type: string
44731       property-value:
44732         type: string
44733   actions:
44734     description: |
44735       APIs that are more action related than REST (e.g., notify, update).
44736     properties:
44737       update:
44738         type: object
44739         $ref: "#/definitions/update"
44740       notify:
44741         type: object
44742         $ref: "#/definitions/notify"
44743   allotted-resource:
44744     description: |
44745       Represents a slice or partial piece of a resource that gets separately allotted
44746       ###### Related Nodes
44747       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
44748       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
44749       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
44750       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
44751       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
44752       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
44753       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
44754       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
44755       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
44756       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
44757       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
44758       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
44759       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
44760
44761       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
44762       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
44763       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
44764     required:
44765     - id
44766     properties:
44767       id:
44768         type: string
44769         description: Allotted Resource id UUID assigned to this instance.
44770       description:
44771         type: string
44772         description: The descriptive information assigned to this allotted resource instance
44773       selflink:
44774         type: string
44775         description: Link back to more information in the controller
44776       model-invariant-id:
44777         type: string
44778         description: the ASDC model id for this resource or service model.
44779       model-version-id:
44780         type: string
44781         description: the ASDC model version for this resource or service model.
44782       persona-model-version:
44783         type: string
44784         description: the ASDC model version for this resource or service model.
44785       resource-version:
44786         type: string
44787         description: Concurrency value
44788       orchestration-status:
44789         type: string
44790         description: Orchestration status
44791       operational-status:
44792         type: string
44793         description: Indicator for whether the resource is considered operational
44794       type:
44795         type: string
44796         description: Generic description of the type of allotted resource.
44797       role:
44798         type: string
44799         description: role in the network that this resource will be providing.
44800       tunnel-xconnects:
44801         type: array
44802         items:
44803           $ref: "#/definitions/tunnel-xconnect"
44804       relationship-list:
44805         type: array
44806         items:
44807           $ref: "#/definitions/relationship"
44808   allotted-resources:
44809     description: |
44810       This object is used to store slices of services being offered
44811     properties:
44812       allotted-resource:
44813         type: array
44814         items:
44815           $ref: "#/definitions/allotted-resource"
44816   availability-zone:
44817     description: |
44818       Availability zone, a collection of compute hosts/pservers
44819       ###### Related Nodes
44820       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
44821       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
44822       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
44823       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
44824       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
44825       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
44826       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
44827       - FROM vce( vce Uses availability-zone, MANY2MANY)
44828
44829       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
44830       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
44831
44832     required:
44833     - availability-zone-name
44834     - hypervisor-type
44835     properties:
44836       availability-zone-name:
44837         type: string
44838         description: Name of the availability zone.  Unique across a cloud region
44839       hypervisor-type:
44840         type: string
44841         description: Type of hypervisor.  Source of truth should define valid values.
44842       operational-status:
44843         type: string
44844         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
44845       resource-version:
44846         type: string
44847         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44848       relationship-list:
44849         type: array
44850         items:
44851           $ref: "#/definitions/relationship"
44852   availability-zones:
44853     description: |
44854       Collection of availability zones
44855     properties:
44856       availability-zone:
44857         type: array
44858         items:
44859           $ref: "#/definitions/availability-zone"
44860   az-and-dvs-switches:
44861     properties:
44862       dvs-switches:
44863         type: object
44864         $ref: "#/definitions/dvs-switches"
44865       availability-zone:
44866         type: object
44867         $ref: "#/definitions/availability-zone"
44868   business:
44869     description: |
44870       Namespace for business related constructs
44871     properties:
44872       connectors:
44873         type: array
44874         items:
44875           $ref: "#/definitions/connector"
44876       customers:
44877         type: array
44878         items:
44879           $ref: "#/definitions/customer"
44880       lines-of-business:
44881         type: array
44882         items:
44883           $ref: "#/definitions/line-of-business"
44884       owning-entities:
44885         type: array
44886         items:
44887           $ref: "#/definitions/owning-entity"
44888       platforms:
44889         type: array
44890         items:
44891           $ref: "#/definitions/platform"
44892       projects:
44893         type: array
44894         items:
44895           $ref: "#/definitions/project"
44896   class-of-service:
44897     description: |
44898       ###### Related Nodes
44899       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
44900
44901       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
44902     required:
44903     - cos
44904     properties:
44905       cos:
44906         type: string
44907         description: unique identifier of probe
44908       probe-id:
44909         type: string
44910         description: identifier of probe
44911       probe-type:
44912         type: string
44913         description: type of probe
44914       resource-version:
44915         type: string
44916         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44917       relationship-list:
44918         type: array
44919         items:
44920           $ref: "#/definitions/relationship"
44921   classes-of-service:
44922     description: |
44923       class-of-service of probe
44924     properties:
44925       class-of-service:
44926         type: array
44927         items:
44928           $ref: "#/definitions/class-of-service"
44929   cloud-infrastructure:
44930     description: |
44931       Namespace for cloud infrastructure.
44932     properties:
44933       complexes:
44934         type: array
44935         items:
44936           $ref: "#/definitions/complex"
44937       cloud-regions:
44938         type: array
44939         items:
44940           $ref: "#/definitions/cloud-region"
44941       network-profiles:
44942         type: array
44943         items:
44944           $ref: "#/definitions/network-profile"
44945       pservers:
44946         type: array
44947         items:
44948           $ref: "#/definitions/pserver"
44949       virtual-data-centers:
44950         type: array
44951         items:
44952           $ref: "#/definitions/virtual-data-center"
44953   cloud-region:
44954     description: |
44955       cloud-region designates an installation of a cloud cluster or region or instantiation.
44956       ###### Related Nodes
44957       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
44958       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
44959       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
44960       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
44961       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
44962       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
44963       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
44964       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
44965       - FROM image( image BelongsTo cloud-region, MANY2ONE)
44966       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
44967       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
44968       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
44969       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
44970       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
44971       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
44972       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
44973       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
44974
44975       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
44976       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
44977
44978     required:
44979     - cloud-owner
44980     - cloud-region-id
44981     - sriov-automation
44982     properties:
44983       cloud-owner:
44984         type: string
44985         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
44986       cloud-region-id:
44987         type: string
44988         description: Identifier used by the vendor for the region. Second part of composite key
44989       cloud-type:
44990         type: string
44991         description: Type of the cloud (e.g., openstack)
44992       owner-defined-type:
44993         type: string
44994         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
44995       cloud-region-version:
44996         type: string
44997         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
44998       identity-url:
44999         type: string
45000         description: URL of the keystone identity service
45001       cloud-zone:
45002         type: string
45003         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
45004       complex-name:
45005         type: string
45006         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
45007       sriov-automation:
45008         type: boolean
45009         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
45010       cloud-extra-info:
45011         type: string
45012         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
45013       cloud-epa-caps:
45014         type: string
45015         description: MultiVIM will discover and expose EPA capabilities.
45016       resource-version:
45017         type: string
45018         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45019       volume-groups:
45020         type: array
45021         items:
45022           $ref: "#/definitions/volume-group"
45023       tenants:
45024         type: array
45025         items:
45026           $ref: "#/definitions/tenant"
45027       flavors:
45028         type: array
45029         items:
45030           $ref: "#/definitions/flavor"
45031       group-assignments:
45032         type: array
45033         items:
45034           $ref: "#/definitions/group-assignment"
45035       snapshots:
45036         type: array
45037         items:
45038           $ref: "#/definitions/snapshot"
45039       images:
45040         type: array
45041         items:
45042           $ref: "#/definitions/image"
45043       dvs-switches:
45044         type: array
45045         items:
45046           $ref: "#/definitions/dvs-switch"
45047       oam-networks:
45048         type: array
45049         items:
45050           $ref: "#/definitions/oam-network"
45051       availability-zones:
45052         type: array
45053         items:
45054           $ref: "#/definitions/availability-zone"
45055       relationship-list:
45056         type: array
45057         items:
45058           $ref: "#/definitions/relationship"
45059       esr-system-info-list:
45060         type: array
45061         items:
45062           $ref: "#/definitions/esr-system-info"
45063       vip-ipv4-address-list:
45064         type: array
45065         items:
45066           $ref: "#/definitions/vip-ipv4-address-list"
45067       vip-ipv6-address-list:
45068         type: array
45069         items:
45070           $ref: "#/definitions/vip-ipv6-address-list"
45071   cloud-regions:
45072     properties:
45073       cloud-region:
45074         type: array
45075         items:
45076           $ref: "#/definitions/cloud-region"
45077   complex:
45078     description: |
45079       Collection of physical locations that can house cloud-regions.
45080       ###### Related Nodes
45081       - TO l3-network( complex Uses l3-network, MANY2MANY)
45082       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
45083       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
45084       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
45085       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
45086       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
45087       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
45088       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
45089       - FROM vce( vce LocatedIn complex, MANY2MANY)
45090       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
45091       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
45092       - FROM zone( zone LocatedIn complex, MANY2ONE)
45093
45094       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
45095       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
45096
45097     required:
45098     - physical-location-id
45099     - physical-location-type
45100     - street1
45101     - city
45102     - postal-code
45103     - country
45104     - region
45105     properties:
45106       physical-location-id:
45107         type: string
45108         description: Unique identifier for physical location, e.g., CLLI
45109       data-center-code:
45110         type: string
45111         description: Data center code which can be an alternate way to identify a complex
45112       complex-name:
45113         type: string
45114         description: Gamma complex name for LCP instance.
45115       identity-url:
45116         type: string
45117         description: URL of the keystone identity service
45118       resource-version:
45119         type: string
45120         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45121       physical-location-type:
45122         type: string
45123         description: Type, e.g., central office, data center.
45124       street1:
45125         type: string
45126       street2:
45127         type: string
45128       city:
45129         type: string
45130       state:
45131         type: string
45132       postal-code:
45133         type: string
45134       country:
45135         type: string
45136       region:
45137         type: string
45138       latitude:
45139         type: string
45140       longitude:
45141         type: string
45142       elevation:
45143         type: string
45144       lata:
45145         type: string
45146       ctag-pools:
45147         type: array
45148         items:
45149           $ref: "#/definitions/ctag-pool"
45150       relationship-list:
45151         type: array
45152         items:
45153           $ref: "#/definitions/relationship"
45154   complexes:
45155     description: |
45156       Collection of physical locations that can house cloud-regions.
45157     properties:
45158       complex:
45159         type: array
45160         items:
45161           $ref: "#/definitions/complex"
45162   configuration:
45163     description: |
45164       Port Mirror Configuration.
45165       ###### Related Nodes
45166       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
45167       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
45168       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
45169       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
45170       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
45171
45172       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
45173       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
45174       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
45175     required:
45176     - configuration-id
45177     - configuration-type
45178     - configuration-sub-type
45179     - orchestration-status
45180     - operational-status
45181     - configuration-selflink
45182     - model-customization-id
45183     properties:
45184       configuration-id:
45185         type: string
45186         description: UUID assigned to configuration.
45187       management-option:
45188         type: string
45189         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
45190       configuration-name:
45191         type: string
45192         description: Name of the configuration.
45193       configuration-type:
45194         type: string
45195         description: port-mirroring-configuration.
45196       configuration-sub-type:
45197         type: string
45198         description: vprobe, pprobe.
45199       model-invariant-id:
45200         type: string
45201         description: the ASDC model id for this resource or service model.
45202       model-version-id:
45203         type: string
45204         description: the ASDC model version for this resource or service model.
45205       orchestration-status:
45206         type: string
45207         description: Orchestration status of the configuration.
45208       operational-status:
45209         type: string
45210         description: Indicator for whether the resource is considered operational.
45211       configuration-selflink:
45212         type: string
45213         description: URL to endpoint where AAI can get more details from SDN-GC.
45214       model-customization-id:
45215         type: string
45216         description: id of  the configuration used to customize the resource
45217       resource-version:
45218         type: string
45219         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45220       relationship-list:
45221         type: array
45222         items:
45223           $ref: "#/definitions/relationship"
45224       metadata:
45225         type: array
45226         items:
45227           $ref: "#/definitions/metadatum"
45228   configurations:
45229     description: |
45230       Collection of configurations
45231     properties:
45232       configuration:
45233         type: array
45234         items:
45235           $ref: "#/definitions/configuration"
45236   connector:
45237     description: |
45238       Collection of resource instances used to connect a variety of disparate inventory widgets
45239       ###### Related Nodes
45240       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
45241       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
45242       - FROM service-instance( service-instance Uses connector, MANY2MANY)
45243
45244       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
45245     required:
45246     - resource-instance-id
45247     properties:
45248       resource-instance-id:
45249         type: string
45250         description: Unique id of resource instance.
45251       resource-version:
45252         type: string
45253         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45254       model-invariant-id:
45255         type: string
45256         description: the ASDC model id for this resource or service model.
45257       model-version-id:
45258         type: string
45259         description: the ASDC model version for this resource or service model.
45260       persona-model-version:
45261         type: string
45262         description: the ASDC model version for this resource or service model.
45263       widget-model-id:
45264         type: string
45265         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45266       widget-model-version:
45267         type: string
45268         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45269       relationship-list:
45270         type: array
45271         items:
45272           $ref: "#/definitions/relationship"
45273       metadata:
45274         type: array
45275         items:
45276           $ref: "#/definitions/metadatum"
45277   connectors:
45278     description: |
45279       Collection of resource instances used to connect a variety of disparate inventory widgets
45280     properties:
45281       connector:
45282         type: array
45283         items:
45284           $ref: "#/definitions/connector"
45285   constrained-element-set:
45286     description: |
45287       This is how we would capture constraints defining allowed sets of elements.
45288       ###### Related Nodes
45289       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
45290       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
45291       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
45292
45293       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
45294       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
45295     required:
45296     - constrained-element-set-uuid
45297     - constraint-type
45298     - check-type
45299     properties:
45300       constrained-element-set-uuid:
45301         type: string
45302       constraint-type:
45303         type: string
45304       check-type:
45305         type: string
45306       resource-version:
45307         type: string
45308       element-choice-sets:
45309         type: array
45310         items:
45311           $ref: "#/definitions/element-choice-set"
45312       relationship-list:
45313         type: array
45314         items:
45315           $ref: "#/definitions/relationship"
45316   constrained-element-sets:
45317     properties:
45318       constrained-element-set:
45319         type: array
45320         items:
45321           $ref: "#/definitions/constrained-element-set"
45322   ctag-assignment:
45323     description: |
45324       ###### Related Nodes
45325       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
45326       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
45327
45328       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
45329     required:
45330     - vlan-id-inner
45331     properties:
45332       vlan-id-inner:
45333         type: integer
45334         format: int64
45335         description: id.
45336       resource-version:
45337         type: string
45338         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45339       relationship-list:
45340         type: array
45341         items:
45342           $ref: "#/definitions/relationship"
45343   ctag-assignments:
45344     properties:
45345       ctag-assignment:
45346         type: array
45347         items:
45348           $ref: "#/definitions/ctag-assignment"
45349   ctag-pool:
45350     description: |
45351       A collection of C tags (vlan tags) grouped for a specific purpose.
45352       ###### Related Nodes
45353       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
45354       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
45355       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
45356       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
45357
45358       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
45359     required:
45360     - target-pe
45361     - availability-zone-name
45362     - ctag-pool-purpose
45363     properties:
45364       target-pe:
45365         type: string
45366         description: The Target provider edge router
45367       availability-zone-name:
45368         type: string
45369         description: Name of the availability zone
45370       ctag-pool-purpose:
45371         type: string
45372         description: Describes what the intended purpose of this pool is.
45373       ctag-values:
45374         type: string
45375         description: Comma separated list of ctags
45376       resource-version:
45377         type: string
45378         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45379       relationship-list:
45380         type: array
45381         items:
45382           $ref: "#/definitions/relationship"
45383   ctag-pools:
45384     properties:
45385       ctag-pool:
45386         type: array
45387         items:
45388           $ref: "#/definitions/ctag-pool"
45389   customer:
45390     description: |
45391       customer identifiers to provide linkage back to BSS information.
45392       ###### Related Nodes
45393       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
45394
45395       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
45396     required:
45397     - global-customer-id
45398     - subscriber-name
45399     - subscriber-type
45400     properties:
45401       global-customer-id:
45402         type: string
45403         description: Global customer id used across ECOMP to uniquely identify customer.
45404       subscriber-name:
45405         type: string
45406         description: Subscriber name, an alternate way to retrieve a customer.
45407       subscriber-type:
45408         type: string
45409         description: Subscriber type, a way to provide VID with only the INFRA customers.
45410       resource-version:
45411         type: string
45412         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45413       service-subscriptions:
45414         type: array
45415         items:
45416           $ref: "#/definitions/service-subscription"
45417       relationship-list:
45418         type: array
45419         items:
45420           $ref: "#/definitions/relationship"
45421   customers:
45422     description: |
45423       Collection of customer identifiers to provide linkage back to BSS information.
45424     properties:
45425       customer:
45426         type: array
45427         items:
45428           $ref: "#/definitions/customer"
45429   cvlan-tag-entry:
45430     required:
45431     - cvlan-tag
45432     properties:
45433       cvlan-tag:
45434         type: integer
45435         format: int64
45436         description: See mis-na-virtualization-platform.yang
45437       resource-version:
45438         type: string
45439         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45440       relationship-list:
45441         type: array
45442         items:
45443           $ref: "#/definitions/relationship"
45444   cvlan-tags:
45445     properties:
45446       cvlan-tag-entry:
45447         type: array
45448         items:
45449           $ref: "#/definitions/cvlan-tag-entry"
45450   dvs-switch:
45451     description: |
45452       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.
45453       ###### Related Nodes
45454       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
45455       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
45456
45457     required:
45458     - switch-name
45459     - vcenter-url
45460     properties:
45461       switch-name:
45462         type: string
45463         description: DVS switch name
45464       vcenter-url:
45465         type: string
45466         description: URL used to reach the vcenter
45467       resource-version:
45468         type: string
45469         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45470       relationship-list:
45471         type: array
45472         items:
45473           $ref: "#/definitions/relationship"
45474   dvs-switches:
45475     description: |
45476       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
45477     properties:
45478       dvs-switch:
45479         type: array
45480         items:
45481           $ref: "#/definitions/dvs-switch"
45482   edge-prop-names:
45483     description: |
45484       Internal map to define the properties of an edge and interpret the map EdgeRules
45485     properties:
45486       edgeLabel:
45487         type: string
45488       direction:
45489         type: string
45490       multiplicityRule:
45491         type: string
45492       contains-other-v:
45493         type: string
45494       delete-other-v:
45495         type: string
45496       SVC-INFRA:
45497         type: string
45498       prevent-delete:
45499         type: string
45500   edge-tag-query-request:
45501     properties:
45502       edge-tag:
45503         type: string
45504       result-detail:
45505         type: string
45506       start-node-type:
45507         type: string
45508       start-node-filter:
45509         type: array
45510         items:
45511           $ref: "#/definitions/start-node-filter"
45512       include-node-filter:
45513         type: array
45514         items:
45515           $ref: "#/definitions/include-node-filter"
45516       secondary-filter:
45517         type: array
45518         items:
45519           $ref: "#/definitions/secondary-filter"
45520   edge-tag-query-result:
45521     properties:
45522       tagged-inventory-item-list:
45523         type: array
45524         items:
45525           $ref: "#/definitions/tagged-inventory-item-list"
45526   element-choice-set:
45527     description: |
45528       This is how we would capture constraints defining allowed sets of elements.
45529       ###### Related Nodes
45530       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
45531       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
45532
45533       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
45534       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
45535     required:
45536     - element-choice-set-uuid
45537     - element-choice-set-name
45538     properties:
45539       element-choice-set-uuid:
45540         type: string
45541       element-choice-set-name:
45542         type: string
45543       cardinality:
45544         type: string
45545       resource-version:
45546         type: string
45547       model-elements:
45548         type: array
45549         items:
45550           $ref: "#/definitions/model-element"
45551       relationship-list:
45552         type: array
45553         items:
45554           $ref: "#/definitions/relationship"
45555   element-choice-sets:
45556     properties:
45557       element-choice-set:
45558         type: array
45559         items:
45560           $ref: "#/definitions/element-choice-set"
45561   entitlement:
45562     description: |
45563       Metadata for entitlement group.
45564       ###### Related Nodes
45565       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
45566       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
45567
45568       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
45569     required:
45570     - group-uuid
45571     - resource-uuid
45572     properties:
45573       group-uuid:
45574         type: string
45575         description: Unique ID for the entitlement group the resource comes from, should be uuid.
45576       resource-uuid:
45577         type: string
45578         description: Unique ID of an entitlement resource.
45579       resource-version:
45580         type: string
45581         description: Concurrency value
45582       relationship-list:
45583         type: array
45584         items:
45585           $ref: "#/definitions/relationship"
45586   entitlements:
45587     description: |
45588       Entitlements, keyed by group-uuid and resource-uuid, related to license management
45589     properties:
45590       entitlement:
45591         type: array
45592         items:
45593           $ref: "#/definitions/entitlement"
45594   esr-ems:
45595     description: |
45596       Persist EMS address information used by EMS driver.
45597       ###### Related Nodes
45598       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
45599
45600       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
45601     required:
45602     - ems-id
45603     properties:
45604       ems-id:
45605         type: string
45606         description: Unique ID of EMS.
45607       resource-version:
45608         type: string
45609         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45610       esr-system-info-list:
45611         type: object
45612         $ref: "#/definitions/esr-system-info-list"
45613       relationship-list:
45614         type: object
45615         $ref: "#/definitions/relationship-list"
45616   esr-ems-list:
45617     properties:
45618       esr-ems:
45619         type: array
45620         items:
45621           $ref: "#/definitions/esr-ems"
45622   esr-system-info:
45623     description: |
45624       Persist common address information of external systems.
45625       ###### Related Nodes
45626       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
45627       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
45628       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
45629       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
45630
45631       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
45632     required:
45633     - esr-system-info-id
45634     - user-name
45635     - password
45636     - system-type
45637     properties:
45638       esr-system-info-id:
45639         type: string
45640         description: Unique ID of esr system info.
45641       system-name:
45642         type: string
45643         description: name of external system.
45644       type:
45645         type: string
45646         description: type of external systems.
45647       vendor:
45648         type: string
45649         description: vendor of external systems.
45650       version:
45651         type: string
45652         description: version of external systems.
45653       service-url:
45654         type: string
45655         description: url used to access external systems.
45656       user-name:
45657         type: string
45658         description: username used to access external systems.
45659       password:
45660         type: string
45661         description: password used to access external systems.
45662       system-type:
45663         type: string
45664         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
45665       protocol:
45666         type: string
45667         description: protocol of third party SDNC, for example netconf/snmp.
45668       ssl-cacert:
45669         type: string
45670         description: ca file content if enabled ssl on auth-url.
45671       ssl-insecure:
45672         type: boolean
45673         description: Whether to verify VIM's certificate.
45674       ip-address:
45675         type: string
45676         description: service IP of ftp server.
45677       port:
45678         type: string
45679         description: service port of ftp server.
45680       cloud-domain:
45681         type: string
45682         description: domain info for authentication.
45683       default-tenant:
45684         type: string
45685         description: default tenant of VIM.
45686       passive:
45687         type: boolean
45688         description: ftp passive mode or not.
45689       remote-path:
45690         type: string
45691         description: resource or performance data file path.
45692       system-status:
45693         type: string
45694         description: the status of external system.
45695       resource-version:
45696         type: string
45697         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45698       relationship-list:
45699         type: array
45700         items:
45701           $ref: "#/definitions/relationship"
45702   esr-system-info-list:
45703     description: |
45704       Collection of persistent block-level external system auth info.
45705     properties:
45706       esr-system-info:
45707         type: array
45708         items:
45709           $ref: "#/definitions/esr-system-info"
45710   esr-thirdparty-sdnc:
45711     description: |
45712       Persist SDNC address information used by ONAP SDNC.
45713       ###### Related Nodes
45714       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
45715       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
45716
45717       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
45718     required:
45719     - thirdparty-sdnc-id
45720     properties:
45721       thirdparty-sdnc-id:
45722         type: string
45723         description: Unique ID of SDNC.
45724       location:
45725         type: string
45726         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
45727       product-name:
45728         type: string
45729         description: password used to access SDNC server.
45730       resource-version:
45731         type: string
45732         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45733       esr-system-info-list:
45734         type: object
45735         $ref: "#/definitions/esr-system-info-list"
45736       relationship-list:
45737         type: object
45738         $ref: "#/definitions/relationship-list"
45739   esr-thirdparty-sdnc-list:
45740     properties:
45741       esr-thirdparty-sdnc:
45742         type: array
45743         items:
45744           $ref: "#/definitions/esr-thirdparty-sdnc"
45745   esr-vnfm:
45746     description: |
45747       Persist VNFM address information used by VF-C.
45748       ###### Related Nodes
45749       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
45750
45751       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
45752     required:
45753     - vnfm-id
45754     properties:
45755       vnfm-id:
45756         type: string
45757         description: Unique ID of VNFM.
45758       vim-id:
45759         type: string
45760         description: indecate the VIM to deploy VNF.
45761       certificate-url:
45762         type: string
45763         description: certificate url of VNFM.
45764       resource-version:
45765         type: string
45766         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45767       esr-system-info-list:
45768         type: object
45769         $ref: "#/definitions/esr-system-info-list"
45770       relationship-list:
45771         type: object
45772         $ref: "#/definitions/relationship-list"
45773   esr-vnfm-list:
45774     properties:
45775       esr-vnfm:
45776         type: array
45777         items:
45778           $ref: "#/definitions/esr-vnfm"
45779   evc:
45780     description: |
45781       evc object is an optional child object of the Configuration object.
45782       ###### Related Nodes
45783       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
45784
45785       -(4) IF this TO node is deleted, this EVC is DELETED also
45786     required:
45787     - evc-id
45788     properties:
45789       evc-id:
45790         type: string
45791         description: Unique/key field for the evc object
45792       forwarding-path-topology:
45793         type: string
45794         description: Point-to-Point, Multi-Point
45795       cir-value:
45796         type: string
45797         description: Commited Information Rate
45798       cir-units:
45799         type: string
45800         description: CIR units
45801       connection-diversity-group-id:
45802         type: string
45803         description: Diversity Group ID
45804       service-hours:
45805         type: string
45806         description: formerly Performance Group
45807       esp-evc-circuit-id:
45808         type: string
45809         description: EVC Circuit ID of ESP EVC
45810       esp-evc-cir-value:
45811         type: string
45812         description: Committed Information Rate (For ESP)
45813       esp-evc-cir-units:
45814         type: string
45815         description: CIR units (For ESP)
45816       esp-itu-code:
45817         type: string
45818         description: Identifies ESP
45819       collector-pop-clli:
45820         type: string
45821         description: Collector POP CLLI (from the hostname of the access pnf)
45822       inter-connect-type-ingress:
45823         type: string
45824         description: Interconnect type on ingress side of EVC.
45825       tagmode-access-ingress:
45826         type: string
45827         description: tagode for collector side of EVC
45828       tagmode-access-egress:
45829         type: string
45830         description: tagMode for network side of EVC
45831       relationship-list:
45832         type: array
45833         items:
45834           $ref: "#/definitions/relationship"
45835       resource-version:
45836         type: string
45837         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45838   evcs:
45839     properties:
45840       evc:
45841         type: array
45842         items:
45843           $ref: "#/definitions/evc"
45844   external-system:
45845     description: |
45846       Namespace for external system.
45847     properties:
45848       esr-ems-list:
45849         type: object
45850         $ref: "#/definitions/esr-ems-list"
45851       esr-vnfm-list:
45852         type: object
45853         $ref: "#/definitions/esr-vnfm-list"
45854       esr-thirdparty-sdnc-list:
45855         type: object
45856         $ref: "#/definitions/esr-thirdparty-sdnc-list"
45857   extra-properties:
45858     description: |
45859       Extra properties for inventory item for response list
45860     properties:
45861       extra-property:
45862         type: array
45863         items:
45864           $ref: "#/definitions/extra-property"
45865   extra-property:
45866     properties:
45867       property-name:
45868         type: string
45869       property-value:
45870         type: string
45871   flavor:
45872     description: |
45873       Openstack flavor.
45874       ###### Related Nodes
45875       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
45876       - FROM vserver( vserver Uses flavor, MANY2ONE)
45877
45878       -FLAVOR cannot be deleted if related to VSERVER
45879
45880     required:
45881     - flavor-id
45882     - flavor-name
45883     - flavor-selflink
45884     properties:
45885       flavor-id:
45886         type: string
45887         description: Flavor id, expected to be unique across cloud-region.
45888       flavor-name:
45889         type: string
45890         description: Flavor name
45891       flavor-vcpus:
45892         type: integer
45893         format: int32
45894         description: Number of CPUs
45895       flavor-ram:
45896         type: integer
45897         format: int32
45898         description: Amount of memory
45899       flavor-disk:
45900         type: integer
45901         format: int32
45902         description: Disk space
45903       flavor-ephemeral:
45904         type: integer
45905         format: int32
45906         description: Amount of ephemeral disk space
45907       flavor-swap:
45908         type: string
45909         description: amount of swap space allocation
45910       flavor-is-public:
45911         type: boolean
45912         description: whether flavor is available to all users or private to the tenant it was created in.
45913       flavor-selflink:
45914         type: string
45915         description: URL to endpoint where AAI can get more details
45916       flavor-disabled:
45917         type: boolean
45918         description: Boolean as to whether this flavor is no longer enabled
45919       resource-version:
45920         type: string
45921         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45922       relationship-list:
45923         type: array
45924         items:
45925           $ref: "#/definitions/relationship"
45926   flavors:
45927     description: |
45928       Collection of openstack flavors.
45929     properties:
45930       flavor:
45931         type: array
45932         items:
45933           $ref: "#/definitions/flavor"
45934   forwarder:
45935     description: |
45936       Entity describing a sequenced segment of forwarding path
45937       ###### Related Nodes
45938       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
45939       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
45940       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
45941       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
45942       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
45943
45944       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
45945       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
45946     required:
45947     - sequence
45948     properties:
45949       sequence:
45950         type: integer
45951         format: int32
45952         description: Unique ID of this segmentation
45953       forwarder-role:
45954         type: string
45955         description: ingress, intermediate, egress
45956       relationship-list:
45957         type: array
45958         items:
45959           $ref: "#/definitions/relationship"
45960       resource-version:
45961         type: string
45962         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45963   forwarder-evc:
45964     description: |
45965       forwarder object is an optional child object of the Configuration object.
45966       ###### Related Nodes
45967       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
45968
45969       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
45970     required:
45971     - forwarder-evc-id
45972     properties:
45973       forwarder-evc-id:
45974         type: string
45975         description: Key for forwarder-evc object
45976       circuit-id:
45977         type: string
45978         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
45979       ivlan:
45980         type: string
45981         description: Internal VLAN.
45982       svlan:
45983         type: string
45984         description: SVLAN value for ingress of egress forwarder.
45985       cvlan:
45986         type: string
45987         description: CVLAN value for ingress of egress forwarder.
45988       relationship-list:
45989         type: array
45990         items:
45991           $ref: "#/definitions/relationship"
45992       resource-version:
45993         type: string
45994         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45995   forwarder-evcs:
45996     properties:
45997       forwarder-evc:
45998         type: array
45999         items:
46000           $ref: "#/definitions/forwarder-evc"
46001   forwarders:
46002     properties:
46003       forwarder:
46004         type: array
46005         items:
46006           $ref: "#/definitions/forwarder"
46007   forwarding-path:
46008     description: |
46009       Entity that describes the sequenced forwarding path between interfaces of services or resources
46010       ###### Related Nodes
46011       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
46012       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
46013       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
46014
46015       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
46016       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
46017       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
46018     required:
46019     - forwarding-path-id
46020     - forwarding-path-name
46021     properties:
46022       forwarding-path-id:
46023         type: string
46024         description: Unique ID of this FP
46025       forwarding-path-name:
46026         type: string
46027         description: Name of the FP
46028       relationship-list:
46029         type: array
46030         items:
46031           $ref: "#/definitions/relationship"
46032       resource-version:
46033         type: string
46034         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46035       selflink:
46036         type: string
46037         description: the self link for this FP
46038       forwarders:
46039         type: array
46040         items:
46041           $ref: "#/definitions/forwarder"
46042   forwarding-paths:
46043     properties:
46044       forwarding-path:
46045         type: array
46046         items:
46047           $ref: "#/definitions/forwarding-path"
46048   generic-vnf:
46049     description: |
46050       General purpose VNF
46051       ###### Related Nodes
46052       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
46053       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
46054       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
46055       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
46056       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
46057       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
46058       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
46059       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
46060       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
46061       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
46062       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
46063       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
46064       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
46065       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
46066       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
46067       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
46068       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
46069       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
46070       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
46071       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
46072       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
46073       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
46074       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
46075       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
46076       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
46077       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
46078       - FROM platform( platform Uses generic-vnf, MANY2MANY)
46079
46080       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
46081       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
46082     required:
46083     - vnf-id
46084     - vnf-name
46085     - vnf-type
46086     - in-maint
46087     - is-closed-loop-disabled
46088     properties:
46089       vnf-id:
46090         type: string
46091         description: Unique id of VNF.  This is unique across the graph.
46092       vnf-instance-id:
46093         type: string
46094         description: vnf instance id.
46095       vnf-name:
46096         type: string
46097         description: Name of VNF.
46098       vnf-name2:
46099         type: string
46100         description: Alternate name of VNF.
46101       vnf-type:
46102         type: string
46103         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.
46104       service-id:
46105         type: string
46106         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
46107       regional-resource-zone:
46108         type: string
46109         description: Regional way of organizing pservers, source of truth should define values
46110       prov-status:
46111         type: string
46112         description: Trigger for operational monitoring of this resource by Service Assurance systems.
46113       operational-status:
46114         type: string
46115         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
46116       license-key:
46117         type: string
46118         description: OBSOLETE -  do not use
46119       equipment-role:
46120         type: string
46121         description: Client should send valid enumerated value
46122       orchestration-status:
46123         type: string
46124         description: Orchestration status of this VNF, used by MSO.
46125       vnf-package-name:
46126         type: string
46127       vnf-discriptor-name:
46128         type: string
46129         description: vnf discriptor name
46130       job-id:
46131         type: string
46132         description: job id corresponding to vnf
46133       heat-stack-id:
46134         type: string
46135         description: Heat stack id corresponding to this instance, managed by MSO
46136       mso-catalog-key:
46137         type: string
46138         description: Corresponds to the SDN-C catalog id used to configure this VCE
46139       management-option:
46140         type: string
46141         description: identifier of managed by ATT or customer
46142       ipv4-oam-address:
46143         type: string
46144         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
46145       ipv4-loopback0-address:
46146         type: string
46147         description: v4 Loopback0 address
46148       nm-lan-v6-address:
46149         type: string
46150         description: v6 Loopback address
46151       management-v6-address:
46152         type: string
46153         description: v6 management address
46154       vcpu:
46155         type: integer
46156         format: int64
46157         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
46158       vcpu-units:
46159         type: string
46160         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
46161       vmemory:
46162         type: integer
46163         format: int64
46164         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
46165       vmemory-units:
46166         type: string
46167         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
46168       vdisk:
46169         type: integer
46170         format: int64
46171         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
46172       vdisk-units:
46173         type: string
46174         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
46175       nshd:
46176         type: integer
46177         format: int64
46178         description: number of associated SHD in vnf.
46179       nvm:
46180         type: integer
46181         format: int64
46182         description: number of vms in vnf.
46183       nnet:
46184         type: integer
46185         format: int64
46186         description: number of network in vnf.
46187       in-maint:
46188         type: boolean
46189         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.
46190       is-closed-loop-disabled:
46191         type: boolean
46192         description: used to indicate whether closed loop function is enabled on this node
46193       resource-version:
46194         type: string
46195         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46196       summary-status:
46197         type: string
46198         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
46199       encrypted-access-flag:
46200         type: boolean
46201         description: indicates whether generic-vnf access uses SSH
46202       entitlement-assignment-group-uuid:
46203         type: string
46204         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
46205       entitlement-resource-uuid:
46206         type: string
46207         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
46208       license-assignment-group-uuid:
46209         type: string
46210         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
46211       license-key-uuid:
46212         type: string
46213         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
46214       model-invariant-id:
46215         type: string
46216         description: the ASDC model id for this resource or service model.
46217       model-version-id:
46218         type: string
46219         description: the ASDC model version for this resource or service model.
46220       persona-model-version:
46221         type: string
46222         description: the ASDC model version for this resource or service model.
46223       model-customization-id:
46224         type: string
46225         description: captures the id of all the configuration used to customize the resource for the service.
46226       widget-model-id:
46227         type: string
46228         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46229       widget-model-version:
46230         type: string
46231         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46232       as-number:
46233         type: string
46234         description: as-number of the VNF
46235       regional-resource-subzone:
46236         type: string
46237         description: represents sub zone of the rr plane
46238       nf-type:
46239         type: string
46240         description: Generic description of the type of NF
46241       nf-function:
46242         type: string
46243         description: English description of Network function that the specific VNF deployment is providing
46244       nf-role:
46245         type: string
46246         description: role in the network that this model will be providing
46247       nf-naming-code:
46248         type: string
46249         description: string assigned to this model used for naming purposes
46250       selflink:
46251         type: string
46252         description: Path to the controller object.
46253       ipv4-oam-gateway-address:
46254         type: string
46255         description: Gateway address
46256       ipv4-oam-gateway-address-prefix-length:
46257         type: integer
46258         format: int32
46259         description: Prefix length for oam-address
46260       vlan-id-outer:
46261         type: integer
46262         format: int64
46263         description: Temporary location for S-TAG to get to VCE
46264       nm-profile-name:
46265         type: string
46266         description: Network Management profile of this VNF
46267       relationship-list:
46268         type: array
46269         items:
46270           $ref: "#/definitions/relationship"
46271       l-interfaces:
46272         type: array
46273         items:
46274           $ref: "#/definitions/l-interface"
46275       lag-interfaces:
46276         type: array
46277         items:
46278           $ref: "#/definitions/lag-interface"
46279       vf-modules:
46280         type: array
46281         items:
46282           $ref: "#/definitions/vf-module"
46283       licenses:
46284         type: array
46285         items:
46286           $ref: "#/definitions/license"
46287       entitlements:
46288         type: array
46289         items:
46290           $ref: "#/definitions/entitlement"
46291   generic-vnfs:
46292     description: |
46293       Collection of VNFs
46294     properties:
46295       generic-vnf:
46296         type: array
46297         items:
46298           $ref: "#/definitions/generic-vnf"
46299   group-assignment:
46300     description: |
46301       Openstack group-assignment used to store exclusivity groups (EG).
46302       ###### Related Nodes
46303       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
46304       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
46305       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
46306
46307     required:
46308     - group-id
46309     - group-type
46310     - group-name
46311     properties:
46312       group-id:
46313         type: string
46314         description: Group id, expected to be unique across cloud-region.
46315       group-type:
46316         type: string
46317         description: Group type - the type of group this instance refers to
46318       group-name:
46319         type: string
46320         description: Group name - name assigned to the group
46321       group-description:
46322         type: string
46323         description: Group description - description of the group
46324       resource-version:
46325         type: string
46326         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46327       relationship-list:
46328         type: array
46329         items:
46330           $ref: "#/definitions/relationship"
46331   group-assignments:
46332     description: |
46333       Collection of openstack group assignments
46334     properties:
46335       group-assignment:
46336         type: array
46337         items:
46338           $ref: "#/definitions/group-assignment"
46339   host-route:
46340     description: |
46341       ###### Related Nodes
46342       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
46343
46344       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
46345     required:
46346     - host-route-id
46347     - route-prefix
46348     - next-hop
46349     properties:
46350       host-route-id:
46351         type: string
46352         description: host-route id
46353       route-prefix:
46354         type: string
46355         description: subnet prefix
46356       next-hop:
46357         type: string
46358         description: Could be ip-address, hostname, or service-instance
46359       next-hop-type:
46360         type: string
46361         description: Should be ip-address, hostname, or service-instance to match next-hop
46362       resource-version:
46363         type: string
46364         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46365       relationship-list:
46366         type: array
46367         items:
46368           $ref: "#/definitions/relationship"
46369   host-routes:
46370     properties:
46371       host-route:
46372         type: array
46373         items:
46374           $ref: "#/definitions/host-route"
46375   hpa-capabilities:
46376     description: |
46377       Collection of HPA Capabilities
46378     properties:
46379       hpa-capability:
46380         type: array
46381         items:
46382           $ref: "#/definitions/hpa-capability"
46383   hpa-capability:
46384     description: |
46385       Represents a HPA capability
46386       ###### Related Nodes
46387       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
46388       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
46389       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
46390
46391       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
46392     required:
46393     - hpa-capability-id
46394     - hpa-feature
46395     properties:
46396       hpa-capability-id:
46397         type: string
46398         description: UUID to uniquely identify a HPA capability
46399       hpa-feature:
46400         type: string
46401         description: Name of the HPACapability
46402       hpa-version:
46403         type: string
46404         description: HPA schema version
46405       architecture:
46406         type: string
46407         description: Hardware architecture
46408       resource-version:
46409         type: string
46410         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46411       relationship-list:
46412         type: array
46413         items:
46414           $ref: "#/definitions/relationship"
46415       hpa-feature-attributes:
46416         type: array
46417         items:
46418           $ref: "#/definitions/hpa-feature-attributes"
46419   hpa-feature-attributes:
46420     description: |
46421       HPA Capability Feature attributes
46422       ###### Related Nodes
46423       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
46424
46425       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
46426     required:
46427     - hpa-attribute-key
46428     properties:
46429       hpa-attribute-key:
46430         type: string
46431         description: name of the specific HPA attribute
46432       hpa-attribute-value:
46433         type: string
46434         description: JSON string specifying the value, unit and type of the specific HPA attribute
46435       resource-version:
46436         type: string
46437         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46438       relationship-list:
46439         type: array
46440         items:
46441           $ref: "#/definitions/relationship"
46442   image:
46443     description: |
46444       Openstack image.
46445       ###### Related Nodes
46446       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
46447       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
46448       - FROM vserver( vserver Uses image, MANY2ONE)
46449
46450       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
46451       -IMAGE cannot be deleted if related to VSERVER
46452
46453     required:
46454     - image-id
46455     - image-name
46456     - image-os-distro
46457     - image-os-version
46458     - image-selflink
46459     properties:
46460       image-id:
46461         type: string
46462         description: Image id, expected to be unique across cloud region
46463       image-name:
46464         type: string
46465         description: Image name
46466       image-architecture:
46467         type: string
46468         description: Operating system architecture.
46469       image-os-distro:
46470         type: string
46471         description: The common name of the operating system distribution in lowercase
46472       image-os-version:
46473         type: string
46474         description: The operating system version as specified by the distributor.
46475       application:
46476         type: string
46477         description: The application that the image instantiates.
46478       application-vendor:
46479         type: string
46480         description: The vendor of the application.
46481       application-version:
46482         type: string
46483         description: The version of the application.
46484       image-selflink:
46485         type: string
46486         description: URL to endpoint where AAI can get more details
46487       resource-version:
46488         type: string
46489         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46490       relationship-list:
46491         type: array
46492         items:
46493           $ref: "#/definitions/relationship"
46494       metadata:
46495         type: array
46496         items:
46497           $ref: "#/definitions/metadatum"
46498   images:
46499     description: |
46500       Collectio of Openstack images.
46501     properties:
46502       image:
46503         type: array
46504         items:
46505           $ref: "#/definitions/image"
46506   include-node-filter:
46507     properties:
46508       include-node-type:
46509         type: string
46510   instance-filter:
46511     description: |
46512       InstanceFilter for performing a named-query or model query
46513   instance-filters:
46514     description: |
46515       InstanceFilters for performing a named-query or model query
46516     properties:
46517       instance-filter:
46518         type: array
46519         items:
46520           $ref: "#/definitions/instance-filter"
46521   instance-group:
46522     description: |
46523       General mechanism for grouping instances
46524       ###### Related Nodes
46525       - TO model( instance-group Targets model, MANY2MANY)
46526       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
46527       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
46528       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
46529       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
46530       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
46531       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
46532       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
46533       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
46534       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
46535       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
46536       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
46537
46538     required:
46539     - id
46540     - description
46541     - type
46542     properties:
46543       instance-group-role:
46544         type: string
46545         description: role of the instance group.
46546       model-invariant-id:
46547         type: string
46548         description: ASDC model id for this resource or service model.
46549       model-version-id:
46550         type: string
46551         description: ASDC model version uid for this resource model.
46552       id:
46553         type: string
46554         description: Instance Group ID, UUID assigned to this instance.
46555       description:
46556         type: string
46557         description: Descriptive text to help identify the usage of this instance-group
46558       type:
46559         type: string
46560         description: Only valid value today is lower case ha for high availability
46561       sub-type:
46562         type: string
46563         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
46564       resource-version:
46565         type: string
46566         description: Concurrency value
46567       relationship-list:
46568         type: array
46569         items:
46570           $ref: "#/definitions/relationship"
46571   instance-groups:
46572     description: |
46573       Collection of openstack route table references
46574     properties:
46575       instance-group:
46576         type: array
46577         items:
46578           $ref: "#/definitions/instance-group"
46579   inventory:
46580     properties:
46581       search:
46582         type: object
46583         $ref: "#/definitions/search"
46584       actions:
46585         type: object
46586         $ref: "#/definitions/actions"
46587       cloud-infrastructure:
46588         type: object
46589         $ref: "#/definitions/cloud-infrastructure"
46590       external-system:
46591         type: object
46592         $ref: "#/definitions/external-system"
46593       business:
46594         type: object
46595         $ref: "#/definitions/business"
46596       service-design-and-creation:
46597         type: object
46598         $ref: "#/definitions/service-design-and-creation"
46599       network:
46600         type: object
46601         $ref: "#/definitions/network"
46602       nodes:
46603         type: object
46604         $ref: "#/definitions/nodes"
46605   inventory-item:
46606     properties:
46607       inventory-item-type:
46608         type: string
46609       inventory-item-link:
46610         type: string
46611       inventory-item-data:
46612         type: array
46613         items:
46614           $ref: "#/definitions/inventory-item-data"
46615       tagged-inventory-item-list:
46616         type: array
46617         items:
46618           $ref: "#/definitions/tagged-inventory-item-list"
46619   inventory-item-data:
46620     properties:
46621       property-name:
46622         type: string
46623       property-value:
46624         type: string
46625   inventory-response-item:
46626     description: |
46627       Inventory item for response list
46628     properties:
46629       model-name:
46630         type: string
46631       extra-properties:
46632         type: object
46633         $ref: "#/definitions/extra-properties"
46634       inventory-response-items:
46635         type: object
46636         $ref: "#/definitions/inventory-response-items"
46637   inventory-response-items:
46638     description: |
46639       Container for inventory items in response list
46640     properties:
46641       inventory-response-item:
46642         type: array
46643         items:
46644           $ref: "#/definitions/inventory-response-item"
46645   ipsec-configuration:
46646     description: |
46647       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
46648       ###### Related Nodes
46649       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
46650       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
46651
46652       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
46653     required:
46654     - ipsec-configuration-id
46655     properties:
46656       ipsec-configuration-id:
46657         type: string
46658         description: UUID of this configuration
46659       requested-vig-address-type:
46660         type: string
46661         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
46662       requested-encryption-strength:
46663         type: string
46664         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
46665       requested-dmz-type:
46666         type: string
46667         description: ATT can offer a shared DMZ or a DMZ specific to a customer
46668       shared-dmz-network-address:
46669         type: string
46670         description: Network address of shared DMZ
46671       requested-customer-name:
46672         type: string
46673         description: If the DMZ is a custom DMZ, this field will indicate the customer information
46674       ike-version:
46675         type: string
46676         description: can be 1 or 2
46677       ikev1-authentication:
46678         type: string
46679         description: Contains values like md5, sha1, sha256, sha384
46680       ikev1-encryption:
46681         type: string
46682         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
46683       ikev1-dh-group:
46684         type: string
46685         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
46686       ikev1-am-group-id:
46687         type: string
46688         description: Group name defined in VIG for clients using aggressive mode
46689       ikev1-am-password:
46690         type: string
46691         description: pre-shared key for the above group name
46692       ikev1-sa-lifetime:
46693         type: string
46694         description: Lifetime for IKEv1 SA
46695       ipsec-authentication:
46696         type: string
46697         description: md5, sha1, sha256, sha384
46698       ipsec-encryption:
46699         type: string
46700         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
46701       ipsec-sa-lifetime:
46702         type: string
46703         description: Life time for IPSec SA
46704       ipsec-pfs:
46705         type: string
46706         description: enable PFS or not
46707       xauth-userid:
46708         type: string
46709         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
46710       xauth-user-password:
46711         type: string
46712         description: Encrypted using the Juniper $9$ algorithm
46713       dpd-interval:
46714         type: string
46715         description: The time between DPD probe
46716       dpd-frequency:
46717         type: string
46718         description: Maximum number of DPD before claiming the tunnel is down
46719       resource-version:
46720         type: string
46721         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46722       relationship-list:
46723         type: array
46724         items:
46725           $ref: "#/definitions/relationship"
46726       vig-servers:
46727         type: array
46728         items:
46729           $ref: "#/definitions/vig-server"
46730   ipsec-configurations:
46731     properties:
46732       ipsec-configuration:
46733         type: array
46734         items:
46735           $ref: "#/definitions/ipsec-configuration"
46736   key-data:
46737     properties:
46738       key-name:
46739         type: string
46740       key-value:
46741         type: string
46742   l-interface:
46743     description: |
46744       Logical interfaces, e.g., a vnic.
46745       ###### Related Nodes
46746       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
46747       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
46748       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
46749       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
46750       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
46751       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
46752       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
46753       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
46754       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
46755       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
46756       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
46757       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
46758       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
46759       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
46760
46761       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
46762       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
46763       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
46764     required:
46765     - interface-name
46766     - is-port-mirrored
46767     - in-maint
46768     - is-ip-unnumbered
46769     properties:
46770       interface-name:
46771         type: string
46772         description: Name given to the interface
46773       interface-role:
46774         type: string
46775         description: E.g., CUSTOMER, UPLINK, etc.
46776       v6-wan-link-ip:
46777         type: string
46778         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
46779       selflink:
46780         type: string
46781         description: URL to endpoint where AAI can get more details
46782       interface-id:
46783         type: string
46784         description: ID of interface
46785       macaddr:
46786         type: string
46787         description: MAC address for the interface
46788       network-name:
46789         type: string
46790         description: Name of the network
46791       management-option:
46792         type: string
46793         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
46794       interface-description:
46795         type: string
46796         description: Human friendly text regarding this interface.
46797       is-port-mirrored:
46798         type: boolean
46799         description: boolean indicatating whether or not port is a mirrored.
46800       resource-version:
46801         type: string
46802         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46803       in-maint:
46804         type: boolean
46805         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46806       prov-status:
46807         type: string
46808         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
46809       is-ip-unnumbered:
46810         type: boolean
46811         description: Flag indicating the interface uses the IP Unnumbered configuration.
46812       allowed-address-pairs:
46813         type: string
46814         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
46815       vlans:
46816         type: array
46817         items:
46818           $ref: "#/definitions/vlan"
46819       sriov-vfs:
46820         type: array
46821         items:
46822           $ref: "#/definitions/sriov-vf"
46823       l-interfaces:
46824         type: array
46825         items:
46826           $ref: "#/definitions/l-interface"
46827       relationship-list:
46828         type: array
46829         items:
46830           $ref: "#/definitions/relationship"
46831       l3-interface-ipv4-address-list:
46832         type: array
46833         items:
46834           $ref: "#/definitions/l3-interface-ipv4-address-list"
46835       l3-interface-ipv6-address-list:
46836         type: array
46837         items:
46838           $ref: "#/definitions/l3-interface-ipv6-address-list"
46839   l-interfaces:
46840     description: |
46841       Collection of logical interfaces.
46842     properties:
46843       l-interface:
46844         type: array
46845         items:
46846           $ref: "#/definitions/l-interface"
46847   l3-interface-ipv4-address-list:
46848     description: |
46849       IPv4 Address Range
46850       ###### Related Nodes
46851       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
46852       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
46853       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
46854       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
46855       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
46856       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
46857
46858       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
46859     required:
46860     - l3-interface-ipv4-address
46861     properties:
46862       l3-interface-ipv4-address:
46863         type: string
46864         description: IP address
46865       l3-interface-ipv4-prefix-length:
46866         type: integer
46867         format: int64
46868         description: Prefix length, 32 for single address
46869       vlan-id-inner:
46870         type: integer
46871         format: int64
46872         description: Inner VLAN tag
46873       vlan-id-outer:
46874         type: integer
46875         format: int64
46876         description: Outer VLAN tag
46877       is-floating:
46878         type: boolean
46879         description: Indicator of fixed or floating address
46880       resource-version:
46881         type: string
46882         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46883       neutron-network-id:
46884         type: string
46885         description: Neutron network id of the interface that address belongs to
46886       neutron-subnet-id:
46887         type: string
46888         description: Neutron id of subnet that address belongs to
46889       relationship-list:
46890         type: array
46891         items:
46892           $ref: "#/definitions/relationship"
46893   l3-interface-ipv6-address-list:
46894     description: |
46895       IPv6 Address Range
46896       ###### Related Nodes
46897       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
46898       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
46899       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
46900       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
46901       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
46902       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
46903
46904       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
46905     required:
46906     - l3-interface-ipv6-address
46907     properties:
46908       l3-interface-ipv6-address:
46909         type: string
46910         description: IP address
46911       l3-interface-ipv6-prefix-length:
46912         type: integer
46913         format: int64
46914         description: Prefix length, 128 for single address
46915       vlan-id-inner:
46916         type: integer
46917         format: int64
46918         description: Inner VLAN tag
46919       vlan-id-outer:
46920         type: integer
46921         format: int64
46922         description: Outer VLAN tag
46923       is-floating:
46924         type: boolean
46925         description: Indicator of fixed or floating address
46926       resource-version:
46927         type: string
46928         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46929       neutron-network-id:
46930         type: string
46931         description: Neutron network id of the interface that address belongs to
46932       neutron-subnet-id:
46933         type: string
46934         description: Neutron id of subnet that address belongs to
46935       relationship-list:
46936         type: array
46937         items:
46938           $ref: "#/definitions/relationship"
46939   l3-network:
46940     description: |
46941       Generic network definition
46942       ###### Related Nodes
46943       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
46944       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
46945       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
46946       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
46947       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
46948       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
46949       - FROM complex( complex Uses l3-network, MANY2MANY)
46950       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
46951       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
46952       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
46953       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
46954       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
46955       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
46956       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
46957       - FROM tenant( tenant Uses l3-network, MANY2MANY)
46958       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
46959
46960       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
46961     required:
46962     - network-id
46963     - network-name
46964     - is-bound-to-vpn
46965     - is-provider-network
46966     - is-shared-network
46967     - is-external-network
46968     properties:
46969       network-id:
46970         type: string
46971         description: Network ID, should be uuid. Unique across A&AI.
46972       network-name:
46973         type: string
46974         description: Name of the network, governed by some naming convention..
46975       network-type:
46976         type: string
46977         description: Type of the network - who defines these values?
46978       network-role:
46979         type: string
46980         description: Role the network plans - who defines these values?
46981       network-technology:
46982         type: string
46983         description: Network technology - who defines these values?
46984       neutron-network-id:
46985         type: string
46986         description: Neutron network id of this Interface
46987       is-bound-to-vpn:
46988         type: boolean
46989         description: Set to true if bound to VPN
46990       service-id:
46991         type: string
46992         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
46993       network-role-instance:
46994         type: integer
46995         format: int64
46996         description: network role instance
46997       resource-version:
46998         type: string
46999         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47000       orchestration-status:
47001         type: string
47002         description: Orchestration status of this VNF, mastered by MSO
47003       heat-stack-id:
47004         type: string
47005         description: Heat stack id corresponding to this instance, managed by MSO
47006       mso-catalog-key:
47007         type: string
47008         description: Corresponds to the SDN-C catalog id used to configure this VCE
47009       contrail-network-fqdn:
47010         type: string
47011         description: Contrail FQDN for the network
47012       model-invariant-id:
47013         type: string
47014         description: the ASDC model id for this resource or service model.
47015       model-version-id:
47016         type: string
47017         description: the ASDC model version for this resource or service model.
47018       persona-model-version:
47019         type: string
47020         description: the ASDC model version for this resource or service model.
47021       model-customization-id:
47022         type: string
47023         description: captures the id of all the configuration used to customize the resource for the service.
47024       widget-model-id:
47025         type: string
47026         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47027       widget-model-version:
47028         type: string
47029         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47030       physical-network-name:
47031         type: string
47032         description: Name associated with the physical network.
47033       is-provider-network:
47034         type: boolean
47035         description: boolean indicatating whether or not network is a provider network.
47036       is-shared-network:
47037         type: boolean
47038         description: boolean indicatating whether or not network is a shared network.
47039       is-external-network:
47040         type: boolean
47041         description: boolean indicatating whether or not network is an external network.
47042       selflink:
47043         type: string
47044         description: Path to the controller object.
47045       operational-status:
47046         type: string
47047         description: Indicator for whether the resource is considered operational.
47048       subnets:
47049         type: array
47050         items:
47051           $ref: "#/definitions/subnet"
47052       ctag-assignments:
47053         type: array
47054         items:
47055           $ref: "#/definitions/ctag-assignment"
47056       segmentation-assignments:
47057         type: array
47058         items:
47059           $ref: "#/definitions/segmentation-assignment"
47060       relationship-list:
47061         type: array
47062         items:
47063           $ref: "#/definitions/relationship"
47064         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
47065   l3-networks:
47066     properties:
47067       l3-network:
47068         type: array
47069         items:
47070           $ref: "#/definitions/l3-network"
47071   lag-interface:
47072     description: |
47073       Link aggregate interface
47074       ###### Related Nodes
47075       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
47076       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
47077       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
47078       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
47079       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
47080       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
47081       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
47082       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
47083
47084       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
47085       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
47086       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
47087     required:
47088     - interface-name
47089     - in-maint
47090     properties:
47091       interface-name:
47092         type: string
47093         description: Name that identifies the link aggregate interface
47094       interface-description:
47095         type: string
47096         description: Human friendly text regarding this interface.
47097       resource-version:
47098         type: string
47099         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47100       speed-value:
47101         type: string
47102         description: Captures the numeric part of the speed
47103       speed-units:
47104         type: string
47105         description: Captures the units corresponding to the speed
47106       interface-id:
47107         type: string
47108         description: ID of interface
47109       interface-role:
47110         type: string
47111         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
47112       prov-status:
47113         type: string
47114         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47115       in-maint:
47116         type: boolean
47117         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
47118       relationship-list:
47119         type: array
47120         items:
47121           $ref: "#/definitions/relationship"
47122       l-interfaces:
47123         type: array
47124         items:
47125           $ref: "#/definitions/l-interface"
47126   lag-interfaces:
47127     description: |
47128       Collection of link aggregate interfaces.
47129     properties:
47130       lag-interface:
47131         type: array
47132         items:
47133           $ref: "#/definitions/lag-interface"
47134   lag-link:
47135     description: |
47136       LAG links can connect lag-interfaces
47137       ###### Related Nodes
47138       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
47139       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
47140
47141       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
47142     required:
47143     - link-name
47144     properties:
47145       link-name:
47146         type: string
47147         description: Alphabetical concatenation of lag-interface names
47148       resource-version:
47149         type: string
47150         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47151       relationship-list:
47152         type: array
47153         items:
47154           $ref: "#/definitions/relationship"
47155   lag-links:
47156     description: |
47157       Collection of link aggregation connections
47158     properties:
47159       lag-link:
47160         type: array
47161         items:
47162           $ref: "#/definitions/lag-link"
47163   license:
47164     description: |
47165       Metadata for license group.
47166       ###### Related Nodes
47167       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
47168       - TO vce( license BelongsTo vce, MANY2ONE)(4)
47169
47170       -(4) IF this TO node is deleted, this LICENSE is DELETED also
47171     required:
47172     - group-uuid
47173     - resource-uuid
47174     properties:
47175       group-uuid:
47176         type: string
47177         description: Unique ID for the license group the resource belongs to, should be uuid.
47178       resource-uuid:
47179         type: string
47180         description: Unique ID of a license resource.
47181       resource-version:
47182         type: string
47183         description: Concurrency value
47184       relationship-list:
47185         type: array
47186         items:
47187           $ref: "#/definitions/relationship"
47188   licenses:
47189     description: |
47190       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
47191     properties:
47192       license:
47193         type: array
47194         items:
47195           $ref: "#/definitions/license"
47196   line-of-business:
47197     description: |
47198       describes a line-of-business
47199       ###### Related Nodes
47200       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
47201
47202     required:
47203     - line-of-business-name
47204     properties:
47205       line-of-business-name:
47206         type: string
47207         description: Name of the line-of-business (product)
47208       resource-version:
47209         type: string
47210         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47211       relationship-list:
47212         type: array
47213         items:
47214           $ref: "#/definitions/relationship"
47215   lines-of-business:
47216     description: |
47217       Collection of lines-of-business
47218     properties:
47219       line-of-business:
47220         type: array
47221         items:
47222           $ref: "#/definitions/line-of-business"
47223   logical-link:
47224     description: |
47225       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
47226       ###### Related Nodes
47227       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
47228       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
47229       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
47230       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
47231       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
47232       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
47233       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
47234       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
47235       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
47236       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
47237       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
47238       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
47239       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
47240       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
47241       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
47242
47243       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
47244     required:
47245     - link-name
47246     - in-maint
47247     - link-type
47248     properties:
47249       link-name:
47250         type: string
47251         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
47252       in-maint:
47253         type: boolean
47254         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.
47255       link-type:
47256         type: string
47257         description: Type of logical link, e.g., evc
47258       speed-value:
47259         type: string
47260         description: Captures the numeric part of the speed
47261       speed-units:
47262         type: string
47263         description: Captures the units corresponding to the speed
47264       ip-version:
47265         type: string
47266         description: v4, v6, or ds for dual stack
47267       routing-protocol:
47268         type: string
47269         description: For example, static or BGP
47270       resource-version:
47271         type: string
47272         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47273       model-invariant-id:
47274         type: string
47275         description: the ASDC model id for this resource or service model.
47276       model-version-id:
47277         type: string
47278         description: the ASDC model version for this resource or service model.
47279       persona-model-version:
47280         type: string
47281         description: the ASDC model version for this resource or service model.
47282       widget-model-id:
47283         type: string
47284         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47285       widget-model-version:
47286         type: string
47287         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47288       operational-status:
47289         type: string
47290         description: Indication of operational status of the logical link.
47291       prov-status:
47292         type: string
47293         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47294       link-role:
47295         type: string
47296         description: Indication of the network use of the logical link.
47297       link-name2:
47298         type: string
47299         description: Alias or alternate name (CLCI or D1 name).
47300       link-id:
47301         type: string
47302         description: UUID of the logical-link, SDNC generates this.
47303       circuit-id:
47304         type: string
47305         description: Circuit id
47306       purpose:
47307         type: string
47308         description: Reason for this entity, role it is playing
47309       relationship-list:
47310         type: array
47311         items:
47312           $ref: "#/definitions/relationship"
47313   logical-links:
47314     description: |
47315       Collection of logical connections
47316     properties:
47317       logical-link:
47318         type: array
47319         items:
47320           $ref: "#/definitions/logical-link"
47321   metadata:
47322     description: |
47323       Collection of metadatum (key/value pairs)
47324     properties:
47325       metadatum:
47326         type: array
47327         items:
47328           $ref: "#/definitions/metadatum"
47329   metadatum:
47330     description: |
47331       Key/value pairs
47332       ###### Related Nodes
47333       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
47334       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
47335       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
47336       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
47337       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
47338
47339       -(4) IF this TO node is deleted, this METADATUM is DELETED also
47340     required:
47341     - metaname
47342     - metaval
47343     properties:
47344       metaname:
47345         type: string
47346       metaval:
47347         type: string
47348       resource-version:
47349         type: string
47350         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47351   model:
47352     description: |
47353       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
47354       ###### Related Nodes
47355       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
47356       - FROM instance-group( instance-group Targets model, MANY2MANY)
47357       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
47358       - FROM named-query( named-query AppliesTo model, ONE2MANY)
47359       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
47360
47361       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
47362       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
47363
47364     required:
47365     - model-invariant-id
47366     - model-type
47367     properties:
47368       model-invariant-id:
47369         type: string
47370         description: Unique identifier corresponding to the main definition of a model in ASDC
47371       model-type:
47372         type: string
47373         description: Type of the model, e.g., service, resource, widget, etc.
47374       resource-version:
47375         type: string
47376         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47377       model-vers:
47378         type: array
47379         items:
47380           $ref: "#/definitions/model-ver"
47381       relationship-list:
47382         type: array
47383         items:
47384           $ref: "#/definitions/relationship"
47385   model-and-named-query-search:
47386     description: |
47387       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
47388     properties:
47389       query-parameters:
47390         type: object
47391         $ref: "#/definitions/query-parameters"
47392       instance-filters:
47393         type: object
47394         $ref: "#/definitions/instance-filters"
47395       secondary-filts:
47396         type: object
47397         $ref: "#/definitions/secondary-filts"
47398       top-node-type:
47399         type: string
47400       secondary-filter-cut-point:
47401         type: string
47402   model-constraint:
47403     description: |
47404       This is how we would capture constraints defining allowed sets of elements.
47405       ###### Related Nodes
47406       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
47407       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
47408
47409       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
47410       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
47411     required:
47412     - model-constraint-uuid
47413     - constrained-element-set-uuid-to-replace
47414     properties:
47415       model-constraint-uuid:
47416         type: string
47417       constrained-element-set-uuid-to-replace:
47418         type: string
47419       constrained-element-sets:
47420         type: array
47421         items:
47422           $ref: "#/definitions/constrained-element-set"
47423       resource-version:
47424         type: string
47425         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47426   model-constraints:
47427     properties:
47428       model-constraint:
47429         type: array
47430         items:
47431           $ref: "#/definitions/model-constraint"
47432   model-element:
47433     description: |
47434       Defines how other models combine to make up a higher-level model.
47435       ###### Related Nodes
47436       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
47437       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
47438       - TO model-ver( model-element IsA model-ver, MANY2ONE)
47439       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
47440       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
47441       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
47442       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
47443
47444       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
47445       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
47446     required:
47447     - model-element-uuid
47448     - new-data-del-flag
47449     - cardinality
47450     properties:
47451       model-element-uuid:
47452         type: string
47453       new-data-del-flag:
47454         type: string
47455         description: Indicates whether this element was created as part of instantiation from this model
47456       cardinality:
47457         type: string
47458         description: How many of this type of element are required/allowed
47459       linkage-points:
47460         type: string
47461       resource-version:
47462         type: string
47463         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47464       model-elements:
47465         type: array
47466         items:
47467           $ref: "#/definitions/model-element"
47468         description: Defines how other models combine to make up a higher-level model
47469       model-constraints:
47470         type: array
47471         items:
47472           $ref: "#/definitions/model-constraint"
47473         description: Describes new constraints on this model element that are not part of that model's definition
47474       relationship-list:
47475         type: array
47476         items:
47477           $ref: "#/definitions/relationship"
47478   model-elements:
47479     properties:
47480       model-element:
47481         type: array
47482         items:
47483           $ref: "#/definitions/model-element"
47484   model-ver:
47485     description: |
47486       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
47487       ###### Related Nodes
47488       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
47489       - FROM model-element( model-element IsA model-ver, MANY2ONE)
47490       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
47491       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
47492
47493       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
47494       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
47495       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
47496
47497     required:
47498     - model-version-id
47499     - model-name
47500     - model-version
47501     properties:
47502       model-version-id:
47503         type: string
47504         description: Unique identifier corresponding to one version of a model in ASDC
47505       model-name:
47506         type: string
47507         description: Name of the model, which can change from version to version.
47508       model-version:
47509         type: string
47510         description: Version
47511       model-description:
47512         type: string
47513         description: Description
47514       resource-version:
47515         type: string
47516         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47517       model-elements:
47518         type: array
47519         items:
47520           $ref: "#/definitions/model-element"
47521       metadata:
47522         type: array
47523         items:
47524           $ref: "#/definitions/metadatum"
47525       relationship-list:
47526         type: array
47527         items:
47528           $ref: "#/definitions/relationship"
47529   model-vers:
47530     properties:
47531       model-ver:
47532         type: array
47533         items:
47534           $ref: "#/definitions/model-ver"
47535   models:
47536     description: |
47537       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
47538     properties:
47539       model:
47540         type: array
47541         items:
47542           $ref: "#/definitions/model"
47543   multicast-configuration:
47544     description: |
47545       ###### Related Nodes
47546       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
47547
47548     required:
47549     - multicast-configuration-id
47550     - multicast-protocol
47551     - rp-type
47552     properties:
47553       multicast-configuration-id:
47554         type: string
47555         description: Unique id of multicast configuration.
47556       multicast-protocol:
47557         type: string
47558         description: protocol of multicast configuration
47559       rp-type:
47560         type: string
47561         description: rp type of multicast configuration
47562       resource-version:
47563         type: string
47564         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47565       relationship-list:
47566         type: array
47567         items:
47568           $ref: "#/definitions/relationship"
47569   multicast-configurations:
47570     description: |
47571       multicast configuration of generic-vnf ip-address
47572     properties:
47573       multicast-configuration:
47574         type: array
47575         items:
47576           $ref: "#/definitions/multicast-configuration"
47577   named-queries:
47578     properties:
47579       named-query:
47580         type: array
47581         items:
47582           $ref: "#/definitions/named-query"
47583   named-query:
47584     description: |
47585       TBD
47586       ###### Related Nodes
47587       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
47588       - TO model( named-query AppliesTo model, ONE2MANY)
47589       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
47590
47591       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
47592     required:
47593     - named-query-uuid
47594     - named-query-name
47595     - named-query-version
47596     properties:
47597       named-query-uuid:
47598         type: string
47599       named-query-name:
47600         type: string
47601       named-query-version:
47602         type: string
47603       required-input-param:
47604         type: string
47605       description:
47606         type: string
47607       resource-version:
47608         type: string
47609       named-query-elements:
47610         type: array
47611         items:
47612           $ref: "#/definitions/named-query-element"
47613       relationship-list:
47614         type: array
47615         items:
47616           $ref: "#/definitions/relationship"
47617   named-query-element:
47618     description: |
47619       TBD
47620       ###### Related Nodes
47621       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
47622       - TO model( named-query-element IsA model, MANY2ONE)
47623       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
47624       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
47625       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
47626       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
47627
47628       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
47629       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
47630     required:
47631     - named-query-element-uuid
47632     properties:
47633       named-query-element-uuid:
47634         type: string
47635       property-collect-list:
47636         type: string
47637       resource-version:
47638         type: string
47639       property-limit-desc:
47640         type: string
47641       do-not-output:
47642         type: string
47643       named-query-elements:
47644         type: array
47645         items:
47646           $ref: "#/definitions/named-query-element"
47647       related-lookups:
47648         type: array
47649         items:
47650           $ref: "#/definitions/related-lookup"
47651       property-constraints:
47652         type: array
47653         items:
47654           $ref: "#/definitions/property-constraint"
47655       relationship-list:
47656         type: array
47657         items:
47658           $ref: "#/definitions/relationship"
47659   named-query-elements:
47660     properties:
47661       named-query-element:
47662         type: array
47663         items:
47664           $ref: "#/definitions/named-query-element"
47665   network:
47666     description: |
47667       Namespace for network inventory resources.
47668     properties:
47669       logical-links:
47670         type: array
47671         items:
47672           $ref: "#/definitions/logical-link"
47673       site-pair-sets:
47674         type: array
47675         items:
47676           $ref: "#/definitions/site-pair-set"
47677       vpn-bindings:
47678         type: array
47679         items:
47680           $ref: "#/definitions/vpn-binding"
47681       vpls-pes:
47682         type: array
47683         items:
47684           $ref: "#/definitions/vpls-pe"
47685       multicast-configurations:
47686         type: array
47687         items:
47688           $ref: "#/definitions/multicast-configuration"
47689       vces:
47690         type: array
47691         items:
47692           $ref: "#/definitions/vce"
47693       vnfcs:
47694         type: array
47695         items:
47696           $ref: "#/definitions/vnfc"
47697       l3-networks:
47698         type: array
47699         items:
47700           $ref: "#/definitions/l3-network"
47701       network-policies:
47702         type: array
47703         items:
47704           $ref: "#/definitions/network-policy"
47705       generic-vnfs:
47706         type: array
47707         items:
47708           $ref: "#/definitions/generic-vnf"
47709       lag-links:
47710         type: array
47711         items:
47712           $ref: "#/definitions/lag-link"
47713       newvces:
47714         type: array
47715         items:
47716           $ref: "#/definitions/newvce"
47717       pnfs:
47718         type: array
47719         items:
47720           $ref: "#/definitions/pnf"
47721       physical-links:
47722         type: array
47723         items:
47724           $ref: "#/definitions/physical-link"
47725       ipsec-configurations:
47726         type: array
47727         items:
47728           $ref: "#/definitions/ipsec-configuration"
47729       route-table-references:
47730         type: array
47731         items:
47732           $ref: "#/definitions/route-table-reference"
47733       instance-groups:
47734         type: array
47735         items:
47736           $ref: "#/definitions/instance-group"
47737       zones:
47738         type: array
47739         items:
47740           $ref: "#/definitions/zone"
47741       configurations:
47742         type: array
47743         items:
47744           $ref: "#/definitions/configurations"
47745   network-policies:
47746     properties:
47747       network-policy:
47748         type: array
47749         items:
47750           $ref: "#/definitions/network-policy"
47751   network-policy:
47752     description: |
47753       ###### Related Nodes
47754       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
47755       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
47756
47757     required:
47758     - network-policy-id
47759     properties:
47760       network-policy-id:
47761         type: string
47762         description: UUID representing unique key to this instance
47763       network-policy-fqdn:
47764         type: string
47765         description: Contrail FQDN for the policy
47766       heat-stack-id:
47767         type: string
47768         description: ID for the openStack Heat instance
47769       resource-version:
47770         type: string
47771         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47772       relationship-list:
47773         type: array
47774         items:
47775           $ref: "#/definitions/relationship"
47776   network-profile:
47777     description: |
47778       Network profile populated by SDN-GP for SNMP
47779       ###### Related Nodes
47780       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
47781
47782     required:
47783     - nm-profile-name
47784     properties:
47785       nm-profile-name:
47786         type: string
47787         description: Unique name of network profile.
47788       community-string:
47789         type: string
47790         description: Encrypted SNMP community string
47791       resource-version:
47792         type: string
47793         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47794       relationship-list:
47795         type: array
47796         items:
47797           $ref: "#/definitions/relationship"
47798   network-profiles:
47799     description: |
47800       Collection of network profiles
47801     properties:
47802       network-profile:
47803         type: array
47804         items:
47805           $ref: "#/definitions/network-profile"
47806   newvce:
47807     description: |
47808       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
47809       ###### Related Nodes
47810       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
47811
47812       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
47813     required:
47814     - vnf-id2
47815     - vnf-name
47816     - vnf-type
47817     properties:
47818       vnf-id2:
47819         type: string
47820         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
47821       vnf-name:
47822         type: string
47823         description: Name of VNF.
47824       vnf-name2:
47825         type: string
47826         description: Alternate name of VNF.
47827       vnf-type:
47828         type: string
47829         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.
47830       prov-status:
47831         type: string
47832         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47833       operational-status:
47834         type: string
47835         description: Indicator for whether the resource is considered operational
47836       license-key:
47837         type: string
47838         description: OBSOLETE -  do not use
47839       ipv4-oam-address:
47840         type: string
47841         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).
47842       equipment-role:
47843         type: string
47844         description: Client should send valid enumerated value.
47845       resource-version:
47846         type: string
47847         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47848       ipv4-loopback0-address:
47849         type: string
47850         description: v4 Loopback0 address
47851       orchestration-status:
47852         type: string
47853         description: Orchestration status of this VNF, mastered by MSO.
47854       heat-stack-id:
47855         type: string
47856         description: Heat stack id corresponding to this instance, managed by MSO
47857       mso-catalog-key:
47858         type: string
47859         description: Corresponds to the SDN-C catalog id used to configure this VCE
47860       relationship-list:
47861         type: array
47862         items:
47863           $ref: "#/definitions/relationship"
47864       l-interfaces:
47865         type: array
47866         items:
47867           $ref: "#/definitions/l-interface"
47868   newvces:
47869     description: |
47870       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
47871     properties:
47872       newvce:
47873         type: array
47874         items:
47875           $ref: "#/definitions/newvce"
47876   nodes:
47877     properties:
47878       inventory-item-data:
47879         type: array
47880         items:
47881           $ref: "#/definitions/inventory-item-data"
47882   notification-event:
47883     properties:
47884       cambria.partition:
47885         type: string
47886       notification-event-header:
47887         type: object
47888         $ref: "#/definitions/notification-event-header"
47889   notification-event-header:
47890     properties:
47891       id:
47892         type: string
47893       timestamp:
47894         type: string
47895       source-name:
47896         type: string
47897       domain:
47898         type: string
47899       sequence-number:
47900         type: string
47901       severity:
47902         type: string
47903       event-type:
47904         type: string
47905       version:
47906         type: string
47907       action:
47908         type: string
47909       entity-type:
47910         type: string
47911       top-entity-type:
47912         type: string
47913       entity-link:
47914         type: string
47915       status:
47916         type: string
47917   notify:
47918     required:
47919     - event-id
47920     properties:
47921       event-id:
47922         type: string
47923       node-type:
47924         type: string
47925       event-trigger:
47926         type: string
47927       key-data:
47928         type: array
47929         items:
47930           $ref: "#/definitions/key-data"
47931       selflink:
47932         type: string
47933   oam-network:
47934     description: |
47935       OAM network, to be deprecated shortly.  Do not use for new purposes.
47936       ###### Related Nodes
47937       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
47938       - TO complex( oam-network AppliesTo complex, MANY2MANY)
47939       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
47940
47941     required:
47942     - network-uuid
47943     - network-name
47944     - cvlan-tag
47945     properties:
47946       network-uuid:
47947         type: string
47948         description: UUID of the network. Unique across a cloud-region
47949       network-name:
47950         type: string
47951         description: Name of the network.
47952       cvlan-tag:
47953         type: integer
47954         format: int64
47955         description: cvlan-id
47956       ipv4-oam-gateway-address:
47957         type: string
47958         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
47959       ipv4-oam-gateway-address-prefix-length:
47960         type: integer
47961         format: int32
47962         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
47963       resource-version:
47964         type: string
47965         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47966       relationship-list:
47967         type: array
47968         items:
47969           $ref: "#/definitions/relationship"
47970   oam-networks:
47971     description: |
47972       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
47973     properties:
47974       oam-network:
47975         type: array
47976         items:
47977           $ref: "#/definitions/oam-network"
47978   operational-environment:
47979     description: |
47980       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
47981       ###### Related Nodes
47982       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
47983       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
47984
47985     required:
47986     - operational-environment-id
47987     - operational-environment-name
47988     - operational-environment-type
47989     - operational-environment-status
47990     - tenant-context
47991     - workload-context
47992     properties:
47993       operational-environment-id:
47994         type: string
47995         description: UUID of an operational environment
47996       operational-environment-name:
47997         type: string
47998         description: Operational Environment name
47999       operational-environment-type:
48000         type: string
48001         description: Operational Environment Type.
48002       operational-environment-status:
48003         type: string
48004         description: Status
48005       tenant-context:
48006         type: string
48007         description: Tenant Context.
48008       workload-context:
48009         type: string
48010         description: Workload Context.
48011       resource-version:
48012         type: string
48013         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48014       relationship-list:
48015         type: array
48016         items:
48017           $ref: "#/definitions/relationship"
48018   operational-environments:
48019     description: |
48020       a logical partition of the cloud which allows to have multiple environments in the production AIC.
48021     properties:
48022       operational-environment:
48023         type: array
48024         items:
48025           $ref: "#/definitions/operational-environment"
48026   overloaded-model:
48027     description: |
48028       Allows for legacy POST of old-style and new-style models
48029     required:
48030     - model-invariant-id
48031     - model-name-version-id
48032     - model-type
48033     - model-name
48034     - model-id
48035     - model-version
48036     properties:
48037       model-invariant-id:
48038         type: string
48039         description: Unique identifier corresponding to the main definition of a model in ASDC
48040       model-name-version-id:
48041         type: string
48042         description: Unique identifier corresponding to one version of a model in ASDC
48043       model-type:
48044         type: string
48045         description: Type of the model, e.g., service, resource, widget, etc.
48046       model-name:
48047         type: string
48048         description: Name of the model, which can change from version to version.
48049       model-id:
48050         type: string
48051         description: Invariant unique ID which does not change from version to version
48052       model-version:
48053         type: string
48054         description: Version
48055       model-description:
48056         type: string
48057         description: Description
48058       resource-version:
48059         type: string
48060         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48061       model-vers:
48062         type: object
48063         $ref: "#/definitions/model-vers"
48064       relationship-list:
48065         type: object
48066         $ref: "#/definitions/relationship-list"
48067   owning-entities:
48068     description: |
48069       Collection of owning-entities
48070     properties:
48071       owning-entity:
48072         type: array
48073         items:
48074           $ref: "#/definitions/owning-entity"
48075   owning-entity:
48076     description: |
48077       describes an owning-entity
48078       ###### Related Nodes
48079       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
48080
48081     required:
48082     - owning-entity-id
48083     - owning-entity-name
48084     properties:
48085       owning-entity-id:
48086         type: string
48087         description: UUID of an owning entity
48088       owning-entity-name:
48089         type: string
48090         description: Owning entity name
48091       resource-version:
48092         type: string
48093         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48094       relationship-list:
48095         type: array
48096         items:
48097           $ref: "#/definitions/relationship"
48098   p-interface:
48099     description: |
48100       Physical interface (e.g., nic)
48101       ###### Related Nodes
48102       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
48103       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
48104       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
48105       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
48106       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
48107       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
48108       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
48109       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
48110
48111       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
48112       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
48113       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
48114     required:
48115     - interface-name
48116     - in-maint
48117     properties:
48118       interface-name:
48119         type: string
48120         description: Name that identifies the physical interface
48121       speed-value:
48122         type: string
48123         description: Captures the numeric part of the speed
48124       speed-units:
48125         type: string
48126         description: Captures the units corresponding to the speed
48127       port-description:
48128         type: string
48129         description: Nature of the services and connectivity on this port.
48130       equipment-identifier:
48131         type: string
48132         description: CLEI or other specification for p-interface hardware.
48133       interface-role:
48134         type: string
48135         description: Role specification for p-interface hardware.
48136       interface-type:
48137         type: string
48138         description: Indicates the physical properties of the interface.
48139       prov-status:
48140         type: string
48141         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48142       mac-addresss:
48143         type: string
48144         description: MAC Address of the p-interface.
48145       resource-version:
48146         type: string
48147         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48148       in-maint:
48149         type: boolean
48150         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
48151       inv-status:
48152         type: string
48153         description: inventory status
48154       relationship-list:
48155         type: array
48156         items:
48157           $ref: "#/definitions/relationship"
48158       sriov-pfs:
48159         type: array
48160         items:
48161           $ref: "#/definitions/sriov-pf"
48162       l-interfaces:
48163         type: array
48164         items:
48165           $ref: "#/definitions/l-interface"
48166   p-interfaces:
48167     description: |
48168       Collection of physical interfaces.
48169     properties:
48170       p-interface:
48171         type: array
48172         items:
48173           $ref: "#/definitions/p-interface"
48174   physical-link:
48175     description: |
48176       Collection of physical connections, typically between p-interfaces
48177       ###### Related Nodes
48178       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
48179
48180       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
48181     required:
48182     - link-name
48183     properties:
48184       link-name:
48185         type: string
48186         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
48187       speed-value:
48188         type: string
48189         description: Captures the numeric part of the speed
48190       speed-units:
48191         type: string
48192         description: Captures the units corresponding to the speed
48193       circuit-id:
48194         type: string
48195         description: Circuit it
48196       dual-mode:
48197         type: string
48198         description: Dual access mode (e.g., primary, secondary
48199       management-option:
48200         type: string
48201         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
48202       service-provider-name:
48203         type: string
48204         description: Name of the service Provider on this link.
48205       service-provider-bandwidth-up-value:
48206         type: integer
48207         format: int32
48208         description: Upstream Bandwidth value agreed with the service provider
48209       service-provider-bandwidth-up-units:
48210         type: string
48211         description: Units for the upstream BW value
48212       service-provider-bandwidth-down-value:
48213         type: integer
48214         format: int32
48215         description: Downstream Bandwidth value agreed with the service provider
48216       service-provider-bandwidth-down-units:
48217         type: string
48218         description: Units for downstream BW value
48219       resource-version:
48220         type: string
48221         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48222       relationship-list:
48223         type: array
48224         items:
48225           $ref: "#/definitions/relationship"
48226   physical-links:
48227     description: |
48228       Collection of physical connections, typically between p-interfaces
48229     properties:
48230       physical-link:
48231         type: array
48232         items:
48233           $ref: "#/definitions/physical-link"
48234   platform:
48235     description: |
48236       describes a platform
48237       ###### Related Nodes
48238       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
48239
48240     required:
48241     - platform-name
48242     properties:
48243       platform-name:
48244         type: string
48245         description: Name of the platform
48246       resource-version:
48247         type: string
48248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48249       relationship-list:
48250         type: array
48251         items:
48252           $ref: "#/definitions/relationship"
48253   platforms:
48254     description: |
48255       Collection of platforms
48256     properties:
48257       platform:
48258         type: array
48259         items:
48260           $ref: "#/definitions/platform"
48261   pnf:
48262     description: |
48263       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
48264       ###### Related Nodes
48265       - TO complex( pnf LocatedIn complex, MANY2ONE)
48266       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
48267       - TO zone( pnf LocatedIn zone, MANY2ONE)
48268       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
48269       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
48270       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
48271       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
48272       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
48273       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
48274
48275       -(1) IF this PNF node is deleted, this FROM node is DELETED also
48276     required:
48277     - pnf-name
48278     - in-maint
48279     properties:
48280       pnf-name:
48281         type: string
48282         description: unique name of Physical Network Function.
48283       pnf-name2:
48284         type: string
48285         description: name of Physical Network Function.
48286       pnf-name2-source:
48287         type: string
48288         description: source of name2
48289       pnf-id:
48290         type: string
48291         description: id of pnf
48292       equip-type:
48293         type: string
48294         description: Equipment type.  Source of truth should define valid values.
48295       equip-vendor:
48296         type: string
48297         description: Equipment vendor.  Source of truth should define valid values.
48298       equip-model:
48299         type: string
48300         description: Equipment model.  Source of truth should define valid values.
48301       management-option:
48302         type: string
48303         description: identifier of managed by ATT or customer
48304       ipaddress-v4-oam:
48305         type: string
48306         description: ipv4-oam-address with new naming convention for IP addresses
48307       sw-version:
48308         type: string
48309         description: sw-version is the version of SW for the hosted application on the PNF.
48310       in-maint:
48311         type: boolean
48312         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.
48313       frame-id:
48314         type: string
48315         description: ID of the physical frame (relay rack) where pnf is installed.
48316       serial-number:
48317         type: string
48318         description: Serial number of the device
48319       ipaddress-v4-loopback-0:
48320         type: string
48321         description: IPV4 Loopback 0 address
48322       ipaddress-v6-loopback-0:
48323         type: string
48324         description: IPV6 Loopback 0 address
48325       ipaddress-v4-aim:
48326         type: string
48327         description: IPV4 AIM address
48328       ipaddress-v6-aim:
48329         type: string
48330         description: IPV6 AIM address
48331       ipaddress-v6-oam:
48332         type: string
48333         description: IPV6 OAM address
48334       inv-status:
48335         type: string
48336         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48337       resource-version:
48338         type: string
48339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48340       prov-status:
48341         type: string
48342         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
48343       nf-role:
48344         type: string
48345         description: Nf Role is the role performed by this instance in the network.
48346       relationship-list:
48347         type: array
48348         items:
48349           $ref: "#/definitions/relationship"
48350       p-interfaces:
48351         type: array
48352         items:
48353           $ref: "#/definitions/p-interface"
48354       lag-interfaces:
48355         type: array
48356         items:
48357           $ref: "#/definitions/lag-interface"
48358   pnfs:
48359     description: |
48360       Collection of Physical Network Functions.
48361     properties:
48362       pnf:
48363         type: array
48364         items:
48365           $ref: "#/definitions/pnf"
48366   port-group:
48367     description: |
48368       Used to capture the network interfaces of this VCE
48369       ###### Related Nodes
48370       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
48371       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
48372
48373       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
48374       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
48375     required:
48376     - interface-id
48377     - orchestration-status
48378     properties:
48379       interface-id:
48380         type: string
48381         description: Unique ID of the interface
48382       neutron-network-id:
48383         type: string
48384         description: Neutron network id of this Interface
48385       neutron-network-name:
48386         type: string
48387         description: Neutron network name of this Interface
48388       interface-role:
48389         type: string
48390         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48391       resource-version:
48392         type: string
48393         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48394       port-group-id:
48395         type: string
48396         description: Unique ID for port group in vmware
48397       port-group-name:
48398         type: string
48399         description: Likely to duplicate value of neutron network name
48400       switch-name:
48401         type: string
48402         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
48403       orchestration-status:
48404         type: string
48405         description: Orchestration status of this VNF, mastered by MSO
48406       heat-stack-id:
48407         type: string
48408         description: Heat stack id corresponding to this instance, managed by MSO
48409       mso-catalog-key:
48410         type: string
48411         description: Corresponds to the SDN-C catalog id used to configure this VCE
48412       cvlan-tags:
48413         type: array
48414         items:
48415           $ref: "#/definitions/cvlan-tag-entry"
48416       relationship-list:
48417         type: array
48418         items:
48419           $ref: "#/definitions/relationship"
48420   port-groups:
48421     properties:
48422       port-group:
48423         type: array
48424         items:
48425           $ref: "#/definitions/port-group"
48426   project:
48427     description: |
48428       describes the project
48429       ###### Related Nodes
48430       - TO service-instance( project Uses service-instance, ONE2MANY)
48431
48432     required:
48433     - project-name
48434     properties:
48435       project-name:
48436         type: string
48437         description: Name of the project deploying a service
48438       resource-version:
48439         type: string
48440         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48441       relationship-list:
48442         type: array
48443         items:
48444           $ref: "#/definitions/relationship"
48445   projects:
48446     description: |
48447       Collection of projects
48448     properties:
48449       project:
48450         type: array
48451         items:
48452           $ref: "#/definitions/project"
48453   properties:
48454     description: |
48455       Property holder for query properties or instance properties
48456     properties:
48457       property-name:
48458         type: string
48459       property-value:
48460         type: string
48461   property-constraint:
48462     description: |
48463       TBD
48464       ###### Related Nodes
48465       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
48466
48467       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
48468     required:
48469     - property-constraint-uuid
48470     - constraint-type
48471     - property-name
48472     - property-value
48473     properties:
48474       property-constraint-uuid:
48475         type: string
48476       constraint-type:
48477         type: string
48478       property-name:
48479         type: string
48480       property-value:
48481         type: string
48482       resource-version:
48483         type: string
48484   property-constraints:
48485     properties:
48486       property-constraint:
48487         type: array
48488         items:
48489           $ref: "#/definitions/property-constraint"
48490   pserver:
48491     description: |
48492       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
48493       ###### Related Nodes
48494       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
48495       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
48496       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
48497       - TO complex( pserver LocatedIn complex, MANY2ONE)
48498       - TO zone( pserver LocatedIn zone, MANY2ONE)
48499       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
48500       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
48501       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
48502       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
48503       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
48504
48505       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
48506       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
48507
48508     required:
48509     - hostname
48510     - in-maint
48511     properties:
48512       hostname:
48513         type: string
48514         description: Value from executing hostname on the compute node.
48515       ptnii-equip-name:
48516         type: string
48517         description: PTNII name
48518       number-of-cpus:
48519         type: integer
48520         format: int32
48521         description: Number of cpus
48522       disk-in-gigabytes:
48523         type: integer
48524         format: int32
48525         description: Disk size, in GBs
48526       ram-in-megabytes:
48527         type: integer
48528         format: int32
48529         description: RAM size, in MBs
48530       equip-type:
48531         type: string
48532         description: Equipment type.  Source of truth should define valid values.
48533       equip-vendor:
48534         type: string
48535         description: Equipment vendor.  Source of truth should define valid values.
48536       equip-model:
48537         type: string
48538         description: Equipment model.  Source of truth should define valid values.
48539       fqdn:
48540         type: string
48541         description: Fully-qualified domain name
48542       pserver-selflink:
48543         type: string
48544         description: URL to endpoint where AAI can get more details
48545       ipv4-oam-address:
48546         type: string
48547         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
48548       serial-number:
48549         type: string
48550         description: Serial number, may be queried
48551       ipaddress-v4-loopback-0:
48552         type: string
48553         description: IPV4 Loopback 0 address
48554       ipaddress-v6-loopback-0:
48555         type: string
48556         description: IPV6 Loopback 0 address
48557       ipaddress-v4-aim:
48558         type: string
48559         description: IPV4 AIM address
48560       ipaddress-v6-aim:
48561         type: string
48562         description: IPV6 AIM address
48563       ipaddress-v6-oam:
48564         type: string
48565         description: IPV6 OAM address
48566       inv-status:
48567         type: string
48568         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48569       pserver-id:
48570         type: string
48571         description: ID of Pserver
48572       internet-topology:
48573         type: string
48574         description: internet topology of Pserver
48575       in-maint:
48576         type: boolean
48577         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.
48578       resource-version:
48579         type: string
48580         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48581       pserver-name2:
48582         type: string
48583         description: alternative pserver name
48584       purpose:
48585         type: string
48586         description: purpose of pserver
48587       prov-status:
48588         type: string
48589         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
48590       management-option:
48591         type: string
48592         description: Indicates who owns and or manages the device.
48593       host-profile:
48594         type: string
48595         description: The host profile that defines the configuration of the pserver.
48596       relationship-list:
48597         type: array
48598         items:
48599           $ref: "#/definitions/relationship"
48600       p-interfaces:
48601         type: array
48602         items:
48603           $ref: "#/definitions/p-interface"
48604       lag-interfaces:
48605         type: array
48606         items:
48607           $ref: "#/definitions/lag-interface"
48608   pservers:
48609     description: |
48610       Collection of compute hosts.
48611     properties:
48612       pserver:
48613         type: array
48614         items:
48615           $ref: "#/definitions/pserver"
48616   query-parameters:
48617     description: |
48618       QueryParameters for performing a named-query or model query
48619     properties:
48620       named-query:
48621         type: object
48622         $ref: "#/definitions/named-query"
48623       overloaded-model:
48624         type: object
48625         $ref: "#/definitions/overloaded-model"
48626   related-lookup:
48627     description: |
48628       TBD
48629       ###### Related Nodes
48630       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
48631
48632       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
48633     required:
48634     - related-lookup-uuid
48635     - source-node-type
48636     - source-node-property
48637     - target-node-type
48638     - target-node-property
48639     properties:
48640       related-lookup-uuid:
48641         type: string
48642       source-node-type:
48643         type: string
48644       source-node-property:
48645         type: string
48646       target-node-type:
48647         type: string
48648       target-node-property:
48649         type: string
48650       property-collect-list:
48651         type: string
48652       resource-version:
48653         type: string
48654       relationship-list:
48655         type: array
48656         items:
48657           $ref: "#/definitions/relationship"
48658   related-lookups:
48659     properties:
48660       related-lookup:
48661         type: array
48662         items:
48663           $ref: "#/definitions/related-lookup"
48664   related-to-property:
48665     properties:
48666       property-key:
48667         type: string
48668         description: Key part of a key/value pair
48669       property-value:
48670         type: string
48671         description: Value part of a key/value pair
48672   relationship:
48673     properties:
48674       related-to:
48675         type: string
48676         description: A keyword provided by A&AI to indicate type of node.
48677       related-link:
48678         type: string
48679         description: URL to the object in A&AI.
48680       relationship-data:
48681         type: array
48682         items:
48683           $ref: "#/definitions/relationship-data"
48684   relationship-data:
48685     required:
48686     - relationship-key
48687     - relationship-value
48688     properties:
48689       relationship-key:
48690         type: string
48691         description: A keyword provided by A&AI to indicate an attribute.
48692       relationship-value:
48693         type: string
48694         description: Value of the attribute.
48695   relationship-list:
48696     properties:
48697       relationship:
48698         type: array
48699         items:
48700           $ref: "#/definitions/relationship"
48701   reserved-prop-names:
48702     description: |
48703       Internal map to define some reserved properties of a vertex
48704     properties:
48705       last-mod-source-of-truth:
48706         type: string
48707       aai-node-type:
48708         type: string
48709       aai-created-ts:
48710         type: integer
48711         format: int64
48712       aai-unique-key:
48713         type: string
48714       aai-last-mod-ts:
48715         type: integer
48716         format: int64
48717       source-of-truth:
48718         type: string
48719       aai-uri:
48720         type: string
48721   response-list:
48722     description: |
48723       Response container for the results of a named-query or model query
48724     properties:
48725       inventory-response-items:
48726         type: object
48727         $ref: "#/definitions/inventory-response-items"
48728   result-data:
48729     properties:
48730       resource-type:
48731         type: string
48732         description: The specific type of node in the A&AI graph
48733       resource-link:
48734         type: string
48735         description: The URL to the specific resource
48736   route-table-reference:
48737     description: |
48738       Openstack route table reference.
48739       ###### Related Nodes
48740       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
48741
48742     required:
48743     - route-table-reference-id
48744     - route-table-reference-fqdn
48745     properties:
48746       route-table-reference-id:
48747         type: string
48748         description: Route Table Reference id, UUID assigned to this instance.
48749       route-table-reference-fqdn:
48750         type: string
48751         description: FQDN entry in the route table.
48752       resource-version:
48753         type: string
48754         description: Concurrency value
48755       relationship-list:
48756         type: array
48757         items:
48758           $ref: "#/definitions/relationship"
48759   route-table-references:
48760     description: |
48761       Collection of openstack route table references
48762     properties:
48763       route-table-reference:
48764         type: array
48765         items:
48766           $ref: "#/definitions/route-table-reference"
48767   route-target:
48768     description: |
48769       Route target information
48770       ###### Related Nodes
48771       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
48772
48773       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
48774     required:
48775     - global-route-target
48776     - route-target-role
48777     properties:
48778       global-route-target:
48779         type: string
48780         description: Number used to identify an RT, globally unique in the network
48781       route-target-role:
48782         type: string
48783         description: Role assigned to this route target
48784       resource-version:
48785         type: string
48786         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48787       relationship-list:
48788         type: array
48789         items:
48790           $ref: "#/definitions/relationship"
48791   route-targets:
48792     description: |
48793       Collection of route target information
48794     properties:
48795       route-target:
48796         type: array
48797         items:
48798           $ref: "#/definitions/route-target"
48799   routing-instance:
48800     description: |
48801       ###### Related Nodes
48802       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
48803       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
48804
48805       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
48806       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
48807     required:
48808     - routing-instance-id
48809     properties:
48810       routing-instance-id:
48811         type: string
48812         description: Unique id of routing instance
48813       rpm-owner:
48814         type: string
48815         description: rpm owner
48816       resource-version:
48817         type: string
48818         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48819       site-pairs:
48820         type: array
48821         items:
48822           $ref: "#/definitions/site-pair"
48823       relationship-list:
48824         type: array
48825         items:
48826           $ref: "#/definitions/relationship"
48827   routing-instances:
48828     description: |
48829       set of probes related to generic-vnf routing instance
48830     properties:
48831       routing-instance:
48832         type: array
48833         items:
48834           $ref: "#/definitions/routing-instance"
48835   sdn-zone-response:
48836     properties:
48837       oam-networks:
48838         type: object
48839         $ref: "#/definitions/oam-networks"
48840       az-and-dvs-switches:
48841         type: array
48842         items:
48843           $ref: "#/definitions/az-and-dvs-switches"
48844   search:
48845     properties:
48846       edge-tag-query-result:
48847         type: object
48848         $ref: "#/definitions/edge-tag-query-result"
48849       edge-tag-query-request:
48850         type: object
48851         $ref: "#/definitions/edge-tag-query-request"
48852       search-results:
48853         type: object
48854         $ref: "#/definitions/search-results"
48855       sdn-zone-response:
48856         type: object
48857         $ref: "#/definitions/sdn-zone-response"
48858   search-results:
48859     properties:
48860       result-data:
48861         type: array
48862         items:
48863           $ref: "#/definitions/result-data"
48864   secondary-filt:
48865     description: |
48866       SecondaryFilt for performing a named-query or model query
48867   secondary-filter:
48868     properties:
48869       property-name:
48870         type: string
48871       filter-type:
48872         type: string
48873       property-value:
48874         type: string
48875   secondary-filts:
48876     description: |
48877       SecondaryFilts for performing a named-query or model query
48878     properties:
48879       secondary-filt:
48880         type: array
48881         items:
48882           $ref: "#/definitions/secondary-filt"
48883   segmentation-assignment:
48884     description: |
48885       Openstack segmentation assignment.
48886       ###### Related Nodes
48887       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
48888
48889       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
48890     required:
48891     - segmentation-id
48892     properties:
48893       segmentation-id:
48894         type: string
48895         description: Route Table Reference id, UUID assigned to this instance.
48896       resource-version:
48897         type: string
48898         description: Concurrency value
48899       relationship-list:
48900         type: array
48901         items:
48902           $ref: "#/definitions/relationship"
48903   segmentation-assignments:
48904     description: |
48905       Collection of openstack segmentation assignments
48906     properties:
48907       segmentation-assignment:
48908         type: array
48909         items:
48910           $ref: "#/definitions/segmentation-assignment"
48911   service:
48912     description: |
48913       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
48914     required:
48915     - service-id
48916     - service-description
48917     properties:
48918       service-id:
48919         type: string
48920         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
48921       service-description:
48922         type: string
48923         description: Description of the service
48924       service-selflink:
48925         type: string
48926         description: URL to endpoint where AAI can get more details
48927       resource-version:
48928         type: string
48929         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48930       service-version:
48931         type: string
48932         description: service version
48933       relationship-list:
48934         type: array
48935         items:
48936           $ref: "#/definitions/relationship"
48937   service-capabilities:
48938     description: |
48939       Collection of service capabilities.
48940     properties:
48941       service-capability:
48942         type: array
48943         items:
48944           $ref: "#/definitions/service-capability"
48945   service-capability:
48946     description: |
48947       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
48948       ###### Related Nodes
48949       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
48950       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
48951
48952       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
48953
48954     required:
48955     - service-type
48956     - vnf-type
48957     properties:
48958       service-type:
48959         type: string
48960         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
48961       vnf-type:
48962         type: string
48963         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.
48964       resource-version:
48965         type: string
48966         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48967       relationship-list:
48968         type: array
48969         items:
48970           $ref: "#/definitions/relationship"
48971   service-design-and-creation:
48972     description: |
48973       Namespace for objects managed by ASDC
48974     properties:
48975       vnf-images:
48976         type: array
48977         items:
48978           $ref: "#/definitions/vnf-image"
48979       services:
48980         type: array
48981         items:
48982           $ref: "#/definitions/service"
48983       service-capabilities:
48984         type: array
48985         items:
48986           $ref: "#/definitions/service-capability"
48987       models:
48988         type: array
48989         items:
48990           $ref: "#/definitions/model"
48991       named-queries:
48992         type: array
48993         items:
48994           $ref: "#/definitions/named-query"
48995   service-instance:
48996     description: |
48997       Instance of a service
48998       ###### Related Nodes
48999       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49000       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49001       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
49002       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49003       - TO configuration( service-instance Uses configuration, ONE2MANY)
49004       - TO connector( service-instance Uses connector, MANY2MANY)
49005       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49006       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49007       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49008       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49009       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49010       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49011       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49012       - TO zone( service-instance LocatedIn zone, MANY2ONE)
49013       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49014       - TO vce( service-instance ComposedOf vce, ONE2MANY)
49015       - FROM project( project Uses service-instance, ONE2MANY)
49016       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49017       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49018       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49019
49020       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49021       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49022       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49023     required:
49024     - service-instance-id
49025     properties:
49026       service-instance-id:
49027         type: string
49028         description: Uniquely identifies this instance of a service
49029       service-instance-name:
49030         type: string
49031         description: This field will store a name assigned to the service-instance.
49032       service-type:
49033         type: string
49034         description: String capturing type of service.
49035       service-role:
49036         type: string
49037         description: String capturing the service role.
49038       environment-context:
49039         type: string
49040         description: This field will store the environment context assigned to the service-instance.
49041       workload-context:
49042         type: string
49043         description: This field will store the workload context assigned to the service-instance.
49044       created-at:
49045         type: string
49046         description: create time of Network Service.
49047       updated-at:
49048         type: string
49049         description: last update of Network Service.
49050       description:
49051         type: string
49052         description: short description for service-instance.
49053       model-invariant-id:
49054         type: string
49055         description: the ASDC model id for this resource or service model.
49056       model-version-id:
49057         type: string
49058         description: the ASDC model version for this resource or service model.
49059       persona-model-version:
49060         type: string
49061         description: the ASDC model version for this resource or service model.
49062       widget-model-id:
49063         type: string
49064         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49065       widget-model-version:
49066         type: string
49067         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49068       bandwidth-total:
49069         type: string
49070         description: Indicates the total bandwidth to be used for this service.
49071       bandwidth-up-wan1:
49072         type: string
49073         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49074       bandwidth-down-wan1:
49075         type: string
49076         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49077       bandwidth-up-wan2:
49078         type: string
49079         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49080       bandwidth-down-wan2:
49081         type: string
49082         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49083       vhn-portal-url:
49084         type: string
49085         description: URL customers will use to access the vHN Portal.
49086       service-instance-location-id:
49087         type: string
49088         description: An identifier that customers assign to the location where this service is being used.
49089       resource-version:
49090         type: string
49091         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49092       selflink:
49093         type: string
49094         description: Path to the controller object.
49095       orchestration-status:
49096         type: string
49097         description: Orchestration status of this service.
49098       relationship-list:
49099         type: array
49100         items:
49101           $ref: "#/definitions/relationship"
49102       metadata:
49103         type: array
49104         items:
49105           $ref: "#/definitions/metadatum"
49106       allotted-resources:
49107         type: array
49108         items:
49109           $ref: "#/definitions/allotted-resource"
49110   service-instances:
49111     description: |
49112       Collection of service instances
49113     properties:
49114       service-instance:
49115         type: array
49116         items:
49117           $ref: "#/definitions/service-instance"
49118   service-subscription:
49119     description: |
49120       Object that group service instances.
49121       ###### Related Nodes
49122       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49123       - TO tenant( service-subscription Uses tenant, MANY2MANY)
49124       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49125
49126       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49127       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49128     required:
49129     - service-type
49130     properties:
49131       service-type:
49132         type: string
49133         description: Value defined by orchestration to identify this service across ECOMP.
49134       temp-ub-sub-account-id:
49135         type: string
49136         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49137       resource-version:
49138         type: string
49139         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49140       service-instances:
49141         type: array
49142         items:
49143           $ref: "#/definitions/service-instance"
49144       relationship-list:
49145         type: array
49146         items:
49147           $ref: "#/definitions/relationship"
49148   service-subscriptions:
49149     description: |
49150       Collection of objects that group service instances.
49151     properties:
49152       service-subscription:
49153         type: array
49154         items:
49155           $ref: "#/definitions/service-subscription"
49156   services:
49157     description: |
49158       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
49159     properties:
49160       service:
49161         type: array
49162         items:
49163           $ref: "#/definitions/service"
49164   site-pair:
49165     description: |
49166       ###### Related Nodes
49167       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49168       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49169
49170       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49171       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49172     required:
49173     - site-pair-id
49174     properties:
49175       site-pair-id:
49176         type: string
49177         description: unique identifier of probe
49178       source-ip:
49179         type: string
49180         description: Prefix address
49181       destination-ip:
49182         type: string
49183         description: Prefix address
49184       ip-version:
49185         type: string
49186         description: ip version, v4, v6
49187       destination-hostname:
49188         type: string
49189         description: Hostname of the destination equipment to which SLAs are measured against.
49190       destination-equip-type:
49191         type: string
49192         description: The type of destinatination equipment. Could be Router, UCPE, etc.
49193       resource-version:
49194         type: string
49195         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49196       classes-of-service:
49197         type: array
49198         items:
49199           $ref: "#/definitions/class-of-service"
49200       relationship-list:
49201         type: array
49202         items:
49203           $ref: "#/definitions/relationship"
49204   site-pair-set:
49205     description: |
49206       Set of instances for probes used to measure service level agreements
49207       ###### Related Nodes
49208       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49209       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
49210
49211       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
49212     required:
49213     - site-pair-set-id
49214     properties:
49215       site-pair-set-id:
49216         type: string
49217         description: Unique id of site pair set.
49218       resource-version:
49219         type: string
49220         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49221       routing-instances:
49222         type: array
49223         items:
49224           $ref: "#/definitions/routing-instance"
49225       relationship-list:
49226         type: array
49227         items:
49228           $ref: "#/definitions/relationship"
49229   site-pair-sets:
49230     description: |
49231       Collection of sets of instances for probes related to generic-vnf
49232     properties:
49233       site-pair-set:
49234         type: array
49235         items:
49236           $ref: "#/definitions/site-pair-set"
49237   site-pairs:
49238     description: |
49239       probe within a set
49240     properties:
49241       site-pair:
49242         type: array
49243         items:
49244           $ref: "#/definitions/site-pair"
49245   snapshot:
49246     description: |
49247       Openstack snapshot
49248       ###### Related Nodes
49249       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
49250       - FROM vserver( vserver Uses snapshot, ONE2ONE)
49251
49252     required:
49253     - snapshot-id
49254     properties:
49255       snapshot-id:
49256         type: string
49257         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
49258       snapshot-name:
49259         type: string
49260         description: Snapshot name
49261       snapshot-architecture:
49262         type: string
49263         description: Operating system architecture
49264       snapshot-os-distro:
49265         type: string
49266         description: The common name of the operating system distribution in lowercase
49267       snapshot-os-version:
49268         type: string
49269         description: The operating system version as specified by the distributor.
49270       application:
49271         type: string
49272         description: The application that the image instantiates.
49273       application-vendor:
49274         type: string
49275         description: The vendor of the application.
49276       application-version:
49277         type: string
49278         description: The version of the application.
49279       snapshot-selflink:
49280         type: string
49281         description: URL to endpoint where AAI can get more details
49282       prev-snapshot-id:
49283         type: string
49284         description: This field contains the UUID of the previous snapshot (if any).
49285       resource-version:
49286         type: string
49287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49288       relationship-list:
49289         type: array
49290         items:
49291           $ref: "#/definitions/relationship"
49292   snapshots:
49293     description: |
49294       Collection of openstack snapshots
49295     properties:
49296       snapshot:
49297         type: array
49298         items:
49299           $ref: "#/definitions/snapshot"
49300   sriov-pf:
49301     description: |
49302       SR-IOV Physical Function
49303       ###### Related Nodes
49304       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
49305       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
49306
49307       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
49308     required:
49309     - pf-pci-id
49310     properties:
49311       pf-pci-id:
49312         type: string
49313         description: Identifier for the sriov-pf
49314       resource-version:
49315         type: string
49316         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49317       relationship-list:
49318         type: array
49319         items:
49320           $ref: "#/definitions/relationship"
49321   sriov-pfs:
49322     description: |
49323       Collection of SR-IOV Physical Functions.
49324     properties:
49325       sriov-pf:
49326         type: array
49327         items:
49328           $ref: "#/definitions/sriov-pf"
49329   sriov-vf:
49330     description: |
49331       SR-IOV Virtual Function (not to be confused with virtual network function)
49332       ###### Related Nodes
49333       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
49334       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
49335
49336       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
49337     required:
49338     - pci-id
49339     properties:
49340       pci-id:
49341         type: string
49342         description: PCI ID used to identify the sriov-vf
49343       vf-vlan-filter:
49344         type: string
49345         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49346       vf-mac-filter:
49347         type: string
49348         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49349       vf-vlan-strip:
49350         type: boolean
49351         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49352       vf-vlan-anti-spoof-check:
49353         type: boolean
49354         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.
49355       vf-mac-anti-spoof-check:
49356         type: boolean
49357         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.
49358       vf-mirrors:
49359         type: string
49360         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
49361       vf-broadcast-allow:
49362         type: boolean
49363         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
49364       vf-unknown-multicast-allow:
49365         type: boolean
49366         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
49367       vf-unknown-unicast-allow:
49368         type: boolean
49369         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
49370       vf-insert-stag:
49371         type: boolean
49372         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
49373       vf-link-status:
49374         type: string
49375         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
49376       resource-version:
49377         type: string
49378         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49379       neutron-network-id:
49380         type: string
49381         description: Neutron network id of the interface
49382       relationship-list:
49383         type: array
49384         items:
49385           $ref: "#/definitions/relationship"
49386   sriov-vfs:
49387     description: |
49388       Collection of SR-IOV Virtual Functions.
49389     properties:
49390       sriov-vf:
49391         type: array
49392         items:
49393           $ref: "#/definitions/sriov-vf"
49394   start-node-filter:
49395     properties:
49396       property-name:
49397         type: string
49398       property-value:
49399         type: string
49400   subnet:
49401     description: |
49402       ###### Related Nodes
49403       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
49404       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49405       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49406       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
49407       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
49408       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
49409
49410       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
49411       -(4) IF this TO node is deleted, this SUBNET is DELETED also
49412       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
49413
49414     required:
49415     - subnet-id
49416     - dhcp-enabled
49417     properties:
49418       subnet-id:
49419         type: string
49420         description: Subnet ID, should be UUID.
49421       subnet-name:
49422         type: string
49423         description: Name associated with the subnet.
49424       neutron-subnet-id:
49425         type: string
49426         description: Neutron id of this subnet
49427       gateway-address:
49428         type: string
49429         description: gateway ip address
49430       network-start-address:
49431         type: string
49432         description: network start address
49433       cidr-mask:
49434         type: string
49435         description: cidr mask
49436       ip-version:
49437         type: string
49438         description: ip version
49439       orchestration-status:
49440         type: string
49441         description: Orchestration status of this VNF, mastered by MSO
49442       dhcp-enabled:
49443         type: boolean
49444         description: dhcp enabled
49445       dhcp-start:
49446         type: string
49447         description: the start address reserved for use by dhcp
49448       dhcp-end:
49449         type: string
49450         description: the last address reserved for use by dhcp
49451       subnet-role:
49452         type: string
49453         description: role of the subnet, referenced when assigning IPs
49454       ip-assignment-direction:
49455         type: string
49456         description: ip address assignment direction of the subnet
49457       resource-version:
49458         type: string
49459         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49460       subnet-sequence:
49461         type: integer
49462         format: int32
49463         description: sequence of the subnet
49464       host-routes:
49465         type: array
49466         items:
49467           $ref: "#/definitions/host-route"
49468       relationship-list:
49469         type: array
49470         items:
49471           $ref: "#/definitions/relationship"
49472   subnets:
49473     properties:
49474       subnet:
49475         type: array
49476         items:
49477           $ref: "#/definitions/subnet"
49478   tagged-inventory-item-list:
49479     properties:
49480       inventory-item:
49481         type: array
49482         items:
49483           $ref: "#/definitions/inventory-item"
49484   tenant:
49485     description: |
49486       Openstack tenant
49487       ###### Related Nodes
49488       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
49489       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
49490       - TO l3-network( tenant Uses l3-network, MANY2MANY)
49491       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
49492       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
49493       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
49494
49495       -TENANT cannot be deleted if related to VSERVER
49496
49497     required:
49498     - tenant-id
49499     - tenant-name
49500     properties:
49501       tenant-id:
49502         type: string
49503         description: Unique id relative to the cloud-region.
49504       tenant-name:
49505         type: string
49506         description: Readable name of tenant
49507       tenant-context:
49508         type: string
49509         description: This field will store the tenant context.
49510       resource-version:
49511         type: string
49512         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49513       vservers:
49514         type: array
49515         items:
49516           $ref: "#/definitions/vserver"
49517       relationship-list:
49518         type: array
49519         items:
49520           $ref: "#/definitions/relationship"
49521   tenants:
49522     description: |
49523       Collection of openstack tenants.
49524     properties:
49525       tenant:
49526         type: array
49527         items:
49528           $ref: "#/definitions/tenant"
49529   tunnel-xconnect:
49530     description: |
49531       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
49532       ###### Related Nodes
49533       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
49534
49535       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
49536     required:
49537     - id
49538     - bandwidth-up-wan1
49539     - bandwidth-down-wan1
49540     - bandwidth-up-wan2
49541     - bandwidth-down-wan2
49542     properties:
49543       id:
49544         type: string
49545         description: Allotted Resource id UUID assigned to this instance.
49546       bandwidth-up-wan1:
49547         type: string
49548         description: The WAN uplink bandwidth for WAN1
49549       bandwidth-down-wan1:
49550         type: string
49551         description: The WAN downlink bandwidth for WAN1
49552       bandwidth-up-wan2:
49553         type: string
49554         description: The WAN uplink bandwidth for WAN2
49555       bandwidth-down-wan2:
49556         type: string
49557         description: The WAN downlink bandwidth for WAN2
49558       resource-version:
49559         type: string
49560         description: Concurrency value
49561       relationship-list:
49562         type: array
49563         items:
49564           $ref: "#/definitions/relationship"
49565   tunnel-xconnects:
49566     description: |
49567       This object is used to store the specific tunnel cross connect aspects of an allotted resource
49568     properties:
49569       tunnel-xconnect:
49570         type: array
49571         items:
49572           $ref: "#/definitions/tunnel-xconnect"
49573   update:
49574     description: |
49575       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
49576     required:
49577     - update-node-type
49578     properties:
49579       update-node-type:
49580         type: string
49581       update-node-key:
49582         type: array
49583         items:
49584           $ref: "#/definitions/update-node-key"
49585       update-node-uri:
49586         type: string
49587       action:
49588         type: array
49589         items:
49590           $ref: "#/definitions/action"
49591   update-node-key:
49592     properties:
49593       key-name:
49594         type: string
49595       key-value:
49596         type: string
49597   vce:
49598     description: |
49599       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
49600       ###### Related Nodes
49601       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
49602       - TO complex( vce LocatedIn complex, MANY2MANY)
49603       - TO vserver( vce HostedOn vserver, ONE2MANY)
49604       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
49605       - FROM license( license BelongsTo vce, MANY2ONE)(1)
49606       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
49607       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
49608
49609       -(1) IF this VCE node is deleted, this FROM node is DELETED also
49610     required:
49611     - vnf-id
49612     - vnf-name
49613     - vnf-type
49614     properties:
49615       vnf-id:
49616         type: string
49617         description: Unique id of VNF.  This is unique across the graph.
49618       vnf-name:
49619         type: string
49620         description: Name of VNF.
49621       vnf-name2:
49622         type: string
49623         description: Alternate name of VNF.
49624       vnf-type:
49625         type: string
49626         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.
49627       service-id:
49628         type: string
49629         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
49630       regional-resource-zone:
49631         type: string
49632         description: Regional way of organizing pservers, source of truth should define values
49633       prov-status:
49634         type: string
49635         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49636       operational-status:
49637         type: string
49638         description: Indicator for whether the resource is considered operational
49639       license-key:
49640         type: string
49641         description: OBSOLETE -  do not use
49642       equipment-role:
49643         type: string
49644         description: Network role being played by this VNF
49645       orchestration-status:
49646         type: string
49647         description: Orchestration status of this VNF, mastered by MSO
49648       heat-stack-id:
49649         type: string
49650         description: Heat stack id corresponding to this instance, managed by MSO
49651       mso-catalog-key:
49652         type: string
49653         description: Corresponds to the SDN-C catalog id used to configure this VCE
49654       vpe-id:
49655         type: string
49656         description: Unique ID of VPE connected to this VCE.
49657       v6-vce-wan-address:
49658         type: string
49659         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
49660       ipv4-oam-address:
49661         type: string
49662         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
49663       resource-version:
49664         type: string
49665         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49666       ipv4-loopback0-address:
49667         type: string
49668         description: Loopback0 address
49669       entitlement-resource-uuid:
49670         type: string
49671         description: OBSOLETE -  see child relationships
49672       port-groups:
49673         type: array
49674         items:
49675           $ref: "#/definitions/port-group"
49676       licenses:
49677         type: array
49678         items:
49679           $ref: "#/definitions/license"
49680       entitlements:
49681         type: array
49682         items:
49683           $ref: "#/definitions/entitlement"
49684       relationship-list:
49685         type: array
49686         items:
49687           $ref: "#/definitions/relationship"
49688   vces:
49689     description: |
49690       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
49691     properties:
49692       vce:
49693         type: array
49694         items:
49695           $ref: "#/definitions/vce"
49696   vf-module:
49697     description: |
49698       a deployment unit of VNFCs
49699       ###### Related Nodes
49700       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
49701       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
49702       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
49703       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
49704       - TO vserver( vf-module Uses vserver, ONE2MANY)
49705
49706       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
49707       -VF-MODULE cannot be deleted if related to VNFC
49708
49709     required:
49710     - vf-module-id
49711     - is-base-vf-module
49712     properties:
49713       vf-module-id:
49714         type: string
49715         description: Unique ID of vf-module.
49716       vf-module-name:
49717         type: string
49718         description: Name of vf-module
49719       heat-stack-id:
49720         type: string
49721         description: Heat stack id corresponding to this instance.
49722       orchestration-status:
49723         type: string
49724         description: orchestration status of this vf-module, mastered by MSO
49725       is-base-vf-module:
49726         type: boolean
49727         description: used to indicate whether or not this object is base vf module
49728       resource-version:
49729         type: string
49730         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49731       model-invariant-id:
49732         type: string
49733         description: the ASDC model id for this resource or service model.
49734       model-version-id:
49735         type: string
49736         description: the ASDC model version for this resource or service model.
49737       persona-model-version:
49738         type: string
49739         description: the ASDC model version for this resource or service model.
49740       model-customization-id:
49741         type: string
49742         description: captures the id of all the configuration used to customize the resource for the service.
49743       widget-model-id:
49744         type: string
49745         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49746       widget-model-version:
49747         type: string
49748         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49749       contrail-service-instance-fqdn:
49750         type: string
49751         description: the Contrail unique ID for a service-instance
49752       module-index:
49753         type: integer
49754         format: int32
49755         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
49756       selflink:
49757         type: string
49758         description: Path to the controller object.
49759       relationship-list:
49760         type: array
49761         items:
49762           $ref: "#/definitions/relationship"
49763   vf-modules:
49764     description: |
49765       Collection of vf-modules, a deployment unit of VNFCs
49766     properties:
49767       vf-module:
49768         type: array
49769         items:
49770           $ref: "#/definitions/vf-module"
49771   vig-server:
49772     description: |
49773       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
49774       ###### Related Nodes
49775       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
49776
49777       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
49778     required:
49779     - vig-address-type
49780     properties:
49781       vig-address-type:
49782         type: string
49783         description: indicates whether the VIG is for AVPN or INTERNET
49784       ipaddress-v4-vig:
49785         type: string
49786         description: v4 IP of the vig server
49787       ipaddress-v6-vig:
49788         type: string
49789         description: v6 IP of the vig server
49790       resource-version:
49791         type: string
49792         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49793       relationship-list:
49794         type: array
49795         items:
49796           $ref: "#/definitions/relationship"
49797   vig-servers:
49798     properties:
49799       vig-server:
49800         type: array
49801         items:
49802           $ref: "#/definitions/vig-server"
49803   vip-ipv4-address-list:
49804     description: |
49805       IPv4 Address Range
49806       ###### Related Nodes
49807       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
49808       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
49809       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
49810       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
49811
49812     required:
49813     - vip-ipv4-address
49814     properties:
49815       vip-ipv4-address:
49816         type: string
49817         description: IP address
49818       vip-ipv4-prefix-length:
49819         type: integer
49820         format: int64
49821         description: Prefix length, 32 for single address
49822       vlan-id-inner:
49823         type: integer
49824         format: int64
49825         description: Inner VLAN tag
49826       vlan-id-outer:
49827         type: integer
49828         format: int64
49829         description: Outer VLAN tag
49830       is-floating:
49831         type: boolean
49832         description: Indicator of fixed or floating address
49833       resource-version:
49834         type: string
49835         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49836       neutron-network-id:
49837         type: string
49838         description: Neutron network id of the interface that address belongs to
49839       neutron-subnet-id:
49840         type: string
49841         description: Neutron id of subnet that address belongs to
49842       relationship-list:
49843         type: array
49844         items:
49845           $ref: "#/definitions/relationship"
49846   vip-ipv6-address-list:
49847     description: |
49848       IPv6 Address Range
49849       ###### Related Nodes
49850       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
49851       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
49852       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
49853       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
49854
49855     required:
49856     - vip-ipv6-address
49857     properties:
49858       vip-ipv6-address:
49859         type: string
49860         description: IP address
49861       vip-ipv6-prefix-length:
49862         type: integer
49863         format: int64
49864         description: Prefix length, 128 for single address
49865       vlan-id-inner:
49866         type: integer
49867         format: int64
49868         description: Inner VLAN tag
49869       vlan-id-outer:
49870         type: integer
49871         format: int64
49872         description: Outer VLAN tag
49873       is-floating:
49874         type: boolean
49875         description: Indicator of fixed or floating address
49876       resource-version:
49877         type: string
49878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49879       neutron-network-id:
49880         type: string
49881         description: Neutron network id of the interface that address belongs to
49882       neutron-subnet-id:
49883         type: string
49884         description: Neutron id of subnet that address belongs to
49885       relationship-list:
49886         type: array
49887         items:
49888           $ref: "#/definitions/relationship"
49889   virtual-data-center:
49890     description: |
49891       Virtual organization of cloud infrastructure elements in a data center context
49892       ###### Related Nodes
49893       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
49894       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
49895       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
49896
49897     required:
49898     - vdc-id
49899     - vdc-name
49900     properties:
49901       vdc-id:
49902         type: string
49903         description: Unique ID of the vdc
49904       vdc-name:
49905         type: string
49906         description: Name of the virtual data center
49907       resource-version:
49908         type: string
49909         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49910       relationship-list:
49911         type: array
49912         items:
49913           $ref: "#/definitions/relationship"
49914   virtual-data-centers:
49915     description: |
49916       Virtual organization of cloud infrastructure elements in a data center context
49917     properties:
49918       virtual-data-center:
49919         type: array
49920         items:
49921           $ref: "#/definitions/virtual-data-center"
49922   vlan:
49923     description: |
49924       Definition of vlan
49925       ###### Related Nodes
49926       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
49927       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
49928       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
49929       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
49930       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
49931       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
49932       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
49933
49934       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
49935       -(2) IF this VLAN node is deleted, this TO node is DELETED also
49936       -(4) IF this TO node is deleted, this VLAN is DELETED also
49937     required:
49938     - vlan-interface
49939     - in-maint
49940     - is-ip-unnumbered
49941     properties:
49942       vlan-interface:
49943         type: string
49944         description: String that identifies the interface
49945       vlan-id-inner:
49946         type: integer
49947         format: int64
49948         description: Inner VLAN tag
49949       vlan-id-outer:
49950         type: integer
49951         format: int64
49952         description: Outer VLAN tag
49953       resource-version:
49954         type: string
49955         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49956       speed-value:
49957         type: string
49958         description: Captures the numeric part of the speed
49959       speed-units:
49960         type: string
49961         description: Captures the units corresponding to the speed
49962       vlan-description:
49963         type: string
49964         description: Used to describe (the service associated with) the vlan
49965       backdoor-connection:
49966         type: string
49967         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
49968       vpn-key:
49969         type: string
49970         description: This indicates the customers VPN ID associated with this vlan
49971       orchestration-status:
49972         type: string
49973         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
49974       in-maint:
49975         type: boolean
49976         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49977       prov-status:
49978         type: string
49979         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
49980       is-ip-unnumbered:
49981         type: boolean
49982         description: Flag indicating the interface uses the IP Unnumbered configuration.
49983       relationship-list:
49984         type: array
49985         items:
49986           $ref: "#/definitions/relationship"
49987       l3-interface-ipv4-address-list:
49988         type: array
49989         items:
49990           $ref: "#/definitions/l3-interface-ipv4-address-list"
49991       l3-interface-ipv6-address-list:
49992         type: array
49993         items:
49994           $ref: "#/definitions/l3-interface-ipv6-address-list"
49995   vlans:
49996     properties:
49997       vlan:
49998         type: array
49999         items:
50000           $ref: "#/definitions/vlan"
50001   vnf:
50002     description: |
50003       Abstract vnf class
50004     required:
50005     - vnf-id
50006     properties:
50007       vnf-id:
50008         type: string
50009         description: Unique id of VNF.  This is unique across the graph.
50010   vnf-image:
50011     description: |
50012       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50013       ###### Related Nodes
50014       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50015
50016       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50017
50018     required:
50019     - vnf-image-uuid
50020     - application
50021     - application-vendor
50022     properties:
50023       vnf-image-uuid:
50024         type: string
50025         description: Unique ID of this asset
50026       application:
50027         type: string
50028         description: The application that the image instantiates.
50029       application-vendor:
50030         type: string
50031         description: The vendor of the application.
50032       application-version:
50033         type: string
50034         description: The version of the application.
50035       selflink:
50036         type: string
50037         description: URL to endpoint where AAI can get more details
50038       resource-version:
50039         type: string
50040         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50041       relationship-list:
50042         type: array
50043         items:
50044           $ref: "#/definitions/relationship"
50045   vnf-images:
50046     description: |
50047       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50048     properties:
50049       vnf-image:
50050         type: array
50051         items:
50052           $ref: "#/definitions/vnf-image"
50053   vnfc:
50054     description: |
50055       ###### Related Nodes
50056       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50057       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
50058       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50059       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50060       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50061       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50062       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
50063       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
50064
50065       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
50066       -(4) IF this TO node is deleted, this VNFC is DELETED also
50067     required:
50068     - vnfc-name
50069     - nfc-naming-code
50070     - nfc-function
50071     - in-maint
50072     - is-closed-loop-disabled
50073     properties:
50074       vnfc-name:
50075         type: string
50076         description: Unique ID of vnfc.
50077       nfc-naming-code:
50078         type: string
50079         description: Short code that is used in naming instances of the item being modeled
50080       nfc-function:
50081         type: string
50082         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
50083       prov-status:
50084         type: string
50085         description: prov status of this vnfc
50086       orchestration-status:
50087         type: string
50088         description: Orchestration status of this VNF, mastered by APP-C
50089       ipaddress-v4-oam-vip:
50090         type: string
50091         description: Oam V4 vip address of this vnfc
50092       in-maint:
50093         type: boolean
50094         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50095       is-closed-loop-disabled:
50096         type: boolean
50097         description: used to indicate whether closed loop function is enabled on this node
50098       group-notation:
50099         type: string
50100         description: Group notation of VNFC
50101       model-invariant-id:
50102         type: string
50103         description: the ASDC model id for this resource or service model.
50104       model-version-id:
50105         type: string
50106         description: the ASDC model version for this resource or service model.
50107       resource-version:
50108         type: string
50109         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50110       relationship-list:
50111         type: array
50112         items:
50113           $ref: "#/definitions/relationship"
50114       l3-interface-ipv4-address-list:
50115         type: array
50116         items:
50117           $ref: "#/definitions/l3-interface-ipv4-address-list"
50118       l3-interface-ipv6-address-list:
50119         type: array
50120         items:
50121           $ref: "#/definitions/l3-interface-ipv6-address-list"
50122   vnfcs:
50123     description: |
50124       virtual network components associated with a vserver from application controller.
50125     properties:
50126       vnfc:
50127         type: array
50128         items:
50129           $ref: "#/definitions/vnfc"
50130   volume:
50131     description: |
50132       Ephemeral Block storage volume.
50133       ###### Related Nodes
50134       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50135
50136       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50137     required:
50138     - volume-id
50139     - volume-selflink
50140     properties:
50141       volume-id:
50142         type: string
50143         description: Unique ID of block storage volume relative to the vserver.
50144       volume-selflink:
50145         type: string
50146         description: URL to endpoint where AAI can get more details
50147       resource-version:
50148         type: string
50149         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50150       relationship-list:
50151         type: array
50152         items:
50153           $ref: "#/definitions/relationship"
50154   volume-group:
50155     description: |
50156       Persistent block-level storage.
50157       ###### Related Nodes
50158       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50159       - TO complex( volume-group LocatedIn complex, MANY2ONE)
50160       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50161       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50162       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50163
50164     required:
50165     - volume-group-id
50166     - volume-group-name
50167     - vnf-type
50168     properties:
50169       volume-group-id:
50170         type: string
50171         description: Unique ID of volume-group.
50172       volume-group-name:
50173         type: string
50174         description: Name of the volume group.
50175       heat-stack-id:
50176         type: string
50177         description: Heat stack id corresponding to this volume-group
50178       vnf-type:
50179         type: string
50180         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.
50181       orchestration-status:
50182         type: string
50183         description: Orchestration status of this volume-group
50184       model-customization-id:
50185         type: string
50186         description: captures the id of all the configuration used to customize the resource for the service.
50187       vf-module-model-customization-id:
50188         type: string
50189         description: helps relate the volume group to the vf-module whose components will require the volume group
50190       resource-version:
50191         type: string
50192         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50193       relationship-list:
50194         type: array
50195         items:
50196           $ref: "#/definitions/relationship"
50197   volume-groups:
50198     description: |
50199       Collection of persistent block-level storage.
50200     properties:
50201       volume-group:
50202         type: array
50203         items:
50204           $ref: "#/definitions/volume-group"
50205   volumes:
50206     description: |
50207       Collection of ephemeral Block storage volumes.
50208     properties:
50209       volume:
50210         type: array
50211         items:
50212           $ref: "#/definitions/volume"
50213   vpls-pe:
50214     description: |
50215       VPLS Provider Edge routers.
50216       ###### Related Nodes
50217       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50218       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50219       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50220       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50221
50222       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50223     required:
50224     - equipment-name
50225     properties:
50226       equipment-name:
50227         type: string
50228       prov-status:
50229         type: string
50230         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50231       ipv4-oam-address:
50232         type: string
50233         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).
50234       equipment-role:
50235         type: string
50236         description: Client should send valid enumerated value, e.g., VPLS-PE.
50237       vlan-id-outer:
50238         type: integer
50239         format: int64
50240         description: Temporary location for stag to get to VCE
50241       resource-version:
50242         type: string
50243         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50244       relationship-list:
50245         type: array
50246         items:
50247           $ref: "#/definitions/relationship"
50248       p-interfaces:
50249         type: array
50250         items:
50251           $ref: "#/definitions/p-interface"
50252       lag-interfaces:
50253         type: array
50254         items:
50255           $ref: "#/definitions/lag-interface"
50256   vpls-pes:
50257     description: |
50258       Collection of VPLS Provider Edge routers
50259     properties:
50260       vpls-pe:
50261         type: array
50262         items:
50263           $ref: "#/definitions/vpls-pe"
50264   vpn-binding:
50265     description: |
50266       VPN binding
50267       ###### Related Nodes
50268       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
50269       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50270       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50271       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
50272
50273       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
50274       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
50275
50276     required:
50277     - vpn-id
50278     - vpn-name
50279     properties:
50280       vpn-id:
50281         type: string
50282         description: VPN ID, globally unique within A&AI
50283       vpn-name:
50284         type: string
50285         description: VPN Name
50286       vpn-platform:
50287         type: string
50288         description: the platform associated with the VPN example AVPN, Mobility
50289       vpn-type:
50290         type: string
50291         description: Type of the vpn, should be taken from enumerated/valid values
50292       vpn-region:
50293         type: string
50294         description: region of customer vpn
50295       customer-vpn-id:
50296         type: string
50297         description: id for this customer vpn
50298       route-distinguisher:
50299         type: string
50300         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50301       resource-version:
50302         type: string
50303         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50304       route-targets:
50305         type: array
50306         items:
50307           $ref: "#/definitions/route-target"
50308       relationship-list:
50309         type: array
50310         items:
50311           $ref: "#/definitions/relationship"
50312         description: l3-networks relate to vpn-bindings
50313   vpn-bindings:
50314     properties:
50315       vpn-binding:
50316         type: array
50317         items:
50318           $ref: "#/definitions/vpn-binding"
50319   vserver:
50320     description: |
50321       Virtual Servers, aka virtual machine or VM.
50322       ###### Related Nodes
50323       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50324       - TO flavor( vserver Uses flavor, MANY2ONE)
50325       - TO image( vserver Uses image, MANY2ONE)
50326       - TO pserver( vserver HostedOn pserver, MANY2ONE)
50327       - TO snapshot( vserver Uses snapshot, ONE2ONE)
50328       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50329       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50330       - FROM vce( vce HostedOn vserver, ONE2MANY)
50331       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50332       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50333       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50334
50335       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50336       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50337     required:
50338     - vserver-id
50339     - vserver-name
50340     - vserver-selflink
50341     - in-maint
50342     - is-closed-loop-disabled
50343     properties:
50344       vserver-id:
50345         type: string
50346         description: Unique identifier for this vserver relative to its tenant
50347       vserver-name:
50348         type: string
50349         description: Name of vserver
50350       vserver-name2:
50351         type: string
50352         description: Alternative name of vserver
50353       prov-status:
50354         type: string
50355         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50356       vserver-selflink:
50357         type: string
50358         description: URL to endpoint where AAI can get more details
50359       in-maint:
50360         type: boolean
50361         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.
50362       is-closed-loop-disabled:
50363         type: boolean
50364         description: Used to indicate whether closed loop function is enabled on this node
50365       resource-version:
50366         type: string
50367         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50368       volumes:
50369         type: array
50370         items:
50371           $ref: "#/definitions/volume"
50372       relationship-list:
50373         type: array
50374         items:
50375           $ref: "#/definitions/relationship"
50376       l-interfaces:
50377         type: array
50378         items:
50379           $ref: "#/definitions/l-interface"
50380   vservers:
50381     description: |
50382       Collection of virtual Servers, aka virtual machines or VMs.
50383     properties:
50384       vserver:
50385         type: array
50386         items:
50387           $ref: "#/definitions/vserver"
50388   zone:
50389     description: |
50390       A zone is a grouping of assets in a location homing to the same connections into the CBB
50391       ###### Related Nodes
50392       - TO complex( zone LocatedIn complex, MANY2ONE)
50393       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50394       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50395       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50396       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
50397
50398     required:
50399     - zone-id
50400     - zone-name
50401     - design-type
50402     - zone-context
50403     properties:
50404       zone-id:
50405         type: string
50406         description: Code assigned by AIC to the zone
50407       zone-name:
50408         type: string
50409         description: English name associated with the zone
50410       design-type:
50411         type: string
50412         description: Design of zone [Medium/Large?]
50413       zone-context:
50414         type: string
50415         description: Context of zone [production/test]
50416       status:
50417         type: string
50418         description: Status of a zone.
50419       resource-version:
50420         type: string
50421         description: Concurrency value
50422       relationship-list:
50423         type: array
50424         items:
50425           $ref: "#/definitions/relationship"
50426   zones:
50427     description: |
50428       Collection of zones
50429     properties:
50430       zone:
50431         type: array
50432         items:
50433           $ref: "#/definitions/zone"
50434 patchDefinitions:
50435   action:
50436     properties:
50437       action-type:
50438         type: string
50439       action-data:
50440         type: array
50441         items:
50442           $ref: "#/patchDefinitions/action-data"
50443   action-data:
50444     properties:
50445       property-name:
50446         type: string
50447       property-value:
50448         type: string
50449   actions:
50450     description: |
50451       APIs that are more action related than REST (e.g., notify, update).
50452     properties:
50453       update:
50454         type: object
50455         $ref: "#/patchDefinitions/update"
50456       notify:
50457         type: object
50458         $ref: "#/patchDefinitions/notify"
50459   allotted-resource:
50460     description: |
50461       Represents a slice or partial piece of a resource that gets separately allotted
50462       ###### Related Nodes
50463       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
50464       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50465       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50466       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50467       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
50468       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
50469       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50470       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
50471       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50472       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50473       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
50474       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50475       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
50476
50477       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50478       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
50479       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50480     required:
50481     - id
50482     properties:
50483       id:
50484         type: string
50485         description: Allotted Resource id UUID assigned to this instance.
50486       description:
50487         type: string
50488         description: The descriptive information assigned to this allotted resource instance
50489       selflink:
50490         type: string
50491         description: Link back to more information in the controller
50492       model-invariant-id:
50493         type: string
50494         description: the ASDC model id for this resource or service model.
50495       model-version-id:
50496         type: string
50497         description: the ASDC model version for this resource or service model.
50498       persona-model-version:
50499         type: string
50500         description: the ASDC model version for this resource or service model.
50501   allotted-resources:
50502     description: |
50503       This object is used to store slices of services being offered
50504     properties:
50505       allotted-resource:
50506         type: array
50507         items:
50508           $ref: "#/patchDefinitions/allotted-resource"
50509   availability-zone:
50510     description: |
50511       Availability zone, a collection of compute hosts/pservers
50512       ###### Related Nodes
50513       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50514       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50515       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50516       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50517       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50518       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50519       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50520       - FROM vce( vce Uses availability-zone, MANY2MANY)
50521
50522       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
50523       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
50524
50525     required:
50526     - availability-zone-name
50527     - hypervisor-type
50528     properties:
50529       availability-zone-name:
50530         type: string
50531         description: Name of the availability zone.  Unique across a cloud region
50532       hypervisor-type:
50533         type: string
50534         description: Type of hypervisor.  Source of truth should define valid values.
50535       operational-status:
50536         type: string
50537         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
50538   availability-zones:
50539     description: |
50540       Collection of availability zones
50541     properties:
50542       availability-zone:
50543         type: array
50544         items:
50545           $ref: "#/patchDefinitions/availability-zone"
50546   az-and-dvs-switches:
50547     properties:
50548       dvs-switches:
50549         type: object
50550         $ref: "#/patchDefinitions/dvs-switches"
50551       availability-zone:
50552         type: object
50553         $ref: "#/patchDefinitions/availability-zone"
50554   business:
50555     description: |
50556       Namespace for business related constructs
50557     properties:
50558       connectors:
50559         type: array
50560         items:
50561           $ref: "#/patchDefinitions/connector"
50562       customers:
50563         type: array
50564         items:
50565           $ref: "#/patchDefinitions/customer"
50566       lines-of-business:
50567         type: array
50568         items:
50569           $ref: "#/patchDefinitions/line-of-business"
50570       owning-entities:
50571         type: array
50572         items:
50573           $ref: "#/patchDefinitions/owning-entity"
50574       platforms:
50575         type: array
50576         items:
50577           $ref: "#/patchDefinitions/platform"
50578       projects:
50579         type: array
50580         items:
50581           $ref: "#/patchDefinitions/project"
50582   class-of-service:
50583     description: |
50584       ###### Related Nodes
50585       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
50586
50587       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
50588     required:
50589     - cos
50590     properties:
50591       cos:
50592         type: string
50593         description: unique identifier of probe
50594       probe-id:
50595         type: string
50596         description: identifier of probe
50597       probe-type:
50598         type: string
50599         description: type of probe
50600   classes-of-service:
50601     description: |
50602       class-of-service of probe
50603     properties:
50604       class-of-service:
50605         type: array
50606         items:
50607           $ref: "#/patchDefinitions/class-of-service"
50608   cloud-infrastructure:
50609     description: |
50610       Namespace for cloud infrastructure.
50611     properties:
50612       complexes:
50613         type: array
50614         items:
50615           $ref: "#/patchDefinitions/complex"
50616       cloud-regions:
50617         type: array
50618         items:
50619           $ref: "#/patchDefinitions/cloud-region"
50620       network-profiles:
50621         type: array
50622         items:
50623           $ref: "#/patchDefinitions/network-profile"
50624       pservers:
50625         type: array
50626         items:
50627           $ref: "#/patchDefinitions/pserver"
50628       virtual-data-centers:
50629         type: array
50630         items:
50631           $ref: "#/patchDefinitions/virtual-data-center"
50632   cloud-region:
50633     description: |
50634       cloud-region designates an installation of a cloud cluster or region or instantiation.
50635       ###### Related Nodes
50636       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
50637       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
50638       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
50639       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
50640       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
50641       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
50642       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
50643       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
50644       - FROM image( image BelongsTo cloud-region, MANY2ONE)
50645       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
50646       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
50647       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
50648       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50649       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50650       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
50651       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
50652       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
50653
50654       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
50655       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
50656
50657     required:
50658     - cloud-owner
50659     - cloud-region-id
50660     - sriov-automation
50661     properties:
50662       cloud-owner:
50663         type: string
50664         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
50665       cloud-region-id:
50666         type: string
50667         description: Identifier used by the vendor for the region. Second part of composite key
50668       cloud-type:
50669         type: string
50670         description: Type of the cloud (e.g., openstack)
50671       owner-defined-type:
50672         type: string
50673         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
50674       cloud-region-version:
50675         type: string
50676         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
50677       identity-url:
50678         type: string
50679         description: URL of the keystone identity service
50680       cloud-zone:
50681         type: string
50682         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50683       complex-name:
50684         type: string
50685         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50686       sriov-automation:
50687         type: boolean
50688         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
50689       cloud-extra-info:
50690         type: string
50691         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
50692       cloud-epa-caps:
50693         type: string
50694         description: MultiVIM will discover and expose EPA capabilities.
50695   cloud-regions:
50696     properties:
50697       cloud-region:
50698         type: array
50699         items:
50700           $ref: "#/patchDefinitions/cloud-region"
50701   complex:
50702     description: |
50703       Collection of physical locations that can house cloud-regions.
50704       ###### Related Nodes
50705       - TO l3-network( complex Uses l3-network, MANY2MANY)
50706       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
50707       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
50708       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
50709       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
50710       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
50711       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
50712       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
50713       - FROM vce( vce LocatedIn complex, MANY2MANY)
50714       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
50715       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
50716       - FROM zone( zone LocatedIn complex, MANY2ONE)
50717
50718       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
50719       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
50720
50721     required:
50722     - physical-location-id
50723     - physical-location-type
50724     - street1
50725     - city
50726     - postal-code
50727     - country
50728     - region
50729     properties:
50730       physical-location-id:
50731         type: string
50732         description: Unique identifier for physical location, e.g., CLLI
50733       data-center-code:
50734         type: string
50735         description: Data center code which can be an alternate way to identify a complex
50736       complex-name:
50737         type: string
50738         description: Gamma complex name for LCP instance.
50739       identity-url:
50740         type: string
50741         description: URL of the keystone identity service
50742   complexes:
50743     description: |
50744       Collection of physical locations that can house cloud-regions.
50745     properties:
50746       complex:
50747         type: array
50748         items:
50749           $ref: "#/patchDefinitions/complex"
50750   configuration:
50751     description: |
50752       Port Mirror Configuration.
50753       ###### Related Nodes
50754       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
50755       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
50756       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
50757       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
50758       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
50759
50760       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
50761       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
50762       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
50763     required:
50764     - configuration-id
50765     - configuration-type
50766     - configuration-sub-type
50767     - orchestration-status
50768     - operational-status
50769     - configuration-selflink
50770     - model-customization-id
50771     properties:
50772       configuration-id:
50773         type: string
50774         description: UUID assigned to configuration.
50775       management-option:
50776         type: string
50777         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
50778       configuration-name:
50779         type: string
50780         description: Name of the configuration.
50781       configuration-type:
50782         type: string
50783         description: port-mirroring-configuration.
50784       configuration-sub-type:
50785         type: string
50786         description: vprobe, pprobe.
50787       model-invariant-id:
50788         type: string
50789         description: the ASDC model id for this resource or service model.
50790       model-version-id:
50791         type: string
50792         description: the ASDC model version for this resource or service model.
50793       orchestration-status:
50794         type: string
50795         description: Orchestration status of the configuration.
50796       operational-status:
50797         type: string
50798         description: Indicator for whether the resource is considered operational.
50799       configuration-selflink:
50800         type: string
50801         description: URL to endpoint where AAI can get more details from SDN-GC.
50802       model-customization-id:
50803         type: string
50804         description: id of  the configuration used to customize the resource
50805   configurations:
50806     description: |
50807       Collection of configurations
50808     properties:
50809       configuration:
50810         type: array
50811         items:
50812           $ref: "#/patchDefinitions/configuration"
50813   connector:
50814     description: |
50815       Collection of resource instances used to connect a variety of disparate inventory widgets
50816       ###### Related Nodes
50817       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
50818       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
50819       - FROM service-instance( service-instance Uses connector, MANY2MANY)
50820
50821       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
50822     required:
50823     - resource-instance-id
50824     properties:
50825       resource-instance-id:
50826         type: string
50827         description: Unique id of resource instance.
50828   connectors:
50829     description: |
50830       Collection of resource instances used to connect a variety of disparate inventory widgets
50831     properties:
50832       connector:
50833         type: array
50834         items:
50835           $ref: "#/patchDefinitions/connector"
50836   constrained-element-set:
50837     description: |
50838       This is how we would capture constraints defining allowed sets of elements.
50839       ###### Related Nodes
50840       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
50841       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
50842       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
50843
50844       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
50845       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
50846     required:
50847     - constrained-element-set-uuid
50848     - constraint-type
50849     - check-type
50850     properties:
50851       constrained-element-set-uuid:
50852         type: string
50853       constraint-type:
50854         type: string
50855       check-type:
50856         type: string
50857   constrained-element-sets:
50858     properties:
50859       constrained-element-set:
50860         type: array
50861         items:
50862           $ref: "#/patchDefinitions/constrained-element-set"
50863   ctag-assignment:
50864     description: |
50865       ###### Related Nodes
50866       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
50867       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
50868
50869       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
50870     required:
50871     - vlan-id-inner
50872     properties:
50873       vlan-id-inner:
50874         type: integer
50875         format: int64
50876         description: id.
50877   ctag-assignments:
50878     properties:
50879       ctag-assignment:
50880         type: array
50881         items:
50882           $ref: "#/patchDefinitions/ctag-assignment"
50883   ctag-pool:
50884     description: |
50885       A collection of C tags (vlan tags) grouped for a specific purpose.
50886       ###### Related Nodes
50887       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
50888       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
50889       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
50890       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
50891
50892       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
50893     required:
50894     - target-pe
50895     - availability-zone-name
50896     - ctag-pool-purpose
50897     properties:
50898       target-pe:
50899         type: string
50900         description: The Target provider edge router
50901       availability-zone-name:
50902         type: string
50903         description: Name of the availability zone
50904       ctag-pool-purpose:
50905         type: string
50906         description: Describes what the intended purpose of this pool is.
50907       ctag-values:
50908         type: string
50909         description: Comma separated list of ctags
50910   ctag-pools:
50911     properties:
50912       ctag-pool:
50913         type: array
50914         items:
50915           $ref: "#/patchDefinitions/ctag-pool"
50916   customer:
50917     description: |
50918       customer identifiers to provide linkage back to BSS information.
50919       ###### Related Nodes
50920       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
50921
50922       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
50923     required:
50924     - global-customer-id
50925     - subscriber-name
50926     - subscriber-type
50927     properties:
50928       global-customer-id:
50929         type: string
50930         description: Global customer id used across ECOMP to uniquely identify customer.
50931       subscriber-name:
50932         type: string
50933         description: Subscriber name, an alternate way to retrieve a customer.
50934       subscriber-type:
50935         type: string
50936         description: Subscriber type, a way to provide VID with only the INFRA customers.
50937   customers:
50938     description: |
50939       Collection of customer identifiers to provide linkage back to BSS information.
50940     properties:
50941       customer:
50942         type: array
50943         items:
50944           $ref: "#/patchDefinitions/customer"
50945   cvlan-tag-entry:
50946     required:
50947     - cvlan-tag
50948     properties:
50949       cvlan-tag:
50950         type: integer
50951         format: int64
50952         description: See mis-na-virtualization-platform.yang
50953   cvlan-tags:
50954     properties:
50955       cvlan-tag-entry:
50956         type: array
50957         items:
50958           $ref: "#/patchDefinitions/cvlan-tag-entry"
50959   dvs-switch:
50960     description: |
50961       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.
50962       ###### Related Nodes
50963       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
50964       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
50965
50966     required:
50967     - switch-name
50968     - vcenter-url
50969     properties:
50970       switch-name:
50971         type: string
50972         description: DVS switch name
50973       vcenter-url:
50974         type: string
50975         description: URL used to reach the vcenter
50976   dvs-switches:
50977     description: |
50978       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
50979     properties:
50980       dvs-switch:
50981         type: array
50982         items:
50983           $ref: "#/patchDefinitions/dvs-switch"
50984   edge-prop-names:
50985     description: |
50986       Internal map to define the properties of an edge and interpret the map EdgeRules
50987     properties:
50988       edgeLabel:
50989         type: string
50990       direction:
50991         type: string
50992       multiplicityRule:
50993         type: string
50994       contains-other-v:
50995         type: string
50996       delete-other-v:
50997         type: string
50998       SVC-INFRA:
50999         type: string
51000       prevent-delete:
51001         type: string
51002   edge-tag-query-request:
51003     properties:
51004       edge-tag:
51005         type: string
51006       result-detail:
51007         type: string
51008       start-node-type:
51009         type: string
51010       start-node-filter:
51011         type: array
51012         items:
51013           $ref: "#/patchDefinitions/start-node-filter"
51014       include-node-filter:
51015         type: array
51016         items:
51017           $ref: "#/patchDefinitions/include-node-filter"
51018       secondary-filter:
51019         type: array
51020         items:
51021           $ref: "#/patchDefinitions/secondary-filter"
51022   edge-tag-query-result:
51023     properties:
51024       tagged-inventory-item-list:
51025         type: array
51026         items:
51027           $ref: "#/patchDefinitions/tagged-inventory-item-list"
51028   element-choice-set:
51029     description: |
51030       This is how we would capture constraints defining allowed sets of elements.
51031       ###### Related Nodes
51032       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51033       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51034
51035       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51036       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51037     required:
51038     - element-choice-set-uuid
51039     - element-choice-set-name
51040     properties:
51041       element-choice-set-uuid:
51042         type: string
51043       element-choice-set-name:
51044         type: string
51045       cardinality:
51046         type: string
51047   element-choice-sets:
51048     properties:
51049       element-choice-set:
51050         type: array
51051         items:
51052           $ref: "#/patchDefinitions/element-choice-set"
51053   entitlement:
51054     description: |
51055       Metadata for entitlement group.
51056       ###### Related Nodes
51057       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51058       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51059
51060       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51061     required:
51062     - group-uuid
51063     - resource-uuid
51064     properties:
51065       group-uuid:
51066         type: string
51067         description: Unique ID for the entitlement group the resource comes from, should be uuid.
51068       resource-uuid:
51069         type: string
51070         description: Unique ID of an entitlement resource.
51071   entitlements:
51072     description: |
51073       Entitlements, keyed by group-uuid and resource-uuid, related to license management
51074     properties:
51075       entitlement:
51076         type: array
51077         items:
51078           $ref: "#/patchDefinitions/entitlement"
51079   esr-ems:
51080     description: |
51081       Persist EMS address information used by EMS driver.
51082       ###### Related Nodes
51083       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
51084
51085       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
51086     required:
51087     - ems-id
51088     properties:
51089       ems-id:
51090         type: string
51091         description: Unique ID of EMS.
51092   esr-ems-list:
51093     properties:
51094       esr-ems:
51095         type: array
51096         items:
51097           $ref: "#/patchDefinitions/esr-ems"
51098   esr-system-info:
51099     description: |
51100       Persist common address information of external systems.
51101       ###### Related Nodes
51102       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
51103       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
51104       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
51105       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
51106
51107       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
51108     required:
51109     - esr-system-info-id
51110     - user-name
51111     - password
51112     - system-type
51113     properties:
51114       esr-system-info-id:
51115         type: string
51116         description: Unique ID of esr system info.
51117       system-name:
51118         type: string
51119         description: name of external system.
51120       type:
51121         type: string
51122         description: type of external systems.
51123       vendor:
51124         type: string
51125         description: vendor of external systems.
51126       version:
51127         type: string
51128         description: version of external systems.
51129       service-url:
51130         type: string
51131         description: url used to access external systems.
51132       user-name:
51133         type: string
51134         description: username used to access external systems.
51135       password:
51136         type: string
51137         description: password used to access external systems.
51138       system-type:
51139         type: string
51140         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51141       protocol:
51142         type: string
51143         description: protocol of third party SDNC, for example netconf/snmp.
51144       ssl-cacert:
51145         type: string
51146         description: ca file content if enabled ssl on auth-url.
51147       ssl-insecure:
51148         type: boolean
51149         description: Whether to verify VIM's certificate.
51150       ip-address:
51151         type: string
51152         description: service IP of ftp server.
51153       port:
51154         type: string
51155         description: service port of ftp server.
51156       cloud-domain:
51157         type: string
51158         description: domain info for authentication.
51159       default-tenant:
51160         type: string
51161         description: default tenant of VIM.
51162       passive:
51163         type: boolean
51164         description: ftp passive mode or not.
51165       remote-path:
51166         type: string
51167         description: resource or performance data file path.
51168       system-status:
51169         type: string
51170         description: the status of external system.
51171   esr-system-info-list:
51172     description: |
51173       Collection of persistent block-level external system auth info.
51174     properties:
51175       esr-system-info:
51176         type: array
51177         items:
51178           $ref: "#/patchDefinitions/esr-system-info"
51179   esr-thirdparty-sdnc:
51180     description: |
51181       Persist SDNC address information used by ONAP SDNC.
51182       ###### Related Nodes
51183       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
51184       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
51185
51186       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
51187     required:
51188     - thirdparty-sdnc-id
51189     properties:
51190       thirdparty-sdnc-id:
51191         type: string
51192         description: Unique ID of SDNC.
51193       location:
51194         type: string
51195         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51196       product-name:
51197         type: string
51198         description: password used to access SDNC server.
51199   esr-thirdparty-sdnc-list:
51200     properties:
51201       esr-thirdparty-sdnc:
51202         type: array
51203         items:
51204           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
51205   esr-vnfm:
51206     description: |
51207       Persist VNFM address information used by VF-C.
51208       ###### Related Nodes
51209       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
51210
51211       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
51212     required:
51213     - vnfm-id
51214     properties:
51215       vnfm-id:
51216         type: string
51217         description: Unique ID of VNFM.
51218       vim-id:
51219         type: string
51220         description: indecate the VIM to deploy VNF.
51221       certificate-url:
51222         type: string
51223         description: certificate url of VNFM.
51224   esr-vnfm-list:
51225     properties:
51226       esr-vnfm:
51227         type: array
51228         items:
51229           $ref: "#/patchDefinitions/esr-vnfm"
51230   evc:
51231     description: |
51232       evc object is an optional child object of the Configuration object.
51233       ###### Related Nodes
51234       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51235
51236       -(4) IF this TO node is deleted, this EVC is DELETED also
51237     required:
51238     - evc-id
51239     properties:
51240       evc-id:
51241         type: string
51242         description: Unique/key field for the evc object
51243       forwarding-path-topology:
51244         type: string
51245         description: Point-to-Point, Multi-Point
51246       cir-value:
51247         type: string
51248         description: Commited Information Rate
51249       cir-units:
51250         type: string
51251         description: CIR units
51252       connection-diversity-group-id:
51253         type: string
51254         description: Diversity Group ID
51255       service-hours:
51256         type: string
51257         description: formerly Performance Group
51258       esp-evc-circuit-id:
51259         type: string
51260         description: EVC Circuit ID of ESP EVC
51261       esp-evc-cir-value:
51262         type: string
51263         description: Committed Information Rate (For ESP)
51264       esp-evc-cir-units:
51265         type: string
51266         description: CIR units (For ESP)
51267       esp-itu-code:
51268         type: string
51269         description: Identifies ESP
51270       collector-pop-clli:
51271         type: string
51272         description: Collector POP CLLI (from the hostname of the access pnf)
51273       inter-connect-type-ingress:
51274         type: string
51275         description: Interconnect type on ingress side of EVC.
51276       tagmode-access-ingress:
51277         type: string
51278         description: tagode for collector side of EVC
51279       tagmode-access-egress:
51280         type: string
51281         description: tagMode for network side of EVC
51282   evcs:
51283     properties:
51284       evc:
51285         type: array
51286         items:
51287           $ref: "#/patchDefinitions/evc"
51288   external-system:
51289     description: |
51290       Namespace for external system.
51291     properties:
51292       esr-ems-list:
51293         type: object
51294         $ref: "#/patchDefinitions/esr-ems-list"
51295       esr-vnfm-list:
51296         type: object
51297         $ref: "#/patchDefinitions/esr-vnfm-list"
51298       esr-thirdparty-sdnc-list:
51299         type: object
51300         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
51301   extra-properties:
51302     description: |
51303       Extra properties for inventory item for response list
51304     properties:
51305       extra-property:
51306         type: array
51307         items:
51308           $ref: "#/patchDefinitions/extra-property"
51309   extra-property:
51310     properties:
51311       property-name:
51312         type: string
51313       property-value:
51314         type: string
51315   flavor:
51316     description: |
51317       Openstack flavor.
51318       ###### Related Nodes
51319       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
51320       - FROM vserver( vserver Uses flavor, MANY2ONE)
51321
51322       -FLAVOR cannot be deleted if related to VSERVER
51323
51324     required:
51325     - flavor-id
51326     - flavor-name
51327     - flavor-selflink
51328     properties:
51329       flavor-id:
51330         type: string
51331         description: Flavor id, expected to be unique across cloud-region.
51332       flavor-name:
51333         type: string
51334         description: Flavor name
51335       flavor-vcpus:
51336         type: integer
51337         format: int32
51338         description: Number of CPUs
51339       flavor-ram:
51340         type: integer
51341         format: int32
51342         description: Amount of memory
51343       flavor-disk:
51344         type: integer
51345         format: int32
51346         description: Disk space
51347       flavor-ephemeral:
51348         type: integer
51349         format: int32
51350         description: Amount of ephemeral disk space
51351       flavor-swap:
51352         type: string
51353         description: amount of swap space allocation
51354       flavor-is-public:
51355         type: boolean
51356         description: whether flavor is available to all users or private to the tenant it was created in.
51357       flavor-selflink:
51358         type: string
51359         description: URL to endpoint where AAI can get more details
51360       flavor-disabled:
51361         type: boolean
51362         description: Boolean as to whether this flavor is no longer enabled
51363   flavors:
51364     description: |
51365       Collection of openstack flavors.
51366     properties:
51367       flavor:
51368         type: array
51369         items:
51370           $ref: "#/patchDefinitions/flavor"
51371   forwarder:
51372     description: |
51373       Entity describing a sequenced segment of forwarding path
51374       ###### Related Nodes
51375       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
51376       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
51377       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
51378       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
51379       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
51380
51381       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
51382       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
51383     required:
51384     - sequence
51385     properties:
51386       sequence:
51387         type: integer
51388         format: int32
51389         description: Unique ID of this segmentation
51390       forwarder-role:
51391         type: string
51392         description: ingress, intermediate, egress
51393   forwarder-evc:
51394     description: |
51395       forwarder object is an optional child object of the Configuration object.
51396       ###### Related Nodes
51397       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
51398
51399       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
51400     required:
51401     - forwarder-evc-id
51402     properties:
51403       forwarder-evc-id:
51404         type: string
51405         description: Key for forwarder-evc object
51406       circuit-id:
51407         type: string
51408         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
51409       ivlan:
51410         type: string
51411         description: Internal VLAN.
51412       svlan:
51413         type: string
51414         description: SVLAN value for ingress of egress forwarder.
51415       cvlan:
51416         type: string
51417         description: CVLAN value for ingress of egress forwarder.
51418   forwarder-evcs:
51419     properties:
51420       forwarder-evc:
51421         type: array
51422         items:
51423           $ref: "#/patchDefinitions/forwarder-evc"
51424   forwarders:
51425     properties:
51426       forwarder:
51427         type: array
51428         items:
51429           $ref: "#/patchDefinitions/forwarder"
51430   forwarding-path:
51431     description: |
51432       Entity that describes the sequenced forwarding path between interfaces of services or resources
51433       ###### Related Nodes
51434       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
51435       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
51436       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
51437
51438       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
51439       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
51440       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
51441     required:
51442     - forwarding-path-id
51443     - forwarding-path-name
51444     properties:
51445       forwarding-path-id:
51446         type: string
51447         description: Unique ID of this FP
51448       forwarding-path-name:
51449         type: string
51450         description: Name of the FP
51451   forwarding-paths:
51452     properties:
51453       forwarding-path:
51454         type: array
51455         items:
51456           $ref: "#/patchDefinitions/forwarding-path"
51457   generic-vnf:
51458     description: |
51459       General purpose VNF
51460       ###### Related Nodes
51461       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
51462       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
51463       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
51464       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
51465       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
51466       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
51467       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
51468       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
51469       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
51470       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
51471       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
51472       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
51473       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
51474       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51475       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
51476       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
51477       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
51478       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
51479       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
51480       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
51481       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
51482       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
51483       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51484       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
51485       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
51486       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
51487       - FROM platform( platform Uses generic-vnf, MANY2MANY)
51488
51489       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
51490       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
51491     required:
51492     - vnf-id
51493     - vnf-name
51494     - vnf-type
51495     - in-maint
51496     - is-closed-loop-disabled
51497     properties:
51498       vnf-id:
51499         type: string
51500         description: Unique id of VNF.  This is unique across the graph.
51501       vnf-instance-id:
51502         type: string
51503         description: vnf instance id.
51504       vnf-name:
51505         type: string
51506         description: Name of VNF.
51507       vnf-name2:
51508         type: string
51509         description: Alternate name of VNF.
51510       vnf-type:
51511         type: string
51512         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.
51513       service-id:
51514         type: string
51515         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
51516       regional-resource-zone:
51517         type: string
51518         description: Regional way of organizing pservers, source of truth should define values
51519       prov-status:
51520         type: string
51521         description: Trigger for operational monitoring of this resource by Service Assurance systems.
51522       operational-status:
51523         type: string
51524         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
51525       license-key:
51526         type: string
51527         description: OBSOLETE -  do not use
51528       equipment-role:
51529         type: string
51530         description: Client should send valid enumerated value
51531       orchestration-status:
51532         type: string
51533         description: Orchestration status of this VNF, used by MSO.
51534       vnf-package-name:
51535         type: string
51536       vnf-discriptor-name:
51537         type: string
51538         description: vnf discriptor name
51539       job-id:
51540         type: string
51541         description: job id corresponding to vnf
51542       heat-stack-id:
51543         type: string
51544         description: Heat stack id corresponding to this instance, managed by MSO
51545       mso-catalog-key:
51546         type: string
51547         description: Corresponds to the SDN-C catalog id used to configure this VCE
51548       management-option:
51549         type: string
51550         description: identifier of managed by ATT or customer
51551       ipv4-oam-address:
51552         type: string
51553         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
51554       ipv4-loopback0-address:
51555         type: string
51556         description: v4 Loopback0 address
51557       nm-lan-v6-address:
51558         type: string
51559         description: v6 Loopback address
51560       management-v6-address:
51561         type: string
51562         description: v6 management address
51563       vcpu:
51564         type: integer
51565         format: int64
51566         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
51567       vcpu-units:
51568         type: string
51569         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
51570       vmemory:
51571         type: integer
51572         format: int64
51573         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
51574       vmemory-units:
51575         type: string
51576         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
51577       vdisk:
51578         type: integer
51579         format: int64
51580         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
51581       vdisk-units:
51582         type: string
51583         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
51584       nshd:
51585         type: integer
51586         format: int64
51587         description: number of associated SHD in vnf.
51588       nvm:
51589         type: integer
51590         format: int64
51591         description: number of vms in vnf.
51592       nnet:
51593         type: integer
51594         format: int64
51595         description: number of network in vnf.
51596       in-maint:
51597         type: boolean
51598         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.
51599       is-closed-loop-disabled:
51600         type: boolean
51601         description: used to indicate whether closed loop function is enabled on this node
51602   generic-vnfs:
51603     description: |
51604       Collection of VNFs
51605     properties:
51606       generic-vnf:
51607         type: array
51608         items:
51609           $ref: "#/patchDefinitions/generic-vnf"
51610   group-assignment:
51611     description: |
51612       Openstack group-assignment used to store exclusivity groups (EG).
51613       ###### Related Nodes
51614       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
51615       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
51616       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
51617
51618     required:
51619     - group-id
51620     - group-type
51621     - group-name
51622     properties:
51623       group-id:
51624         type: string
51625         description: Group id, expected to be unique across cloud-region.
51626       group-type:
51627         type: string
51628         description: Group type - the type of group this instance refers to
51629       group-name:
51630         type: string
51631         description: Group name - name assigned to the group
51632       group-description:
51633         type: string
51634         description: Group description - description of the group
51635   group-assignments:
51636     description: |
51637       Collection of openstack group assignments
51638     properties:
51639       group-assignment:
51640         type: array
51641         items:
51642           $ref: "#/patchDefinitions/group-assignment"
51643   host-route:
51644     description: |
51645       ###### Related Nodes
51646       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
51647
51648       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
51649     required:
51650     - host-route-id
51651     - route-prefix
51652     - next-hop
51653     properties:
51654       host-route-id:
51655         type: string
51656         description: host-route id
51657       route-prefix:
51658         type: string
51659         description: subnet prefix
51660       next-hop:
51661         type: string
51662         description: Could be ip-address, hostname, or service-instance
51663       next-hop-type:
51664         type: string
51665         description: Should be ip-address, hostname, or service-instance to match next-hop
51666   host-routes:
51667     properties:
51668       host-route:
51669         type: array
51670         items:
51671           $ref: "#/patchDefinitions/host-route"
51672   hpa-capabilities:
51673     description: |
51674       Collection of HPA Capabilities
51675     properties:
51676       hpa-capability:
51677         type: array
51678         items:
51679           $ref: "#/patchDefinitions/hpa-capability"
51680   hpa-capability:
51681     description: |
51682       Represents a HPA capability
51683       ###### Related Nodes
51684       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
51685       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
51686       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
51687
51688       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
51689     required:
51690     - hpa-capability-id
51691     - hpa-feature
51692     properties:
51693       hpa-capability-id:
51694         type: string
51695         description: UUID to uniquely identify a HPA capability
51696       hpa-feature:
51697         type: string
51698         description: Name of the HPACapability
51699       hpa-version:
51700         type: string
51701         description: HPA schema version
51702       architecture:
51703         type: string
51704         description: Hardware architecture
51705   hpa-feature-attributes:
51706     description: |
51707       HPA Capability Feature attributes
51708       ###### Related Nodes
51709       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
51710
51711       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
51712     required:
51713     - hpa-attribute-key
51714     properties:
51715       hpa-attribute-key:
51716         type: string
51717         description: name of the specific HPA attribute
51718       hpa-attribute-value:
51719         type: string
51720         description: JSON string specifying the value, unit and type of the specific HPA attribute
51721   image:
51722     description: |
51723       Openstack image.
51724       ###### Related Nodes
51725       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
51726       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
51727       - FROM vserver( vserver Uses image, MANY2ONE)
51728
51729       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
51730       -IMAGE cannot be deleted if related to VSERVER
51731
51732     required:
51733     - image-id
51734     - image-name
51735     - image-os-distro
51736     - image-os-version
51737     - image-selflink
51738     properties:
51739       image-id:
51740         type: string
51741         description: Image id, expected to be unique across cloud region
51742       image-name:
51743         type: string
51744         description: Image name
51745       image-architecture:
51746         type: string
51747         description: Operating system architecture.
51748       image-os-distro:
51749         type: string
51750         description: The common name of the operating system distribution in lowercase
51751       image-os-version:
51752         type: string
51753         description: The operating system version as specified by the distributor.
51754       application:
51755         type: string
51756         description: The application that the image instantiates.
51757       application-vendor:
51758         type: string
51759         description: The vendor of the application.
51760       application-version:
51761         type: string
51762         description: The version of the application.
51763       image-selflink:
51764         type: string
51765         description: URL to endpoint where AAI can get more details
51766   images:
51767     description: |
51768       Collectio of Openstack images.
51769     properties:
51770       image:
51771         type: array
51772         items:
51773           $ref: "#/patchDefinitions/image"
51774   include-node-filter:
51775     properties:
51776       include-node-type:
51777         type: string
51778   instance-filter:
51779     description: |
51780       InstanceFilter for performing a named-query or model query
51781   instance-filters:
51782     description: |
51783       InstanceFilters for performing a named-query or model query
51784     properties:
51785       instance-filter:
51786         type: array
51787         items:
51788           $ref: "#/patchDefinitions/instance-filter"
51789   instance-group:
51790     description: |
51791       General mechanism for grouping instances
51792       ###### Related Nodes
51793       - TO model( instance-group Targets model, MANY2MANY)
51794       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
51795       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
51796       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
51797       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
51798       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
51799       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
51800       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
51801       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
51802       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
51803       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
51804       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
51805
51806     required:
51807     - id
51808     - description
51809     - type
51810     properties:
51811       instance-group-role:
51812         type: string
51813         description: role of the instance group.
51814       model-invariant-id:
51815         type: string
51816         description: ASDC model id for this resource or service model.
51817       model-version-id:
51818         type: string
51819         description: ASDC model version uid for this resource model.
51820       id:
51821         type: string
51822         description: Instance Group ID, UUID assigned to this instance.
51823       description:
51824         type: string
51825         description: Descriptive text to help identify the usage of this instance-group
51826       type:
51827         type: string
51828         description: Only valid value today is lower case ha for high availability
51829       sub-type:
51830         type: string
51831         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
51832   instance-groups:
51833     description: |
51834       Collection of openstack route table references
51835     properties:
51836       instance-group:
51837         type: array
51838         items:
51839           $ref: "#/patchDefinitions/instance-group"
51840   inventory:
51841     properties:
51842       search:
51843         type: object
51844         $ref: "#/patchDefinitions/search"
51845       actions:
51846         type: object
51847         $ref: "#/patchDefinitions/actions"
51848       cloud-infrastructure:
51849         type: object
51850         $ref: "#/patchDefinitions/cloud-infrastructure"
51851       external-system:
51852         type: object
51853         $ref: "#/patchDefinitions/external-system"
51854       business:
51855         type: object
51856         $ref: "#/patchDefinitions/business"
51857       service-design-and-creation:
51858         type: object
51859         $ref: "#/patchDefinitions/service-design-and-creation"
51860       network:
51861         type: object
51862         $ref: "#/patchDefinitions/network"
51863       nodes:
51864         type: object
51865         $ref: "#/patchDefinitions/nodes"
51866   inventory-item:
51867     properties:
51868       inventory-item-type:
51869         type: string
51870       inventory-item-link:
51871         type: string
51872       inventory-item-data:
51873         type: array
51874         items:
51875           $ref: "#/patchDefinitions/inventory-item-data"
51876       tagged-inventory-item-list:
51877         type: array
51878         items:
51879           $ref: "#/patchDefinitions/tagged-inventory-item-list"
51880   inventory-item-data:
51881     properties:
51882       property-name:
51883         type: string
51884       property-value:
51885         type: string
51886   inventory-response-item:
51887     description: |
51888       Inventory item for response list
51889     properties:
51890       model-name:
51891         type: string
51892       extra-properties:
51893         type: object
51894         $ref: "#/patchDefinitions/extra-properties"
51895       inventory-response-items:
51896         type: object
51897         $ref: "#/patchDefinitions/inventory-response-items"
51898   inventory-response-items:
51899     description: |
51900       Container for inventory items in response list
51901     properties:
51902       inventory-response-item:
51903         type: array
51904         items:
51905           $ref: "#/patchDefinitions/inventory-response-item"
51906   ipsec-configuration:
51907     description: |
51908       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
51909       ###### Related Nodes
51910       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
51911       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
51912
51913       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
51914     required:
51915     - ipsec-configuration-id
51916     properties:
51917       ipsec-configuration-id:
51918         type: string
51919         description: UUID of this configuration
51920       requested-vig-address-type:
51921         type: string
51922         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
51923       requested-encryption-strength:
51924         type: string
51925         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
51926       requested-dmz-type:
51927         type: string
51928         description: ATT can offer a shared DMZ or a DMZ specific to a customer
51929       shared-dmz-network-address:
51930         type: string
51931         description: Network address of shared DMZ
51932       requested-customer-name:
51933         type: string
51934         description: If the DMZ is a custom DMZ, this field will indicate the customer information
51935       ike-version:
51936         type: string
51937         description: can be 1 or 2
51938       ikev1-authentication:
51939         type: string
51940         description: Contains values like md5, sha1, sha256, sha384
51941       ikev1-encryption:
51942         type: string
51943         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
51944       ikev1-dh-group:
51945         type: string
51946         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
51947       ikev1-am-group-id:
51948         type: string
51949         description: Group name defined in VIG for clients using aggressive mode
51950       ikev1-am-password:
51951         type: string
51952         description: pre-shared key for the above group name
51953       ikev1-sa-lifetime:
51954         type: string
51955         description: Lifetime for IKEv1 SA
51956       ipsec-authentication:
51957         type: string
51958         description: md5, sha1, sha256, sha384
51959       ipsec-encryption:
51960         type: string
51961         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
51962       ipsec-sa-lifetime:
51963         type: string
51964         description: Life time for IPSec SA
51965       ipsec-pfs:
51966         type: string
51967         description: enable PFS or not
51968       xauth-userid:
51969         type: string
51970         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
51971       xauth-user-password:
51972         type: string
51973         description: Encrypted using the Juniper $9$ algorithm
51974       dpd-interval:
51975         type: string
51976         description: The time between DPD probe
51977       dpd-frequency:
51978         type: string
51979         description: Maximum number of DPD before claiming the tunnel is down
51980   ipsec-configurations:
51981     properties:
51982       ipsec-configuration:
51983         type: array
51984         items:
51985           $ref: "#/patchDefinitions/ipsec-configuration"
51986   key-data:
51987     properties:
51988       key-name:
51989         type: string
51990       key-value:
51991         type: string
51992   l-interface:
51993     description: |
51994       Logical interfaces, e.g., a vnic.
51995       ###### Related Nodes
51996       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
51997       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
51998       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
51999       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52000       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52001       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52002       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52003       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52004       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
52005       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52006       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52007       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52008       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52009       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52010
52011       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52012       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52013       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52014     required:
52015     - interface-name
52016     - is-port-mirrored
52017     - in-maint
52018     - is-ip-unnumbered
52019     properties:
52020       interface-name:
52021         type: string
52022         description: Name given to the interface
52023       interface-role:
52024         type: string
52025         description: E.g., CUSTOMER, UPLINK, etc.
52026       v6-wan-link-ip:
52027         type: string
52028         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52029       selflink:
52030         type: string
52031         description: URL to endpoint where AAI can get more details
52032       interface-id:
52033         type: string
52034         description: ID of interface
52035       macaddr:
52036         type: string
52037         description: MAC address for the interface
52038       network-name:
52039         type: string
52040         description: Name of the network
52041       management-option:
52042         type: string
52043         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52044       interface-description:
52045         type: string
52046         description: Human friendly text regarding this interface.
52047       is-port-mirrored:
52048         type: boolean
52049         description: boolean indicatating whether or not port is a mirrored.
52050   l-interfaces:
52051     description: |
52052       Collection of logical interfaces.
52053     properties:
52054       l-interface:
52055         type: array
52056         items:
52057           $ref: "#/patchDefinitions/l-interface"
52058   l3-interface-ipv4-address-list:
52059     description: |
52060       IPv4 Address Range
52061       ###### Related Nodes
52062       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52063       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52064       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52065       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52066       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52067       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
52068
52069       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52070     required:
52071     - l3-interface-ipv4-address
52072     properties:
52073       l3-interface-ipv4-address:
52074         type: string
52075         description: IP address
52076       l3-interface-ipv4-prefix-length:
52077         type: integer
52078         format: int64
52079         description: Prefix length, 32 for single address
52080       vlan-id-inner:
52081         type: integer
52082         format: int64
52083         description: Inner VLAN tag
52084       vlan-id-outer:
52085         type: integer
52086         format: int64
52087         description: Outer VLAN tag
52088       is-floating:
52089         type: boolean
52090         description: Indicator of fixed or floating address
52091   l3-interface-ipv6-address-list:
52092     description: |
52093       IPv6 Address Range
52094       ###### Related Nodes
52095       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52096       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52097       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52098       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52099       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52100       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
52101
52102       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52103     required:
52104     - l3-interface-ipv6-address
52105     properties:
52106       l3-interface-ipv6-address:
52107         type: string
52108         description: IP address
52109       l3-interface-ipv6-prefix-length:
52110         type: integer
52111         format: int64
52112         description: Prefix length, 128 for single address
52113       vlan-id-inner:
52114         type: integer
52115         format: int64
52116         description: Inner VLAN tag
52117       vlan-id-outer:
52118         type: integer
52119         format: int64
52120         description: Outer VLAN tag
52121       is-floating:
52122         type: boolean
52123         description: Indicator of fixed or floating address
52124   l3-network:
52125     description: |
52126       Generic network definition
52127       ###### Related Nodes
52128       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
52129       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
52130       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
52131       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
52132       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
52133       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
52134       - FROM complex( complex Uses l3-network, MANY2MANY)
52135       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
52136       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52137       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52138       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
52139       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
52140       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
52141       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
52142       - FROM tenant( tenant Uses l3-network, MANY2MANY)
52143       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
52144
52145       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
52146     required:
52147     - network-id
52148     - network-name
52149     - is-bound-to-vpn
52150     - is-provider-network
52151     - is-shared-network
52152     - is-external-network
52153     properties:
52154       network-id:
52155         type: string
52156         description: Network ID, should be uuid. Unique across A&AI.
52157       network-name:
52158         type: string
52159         description: Name of the network, governed by some naming convention..
52160       network-type:
52161         type: string
52162         description: Type of the network - who defines these values?
52163       network-role:
52164         type: string
52165         description: Role the network plans - who defines these values?
52166       network-technology:
52167         type: string
52168         description: Network technology - who defines these values?
52169       neutron-network-id:
52170         type: string
52171         description: Neutron network id of this Interface
52172       is-bound-to-vpn:
52173         type: boolean
52174         description: Set to true if bound to VPN
52175       service-id:
52176         type: string
52177         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
52178       network-role-instance:
52179         type: integer
52180         format: int64
52181         description: network role instance
52182   l3-networks:
52183     properties:
52184       l3-network:
52185         type: array
52186         items:
52187           $ref: "#/patchDefinitions/l3-network"
52188   lag-interface:
52189     description: |
52190       Link aggregate interface
52191       ###### Related Nodes
52192       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
52193       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
52194       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
52195       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
52196       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
52197       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
52198       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
52199       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
52200
52201       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
52202       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
52203       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
52204     required:
52205     - interface-name
52206     - in-maint
52207     properties:
52208       interface-name:
52209         type: string
52210         description: Name that identifies the link aggregate interface
52211       interface-description:
52212         type: string
52213         description: Human friendly text regarding this interface.
52214   lag-interfaces:
52215     description: |
52216       Collection of link aggregate interfaces.
52217     properties:
52218       lag-interface:
52219         type: array
52220         items:
52221           $ref: "#/patchDefinitions/lag-interface"
52222   lag-link:
52223     description: |
52224       LAG links can connect lag-interfaces
52225       ###### Related Nodes
52226       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
52227       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
52228
52229       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
52230     required:
52231     - link-name
52232     properties:
52233       link-name:
52234         type: string
52235         description: Alphabetical concatenation of lag-interface names
52236   lag-links:
52237     description: |
52238       Collection of link aggregation connections
52239     properties:
52240       lag-link:
52241         type: array
52242         items:
52243           $ref: "#/patchDefinitions/lag-link"
52244   license:
52245     description: |
52246       Metadata for license group.
52247       ###### Related Nodes
52248       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
52249       - TO vce( license BelongsTo vce, MANY2ONE)(4)
52250
52251       -(4) IF this TO node is deleted, this LICENSE is DELETED also
52252     required:
52253     - group-uuid
52254     - resource-uuid
52255     properties:
52256       group-uuid:
52257         type: string
52258         description: Unique ID for the license group the resource belongs to, should be uuid.
52259       resource-uuid:
52260         type: string
52261         description: Unique ID of a license resource.
52262   licenses:
52263     description: |
52264       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
52265     properties:
52266       license:
52267         type: array
52268         items:
52269           $ref: "#/patchDefinitions/license"
52270   line-of-business:
52271     description: |
52272       describes a line-of-business
52273       ###### Related Nodes
52274       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
52275
52276     required:
52277     - line-of-business-name
52278     properties:
52279       line-of-business-name:
52280         type: string
52281         description: Name of the line-of-business (product)
52282   lines-of-business:
52283     description: |
52284       Collection of lines-of-business
52285     properties:
52286       line-of-business:
52287         type: array
52288         items:
52289           $ref: "#/patchDefinitions/line-of-business"
52290   logical-link:
52291     description: |
52292       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
52293       ###### Related Nodes
52294       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
52295       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
52296       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
52297       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
52298       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
52299       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
52300       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
52301       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
52302       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
52303       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
52304       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
52305       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
52306       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
52307       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
52308       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
52309
52310       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
52311     required:
52312     - link-name
52313     - in-maint
52314     - link-type
52315     properties:
52316       link-name:
52317         type: string
52318         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
52319       in-maint:
52320         type: boolean
52321         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.
52322       link-type:
52323         type: string
52324         description: Type of logical link, e.g., evc
52325       speed-value:
52326         type: string
52327         description: Captures the numeric part of the speed
52328       speed-units:
52329         type: string
52330         description: Captures the units corresponding to the speed
52331       ip-version:
52332         type: string
52333         description: v4, v6, or ds for dual stack
52334       routing-protocol:
52335         type: string
52336         description: For example, static or BGP
52337   logical-links:
52338     description: |
52339       Collection of logical connections
52340     properties:
52341       logical-link:
52342         type: array
52343         items:
52344           $ref: "#/patchDefinitions/logical-link"
52345   metadata:
52346     description: |
52347       Collection of metadatum (key/value pairs)
52348     properties:
52349       metadatum:
52350         type: array
52351         items:
52352           $ref: "#/patchDefinitions/metadatum"
52353   metadatum:
52354     description: |
52355       Key/value pairs
52356       ###### Related Nodes
52357       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
52358       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
52359       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
52360       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
52361       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
52362
52363       -(4) IF this TO node is deleted, this METADATUM is DELETED also
52364     required:
52365     - metaname
52366     - metaval
52367     properties:
52368       metaname:
52369         type: string
52370       metaval:
52371         type: string
52372   model:
52373     description: |
52374       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
52375       ###### Related Nodes
52376       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
52377       - FROM instance-group( instance-group Targets model, MANY2MANY)
52378       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
52379       - FROM named-query( named-query AppliesTo model, ONE2MANY)
52380       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
52381
52382       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
52383       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
52384
52385     required:
52386     - model-invariant-id
52387     - model-type
52388     properties:
52389       model-invariant-id:
52390         type: string
52391         description: Unique identifier corresponding to the main definition of a model in ASDC
52392       model-type:
52393         type: string
52394         description: Type of the model, e.g., service, resource, widget, etc.
52395   model-and-named-query-search:
52396     description: |
52397       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
52398     properties:
52399       query-parameters:
52400         type: object
52401         $ref: "#/patchDefinitions/query-parameters"
52402       instance-filters:
52403         type: object
52404         $ref: "#/patchDefinitions/instance-filters"
52405       secondary-filts:
52406         type: object
52407         $ref: "#/patchDefinitions/secondary-filts"
52408       top-node-type:
52409         type: string
52410       secondary-filter-cut-point:
52411         type: string
52412   model-constraint:
52413     description: |
52414       This is how we would capture constraints defining allowed sets of elements.
52415       ###### Related Nodes
52416       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
52417       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
52418
52419       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
52420       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
52421     required:
52422     - model-constraint-uuid
52423     - constrained-element-set-uuid-to-replace
52424     properties:
52425       model-constraint-uuid:
52426         type: string
52427       constrained-element-set-uuid-to-replace:
52428         type: string
52429       constrained-element-sets:
52430         type: array
52431         items:
52432           $ref: "#/patchDefinitions/constrained-element-set"
52433   model-constraints:
52434     properties:
52435       model-constraint:
52436         type: array
52437         items:
52438           $ref: "#/patchDefinitions/model-constraint"
52439   model-element:
52440     description: |
52441       Defines how other models combine to make up a higher-level model.
52442       ###### Related Nodes
52443       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
52444       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
52445       - TO model-ver( model-element IsA model-ver, MANY2ONE)
52446       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
52447       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
52448       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
52449       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
52450
52451       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
52452       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
52453     required:
52454     - model-element-uuid
52455     - new-data-del-flag
52456     - cardinality
52457     properties:
52458       model-element-uuid:
52459         type: string
52460       new-data-del-flag:
52461         type: string
52462         description: Indicates whether this element was created as part of instantiation from this model
52463       cardinality:
52464         type: string
52465         description: How many of this type of element are required/allowed
52466       linkage-points:
52467         type: string
52468   model-elements:
52469     properties:
52470       model-element:
52471         type: array
52472         items:
52473           $ref: "#/patchDefinitions/model-element"
52474   model-ver:
52475     description: |
52476       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
52477       ###### Related Nodes
52478       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
52479       - FROM model-element( model-element IsA model-ver, MANY2ONE)
52480       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
52481       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
52482
52483       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
52484       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
52485       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
52486
52487     required:
52488     - model-version-id
52489     - model-name
52490     - model-version
52491     properties:
52492       model-version-id:
52493         type: string
52494         description: Unique identifier corresponding to one version of a model in ASDC
52495       model-name:
52496         type: string
52497         description: Name of the model, which can change from version to version.
52498       model-version:
52499         type: string
52500         description: Version
52501       model-description:
52502         type: string
52503         description: Description
52504   model-vers:
52505     properties:
52506       model-ver:
52507         type: array
52508         items:
52509           $ref: "#/patchDefinitions/model-ver"
52510   models:
52511     description: |
52512       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
52513     properties:
52514       model:
52515         type: array
52516         items:
52517           $ref: "#/patchDefinitions/model"
52518   multicast-configuration:
52519     description: |
52520       ###### Related Nodes
52521       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
52522
52523     required:
52524     - multicast-configuration-id
52525     - multicast-protocol
52526     - rp-type
52527     properties:
52528       multicast-configuration-id:
52529         type: string
52530         description: Unique id of multicast configuration.
52531       multicast-protocol:
52532         type: string
52533         description: protocol of multicast configuration
52534       rp-type:
52535         type: string
52536         description: rp type of multicast configuration
52537   multicast-configurations:
52538     description: |
52539       multicast configuration of generic-vnf ip-address
52540     properties:
52541       multicast-configuration:
52542         type: array
52543         items:
52544           $ref: "#/patchDefinitions/multicast-configuration"
52545   named-queries:
52546     properties:
52547       named-query:
52548         type: array
52549         items:
52550           $ref: "#/patchDefinitions/named-query"
52551   named-query:
52552     description: |
52553       TBD
52554       ###### Related Nodes
52555       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
52556       - TO model( named-query AppliesTo model, ONE2MANY)
52557       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
52558
52559       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
52560     required:
52561     - named-query-uuid
52562     - named-query-name
52563     - named-query-version
52564     properties:
52565       named-query-uuid:
52566         type: string
52567       named-query-name:
52568         type: string
52569       named-query-version:
52570         type: string
52571       required-input-param:
52572         type: string
52573       description:
52574         type: string
52575   named-query-element:
52576     description: |
52577       TBD
52578       ###### Related Nodes
52579       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
52580       - TO model( named-query-element IsA model, MANY2ONE)
52581       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
52582       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
52583       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
52584       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
52585
52586       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
52587       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
52588     required:
52589     - named-query-element-uuid
52590     properties:
52591       named-query-element-uuid:
52592         type: string
52593       property-collect-list:
52594         type: string
52595   named-query-elements:
52596     properties:
52597       named-query-element:
52598         type: array
52599         items:
52600           $ref: "#/patchDefinitions/named-query-element"
52601   network:
52602     description: |
52603       Namespace for network inventory resources.
52604     properties:
52605       logical-links:
52606         type: array
52607         items:
52608           $ref: "#/patchDefinitions/logical-link"
52609       site-pair-sets:
52610         type: array
52611         items:
52612           $ref: "#/patchDefinitions/site-pair-set"
52613       vpn-bindings:
52614         type: array
52615         items:
52616           $ref: "#/patchDefinitions/vpn-binding"
52617       vpls-pes:
52618         type: array
52619         items:
52620           $ref: "#/patchDefinitions/vpls-pe"
52621       multicast-configurations:
52622         type: array
52623         items:
52624           $ref: "#/patchDefinitions/multicast-configuration"
52625       vces:
52626         type: array
52627         items:
52628           $ref: "#/patchDefinitions/vce"
52629       vnfcs:
52630         type: array
52631         items:
52632           $ref: "#/patchDefinitions/vnfc"
52633       l3-networks:
52634         type: array
52635         items:
52636           $ref: "#/patchDefinitions/l3-network"
52637       network-policies:
52638         type: array
52639         items:
52640           $ref: "#/patchDefinitions/network-policy"
52641       generic-vnfs:
52642         type: array
52643         items:
52644           $ref: "#/patchDefinitions/generic-vnf"
52645       lag-links:
52646         type: array
52647         items:
52648           $ref: "#/patchDefinitions/lag-link"
52649       newvces:
52650         type: array
52651         items:
52652           $ref: "#/patchDefinitions/newvce"
52653       pnfs:
52654         type: array
52655         items:
52656           $ref: "#/patchDefinitions/pnf"
52657       physical-links:
52658         type: array
52659         items:
52660           $ref: "#/patchDefinitions/physical-link"
52661       ipsec-configurations:
52662         type: array
52663         items:
52664           $ref: "#/patchDefinitions/ipsec-configuration"
52665       route-table-references:
52666         type: array
52667         items:
52668           $ref: "#/patchDefinitions/route-table-reference"
52669       instance-groups:
52670         type: array
52671         items:
52672           $ref: "#/patchDefinitions/instance-group"
52673       zones:
52674         type: array
52675         items:
52676           $ref: "#/patchDefinitions/zone"
52677       configurations:
52678         type: array
52679         items:
52680           $ref: "#/patchDefinitions/configurations"
52681   network-policies:
52682     properties:
52683       network-policy:
52684         type: array
52685         items:
52686           $ref: "#/patchDefinitions/network-policy"
52687   network-policy:
52688     description: |
52689       ###### Related Nodes
52690       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
52691       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
52692
52693     required:
52694     - network-policy-id
52695     properties:
52696       network-policy-id:
52697         type: string
52698         description: UUID representing unique key to this instance
52699       network-policy-fqdn:
52700         type: string
52701         description: Contrail FQDN for the policy
52702       heat-stack-id:
52703         type: string
52704         description: ID for the openStack Heat instance
52705   network-profile:
52706     description: |
52707       Network profile populated by SDN-GP for SNMP
52708       ###### Related Nodes
52709       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
52710
52711     required:
52712     - nm-profile-name
52713     properties:
52714       nm-profile-name:
52715         type: string
52716         description: Unique name of network profile.
52717       community-string:
52718         type: string
52719         description: Encrypted SNMP community string
52720   network-profiles:
52721     description: |
52722       Collection of network profiles
52723     properties:
52724       network-profile:
52725         type: array
52726         items:
52727           $ref: "#/patchDefinitions/network-profile"
52728   newvce:
52729     description: |
52730       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
52731       ###### Related Nodes
52732       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
52733
52734       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
52735     required:
52736     - vnf-id2
52737     - vnf-name
52738     - vnf-type
52739     properties:
52740       vnf-id2:
52741         type: string
52742         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
52743       vnf-name:
52744         type: string
52745         description: Name of VNF.
52746       vnf-name2:
52747         type: string
52748         description: Alternate name of VNF.
52749       vnf-type:
52750         type: string
52751         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.
52752       prov-status:
52753         type: string
52754         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52755       operational-status:
52756         type: string
52757         description: Indicator for whether the resource is considered operational
52758       license-key:
52759         type: string
52760         description: OBSOLETE -  do not use
52761       ipv4-oam-address:
52762         type: string
52763         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).
52764       equipment-role:
52765         type: string
52766         description: Client should send valid enumerated value.
52767   newvces:
52768     description: |
52769       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
52770     properties:
52771       newvce:
52772         type: array
52773         items:
52774           $ref: "#/patchDefinitions/newvce"
52775   nodes:
52776     properties:
52777       inventory-item-data:
52778         type: array
52779         items:
52780           $ref: "#/patchDefinitions/inventory-item-data"
52781   notification-event:
52782     properties:
52783       cambria.partition:
52784         type: string
52785       notification-event-header:
52786         type: object
52787         $ref: "#/patchDefinitions/notification-event-header"
52788   notification-event-header:
52789     properties:
52790       id:
52791         type: string
52792       timestamp:
52793         type: string
52794       source-name:
52795         type: string
52796       domain:
52797         type: string
52798       sequence-number:
52799         type: string
52800       severity:
52801         type: string
52802       event-type:
52803         type: string
52804       version:
52805         type: string
52806       action:
52807         type: string
52808       entity-type:
52809         type: string
52810       top-entity-type:
52811         type: string
52812       entity-link:
52813         type: string
52814       status:
52815         type: string
52816   notify:
52817     required:
52818     - event-id
52819     properties:
52820       event-id:
52821         type: string
52822       node-type:
52823         type: string
52824       event-trigger:
52825         type: string
52826       key-data:
52827         type: array
52828         items:
52829           $ref: "#/patchDefinitions/key-data"
52830       selflink:
52831         type: string
52832   oam-network:
52833     description: |
52834       OAM network, to be deprecated shortly.  Do not use for new purposes.
52835       ###### Related Nodes
52836       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
52837       - TO complex( oam-network AppliesTo complex, MANY2MANY)
52838       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
52839
52840     required:
52841     - network-uuid
52842     - network-name
52843     - cvlan-tag
52844     properties:
52845       network-uuid:
52846         type: string
52847         description: UUID of the network. Unique across a cloud-region
52848       network-name:
52849         type: string
52850         description: Name of the network.
52851       cvlan-tag:
52852         type: integer
52853         format: int64
52854         description: cvlan-id
52855       ipv4-oam-gateway-address:
52856         type: string
52857         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
52858       ipv4-oam-gateway-address-prefix-length:
52859         type: integer
52860         format: int32
52861         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
52862   oam-networks:
52863     description: |
52864       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
52865     properties:
52866       oam-network:
52867         type: array
52868         items:
52869           $ref: "#/patchDefinitions/oam-network"
52870   operational-environment:
52871     description: |
52872       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
52873       ###### Related Nodes
52874       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
52875       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
52876
52877     required:
52878     - operational-environment-id
52879     - operational-environment-name
52880     - operational-environment-type
52881     - operational-environment-status
52882     - tenant-context
52883     - workload-context
52884     properties:
52885       operational-environment-id:
52886         type: string
52887         description: UUID of an operational environment
52888       operational-environment-name:
52889         type: string
52890         description: Operational Environment name
52891       operational-environment-type:
52892         type: string
52893         description: Operational Environment Type.
52894       operational-environment-status:
52895         type: string
52896         description: Status
52897       tenant-context:
52898         type: string
52899         description: Tenant Context.
52900       workload-context:
52901         type: string
52902         description: Workload Context.
52903   operational-environments:
52904     description: |
52905       a logical partition of the cloud which allows to have multiple environments in the production AIC.
52906     properties:
52907       operational-environment:
52908         type: array
52909         items:
52910           $ref: "#/patchDefinitions/operational-environment"
52911   overloaded-model:
52912     description: |
52913       Allows for legacy POST of old-style and new-style models
52914     required:
52915     - model-invariant-id
52916     - model-name-version-id
52917     - model-type
52918     - model-name
52919     - model-id
52920     - model-version
52921     properties:
52922       model-invariant-id:
52923         type: string
52924         description: Unique identifier corresponding to the main definition of a model in ASDC
52925       model-name-version-id:
52926         type: string
52927         description: Unique identifier corresponding to one version of a model in ASDC
52928       model-type:
52929         type: string
52930         description: Type of the model, e.g., service, resource, widget, etc.
52931       model-name:
52932         type: string
52933         description: Name of the model, which can change from version to version.
52934       model-id:
52935         type: string
52936         description: Invariant unique ID which does not change from version to version
52937       model-version:
52938         type: string
52939         description: Version
52940       model-description:
52941         type: string
52942         description: Description
52943   owning-entities:
52944     description: |
52945       Collection of owning-entities
52946     properties:
52947       owning-entity:
52948         type: array
52949         items:
52950           $ref: "#/patchDefinitions/owning-entity"
52951   owning-entity:
52952     description: |
52953       describes an owning-entity
52954       ###### Related Nodes
52955       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
52956
52957     required:
52958     - owning-entity-id
52959     - owning-entity-name
52960     properties:
52961       owning-entity-id:
52962         type: string
52963         description: UUID of an owning entity
52964       owning-entity-name:
52965         type: string
52966         description: Owning entity name
52967   p-interface:
52968     description: |
52969       Physical interface (e.g., nic)
52970       ###### Related Nodes
52971       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
52972       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
52973       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
52974       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
52975       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
52976       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
52977       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
52978       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
52979
52980       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
52981       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
52982       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
52983     required:
52984     - interface-name
52985     - in-maint
52986     properties:
52987       interface-name:
52988         type: string
52989         description: Name that identifies the physical interface
52990       speed-value:
52991         type: string
52992         description: Captures the numeric part of the speed
52993       speed-units:
52994         type: string
52995         description: Captures the units corresponding to the speed
52996       port-description:
52997         type: string
52998         description: Nature of the services and connectivity on this port.
52999       equipment-identifier:
53000         type: string
53001         description: CLEI or other specification for p-interface hardware.
53002       interface-role:
53003         type: string
53004         description: Role specification for p-interface hardware.
53005       interface-type:
53006         type: string
53007         description: Indicates the physical properties of the interface.
53008       prov-status:
53009         type: string
53010         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53011       mac-addresss:
53012         type: string
53013         description: MAC Address of the p-interface.
53014   p-interfaces:
53015     description: |
53016       Collection of physical interfaces.
53017     properties:
53018       p-interface:
53019         type: array
53020         items:
53021           $ref: "#/patchDefinitions/p-interface"
53022   physical-link:
53023     description: |
53024       Collection of physical connections, typically between p-interfaces
53025       ###### Related Nodes
53026       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
53027
53028       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
53029     required:
53030     - link-name
53031     properties:
53032       link-name:
53033         type: string
53034         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
53035       speed-value:
53036         type: string
53037         description: Captures the numeric part of the speed
53038       speed-units:
53039         type: string
53040         description: Captures the units corresponding to the speed
53041       circuit-id:
53042         type: string
53043         description: Circuit it
53044       dual-mode:
53045         type: string
53046         description: Dual access mode (e.g., primary, secondary
53047       management-option:
53048         type: string
53049         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
53050       service-provider-name:
53051         type: string
53052         description: Name of the service Provider on this link.
53053       service-provider-bandwidth-up-value:
53054         type: integer
53055         format: int32
53056         description: Upstream Bandwidth value agreed with the service provider
53057       service-provider-bandwidth-up-units:
53058         type: string
53059         description: Units for the upstream BW value
53060       service-provider-bandwidth-down-value:
53061         type: integer
53062         format: int32
53063         description: Downstream Bandwidth value agreed with the service provider
53064       service-provider-bandwidth-down-units:
53065         type: string
53066         description: Units for downstream BW value
53067   physical-links:
53068     description: |
53069       Collection of physical connections, typically between p-interfaces
53070     properties:
53071       physical-link:
53072         type: array
53073         items:
53074           $ref: "#/patchDefinitions/physical-link"
53075   platform:
53076     description: |
53077       describes a platform
53078       ###### Related Nodes
53079       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
53080
53081     required:
53082     - platform-name
53083     properties:
53084       platform-name:
53085         type: string
53086         description: Name of the platform
53087   platforms:
53088     description: |
53089       Collection of platforms
53090     properties:
53091       platform:
53092         type: array
53093         items:
53094           $ref: "#/patchDefinitions/platform"
53095   pnf:
53096     description: |
53097       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
53098       ###### Related Nodes
53099       - TO complex( pnf LocatedIn complex, MANY2ONE)
53100       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
53101       - TO zone( pnf LocatedIn zone, MANY2ONE)
53102       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
53103       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
53104       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
53105       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
53106       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
53107       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
53108
53109       -(1) IF this PNF node is deleted, this FROM node is DELETED also
53110     required:
53111     - pnf-name
53112     - in-maint
53113     properties:
53114       pnf-name:
53115         type: string
53116         description: unique name of Physical Network Function.
53117       pnf-name2:
53118         type: string
53119         description: name of Physical Network Function.
53120       pnf-name2-source:
53121         type: string
53122         description: source of name2
53123       pnf-id:
53124         type: string
53125         description: id of pnf
53126       equip-type:
53127         type: string
53128         description: Equipment type.  Source of truth should define valid values.
53129       equip-vendor:
53130         type: string
53131         description: Equipment vendor.  Source of truth should define valid values.
53132       equip-model:
53133         type: string
53134         description: Equipment model.  Source of truth should define valid values.
53135       management-option:
53136         type: string
53137         description: identifier of managed by ATT or customer
53138       ipaddress-v4-oam:
53139         type: string
53140         description: ipv4-oam-address with new naming convention for IP addresses
53141       sw-version:
53142         type: string
53143         description: sw-version is the version of SW for the hosted application on the PNF.
53144       in-maint:
53145         type: boolean
53146         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.
53147       frame-id:
53148         type: string
53149         description: ID of the physical frame (relay rack) where pnf is installed.
53150       serial-number:
53151         type: string
53152         description: Serial number of the device
53153       ipaddress-v4-loopback-0:
53154         type: string
53155         description: IPV4 Loopback 0 address
53156       ipaddress-v6-loopback-0:
53157         type: string
53158         description: IPV6 Loopback 0 address
53159       ipaddress-v4-aim:
53160         type: string
53161         description: IPV4 AIM address
53162       ipaddress-v6-aim:
53163         type: string
53164         description: IPV6 AIM address
53165       ipaddress-v6-oam:
53166         type: string
53167         description: IPV6 OAM address
53168       inv-status:
53169         type: string
53170         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
53171   pnfs:
53172     description: |
53173       Collection of Physical Network Functions.
53174     properties:
53175       pnf:
53176         type: array
53177         items:
53178           $ref: "#/patchDefinitions/pnf"
53179   port-group:
53180     description: |
53181       Used to capture the network interfaces of this VCE
53182       ###### Related Nodes
53183       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
53184       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
53185
53186       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
53187       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
53188     required:
53189     - interface-id
53190     - orchestration-status
53191     properties:
53192       interface-id:
53193         type: string
53194         description: Unique ID of the interface
53195       neutron-network-id:
53196         type: string
53197         description: Neutron network id of this Interface
53198       neutron-network-name:
53199         type: string
53200         description: Neutron network name of this Interface
53201       interface-role:
53202         type: string
53203         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53204   port-groups:
53205     properties:
53206       port-group:
53207         type: array
53208         items:
53209           $ref: "#/patchDefinitions/port-group"
53210   project:
53211     description: |
53212       describes the project
53213       ###### Related Nodes
53214       - TO service-instance( project Uses service-instance, ONE2MANY)
53215
53216     required:
53217     - project-name
53218     properties:
53219       project-name:
53220         type: string
53221         description: Name of the project deploying a service
53222   projects:
53223     description: |
53224       Collection of projects
53225     properties:
53226       project:
53227         type: array
53228         items:
53229           $ref: "#/patchDefinitions/project"
53230   properties:
53231     description: |
53232       Property holder for query properties or instance properties
53233     properties:
53234       property-name:
53235         type: string
53236       property-value:
53237         type: string
53238   property-constraint:
53239     description: |
53240       TBD
53241       ###### Related Nodes
53242       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
53243
53244       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
53245     required:
53246     - property-constraint-uuid
53247     - constraint-type
53248     - property-name
53249     - property-value
53250     properties:
53251       property-constraint-uuid:
53252         type: string
53253       constraint-type:
53254         type: string
53255       property-name:
53256         type: string
53257       property-value:
53258         type: string
53259   property-constraints:
53260     properties:
53261       property-constraint:
53262         type: array
53263         items:
53264           $ref: "#/patchDefinitions/property-constraint"
53265   pserver:
53266     description: |
53267       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
53268       ###### Related Nodes
53269       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
53270       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
53271       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
53272       - TO complex( pserver LocatedIn complex, MANY2ONE)
53273       - TO zone( pserver LocatedIn zone, MANY2ONE)
53274       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
53275       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
53276       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
53277       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
53278       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
53279
53280       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
53281       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
53282
53283     required:
53284     - hostname
53285     - in-maint
53286     properties:
53287       hostname:
53288         type: string
53289         description: Value from executing hostname on the compute node.
53290       ptnii-equip-name:
53291         type: string
53292         description: PTNII name
53293       number-of-cpus:
53294         type: integer
53295         format: int32
53296         description: Number of cpus
53297       disk-in-gigabytes:
53298         type: integer
53299         format: int32
53300         description: Disk size, in GBs
53301       ram-in-megabytes:
53302         type: integer
53303         format: int32
53304         description: RAM size, in MBs
53305       equip-type:
53306         type: string
53307         description: Equipment type.  Source of truth should define valid values.
53308       equip-vendor:
53309         type: string
53310         description: Equipment vendor.  Source of truth should define valid values.
53311       equip-model:
53312         type: string
53313         description: Equipment model.  Source of truth should define valid values.
53314       fqdn:
53315         type: string
53316         description: Fully-qualified domain name
53317       pserver-selflink:
53318         type: string
53319         description: URL to endpoint where AAI can get more details
53320       ipv4-oam-address:
53321         type: string
53322         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
53323       serial-number:
53324         type: string
53325         description: Serial number, may be queried
53326       ipaddress-v4-loopback-0:
53327         type: string
53328         description: IPV4 Loopback 0 address
53329       ipaddress-v6-loopback-0:
53330         type: string
53331         description: IPV6 Loopback 0 address
53332       ipaddress-v4-aim:
53333         type: string
53334         description: IPV4 AIM address
53335       ipaddress-v6-aim:
53336         type: string
53337         description: IPV6 AIM address
53338       ipaddress-v6-oam:
53339         type: string
53340         description: IPV6 OAM address
53341       inv-status:
53342         type: string
53343         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
53344       pserver-id:
53345         type: string
53346         description: ID of Pserver
53347       internet-topology:
53348         type: string
53349         description: internet topology of Pserver
53350       in-maint:
53351         type: boolean
53352         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.
53353   pservers:
53354     description: |
53355       Collection of compute hosts.
53356     properties:
53357       pserver:
53358         type: array
53359         items:
53360           $ref: "#/patchDefinitions/pserver"
53361   query-parameters:
53362     description: |
53363       QueryParameters for performing a named-query or model query
53364     properties:
53365       named-query:
53366         type: object
53367         $ref: "#/patchDefinitions/named-query"
53368       overloaded-model:
53369         type: object
53370         $ref: "#/patchDefinitions/overloaded-model"
53371   related-lookup:
53372     description: |
53373       TBD
53374       ###### Related Nodes
53375       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
53376
53377       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
53378     required:
53379     - related-lookup-uuid
53380     - source-node-type
53381     - source-node-property
53382     - target-node-type
53383     - target-node-property
53384     properties:
53385       related-lookup-uuid:
53386         type: string
53387       source-node-type:
53388         type: string
53389       source-node-property:
53390         type: string
53391       target-node-type:
53392         type: string
53393       target-node-property:
53394         type: string
53395       property-collect-list:
53396         type: string
53397   related-lookups:
53398     properties:
53399       related-lookup:
53400         type: array
53401         items:
53402           $ref: "#/patchDefinitions/related-lookup"
53403   related-to-property:
53404     properties:
53405       property-key:
53406         type: string
53407         description: Key part of a key/value pair
53408       property-value:
53409         type: string
53410         description: Value part of a key/value pair
53411   relationship:
53412     properties:
53413       related-to:
53414         type: string
53415         description: A keyword provided by A&AI to indicate type of node.
53416       related-link:
53417         type: string
53418         description: URL to the object in A&AI.
53419       relationship-data:
53420         type: array
53421         items:
53422           $ref: "#/patchDefinitions/relationship-data"
53423       related-to-property:
53424         type: array
53425         items:
53426           $ref: "#/patchDefinitions/related-to-property"
53427   relationship-data:
53428     required:
53429     - relationship-key
53430     - relationship-value
53431     properties:
53432       relationship-key:
53433         type: string
53434         description: A keyword provided by A&AI to indicate an attribute.
53435       relationship-value:
53436         type: string
53437         description: Value of the attribute.
53438   reserved-prop-names:
53439     description: |
53440       Internal map to define some reserved properties of a vertex
53441     properties:
53442       last-mod-source-of-truth:
53443         type: string
53444       aai-node-type:
53445         type: string
53446       aai-created-ts:
53447         type: integer
53448         format: int64
53449       aai-unique-key:
53450         type: string
53451       aai-last-mod-ts:
53452         type: integer
53453         format: int64
53454       source-of-truth:
53455         type: string
53456       aai-uri:
53457         type: string
53458   response-list:
53459     description: |
53460       Response container for the results of a named-query or model query
53461     properties:
53462       inventory-response-items:
53463         type: object
53464         $ref: "#/patchDefinitions/inventory-response-items"
53465   result-data:
53466     properties:
53467       resource-type:
53468         type: string
53469         description: The specific type of node in the A&AI graph
53470       resource-link:
53471         type: string
53472         description: The URL to the specific resource
53473   route-table-reference:
53474     description: |
53475       Openstack route table reference.
53476       ###### Related Nodes
53477       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
53478
53479     required:
53480     - route-table-reference-id
53481     - route-table-reference-fqdn
53482     properties:
53483       route-table-reference-id:
53484         type: string
53485         description: Route Table Reference id, UUID assigned to this instance.
53486       route-table-reference-fqdn:
53487         type: string
53488         description: FQDN entry in the route table.
53489   route-table-references:
53490     description: |
53491       Collection of openstack route table references
53492     properties:
53493       route-table-reference:
53494         type: array
53495         items:
53496           $ref: "#/patchDefinitions/route-table-reference"
53497   route-target:
53498     description: |
53499       Route target information
53500       ###### Related Nodes
53501       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
53502
53503       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
53504     required:
53505     - global-route-target
53506     - route-target-role
53507     properties:
53508       global-route-target:
53509         type: string
53510         description: Number used to identify an RT, globally unique in the network
53511       route-target-role:
53512         type: string
53513         description: Role assigned to this route target
53514   route-targets:
53515     description: |
53516       Collection of route target information
53517     properties:
53518       route-target:
53519         type: array
53520         items:
53521           $ref: "#/patchDefinitions/route-target"
53522   routing-instance:
53523     description: |
53524       ###### Related Nodes
53525       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
53526       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
53527
53528       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
53529       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
53530     required:
53531     - routing-instance-id
53532     properties:
53533       routing-instance-id:
53534         type: string
53535         description: Unique id of routing instance
53536       rpm-owner:
53537         type: string
53538         description: rpm owner
53539   routing-instances:
53540     description: |
53541       set of probes related to generic-vnf routing instance
53542     properties:
53543       routing-instance:
53544         type: array
53545         items:
53546           $ref: "#/patchDefinitions/routing-instance"
53547   sdn-zone-response:
53548     properties:
53549       oam-networks:
53550         type: object
53551         $ref: "#/patchDefinitions/oam-networks"
53552       az-and-dvs-switches:
53553         type: array
53554         items:
53555           $ref: "#/patchDefinitions/az-and-dvs-switches"
53556   search:
53557     properties:
53558       edge-tag-query-result:
53559         type: object
53560         $ref: "#/patchDefinitions/edge-tag-query-result"
53561       edge-tag-query-request:
53562         type: object
53563         $ref: "#/patchDefinitions/edge-tag-query-request"
53564       search-results:
53565         type: object
53566         $ref: "#/patchDefinitions/search-results"
53567       sdn-zone-response:
53568         type: object
53569         $ref: "#/patchDefinitions/sdn-zone-response"
53570   search-results:
53571     properties:
53572       result-data:
53573         type: array
53574         items:
53575           $ref: "#/patchDefinitions/result-data"
53576   secondary-filt:
53577     description: |
53578       SecondaryFilt for performing a named-query or model query
53579   secondary-filter:
53580     properties:
53581       property-name:
53582         type: string
53583       filter-type:
53584         type: string
53585       property-value:
53586         type: string
53587   secondary-filts:
53588     description: |
53589       SecondaryFilts for performing a named-query or model query
53590     properties:
53591       secondary-filt:
53592         type: array
53593         items:
53594           $ref: "#/patchDefinitions/secondary-filt"
53595   segmentation-assignment:
53596     description: |
53597       Openstack segmentation assignment.
53598       ###### Related Nodes
53599       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
53600
53601       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
53602     required:
53603     - segmentation-id
53604     properties:
53605       segmentation-id:
53606         type: string
53607         description: Route Table Reference id, UUID assigned to this instance.
53608   segmentation-assignments:
53609     description: |
53610       Collection of openstack segmentation assignments
53611     properties:
53612       segmentation-assignment:
53613         type: array
53614         items:
53615           $ref: "#/patchDefinitions/segmentation-assignment"
53616   service:
53617     description: |
53618       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
53619     required:
53620     - service-id
53621     - service-description
53622     properties:
53623       service-id:
53624         type: string
53625         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
53626       service-description:
53627         type: string
53628         description: Description of the service
53629       service-selflink:
53630         type: string
53631         description: URL to endpoint where AAI can get more details
53632   service-capabilities:
53633     description: |
53634       Collection of service capabilities.
53635     properties:
53636       service-capability:
53637         type: array
53638         items:
53639           $ref: "#/patchDefinitions/service-capability"
53640   service-capability:
53641     description: |
53642       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
53643       ###### Related Nodes
53644       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
53645       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
53646
53647       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
53648
53649     required:
53650     - service-type
53651     - vnf-type
53652     properties:
53653       service-type:
53654         type: string
53655         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
53656       vnf-type:
53657         type: string
53658         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.
53659   service-design-and-creation:
53660     description: |
53661       Namespace for objects managed by ASDC
53662     properties:
53663       vnf-images:
53664         type: array
53665         items:
53666           $ref: "#/patchDefinitions/vnf-image"
53667       services:
53668         type: array
53669         items:
53670           $ref: "#/patchDefinitions/service"
53671       service-capabilities:
53672         type: array
53673         items:
53674           $ref: "#/patchDefinitions/service-capability"
53675       models:
53676         type: array
53677         items:
53678           $ref: "#/patchDefinitions/model"
53679       named-queries:
53680         type: array
53681         items:
53682           $ref: "#/patchDefinitions/named-query"
53683   service-instance:
53684     description: |
53685       Instance of a service
53686       ###### Related Nodes
53687       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
53688       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
53689       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
53690       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
53691       - TO configuration( service-instance Uses configuration, ONE2MANY)
53692       - TO connector( service-instance Uses connector, MANY2MANY)
53693       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
53694       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
53695       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
53696       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
53697       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
53698       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
53699       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
53700       - TO zone( service-instance LocatedIn zone, MANY2ONE)
53701       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
53702       - TO vce( service-instance ComposedOf vce, ONE2MANY)
53703       - FROM project( project Uses service-instance, ONE2MANY)
53704       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
53705       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
53706       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
53707
53708       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
53709       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
53710       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
53711     required:
53712     - service-instance-id
53713     properties:
53714       service-instance-id:
53715         type: string
53716         description: Uniquely identifies this instance of a service
53717       service-instance-name:
53718         type: string
53719         description: This field will store a name assigned to the service-instance.
53720       service-type:
53721         type: string
53722         description: String capturing type of service.
53723       service-role:
53724         type: string
53725         description: String capturing the service role.
53726       environment-context:
53727         type: string
53728         description: This field will store the environment context assigned to the service-instance.
53729       workload-context:
53730         type: string
53731         description: This field will store the workload context assigned to the service-instance.
53732       created-at:
53733         type: string
53734         description: create time of Network Service.
53735       updated-at:
53736         type: string
53737         description: last update of Network Service.
53738       description:
53739         type: string
53740         description: short description for service-instance.
53741       model-invariant-id:
53742         type: string
53743         description: the ASDC model id for this resource or service model.
53744       model-version-id:
53745         type: string
53746         description: the ASDC model version for this resource or service model.
53747       persona-model-version:
53748         type: string
53749         description: the ASDC model version for this resource or service model.
53750       widget-model-id:
53751         type: string
53752         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53753       widget-model-version:
53754         type: string
53755         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53756       bandwidth-total:
53757         type: string
53758         description: Indicates the total bandwidth to be used for this service.
53759       bandwidth-up-wan1:
53760         type: string
53761         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
53762       bandwidth-down-wan1:
53763         type: string
53764         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
53765       bandwidth-up-wan2:
53766         type: string
53767         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
53768       bandwidth-down-wan2:
53769         type: string
53770         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
53771       vhn-portal-url:
53772         type: string
53773         description: URL customers will use to access the vHN Portal.
53774       service-instance-location-id:
53775         type: string
53776         description: An identifier that customers assign to the location where this service is being used.
53777   service-instances:
53778     description: |
53779       Collection of service instances
53780     properties:
53781       service-instance:
53782         type: array
53783         items:
53784           $ref: "#/patchDefinitions/service-instance"
53785   service-subscription:
53786     description: |
53787       Object that group service instances.
53788       ###### Related Nodes
53789       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
53790       - TO tenant( service-subscription Uses tenant, MANY2MANY)
53791       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
53792
53793       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
53794       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
53795     required:
53796     - service-type
53797     properties:
53798       service-type:
53799         type: string
53800         description: Value defined by orchestration to identify this service across ECOMP.
53801       temp-ub-sub-account-id:
53802         type: string
53803         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
53804   service-subscriptions:
53805     description: |
53806       Collection of objects that group service instances.
53807     properties:
53808       service-subscription:
53809         type: array
53810         items:
53811           $ref: "#/patchDefinitions/service-subscription"
53812   services:
53813     description: |
53814       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
53815     properties:
53816       service:
53817         type: array
53818         items:
53819           $ref: "#/patchDefinitions/service"
53820   site-pair:
53821     description: |
53822       ###### Related Nodes
53823       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
53824       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
53825
53826       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
53827       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
53828     required:
53829     - site-pair-id
53830     properties:
53831       site-pair-id:
53832         type: string
53833         description: unique identifier of probe
53834       source-ip:
53835         type: string
53836         description: Prefix address
53837       destination-ip:
53838         type: string
53839         description: Prefix address
53840       ip-version:
53841         type: string
53842         description: ip version, v4, v6
53843       destination-hostname:
53844         type: string
53845         description: Hostname of the destination equipment to which SLAs are measured against.
53846       destination-equip-type:
53847         type: string
53848         description: The type of destinatination equipment. Could be Router, UCPE, etc.
53849   site-pair-set:
53850     description: |
53851       Set of instances for probes used to measure service level agreements
53852       ###### Related Nodes
53853       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53854       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
53855
53856       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
53857     required:
53858     - site-pair-set-id
53859     properties:
53860       site-pair-set-id:
53861         type: string
53862         description: Unique id of site pair set.
53863   site-pair-sets:
53864     description: |
53865       Collection of sets of instances for probes related to generic-vnf
53866     properties:
53867       site-pair-set:
53868         type: array
53869         items:
53870           $ref: "#/patchDefinitions/site-pair-set"
53871   site-pairs:
53872     description: |
53873       probe within a set
53874     properties:
53875       site-pair:
53876         type: array
53877         items:
53878           $ref: "#/patchDefinitions/site-pair"
53879   snapshot:
53880     description: |
53881       Openstack snapshot
53882       ###### Related Nodes
53883       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
53884       - FROM vserver( vserver Uses snapshot, ONE2ONE)
53885
53886     required:
53887     - snapshot-id
53888     properties:
53889       snapshot-id:
53890         type: string
53891         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
53892       snapshot-name:
53893         type: string
53894         description: Snapshot name
53895       snapshot-architecture:
53896         type: string
53897         description: Operating system architecture
53898       snapshot-os-distro:
53899         type: string
53900         description: The common name of the operating system distribution in lowercase
53901       snapshot-os-version:
53902         type: string
53903         description: The operating system version as specified by the distributor.
53904       application:
53905         type: string
53906         description: The application that the image instantiates.
53907       application-vendor:
53908         type: string
53909         description: The vendor of the application.
53910       application-version:
53911         type: string
53912         description: The version of the application.
53913       snapshot-selflink:
53914         type: string
53915         description: URL to endpoint where AAI can get more details
53916       prev-snapshot-id:
53917         type: string
53918         description: This field contains the UUID of the previous snapshot (if any).
53919   snapshots:
53920     description: |
53921       Collection of openstack snapshots
53922     properties:
53923       snapshot:
53924         type: array
53925         items:
53926           $ref: "#/patchDefinitions/snapshot"
53927   sriov-pf:
53928     description: |
53929       SR-IOV Physical Function
53930       ###### Related Nodes
53931       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
53932       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
53933
53934       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
53935     required:
53936     - pf-pci-id
53937     properties:
53938       pf-pci-id:
53939         type: string
53940         description: Identifier for the sriov-pf
53941   sriov-pfs:
53942     description: |
53943       Collection of SR-IOV Physical Functions.
53944     properties:
53945       sriov-pf:
53946         type: array
53947         items:
53948           $ref: "#/patchDefinitions/sriov-pf"
53949   sriov-vf:
53950     description: |
53951       SR-IOV Virtual Function (not to be confused with virtual network function)
53952       ###### Related Nodes
53953       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
53954       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
53955
53956       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
53957     required:
53958     - pci-id
53959     properties:
53960       pci-id:
53961         type: string
53962         description: PCI ID used to identify the sriov-vf
53963       vf-vlan-filter:
53964         type: string
53965         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
53966       vf-mac-filter:
53967         type: string
53968         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
53969       vf-vlan-strip:
53970         type: boolean
53971         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
53972       vf-vlan-anti-spoof-check:
53973         type: boolean
53974         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.
53975       vf-mac-anti-spoof-check:
53976         type: boolean
53977         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.
53978       vf-mirrors:
53979         type: string
53980         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
53981       vf-broadcast-allow:
53982         type: boolean
53983         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
53984       vf-unknown-multicast-allow:
53985         type: boolean
53986         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
53987       vf-unknown-unicast-allow:
53988         type: boolean
53989         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
53990       vf-insert-stag:
53991         type: boolean
53992         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
53993       vf-link-status:
53994         type: string
53995         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
53996   sriov-vfs:
53997     description: |
53998       Collection of SR-IOV Virtual Functions.
53999     properties:
54000       sriov-vf:
54001         type: array
54002         items:
54003           $ref: "#/patchDefinitions/sriov-vf"
54004   start-node-filter:
54005     properties:
54006       property-name:
54007         type: string
54008       property-value:
54009         type: string
54010   subnet:
54011     description: |
54012       ###### Related Nodes
54013       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
54014       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54015       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54016       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
54017       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
54018       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
54019
54020       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
54021       -(4) IF this TO node is deleted, this SUBNET is DELETED also
54022       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
54023
54024     required:
54025     - subnet-id
54026     - dhcp-enabled
54027     properties:
54028       subnet-id:
54029         type: string
54030         description: Subnet ID, should be UUID.
54031       subnet-name:
54032         type: string
54033         description: Name associated with the subnet.
54034       neutron-subnet-id:
54035         type: string
54036         description: Neutron id of this subnet
54037       gateway-address:
54038         type: string
54039         description: gateway ip address
54040       network-start-address:
54041         type: string
54042         description: network start address
54043       cidr-mask:
54044         type: string
54045         description: cidr mask
54046       ip-version:
54047         type: string
54048         description: ip version
54049       orchestration-status:
54050         type: string
54051         description: Orchestration status of this VNF, mastered by MSO
54052       dhcp-enabled:
54053         type: boolean
54054         description: dhcp enabled
54055       dhcp-start:
54056         type: string
54057         description: the start address reserved for use by dhcp
54058       dhcp-end:
54059         type: string
54060         description: the last address reserved for use by dhcp
54061       subnet-role:
54062         type: string
54063         description: role of the subnet, referenced when assigning IPs
54064       ip-assignment-direction:
54065         type: string
54066         description: ip address assignment direction of the subnet
54067   subnets:
54068     properties:
54069       subnet:
54070         type: array
54071         items:
54072           $ref: "#/patchDefinitions/subnet"
54073   tagged-inventory-item-list:
54074     properties:
54075       inventory-item:
54076         type: array
54077         items:
54078           $ref: "#/patchDefinitions/inventory-item"
54079   tenant:
54080     description: |
54081       Openstack tenant
54082       ###### Related Nodes
54083       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
54084       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
54085       - TO l3-network( tenant Uses l3-network, MANY2MANY)
54086       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
54087       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
54088       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
54089
54090       -TENANT cannot be deleted if related to VSERVER
54091
54092     required:
54093     - tenant-id
54094     - tenant-name
54095     properties:
54096       tenant-id:
54097         type: string
54098         description: Unique id relative to the cloud-region.
54099       tenant-name:
54100         type: string
54101         description: Readable name of tenant
54102       tenant-context:
54103         type: string
54104         description: This field will store the tenant context.
54105   tenants:
54106     description: |
54107       Collection of openstack tenants.
54108     properties:
54109       tenant:
54110         type: array
54111         items:
54112           $ref: "#/patchDefinitions/tenant"
54113   tunnel-xconnect:
54114     description: |
54115       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
54116       ###### Related Nodes
54117       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
54118
54119       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
54120     required:
54121     - id
54122     - bandwidth-up-wan1
54123     - bandwidth-down-wan1
54124     - bandwidth-up-wan2
54125     - bandwidth-down-wan2
54126     properties:
54127       id:
54128         type: string
54129         description: Allotted Resource id UUID assigned to this instance.
54130       bandwidth-up-wan1:
54131         type: string
54132         description: The WAN uplink bandwidth for WAN1
54133       bandwidth-down-wan1:
54134         type: string
54135         description: The WAN downlink bandwidth for WAN1
54136       bandwidth-up-wan2:
54137         type: string
54138         description: The WAN uplink bandwidth for WAN2
54139       bandwidth-down-wan2:
54140         type: string
54141         description: The WAN downlink bandwidth for WAN2
54142   tunnel-xconnects:
54143     description: |
54144       This object is used to store the specific tunnel cross connect aspects of an allotted resource
54145     properties:
54146       tunnel-xconnect:
54147         type: array
54148         items:
54149           $ref: "#/patchDefinitions/tunnel-xconnect"
54150   update:
54151     description: |
54152       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
54153     required:
54154     - update-node-type
54155     properties:
54156       update-node-type:
54157         type: string
54158       update-node-key:
54159         type: array
54160         items:
54161           $ref: "#/patchDefinitions/update-node-key"
54162       update-node-uri:
54163         type: string
54164       action:
54165         type: array
54166         items:
54167           $ref: "#/patchDefinitions/action"
54168   update-node-key:
54169     properties:
54170       key-name:
54171         type: string
54172       key-value:
54173         type: string
54174   vce:
54175     description: |
54176       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
54177       ###### Related Nodes
54178       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
54179       - TO complex( vce LocatedIn complex, MANY2MANY)
54180       - TO vserver( vce HostedOn vserver, ONE2MANY)
54181       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
54182       - FROM license( license BelongsTo vce, MANY2ONE)(1)
54183       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
54184       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
54185
54186       -(1) IF this VCE node is deleted, this FROM node is DELETED also
54187     required:
54188     - vnf-id
54189     - vnf-name
54190     - vnf-type
54191     properties:
54192       vnf-id:
54193         type: string
54194         description: Unique id of VNF.  This is unique across the graph.
54195       vnf-name:
54196         type: string
54197         description: Name of VNF.
54198       vnf-name2:
54199         type: string
54200         description: Alternate name of VNF.
54201       vnf-type:
54202         type: string
54203         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.
54204       service-id:
54205         type: string
54206         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
54207       regional-resource-zone:
54208         type: string
54209         description: Regional way of organizing pservers, source of truth should define values
54210       prov-status:
54211         type: string
54212         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54213       operational-status:
54214         type: string
54215         description: Indicator for whether the resource is considered operational
54216       license-key:
54217         type: string
54218         description: OBSOLETE -  do not use
54219       equipment-role:
54220         type: string
54221         description: Network role being played by this VNF
54222       orchestration-status:
54223         type: string
54224         description: Orchestration status of this VNF, mastered by MSO
54225       heat-stack-id:
54226         type: string
54227         description: Heat stack id corresponding to this instance, managed by MSO
54228       mso-catalog-key:
54229         type: string
54230         description: Corresponds to the SDN-C catalog id used to configure this VCE
54231       vpe-id:
54232         type: string
54233         description: Unique ID of VPE connected to this VCE.
54234       v6-vce-wan-address:
54235         type: string
54236         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
54237       ipv4-oam-address:
54238         type: string
54239         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
54240   vces:
54241     description: |
54242       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
54243     properties:
54244       vce:
54245         type: array
54246         items:
54247           $ref: "#/patchDefinitions/vce"
54248   vf-module:
54249     description: |
54250       a deployment unit of VNFCs
54251       ###### Related Nodes
54252       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
54253       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
54254       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
54255       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
54256       - TO vserver( vf-module Uses vserver, ONE2MANY)
54257
54258       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
54259       -VF-MODULE cannot be deleted if related to VNFC
54260
54261     required:
54262     - vf-module-id
54263     - is-base-vf-module
54264     properties:
54265       vf-module-id:
54266         type: string
54267         description: Unique ID of vf-module.
54268       vf-module-name:
54269         type: string
54270         description: Name of vf-module
54271       heat-stack-id:
54272         type: string
54273         description: Heat stack id corresponding to this instance.
54274       orchestration-status:
54275         type: string
54276         description: orchestration status of this vf-module, mastered by MSO
54277       is-base-vf-module:
54278         type: boolean
54279         description: used to indicate whether or not this object is base vf module
54280   vf-modules:
54281     description: |
54282       Collection of vf-modules, a deployment unit of VNFCs
54283     properties:
54284       vf-module:
54285         type: array
54286         items:
54287           $ref: "#/patchDefinitions/vf-module"
54288   vig-server:
54289     description: |
54290       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
54291       ###### Related Nodes
54292       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
54293
54294       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
54295     required:
54296     - vig-address-type
54297     properties:
54298       vig-address-type:
54299         type: string
54300         description: indicates whether the VIG is for AVPN or INTERNET
54301       ipaddress-v4-vig:
54302         type: string
54303         description: v4 IP of the vig server
54304       ipaddress-v6-vig:
54305         type: string
54306         description: v6 IP of the vig server
54307   vig-servers:
54308     properties:
54309       vig-server:
54310         type: array
54311         items:
54312           $ref: "#/patchDefinitions/vig-server"
54313   vip-ipv4-address-list:
54314     description: |
54315       IPv4 Address Range
54316       ###### Related Nodes
54317       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
54318       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
54319       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
54320       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
54321
54322     required:
54323     - vip-ipv4-address
54324     properties:
54325       vip-ipv4-address:
54326         type: string
54327         description: IP address
54328       vip-ipv4-prefix-length:
54329         type: integer
54330         format: int64
54331         description: Prefix length, 32 for single address
54332       vlan-id-inner:
54333         type: integer
54334         format: int64
54335         description: Inner VLAN tag
54336       vlan-id-outer:
54337         type: integer
54338         format: int64
54339         description: Outer VLAN tag
54340       is-floating:
54341         type: boolean
54342         description: Indicator of fixed or floating address
54343   vip-ipv6-address-list:
54344     description: |
54345       IPv6 Address Range
54346       ###### Related Nodes
54347       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
54348       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
54349       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
54350       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
54351
54352     required:
54353     - vip-ipv6-address
54354     properties:
54355       vip-ipv6-address:
54356         type: string
54357         description: IP address
54358       vip-ipv6-prefix-length:
54359         type: integer
54360         format: int64
54361         description: Prefix length, 128 for single address
54362       vlan-id-inner:
54363         type: integer
54364         format: int64
54365         description: Inner VLAN tag
54366       vlan-id-outer:
54367         type: integer
54368         format: int64
54369         description: Outer VLAN tag
54370       is-floating:
54371         type: boolean
54372         description: Indicator of fixed or floating address
54373   virtual-data-center:
54374     description: |
54375       Virtual organization of cloud infrastructure elements in a data center context
54376       ###### Related Nodes
54377       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
54378       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
54379       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
54380
54381     required:
54382     - vdc-id
54383     - vdc-name
54384     properties:
54385       vdc-id:
54386         type: string
54387         description: Unique ID of the vdc
54388       vdc-name:
54389         type: string
54390         description: Name of the virtual data center
54391   virtual-data-centers:
54392     description: |
54393       Virtual organization of cloud infrastructure elements in a data center context
54394     properties:
54395       virtual-data-center:
54396         type: array
54397         items:
54398           $ref: "#/patchDefinitions/virtual-data-center"
54399   vlan:
54400     description: |
54401       Definition of vlan
54402       ###### Related Nodes
54403       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
54404       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
54405       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
54406       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
54407       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
54408       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
54409       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
54410
54411       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
54412       -(2) IF this VLAN node is deleted, this TO node is DELETED also
54413       -(4) IF this TO node is deleted, this VLAN is DELETED also
54414     required:
54415     - vlan-interface
54416     - in-maint
54417     - is-ip-unnumbered
54418     properties:
54419       vlan-interface:
54420         type: string
54421         description: String that identifies the interface
54422       vlan-id-inner:
54423         type: integer
54424         format: int64
54425         description: Inner VLAN tag
54426       vlan-id-outer:
54427         type: integer
54428         format: int64
54429         description: Outer VLAN tag
54430   vlans:
54431     properties:
54432       vlan:
54433         type: array
54434         items:
54435           $ref: "#/patchDefinitions/vlan"
54436   vnf:
54437     description: |
54438       Abstract vnf class
54439     required:
54440     - vnf-id
54441     properties:
54442       vnf-id:
54443         type: string
54444         description: Unique id of VNF.  This is unique across the graph.
54445   vnf-image:
54446     description: |
54447       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
54448       ###### Related Nodes
54449       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
54450
54451       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
54452
54453     required:
54454     - vnf-image-uuid
54455     - application
54456     - application-vendor
54457     properties:
54458       vnf-image-uuid:
54459         type: string
54460         description: Unique ID of this asset
54461       application:
54462         type: string
54463         description: The application that the image instantiates.
54464       application-vendor:
54465         type: string
54466         description: The vendor of the application.
54467       application-version:
54468         type: string
54469         description: The version of the application.
54470       selflink:
54471         type: string
54472         description: URL to endpoint where AAI can get more details
54473   vnf-images:
54474     description: |
54475       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
54476     properties:
54477       vnf-image:
54478         type: array
54479         items:
54480           $ref: "#/patchDefinitions/vnf-image"
54481   vnfc:
54482     description: |
54483       ###### Related Nodes
54484       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
54485       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
54486       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
54487       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
54488       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
54489       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
54490       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
54491       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
54492
54493       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
54494       -(4) IF this TO node is deleted, this VNFC is DELETED also
54495     required:
54496     - vnfc-name
54497     - nfc-naming-code
54498     - nfc-function
54499     - in-maint
54500     - is-closed-loop-disabled
54501     properties:
54502       vnfc-name:
54503         type: string
54504         description: Unique ID of vnfc.
54505       nfc-naming-code:
54506         type: string
54507         description: Short code that is used in naming instances of the item being modeled
54508       nfc-function:
54509         type: string
54510         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
54511       prov-status:
54512         type: string
54513         description: prov status of this vnfc
54514       orchestration-status:
54515         type: string
54516         description: Orchestration status of this VNF, mastered by APP-C
54517       ipaddress-v4-oam-vip:
54518         type: string
54519         description: Oam V4 vip address of this vnfc
54520       in-maint:
54521         type: boolean
54522         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
54523       is-closed-loop-disabled:
54524         type: boolean
54525         description: used to indicate whether closed loop function is enabled on this node
54526       group-notation:
54527         type: string
54528         description: Group notation of VNFC
54529       model-invariant-id:
54530         type: string
54531         description: the ASDC model id for this resource or service model.
54532       model-version-id:
54533         type: string
54534         description: the ASDC model version for this resource or service model.
54535   vnfcs:
54536     description: |
54537       virtual network components associated with a vserver from application controller.
54538     properties:
54539       vnfc:
54540         type: array
54541         items:
54542           $ref: "#/patchDefinitions/vnfc"
54543   volume:
54544     description: |
54545       Ephemeral Block storage volume.
54546       ###### Related Nodes
54547       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
54548
54549       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
54550     required:
54551     - volume-id
54552     - volume-selflink
54553     properties:
54554       volume-id:
54555         type: string
54556         description: Unique ID of block storage volume relative to the vserver.
54557       volume-selflink:
54558         type: string
54559         description: URL to endpoint where AAI can get more details
54560   volume-group:
54561     description: |
54562       Persistent block-level storage.
54563       ###### Related Nodes
54564       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
54565       - TO complex( volume-group LocatedIn complex, MANY2ONE)
54566       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
54567       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
54568       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
54569
54570     required:
54571     - volume-group-id
54572     - volume-group-name
54573     - vnf-type
54574     properties:
54575       volume-group-id:
54576         type: string
54577         description: Unique ID of volume-group.
54578       volume-group-name:
54579         type: string
54580         description: Name of the volume group.
54581       heat-stack-id:
54582         type: string
54583         description: Heat stack id corresponding to this volume-group
54584       vnf-type:
54585         type: string
54586         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.
54587       orchestration-status:
54588         type: string
54589         description: Orchestration status of this volume-group
54590       model-customization-id:
54591         type: string
54592         description: captures the id of all the configuration used to customize the resource for the service.
54593       vf-module-model-customization-id:
54594         type: string
54595         description: helps relate the volume group to the vf-module whose components will require the volume group
54596   volume-groups:
54597     description: |
54598       Collection of persistent block-level storage.
54599     properties:
54600       volume-group:
54601         type: array
54602         items:
54603           $ref: "#/patchDefinitions/volume-group"
54604   volumes:
54605     description: |
54606       Collection of ephemeral Block storage volumes.
54607     properties:
54608       volume:
54609         type: array
54610         items:
54611           $ref: "#/patchDefinitions/volume"
54612   vpls-pe:
54613     description: |
54614       VPLS Provider Edge routers.
54615       ###### Related Nodes
54616       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
54617       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
54618       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
54619       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
54620
54621       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
54622     required:
54623     - equipment-name
54624     properties:
54625       equipment-name:
54626         type: string
54627       prov-status:
54628         type: string
54629         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54630       ipv4-oam-address:
54631         type: string
54632         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).
54633       equipment-role:
54634         type: string
54635         description: Client should send valid enumerated value, e.g., VPLS-PE.
54636       vlan-id-outer:
54637         type: integer
54638         format: int64
54639         description: Temporary location for stag to get to VCE
54640   vpls-pes:
54641     description: |
54642       Collection of VPLS Provider Edge routers
54643     properties:
54644       vpls-pe:
54645         type: array
54646         items:
54647           $ref: "#/patchDefinitions/vpls-pe"
54648   vpn-binding:
54649     description: |
54650       VPN binding
54651       ###### Related Nodes
54652       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
54653       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
54654       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
54655       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
54656
54657       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
54658       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
54659
54660     required:
54661     - vpn-id
54662     - vpn-name
54663     properties:
54664       vpn-id:
54665         type: string
54666         description: VPN ID, globally unique within A&AI
54667       vpn-name:
54668         type: string
54669         description: VPN Name
54670       vpn-platform:
54671         type: string
54672         description: the platform associated with the VPN example AVPN, Mobility
54673       vpn-type:
54674         type: string
54675         description: Type of the vpn, should be taken from enumerated/valid values
54676       vpn-region:
54677         type: string
54678         description: region of customer vpn
54679       customer-vpn-id:
54680         type: string
54681         description: id for this customer vpn
54682       route-distinguisher:
54683         type: string
54684         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
54685   vpn-bindings:
54686     properties:
54687       vpn-binding:
54688         type: array
54689         items:
54690           $ref: "#/patchDefinitions/vpn-binding"
54691   vserver:
54692     description: |
54693       Virtual Servers, aka virtual machine or VM.
54694       ###### Related Nodes
54695       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
54696       - TO flavor( vserver Uses flavor, MANY2ONE)
54697       - TO image( vserver Uses image, MANY2ONE)
54698       - TO pserver( vserver HostedOn pserver, MANY2ONE)
54699       - TO snapshot( vserver Uses snapshot, ONE2ONE)
54700       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
54701       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
54702       - FROM vce( vce HostedOn vserver, ONE2MANY)
54703       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
54704       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
54705       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
54706
54707       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
54708       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
54709     required:
54710     - vserver-id
54711     - vserver-name
54712     - vserver-selflink
54713     - in-maint
54714     - is-closed-loop-disabled
54715     properties:
54716       vserver-id:
54717         type: string
54718         description: Unique identifier for this vserver relative to its tenant
54719       vserver-name:
54720         type: string
54721         description: Name of vserver
54722       vserver-name2:
54723         type: string
54724         description: Alternative name of vserver
54725       prov-status:
54726         type: string
54727         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54728       vserver-selflink:
54729         type: string
54730         description: URL to endpoint where AAI can get more details
54731       in-maint:
54732         type: boolean
54733         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.
54734       is-closed-loop-disabled:
54735         type: boolean
54736         description: Used to indicate whether closed loop function is enabled on this node
54737   vservers:
54738     description: |
54739       Collection of virtual Servers, aka virtual machines or VMs.
54740     properties:
54741       vserver:
54742         type: array
54743         items:
54744           $ref: "#/patchDefinitions/vserver"
54745   zone:
54746     description: |
54747       A zone is a grouping of assets in a location homing to the same connections into the CBB
54748       ###### Related Nodes
54749       - TO complex( zone LocatedIn complex, MANY2ONE)
54750       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
54751       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
54752       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
54753       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
54754
54755     required:
54756     - zone-id
54757     - zone-name
54758     - design-type
54759     - zone-context
54760     properties:
54761       zone-id:
54762         type: string
54763         description: Code assigned by AIC to the zone
54764       zone-name:
54765         type: string
54766         description: English name associated with the zone
54767       design-type:
54768         type: string
54769         description: Design of zone [Medium/Large?]
54770       zone-context:
54771         type: string
54772         description: Context of zone [production/test]
54773       status:
54774         type: string
54775         description: Status of a zone.
54776   zones:
54777     description: |
54778       Collection of zones
54779     properties:
54780       zone:
54781         type: array
54782         items:
54783           $ref: "#/patchDefinitions/zone"
54784 getDefinitions:
54785   action:
54786     properties:
54787       action-type:
54788         type: string
54789       action-data:
54790         type: array
54791         items:
54792           $ref: "#/getDefinitions/action-data"
54793   action-data:
54794     properties:
54795       property-name:
54796         type: string
54797       property-value:
54798         type: string
54799   actions:
54800     description: |
54801       APIs that are more action related than REST (e.g., notify, update).
54802     properties:
54803       update:
54804         type: object
54805         $ref: "#/getDefinitions/update"
54806       notify:
54807         type: object
54808         $ref: "#/getDefinitions/notify"
54809   allotted-resource:
54810     description: |
54811       Represents a slice or partial piece of a resource that gets separately allotted
54812       ###### Related Nodes
54813       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
54814       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
54815       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
54816       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
54817       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
54818       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
54819       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
54820       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
54821       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
54822       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
54823       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
54824       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
54825       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
54826
54827       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
54828       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
54829       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
54830     required:
54831     - id
54832     properties:
54833       id:
54834         type: string
54835         description: Allotted Resource id UUID assigned to this instance.
54836       description:
54837         type: string
54838         description: The descriptive information assigned to this allotted resource instance
54839       selflink:
54840         type: string
54841         description: Link back to more information in the controller
54842       model-invariant-id:
54843         type: string
54844         description: the ASDC model id for this resource or service model.
54845       model-version-id:
54846         type: string
54847         description: the ASDC model version for this resource or service model.
54848       persona-model-version:
54849         type: string
54850         description: the ASDC model version for this resource or service model.
54851       resource-version:
54852         type: string
54853         description: Concurrency value
54854       orchestration-status:
54855         type: string
54856         description: Orchestration status
54857       operational-status:
54858         type: string
54859         description: Indicator for whether the resource is considered operational
54860       type:
54861         type: string
54862         description: Generic description of the type of allotted resource.
54863       role:
54864         type: string
54865         description: role in the network that this resource will be providing.
54866       tunnel-xconnects:
54867         type: array
54868         items:
54869           $ref: "#/getDefinitions/tunnel-xconnect"
54870       relationship-list:
54871         type: array
54872         items:
54873           $ref: "#/getDefinitions/relationship"
54874   allotted-resources:
54875     description: |
54876       This object is used to store slices of services being offered
54877     properties:
54878       allotted-resource:
54879         type: array
54880         items:
54881           $ref: "#/getDefinitions/allotted-resource"
54882   availability-zone:
54883     description: |
54884       Availability zone, a collection of compute hosts/pservers
54885       ###### Related Nodes
54886       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
54887       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
54888       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
54889       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
54890       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
54891       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
54892       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
54893       - FROM vce( vce Uses availability-zone, MANY2MANY)
54894
54895       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
54896       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
54897
54898     required:
54899     - availability-zone-name
54900     - hypervisor-type
54901     properties:
54902       availability-zone-name:
54903         type: string
54904         description: Name of the availability zone.  Unique across a cloud region
54905       hypervisor-type:
54906         type: string
54907         description: Type of hypervisor.  Source of truth should define valid values.
54908       operational-status:
54909         type: string
54910         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
54911       resource-version:
54912         type: string
54913         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54914       relationship-list:
54915         type: array
54916         items:
54917           $ref: "#/getDefinitions/relationship"
54918   availability-zones:
54919     description: |
54920       Collection of availability zones
54921     properties:
54922       availability-zone:
54923         type: array
54924         items:
54925           $ref: "#/getDefinitions/availability-zone"
54926   az-and-dvs-switches:
54927     properties:
54928       dvs-switches:
54929         type: object
54930         $ref: "#/getDefinitions/dvs-switches"
54931       availability-zone:
54932         type: object
54933         $ref: "#/getDefinitions/availability-zone"
54934   business:
54935     description: |
54936       Namespace for business related constructs
54937     properties:
54938       connectors:
54939         type: array
54940         items:
54941           $ref: "#/getDefinitions/connector"
54942       customers:
54943         type: array
54944         items:
54945           $ref: "#/getDefinitions/customer"
54946       lines-of-business:
54947         type: array
54948         items:
54949           $ref: "#/getDefinitions/line-of-business"
54950       owning-entities:
54951         type: array
54952         items:
54953           $ref: "#/getDefinitions/owning-entity"
54954       platforms:
54955         type: array
54956         items:
54957           $ref: "#/getDefinitions/platform"
54958       projects:
54959         type: array
54960         items:
54961           $ref: "#/getDefinitions/project"
54962   class-of-service:
54963     description: |
54964       ###### Related Nodes
54965       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
54966
54967       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
54968     required:
54969     - cos
54970     properties:
54971       cos:
54972         type: string
54973         description: unique identifier of probe
54974       probe-id:
54975         type: string
54976         description: identifier of probe
54977       probe-type:
54978         type: string
54979         description: type of probe
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   classes-of-service:
54988     description: |
54989       class-of-service of probe
54990     properties:
54991       class-of-service:
54992         type: array
54993         items:
54994           $ref: "#/getDefinitions/class-of-service"
54995   cloud-infrastructure:
54996     description: |
54997       Namespace for cloud infrastructure.
54998     properties:
54999       complexes:
55000         type: array
55001         items:
55002           $ref: "#/getDefinitions/complex"
55003       cloud-regions:
55004         type: array
55005         items:
55006           $ref: "#/getDefinitions/cloud-region"
55007       network-profiles:
55008         type: array
55009         items:
55010           $ref: "#/getDefinitions/network-profile"
55011       pservers:
55012         type: array
55013         items:
55014           $ref: "#/getDefinitions/pserver"
55015       virtual-data-centers:
55016         type: array
55017         items:
55018           $ref: "#/getDefinitions/virtual-data-center"
55019   cloud-region:
55020     description: |
55021       cloud-region designates an installation of a cloud cluster or region or instantiation.
55022       ###### Related Nodes
55023       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
55024       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
55025       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
55026       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
55027       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
55028       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
55029       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
55030       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
55031       - FROM image( image BelongsTo cloud-region, MANY2ONE)
55032       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
55033       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
55034       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
55035       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55036       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55037       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
55038       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
55039       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
55040
55041       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
55042       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
55043
55044     required:
55045     - cloud-owner
55046     - cloud-region-id
55047     - sriov-automation
55048     properties:
55049       cloud-owner:
55050         type: string
55051         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
55052       cloud-region-id:
55053         type: string
55054         description: Identifier used by the vendor for the region. Second part of composite key
55055       cloud-type:
55056         type: string
55057         description: Type of the cloud (e.g., openstack)
55058       owner-defined-type:
55059         type: string
55060         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
55061       cloud-region-version:
55062         type: string
55063         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
55064       identity-url:
55065         type: string
55066         description: URL of the keystone identity service
55067       cloud-zone:
55068         type: string
55069         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
55070       complex-name:
55071         type: string
55072         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
55073       sriov-automation:
55074         type: boolean
55075         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
55076       cloud-extra-info:
55077         type: string
55078         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
55079       cloud-epa-caps:
55080         type: string
55081         description: MultiVIM will discover and expose EPA capabilities.
55082       resource-version:
55083         type: string
55084         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55085       volume-groups:
55086         type: array
55087         items:
55088           $ref: "#/getDefinitions/volume-group"
55089       tenants:
55090         type: array
55091         items:
55092           $ref: "#/getDefinitions/tenant"
55093       flavors:
55094         type: array
55095         items:
55096           $ref: "#/getDefinitions/flavor"
55097       group-assignments:
55098         type: array
55099         items:
55100           $ref: "#/getDefinitions/group-assignment"
55101       snapshots:
55102         type: array
55103         items:
55104           $ref: "#/getDefinitions/snapshot"
55105       images:
55106         type: array
55107         items:
55108           $ref: "#/getDefinitions/image"
55109       dvs-switches:
55110         type: array
55111         items:
55112           $ref: "#/getDefinitions/dvs-switch"
55113       oam-networks:
55114         type: array
55115         items:
55116           $ref: "#/getDefinitions/oam-network"
55117       availability-zones:
55118         type: array
55119         items:
55120           $ref: "#/getDefinitions/availability-zone"
55121       relationship-list:
55122         type: array
55123         items:
55124           $ref: "#/getDefinitions/relationship"
55125       esr-system-info-list:
55126         type: array
55127         items:
55128           $ref: "#/getDefinitions/esr-system-info"
55129       vip-ipv4-address-list:
55130         type: array
55131         items:
55132           $ref: "#/getDefinitions/vip-ipv4-address-list"
55133       vip-ipv6-address-list:
55134         type: array
55135         items:
55136           $ref: "#/getDefinitions/vip-ipv6-address-list"
55137   cloud-regions:
55138     properties:
55139       cloud-region:
55140         type: array
55141         items:
55142           $ref: "#/getDefinitions/cloud-region"
55143   complex:
55144     description: |
55145       Collection of physical locations that can house cloud-regions.
55146       ###### Related Nodes
55147       - TO l3-network( complex Uses l3-network, MANY2MANY)
55148       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
55149       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
55150       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
55151       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
55152       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
55153       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
55154       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
55155       - FROM vce( vce LocatedIn complex, MANY2MANY)
55156       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
55157       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
55158       - FROM zone( zone LocatedIn complex, MANY2ONE)
55159
55160       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
55161       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
55162
55163     required:
55164     - physical-location-id
55165     - physical-location-type
55166     - street1
55167     - city
55168     - postal-code
55169     - country
55170     - region
55171     properties:
55172       physical-location-id:
55173         type: string
55174         description: Unique identifier for physical location, e.g., CLLI
55175       data-center-code:
55176         type: string
55177         description: Data center code which can be an alternate way to identify a complex
55178       complex-name:
55179         type: string
55180         description: Gamma complex name for LCP instance.
55181       identity-url:
55182         type: string
55183         description: URL of the keystone identity service
55184       resource-version:
55185         type: string
55186         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55187       physical-location-type:
55188         type: string
55189         description: Type, e.g., central office, data center.
55190       street1:
55191         type: string
55192       street2:
55193         type: string
55194       city:
55195         type: string
55196       state:
55197         type: string
55198       postal-code:
55199         type: string
55200       country:
55201         type: string
55202       region:
55203         type: string
55204       latitude:
55205         type: string
55206       longitude:
55207         type: string
55208       elevation:
55209         type: string
55210       lata:
55211         type: string
55212       ctag-pools:
55213         type: array
55214         items:
55215           $ref: "#/getDefinitions/ctag-pool"
55216       relationship-list:
55217         type: array
55218         items:
55219           $ref: "#/getDefinitions/relationship"
55220   complexes:
55221     description: |
55222       Collection of physical locations that can house cloud-regions.
55223     properties:
55224       complex:
55225         type: array
55226         items:
55227           $ref: "#/getDefinitions/complex"
55228   configuration:
55229     description: |
55230       Port Mirror Configuration.
55231       ###### Related Nodes
55232       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
55233       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
55234       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
55235       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
55236       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
55237
55238       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
55239       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
55240       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
55241     required:
55242     - configuration-id
55243     - configuration-type
55244     - configuration-sub-type
55245     - orchestration-status
55246     - operational-status
55247     - configuration-selflink
55248     - model-customization-id
55249     properties:
55250       configuration-id:
55251         type: string
55252         description: UUID assigned to configuration.
55253       management-option:
55254         type: string
55255         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
55256       configuration-name:
55257         type: string
55258         description: Name of the configuration.
55259       configuration-type:
55260         type: string
55261         description: port-mirroring-configuration.
55262       configuration-sub-type:
55263         type: string
55264         description: vprobe, pprobe.
55265       model-invariant-id:
55266         type: string
55267         description: the ASDC model id for this resource or service model.
55268       model-version-id:
55269         type: string
55270         description: the ASDC model version for this resource or service model.
55271       orchestration-status:
55272         type: string
55273         description: Orchestration status of the configuration.
55274       operational-status:
55275         type: string
55276         description: Indicator for whether the resource is considered operational.
55277       configuration-selflink:
55278         type: string
55279         description: URL to endpoint where AAI can get more details from SDN-GC.
55280       model-customization-id:
55281         type: string
55282         description: id of  the configuration used to customize the resource
55283       resource-version:
55284         type: string
55285         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55286       relationship-list:
55287         type: array
55288         items:
55289           $ref: "#/getDefinitions/relationship"
55290       metadata:
55291         type: array
55292         items:
55293           $ref: "#/getDefinitions/metadatum"
55294   configurations:
55295     description: |
55296       Collection of configurations
55297     properties:
55298       configuration:
55299         type: array
55300         items:
55301           $ref: "#/getDefinitions/configuration"
55302   connector:
55303     description: |
55304       Collection of resource instances used to connect a variety of disparate inventory widgets
55305       ###### Related Nodes
55306       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
55307       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
55308       - FROM service-instance( service-instance Uses connector, MANY2MANY)
55309
55310       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
55311     required:
55312     - resource-instance-id
55313     properties:
55314       resource-instance-id:
55315         type: string
55316         description: Unique id of resource instance.
55317       resource-version:
55318         type: string
55319         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55320       model-invariant-id:
55321         type: string
55322         description: the ASDC model id for this resource or service model.
55323       model-version-id:
55324         type: string
55325         description: the ASDC model version for this resource or service model.
55326       persona-model-version:
55327         type: string
55328         description: the ASDC model version for this resource or service model.
55329       widget-model-id:
55330         type: string
55331         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55332       widget-model-version:
55333         type: string
55334         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55335       relationship-list:
55336         type: array
55337         items:
55338           $ref: "#/getDefinitions/relationship"
55339       metadata:
55340         type: array
55341         items:
55342           $ref: "#/getDefinitions/metadatum"
55343   connectors:
55344     description: |
55345       Collection of resource instances used to connect a variety of disparate inventory widgets
55346     properties:
55347       connector:
55348         type: array
55349         items:
55350           $ref: "#/getDefinitions/connector"
55351   constrained-element-set:
55352     description: |
55353       This is how we would capture constraints defining allowed sets of elements.
55354       ###### Related Nodes
55355       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
55356       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
55357       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
55358
55359       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
55360       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
55361     required:
55362     - constrained-element-set-uuid
55363     - constraint-type
55364     - check-type
55365     properties:
55366       constrained-element-set-uuid:
55367         type: string
55368       constraint-type:
55369         type: string
55370       check-type:
55371         type: string
55372       resource-version:
55373         type: string
55374       element-choice-sets:
55375         type: array
55376         items:
55377           $ref: "#/getDefinitions/element-choice-set"
55378       relationship-list:
55379         type: array
55380         items:
55381           $ref: "#/getDefinitions/relationship"
55382   constrained-element-sets:
55383     properties:
55384       constrained-element-set:
55385         type: array
55386         items:
55387           $ref: "#/getDefinitions/constrained-element-set"
55388   ctag-assignment:
55389     description: |
55390       ###### Related Nodes
55391       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
55392       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
55393
55394       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
55395     required:
55396     - vlan-id-inner
55397     properties:
55398       vlan-id-inner:
55399         type: integer
55400         format: int64
55401         description: id.
55402       resource-version:
55403         type: string
55404         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55405       relationship-list:
55406         type: array
55407         items:
55408           $ref: "#/getDefinitions/relationship"
55409   ctag-assignments:
55410     properties:
55411       ctag-assignment:
55412         type: array
55413         items:
55414           $ref: "#/getDefinitions/ctag-assignment"
55415   ctag-pool:
55416     description: |
55417       A collection of C tags (vlan tags) grouped for a specific purpose.
55418       ###### Related Nodes
55419       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
55420       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
55421       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
55422       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
55423
55424       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
55425     required:
55426     - target-pe
55427     - availability-zone-name
55428     - ctag-pool-purpose
55429     properties:
55430       target-pe:
55431         type: string
55432         description: The Target provider edge router
55433       availability-zone-name:
55434         type: string
55435         description: Name of the availability zone
55436       ctag-pool-purpose:
55437         type: string
55438         description: Describes what the intended purpose of this pool is.
55439       ctag-values:
55440         type: string
55441         description: Comma separated list of ctags
55442       resource-version:
55443         type: string
55444         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55445       relationship-list:
55446         type: array
55447         items:
55448           $ref: "#/getDefinitions/relationship"
55449   ctag-pools:
55450     properties:
55451       ctag-pool:
55452         type: array
55453         items:
55454           $ref: "#/getDefinitions/ctag-pool"
55455   customer:
55456     description: |
55457       customer identifiers to provide linkage back to BSS information.
55458       ###### Related Nodes
55459       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
55460
55461       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
55462     required:
55463     - global-customer-id
55464     - subscriber-name
55465     - subscriber-type
55466     properties:
55467       global-customer-id:
55468         type: string
55469         description: Global customer id used across ECOMP to uniquely identify customer.
55470       subscriber-name:
55471         type: string
55472         description: Subscriber name, an alternate way to retrieve a customer.
55473       subscriber-type:
55474         type: string
55475         description: Subscriber type, a way to provide VID with only the INFRA customers.
55476       resource-version:
55477         type: string
55478         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55479       service-subscriptions:
55480         type: array
55481         items:
55482           $ref: "#/getDefinitions/service-subscription"
55483       relationship-list:
55484         type: array
55485         items:
55486           $ref: "#/getDefinitions/relationship"
55487   customers:
55488     description: |
55489       Collection of customer identifiers to provide linkage back to BSS information.
55490     properties:
55491       customer:
55492         type: array
55493         items:
55494           $ref: "#/getDefinitions/customer"
55495   cvlan-tag-entry:
55496     required:
55497     - cvlan-tag
55498     properties:
55499       cvlan-tag:
55500         type: integer
55501         format: int64
55502         description: See mis-na-virtualization-platform.yang
55503       resource-version:
55504         type: string
55505         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55506       relationship-list:
55507         type: array
55508         items:
55509           $ref: "#/getDefinitions/relationship"
55510   cvlan-tags:
55511     properties:
55512       cvlan-tag-entry:
55513         type: array
55514         items:
55515           $ref: "#/getDefinitions/cvlan-tag-entry"
55516   dvs-switch:
55517     description: |
55518       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.
55519       ###### Related Nodes
55520       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
55521       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
55522
55523     required:
55524     - switch-name
55525     - vcenter-url
55526     properties:
55527       switch-name:
55528         type: string
55529         description: DVS switch name
55530       vcenter-url:
55531         type: string
55532         description: URL used to reach the vcenter
55533       resource-version:
55534         type: string
55535         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55536       relationship-list:
55537         type: array
55538         items:
55539           $ref: "#/getDefinitions/relationship"
55540   dvs-switches:
55541     description: |
55542       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
55543     properties:
55544       dvs-switch:
55545         type: array
55546         items:
55547           $ref: "#/getDefinitions/dvs-switch"
55548   edge-prop-names:
55549     description: |
55550       Internal map to define the properties of an edge and interpret the map EdgeRules
55551     properties:
55552       edgeLabel:
55553         type: string
55554       direction:
55555         type: string
55556       multiplicityRule:
55557         type: string
55558       contains-other-v:
55559         type: string
55560       delete-other-v:
55561         type: string
55562       SVC-INFRA:
55563         type: string
55564       prevent-delete:
55565         type: string
55566   edge-tag-query-request:
55567     properties:
55568       edge-tag:
55569         type: string
55570       result-detail:
55571         type: string
55572       start-node-type:
55573         type: string
55574       start-node-filter:
55575         type: array
55576         items:
55577           $ref: "#/getDefinitions/start-node-filter"
55578       include-node-filter:
55579         type: array
55580         items:
55581           $ref: "#/getDefinitions/include-node-filter"
55582       secondary-filter:
55583         type: array
55584         items:
55585           $ref: "#/getDefinitions/secondary-filter"
55586   edge-tag-query-result:
55587     properties:
55588       tagged-inventory-item-list:
55589         type: array
55590         items:
55591           $ref: "#/getDefinitions/tagged-inventory-item-list"
55592   element-choice-set:
55593     description: |
55594       This is how we would capture constraints defining allowed sets of elements.
55595       ###### Related Nodes
55596       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
55597       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
55598
55599       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
55600       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
55601     required:
55602     - element-choice-set-uuid
55603     - element-choice-set-name
55604     properties:
55605       element-choice-set-uuid:
55606         type: string
55607       element-choice-set-name:
55608         type: string
55609       cardinality:
55610         type: string
55611       resource-version:
55612         type: string
55613       model-elements:
55614         type: array
55615         items:
55616           $ref: "#/getDefinitions/model-element"
55617       relationship-list:
55618         type: array
55619         items:
55620           $ref: "#/getDefinitions/relationship"
55621   element-choice-sets:
55622     properties:
55623       element-choice-set:
55624         type: array
55625         items:
55626           $ref: "#/getDefinitions/element-choice-set"
55627   entitlement:
55628     description: |
55629       Metadata for entitlement group.
55630       ###### Related Nodes
55631       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
55632       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
55633
55634       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
55635     required:
55636     - group-uuid
55637     - resource-uuid
55638     properties:
55639       group-uuid:
55640         type: string
55641         description: Unique ID for the entitlement group the resource comes from, should be uuid.
55642       resource-uuid:
55643         type: string
55644         description: Unique ID of an entitlement resource.
55645       resource-version:
55646         type: string
55647         description: Concurrency value
55648       relationship-list:
55649         type: array
55650         items:
55651           $ref: "#/getDefinitions/relationship"
55652   entitlements:
55653     description: |
55654       Entitlements, keyed by group-uuid and resource-uuid, related to license management
55655     properties:
55656       entitlement:
55657         type: array
55658         items:
55659           $ref: "#/getDefinitions/entitlement"
55660   esr-ems:
55661     description: |
55662       Persist EMS address information used by EMS driver.
55663       ###### Related Nodes
55664       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
55665
55666       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
55667     required:
55668     - ems-id
55669     properties:
55670       ems-id:
55671         type: string
55672         description: Unique ID of EMS.
55673       resource-version:
55674         type: string
55675         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55676       esr-system-info-list:
55677         type: object
55678         $ref: "#/getDefinitions/esr-system-info-list"
55679       relationship-list:
55680         type: object
55681         $ref: "#/getDefinitions/relationship-list"
55682   esr-ems-list:
55683     properties:
55684       esr-ems:
55685         type: array
55686         items:
55687           $ref: "#/getDefinitions/esr-ems"
55688   esr-system-info:
55689     description: |
55690       Persist common address information of external systems.
55691       ###### Related Nodes
55692       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
55693       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
55694       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
55695       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
55696
55697       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
55698     required:
55699     - esr-system-info-id
55700     - user-name
55701     - password
55702     - system-type
55703     properties:
55704       esr-system-info-id:
55705         type: string
55706         description: Unique ID of esr system info.
55707       system-name:
55708         type: string
55709         description: name of external system.
55710       type:
55711         type: string
55712         description: type of external systems.
55713       vendor:
55714         type: string
55715         description: vendor of external systems.
55716       version:
55717         type: string
55718         description: version of external systems.
55719       service-url:
55720         type: string
55721         description: url used to access external systems.
55722       user-name:
55723         type: string
55724         description: username used to access external systems.
55725       password:
55726         type: string
55727         description: password used to access external systems.
55728       system-type:
55729         type: string
55730         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
55731       protocol:
55732         type: string
55733         description: protocol of third party SDNC, for example netconf/snmp.
55734       ssl-cacert:
55735         type: string
55736         description: ca file content if enabled ssl on auth-url.
55737       ssl-insecure:
55738         type: boolean
55739         description: Whether to verify VIM's certificate.
55740       ip-address:
55741         type: string
55742         description: service IP of ftp server.
55743       port:
55744         type: string
55745         description: service port of ftp server.
55746       cloud-domain:
55747         type: string
55748         description: domain info for authentication.
55749       default-tenant:
55750         type: string
55751         description: default tenant of VIM.
55752       passive:
55753         type: boolean
55754         description: ftp passive mode or not.
55755       remote-path:
55756         type: string
55757         description: resource or performance data file path.
55758       system-status:
55759         type: string
55760         description: the status of external system.
55761       resource-version:
55762         type: string
55763         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55764       relationship-list:
55765         type: array
55766         items:
55767           $ref: "#/getDefinitions/relationship"
55768   esr-system-info-list:
55769     description: |
55770       Collection of persistent block-level external system auth info.
55771     properties:
55772       esr-system-info:
55773         type: array
55774         items:
55775           $ref: "#/getDefinitions/esr-system-info"
55776   esr-thirdparty-sdnc:
55777     description: |
55778       Persist SDNC address information used by ONAP SDNC.
55779       ###### Related Nodes
55780       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
55781       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
55782
55783       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
55784     required:
55785     - thirdparty-sdnc-id
55786     properties:
55787       thirdparty-sdnc-id:
55788         type: string
55789         description: Unique ID of SDNC.
55790       location:
55791         type: string
55792         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
55793       product-name:
55794         type: string
55795         description: password used to access SDNC server.
55796       resource-version:
55797         type: string
55798         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55799       esr-system-info-list:
55800         type: object
55801         $ref: "#/getDefinitions/esr-system-info-list"
55802       relationship-list:
55803         type: object
55804         $ref: "#/getDefinitions/relationship-list"
55805   esr-thirdparty-sdnc-list:
55806     properties:
55807       esr-thirdparty-sdnc:
55808         type: array
55809         items:
55810           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
55811   esr-vnfm:
55812     description: |
55813       Persist VNFM address information used by VF-C.
55814       ###### Related Nodes
55815       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
55816
55817       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
55818     required:
55819     - vnfm-id
55820     properties:
55821       vnfm-id:
55822         type: string
55823         description: Unique ID of VNFM.
55824       vim-id:
55825         type: string
55826         description: indecate the VIM to deploy VNF.
55827       certificate-url:
55828         type: string
55829         description: certificate url of VNFM.
55830       resource-version:
55831         type: string
55832         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55833       esr-system-info-list:
55834         type: object
55835         $ref: "#/getDefinitions/esr-system-info-list"
55836       relationship-list:
55837         type: object
55838         $ref: "#/getDefinitions/relationship-list"
55839   esr-vnfm-list:
55840     properties:
55841       esr-vnfm:
55842         type: array
55843         items:
55844           $ref: "#/getDefinitions/esr-vnfm"
55845   evc:
55846     description: |
55847       evc object is an optional child object of the Configuration object.
55848       ###### Related Nodes
55849       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
55850
55851       -(4) IF this TO node is deleted, this EVC is DELETED also
55852     required:
55853     - evc-id
55854     properties:
55855       evc-id:
55856         type: string
55857         description: Unique/key field for the evc object
55858       forwarding-path-topology:
55859         type: string
55860         description: Point-to-Point, Multi-Point
55861       cir-value:
55862         type: string
55863         description: Commited Information Rate
55864       cir-units:
55865         type: string
55866         description: CIR units
55867       connection-diversity-group-id:
55868         type: string
55869         description: Diversity Group ID
55870       service-hours:
55871         type: string
55872         description: formerly Performance Group
55873       esp-evc-circuit-id:
55874         type: string
55875         description: EVC Circuit ID of ESP EVC
55876       esp-evc-cir-value:
55877         type: string
55878         description: Committed Information Rate (For ESP)
55879       esp-evc-cir-units:
55880         type: string
55881         description: CIR units (For ESP)
55882       esp-itu-code:
55883         type: string
55884         description: Identifies ESP
55885       collector-pop-clli:
55886         type: string
55887         description: Collector POP CLLI (from the hostname of the access pnf)
55888       inter-connect-type-ingress:
55889         type: string
55890         description: Interconnect type on ingress side of EVC.
55891       tagmode-access-ingress:
55892         type: string
55893         description: tagode for collector side of EVC
55894       tagmode-access-egress:
55895         type: string
55896         description: tagMode for network side of EVC
55897       relationship-list:
55898         type: array
55899         items:
55900           $ref: "#/getDefinitions/relationship"
55901       resource-version:
55902         type: string
55903         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55904   evcs:
55905     properties:
55906       evc:
55907         type: array
55908         items:
55909           $ref: "#/getDefinitions/evc"
55910   external-system:
55911     description: |
55912       Namespace for external system.
55913     properties:
55914       esr-ems-list:
55915         type: object
55916         $ref: "#/getDefinitions/esr-ems-list"
55917       esr-vnfm-list:
55918         type: object
55919         $ref: "#/getDefinitions/esr-vnfm-list"
55920       esr-thirdparty-sdnc-list:
55921         type: object
55922         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
55923   extra-properties:
55924     description: |
55925       Extra properties for inventory item for response list
55926     properties:
55927       extra-property:
55928         type: array
55929         items:
55930           $ref: "#/getDefinitions/extra-property"
55931   extra-property:
55932     properties:
55933       property-name:
55934         type: string
55935       property-value:
55936         type: string
55937   flavor:
55938     description: |
55939       Openstack flavor.
55940       ###### Related Nodes
55941       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
55942       - FROM vserver( vserver Uses flavor, MANY2ONE)
55943
55944       -FLAVOR cannot be deleted if related to VSERVER
55945
55946     required:
55947     - flavor-id
55948     - flavor-name
55949     - flavor-selflink
55950     properties:
55951       flavor-id:
55952         type: string
55953         description: Flavor id, expected to be unique across cloud-region.
55954       flavor-name:
55955         type: string
55956         description: Flavor name
55957       flavor-vcpus:
55958         type: integer
55959         format: int32
55960         description: Number of CPUs
55961       flavor-ram:
55962         type: integer
55963         format: int32
55964         description: Amount of memory
55965       flavor-disk:
55966         type: integer
55967         format: int32
55968         description: Disk space
55969       flavor-ephemeral:
55970         type: integer
55971         format: int32
55972         description: Amount of ephemeral disk space
55973       flavor-swap:
55974         type: string
55975         description: amount of swap space allocation
55976       flavor-is-public:
55977         type: boolean
55978         description: whether flavor is available to all users or private to the tenant it was created in.
55979       flavor-selflink:
55980         type: string
55981         description: URL to endpoint where AAI can get more details
55982       flavor-disabled:
55983         type: boolean
55984         description: Boolean as to whether this flavor is no longer enabled
55985       resource-version:
55986         type: string
55987         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55988       relationship-list:
55989         type: array
55990         items:
55991           $ref: "#/getDefinitions/relationship"
55992   flavors:
55993     description: |
55994       Collection of openstack flavors.
55995     properties:
55996       flavor:
55997         type: array
55998         items:
55999           $ref: "#/getDefinitions/flavor"
56000   forwarder:
56001     description: |
56002       Entity describing a sequenced segment of forwarding path
56003       ###### Related Nodes
56004       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
56005       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
56006       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
56007       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
56008       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
56009
56010       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
56011       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
56012     required:
56013     - sequence
56014     properties:
56015       sequence:
56016         type: integer
56017         format: int32
56018         description: Unique ID of this segmentation
56019       forwarder-role:
56020         type: string
56021         description: ingress, intermediate, egress
56022       relationship-list:
56023         type: array
56024         items:
56025           $ref: "#/getDefinitions/relationship"
56026       resource-version:
56027         type: string
56028         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56029   forwarder-evc:
56030     description: |
56031       forwarder object is an optional child object of the Configuration object.
56032       ###### Related Nodes
56033       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
56034
56035       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
56036     required:
56037     - forwarder-evc-id
56038     properties:
56039       forwarder-evc-id:
56040         type: string
56041         description: Key for forwarder-evc object
56042       circuit-id:
56043         type: string
56044         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
56045       ivlan:
56046         type: string
56047         description: Internal VLAN.
56048       svlan:
56049         type: string
56050         description: SVLAN value for ingress of egress forwarder.
56051       cvlan:
56052         type: string
56053         description: CVLAN value for ingress of egress forwarder.
56054       relationship-list:
56055         type: array
56056         items:
56057           $ref: "#/getDefinitions/relationship"
56058       resource-version:
56059         type: string
56060         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56061   forwarder-evcs:
56062     properties:
56063       forwarder-evc:
56064         type: array
56065         items:
56066           $ref: "#/getDefinitions/forwarder-evc"
56067   forwarders:
56068     properties:
56069       forwarder:
56070         type: array
56071         items:
56072           $ref: "#/getDefinitions/forwarder"
56073   forwarding-path:
56074     description: |
56075       Entity that describes the sequenced forwarding path between interfaces of services or resources
56076       ###### Related Nodes
56077       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
56078       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
56079       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
56080
56081       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
56082       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
56083       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
56084     required:
56085     - forwarding-path-id
56086     - forwarding-path-name
56087     properties:
56088       forwarding-path-id:
56089         type: string
56090         description: Unique ID of this FP
56091       forwarding-path-name:
56092         type: string
56093         description: Name of the FP
56094       relationship-list:
56095         type: array
56096         items:
56097           $ref: "#/getDefinitions/relationship"
56098       resource-version:
56099         type: string
56100         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56101       selflink:
56102         type: string
56103         description: the self link for this FP
56104       forwarders:
56105         type: array
56106         items:
56107           $ref: "#/getDefinitions/forwarder"
56108   forwarding-paths:
56109     properties:
56110       forwarding-path:
56111         type: array
56112         items:
56113           $ref: "#/getDefinitions/forwarding-path"
56114   generic-vnf:
56115     description: |
56116       General purpose VNF
56117       ###### Related Nodes
56118       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
56119       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
56120       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
56121       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
56122       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
56123       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
56124       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
56125       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
56126       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
56127       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
56128       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
56129       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
56130       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
56131       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56132       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
56133       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
56134       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
56135       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
56136       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
56137       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
56138       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
56139       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
56140       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56141       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
56142       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
56143       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
56144       - FROM platform( platform Uses generic-vnf, MANY2MANY)
56145
56146       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
56147       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
56148     required:
56149     - vnf-id
56150     - vnf-name
56151     - vnf-type
56152     - in-maint
56153     - is-closed-loop-disabled
56154     properties:
56155       vnf-id:
56156         type: string
56157         description: Unique id of VNF.  This is unique across the graph.
56158       vnf-instance-id:
56159         type: string
56160         description: vnf instance id.
56161       vnf-name:
56162         type: string
56163         description: Name of VNF.
56164       vnf-name2:
56165         type: string
56166         description: Alternate name of VNF.
56167       vnf-type:
56168         type: string
56169         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.
56170       service-id:
56171         type: string
56172         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
56173       regional-resource-zone:
56174         type: string
56175         description: Regional way of organizing pservers, source of truth should define values
56176       prov-status:
56177         type: string
56178         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56179       operational-status:
56180         type: string
56181         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
56182       license-key:
56183         type: string
56184         description: OBSOLETE -  do not use
56185       equipment-role:
56186         type: string
56187         description: Client should send valid enumerated value
56188       orchestration-status:
56189         type: string
56190         description: Orchestration status of this VNF, used by MSO.
56191       vnf-package-name:
56192         type: string
56193       vnf-discriptor-name:
56194         type: string
56195         description: vnf discriptor name
56196       job-id:
56197         type: string
56198         description: job id corresponding to vnf
56199       heat-stack-id:
56200         type: string
56201         description: Heat stack id corresponding to this instance, managed by MSO
56202       mso-catalog-key:
56203         type: string
56204         description: Corresponds to the SDN-C catalog id used to configure this VCE
56205       management-option:
56206         type: string
56207         description: identifier of managed by ATT or customer
56208       ipv4-oam-address:
56209         type: string
56210         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
56211       ipv4-loopback0-address:
56212         type: string
56213         description: v4 Loopback0 address
56214       nm-lan-v6-address:
56215         type: string
56216         description: v6 Loopback address
56217       management-v6-address:
56218         type: string
56219         description: v6 management address
56220       vcpu:
56221         type: integer
56222         format: int64
56223         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
56224       vcpu-units:
56225         type: string
56226         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
56227       vmemory:
56228         type: integer
56229         format: int64
56230         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
56231       vmemory-units:
56232         type: string
56233         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
56234       vdisk:
56235         type: integer
56236         format: int64
56237         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
56238       vdisk-units:
56239         type: string
56240         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
56241       nshd:
56242         type: integer
56243         format: int64
56244         description: number of associated SHD in vnf.
56245       nvm:
56246         type: integer
56247         format: int64
56248         description: number of vms in vnf.
56249       nnet:
56250         type: integer
56251         format: int64
56252         description: number of network in vnf.
56253       in-maint:
56254         type: boolean
56255         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.
56256       is-closed-loop-disabled:
56257         type: boolean
56258         description: used to indicate whether closed loop function is enabled on this node
56259       resource-version:
56260         type: string
56261         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56262       summary-status:
56263         type: string
56264         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
56265       encrypted-access-flag:
56266         type: boolean
56267         description: indicates whether generic-vnf access uses SSH
56268       entitlement-assignment-group-uuid:
56269         type: string
56270         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
56271       entitlement-resource-uuid:
56272         type: string
56273         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
56274       license-assignment-group-uuid:
56275         type: string
56276         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
56277       license-key-uuid:
56278         type: string
56279         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
56280       model-invariant-id:
56281         type: string
56282         description: the ASDC model id for this resource or service model.
56283       model-version-id:
56284         type: string
56285         description: the ASDC model version for this resource or service model.
56286       persona-model-version:
56287         type: string
56288         description: the ASDC model version for this resource or service model.
56289       model-customization-id:
56290         type: string
56291         description: captures the id of all the configuration used to customize the resource for the service.
56292       widget-model-id:
56293         type: string
56294         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56295       widget-model-version:
56296         type: string
56297         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56298       as-number:
56299         type: string
56300         description: as-number of the VNF
56301       regional-resource-subzone:
56302         type: string
56303         description: represents sub zone of the rr plane
56304       nf-type:
56305         type: string
56306         description: Generic description of the type of NF
56307       nf-function:
56308         type: string
56309         description: English description of Network function that the specific VNF deployment is providing
56310       nf-role:
56311         type: string
56312         description: role in the network that this model will be providing
56313       nf-naming-code:
56314         type: string
56315         description: string assigned to this model used for naming purposes
56316       selflink:
56317         type: string
56318         description: Path to the controller object.
56319       ipv4-oam-gateway-address:
56320         type: string
56321         description: Gateway address
56322       ipv4-oam-gateway-address-prefix-length:
56323         type: integer
56324         format: int32
56325         description: Prefix length for oam-address
56326       vlan-id-outer:
56327         type: integer
56328         format: int64
56329         description: Temporary location for S-TAG to get to VCE
56330       nm-profile-name:
56331         type: string
56332         description: Network Management profile of this VNF
56333       relationship-list:
56334         type: array
56335         items:
56336           $ref: "#/getDefinitions/relationship"
56337       l-interfaces:
56338         type: array
56339         items:
56340           $ref: "#/getDefinitions/l-interface"
56341       lag-interfaces:
56342         type: array
56343         items:
56344           $ref: "#/getDefinitions/lag-interface"
56345       vf-modules:
56346         type: array
56347         items:
56348           $ref: "#/getDefinitions/vf-module"
56349       licenses:
56350         type: array
56351         items:
56352           $ref: "#/getDefinitions/license"
56353       entitlements:
56354         type: array
56355         items:
56356           $ref: "#/getDefinitions/entitlement"
56357   generic-vnfs:
56358     description: |
56359       Collection of VNFs
56360     properties:
56361       generic-vnf:
56362         type: array
56363         items:
56364           $ref: "#/getDefinitions/generic-vnf"
56365   group-assignment:
56366     description: |
56367       Openstack group-assignment used to store exclusivity groups (EG).
56368       ###### Related Nodes
56369       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
56370       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
56371       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
56372
56373     required:
56374     - group-id
56375     - group-type
56376     - group-name
56377     properties:
56378       group-id:
56379         type: string
56380         description: Group id, expected to be unique across cloud-region.
56381       group-type:
56382         type: string
56383         description: Group type - the type of group this instance refers to
56384       group-name:
56385         type: string
56386         description: Group name - name assigned to the group
56387       group-description:
56388         type: string
56389         description: Group description - description of the group
56390       resource-version:
56391         type: string
56392         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56393       relationship-list:
56394         type: array
56395         items:
56396           $ref: "#/getDefinitions/relationship"
56397   group-assignments:
56398     description: |
56399       Collection of openstack group assignments
56400     properties:
56401       group-assignment:
56402         type: array
56403         items:
56404           $ref: "#/getDefinitions/group-assignment"
56405   host-route:
56406     description: |
56407       ###### Related Nodes
56408       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
56409
56410       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
56411     required:
56412     - host-route-id
56413     - route-prefix
56414     - next-hop
56415     properties:
56416       host-route-id:
56417         type: string
56418         description: host-route id
56419       route-prefix:
56420         type: string
56421         description: subnet prefix
56422       next-hop:
56423         type: string
56424         description: Could be ip-address, hostname, or service-instance
56425       next-hop-type:
56426         type: string
56427         description: Should be ip-address, hostname, or service-instance to match next-hop
56428       resource-version:
56429         type: string
56430         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56431       relationship-list:
56432         type: array
56433         items:
56434           $ref: "#/getDefinitions/relationship"
56435   host-routes:
56436     properties:
56437       host-route:
56438         type: array
56439         items:
56440           $ref: "#/getDefinitions/host-route"
56441   hpa-capabilities:
56442     description: |
56443       Collection of HPA Capabilities
56444     properties:
56445       hpa-capability:
56446         type: array
56447         items:
56448           $ref: "#/getDefinitions/hpa-capability"
56449   hpa-capability:
56450     description: |
56451       Represents a HPA capability
56452       ###### Related Nodes
56453       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
56454       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
56455       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
56456
56457       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
56458     required:
56459     - hpa-capability-id
56460     - hpa-feature
56461     properties:
56462       hpa-capability-id:
56463         type: string
56464         description: UUID to uniquely identify a HPA capability
56465       hpa-feature:
56466         type: string
56467         description: Name of the HPACapability
56468       hpa-version:
56469         type: string
56470         description: HPA schema version
56471       architecture:
56472         type: string
56473         description: Hardware architecture
56474       resource-version:
56475         type: string
56476         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56477       relationship-list:
56478         type: array
56479         items:
56480           $ref: "#/getDefinitions/relationship"
56481       hpa-feature-attributes:
56482         type: array
56483         items:
56484           $ref: "#/getDefinitions/hpa-feature-attributes"
56485   hpa-feature-attributes:
56486     description: |
56487       HPA Capability Feature attributes
56488       ###### Related Nodes
56489       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
56490
56491       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
56492     required:
56493     - hpa-attribute-key
56494     properties:
56495       hpa-attribute-key:
56496         type: string
56497         description: name of the specific HPA attribute
56498       hpa-attribute-value:
56499         type: string
56500         description: JSON string specifying the value, unit and type of the specific HPA attribute
56501       resource-version:
56502         type: string
56503         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56504       relationship-list:
56505         type: array
56506         items:
56507           $ref: "#/getDefinitions/relationship"
56508   image:
56509     description: |
56510       Openstack image.
56511       ###### Related Nodes
56512       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
56513       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
56514       - FROM vserver( vserver Uses image, MANY2ONE)
56515
56516       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
56517       -IMAGE cannot be deleted if related to VSERVER
56518
56519     required:
56520     - image-id
56521     - image-name
56522     - image-os-distro
56523     - image-os-version
56524     - image-selflink
56525     properties:
56526       image-id:
56527         type: string
56528         description: Image id, expected to be unique across cloud region
56529       image-name:
56530         type: string
56531         description: Image name
56532       image-architecture:
56533         type: string
56534         description: Operating system architecture.
56535       image-os-distro:
56536         type: string
56537         description: The common name of the operating system distribution in lowercase
56538       image-os-version:
56539         type: string
56540         description: The operating system version as specified by the distributor.
56541       application:
56542         type: string
56543         description: The application that the image instantiates.
56544       application-vendor:
56545         type: string
56546         description: The vendor of the application.
56547       application-version:
56548         type: string
56549         description: The version of the application.
56550       image-selflink:
56551         type: string
56552         description: URL to endpoint where AAI can get more details
56553       resource-version:
56554         type: string
56555         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56556       relationship-list:
56557         type: array
56558         items:
56559           $ref: "#/getDefinitions/relationship"
56560       metadata:
56561         type: array
56562         items:
56563           $ref: "#/getDefinitions/metadatum"
56564   images:
56565     description: |
56566       Collectio of Openstack images.
56567     properties:
56568       image:
56569         type: array
56570         items:
56571           $ref: "#/getDefinitions/image"
56572   include-node-filter:
56573     properties:
56574       include-node-type:
56575         type: string
56576   instance-filter:
56577     description: |
56578       InstanceFilter for performing a named-query or model query
56579   instance-filters:
56580     description: |
56581       InstanceFilters for performing a named-query or model query
56582     properties:
56583       instance-filter:
56584         type: array
56585         items:
56586           $ref: "#/getDefinitions/instance-filter"
56587   instance-group:
56588     description: |
56589       General mechanism for grouping instances
56590       ###### Related Nodes
56591       - TO model( instance-group Targets model, MANY2MANY)
56592       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
56593       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
56594       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
56595       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
56596       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
56597       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
56598       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
56599       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
56600       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56601       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56602       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
56603
56604     required:
56605     - id
56606     - description
56607     - type
56608     properties:
56609       instance-group-role:
56610         type: string
56611         description: role of the instance group.
56612       model-invariant-id:
56613         type: string
56614         description: ASDC model id for this resource or service model.
56615       model-version-id:
56616         type: string
56617         description: ASDC model version uid for this resource model.
56618       id:
56619         type: string
56620         description: Instance Group ID, UUID assigned to this instance.
56621       description:
56622         type: string
56623         description: Descriptive text to help identify the usage of this instance-group
56624       type:
56625         type: string
56626         description: Only valid value today is lower case ha for high availability
56627       sub-type:
56628         type: string
56629         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
56630       resource-version:
56631         type: string
56632         description: Concurrency value
56633       relationship-list:
56634         type: array
56635         items:
56636           $ref: "#/getDefinitions/relationship"
56637   instance-groups:
56638     description: |
56639       Collection of openstack route table references
56640     properties:
56641       instance-group:
56642         type: array
56643         items:
56644           $ref: "#/getDefinitions/instance-group"
56645   inventory:
56646     properties:
56647       search:
56648         type: object
56649         $ref: "#/getDefinitions/search"
56650       actions:
56651         type: object
56652         $ref: "#/getDefinitions/actions"
56653       cloud-infrastructure:
56654         type: object
56655         $ref: "#/getDefinitions/cloud-infrastructure"
56656       external-system:
56657         type: object
56658         $ref: "#/getDefinitions/external-system"
56659       business:
56660         type: object
56661         $ref: "#/getDefinitions/business"
56662       service-design-and-creation:
56663         type: object
56664         $ref: "#/getDefinitions/service-design-and-creation"
56665       network:
56666         type: object
56667         $ref: "#/getDefinitions/network"
56668       nodes:
56669         type: object
56670         $ref: "#/getDefinitions/nodes"
56671   inventory-item:
56672     properties:
56673       inventory-item-type:
56674         type: string
56675       inventory-item-link:
56676         type: string
56677       inventory-item-data:
56678         type: array
56679         items:
56680           $ref: "#/getDefinitions/inventory-item-data"
56681       tagged-inventory-item-list:
56682         type: array
56683         items:
56684           $ref: "#/getDefinitions/tagged-inventory-item-list"
56685   inventory-item-data:
56686     properties:
56687       property-name:
56688         type: string
56689       property-value:
56690         type: string
56691   inventory-response-item:
56692     description: |
56693       Inventory item for response list
56694     properties:
56695       model-name:
56696         type: string
56697       extra-properties:
56698         type: object
56699         $ref: "#/getDefinitions/extra-properties"
56700       inventory-response-items:
56701         type: object
56702         $ref: "#/getDefinitions/inventory-response-items"
56703   inventory-response-items:
56704     description: |
56705       Container for inventory items in response list
56706     properties:
56707       inventory-response-item:
56708         type: array
56709         items:
56710           $ref: "#/getDefinitions/inventory-response-item"
56711   ipsec-configuration:
56712     description: |
56713       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
56714       ###### Related Nodes
56715       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
56716       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
56717
56718       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
56719     required:
56720     - ipsec-configuration-id
56721     properties:
56722       ipsec-configuration-id:
56723         type: string
56724         description: UUID of this configuration
56725       requested-vig-address-type:
56726         type: string
56727         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
56728       requested-encryption-strength:
56729         type: string
56730         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
56731       requested-dmz-type:
56732         type: string
56733         description: ATT can offer a shared DMZ or a DMZ specific to a customer
56734       shared-dmz-network-address:
56735         type: string
56736         description: Network address of shared DMZ
56737       requested-customer-name:
56738         type: string
56739         description: If the DMZ is a custom DMZ, this field will indicate the customer information
56740       ike-version:
56741         type: string
56742         description: can be 1 or 2
56743       ikev1-authentication:
56744         type: string
56745         description: Contains values like md5, sha1, sha256, sha384
56746       ikev1-encryption:
56747         type: string
56748         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
56749       ikev1-dh-group:
56750         type: string
56751         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
56752       ikev1-am-group-id:
56753         type: string
56754         description: Group name defined in VIG for clients using aggressive mode
56755       ikev1-am-password:
56756         type: string
56757         description: pre-shared key for the above group name
56758       ikev1-sa-lifetime:
56759         type: string
56760         description: Lifetime for IKEv1 SA
56761       ipsec-authentication:
56762         type: string
56763         description: md5, sha1, sha256, sha384
56764       ipsec-encryption:
56765         type: string
56766         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
56767       ipsec-sa-lifetime:
56768         type: string
56769         description: Life time for IPSec SA
56770       ipsec-pfs:
56771         type: string
56772         description: enable PFS or not
56773       xauth-userid:
56774         type: string
56775         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
56776       xauth-user-password:
56777         type: string
56778         description: Encrypted using the Juniper $9$ algorithm
56779       dpd-interval:
56780         type: string
56781         description: The time between DPD probe
56782       dpd-frequency:
56783         type: string
56784         description: Maximum number of DPD before claiming the tunnel is down
56785       resource-version:
56786         type: string
56787         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56788       relationship-list:
56789         type: array
56790         items:
56791           $ref: "#/getDefinitions/relationship"
56792       vig-servers:
56793         type: array
56794         items:
56795           $ref: "#/getDefinitions/vig-server"
56796   ipsec-configurations:
56797     properties:
56798       ipsec-configuration:
56799         type: array
56800         items:
56801           $ref: "#/getDefinitions/ipsec-configuration"
56802   key-data:
56803     properties:
56804       key-name:
56805         type: string
56806       key-value:
56807         type: string
56808   l-interface:
56809     description: |
56810       Logical interfaces, e.g., a vnic.
56811       ###### Related Nodes
56812       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
56813       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
56814       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
56815       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
56816       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
56817       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
56818       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
56819       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
56820       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
56821       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
56822       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
56823       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
56824       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
56825       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
56826
56827       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
56828       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
56829       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
56830     required:
56831     - interface-name
56832     - is-port-mirrored
56833     - in-maint
56834     - is-ip-unnumbered
56835     properties:
56836       interface-name:
56837         type: string
56838         description: Name given to the interface
56839       interface-role:
56840         type: string
56841         description: E.g., CUSTOMER, UPLINK, etc.
56842       v6-wan-link-ip:
56843         type: string
56844         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
56845       selflink:
56846         type: string
56847         description: URL to endpoint where AAI can get more details
56848       interface-id:
56849         type: string
56850         description: ID of interface
56851       macaddr:
56852         type: string
56853         description: MAC address for the interface
56854       network-name:
56855         type: string
56856         description: Name of the network
56857       management-option:
56858         type: string
56859         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
56860       interface-description:
56861         type: string
56862         description: Human friendly text regarding this interface.
56863       is-port-mirrored:
56864         type: boolean
56865         description: boolean indicatating whether or not port is a mirrored.
56866       resource-version:
56867         type: string
56868         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56869       in-maint:
56870         type: boolean
56871         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56872       prov-status:
56873         type: string
56874         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
56875       is-ip-unnumbered:
56876         type: boolean
56877         description: Flag indicating the interface uses the IP Unnumbered configuration.
56878       allowed-address-pairs:
56879         type: string
56880         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
56881       vlans:
56882         type: array
56883         items:
56884           $ref: "#/getDefinitions/vlan"
56885       sriov-vfs:
56886         type: array
56887         items:
56888           $ref: "#/getDefinitions/sriov-vf"
56889       l-interfaces:
56890         type: array
56891         items:
56892           $ref: "#/getDefinitions/l-interface"
56893       relationship-list:
56894         type: array
56895         items:
56896           $ref: "#/getDefinitions/relationship"
56897       l3-interface-ipv4-address-list:
56898         type: array
56899         items:
56900           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
56901       l3-interface-ipv6-address-list:
56902         type: array
56903         items:
56904           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
56905   l-interfaces:
56906     description: |
56907       Collection of logical interfaces.
56908     properties:
56909       l-interface:
56910         type: array
56911         items:
56912           $ref: "#/getDefinitions/l-interface"
56913   l3-interface-ipv4-address-list:
56914     description: |
56915       IPv4 Address Range
56916       ###### Related Nodes
56917       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
56918       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
56919       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56920       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
56921       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
56922       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
56923
56924       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
56925     required:
56926     - l3-interface-ipv4-address
56927     properties:
56928       l3-interface-ipv4-address:
56929         type: string
56930         description: IP address
56931       l3-interface-ipv4-prefix-length:
56932         type: integer
56933         format: int64
56934         description: Prefix length, 32 for single address
56935       vlan-id-inner:
56936         type: integer
56937         format: int64
56938         description: Inner VLAN tag
56939       vlan-id-outer:
56940         type: integer
56941         format: int64
56942         description: Outer VLAN tag
56943       is-floating:
56944         type: boolean
56945         description: Indicator of fixed or floating address
56946       resource-version:
56947         type: string
56948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56949       neutron-network-id:
56950         type: string
56951         description: Neutron network id of the interface that address belongs to
56952       neutron-subnet-id:
56953         type: string
56954         description: Neutron id of subnet that address belongs to
56955       relationship-list:
56956         type: array
56957         items:
56958           $ref: "#/getDefinitions/relationship"
56959   l3-interface-ipv6-address-list:
56960     description: |
56961       IPv6 Address Range
56962       ###### Related Nodes
56963       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
56964       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
56965       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56966       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
56967       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
56968       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
56969
56970       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
56971     required:
56972     - l3-interface-ipv6-address
56973     properties:
56974       l3-interface-ipv6-address:
56975         type: string
56976         description: IP address
56977       l3-interface-ipv6-prefix-length:
56978         type: integer
56979         format: int64
56980         description: Prefix length, 128 for single address
56981       vlan-id-inner:
56982         type: integer
56983         format: int64
56984         description: Inner VLAN tag
56985       vlan-id-outer:
56986         type: integer
56987         format: int64
56988         description: Outer VLAN tag
56989       is-floating:
56990         type: boolean
56991         description: Indicator of fixed or floating address
56992       resource-version:
56993         type: string
56994         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56995       neutron-network-id:
56996         type: string
56997         description: Neutron network id of the interface that address belongs to
56998       neutron-subnet-id:
56999         type: string
57000         description: Neutron id of subnet that address belongs to
57001       relationship-list:
57002         type: array
57003         items:
57004           $ref: "#/getDefinitions/relationship"
57005   l3-network:
57006     description: |
57007       Generic network definition
57008       ###### Related Nodes
57009       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
57010       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
57011       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
57012       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
57013       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
57014       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
57015       - FROM complex( complex Uses l3-network, MANY2MANY)
57016       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
57017       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
57018       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
57019       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
57020       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
57021       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
57022       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
57023       - FROM tenant( tenant Uses l3-network, MANY2MANY)
57024       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
57025
57026       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
57027     required:
57028     - network-id
57029     - network-name
57030     - is-bound-to-vpn
57031     - is-provider-network
57032     - is-shared-network
57033     - is-external-network
57034     properties:
57035       network-id:
57036         type: string
57037         description: Network ID, should be uuid. Unique across A&AI.
57038       network-name:
57039         type: string
57040         description: Name of the network, governed by some naming convention..
57041       network-type:
57042         type: string
57043         description: Type of the network - who defines these values?
57044       network-role:
57045         type: string
57046         description: Role the network plans - who defines these values?
57047       network-technology:
57048         type: string
57049         description: Network technology - who defines these values?
57050       neutron-network-id:
57051         type: string
57052         description: Neutron network id of this Interface
57053       is-bound-to-vpn:
57054         type: boolean
57055         description: Set to true if bound to VPN
57056       service-id:
57057         type: string
57058         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
57059       network-role-instance:
57060         type: integer
57061         format: int64
57062         description: network role instance
57063       resource-version:
57064         type: string
57065         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57066       orchestration-status:
57067         type: string
57068         description: Orchestration status of this VNF, mastered by MSO
57069       heat-stack-id:
57070         type: string
57071         description: Heat stack id corresponding to this instance, managed by MSO
57072       mso-catalog-key:
57073         type: string
57074         description: Corresponds to the SDN-C catalog id used to configure this VCE
57075       contrail-network-fqdn:
57076         type: string
57077         description: Contrail FQDN for the network
57078       model-invariant-id:
57079         type: string
57080         description: the ASDC model id for this resource or service model.
57081       model-version-id:
57082         type: string
57083         description: the ASDC model version for this resource or service model.
57084       persona-model-version:
57085         type: string
57086         description: the ASDC model version for this resource or service model.
57087       model-customization-id:
57088         type: string
57089         description: captures the id of all the configuration used to customize the resource for the service.
57090       widget-model-id:
57091         type: string
57092         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57093       widget-model-version:
57094         type: string
57095         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57096       physical-network-name:
57097         type: string
57098         description: Name associated with the physical network.
57099       is-provider-network:
57100         type: boolean
57101         description: boolean indicatating whether or not network is a provider network.
57102       is-shared-network:
57103         type: boolean
57104         description: boolean indicatating whether or not network is a shared network.
57105       is-external-network:
57106         type: boolean
57107         description: boolean indicatating whether or not network is an external network.
57108       selflink:
57109         type: string
57110         description: Path to the controller object.
57111       operational-status:
57112         type: string
57113         description: Indicator for whether the resource is considered operational.
57114       subnets:
57115         type: array
57116         items:
57117           $ref: "#/getDefinitions/subnet"
57118       ctag-assignments:
57119         type: array
57120         items:
57121           $ref: "#/getDefinitions/ctag-assignment"
57122       segmentation-assignments:
57123         type: array
57124         items:
57125           $ref: "#/getDefinitions/segmentation-assignment"
57126       relationship-list:
57127         type: array
57128         items:
57129           $ref: "#/getDefinitions/relationship"
57130         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
57131   l3-networks:
57132     properties:
57133       l3-network:
57134         type: array
57135         items:
57136           $ref: "#/getDefinitions/l3-network"
57137   lag-interface:
57138     description: |
57139       Link aggregate interface
57140       ###### Related Nodes
57141       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
57142       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
57143       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
57144       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
57145       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
57146       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
57147       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
57148       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
57149
57150       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
57151       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
57152       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
57153     required:
57154     - interface-name
57155     - in-maint
57156     properties:
57157       interface-name:
57158         type: string
57159         description: Name that identifies the link aggregate interface
57160       interface-description:
57161         type: string
57162         description: Human friendly text regarding this interface.
57163       resource-version:
57164         type: string
57165         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57166       speed-value:
57167         type: string
57168         description: Captures the numeric part of the speed
57169       speed-units:
57170         type: string
57171         description: Captures the units corresponding to the speed
57172       interface-id:
57173         type: string
57174         description: ID of interface
57175       interface-role:
57176         type: string
57177         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
57178       prov-status:
57179         type: string
57180         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57181       in-maint:
57182         type: boolean
57183         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
57184       relationship-list:
57185         type: array
57186         items:
57187           $ref: "#/getDefinitions/relationship"
57188       l-interfaces:
57189         type: array
57190         items:
57191           $ref: "#/getDefinitions/l-interface"
57192   lag-interfaces:
57193     description: |
57194       Collection of link aggregate interfaces.
57195     properties:
57196       lag-interface:
57197         type: array
57198         items:
57199           $ref: "#/getDefinitions/lag-interface"
57200   lag-link:
57201     description: |
57202       LAG links can connect lag-interfaces
57203       ###### Related Nodes
57204       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
57205       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
57206
57207       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
57208     required:
57209     - link-name
57210     properties:
57211       link-name:
57212         type: string
57213         description: Alphabetical concatenation of lag-interface names
57214       resource-version:
57215         type: string
57216         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57217       relationship-list:
57218         type: array
57219         items:
57220           $ref: "#/getDefinitions/relationship"
57221   lag-links:
57222     description: |
57223       Collection of link aggregation connections
57224     properties:
57225       lag-link:
57226         type: array
57227         items:
57228           $ref: "#/getDefinitions/lag-link"
57229   license:
57230     description: |
57231       Metadata for license group.
57232       ###### Related Nodes
57233       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
57234       - TO vce( license BelongsTo vce, MANY2ONE)(4)
57235
57236       -(4) IF this TO node is deleted, this LICENSE is DELETED also
57237     required:
57238     - group-uuid
57239     - resource-uuid
57240     properties:
57241       group-uuid:
57242         type: string
57243         description: Unique ID for the license group the resource belongs to, should be uuid.
57244       resource-uuid:
57245         type: string
57246         description: Unique ID of a license resource.
57247       resource-version:
57248         type: string
57249         description: Concurrency value
57250       relationship-list:
57251         type: array
57252         items:
57253           $ref: "#/getDefinitions/relationship"
57254   licenses:
57255     description: |
57256       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
57257     properties:
57258       license:
57259         type: array
57260         items:
57261           $ref: "#/getDefinitions/license"
57262   line-of-business:
57263     description: |
57264       describes a line-of-business
57265       ###### Related Nodes
57266       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
57267
57268     required:
57269     - line-of-business-name
57270     properties:
57271       line-of-business-name:
57272         type: string
57273         description: Name of the line-of-business (product)
57274       resource-version:
57275         type: string
57276         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57277       relationship-list:
57278         type: array
57279         items:
57280           $ref: "#/getDefinitions/relationship"
57281   lines-of-business:
57282     description: |
57283       Collection of lines-of-business
57284     properties:
57285       line-of-business:
57286         type: array
57287         items:
57288           $ref: "#/getDefinitions/line-of-business"
57289   logical-link:
57290     description: |
57291       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
57292       ###### Related Nodes
57293       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
57294       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
57295       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
57296       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
57297       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
57298       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
57299       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
57300       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
57301       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
57302       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
57303       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
57304       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
57305       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
57306       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
57307       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
57308
57309       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
57310     required:
57311     - link-name
57312     - in-maint
57313     - link-type
57314     properties:
57315       link-name:
57316         type: string
57317         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
57318       in-maint:
57319         type: boolean
57320         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.
57321       link-type:
57322         type: string
57323         description: Type of logical link, e.g., evc
57324       speed-value:
57325         type: string
57326         description: Captures the numeric part of the speed
57327       speed-units:
57328         type: string
57329         description: Captures the units corresponding to the speed
57330       ip-version:
57331         type: string
57332         description: v4, v6, or ds for dual stack
57333       routing-protocol:
57334         type: string
57335         description: For example, static or BGP
57336       resource-version:
57337         type: string
57338         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57339       model-invariant-id:
57340         type: string
57341         description: the ASDC model id for this resource or service model.
57342       model-version-id:
57343         type: string
57344         description: the ASDC model version for this resource or service model.
57345       persona-model-version:
57346         type: string
57347         description: the ASDC model version for this resource or service model.
57348       widget-model-id:
57349         type: string
57350         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57351       widget-model-version:
57352         type: string
57353         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57354       operational-status:
57355         type: string
57356         description: Indication of operational status of the logical link.
57357       prov-status:
57358         type: string
57359         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57360       link-role:
57361         type: string
57362         description: Indication of the network use of the logical link.
57363       link-name2:
57364         type: string
57365         description: Alias or alternate name (CLCI or D1 name).
57366       link-id:
57367         type: string
57368         description: UUID of the logical-link, SDNC generates this.
57369       circuit-id:
57370         type: string
57371         description: Circuit id
57372       purpose:
57373         type: string
57374         description: Reason for this entity, role it is playing
57375       relationship-list:
57376         type: array
57377         items:
57378           $ref: "#/getDefinitions/relationship"
57379   logical-links:
57380     description: |
57381       Collection of logical connections
57382     properties:
57383       logical-link:
57384         type: array
57385         items:
57386           $ref: "#/getDefinitions/logical-link"
57387   metadata:
57388     description: |
57389       Collection of metadatum (key/value pairs)
57390     properties:
57391       metadatum:
57392         type: array
57393         items:
57394           $ref: "#/getDefinitions/metadatum"
57395   metadatum:
57396     description: |
57397       Key/value pairs
57398       ###### Related Nodes
57399       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
57400       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
57401       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
57402       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
57403       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
57404
57405       -(4) IF this TO node is deleted, this METADATUM is DELETED also
57406     required:
57407     - metaname
57408     - metaval
57409     properties:
57410       metaname:
57411         type: string
57412       metaval:
57413         type: string
57414       resource-version:
57415         type: string
57416         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57417   model:
57418     description: |
57419       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
57420       ###### Related Nodes
57421       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
57422       - FROM instance-group( instance-group Targets model, MANY2MANY)
57423       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
57424       - FROM named-query( named-query AppliesTo model, ONE2MANY)
57425       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
57426
57427       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
57428       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
57429
57430     required:
57431     - model-invariant-id
57432     - model-type
57433     properties:
57434       model-invariant-id:
57435         type: string
57436         description: Unique identifier corresponding to the main definition of a model in ASDC
57437       model-type:
57438         type: string
57439         description: Type of the model, e.g., service, resource, widget, etc.
57440       resource-version:
57441         type: string
57442         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57443       model-vers:
57444         type: array
57445         items:
57446           $ref: "#/getDefinitions/model-ver"
57447       relationship-list:
57448         type: array
57449         items:
57450           $ref: "#/getDefinitions/relationship"
57451   model-and-named-query-search:
57452     description: |
57453       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
57454     properties:
57455       query-parameters:
57456         type: object
57457         $ref: "#/getDefinitions/query-parameters"
57458       instance-filters:
57459         type: object
57460         $ref: "#/getDefinitions/instance-filters"
57461       secondary-filts:
57462         type: object
57463         $ref: "#/getDefinitions/secondary-filts"
57464       top-node-type:
57465         type: string
57466       secondary-filter-cut-point:
57467         type: string
57468   model-constraint:
57469     description: |
57470       This is how we would capture constraints defining allowed sets of elements.
57471       ###### Related Nodes
57472       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
57473       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
57474
57475       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
57476       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
57477     required:
57478     - model-constraint-uuid
57479     - constrained-element-set-uuid-to-replace
57480     properties:
57481       model-constraint-uuid:
57482         type: string
57483       constrained-element-set-uuid-to-replace:
57484         type: string
57485       constrained-element-sets:
57486         type: array
57487         items:
57488           $ref: "#/getDefinitions/constrained-element-set"
57489       resource-version:
57490         type: string
57491         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57492   model-constraints:
57493     properties:
57494       model-constraint:
57495         type: array
57496         items:
57497           $ref: "#/getDefinitions/model-constraint"
57498   model-element:
57499     description: |
57500       Defines how other models combine to make up a higher-level model.
57501       ###### Related Nodes
57502       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
57503       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
57504       - TO model-ver( model-element IsA model-ver, MANY2ONE)
57505       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
57506       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
57507       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
57508       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
57509
57510       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
57511       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
57512     required:
57513     - model-element-uuid
57514     - new-data-del-flag
57515     - cardinality
57516     properties:
57517       model-element-uuid:
57518         type: string
57519       new-data-del-flag:
57520         type: string
57521         description: Indicates whether this element was created as part of instantiation from this model
57522       cardinality:
57523         type: string
57524         description: How many of this type of element are required/allowed
57525       linkage-points:
57526         type: string
57527       resource-version:
57528         type: string
57529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57530       model-elements:
57531         type: array
57532         items:
57533           $ref: "#/getDefinitions/model-element"
57534         description: Defines how other models combine to make up a higher-level model
57535       model-constraints:
57536         type: array
57537         items:
57538           $ref: "#/getDefinitions/model-constraint"
57539         description: Describes new constraints on this model element that are not part of that model's definition
57540       relationship-list:
57541         type: array
57542         items:
57543           $ref: "#/getDefinitions/relationship"
57544   model-elements:
57545     properties:
57546       model-element:
57547         type: array
57548         items:
57549           $ref: "#/getDefinitions/model-element"
57550   model-ver:
57551     description: |
57552       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
57553       ###### Related Nodes
57554       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
57555       - FROM model-element( model-element IsA model-ver, MANY2ONE)
57556       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
57557       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
57558
57559       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
57560       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
57561       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
57562
57563     required:
57564     - model-version-id
57565     - model-name
57566     - model-version
57567     properties:
57568       model-version-id:
57569         type: string
57570         description: Unique identifier corresponding to one version of a model in ASDC
57571       model-name:
57572         type: string
57573         description: Name of the model, which can change from version to version.
57574       model-version:
57575         type: string
57576         description: Version
57577       model-description:
57578         type: string
57579         description: Description
57580       resource-version:
57581         type: string
57582         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57583       model-elements:
57584         type: array
57585         items:
57586           $ref: "#/getDefinitions/model-element"
57587       metadata:
57588         type: array
57589         items:
57590           $ref: "#/getDefinitions/metadatum"
57591       relationship-list:
57592         type: array
57593         items:
57594           $ref: "#/getDefinitions/relationship"
57595   model-vers:
57596     properties:
57597       model-ver:
57598         type: array
57599         items:
57600           $ref: "#/getDefinitions/model-ver"
57601   models:
57602     description: |
57603       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
57604     properties:
57605       model:
57606         type: array
57607         items:
57608           $ref: "#/getDefinitions/model"
57609   multicast-configuration:
57610     description: |
57611       ###### Related Nodes
57612       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
57613
57614     required:
57615     - multicast-configuration-id
57616     - multicast-protocol
57617     - rp-type
57618     properties:
57619       multicast-configuration-id:
57620         type: string
57621         description: Unique id of multicast configuration.
57622       multicast-protocol:
57623         type: string
57624         description: protocol of multicast configuration
57625       rp-type:
57626         type: string
57627         description: rp type of multicast configuration
57628       resource-version:
57629         type: string
57630         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57631       relationship-list:
57632         type: array
57633         items:
57634           $ref: "#/getDefinitions/relationship"
57635   multicast-configurations:
57636     description: |
57637       multicast configuration of generic-vnf ip-address
57638     properties:
57639       multicast-configuration:
57640         type: array
57641         items:
57642           $ref: "#/getDefinitions/multicast-configuration"
57643   named-queries:
57644     properties:
57645       named-query:
57646         type: array
57647         items:
57648           $ref: "#/getDefinitions/named-query"
57649   named-query:
57650     description: |
57651       TBD
57652       ###### Related Nodes
57653       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
57654       - TO model( named-query AppliesTo model, ONE2MANY)
57655       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
57656
57657       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
57658     required:
57659     - named-query-uuid
57660     - named-query-name
57661     - named-query-version
57662     properties:
57663       named-query-uuid:
57664         type: string
57665       named-query-name:
57666         type: string
57667       named-query-version:
57668         type: string
57669       required-input-param:
57670         type: string
57671       description:
57672         type: string
57673       resource-version:
57674         type: string
57675       named-query-elements:
57676         type: array
57677         items:
57678           $ref: "#/getDefinitions/named-query-element"
57679       relationship-list:
57680         type: array
57681         items:
57682           $ref: "#/getDefinitions/relationship"
57683   named-query-element:
57684     description: |
57685       TBD
57686       ###### Related Nodes
57687       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
57688       - TO model( named-query-element IsA model, MANY2ONE)
57689       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
57690       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
57691       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
57692       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
57693
57694       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
57695       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
57696     required:
57697     - named-query-element-uuid
57698     properties:
57699       named-query-element-uuid:
57700         type: string
57701       property-collect-list:
57702         type: string
57703       resource-version:
57704         type: string
57705       property-limit-desc:
57706         type: string
57707       do-not-output:
57708         type: string
57709       named-query-elements:
57710         type: array
57711         items:
57712           $ref: "#/getDefinitions/named-query-element"
57713       related-lookups:
57714         type: array
57715         items:
57716           $ref: "#/getDefinitions/related-lookup"
57717       property-constraints:
57718         type: array
57719         items:
57720           $ref: "#/getDefinitions/property-constraint"
57721       relationship-list:
57722         type: array
57723         items:
57724           $ref: "#/getDefinitions/relationship"
57725   named-query-elements:
57726     properties:
57727       named-query-element:
57728         type: array
57729         items:
57730           $ref: "#/getDefinitions/named-query-element"
57731   network:
57732     description: |
57733       Namespace for network inventory resources.
57734     properties:
57735       logical-links:
57736         type: array
57737         items:
57738           $ref: "#/getDefinitions/logical-link"
57739       site-pair-sets:
57740         type: array
57741         items:
57742           $ref: "#/getDefinitions/site-pair-set"
57743       vpn-bindings:
57744         type: array
57745         items:
57746           $ref: "#/getDefinitions/vpn-binding"
57747       vpls-pes:
57748         type: array
57749         items:
57750           $ref: "#/getDefinitions/vpls-pe"
57751       multicast-configurations:
57752         type: array
57753         items:
57754           $ref: "#/getDefinitions/multicast-configuration"
57755       vces:
57756         type: array
57757         items:
57758           $ref: "#/getDefinitions/vce"
57759       vnfcs:
57760         type: array
57761         items:
57762           $ref: "#/getDefinitions/vnfc"
57763       l3-networks:
57764         type: array
57765         items:
57766           $ref: "#/getDefinitions/l3-network"
57767       network-policies:
57768         type: array
57769         items:
57770           $ref: "#/getDefinitions/network-policy"
57771       generic-vnfs:
57772         type: array
57773         items:
57774           $ref: "#/getDefinitions/generic-vnf"
57775       lag-links:
57776         type: array
57777         items:
57778           $ref: "#/getDefinitions/lag-link"
57779       newvces:
57780         type: array
57781         items:
57782           $ref: "#/getDefinitions/newvce"
57783       pnfs:
57784         type: array
57785         items:
57786           $ref: "#/getDefinitions/pnf"
57787       physical-links:
57788         type: array
57789         items:
57790           $ref: "#/getDefinitions/physical-link"
57791       ipsec-configurations:
57792         type: array
57793         items:
57794           $ref: "#/getDefinitions/ipsec-configuration"
57795       route-table-references:
57796         type: array
57797         items:
57798           $ref: "#/getDefinitions/route-table-reference"
57799       instance-groups:
57800         type: array
57801         items:
57802           $ref: "#/getDefinitions/instance-group"
57803       zones:
57804         type: array
57805         items:
57806           $ref: "#/getDefinitions/zone"
57807       configurations:
57808         type: array
57809         items:
57810           $ref: "#/getDefinitions/configurations"
57811   network-policies:
57812     properties:
57813       network-policy:
57814         type: array
57815         items:
57816           $ref: "#/getDefinitions/network-policy"
57817   network-policy:
57818     description: |
57819       ###### Related Nodes
57820       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
57821       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
57822
57823     required:
57824     - network-policy-id
57825     properties:
57826       network-policy-id:
57827         type: string
57828         description: UUID representing unique key to this instance
57829       network-policy-fqdn:
57830         type: string
57831         description: Contrail FQDN for the policy
57832       heat-stack-id:
57833         type: string
57834         description: ID for the openStack Heat instance
57835       resource-version:
57836         type: string
57837         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57838       relationship-list:
57839         type: array
57840         items:
57841           $ref: "#/getDefinitions/relationship"
57842   network-profile:
57843     description: |
57844       Network profile populated by SDN-GP for SNMP
57845       ###### Related Nodes
57846       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
57847
57848     required:
57849     - nm-profile-name
57850     properties:
57851       nm-profile-name:
57852         type: string
57853         description: Unique name of network profile.
57854       community-string:
57855         type: string
57856         description: Encrypted SNMP community string
57857       resource-version:
57858         type: string
57859         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57860       relationship-list:
57861         type: array
57862         items:
57863           $ref: "#/getDefinitions/relationship"
57864   network-profiles:
57865     description: |
57866       Collection of network profiles
57867     properties:
57868       network-profile:
57869         type: array
57870         items:
57871           $ref: "#/getDefinitions/network-profile"
57872   newvce:
57873     description: |
57874       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57875       ###### Related Nodes
57876       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
57877
57878       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
57879     required:
57880     - vnf-id2
57881     - vnf-name
57882     - vnf-type
57883     properties:
57884       vnf-id2:
57885         type: string
57886         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
57887       vnf-name:
57888         type: string
57889         description: Name of VNF.
57890       vnf-name2:
57891         type: string
57892         description: Alternate name of VNF.
57893       vnf-type:
57894         type: string
57895         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.
57896       prov-status:
57897         type: string
57898         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57899       operational-status:
57900         type: string
57901         description: Indicator for whether the resource is considered operational
57902       license-key:
57903         type: string
57904         description: OBSOLETE -  do not use
57905       ipv4-oam-address:
57906         type: string
57907         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).
57908       equipment-role:
57909         type: string
57910         description: Client should send valid enumerated value.
57911       resource-version:
57912         type: string
57913         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57914       ipv4-loopback0-address:
57915         type: string
57916         description: v4 Loopback0 address
57917       orchestration-status:
57918         type: string
57919         description: Orchestration status of this VNF, mastered by MSO.
57920       heat-stack-id:
57921         type: string
57922         description: Heat stack id corresponding to this instance, managed by MSO
57923       mso-catalog-key:
57924         type: string
57925         description: Corresponds to the SDN-C catalog id used to configure this VCE
57926       relationship-list:
57927         type: array
57928         items:
57929           $ref: "#/getDefinitions/relationship"
57930       l-interfaces:
57931         type: array
57932         items:
57933           $ref: "#/getDefinitions/l-interface"
57934   newvces:
57935     description: |
57936       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57937     properties:
57938       newvce:
57939         type: array
57940         items:
57941           $ref: "#/getDefinitions/newvce"
57942   nodes:
57943     properties:
57944       inventory-item-data:
57945         type: array
57946         items:
57947           $ref: "#/getDefinitions/inventory-item-data"
57948   notification-event:
57949     properties:
57950       cambria.partition:
57951         type: string
57952       notification-event-header:
57953         type: object
57954         $ref: "#/getDefinitions/notification-event-header"
57955   notification-event-header:
57956     properties:
57957       id:
57958         type: string
57959       timestamp:
57960         type: string
57961       source-name:
57962         type: string
57963       domain:
57964         type: string
57965       sequence-number:
57966         type: string
57967       severity:
57968         type: string
57969       event-type:
57970         type: string
57971       version:
57972         type: string
57973       action:
57974         type: string
57975       entity-type:
57976         type: string
57977       top-entity-type:
57978         type: string
57979       entity-link:
57980         type: string
57981       status:
57982         type: string
57983   notify:
57984     required:
57985     - event-id
57986     properties:
57987       event-id:
57988         type: string
57989       node-type:
57990         type: string
57991       event-trigger:
57992         type: string
57993       key-data:
57994         type: array
57995         items:
57996           $ref: "#/getDefinitions/key-data"
57997       selflink:
57998         type: string
57999   oam-network:
58000     description: |
58001       OAM network, to be deprecated shortly.  Do not use for new purposes.
58002       ###### Related Nodes
58003       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
58004       - TO complex( oam-network AppliesTo complex, MANY2MANY)
58005       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
58006
58007     required:
58008     - network-uuid
58009     - network-name
58010     - cvlan-tag
58011     properties:
58012       network-uuid:
58013         type: string
58014         description: UUID of the network. Unique across a cloud-region
58015       network-name:
58016         type: string
58017         description: Name of the network.
58018       cvlan-tag:
58019         type: integer
58020         format: int64
58021         description: cvlan-id
58022       ipv4-oam-gateway-address:
58023         type: string
58024         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
58025       ipv4-oam-gateway-address-prefix-length:
58026         type: integer
58027         format: int32
58028         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
58029       resource-version:
58030         type: string
58031         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58032       relationship-list:
58033         type: array
58034         items:
58035           $ref: "#/getDefinitions/relationship"
58036   oam-networks:
58037     description: |
58038       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
58039     properties:
58040       oam-network:
58041         type: array
58042         items:
58043           $ref: "#/getDefinitions/oam-network"
58044   operational-environment:
58045     description: |
58046       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
58047       ###### Related Nodes
58048       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
58049       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
58050
58051     required:
58052     - operational-environment-id
58053     - operational-environment-name
58054     - operational-environment-type
58055     - operational-environment-status
58056     - tenant-context
58057     - workload-context
58058     properties:
58059       operational-environment-id:
58060         type: string
58061         description: UUID of an operational environment
58062       operational-environment-name:
58063         type: string
58064         description: Operational Environment name
58065       operational-environment-type:
58066         type: string
58067         description: Operational Environment Type.
58068       operational-environment-status:
58069         type: string
58070         description: Status
58071       tenant-context:
58072         type: string
58073         description: Tenant Context.
58074       workload-context:
58075         type: string
58076         description: Workload Context.
58077       resource-version:
58078         type: string
58079         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58080       relationship-list:
58081         type: array
58082         items:
58083           $ref: "#/getDefinitions/relationship"
58084   operational-environments:
58085     description: |
58086       a logical partition of the cloud which allows to have multiple environments in the production AIC.
58087     properties:
58088       operational-environment:
58089         type: array
58090         items:
58091           $ref: "#/getDefinitions/operational-environment"
58092   overloaded-model:
58093     description: |
58094       Allows for legacy POST of old-style and new-style models
58095     required:
58096     - model-invariant-id
58097     - model-name-version-id
58098     - model-type
58099     - model-name
58100     - model-id
58101     - model-version
58102     properties:
58103       model-invariant-id:
58104         type: string
58105         description: Unique identifier corresponding to the main definition of a model in ASDC
58106       model-name-version-id:
58107         type: string
58108         description: Unique identifier corresponding to one version of a model in ASDC
58109       model-type:
58110         type: string
58111         description: Type of the model, e.g., service, resource, widget, etc.
58112       model-name:
58113         type: string
58114         description: Name of the model, which can change from version to version.
58115       model-id:
58116         type: string
58117         description: Invariant unique ID which does not change from version to version
58118       model-version:
58119         type: string
58120         description: Version
58121       model-description:
58122         type: string
58123         description: Description
58124       resource-version:
58125         type: string
58126         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58127       model-vers:
58128         type: object
58129         $ref: "#/getDefinitions/model-vers"
58130       relationship-list:
58131         type: object
58132         $ref: "#/getDefinitions/relationship-list"
58133   owning-entities:
58134     description: |
58135       Collection of owning-entities
58136     properties:
58137       owning-entity:
58138         type: array
58139         items:
58140           $ref: "#/getDefinitions/owning-entity"
58141   owning-entity:
58142     description: |
58143       describes an owning-entity
58144       ###### Related Nodes
58145       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
58146
58147     required:
58148     - owning-entity-id
58149     - owning-entity-name
58150     properties:
58151       owning-entity-id:
58152         type: string
58153         description: UUID of an owning entity
58154       owning-entity-name:
58155         type: string
58156         description: Owning entity name
58157       resource-version:
58158         type: string
58159         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58160       relationship-list:
58161         type: array
58162         items:
58163           $ref: "#/getDefinitions/relationship"
58164   p-interface:
58165     description: |
58166       Physical interface (e.g., nic)
58167       ###### Related Nodes
58168       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
58169       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
58170       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
58171       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
58172       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
58173       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
58174       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
58175       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
58176
58177       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
58178       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
58179       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
58180     required:
58181     - interface-name
58182     - in-maint
58183     properties:
58184       interface-name:
58185         type: string
58186         description: Name that identifies the physical interface
58187       speed-value:
58188         type: string
58189         description: Captures the numeric part of the speed
58190       speed-units:
58191         type: string
58192         description: Captures the units corresponding to the speed
58193       port-description:
58194         type: string
58195         description: Nature of the services and connectivity on this port.
58196       equipment-identifier:
58197         type: string
58198         description: CLEI or other specification for p-interface hardware.
58199       interface-role:
58200         type: string
58201         description: Role specification for p-interface hardware.
58202       interface-type:
58203         type: string
58204         description: Indicates the physical properties of the interface.
58205       prov-status:
58206         type: string
58207         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58208       mac-addresss:
58209         type: string
58210         description: MAC Address of the p-interface.
58211       resource-version:
58212         type: string
58213         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58214       in-maint:
58215         type: boolean
58216         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
58217       inv-status:
58218         type: string
58219         description: inventory status
58220       relationship-list:
58221         type: array
58222         items:
58223           $ref: "#/getDefinitions/relationship"
58224       sriov-pfs:
58225         type: array
58226         items:
58227           $ref: "#/getDefinitions/sriov-pf"
58228       l-interfaces:
58229         type: array
58230         items:
58231           $ref: "#/getDefinitions/l-interface"
58232   p-interfaces:
58233     description: |
58234       Collection of physical interfaces.
58235     properties:
58236       p-interface:
58237         type: array
58238         items:
58239           $ref: "#/getDefinitions/p-interface"
58240   physical-link:
58241     description: |
58242       Collection of physical connections, typically between p-interfaces
58243       ###### Related Nodes
58244       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
58245
58246       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
58247     required:
58248     - link-name
58249     properties:
58250       link-name:
58251         type: string
58252         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
58253       speed-value:
58254         type: string
58255         description: Captures the numeric part of the speed
58256       speed-units:
58257         type: string
58258         description: Captures the units corresponding to the speed
58259       circuit-id:
58260         type: string
58261         description: Circuit it
58262       dual-mode:
58263         type: string
58264         description: Dual access mode (e.g., primary, secondary
58265       management-option:
58266         type: string
58267         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
58268       service-provider-name:
58269         type: string
58270         description: Name of the service Provider on this link.
58271       service-provider-bandwidth-up-value:
58272         type: integer
58273         format: int32
58274         description: Upstream Bandwidth value agreed with the service provider
58275       service-provider-bandwidth-up-units:
58276         type: string
58277         description: Units for the upstream BW value
58278       service-provider-bandwidth-down-value:
58279         type: integer
58280         format: int32
58281         description: Downstream Bandwidth value agreed with the service provider
58282       service-provider-bandwidth-down-units:
58283         type: string
58284         description: Units for downstream BW value
58285       resource-version:
58286         type: string
58287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58288       relationship-list:
58289         type: array
58290         items:
58291           $ref: "#/getDefinitions/relationship"
58292   physical-links:
58293     description: |
58294       Collection of physical connections, typically between p-interfaces
58295     properties:
58296       physical-link:
58297         type: array
58298         items:
58299           $ref: "#/getDefinitions/physical-link"
58300   platform:
58301     description: |
58302       describes a platform
58303       ###### Related Nodes
58304       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
58305
58306     required:
58307     - platform-name
58308     properties:
58309       platform-name:
58310         type: string
58311         description: Name of the platform
58312       resource-version:
58313         type: string
58314         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58315       relationship-list:
58316         type: array
58317         items:
58318           $ref: "#/getDefinitions/relationship"
58319   platforms:
58320     description: |
58321       Collection of platforms
58322     properties:
58323       platform:
58324         type: array
58325         items:
58326           $ref: "#/getDefinitions/platform"
58327   pnf:
58328     description: |
58329       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
58330       ###### Related Nodes
58331       - TO complex( pnf LocatedIn complex, MANY2ONE)
58332       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
58333       - TO zone( pnf LocatedIn zone, MANY2ONE)
58334       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
58335       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
58336       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
58337       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
58338       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
58339       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
58340
58341       -(1) IF this PNF node is deleted, this FROM node is DELETED also
58342     required:
58343     - pnf-name
58344     - in-maint
58345     properties:
58346       pnf-name:
58347         type: string
58348         description: unique name of Physical Network Function.
58349       pnf-name2:
58350         type: string
58351         description: name of Physical Network Function.
58352       pnf-name2-source:
58353         type: string
58354         description: source of name2
58355       pnf-id:
58356         type: string
58357         description: id of pnf
58358       equip-type:
58359         type: string
58360         description: Equipment type.  Source of truth should define valid values.
58361       equip-vendor:
58362         type: string
58363         description: Equipment vendor.  Source of truth should define valid values.
58364       equip-model:
58365         type: string
58366         description: Equipment model.  Source of truth should define valid values.
58367       management-option:
58368         type: string
58369         description: identifier of managed by ATT or customer
58370       ipaddress-v4-oam:
58371         type: string
58372         description: ipv4-oam-address with new naming convention for IP addresses
58373       sw-version:
58374         type: string
58375         description: sw-version is the version of SW for the hosted application on the PNF.
58376       in-maint:
58377         type: boolean
58378         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.
58379       frame-id:
58380         type: string
58381         description: ID of the physical frame (relay rack) where pnf is installed.
58382       serial-number:
58383         type: string
58384         description: Serial number of the device
58385       ipaddress-v4-loopback-0:
58386         type: string
58387         description: IPV4 Loopback 0 address
58388       ipaddress-v6-loopback-0:
58389         type: string
58390         description: IPV6 Loopback 0 address
58391       ipaddress-v4-aim:
58392         type: string
58393         description: IPV4 AIM address
58394       ipaddress-v6-aim:
58395         type: string
58396         description: IPV6 AIM address
58397       ipaddress-v6-oam:
58398         type: string
58399         description: IPV6 OAM address
58400       inv-status:
58401         type: string
58402         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
58403       resource-version:
58404         type: string
58405         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58406       prov-status:
58407         type: string
58408         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58409       nf-role:
58410         type: string
58411         description: Nf Role is the role performed by this instance in the network.
58412       relationship-list:
58413         type: array
58414         items:
58415           $ref: "#/getDefinitions/relationship"
58416       p-interfaces:
58417         type: array
58418         items:
58419           $ref: "#/getDefinitions/p-interface"
58420       lag-interfaces:
58421         type: array
58422         items:
58423           $ref: "#/getDefinitions/lag-interface"
58424   pnfs:
58425     description: |
58426       Collection of Physical Network Functions.
58427     properties:
58428       pnf:
58429         type: array
58430         items:
58431           $ref: "#/getDefinitions/pnf"
58432   port-group:
58433     description: |
58434       Used to capture the network interfaces of this VCE
58435       ###### Related Nodes
58436       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
58437       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
58438
58439       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
58440       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
58441     required:
58442     - interface-id
58443     - orchestration-status
58444     properties:
58445       interface-id:
58446         type: string
58447         description: Unique ID of the interface
58448       neutron-network-id:
58449         type: string
58450         description: Neutron network id of this Interface
58451       neutron-network-name:
58452         type: string
58453         description: Neutron network name of this Interface
58454       interface-role:
58455         type: string
58456         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
58457       resource-version:
58458         type: string
58459         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58460       port-group-id:
58461         type: string
58462         description: Unique ID for port group in vmware
58463       port-group-name:
58464         type: string
58465         description: Likely to duplicate value of neutron network name
58466       switch-name:
58467         type: string
58468         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
58469       orchestration-status:
58470         type: string
58471         description: Orchestration status of this VNF, mastered by MSO
58472       heat-stack-id:
58473         type: string
58474         description: Heat stack id corresponding to this instance, managed by MSO
58475       mso-catalog-key:
58476         type: string
58477         description: Corresponds to the SDN-C catalog id used to configure this VCE
58478       cvlan-tags:
58479         type: array
58480         items:
58481           $ref: "#/getDefinitions/cvlan-tag-entry"
58482       relationship-list:
58483         type: array
58484         items:
58485           $ref: "#/getDefinitions/relationship"
58486   port-groups:
58487     properties:
58488       port-group:
58489         type: array
58490         items:
58491           $ref: "#/getDefinitions/port-group"
58492   project:
58493     description: |
58494       describes the project
58495       ###### Related Nodes
58496       - TO service-instance( project Uses service-instance, ONE2MANY)
58497
58498     required:
58499     - project-name
58500     properties:
58501       project-name:
58502         type: string
58503         description: Name of the project deploying a service
58504       resource-version:
58505         type: string
58506         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58507       relationship-list:
58508         type: array
58509         items:
58510           $ref: "#/getDefinitions/relationship"
58511   projects:
58512     description: |
58513       Collection of projects
58514     properties:
58515       project:
58516         type: array
58517         items:
58518           $ref: "#/getDefinitions/project"
58519   properties:
58520     description: |
58521       Property holder for query properties or instance properties
58522     properties:
58523       property-name:
58524         type: string
58525       property-value:
58526         type: string
58527   property-constraint:
58528     description: |
58529       TBD
58530       ###### Related Nodes
58531       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
58532
58533       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
58534     required:
58535     - property-constraint-uuid
58536     - constraint-type
58537     - property-name
58538     - property-value
58539     properties:
58540       property-constraint-uuid:
58541         type: string
58542       constraint-type:
58543         type: string
58544       property-name:
58545         type: string
58546       property-value:
58547         type: string
58548       resource-version:
58549         type: string
58550   property-constraints:
58551     properties:
58552       property-constraint:
58553         type: array
58554         items:
58555           $ref: "#/getDefinitions/property-constraint"
58556   pserver:
58557     description: |
58558       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
58559       ###### Related Nodes
58560       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
58561       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
58562       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
58563       - TO complex( pserver LocatedIn complex, MANY2ONE)
58564       - TO zone( pserver LocatedIn zone, MANY2ONE)
58565       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
58566       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
58567       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
58568       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
58569       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
58570
58571       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
58572       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
58573
58574     required:
58575     - hostname
58576     - in-maint
58577     properties:
58578       hostname:
58579         type: string
58580         description: Value from executing hostname on the compute node.
58581       ptnii-equip-name:
58582         type: string
58583         description: PTNII name
58584       number-of-cpus:
58585         type: integer
58586         format: int32
58587         description: Number of cpus
58588       disk-in-gigabytes:
58589         type: integer
58590         format: int32
58591         description: Disk size, in GBs
58592       ram-in-megabytes:
58593         type: integer
58594         format: int32
58595         description: RAM size, in MBs
58596       equip-type:
58597         type: string
58598         description: Equipment type.  Source of truth should define valid values.
58599       equip-vendor:
58600         type: string
58601         description: Equipment vendor.  Source of truth should define valid values.
58602       equip-model:
58603         type: string
58604         description: Equipment model.  Source of truth should define valid values.
58605       fqdn:
58606         type: string
58607         description: Fully-qualified domain name
58608       pserver-selflink:
58609         type: string
58610         description: URL to endpoint where AAI can get more details
58611       ipv4-oam-address:
58612         type: string
58613         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
58614       serial-number:
58615         type: string
58616         description: Serial number, may be queried
58617       ipaddress-v4-loopback-0:
58618         type: string
58619         description: IPV4 Loopback 0 address
58620       ipaddress-v6-loopback-0:
58621         type: string
58622         description: IPV6 Loopback 0 address
58623       ipaddress-v4-aim:
58624         type: string
58625         description: IPV4 AIM address
58626       ipaddress-v6-aim:
58627         type: string
58628         description: IPV6 AIM address
58629       ipaddress-v6-oam:
58630         type: string
58631         description: IPV6 OAM address
58632       inv-status:
58633         type: string
58634         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
58635       pserver-id:
58636         type: string
58637         description: ID of Pserver
58638       internet-topology:
58639         type: string
58640         description: internet topology of Pserver
58641       in-maint:
58642         type: boolean
58643         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.
58644       resource-version:
58645         type: string
58646         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58647       pserver-name2:
58648         type: string
58649         description: alternative pserver name
58650       purpose:
58651         type: string
58652         description: purpose of pserver
58653       prov-status:
58654         type: string
58655         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58656       management-option:
58657         type: string
58658         description: Indicates who owns and or manages the device.
58659       host-profile:
58660         type: string
58661         description: The host profile that defines the configuration of the pserver.
58662       relationship-list:
58663         type: array
58664         items:
58665           $ref: "#/getDefinitions/relationship"
58666       p-interfaces:
58667         type: array
58668         items:
58669           $ref: "#/getDefinitions/p-interface"
58670       lag-interfaces:
58671         type: array
58672         items:
58673           $ref: "#/getDefinitions/lag-interface"
58674   pservers:
58675     description: |
58676       Collection of compute hosts.
58677     properties:
58678       pserver:
58679         type: array
58680         items:
58681           $ref: "#/getDefinitions/pserver"
58682   query-parameters:
58683     description: |
58684       QueryParameters for performing a named-query or model query
58685     properties:
58686       named-query:
58687         type: object
58688         $ref: "#/getDefinitions/named-query"
58689       overloaded-model:
58690         type: object
58691         $ref: "#/getDefinitions/overloaded-model"
58692   related-lookup:
58693     description: |
58694       TBD
58695       ###### Related Nodes
58696       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
58697
58698       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
58699     required:
58700     - related-lookup-uuid
58701     - source-node-type
58702     - source-node-property
58703     - target-node-type
58704     - target-node-property
58705     properties:
58706       related-lookup-uuid:
58707         type: string
58708       source-node-type:
58709         type: string
58710       source-node-property:
58711         type: string
58712       target-node-type:
58713         type: string
58714       target-node-property:
58715         type: string
58716       property-collect-list:
58717         type: string
58718       resource-version:
58719         type: string
58720       relationship-list:
58721         type: array
58722         items:
58723           $ref: "#/getDefinitions/relationship"
58724   related-lookups:
58725     properties:
58726       related-lookup:
58727         type: array
58728         items:
58729           $ref: "#/getDefinitions/related-lookup"
58730   related-to-property:
58731     properties:
58732       property-key:
58733         type: string
58734         description: Key part of a key/value pair
58735       property-value:
58736         type: string
58737         description: Value part of a key/value pair
58738   relationship:
58739     properties:
58740       related-to:
58741         type: string
58742         description: A keyword provided by A&AI to indicate type of node.
58743       related-link:
58744         type: string
58745         description: URL to the object in A&AI.
58746       relationship-data:
58747         type: array
58748         items:
58749           $ref: "#/getDefinitions/relationship-data"
58750       related-to-property:
58751         type: array
58752         items:
58753           $ref: "#/getDefinitions/related-to-property"
58754   relationship-data:
58755     required:
58756     - relationship-key
58757     - relationship-value
58758     properties:
58759       relationship-key:
58760         type: string
58761         description: A keyword provided by A&AI to indicate an attribute.
58762       relationship-value:
58763         type: string
58764         description: Value of the attribute.
58765   relationship-list:
58766     properties:
58767       relationship:
58768         type: array
58769         items:
58770           $ref: "#/getDefinitions/relationship"
58771   reserved-prop-names:
58772     description: |
58773       Internal map to define some reserved properties of a vertex
58774     properties:
58775       last-mod-source-of-truth:
58776         type: string
58777       aai-node-type:
58778         type: string
58779       aai-created-ts:
58780         type: integer
58781         format: int64
58782       aai-unique-key:
58783         type: string
58784       aai-last-mod-ts:
58785         type: integer
58786         format: int64
58787       source-of-truth:
58788         type: string
58789       aai-uri:
58790         type: string
58791   response-list:
58792     description: |
58793       Response container for the results of a named-query or model query
58794     properties:
58795       inventory-response-items:
58796         type: object
58797         $ref: "#/getDefinitions/inventory-response-items"
58798   result-data:
58799     properties:
58800       resource-type:
58801         type: string
58802         description: The specific type of node in the A&AI graph
58803       resource-link:
58804         type: string
58805         description: The URL to the specific resource
58806   route-table-reference:
58807     description: |
58808       Openstack route table reference.
58809       ###### Related Nodes
58810       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
58811
58812     required:
58813     - route-table-reference-id
58814     - route-table-reference-fqdn
58815     properties:
58816       route-table-reference-id:
58817         type: string
58818         description: Route Table Reference id, UUID assigned to this instance.
58819       route-table-reference-fqdn:
58820         type: string
58821         description: FQDN entry in the route table.
58822       resource-version:
58823         type: string
58824         description: Concurrency value
58825       relationship-list:
58826         type: array
58827         items:
58828           $ref: "#/getDefinitions/relationship"
58829   route-table-references:
58830     description: |
58831       Collection of openstack route table references
58832     properties:
58833       route-table-reference:
58834         type: array
58835         items:
58836           $ref: "#/getDefinitions/route-table-reference"
58837   route-target:
58838     description: |
58839       Route target information
58840       ###### Related Nodes
58841       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
58842
58843       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
58844     required:
58845     - global-route-target
58846     - route-target-role
58847     properties:
58848       global-route-target:
58849         type: string
58850         description: Number used to identify an RT, globally unique in the network
58851       route-target-role:
58852         type: string
58853         description: Role assigned to this route target
58854       resource-version:
58855         type: string
58856         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58857       relationship-list:
58858         type: array
58859         items:
58860           $ref: "#/getDefinitions/relationship"
58861   route-targets:
58862     description: |
58863       Collection of route target information
58864     properties:
58865       route-target:
58866         type: array
58867         items:
58868           $ref: "#/getDefinitions/route-target"
58869   routing-instance:
58870     description: |
58871       ###### Related Nodes
58872       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
58873       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
58874
58875       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
58876       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
58877     required:
58878     - routing-instance-id
58879     properties:
58880       routing-instance-id:
58881         type: string
58882         description: Unique id of routing instance
58883       rpm-owner:
58884         type: string
58885         description: rpm owner
58886       resource-version:
58887         type: string
58888         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58889       site-pairs:
58890         type: array
58891         items:
58892           $ref: "#/getDefinitions/site-pair"
58893       relationship-list:
58894         type: array
58895         items:
58896           $ref: "#/getDefinitions/relationship"
58897   routing-instances:
58898     description: |
58899       set of probes related to generic-vnf routing instance
58900     properties:
58901       routing-instance:
58902         type: array
58903         items:
58904           $ref: "#/getDefinitions/routing-instance"
58905   sdn-zone-response:
58906     properties:
58907       oam-networks:
58908         type: object
58909         $ref: "#/getDefinitions/oam-networks"
58910       az-and-dvs-switches:
58911         type: array
58912         items:
58913           $ref: "#/getDefinitions/az-and-dvs-switches"
58914   search:
58915     properties:
58916       edge-tag-query-result:
58917         type: object
58918         $ref: "#/getDefinitions/edge-tag-query-result"
58919       edge-tag-query-request:
58920         type: object
58921         $ref: "#/getDefinitions/edge-tag-query-request"
58922       search-results:
58923         type: object
58924         $ref: "#/getDefinitions/search-results"
58925       sdn-zone-response:
58926         type: object
58927         $ref: "#/getDefinitions/sdn-zone-response"
58928   search-results:
58929     properties:
58930       result-data:
58931         type: array
58932         items:
58933           $ref: "#/getDefinitions/result-data"
58934   secondary-filt:
58935     description: |
58936       SecondaryFilt for performing a named-query or model query
58937   secondary-filter:
58938     properties:
58939       property-name:
58940         type: string
58941       filter-type:
58942         type: string
58943       property-value:
58944         type: string
58945   secondary-filts:
58946     description: |
58947       SecondaryFilts for performing a named-query or model query
58948     properties:
58949       secondary-filt:
58950         type: array
58951         items:
58952           $ref: "#/getDefinitions/secondary-filt"
58953   segmentation-assignment:
58954     description: |
58955       Openstack segmentation assignment.
58956       ###### Related Nodes
58957       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
58958
58959       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
58960     required:
58961     - segmentation-id
58962     properties:
58963       segmentation-id:
58964         type: string
58965         description: Route Table Reference id, UUID assigned to this instance.
58966       resource-version:
58967         type: string
58968         description: Concurrency value
58969       relationship-list:
58970         type: array
58971         items:
58972           $ref: "#/getDefinitions/relationship"
58973   segmentation-assignments:
58974     description: |
58975       Collection of openstack segmentation assignments
58976     properties:
58977       segmentation-assignment:
58978         type: array
58979         items:
58980           $ref: "#/getDefinitions/segmentation-assignment"
58981   service:
58982     description: |
58983       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
58984     required:
58985     - service-id
58986     - service-description
58987     properties:
58988       service-id:
58989         type: string
58990         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58991       service-description:
58992         type: string
58993         description: Description of the service
58994       service-selflink:
58995         type: string
58996         description: URL to endpoint where AAI can get more details
58997       resource-version:
58998         type: string
58999         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59000       service-version:
59001         type: string
59002         description: service version
59003       relationship-list:
59004         type: array
59005         items:
59006           $ref: "#/getDefinitions/relationship"
59007   service-capabilities:
59008     description: |
59009       Collection of service capabilities.
59010     properties:
59011       service-capability:
59012         type: array
59013         items:
59014           $ref: "#/getDefinitions/service-capability"
59015   service-capability:
59016     description: |
59017       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
59018       ###### Related Nodes
59019       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
59020       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
59021
59022       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
59023
59024     required:
59025     - service-type
59026     - vnf-type
59027     properties:
59028       service-type:
59029         type: string
59030         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
59031       vnf-type:
59032         type: string
59033         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.
59034       resource-version:
59035         type: string
59036         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59037       relationship-list:
59038         type: array
59039         items:
59040           $ref: "#/getDefinitions/relationship"
59041   service-design-and-creation:
59042     description: |
59043       Namespace for objects managed by ASDC
59044     properties:
59045       vnf-images:
59046         type: array
59047         items:
59048           $ref: "#/getDefinitions/vnf-image"
59049       services:
59050         type: array
59051         items:
59052           $ref: "#/getDefinitions/service"
59053       service-capabilities:
59054         type: array
59055         items:
59056           $ref: "#/getDefinitions/service-capability"
59057       models:
59058         type: array
59059         items:
59060           $ref: "#/getDefinitions/model"
59061       named-queries:
59062         type: array
59063         items:
59064           $ref: "#/getDefinitions/named-query"
59065   service-instance:
59066     description: |
59067       Instance of a service
59068       ###### Related Nodes
59069       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
59070       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
59071       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
59072       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
59073       - TO configuration( service-instance Uses configuration, ONE2MANY)
59074       - TO connector( service-instance Uses connector, MANY2MANY)
59075       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
59076       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
59077       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
59078       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
59079       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
59080       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
59081       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
59082       - TO zone( service-instance LocatedIn zone, MANY2ONE)
59083       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
59084       - TO vce( service-instance ComposedOf vce, ONE2MANY)
59085       - FROM project( project Uses service-instance, ONE2MANY)
59086       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
59087       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
59088       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
59089
59090       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
59091       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
59092       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
59093     required:
59094     - service-instance-id
59095     properties:
59096       service-instance-id:
59097         type: string
59098         description: Uniquely identifies this instance of a service
59099       service-instance-name:
59100         type: string
59101         description: This field will store a name assigned to the service-instance.
59102       service-type:
59103         type: string
59104         description: String capturing type of service.
59105       service-role:
59106         type: string
59107         description: String capturing the service role.
59108       environment-context:
59109         type: string
59110         description: This field will store the environment context assigned to the service-instance.
59111       workload-context:
59112         type: string
59113         description: This field will store the workload context assigned to the service-instance.
59114       created-at:
59115         type: string
59116         description: create time of Network Service.
59117       updated-at:
59118         type: string
59119         description: last update of Network Service.
59120       description:
59121         type: string
59122         description: short description for service-instance.
59123       model-invariant-id:
59124         type: string
59125         description: the ASDC model id for this resource or service model.
59126       model-version-id:
59127         type: string
59128         description: the ASDC model version for this resource or service model.
59129       persona-model-version:
59130         type: string
59131         description: the ASDC model version for this resource or service model.
59132       widget-model-id:
59133         type: string
59134         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59135       widget-model-version:
59136         type: string
59137         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59138       bandwidth-total:
59139         type: string
59140         description: Indicates the total bandwidth to be used for this service.
59141       bandwidth-up-wan1:
59142         type: string
59143         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
59144       bandwidth-down-wan1:
59145         type: string
59146         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
59147       bandwidth-up-wan2:
59148         type: string
59149         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
59150       bandwidth-down-wan2:
59151         type: string
59152         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
59153       vhn-portal-url:
59154         type: string
59155         description: URL customers will use to access the vHN Portal.
59156       service-instance-location-id:
59157         type: string
59158         description: An identifier that customers assign to the location where this service is being used.
59159       resource-version:
59160         type: string
59161         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59162       selflink:
59163         type: string
59164         description: Path to the controller object.
59165       orchestration-status:
59166         type: string
59167         description: Orchestration status of this service.
59168       relationship-list:
59169         type: array
59170         items:
59171           $ref: "#/getDefinitions/relationship"
59172       metadata:
59173         type: array
59174         items:
59175           $ref: "#/getDefinitions/metadatum"
59176       allotted-resources:
59177         type: array
59178         items:
59179           $ref: "#/getDefinitions/allotted-resource"
59180   service-instances:
59181     description: |
59182       Collection of service instances
59183     properties:
59184       service-instance:
59185         type: array
59186         items:
59187           $ref: "#/getDefinitions/service-instance"
59188   service-subscription:
59189     description: |
59190       Object that group service instances.
59191       ###### Related Nodes
59192       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
59193       - TO tenant( service-subscription Uses tenant, MANY2MANY)
59194       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
59195
59196       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
59197       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
59198     required:
59199     - service-type
59200     properties:
59201       service-type:
59202         type: string
59203         description: Value defined by orchestration to identify this service across ECOMP.
59204       temp-ub-sub-account-id:
59205         type: string
59206         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
59207       resource-version:
59208         type: string
59209         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59210       service-instances:
59211         type: array
59212         items:
59213           $ref: "#/getDefinitions/service-instance"
59214       relationship-list:
59215         type: array
59216         items:
59217           $ref: "#/getDefinitions/relationship"
59218   service-subscriptions:
59219     description: |
59220       Collection of objects that group service instances.
59221     properties:
59222       service-subscription:
59223         type: array
59224         items:
59225           $ref: "#/getDefinitions/service-subscription"
59226   services:
59227     description: |
59228       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
59229     properties:
59230       service:
59231         type: array
59232         items:
59233           $ref: "#/getDefinitions/service"
59234   site-pair:
59235     description: |
59236       ###### Related Nodes
59237       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
59238       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
59239
59240       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
59241       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
59242     required:
59243     - site-pair-id
59244     properties:
59245       site-pair-id:
59246         type: string
59247         description: unique identifier of probe
59248       source-ip:
59249         type: string
59250         description: Prefix address
59251       destination-ip:
59252         type: string
59253         description: Prefix address
59254       ip-version:
59255         type: string
59256         description: ip version, v4, v6
59257       destination-hostname:
59258         type: string
59259         description: Hostname of the destination equipment to which SLAs are measured against.
59260       destination-equip-type:
59261         type: string
59262         description: The type of destinatination equipment. Could be Router, UCPE, etc.
59263       resource-version:
59264         type: string
59265         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59266       classes-of-service:
59267         type: array
59268         items:
59269           $ref: "#/getDefinitions/class-of-service"
59270       relationship-list:
59271         type: array
59272         items:
59273           $ref: "#/getDefinitions/relationship"
59274   site-pair-set:
59275     description: |
59276       Set of instances for probes used to measure service level agreements
59277       ###### Related Nodes
59278       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
59279       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
59280
59281       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
59282     required:
59283     - site-pair-set-id
59284     properties:
59285       site-pair-set-id:
59286         type: string
59287         description: Unique id of site pair set.
59288       resource-version:
59289         type: string
59290         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59291       routing-instances:
59292         type: array
59293         items:
59294           $ref: "#/getDefinitions/routing-instance"
59295       relationship-list:
59296         type: array
59297         items:
59298           $ref: "#/getDefinitions/relationship"
59299   site-pair-sets:
59300     description: |
59301       Collection of sets of instances for probes related to generic-vnf
59302     properties:
59303       site-pair-set:
59304         type: array
59305         items:
59306           $ref: "#/getDefinitions/site-pair-set"
59307   site-pairs:
59308     description: |
59309       probe within a set
59310     properties:
59311       site-pair:
59312         type: array
59313         items:
59314           $ref: "#/getDefinitions/site-pair"
59315   snapshot:
59316     description: |
59317       Openstack snapshot
59318       ###### Related Nodes
59319       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
59320       - FROM vserver( vserver Uses snapshot, ONE2ONE)
59321
59322     required:
59323     - snapshot-id
59324     properties:
59325       snapshot-id:
59326         type: string
59327         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
59328       snapshot-name:
59329         type: string
59330         description: Snapshot name
59331       snapshot-architecture:
59332         type: string
59333         description: Operating system architecture
59334       snapshot-os-distro:
59335         type: string
59336         description: The common name of the operating system distribution in lowercase
59337       snapshot-os-version:
59338         type: string
59339         description: The operating system version as specified by the distributor.
59340       application:
59341         type: string
59342         description: The application that the image instantiates.
59343       application-vendor:
59344         type: string
59345         description: The vendor of the application.
59346       application-version:
59347         type: string
59348         description: The version of the application.
59349       snapshot-selflink:
59350         type: string
59351         description: URL to endpoint where AAI can get more details
59352       prev-snapshot-id:
59353         type: string
59354         description: This field contains the UUID of the previous snapshot (if any).
59355       resource-version:
59356         type: string
59357         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59358       relationship-list:
59359         type: array
59360         items:
59361           $ref: "#/getDefinitions/relationship"
59362   snapshots:
59363     description: |
59364       Collection of openstack snapshots
59365     properties:
59366       snapshot:
59367         type: array
59368         items:
59369           $ref: "#/getDefinitions/snapshot"
59370   sriov-pf:
59371     description: |
59372       SR-IOV Physical Function
59373       ###### Related Nodes
59374       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
59375       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
59376
59377       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
59378     required:
59379     - pf-pci-id
59380     properties:
59381       pf-pci-id:
59382         type: string
59383         description: Identifier for the sriov-pf
59384       resource-version:
59385         type: string
59386         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59387       relationship-list:
59388         type: array
59389         items:
59390           $ref: "#/getDefinitions/relationship"
59391   sriov-pfs:
59392     description: |
59393       Collection of SR-IOV Physical Functions.
59394     properties:
59395       sriov-pf:
59396         type: array
59397         items:
59398           $ref: "#/getDefinitions/sriov-pf"
59399   sriov-vf:
59400     description: |
59401       SR-IOV Virtual Function (not to be confused with virtual network function)
59402       ###### Related Nodes
59403       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
59404       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
59405
59406       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
59407     required:
59408     - pci-id
59409     properties:
59410       pci-id:
59411         type: string
59412         description: PCI ID used to identify the sriov-vf
59413       vf-vlan-filter:
59414         type: string
59415         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
59416       vf-mac-filter:
59417         type: string
59418         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
59419       vf-vlan-strip:
59420         type: boolean
59421         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
59422       vf-vlan-anti-spoof-check:
59423         type: boolean
59424         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.
59425       vf-mac-anti-spoof-check:
59426         type: boolean
59427         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.
59428       vf-mirrors:
59429         type: string
59430         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
59431       vf-broadcast-allow:
59432         type: boolean
59433         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
59434       vf-unknown-multicast-allow:
59435         type: boolean
59436         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
59437       vf-unknown-unicast-allow:
59438         type: boolean
59439         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
59440       vf-insert-stag:
59441         type: boolean
59442         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
59443       vf-link-status:
59444         type: string
59445         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
59446       resource-version:
59447         type: string
59448         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59449       neutron-network-id:
59450         type: string
59451         description: Neutron network id of the interface
59452       relationship-list:
59453         type: array
59454         items:
59455           $ref: "#/getDefinitions/relationship"
59456   sriov-vfs:
59457     description: |
59458       Collection of SR-IOV Virtual Functions.
59459     properties:
59460       sriov-vf:
59461         type: array
59462         items:
59463           $ref: "#/getDefinitions/sriov-vf"
59464   start-node-filter:
59465     properties:
59466       property-name:
59467         type: string
59468       property-value:
59469         type: string
59470   subnet:
59471     description: |
59472       ###### Related Nodes
59473       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
59474       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59475       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59476       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
59477       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
59478       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
59479
59480       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
59481       -(4) IF this TO node is deleted, this SUBNET is DELETED also
59482       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
59483
59484     required:
59485     - subnet-id
59486     - dhcp-enabled
59487     properties:
59488       subnet-id:
59489         type: string
59490         description: Subnet ID, should be UUID.
59491       subnet-name:
59492         type: string
59493         description: Name associated with the subnet.
59494       neutron-subnet-id:
59495         type: string
59496         description: Neutron id of this subnet
59497       gateway-address:
59498         type: string
59499         description: gateway ip address
59500       network-start-address:
59501         type: string
59502         description: network start address
59503       cidr-mask:
59504         type: string
59505         description: cidr mask
59506       ip-version:
59507         type: string
59508         description: ip version
59509       orchestration-status:
59510         type: string
59511         description: Orchestration status of this VNF, mastered by MSO
59512       dhcp-enabled:
59513         type: boolean
59514         description: dhcp enabled
59515       dhcp-start:
59516         type: string
59517         description: the start address reserved for use by dhcp
59518       dhcp-end:
59519         type: string
59520         description: the last address reserved for use by dhcp
59521       subnet-role:
59522         type: string
59523         description: role of the subnet, referenced when assigning IPs
59524       ip-assignment-direction:
59525         type: string
59526         description: ip address assignment direction of the subnet
59527       resource-version:
59528         type: string
59529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59530       subnet-sequence:
59531         type: integer
59532         format: int32
59533         description: sequence of the subnet
59534       host-routes:
59535         type: array
59536         items:
59537           $ref: "#/getDefinitions/host-route"
59538       relationship-list:
59539         type: array
59540         items:
59541           $ref: "#/getDefinitions/relationship"
59542   subnets:
59543     properties:
59544       subnet:
59545         type: array
59546         items:
59547           $ref: "#/getDefinitions/subnet"
59548   tagged-inventory-item-list:
59549     properties:
59550       inventory-item:
59551         type: array
59552         items:
59553           $ref: "#/getDefinitions/inventory-item"
59554   tenant:
59555     description: |
59556       Openstack tenant
59557       ###### Related Nodes
59558       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
59559       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
59560       - TO l3-network( tenant Uses l3-network, MANY2MANY)
59561       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
59562       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
59563       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
59564
59565       -TENANT cannot be deleted if related to VSERVER
59566
59567     required:
59568     - tenant-id
59569     - tenant-name
59570     properties:
59571       tenant-id:
59572         type: string
59573         description: Unique id relative to the cloud-region.
59574       tenant-name:
59575         type: string
59576         description: Readable name of tenant
59577       tenant-context:
59578         type: string
59579         description: This field will store the tenant context.
59580       resource-version:
59581         type: string
59582         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59583       vservers:
59584         type: array
59585         items:
59586           $ref: "#/getDefinitions/vserver"
59587       relationship-list:
59588         type: array
59589         items:
59590           $ref: "#/getDefinitions/relationship"
59591   tenants:
59592     description: |
59593       Collection of openstack tenants.
59594     properties:
59595       tenant:
59596         type: array
59597         items:
59598           $ref: "#/getDefinitions/tenant"
59599   tunnel-xconnect:
59600     description: |
59601       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
59602       ###### Related Nodes
59603       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
59604
59605       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
59606     required:
59607     - id
59608     - bandwidth-up-wan1
59609     - bandwidth-down-wan1
59610     - bandwidth-up-wan2
59611     - bandwidth-down-wan2
59612     properties:
59613       id:
59614         type: string
59615         description: Allotted Resource id UUID assigned to this instance.
59616       bandwidth-up-wan1:
59617         type: string
59618         description: The WAN uplink bandwidth for WAN1
59619       bandwidth-down-wan1:
59620         type: string
59621         description: The WAN downlink bandwidth for WAN1
59622       bandwidth-up-wan2:
59623         type: string
59624         description: The WAN uplink bandwidth for WAN2
59625       bandwidth-down-wan2:
59626         type: string
59627         description: The WAN downlink bandwidth for WAN2
59628       resource-version:
59629         type: string
59630         description: Concurrency value
59631       relationship-list:
59632         type: array
59633         items:
59634           $ref: "#/getDefinitions/relationship"
59635   tunnel-xconnects:
59636     description: |
59637       This object is used to store the specific tunnel cross connect aspects of an allotted resource
59638     properties:
59639       tunnel-xconnect:
59640         type: array
59641         items:
59642           $ref: "#/getDefinitions/tunnel-xconnect"
59643   update:
59644     description: |
59645       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
59646     required:
59647     - update-node-type
59648     properties:
59649       update-node-type:
59650         type: string
59651       update-node-key:
59652         type: array
59653         items:
59654           $ref: "#/getDefinitions/update-node-key"
59655       update-node-uri:
59656         type: string
59657       action:
59658         type: array
59659         items:
59660           $ref: "#/getDefinitions/action"
59661   update-node-key:
59662     properties:
59663       key-name:
59664         type: string
59665       key-value:
59666         type: string
59667   vce:
59668     description: |
59669       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
59670       ###### Related Nodes
59671       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
59672       - TO complex( vce LocatedIn complex, MANY2MANY)
59673       - TO vserver( vce HostedOn vserver, ONE2MANY)
59674       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
59675       - FROM license( license BelongsTo vce, MANY2ONE)(1)
59676       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
59677       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
59678
59679       -(1) IF this VCE node is deleted, this FROM node is DELETED also
59680     required:
59681     - vnf-id
59682     - vnf-name
59683     - vnf-type
59684     properties:
59685       vnf-id:
59686         type: string
59687         description: Unique id of VNF.  This is unique across the graph.
59688       vnf-name:
59689         type: string
59690         description: Name of VNF.
59691       vnf-name2:
59692         type: string
59693         description: Alternate name of VNF.
59694       vnf-type:
59695         type: string
59696         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.
59697       service-id:
59698         type: string
59699         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
59700       regional-resource-zone:
59701         type: string
59702         description: Regional way of organizing pservers, source of truth should define values
59703       prov-status:
59704         type: string
59705         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59706       operational-status:
59707         type: string
59708         description: Indicator for whether the resource is considered operational
59709       license-key:
59710         type: string
59711         description: OBSOLETE -  do not use
59712       equipment-role:
59713         type: string
59714         description: Network role being played by this VNF
59715       orchestration-status:
59716         type: string
59717         description: Orchestration status of this VNF, mastered by MSO
59718       heat-stack-id:
59719         type: string
59720         description: Heat stack id corresponding to this instance, managed by MSO
59721       mso-catalog-key:
59722         type: string
59723         description: Corresponds to the SDN-C catalog id used to configure this VCE
59724       vpe-id:
59725         type: string
59726         description: Unique ID of VPE connected to this VCE.
59727       v6-vce-wan-address:
59728         type: string
59729         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
59730       ipv4-oam-address:
59731         type: string
59732         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
59733       resource-version:
59734         type: string
59735         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59736       ipv4-loopback0-address:
59737         type: string
59738         description: Loopback0 address
59739       entitlement-resource-uuid:
59740         type: string
59741         description: OBSOLETE -  see child relationships
59742       port-groups:
59743         type: array
59744         items:
59745           $ref: "#/getDefinitions/port-group"
59746       licenses:
59747         type: array
59748         items:
59749           $ref: "#/getDefinitions/license"
59750       entitlements:
59751         type: array
59752         items:
59753           $ref: "#/getDefinitions/entitlement"
59754       relationship-list:
59755         type: array
59756         items:
59757           $ref: "#/getDefinitions/relationship"
59758   vces:
59759     description: |
59760       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
59761     properties:
59762       vce:
59763         type: array
59764         items:
59765           $ref: "#/getDefinitions/vce"
59766   vf-module:
59767     description: |
59768       a deployment unit of VNFCs
59769       ###### Related Nodes
59770       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
59771       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
59772       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
59773       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
59774       - TO vserver( vf-module Uses vserver, ONE2MANY)
59775
59776       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
59777       -VF-MODULE cannot be deleted if related to VNFC
59778
59779     required:
59780     - vf-module-id
59781     - is-base-vf-module
59782     properties:
59783       vf-module-id:
59784         type: string
59785         description: Unique ID of vf-module.
59786       vf-module-name:
59787         type: string
59788         description: Name of vf-module
59789       heat-stack-id:
59790         type: string
59791         description: Heat stack id corresponding to this instance.
59792       orchestration-status:
59793         type: string
59794         description: orchestration status of this vf-module, mastered by MSO
59795       is-base-vf-module:
59796         type: boolean
59797         description: used to indicate whether or not this object is base vf module
59798       resource-version:
59799         type: string
59800         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59801       model-invariant-id:
59802         type: string
59803         description: the ASDC model id for this resource or service model.
59804       model-version-id:
59805         type: string
59806         description: the ASDC model version for this resource or service model.
59807       persona-model-version:
59808         type: string
59809         description: the ASDC model version for this resource or service model.
59810       model-customization-id:
59811         type: string
59812         description: captures the id of all the configuration used to customize the resource for the service.
59813       widget-model-id:
59814         type: string
59815         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59816       widget-model-version:
59817         type: string
59818         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59819       contrail-service-instance-fqdn:
59820         type: string
59821         description: the Contrail unique ID for a service-instance
59822       module-index:
59823         type: integer
59824         format: int32
59825         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
59826       selflink:
59827         type: string
59828         description: Path to the controller object.
59829       relationship-list:
59830         type: array
59831         items:
59832           $ref: "#/getDefinitions/relationship"
59833   vf-modules:
59834     description: |
59835       Collection of vf-modules, a deployment unit of VNFCs
59836     properties:
59837       vf-module:
59838         type: array
59839         items:
59840           $ref: "#/getDefinitions/vf-module"
59841   vig-server:
59842     description: |
59843       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
59844       ###### Related Nodes
59845       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
59846
59847       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
59848     required:
59849     - vig-address-type
59850     properties:
59851       vig-address-type:
59852         type: string
59853         description: indicates whether the VIG is for AVPN or INTERNET
59854       ipaddress-v4-vig:
59855         type: string
59856         description: v4 IP of the vig server
59857       ipaddress-v6-vig:
59858         type: string
59859         description: v6 IP of the vig server
59860       resource-version:
59861         type: string
59862         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59863       relationship-list:
59864         type: array
59865         items:
59866           $ref: "#/getDefinitions/relationship"
59867   vig-servers:
59868     properties:
59869       vig-server:
59870         type: array
59871         items:
59872           $ref: "#/getDefinitions/vig-server"
59873   vip-ipv4-address-list:
59874     description: |
59875       IPv4 Address Range
59876       ###### Related Nodes
59877       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
59878       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
59879       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
59880       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
59881
59882     required:
59883     - vip-ipv4-address
59884     properties:
59885       vip-ipv4-address:
59886         type: string
59887         description: IP address
59888       vip-ipv4-prefix-length:
59889         type: integer
59890         format: int64
59891         description: Prefix length, 32 for single address
59892       vlan-id-inner:
59893         type: integer
59894         format: int64
59895         description: Inner VLAN tag
59896       vlan-id-outer:
59897         type: integer
59898         format: int64
59899         description: Outer VLAN tag
59900       is-floating:
59901         type: boolean
59902         description: Indicator of fixed or floating address
59903       resource-version:
59904         type: string
59905         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59906       neutron-network-id:
59907         type: string
59908         description: Neutron network id of the interface that address belongs to
59909       neutron-subnet-id:
59910         type: string
59911         description: Neutron id of subnet that address belongs to
59912       relationship-list:
59913         type: array
59914         items:
59915           $ref: "#/getDefinitions/relationship"
59916   vip-ipv6-address-list:
59917     description: |
59918       IPv6 Address Range
59919       ###### Related Nodes
59920       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
59921       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
59922       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
59923       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
59924
59925     required:
59926     - vip-ipv6-address
59927     properties:
59928       vip-ipv6-address:
59929         type: string
59930         description: IP address
59931       vip-ipv6-prefix-length:
59932         type: integer
59933         format: int64
59934         description: Prefix length, 128 for single address
59935       vlan-id-inner:
59936         type: integer
59937         format: int64
59938         description: Inner VLAN tag
59939       vlan-id-outer:
59940         type: integer
59941         format: int64
59942         description: Outer VLAN tag
59943       is-floating:
59944         type: boolean
59945         description: Indicator of fixed or floating address
59946       resource-version:
59947         type: string
59948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59949       neutron-network-id:
59950         type: string
59951         description: Neutron network id of the interface that address belongs to
59952       neutron-subnet-id:
59953         type: string
59954         description: Neutron id of subnet that address belongs to
59955       relationship-list:
59956         type: array
59957         items:
59958           $ref: "#/getDefinitions/relationship"
59959   virtual-data-center:
59960     description: |
59961       Virtual organization of cloud infrastructure elements in a data center context
59962       ###### Related Nodes
59963       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
59964       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
59965       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
59966
59967     required:
59968     - vdc-id
59969     - vdc-name
59970     properties:
59971       vdc-id:
59972         type: string
59973         description: Unique ID of the vdc
59974       vdc-name:
59975         type: string
59976         description: Name of the virtual data center
59977       resource-version:
59978         type: string
59979         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59980       relationship-list:
59981         type: array
59982         items:
59983           $ref: "#/getDefinitions/relationship"
59984   virtual-data-centers:
59985     description: |
59986       Virtual organization of cloud infrastructure elements in a data center context
59987     properties:
59988       virtual-data-center:
59989         type: array
59990         items:
59991           $ref: "#/getDefinitions/virtual-data-center"
59992   vlan:
59993     description: |
59994       Definition of vlan
59995       ###### Related Nodes
59996       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
59997       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
59998       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
59999       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
60000       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
60001       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
60002       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
60003
60004       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
60005       -(2) IF this VLAN node is deleted, this TO node is DELETED also
60006       -(4) IF this TO node is deleted, this VLAN is DELETED also
60007     required:
60008     - vlan-interface
60009     - in-maint
60010     - is-ip-unnumbered
60011     properties:
60012       vlan-interface:
60013         type: string
60014         description: String that identifies the interface
60015       vlan-id-inner:
60016         type: integer
60017         format: int64
60018         description: Inner VLAN tag
60019       vlan-id-outer:
60020         type: integer
60021         format: int64
60022         description: Outer VLAN tag
60023       resource-version:
60024         type: string
60025         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60026       speed-value:
60027         type: string
60028         description: Captures the numeric part of the speed
60029       speed-units:
60030         type: string
60031         description: Captures the units corresponding to the speed
60032       vlan-description:
60033         type: string
60034         description: Used to describe (the service associated with) the vlan
60035       backdoor-connection:
60036         type: string
60037         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
60038       vpn-key:
60039         type: string
60040         description: This indicates the customers VPN ID associated with this vlan
60041       orchestration-status:
60042         type: string
60043         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
60044       in-maint:
60045         type: boolean
60046         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60047       prov-status:
60048         type: string
60049         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
60050       is-ip-unnumbered:
60051         type: boolean
60052         description: Flag indicating the interface uses the IP Unnumbered configuration.
60053       relationship-list:
60054         type: array
60055         items:
60056           $ref: "#/getDefinitions/relationship"
60057       l3-interface-ipv4-address-list:
60058         type: array
60059         items:
60060           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
60061       l3-interface-ipv6-address-list:
60062         type: array
60063         items:
60064           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
60065   vlans:
60066     properties:
60067       vlan:
60068         type: array
60069         items:
60070           $ref: "#/getDefinitions/vlan"
60071   vnf:
60072     description: |
60073       Abstract vnf class
60074     required:
60075     - vnf-id
60076     properties:
60077       vnf-id:
60078         type: string
60079         description: Unique id of VNF.  This is unique across the graph.
60080   vnf-image:
60081     description: |
60082       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
60083       ###### Related Nodes
60084       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
60085
60086       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
60087
60088     required:
60089     - vnf-image-uuid
60090     - application
60091     - application-vendor
60092     properties:
60093       vnf-image-uuid:
60094         type: string
60095         description: Unique ID of this asset
60096       application:
60097         type: string
60098         description: The application that the image instantiates.
60099       application-vendor:
60100         type: string
60101         description: The vendor of the application.
60102       application-version:
60103         type: string
60104         description: The version of the application.
60105       selflink:
60106         type: string
60107         description: URL to endpoint where AAI can get more details
60108       resource-version:
60109         type: string
60110         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60111       relationship-list:
60112         type: array
60113         items:
60114           $ref: "#/getDefinitions/relationship"
60115   vnf-images:
60116     description: |
60117       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
60118     properties:
60119       vnf-image:
60120         type: array
60121         items:
60122           $ref: "#/getDefinitions/vnf-image"
60123   vnfc:
60124     description: |
60125       ###### Related Nodes
60126       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
60127       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
60128       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
60129       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
60130       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
60131       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
60132       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
60133       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
60134
60135       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
60136       -(4) IF this TO node is deleted, this VNFC is DELETED also
60137     required:
60138     - vnfc-name
60139     - nfc-naming-code
60140     - nfc-function
60141     - in-maint
60142     - is-closed-loop-disabled
60143     properties:
60144       vnfc-name:
60145         type: string
60146         description: Unique ID of vnfc.
60147       nfc-naming-code:
60148         type: string
60149         description: Short code that is used in naming instances of the item being modeled
60150       nfc-function:
60151         type: string
60152         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
60153       prov-status:
60154         type: string
60155         description: prov status of this vnfc
60156       orchestration-status:
60157         type: string
60158         description: Orchestration status of this VNF, mastered by APP-C
60159       ipaddress-v4-oam-vip:
60160         type: string
60161         description: Oam V4 vip address of this vnfc
60162       in-maint:
60163         type: boolean
60164         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60165       is-closed-loop-disabled:
60166         type: boolean
60167         description: used to indicate whether closed loop function is enabled on this node
60168       group-notation:
60169         type: string
60170         description: Group notation of VNFC
60171       model-invariant-id:
60172         type: string
60173         description: the ASDC model id for this resource or service model.
60174       model-version-id:
60175         type: string
60176         description: the ASDC model version for this resource or service model.
60177       resource-version:
60178         type: string
60179         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60180       relationship-list:
60181         type: array
60182         items:
60183           $ref: "#/getDefinitions/relationship"
60184       l3-interface-ipv4-address-list:
60185         type: array
60186         items:
60187           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
60188       l3-interface-ipv6-address-list:
60189         type: array
60190         items:
60191           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
60192   vnfcs:
60193     description: |
60194       virtual network components associated with a vserver from application controller.
60195     properties:
60196       vnfc:
60197         type: array
60198         items:
60199           $ref: "#/getDefinitions/vnfc"
60200   volume:
60201     description: |
60202       Ephemeral Block storage volume.
60203       ###### Related Nodes
60204       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
60205
60206       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
60207     required:
60208     - volume-id
60209     - volume-selflink
60210     properties:
60211       volume-id:
60212         type: string
60213         description: Unique ID of block storage volume relative to the vserver.
60214       volume-selflink:
60215         type: string
60216         description: URL to endpoint where AAI can get more details
60217       resource-version:
60218         type: string
60219         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60220       relationship-list:
60221         type: array
60222         items:
60223           $ref: "#/getDefinitions/relationship"
60224   volume-group:
60225     description: |
60226       Persistent block-level storage.
60227       ###### Related Nodes
60228       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
60229       - TO complex( volume-group LocatedIn complex, MANY2ONE)
60230       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
60231       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
60232       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
60233
60234     required:
60235     - volume-group-id
60236     - volume-group-name
60237     - vnf-type
60238     properties:
60239       volume-group-id:
60240         type: string
60241         description: Unique ID of volume-group.
60242       volume-group-name:
60243         type: string
60244         description: Name of the volume group.
60245       heat-stack-id:
60246         type: string
60247         description: Heat stack id corresponding to this volume-group
60248       vnf-type:
60249         type: string
60250         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.
60251       orchestration-status:
60252         type: string
60253         description: Orchestration status of this volume-group
60254       model-customization-id:
60255         type: string
60256         description: captures the id of all the configuration used to customize the resource for the service.
60257       vf-module-model-customization-id:
60258         type: string
60259         description: helps relate the volume group to the vf-module whose components will require the volume group
60260       resource-version:
60261         type: string
60262         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60263       relationship-list:
60264         type: array
60265         items:
60266           $ref: "#/getDefinitions/relationship"
60267   volume-groups:
60268     description: |
60269       Collection of persistent block-level storage.
60270     properties:
60271       volume-group:
60272         type: array
60273         items:
60274           $ref: "#/getDefinitions/volume-group"
60275   volumes:
60276     description: |
60277       Collection of ephemeral Block storage volumes.
60278     properties:
60279       volume:
60280         type: array
60281         items:
60282           $ref: "#/getDefinitions/volume"
60283   vpls-pe:
60284     description: |
60285       VPLS Provider Edge routers.
60286       ###### Related Nodes
60287       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
60288       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
60289       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
60290       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
60291
60292       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
60293     required:
60294     - equipment-name
60295     properties:
60296       equipment-name:
60297         type: string
60298       prov-status:
60299         type: string
60300         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60301       ipv4-oam-address:
60302         type: string
60303         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).
60304       equipment-role:
60305         type: string
60306         description: Client should send valid enumerated value, e.g., VPLS-PE.
60307       vlan-id-outer:
60308         type: integer
60309         format: int64
60310         description: Temporary location for stag to get to VCE
60311       resource-version:
60312         type: string
60313         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60314       relationship-list:
60315         type: array
60316         items:
60317           $ref: "#/getDefinitions/relationship"
60318       p-interfaces:
60319         type: array
60320         items:
60321           $ref: "#/getDefinitions/p-interface"
60322       lag-interfaces:
60323         type: array
60324         items:
60325           $ref: "#/getDefinitions/lag-interface"
60326   vpls-pes:
60327     description: |
60328       Collection of VPLS Provider Edge routers
60329     properties:
60330       vpls-pe:
60331         type: array
60332         items:
60333           $ref: "#/getDefinitions/vpls-pe"
60334   vpn-binding:
60335     description: |
60336       VPN binding
60337       ###### Related Nodes
60338       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
60339       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
60340       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
60341       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
60342
60343       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
60344       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
60345
60346     required:
60347     - vpn-id
60348     - vpn-name
60349     properties:
60350       vpn-id:
60351         type: string
60352         description: VPN ID, globally unique within A&AI
60353       vpn-name:
60354         type: string
60355         description: VPN Name
60356       vpn-platform:
60357         type: string
60358         description: the platform associated with the VPN example AVPN, Mobility
60359       vpn-type:
60360         type: string
60361         description: Type of the vpn, should be taken from enumerated/valid values
60362       vpn-region:
60363         type: string
60364         description: region of customer vpn
60365       customer-vpn-id:
60366         type: string
60367         description: id for this customer vpn
60368       route-distinguisher:
60369         type: string
60370         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
60371       resource-version:
60372         type: string
60373         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60374       route-targets:
60375         type: array
60376         items:
60377           $ref: "#/getDefinitions/route-target"
60378       relationship-list:
60379         type: array
60380         items:
60381           $ref: "#/getDefinitions/relationship"
60382         description: l3-networks relate to vpn-bindings
60383   vpn-bindings:
60384     properties:
60385       vpn-binding:
60386         type: array
60387         items:
60388           $ref: "#/getDefinitions/vpn-binding"
60389   vserver:
60390     description: |
60391       Virtual Servers, aka virtual machine or VM.
60392       ###### Related Nodes
60393       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
60394       - TO flavor( vserver Uses flavor, MANY2ONE)
60395       - TO image( vserver Uses image, MANY2ONE)
60396       - TO pserver( vserver HostedOn pserver, MANY2ONE)
60397       - TO snapshot( vserver Uses snapshot, ONE2ONE)
60398       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
60399       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
60400       - FROM vce( vce HostedOn vserver, ONE2MANY)
60401       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
60402       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
60403       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
60404
60405       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
60406       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
60407     required:
60408     - vserver-id
60409     - vserver-name
60410     - vserver-selflink
60411     - in-maint
60412     - is-closed-loop-disabled
60413     properties:
60414       vserver-id:
60415         type: string
60416         description: Unique identifier for this vserver relative to its tenant
60417       vserver-name:
60418         type: string
60419         description: Name of vserver
60420       vserver-name2:
60421         type: string
60422         description: Alternative name of vserver
60423       prov-status:
60424         type: string
60425         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60426       vserver-selflink:
60427         type: string
60428         description: URL to endpoint where AAI can get more details
60429       in-maint:
60430         type: boolean
60431         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.
60432       is-closed-loop-disabled:
60433         type: boolean
60434         description: Used to indicate whether closed loop function is enabled on this node
60435       resource-version:
60436         type: string
60437         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60438       volumes:
60439         type: array
60440         items:
60441           $ref: "#/getDefinitions/volume"
60442       relationship-list:
60443         type: array
60444         items:
60445           $ref: "#/getDefinitions/relationship"
60446       l-interfaces:
60447         type: array
60448         items:
60449           $ref: "#/getDefinitions/l-interface"
60450   vservers:
60451     description: |
60452       Collection of virtual Servers, aka virtual machines or VMs.
60453     properties:
60454       vserver:
60455         type: array
60456         items:
60457           $ref: "#/getDefinitions/vserver"
60458   zone:
60459     description: |
60460       A zone is a grouping of assets in a location homing to the same connections into the CBB
60461       ###### Related Nodes
60462       - TO complex( zone LocatedIn complex, MANY2ONE)
60463       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
60464       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
60465       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
60466       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
60467
60468     required:
60469     - zone-id
60470     - zone-name
60471     - design-type
60472     - zone-context
60473     properties:
60474       zone-id:
60475         type: string
60476         description: Code assigned by AIC to the zone
60477       zone-name:
60478         type: string
60479         description: English name associated with the zone
60480       design-type:
60481         type: string
60482         description: Design of zone [Medium/Large?]
60483       zone-context:
60484         type: string
60485         description: Context of zone [production/test]
60486       status:
60487         type: string
60488         description: Status of a zone.
60489       resource-version:
60490         type: string
60491         description: Concurrency value
60492       relationship-list:
60493         type: array
60494         items:
60495           $ref: "#/getDefinitions/relationship"
60496   zones:
60497     description: |
60498       Collection of zones
60499     properties:
60500       zone:
60501         type: array
60502         items:
60503           $ref: "#/getDefinitions/zone"